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