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