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