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