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