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/console.h>
  43 #include <lib/base/nconfig.h>
  44 #include <lib/base/message.h>
  45 #include <lib/driver/rc.h>
  46 #include <lib/service/event.h>
  47 #include <lib/service/iservice.h>
  48 #include <lib/service/service.h>
  49 #include <lib/service/servicedvb.h>
  50 #include <lib/gdi/fb.h>
  51 #include <lib/gdi/font.h>
  52 #include <lib/gdi/gpixmap.h>
  53 #include <lib/gui/ewidget.h>
  54 #include <lib/gui/elabel.h>
  55 #include <lib/gui/einput.h>
  56 #include <lib/gui/einputstring.h>
  57 #include <lib/gui/einputnumber.h>
  58 #include <lib/gui/epixmap.h>
  59 #include <lib/gui/ebutton.h>
  60 #include <lib/gui/ewindow.h>
  61 #include <lib/gui/ewidgetdesktop.h>
  62 #include <lib/gui/ewindowstyle.h>
  63 #include <lib/gui/ewindowstyleskinned.h>
  64 #include <lib/gui/ewidgetanimation.h>
  65 #include <lib/gui/eslider.h>
  66 #include <lib/gui/epositiongauge.h>
  67 #include <lib/gui/evideo.h>
  68 #include <lib/python/connections.h>
  69 #include <lib/gui/elistbox.h>
  70 #include <lib/gui/elistboxcontent.h>
  71 #include <lib/service/listboxservice.h>
  72 #include <lib/components/scan.h>
  73 #include <lib/components/file_eraser.h>
  74 #include <lib/nav/pcore.h>
  75 #include <lib/actions/action.h>
  76 #include <lib/gdi/gfont.h>
  77 #include <lib/gdi/epng.h>
  78 #include <lib/dvb/db.h>
  79 #include <lib/dvb/idvb.h>
  80 #include <lib/dvb/dvb.h>
  81 #include <lib/dvb/frontend.h>
  82 #include <lib/dvb/volume.h>
  83 #include <lib/dvb/sec.h>
  84 #include <lib/dvb/epgcache.h>
  85 #include <lib/dvb/frontendparms.h>
  86 #include <lib/dvb/dvbtime.h>
  87 #include <lib/dvb/pmt.h>
  88 #include <lib/driver/avswitch.h>
  89 #include <lib/driver/rfmod.h>
  90 #include <lib/driver/misc_options.h>
  91 #include <lib/driver/etimezone.h>
  92 #include <lib/gdi/lcd.h>
  93 #include <lib/dvb_ci/dvbci.h>
  94 #include <lib/dvb_ci/dvbci_ui.h>
  95 #include <lib/python/python.h>
  96 #include <lib/gdi/picload.h>
  97 %}
  98
  99 %feature("ref")   iObject "$this->AddRef(); /* eDebug(\"AddRef (%s:%d)!\", __FILE__, __LINE__); */ "
 100 %feature("unref") iObject "$this->Release(); /* eDebug(\"Release! %s:%d\", __FILE__, __LINE__); */ "
 101
 102 /* this magic allows smartpointer to be used as OUTPUT arguments, i.e. call-by-reference-styled return value. */
 103
 104 %define %typemap_output_simple(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    "$result = t_output_helper($result, (SWIG_NewPointerObj((void*)($1), $1_descriptor, 1)));"
 112 %enddef
 113
 114 %define %typemap_output_ptr(Type)
 115  %typemap(in,numinputs=0) Type *OUTPUT ($*1_ltype temp),
 116               Type &OUTPUT ($*1_ltype temp)
 117    "$1 = new Type;";
 118  %fragment("t_out_helper"{Type},"header",
 119      fragment="t_output_helper") {}
 120  %typemap(argout,fragment="t_out_helper"{Type}) Type *OUTPUT, Type &OUTPUT
 121                 // generate None if smartpointer is NULL
 122    "$result = t_output_helper($result, ((*$1) ? SWIG_NewPointerObj((void*)($1), $1_descriptor, 1) : (delete $1, Py_INCREF(Py_None), Py_None)));"
 123 %enddef
 124
 125
 126 #define DEBUG
 127 typedef long time_t;
 128 %include "typemaps.i"
 129 %include "std_string.i"
 130 %include <lib/python/swig.h>
 131 %include <lib/base/object.h>
 132 %include <lib/base/eerror.h>
 133
 134 %immutable eTimer::timeout;
 135 %immutable eSocketNotifier::activated;
 136 %include <lib/base/ebase.h>
 137 %include <lib/base/smartptr.h>
 138 %include <lib/service/event.h>
 139 %include <lib/service/iservice.h>
 140 %include <lib/service/service.h>
 141
 142 // TODO: embed these...
 143 %immutable eConsoleAppContainer::appClosed;
 144 %immutable eConsoleAppContainer::dataAvail;
 145 %immutable eConsoleAppContainer::dataSent;
 146 %immutable eButton::selected;
 147 %immutable eInput::changed;
 148 %immutable eComponentScan::statusChanged;
 149 %immutable eComponentScan::newService;
 150 %immutable pNavigation::m_event;
 151 %immutable pNavigation::m_record_event;
 152 %immutable eListbox::selectionChanged;
 153 %immutable eDVBCI_UI::ciStateChanged;
 154 %immutable eDVBResourceManager::frontendUseMaskChanged;
 155 %immutable eAVSwitch::vcr_sb_notifier;
 156 %immutable ePythonMessagePump::recv_msg;
 157 %immutable eDVBLocalTimeHandler::m_timeUpdated;
 158 %include <lib/base/message.h>
 159 %include <lib/base/console.h>
 160 %include <lib/base/nconfig.h>
 161 %include <lib/driver/rc.h>
 162 %include <lib/gdi/fb.h>
 163 %include <lib/gdi/font.h>
 164 %include <lib/gdi/gpixmap.h>
 165 %include <lib/gdi/epoint.h>
 166 %include <lib/gdi/erect.h>
 167 %include <lib/gdi/esize.h>
 168 %include <lib/gui/ewidget.h>
 169 %include <lib/gui/elabel.h>
 170 %include <lib/gui/einput.h>
 171 %include <lib/gui/einputstring.h>
 172 %include <lib/gui/einputnumber.h>
 173 %include <lib/gui/epixmap.h>
 174 %include <lib/gui/ebutton.h>
 175 %include <lib/gui/ewindow.h>
 176 %include <lib/gui/eslider.h>
 177 %include <lib/gui/epositiongauge.h>
 178 %include <lib/gui/ewidgetdesktop.h>
 179 %include <lib/gui/elistbox.h>
 180 %include <lib/gui/elistboxcontent.h>
 181 %include <lib/gui/ewindowstyle.h>
 182 %include <lib/gui/ewindowstyleskinned.h>
 183 %include <lib/gui/ewidgetanimation.h>
 184 %include <lib/gui/evideo.h>
 185 %include <lib/service/listboxservice.h>
 186 %include <lib/components/scan.h>
 187 %include <lib/components/file_eraser.h>
 188 %include <lib/nav/pcore.h>
 189 %include <lib/actions/action.h>
 190 %include <lib/gdi/gfont.h>
 191 %include <lib/gdi/epng.h>
 192 %include <lib/dvb/volume.h>
 193 %include <lib/dvb/sec.h>
 194 %include <lib/dvb/epgcache.h>
 195 %include <lib/dvb/frontendparms.h>
 196 %include <lib/dvb/dvbtime.h>
 197 %include <lib/dvb/idvb.h>
 198 %include <lib/dvb/dvb.h>
 199 %include <lib/dvb/frontend.h>
 200 %include <lib/dvb/pmt.h>
 201 %include <lib/driver/avswitch.h>
 202 %include <lib/driver/rfmod.h>
 203 %include <lib/driver/misc_options.h>
 204 %include <lib/driver/etimezone.h>
 205 %include <lib/gdi/lcd.h>
 206 %include <lib/dvb_ci/dvbci.h>
 207 %include <lib/dvb_ci/dvbci_ui.h>
 208 %include <lib/dvb/db.h>
 209 %include <lib/python/python.h>
 210 %include <lib/gdi/picload.h>
 211 /**************  eptr  **************/
 212
 213 /**************  signals  **************/
 214
 215 template<class R> class PSignal0
 216 {
 217 public:
 218         PyObject *get();
 219 };
 220
 221 %template(PSignal0V) PSignal0<void>;
 222
 223 %typemap(out) PSignal0V {
 224         $1 = $input->get();
 225 }
 226
 227 template<class R, class P0> class PSignal1
 228 {
 229 public:
 230         PyObject *get();
 231 };
 232
 233 %template(PSignal1VI) PSignal1<void,int>;
 234 %template(PSignal1VS) PSignal1<void,const char *c>;
 235
 236 %typemap(out) PSignal1VI {
 237         $1 = $input->get();
 238 }
 239
 240 %typemap(out) PSignal1VS {
 241         $1 = $input->get();
 242 }
 243
 244 template<class R, class P0, class P1> class PSignal2
 245 {
 246 public:
 247         PyObject *get();
 248 };
 249
 250 %template(PSignal2VoidIRecordableServiceInt) PSignal2<void,ePtr<iRecordableService>&,int>;
 251
 252 %typemap(out) PSignal2VoidIRecordableServiceInt {
 253         $1 = $input->get();
 254 }
 255
 256 %{
 257 RESULT SwigFromPython(ePtr<gPixmap> &result, PyObject *obj)
 258 {
 259         ePtr<gPixmap> *res;
 260
 261         res = 0;
 262         result = 0;
 263         if (SWIG_Python_ConvertPtr(obj, (void **)&res, SWIGTYPE_p_ePtrTgPixmap_t, SWIG_POINTER_EXCEPTION | 0))
 264                 return -1;
 265         if (!res)
 266                 return -1;
 267         result = *res;
 268         return 0;
 269 }
 270 PyObject *New_eServiceReference(const eServiceReference &ref)
 271 {
 272     eServiceReference *result = new eServiceReference(ref);
 273     return SWIG_NewPointerObj((void*)(result), SWIGTYPE_p_eServiceReference, 1);
 274 }
 275 PyObject *New_iRecordableServicePtr(const ePtr<iRecordableService> &ptr)
 276 {
 277     ePtr<iRecordableService> *result = new ePtr<iRecordableService>(ptr);
 278     return SWIG_NewPointerObj((void*)(result), SWIGTYPE_p_ePtrTiRecordableService_t, 1);
 279 }
 280 %}
 281
 282 /* needed for service groups */
 283
 284 PyObject *getBestPlayableServiceReference(const eServiceReference &bouquet_ref, const eServiceReference &ignore);
 285 %{
 286 PyObject *getBestPlayableServiceReference(const eServiceReference &bouquet_ref, const eServiceReference &ignore)
 287 {
 288         eStaticServiceDVBBouquetInformation info;
 289         if (info.isPlayable(bouquet_ref, ignore))
 290                 return New_eServiceReference(info.getPlayableService());
 291         Py_INCREF(Py_None);
 292         return Py_None;
 293 }
 294 %}
 295
 296 /************** temp *****************/
 297
 298         /* need a better place for this, i agree. */
 299 %{
 300 extern void runMainloop();
 301 extern void quitMainloop(int exit_code);
 302 extern eApplication *getApplication();
 303 extern int getPrevAsciiCode();
 304 extern void addFont(const char *filename, const char *alias, int scale_factor, int is_replacement);
 305 %}
 306
 307 extern void addFont(const char *filename, const char *alias, int scale_factor, int is_replacement);
 308 extern int getPrevAsciiCode();
 309 extern void runMainloop();
 310 extern void quitMainloop(int exit_code);
 311 extern eApplication *getApplication();