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