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