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