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