e16270b56444a4947993ea6f39fa764e524b5222
[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/base/console.h>
43 #include <lib/driver/rc.h>
44 #include <lib/service/iservice.h>
45 #include <lib/service/service.h>
46 #include <lib/service/event.h>
47 #include <lib/gdi/fb.h>
48 #include <lib/gdi/font.h>
49 #include <lib/gdi/gpixmap.h>
50 #include <lib/gui/ewidget.h>
51 #include <lib/gui/elabel.h>
52 #include <lib/gui/einput.h>
53 #include <lib/gui/einputstring.h>
54 #include <lib/gui/einputnumber.h>
55 #include <lib/gui/epixmap.h>
56 #include <lib/gui/ebutton.h>
57 #include <lib/gui/ewindow.h>
58 #include <lib/gui/ewidgetdesktop.h>
59 #include <lib/gui/ewindowstyle.h>
60 #include <lib/gui/ewindowstyleskinned.h>
61 #include <lib/gui/ewidgetanimation.h>
62 #include <lib/gui/eslider.h>
63 #include <lib/gui/epositiongauge.h>
64 #include <lib/gui/evideo.h>
65 #include <lib/python/connections.h>
66 #include <lib/gui/elistbox.h>
67 #include <lib/gui/elistboxcontent.h>
68 #include <lib/service/listboxservice.h>
69 #include <lib/components/scan.h>
70 #include <lib/components/listboxepg.h>
71 #include <lib/components/file_eraser.h>
72 #include <lib/nav/pcore.h>
73 #include <lib/actions/action.h>
74 #include <lib/gdi/gfont.h>
75 #include <lib/gdi/epng.h>
76 #include <lib/dvb/db.h>
77 #include <lib/dvb/dvb.h>
78 #include <lib/dvb/idvb.h>
79 #include <lib/dvb/frontend.h>
80 #include <lib/dvb/volume.h>
81 #include <lib/dvb/sec.h>
82 #include <lib/dvb/epgcache.h>
83 #include <lib/dvb/frontendparms.h>
84 #include <lib/dvb/dvbtime.h>
85 #include <lib/driver/avswitch.h>
86 #include <lib/driver/rfmod.h>
87 #include <lib/driver/etimezone.h>
88 #include <lib/gdi/lcd.h>
89 #include <lib/dvb_ci/dvbci_ui.h>
90 #include <lib/python/python.h>
91
92 extern void runMainloop();
93 extern void quitMainloop(int exit_code);
94 extern eApplication *getApplication();
95
96 extern PSignal1<void,int> &keyPressedSignal();
97 %}
98
99 %feature("ref")   iObject "$this->AddRef(); /* eDebug(\"AddRef (%s:%d)!\", __FILE__, __LINE__); */ "
100 %feature("unref") iObject "$this->Release(); /* eDebug(\"Release! %s:%d\", __FILE__, __LINE__); */ "
101
102
103 /* this magic allows smartpointer to be used as OUTPUT arguments, i.e. call-by-reference-styled return value. */
104
105 %define %typemap_output_simple(Type)
106  %typemap(in,numinputs=0) Type *OUTPUT ($*1_ltype temp),
107               Type &OUTPUT ($*1_ltype temp)
108    "$1 = new Type;";
109  %fragment("t_out_helper"{Type},"header",
110      fragment="t_output_helper") {}
111  %typemap(argout,fragment="t_out_helper"{Type}) Type *OUTPUT, Type &OUTPUT
112    "$result = t_output_helper($result, (SWIG_NewPointerObj((void*)($1), $1_descriptor, 1)));"
113 %enddef
114
115 %define %typemap_output_ptr(Type)
116  %typemap(in,numinputs=0) Type *OUTPUT ($*1_ltype temp),
117               Type &OUTPUT ($*1_ltype temp)
118    "$1 = new Type;";
119  %fragment("t_out_helper"{Type},"header",
120      fragment="t_output_helper") {}
121  %typemap(argout,fragment="t_out_helper"{Type}) Type *OUTPUT, Type &OUTPUT
122                 // generate None if smartpointer is NULL
123    "$result = t_output_helper($result, ((*$1) ? SWIG_NewPointerObj((void*)($1), $1_descriptor, 1) : (Py_INCREF(Py_None), Py_None)));"
124 %enddef
125
126
127 #define DEBUG
128 typedef long time_t;
129 %include "typemaps.i"
130 %include "stl.i"
131 %include <lib/python/swig.h>
132 %include <lib/base/object.h>
133 %include <lib/base/eerror.h>
134
135 %immutable eTimer::timeout;
136 %immutable eSocketNotifier::activated;
137 %include <lib/base/ebase.h>
138 %include <lib/base/smartptr.h>
139 %include <lib/service/iservice.h>
140 %include <lib/service/service.h>
141
142 %template(eServiceCenterPtr) ePtr<eServiceCenter>;
143 %include <lib/service/event.h>
144
145
146 // TODO: embed these...
147 %immutable eConsoleAppContainer::appClosed;
148 %immutable eConsoleAppContainer::dataAvail;
149 %immutable eConsoleAppContainer::dataSent;
150 %immutable eButton::selected;
151 %immutable eInput::changed;
152 %immutable eComponentScan::statusChanged;
153 %immutable eComponentScan::newService;
154 %immutable pNavigation::m_event;
155 %immutable eListbox::selectionChanged;
156
157 %include <lib/base/console.h>
158 %include <lib/driver/rc.h>
159 %include <lib/gdi/fb.h>
160 %include <lib/gdi/font.h>
161 %include <lib/gdi/gpixmap.h>
162 %include <lib/gdi/epoint.h>
163 %include <lib/gdi/erect.h>
164 %include <lib/gdi/esize.h>
165 %include <lib/gdi/region.h>
166 %include <lib/gui/ewidget.h>
167 %include <lib/gui/elabel.h>
168 %include <lib/gui/einput.h>
169 %include <lib/gui/einputstring.h>
170 %include <lib/gui/einputnumber.h>
171 %include <lib/gui/epixmap.h>
172 %include <lib/gui/ebutton.h>
173 %include <lib/gui/ewindow.h>
174 %include <lib/gui/eslider.h>
175 %include <lib/gui/epositiongauge.h>
176 %include <lib/gui/ewidgetdesktop.h>
177 %include <lib/gui/elistbox.h>
178 %include <lib/gui/elistboxcontent.h>
179 %include <lib/gui/ewindowstyle.h>
180 %include <lib/gui/ewindowstyleskinned.h>
181 %include <lib/gui/ewidgetanimation.h>
182 %include <lib/gui/evideo.h>
183 %include <lib/service/listboxservice.h>
184 %include <lib/components/scan.h>
185 %include <lib/components/listboxepg.h>
186 %include <lib/components/file_eraser.h>
187 %include <lib/nav/pcore.h>
188 %include <lib/actions/action.h>
189 %include <lib/gdi/gfont.h>
190 %include <lib/gdi/epng.h>
191 %include <lib/dvb/volume.h>
192 %include <lib/dvb/sec.h>
193 %include <lib/dvb/epgcache.h>
194 %include <lib/dvb/frontendparms.h>
195 %include <lib/dvb/dvbtime.h>
196 %include <lib/dvb/dvb.h>
197 %include <lib/dvb/idvb.h>
198 %include <lib/dvb/frontend.h>
199 %include <lib/driver/avswitch.h>
200 %include <lib/driver/rfmod.h>
201 %include <lib/driver/etimezone.h>
202 %include <lib/gdi/lcd.h>
203 %include <lib/dvb_ci/dvbci_ui.h>
204 %include <lib/dvb/db.h>
205 %include <lib/python/python.h>
206 /**************  eptr  **************/
207
208 %template(eActionMapPtr) ePtr<eActionMap>;
209
210 /**************  signals  **************/
211
212 template<class R> class PSignal0
213 {
214 public:
215         PyObject *get();
216 };
217
218 %template(PSignal0V) PSignal0<void>;
219
220 %typemap(out) PSignal0V {
221         $1 = $input->get();
222 }
223
224 template<class R, class P0> class PSignal1
225 {
226 public:
227         PyObject *get();
228 };
229
230 %template(PSignal1VI) PSignal1<void,int>;
231 %template(PSignal1VS) PSignal1<void,const char *c>;
232
233 %typemap(out) PSignal1VI {
234         $1 = $input->get();
235 }
236
237 %typemap(out) PSignal1VS {
238         $1 = $input->get();
239 }
240
241 template<class R, class P0, class P1> class PSignal2
242 {
243 public:
244         PyObject *get();
245 };
246
247 /**************  debug  **************/
248
249 void runMainloop();
250 void quitMainloop(int exit_code);
251 eApplication *getApplication();
252 %immutable keyPressed;
253 PSignal1<void,int> &keyPressedSignal();
254
255 %{
256 RESULT SwigFromPython(ePtr<gPixmap> &result, PyObject *obj)
257 {       
258         ePtr<gPixmap> *res;
259
260         res = 0;
261         result = 0;
262         if (SWIG_Python_ConvertPtr(obj, (void **)&res, SWIGTYPE_p_ePtrTgPixmap_t, SWIG_POINTER_EXCEPTION | 0))
263                 return -1;
264         if (!res)
265                 return -1;
266         result = *res;
267         return 0;
268 }
269 PyObject *New_TestObj()
270 {
271     TestObj *result = (TestObj *)new TestObj();
272     return SWIG_NewPointerObj((void*)(result), SWIGTYPE_p_TestObj, 1);
273 }
274 PyObject *New_eServiceReference(const eServiceReference &ref)
275 {
276     eServiceReference *result = new eServiceReference(ref);
277     return SWIG_NewPointerObj((void*)(result), SWIGTYPE_p_eServiceReference, 1);
278 }
279 %}