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