make eDVBSatelliteEquipmentControl useable 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/econfig.h>
43 #include <lib/service/iservice.h>
44 #include <lib/service/service.h>
45 #include <lib/service/event.h>
46
47 #include <lib/gdi/gpixmap.h>
48
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/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/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/driver/avswitch.h>
74 #include <lib/driver/rfmod.h>
75
76 extern void runMainloop();
77 extern void quitMainloop();
78 extern void setLCD(const char *c);
79 extern void setLCDClock(const char *c);
80
81 extern PSignal1<void,int> &keyPressedSignal();
82 %}
83
84 %feature("ref")   iObject "$this->AddRef(); /* eDebug(\"AddRef (%s:%d)!\", __FILE__, __LINE__); */ "
85 %feature("unref") iObject "$this->Release(); /* eDebug(\"Release! %s:%d\", __FILE__, __LINE__); */ "
86
87
88 /* this magic allows smartpointer to be used as OUTPUT arguments, i.e. call-by-reference-styled return value. */
89
90 %define %typemap_output_simple(Type)
91  %typemap(in,numinputs=0) Type *OUTPUT ($*1_ltype temp),
92               Type &OUTPUT ($*1_ltype temp)
93    "$1 = new Type;";
94  %fragment("t_out_helper"{Type},"header",
95      fragment="t_output_helper") {}
96  %typemap(argout,fragment="t_out_helper"{Type}) Type *OUTPUT, Type &OUTPUT
97    "$result = t_output_helper($result, (SWIG_NewPointerObj((void*)($1), $1_descriptor, 1)));"
98 %enddef
99
100 %define %typemap_output_ptr(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                 // generate None if smartpointer is NULL
108    "$result = t_output_helper($result, ((*$1) ? SWIG_NewPointerObj((void*)($1), $1_descriptor, 1) : (Py_INCREF(Py_None), Py_None)));"
109 %enddef
110
111
112 #define DEBUG
113 %include "typemaps.i"
114 %include "stl.i"
115 %include <lib/python/swig.h>
116 %include <lib/base/object.h>
117 %include <lib/base/eerror.h>
118 %include <lib/base/econfig.h>
119 %include <lib/base/smartptr.h>
120 %include <lib/service/iservice.h>
121 %include <lib/service/service.h>
122
123 %template(eServiceCenterPtr) ePtr<eServiceCenter>;
124 %include <lib/service/event.h>
125
126
127 // TODO: embed these...
128 %immutable eButton::selected;
129 %immutable eInput::changed;
130 %immutable eComponentScan::statusChanged;
131 %immutable pNavigation::m_event;
132
133 %include <lib/gdi/epoint.h>
134 %include <lib/gdi/erect.h>
135 %include <lib/gdi/esize.h>
136 %include <lib/gdi/region.h>
137 %include <lib/gui/ewidget.h>
138 %include <lib/gui/elabel.h>
139 %include <lib/gui/einput.h>
140 %include <lib/gui/einputstring.h>
141 %include <lib/gui/einputnumber.h>
142 %include <lib/gui/epixmap.h>
143 %include <lib/gui/ebutton.h>
144 %include <lib/gui/ewindow.h>
145 %include <lib/gui/eslider.h>
146 %include <lib/gui/ewidgetdesktop.h>
147 %include <lib/gui/elistbox.h>
148 %include <lib/gui/elistboxcontent.h>
149 %include <lib/gui/ewindowstyle.h>
150 %include <lib/gui/ewindowstyleskinned.h>
151 %include <lib/gui/ewidgetanimation.h>
152 %include <lib/service/listboxservice.h>
153 %include <lib/components/scan.h>
154 %include <lib/nav/pcore.h>
155 %include <lib/actions/action.h>
156 %include <lib/gdi/gfont.h>
157 %include <lib/gdi/epng.h>
158 %include <lib/dvb/volume.h>
159 %include <lib/dvb/sec.h>
160 %include <lib/driver/avswitch.h>
161 %include <lib/driver/rfmod.h>
162
163 %include <lib/gdi/gpixmap.h>
164 /**************  eptr  **************/
165
166 %template(eActionMapPtr) ePtr<eActionMap>;
167 %apply eActionMapPtr OUTPUT { eActionMapPtr &ptr }
168 %apply eActionMap* *OUTPUT { eActionMap **ptr }
169
170 /**************  signals  **************/
171
172 template<class R> class PSignal0
173 {
174 public:
175         PyObject *get();
176 };
177
178 template<class R, class P0> class PSignal1
179 {
180 public:
181         PyObject *get();
182 };
183
184 template<class R, class P0, class P1> class PSignal2
185 {
186 public:
187         PyObject *get();
188 };
189
190 %template(PSignal1VI) PSignal1<void,int>;
191
192 %typemap(out) PSignal1VI {
193         $1 = $input->get();
194 }
195
196 %template(PSignal0V) PSignal0<void>;
197
198 %typemap(out) PSignal0V {
199         $1 = $input->get();
200 }
201
202 /**************  base  **************/
203
204 %immutable eTimer::timeout;
205
206 class eTimer
207 {
208 public:
209         eTimer(eMainloop *context = eApp);
210         PSignal0<void> timeout;
211
212         void start(long msec, bool singleShot=false);
213         void stop();
214         void changeInterval(long msek);
215 };
216
217 /**************  debug  **************/
218
219 void runMainloop();
220 void quitMainloop();
221 void setLCD(const char*);
222 void setLCDClock(const char*);
223 %immutable keyPressed;
224 PSignal1<void,int> &keyPressedSignal();
225