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