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