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/driver/avswitch.h>
  87 #include <lib/driver/rfmod.h>
  88 #include <lib/driver/misc_options.h>
  89 #include <lib/driver/etimezone.h>
  90 #include <lib/gdi/lcd.h>
  91 #include <lib/dvb_ci/dvbci_ui.h>
  92 #include <lib/python/python.h>
  93 #include <lib/gdi/picexif.h>
  94 #include <lib/gdi/picload.h>
  95
  96 extern void runMainloop();
  97 extern void quitMainloop(int exit_code);
  98 extern eApplication *getApplication();
  99 extern int getPrevAsciiCode();
 100 extern int isUTF8(const std::string &);
 101 extern std::string convertUTF8DVB(const std::string &, int);
 102 extern std::string convertDVBUTF8(const unsigned char *data, int len, int table, int tsidonid);
 103 PyObject *getBestPlayableServiceReference(const eServiceReference &bouquet_ref, const eServiceReference &ignore)
 104 {
 105         eStaticServiceDVBBouquetInformation info;
 106         if (info.isPlayable(bouquet_ref, ignore))
 107                 return New_eServiceReference(info.getPlayableService());
 108         Py_INCREF(Py_None);
 109         return Py_None;
 110 }
 111 %}
 112
 113 %feature("ref")   iObject "$this->AddRef(); /* eDebug(\"AddRef (%s:%d)!\", __FILE__, __LINE__); */ "
 114 %feature("unref") iObject "$this->Release(); /* eDebug(\"Release! %s:%d\", __FILE__, __LINE__); */ "
 115
 116
 117 /* this magic allows smartpointer to be used as OUTPUT arguments, i.e. call-by-reference-styled return value. */
 118
 119 %define %typemap_output_simple(Type)
 120  %typemap(in,numinputs=0) Type *OUTPUT ($*1_ltype temp),
 121               Type &OUTPUT ($*1_ltype temp)
 122    "$1 = new Type;";
 123  %fragment("t_out_helper"{Type},"header",
 124      fragment="t_output_helper") {}
 125  %typemap(argout,fragment="t_out_helper"{Type}) Type *OUTPUT, Type &OUTPUT
 126    "$result = t_output_helper($result, (SWIG_NewPointerObj((void*)($1), $1_descriptor, 1)));"
 127 %enddef
 128
 129 %define %typemap_output_ptr(Type)
 130  %typemap(in,numinputs=0) Type *OUTPUT ($*1_ltype temp),
 131               Type &OUTPUT ($*1_ltype temp)
 132    "$1 = new Type;";
 133  %fragment("t_out_helper"{Type},"header",
 134      fragment="t_output_helper") {}
 135  %typemap(argout,fragment="t_out_helper"{Type}) Type *OUTPUT, Type &OUTPUT
 136                 // generate None if smartpointer is NULL
 137    "$result = t_output_helper($result, ((*$1) ? SWIG_NewPointerObj((void*)($1), $1_descriptor, 1) : (delete $1, Py_INCREF(Py_None), Py_None)));"
 138 %enddef
 139
 140
 141 #define DEBUG
 142 typedef long time_t;
 143 %include "typemaps.i"
 144 %include "stl.i"
 145 %include <lib/python/swig.h>
 146 %include <lib/base/object.h>
 147 %include <lib/base/eerror.h>
 148
 149 %immutable eTimer::timeout;
 150 %immutable eSocketNotifier::activated;
 151 %include <lib/base/ebase.h>
 152 %include <lib/base/smartptr.h>
 153 %include <lib/service/iservice.h>
 154 %include <lib/service/service.h>
 155
 156 %template(eServiceCenterPtr) ePtr<eServiceCenter>;
 157 %include <lib/service/event.h>
 158
 159 // TODO: embed these...
 160 %immutable eConsoleAppContainer::appClosed;
 161 %immutable eConsoleAppContainer::dataAvail;
 162 %immutable eConsoleAppContainer::dataSent;
 163 %immutable eButton::selected;
 164 %immutable eInput::changed;
 165 %immutable eComponentScan::statusChanged;
 166 %immutable eComponentScan::newService;
 167 %immutable pNavigation::m_event;
 168 %immutable pNavigation::m_record_event;
 169 %immutable eListbox::selectionChanged;
 170 %immutable eDVBCI_UI::ciStateChanged;
 171 %immutable eDVBResourceManager::frontendUseMaskChanged;
 172 %immutable eAVSwitch::vcr_sb_notifier;
 173
 174 %include <lib/base/console.h>
 175 %include <lib/base/nconfig.h>
 176 %include <lib/driver/rc.h>
 177 %include <lib/gdi/fb.h>
 178 %include <lib/gdi/font.h>
 179 %include <lib/gdi/gpixmap.h>
 180 %include <lib/gdi/epoint.h>
 181 %include <lib/gdi/erect.h>
 182 %include <lib/gdi/esize.h>
 183 %include <lib/gdi/region.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/driver/avswitch.h>
 217 %include <lib/driver/rfmod.h>
 218 %include <lib/driver/misc_options.h>
 219 %include <lib/driver/etimezone.h>
 220 %include <lib/gdi/lcd.h>
 221 %include <lib/dvb_ci/dvbci_ui.h>
 222 %include <lib/dvb/db.h>
 223 %include <lib/python/python.h>
 224 %include <lib/gdi/picexif.h>
 225 %include <lib/gdi/picload.h>
 226 /**************  eptr  **************/
 227
 228 %template(eActionMapPtr) ePtr<eActionMap>;
 229
 230 /**************  signals  **************/
 231
 232 template<class R> class PSignal0
 233 {
 234 public:
 235         PyObject *get();
 236 };
 237
 238 %template(PSignal0V) PSignal0<void>;
 239
 240 %typemap(out) PSignal0V {
 241         $1 = $input->get();
 242 }
 243
 244 template<class R, class P0> class PSignal1
 245 {
 246 public:
 247         PyObject *get();
 248 };
 249
 250 %template(PSignal1VI) PSignal1<void,int>;
 251 %template(PSignal1VS) PSignal1<void,const char *c>;
 252
 253 %typemap(out) PSignal1VI {
 254         $1 = $input->get();
 255 }
 256
 257 %typemap(out) PSignal1VS {
 258         $1 = $input->get();
 259 }
 260
 261 template<class R, class P0, class P1> class PSignal2
 262 {
 263 public:
 264         PyObject *get();
 265 };
 266
 267 %template(PSignal2VoidIRecordableServiceInt) PSignal2<void,ePtr<iRecordableService>&,int>;
 268
 269 %typemap(out) PSignal2VoidIRecordableServiceInt {
 270         $1 = $input->get();
 271 }
 272
 273 /************** temp *****************/
 274
 275         /* need a better place for this, i agree. */
 276 %{
 277 void addFont(const char *filename, const char *alias, int scale_factor, int is_replacement);
 278 %}
 279 void addFont(const char *filename, const char *alias, int scale_factor, int is_replacement);
 280
 281 /**************  debug  **************/
 282
 283 int getPrevAsciiCode();
 284 void runMainloop();
 285 void quitMainloop(int exit_code);
 286 eApplication *getApplication();
 287 PyObject *getBestPlayableServiceReference(const eServiceReference &bouquet_ref, const eServiceReference &ignore);
 288 %{
 289 RESULT SwigFromPython(ePtr<gPixmap> &result, PyObject *obj)
 290 {
 291         ePtr<gPixmap> *res;
 292
 293         res = 0;
 294         result = 0;
 295         if (SWIG_Python_ConvertPtr(obj, (void **)&res, SWIGTYPE_p_ePtrTgPixmap_t, SWIG_POINTER_EXCEPTION | 0))
 296                 return -1;
 297         if (!res)
 298                 return -1;
 299         result = *res;
 300         return 0;
 301 }
 302 PyObject *New_TestObj()
 303 {
 304     TestObj *result = (TestObj *)new TestObj();
 305     return SWIG_NewPointerObj((void*)(result), SWIGTYPE_p_TestObj, 1);
 306 }
 307 PyObject *New_eServiceReference(const eServiceReference &ref)
 308 {
 309     eServiceReference *result = new eServiceReference(ref);
 310     return SWIG_NewPointerObj((void*)(result), SWIGTYPE_p_eServiceReference, 1);
 311 }
 312 PyObject *New_iRecordableServicePtr(const ePtr<iRecordableService> &ptr)
 313 {
 314     ePtr<iRecordableService> *result = new ePtr<iRecordableService>(ptr);
 315     return SWIG_NewPointerObj((void*)(result), SWIGTYPE_p_ePtrTiRecordableService_t, 1);
 316 }
 317 %}