add some .cvsignore
[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/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/mmi/mmi_ui.h>
96 #include <lib/mmi/socket_mmi.h>
97 #include <lib/dvb_ci/dvbci.h>
98 #include <lib/dvb_ci/dvbci_ui.h>
99 #include <lib/python/python.h>
100 #include <lib/gdi/picload.h>
101 %}
102
103 %feature("ref")   iObject "$this->AddRef(); /* eDebug(\"AddRef (%s:%d)!\", __FILE__, __LINE__); */ "
104 %feature("unref") iObject "$this->Release(); /* eDebug(\"Release! %s:%d\", __FILE__, __LINE__); */ "
105
106 /* this magic allows smartpointer to be used as OUTPUT arguments, i.e. call-by-reference-styled return value. */
107
108 %define %typemap_output_simple(Type)
109  %typemap(in,numinputs=0) Type *OUTPUT ($*1_ltype temp),
110               Type &OUTPUT ($*1_ltype temp)
111    "$1 = new Type;";
112  %fragment("t_out_helper"{Type},"header",
113      fragment="t_output_helper") {}
114  %typemap(argout,fragment="t_out_helper"{Type}) Type *OUTPUT, Type &OUTPUT
115    "$result = t_output_helper($result, (SWIG_NewPointerObj((void*)($1), $1_descriptor, 1)));"
116 %enddef
117
118 %define %typemap_output_ptr(Type)
119  %typemap(in,numinputs=0) Type *OUTPUT ($*1_ltype temp),
120               Type &OUTPUT ($*1_ltype temp)
121    "$1 = new Type;";
122  %fragment("t_out_helper"{Type},"header",
123      fragment="t_output_helper") {}
124  %typemap(argout,fragment="t_out_helper"{Type}) Type *OUTPUT, Type &OUTPUT
125                 // generate None if smartpointer is NULL
126    "$result = t_output_helper($result, ((*$1) ? SWIG_NewPointerObj((void*)($1), $1_descriptor, 1) : (delete $1, Py_INCREF(Py_None), Py_None)));"
127 %enddef
128
129
130 #define DEBUG
131 typedef long time_t;
132 %include "typemaps.i"
133 %include "std_string.i"
134 %include <lib/python/swig.h>
135 %include <lib/base/object.h>
136 %include <lib/base/eerror.h>
137
138 %immutable eTimer::timeout;
139 %immutable eSocketNotifier::activated;
140 %include <lib/base/ebase.h>
141 %include <lib/base/smartptr.h>
142 %include <lib/service/event.h>
143 %include <lib/service/iservice.h>
144 %include <lib/service/service.h>
145
146 // TODO: embed these...
147 %immutable eConsoleAppContainer::appClosed;
148 %immutable eConsoleAppContainer::dataAvail;
149 %immutable eConsoleAppContainer::dataSent;
150 %immutable eButton::selected;
151 %immutable eInput::changed;
152 %immutable eComponentScan::statusChanged;
153 %immutable eComponentScan::newService;
154 %immutable pNavigation::m_event;
155 %immutable pNavigation::m_record_event;
156 %immutable eListbox::selectionChanged;
157 %immutable eDVBCI_UI::ciStateChanged;
158 %immutable eSocket_UI::socketStateChanged;
159 %immutable eDVBResourceManager::frontendUseMaskChanged;
160 %immutable eAVSwitch::vcr_sb_notifier;
161 %immutable ePythonMessagePump::recv_msg;
162 %immutable eDVBLocalTimeHandler::m_timeUpdated;
163 %include <lib/base/message.h>
164 %include <lib/base/console.h>
165 %include <lib/base/nconfig.h>
166 %include <lib/driver/rc.h>
167 %include <lib/gdi/fb.h>
168 %include <lib/gdi/font.h>
169 %include <lib/gdi/gpixmap.h>
170 %include <lib/gdi/gfbdc.h>
171 %include <lib/gdi/epoint.h>
172 %include <lib/gdi/erect.h>
173 %include <lib/gdi/esize.h>
174 %include <lib/gui/ewidget.h>
175 %include <lib/gui/elabel.h>
176 %include <lib/gui/einput.h>
177 %include <lib/gui/einputstring.h>
178 %include <lib/gui/einputnumber.h>
179 %include <lib/gui/epixmap.h>
180 %include <lib/gui/ecanvas.h>
181 %include <lib/gui/ebutton.h>
182 %include <lib/gui/ewindow.h>
183 %include <lib/gui/eslider.h>
184 %include <lib/gui/epositiongauge.h>
185 %include <lib/gui/ewidgetdesktop.h>
186 %include <lib/gui/elistbox.h>
187 %include <lib/gui/elistboxcontent.h>
188 %include <lib/gui/ewindowstyle.h>
189 %include <lib/gui/ewindowstyleskinned.h>
190 %include <lib/gui/ewidgetanimation.h>
191 %include <lib/gui/evideo.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/mmi/socket_mmi.h>
215 %include <lib/dvb_ci/dvbci.h>
216 %include <lib/dvb_ci/dvbci_ui.h>
217 %include <lib/dvb/db.h>
218 %include <lib/python/python.h>
219 %include <lib/gdi/picload.h>
220 /**************  eptr  **************/
221
222 /**************  signals  **************/
223
224 template<class R> class PSignal0
225 {
226 public:
227         PyObject *get();
228 };
229
230 %template(PSignal0V) PSignal0<void>;
231
232 %typemap(out) PSignal0V {
233         $1 = $input->get();
234 }
235
236 template<class R, class P0> class PSignal1
237 {
238 public:
239         PyObject *get();
240 };
241
242 %template(PSignal1VI) PSignal1<void,int>;
243 %template(PSignal1VS) PSignal1<void,const char *c>;
244
245 %typemap(out) PSignal1VI {
246         $1 = $input->get();
247 }
248
249 %typemap(out) PSignal1VS {
250         $1 = $input->get();
251 }
252
253 template<class R, class P0, class P1> class PSignal2
254 {
255 public:
256         PyObject *get();
257 };
258
259 %template(PSignal2VoidIRecordableServiceInt) PSignal2<void,ePtr<iRecordableService>&,int>;
260
261 %typemap(out) PSignal2VoidIRecordableServiceInt {
262         $1 = $input->get();
263 }
264
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_eServiceReference(const eServiceReference &ref)
280 {
281     eServiceReference *result = new eServiceReference(ref);
282     return SWIG_NewPointerObj((void*)(result), SWIGTYPE_p_eServiceReference, 1);
283 }
284 PyObject *New_iRecordableServicePtr(const ePtr<iRecordableService> &ptr)
285 {
286     ePtr<iRecordableService> *result = new ePtr<iRecordableService>(ptr);
287     return SWIG_NewPointerObj((void*)(result), SWIGTYPE_p_ePtrTiRecordableService_t, 1);
288 }
289 %}
290
291 /* needed for service groups */
292
293 PyObject *getBestPlayableServiceReference(const eServiceReference &bouquet_ref, const eServiceReference &ignore);
294 %{
295 PyObject *getBestPlayableServiceReference(const eServiceReference &bouquet_ref, const eServiceReference &ignore)
296 {
297         eStaticServiceDVBBouquetInformation info;
298         if (info.isPlayable(bouquet_ref, ignore))
299                 return New_eServiceReference(info.getPlayableService());
300         Py_INCREF(Py_None);
301         return Py_None;
302 }
303 %}
304
305 void setTunerTypePriorityOrder(int);
306 %{
307 void setTunerTypePriorityOrder(int order)
308 {
309         eDVBFrontend::setTypePriorityOrder(order);
310 }
311 %}
312
313 /************** temp *****************/
314
315         /* need a better place for this, i agree. */
316 %{
317 extern void runMainloop();
318 extern void quitMainloop(int exit_code);
319 extern eApplication *getApplication();
320 extern int getPrevAsciiCode();
321 extern void addFont(const char *filename, const char *alias, int scale_factor, int is_replacement);
322 extern const char *getEnigmaVersionString();
323 %}
324
325 extern void addFont(const char *filename, const char *alias, int scale_factor, int is_replacement);
326 extern int getPrevAsciiCode();
327 extern void runMainloop();
328 extern void quitMainloop(int exit_code);
329 extern eApplication *getApplication();
330 extern const char *getEnigmaVersionString();