update only when executed
[enigma2.git] / lib / python / enigma_python.i
1 /*
2   NOTE: you have two options when adding classes so that
3   they are callable *from* python.
4   
5    - either you %include the header file
6    - or you re-declare it
7    
8   In both cases, you must #include the required
9   header file (i.e. the header file itself), otherwise
10   enigma_python_wrap.cxx won't build.
11   
12         In case you import the whole header file,
13         please make sure that no unimportant stuff
14         is wrapped, as this makes the wrapper stuff
15         much more complex and it can probably break 
16         very easily because of missing typemaps etc.
17         
18         you could make use of dizzy macros to ensure
19         that some stuff is left out when parsed as SWIG
20         definitions, but be sure to not modify the binary 
21         representation. DON'T USE #ifdef SWIG_COMPILE
22         for leaving out stuff (unless you *really* know
23         what you are doing,of course!). you WILL break it.
24                 
25         The better way (with more work) is to re-declare
26         the class. It won't be compiled, so you can
27         leave out stuff as you like.
28
29
30
31 Oh, things like "operator= is private in this context" etc.
32 is usually caused by not marking PSignals as immutable. 
33 */
34
35 %module enigma
36 %{
37
38 #define SWIG_COMPILE
39 #include <lib/base/ebase.h>
40 #include <lib/base/smartptr.h>
41 #include <lib/base/eerror.h>
42 #include <lib/service/iservice.h>
43 #include <lib/service/service.h>
44 #include <lib/service/event.h>
45 #include <lib/gdi/font.h>
46 #include <lib/gdi/gpixmap.h>
47 #include <lib/gui/ewidget.h>
48 #include <lib/gui/elabel.h>
49 #include <lib/gui/einput.h>
50 #include <lib/gui/einputstring.h>
51 #include <lib/gui/einputnumber.h>
52 #include <lib/gui/epixmap.h>
53 #include <lib/gui/ebutton.h>
54 #include <lib/gui/ewindow.h>
55 #include <lib/gui/ewidgetdesktop.h>
56 #include <lib/gui/ewindowstyle.h>
57 #include <lib/gui/ewindowstyleskinned.h>
58 #include <lib/gui/ewidgetanimation.h>
59 #include <lib/gui/eslider.h>
60 #include <lib/gui/epositiongauge.h>
61 #include <lib/python/connections.h>
62 #include <lib/gui/elistbox.h>
63 #include <lib/gui/elistboxcontent.h>
64 #include <lib/service/listboxservice.h>
65 #include <lib/components/scan.h>
66 #include <lib/components/listboxepg.h>
67 #include <lib/nav/pcore.h>
68 #include <lib/actions/action.h>
69 #include <lib/gdi/gfont.h>
70 #include <lib/gdi/epng.h>
71 #include <lib/dvb/db.h>
72 #include <lib/dvb/volume.h>
73 #include <lib/dvb/sec.h>
74 #include <lib/dvb/epgcache.h>
75 #include <lib/dvb/frontendparms.h>
76 #include <lib/dvb/dvbtime.h>
77 #include <lib/driver/avswitch.h>
78 #include <lib/driver/rfmod.h>
79 #include <lib/driver/etimezone.h>
80 #include <lib/gdi/lcd.h>
81 #include <lib/dvb_ci/dvbci_ui.h>
82 #include <lib/python/python.h>
83
84 extern void runMainloop();
85 extern void quitMainloop(int exit_code);
86 extern void setLCD(const char *c);
87 extern void setLCDClock(const char *c);
88 extern eApplication *getApplication();
89
90 extern PSignal1<void,int> &keyPressedSignal();
91 %}
92
93 %feature("ref")   iObject "$this->AddRef(); /* eDebug(\"AddRef (%s:%d)!\", __FILE__, __LINE__); */ "
94 %feature("unref") iObject "$this->Release(); /* eDebug(\"Release! %s:%d\", __FILE__, __LINE__); */ "
95
96
97 /* this magic allows smartpointer to be used as OUTPUT arguments, i.e. call-by-reference-styled return value. */
98
99 %define %typemap_output_simple(Type)
100  %typemap(in,numinputs=0) Type *OUTPUT ($*1_ltype temp),
101               Type &OUTPUT ($*1_ltype temp)
102    "$1 = new Type;";
103  %fragment("t_out_helper"{Type},"header",
104      fragment="t_output_helper") {}
105  %typemap(argout,fragment="t_out_helper"{Type}) Type *OUTPUT, Type &OUTPUT
106    "$result = t_output_helper($result, (SWIG_NewPointerObj((void*)($1), $1_descriptor, 1)));"
107 %enddef
108
109 %define %typemap_output_ptr(Type)
110  %typemap(in,numinputs=0) Type *OUTPUT ($*1_ltype temp),
111               Type &OUTPUT ($*1_ltype temp)
112    "$1 = new Type;";
113  %fragment("t_out_helper"{Type},"header",
114      fragment="t_output_helper") {}
115  %typemap(argout,fragment="t_out_helper"{Type}) Type *OUTPUT, Type &OUTPUT
116                 // generate None if smartpointer is NULL
117    "$result = t_output_helper($result, ((*$1) ? SWIG_NewPointerObj((void*)($1), $1_descriptor, 1) : (Py_INCREF(Py_None), Py_None)));"
118 %enddef
119
120
121 #define DEBUG
122 typedef long time_t;
123 %include "typemaps.i"
124 %include "stl.i"
125 %include <lib/python/swig.h>
126 %include <lib/base/object.h>
127 %include <lib/base/eerror.h>
128
129 %immutable eTimer::timeout;
130 %immutable eSocketNotifier::activated;
131 %include <lib/base/ebase.h>
132 %include <lib/base/smartptr.h>
133 %include <lib/service/iservice.h>
134 %include <lib/service/service.h>
135
136 %template(eServiceCenterPtr) ePtr<eServiceCenter>;
137 %include <lib/service/event.h>
138
139
140 // TODO: embed these...
141 %immutable eButton::selected;
142 %immutable eInput::changed;
143 %immutable eComponentScan::statusChanged;
144 %immutable eComponentScan::newService;
145 %immutable pNavigation::m_event;
146 %immutable eListbox::selectionChanged;
147
148 %include <lib/gdi/font.h>
149 %include <lib/gdi/gpixmap.h>
150 %include <lib/gdi/epoint.h>
151 %include <lib/gdi/erect.h>
152 %include <lib/gdi/esize.h>
153 %include <lib/gdi/region.h>
154 %include <lib/gui/ewidget.h>
155 %include <lib/gui/elabel.h>
156 %include <lib/gui/einput.h>
157 %include <lib/gui/einputstring.h>
158 %include <lib/gui/einputnumber.h>
159 %include <lib/gui/epixmap.h>
160 %include <lib/gui/ebutton.h>
161 %include <lib/gui/ewindow.h>
162 %include <lib/gui/eslider.h>
163 %include <lib/gui/epositiongauge.h>
164 %include <lib/gui/ewidgetdesktop.h>
165 %include <lib/gui/elistbox.h>
166 %include <lib/gui/elistboxcontent.h>
167 %include <lib/gui/ewindowstyle.h>
168 %include <lib/gui/ewindowstyleskinned.h>
169 %include <lib/gui/ewidgetanimation.h>
170 %include <lib/service/listboxservice.h>
171 %include <lib/components/scan.h>
172 %include <lib/components/listboxepg.h>
173 %include <lib/nav/pcore.h>
174 %include <lib/actions/action.h>
175 %include <lib/gdi/gfont.h>
176 %include <lib/gdi/epng.h>
177 %include <lib/dvb/volume.h>
178 %include <lib/dvb/sec.h>
179 %include <lib/dvb/epgcache.h>
180 %include <lib/dvb/frontendparms.h>
181 %include <lib/dvb/dvbtime.h>
182 %include <lib/driver/avswitch.h>
183 %include <lib/driver/rfmod.h>
184 %include <lib/driver/etimezone.h>
185 %include <lib/gdi/lcd.h>
186 %include <lib/dvb_ci/dvbci_ui.h>
187 %include <lib/dvb/db.h>
188 %include <lib/python/python.h>
189 /**************  eptr  **************/
190
191 %template(eActionMapPtr) ePtr<eActionMap>;
192
193 /**************  signals  **************/
194
195 template<class R> class PSignal0
196 {
197 public:
198         PyObject *get();
199 };
200
201 template<class R, class P0> class PSignal1
202 {
203 public:
204         PyObject *get();
205 };
206
207 template<class R, class P0, class P1> class PSignal2
208 {
209 public:
210         PyObject *get();
211 };
212
213 %template(PSignal1VI) PSignal1<void,int>;
214
215 %typemap(out) PSignal1VI {
216         $1 = $input->get();
217 }
218
219 %template(PSignal0V) PSignal0<void>;
220
221 %typemap(out) PSignal0V {
222         $1 = $input->get();
223 }
224
225
226 /**************  debug  **************/
227
228 void runMainloop();
229 void quitMainloop(int exit_code);
230 void setLCD(const char*);
231 void setLCDClock(const char*);
232 eApplication *getApplication();
233 %immutable keyPressed;
234 PSignal1<void,int> &keyPressedSignal();
235
236 %{
237 RESULT SwigFromPython(ePtr<gPixmap> &result, PyObject *obj)
238 {       
239         ePtr<gPixmap> *res;
240
241         res = 0;
242         result = 0;
243         if (SWIG_Python_ConvertPtr(obj, (void **)&res, SWIGTYPE_p_ePtrTgPixmap_t, SWIG_POINTER_EXCEPTION | 0))
244                 return -1;
245         if (!res)
246                 return -1;
247         result = *res;
248         return 0;
249 }
250 PyObject *New_TestObj()
251 {
252     TestObj *result = (TestObj *)new TestObj();
253     return SWIG_NewPointerObj((void*)(result), SWIGTYPE_p_TestObj, 1);
254 }
255 PyObject *New_eServiceReference(const eServiceReference &ref)
256 {
257     eServiceReference *result = new eServiceReference(ref);
258     return SWIG_NewPointerObj((void*)(result), SWIGTYPE_p_eServiceReference, 1);
259 }
260 %}