Merge remote branch 'origin/pootle-import'
[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/eenv.h>
42 #include <lib/base/eerror.h>
43 #include <lib/base/etpm.h>
44 #include <lib/base/nconfig.h>
45 #include <lib/base/message.h>
46 #include <lib/driver/rc.h>
47 #include <lib/service/event.h>
48 #include <lib/service/iservice.h>
49 #include <lib/service/service.h>
50 #include <lib/service/servicedvb.h>
51 #include <lib/gdi/fb.h>
52 #include <lib/gdi/font.h>
53 #include <lib/gdi/gpixmap.h>
54 #include <lib/gdi/gmaindc.h>
55 #include <lib/gui/ewidget.h>
56 #include <lib/gui/elabel.h>
57 #include <lib/gui/einput.h>
58 #include <lib/gui/einputstring.h>
59 #include <lib/gui/einputnumber.h>
60 #include <lib/gui/epixmap.h>
61 #include <lib/gui/ebutton.h>
62 #include <lib/gui/ewindow.h>
63 #include <lib/gui/ewidgetdesktop.h>
64 #include <lib/gui/ewindowstyle.h>
65 #include <lib/gui/ewindowstyleskinned.h>
66 #include <lib/gui/ewidgetanimation.h>
67 #include <lib/gui/eslider.h>
68 #include <lib/gui/epositiongauge.h>
69 #include <lib/gui/evideo.h>
70 #include <lib/gui/ecanvas.h>
71 #include <lib/python/connections.h>
72 #include <lib/gui/elistbox.h>
73 #include <lib/gui/elistboxcontent.h>
74 #include <lib/gui/esubtitle.h>
75 #include <lib/service/listboxservice.h>
76 #include <lib/nav/pcore.h>
77 #include <lib/actions/action.h>
78 #include <lib/gdi/gfont.h>
79 #include <lib/gdi/epng.h>
80 #include <lib/dvb/db.h>
81 #include <lib/dvb/frontendparms.h>
82 #include <lib/dvb/idvb.h>
83 #include <lib/dvb/dvb.h>
84 #include <lib/dvb/frontend.h>
85 #include <lib/dvb/volume.h>
86 #include <lib/dvb/sec.h>
87 #include <lib/dvb/epgcache.h>
88 #include <lib/dvb/dvbtime.h>
89 #include <lib/dvb/pmt.h>
90 #include <lib/components/scan.h>
91 #include <lib/components/file_eraser.h>
92 #include <lib/driver/avswitch.h>
93 #include <lib/driver/rfmod.h>
94 #include <lib/driver/misc_options.h>
95 #include <lib/driver/etimezone.h>
96 #include <lib/gdi/lcd.h>
97 #include <lib/mmi/mmi_ui.h>
98 #include <lib/dvb_ci/dvbci.h>
99 #include <lib/dvb_ci/dvbci_ui.h>
100 #include <lib/python/python.h>
101 #include <lib/gdi/picload.h>
102 %}
103
104 %feature("ref")   iObject "$this->AddRef(); /* eDebug(\"AddRef (%s:%d)!\", __FILE__, __LINE__); */ "
105 %feature("unref") iObject "$this->Release(); /* eDebug(\"Release! %s:%d\", __FILE__, __LINE__); */ "
106
107 /* this magic allows smartpointer to be used as OUTPUT arguments, i.e. call-by-reference-styled return value. */
108
109 %define %typemap_output_simple(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    "$result = t_output_helper($result, (SWIG_NewPointerObj((void*)($1), $1_descriptor, 1)));"
117 %enddef
118
119 %define %typemap_output_ptr(Type)
120  %typemap(in,numinputs=0) Type *OUTPUT ($*1_ltype temp),
121               Type &OUTPUT ($*1_ltype temp)
122    "$1 = new Type;";
123  %fragment("t_out_helper"{Type},"header",
124      fragment="t_output_helper") {}
125  %typemap(argout,fragment="t_out_helper"{Type}) Type *OUTPUT, Type &OUTPUT
126                 // generate None if smartpointer is NULL
127    "$result = t_output_helper($result, ((*$1) ? SWIG_NewPointerObj((void*)($1), $1_descriptor, 1) : (delete $1, Py_INCREF(Py_None), Py_None)));"
128 %enddef
129
130
131 #define DEBUG
132 typedef long time_t;
133 %include "typemaps.i"
134 %include "std_string.i"
135 %include <lib/python/swig.h>
136 %include <lib/base/object.h>
137 %include <lib/base/eenv.h>
138 %include <lib/base/eerror.h>
139
140 %immutable eSocketNotifier::activated;
141 %include <lib/base/ebase.h>
142 %include <lib/base/smartptr.h>
143 %include <lib/service/event.h>
144 %include <lib/service/iservice.h>
145 %include <lib/service/service.h>
146
147 // TODO: embed these...
148 %immutable ePicLoad::PictureData;
149 %immutable eButton::selected;
150 %immutable eInput::changed;
151 %immutable eComponentScan::statusChanged;
152 %immutable eComponentScan::newService;
153 %immutable pNavigation::m_event;
154 %immutable pNavigation::m_record_event;
155 %immutable eListbox::selectionChanged;
156 %immutable eDVBCI_UI::ciStateChanged;
157 %immutable eSocket_UI::socketStateChanged;
158 %immutable eDVBResourceManager::frontendUseMaskChanged;
159 %immutable eAVSwitch::vcr_sb_notifier;
160 %immutable ePythonMessagePump::recv_msg;
161 %immutable eDVBLocalTimeHandler::m_timeUpdated;
162 %include <lib/base/message.h>
163 %include <lib/base/etpm.h>
164 %include <lib/base/nconfig.h>
165 %include <lib/driver/rc.h>
166 %include <lib/gdi/fb.h>
167 %include <lib/gdi/font.h>
168 %include <lib/gdi/gpixmap.h>
169 %include <lib/gdi/gmaindc.h>
170 %include <lib/gdi/epoint.h>
171 %include <lib/gdi/erect.h>
172 %include <lib/gdi/esize.h>
173 %include <lib/gui/ewidget.h>
174 %include <lib/gui/elabel.h>
175 %include <lib/gui/einput.h>
176 %include <lib/gui/einputstring.h>
177 %include <lib/gui/einputnumber.h>
178 %include <lib/gui/epixmap.h>
179 %include <lib/gui/ecanvas.h>
180 %include <lib/gui/ebutton.h>
181 %include <lib/gui/ewindow.h>
182 %include <lib/gui/eslider.h>
183 %include <lib/gui/epositiongauge.h>
184 %include <lib/gui/ewidgetdesktop.h>
185 %include <lib/gui/elistbox.h>
186 %include <lib/gui/elistboxcontent.h>
187 %include <lib/gui/ewindowstyle.h>
188 %include <lib/gui/ewindowstyleskinned.h>
189 %include <lib/gui/ewidgetanimation.h>
190 %include <lib/gui/evideo.h>
191 %include <lib/gui/esubtitle.h>
192 %include <lib/service/listboxservice.h>
193 %include <lib/nav/pcore.h>
194 %include <lib/actions/action.h>
195 %include <lib/gdi/gfont.h>
196 %include <lib/gdi/epng.h>
197 %include <lib/dvb/volume.h>
198 %include <lib/dvb/sec.h>
199 %include <lib/dvb/epgcache.h>
200 %include <lib/dvb/frontendparms.h>
201 %include <lib/dvb/dvbtime.h>
202 %include <lib/dvb/idvb.h>
203 %include <lib/dvb/dvb.h>
204 %include <lib/dvb/frontend.h>
205 %include <lib/dvb/pmt.h>
206 %include <lib/components/scan.h>
207 %include <lib/components/file_eraser.h>
208 %include <lib/driver/avswitch.h>
209 %include <lib/driver/rfmod.h>
210 %include <lib/driver/misc_options.h>
211 %include <lib/driver/etimezone.h>
212 %include <lib/gdi/lcd.h>
213 %include <lib/mmi/mmi_ui.h>
214 %include <lib/dvb_ci/dvbci.h>
215 %include <lib/dvb_ci/dvbci_ui.h>
216 %include <lib/dvb/db.h>
217 %include <lib/python/python.h>
218 %include <lib/gdi/picload.h>
219 /**************  eptr  **************/
220
221 /**************  signals  **************/
222
223 template<class R> class PSignal0
224 {
225 public:
226         PyObject *get();
227 };
228
229 %template(PSignal0V) PSignal0<void>;
230
231 %typemap(out) PSignal0V {
232         $1 = $input->get();
233 }
234
235 template<class R, class P0> class PSignal1
236 {
237 public:
238         PyObject *get();
239 };
240
241 %template(PSignal1VI) PSignal1<void,int>;
242 %template(PSignal1VS) PSignal1<void,const char *c>;
243
244 %typemap(out) PSignal1VI {
245         $1 = $input->get();
246 }
247
248 %typemap(out) PSignal1VS {
249         $1 = $input->get();
250 }
251
252 template<class R, class P0, class P1> class PSignal2
253 {
254 public:
255         PyObject *get();
256 };
257
258 %template(PSignal2VoidIRecordableServiceInt) PSignal2<void,ePtr<iRecordableService>&,int>;
259
260 %typemap(out) PSignal2VoidIRecordableServiceInt {
261         $1 = $input->get();
262 }
263
264 %{
265 RESULT SwigFromPython(ePtr<gPixmap> &result, PyObject *obj)
266 {       
267         ePtr<gPixmap> *res;
268
269         res = 0;
270         result = 0;
271 #ifndef SWIGTYPE_p_ePtrT_gPixmap_t
272 #define SWIGTYPE_p_ePtrT_gPixmap_t SWIGTYPE_p_ePtrTgPixmap_t
273 #endif
274         if (SWIG_Python_ConvertPtr(obj, (void **)&res, SWIGTYPE_p_ePtrT_gPixmap_t, SWIG_POINTER_EXCEPTION | 0))
275                 return -1;
276         if (!res)
277                 return -1;
278         result = *res;
279         return 0;
280 }
281 PyObject *New_eServiceReference(const eServiceReference &ref)
282 {
283     eServiceReference *result = new eServiceReference(ref);
284     return SWIG_NewPointerObj((void*)(result), SWIGTYPE_p_eServiceReference, 1);
285 }
286 PyObject *New_iRecordableServicePtr(const ePtr<iRecordableService> &ptr)
287 {
288     ePtr<iRecordableService> *result = new ePtr<iRecordableService>(ptr);
289 #ifndef SWIGTYPE_p_ePtrT_iRecordableService_t
290 #define SWIGTYPE_p_ePtrT_iRecordableService_t SWIGTYPE_p_ePtrTiRecordableService_t
291 #endif
292     return SWIG_NewPointerObj((void*)(result), SWIGTYPE_p_ePtrT_iRecordableService_t, 1);
293 }
294 %}
295
296 /* needed for service groups */
297
298 PyObject *getBestPlayableServiceReference(const eServiceReference &bouquet_ref, const eServiceReference &ignore, bool simulate=false);
299 %{
300 PyObject *getBestPlayableServiceReference(const eServiceReference &bouquet_ref, const eServiceReference &ignore, bool simulate=false)
301 {
302         eStaticServiceDVBBouquetInformation info;
303         if (info.isPlayable(bouquet_ref, ignore, simulate))
304                 return New_eServiceReference(info.getPlayableService());
305         Py_INCREF(Py_None);
306         return Py_None;
307 }
308 %}
309
310 void setTunerTypePriorityOrder(int);
311 %{
312 void setTunerTypePriorityOrder(int order)
313 {
314         eDVBFrontend::setTypePriorityOrder(order);
315 }
316 %}
317
318 /************** temp *****************/
319
320         /* need a better place for this, i agree. */
321 %{
322 extern void runMainloop();
323 extern void quitMainloop(int exit_code);
324 extern eApplication *getApplication();
325 extern int getPrevAsciiCode();
326 extern void addFont(const char *filename, const char *alias, int scale_factor, int is_replacement);
327 extern const char *getEnigmaVersionString();
328 extern void dump_malloc_stats(void);
329 %}
330
331 extern void addFont(const char *filename, const char *alias, int scale_factor, int is_replacement);
332 extern int getPrevAsciiCode();
333 extern void runMainloop();
334 extern void quitMainloop(int exit_code);
335 extern eApplication *getApplication();
336 extern const char *getEnigmaVersionString();
337 extern void dump_malloc_stats(void);