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