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