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