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