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