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/nconfig.h>
  43 #include <lib/base/message.h>
  44 #include <lib/driver/rc.h>
  45 #include <lib/service/event.h>
  46 #include <lib/service/iservice.h>
  47 #include <lib/service/service.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/gdi/gfbdc.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/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/frontendparms.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/dvbtime.h>
  86 #include <lib/dvb/pmt.h>
  87 #include <lib/components/scan.h>
  88 #include <lib/components/file_eraser.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/mmi/mmi_ui.h>
  95 #include <lib/dvb_ci/dvbci.h>
  96 #include <lib/dvb_ci/dvbci_ui.h>
  97 #include <lib/python/python.h>
  98 #include <lib/gdi/picload.h>
  99 %}
 100
 101 %feature("ref")   iObject "$this->AddRef(); /* eDebug(\"AddRef (%s:%d)!\", __FILE__, __LINE__); */ "
 102 %feature("unref") iObject "$this->Release(); /* eDebug(\"Release! %s:%d\", __FILE__, __LINE__); */ "
 103
 104 /* this magic allows smartpointer to be used as OUTPUT arguments, i.e. call-by-reference-styled return value. */
 105
 106 %define %typemap_output_simple(Type)
 107  %typemap(in,numinputs=0) Type *OUTPUT ($*1_ltype temp),
 108               Type &OUTPUT ($*1_ltype temp)
 109    "$1 = new Type;";
 110  %fragment("t_out_helper"{Type},"header",
 111      fragment="t_output_helper") {}
 112  %typemap(argout,fragment="t_out_helper"{Type}) Type *OUTPUT, Type &OUTPUT
 113    "$result = t_output_helper($result, (SWIG_NewPointerObj((void*)($1), $1_descriptor, 1)));"
 114 %enddef
 115
 116 %define %typemap_output_ptr(Type)
 117  %typemap(in,numinputs=0) Type *OUTPUT ($*1_ltype temp),
 118               Type &OUTPUT ($*1_ltype temp)
 119    "$1 = new Type;";
 120  %fragment("t_out_helper"{Type},"header",
 121      fragment="t_output_helper") {}
 122  %typemap(argout,fragment="t_out_helper"{Type}) Type *OUTPUT, Type &OUTPUT
 123                 // generate None if smartpointer is NULL
 124    "$result = t_output_helper($result, ((*$1) ? SWIG_NewPointerObj((void*)($1), $1_descriptor, 1) : (delete $1, Py_INCREF(Py_None), Py_None)));"
 125 %enddef
 126
 127
 128 #define DEBUG
 129 typedef long time_t;
 130 %include "typemaps.i"
 131 %include "std_string.i"
 132 %include <lib/python/swig.h>
 133 %include <lib/base/object.h>
 134 %include <lib/base/eerror.h>
 135
 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 ePicLoad::PictureData;
 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 eSocket_UI::socketStateChanged;
 154 %immutable eDVBResourceManager::frontendUseMaskChanged;
 155 %immutable eAVSwitch::vcr_sb_notifier;
 156 %immutable ePythonMessagePump::recv_msg;
 157 %immutable eDVBLocalTimeHandler::m_timeUpdated;
 158 %include <lib/base/message.h>
 159 %include <lib/base/nconfig.h>
 160 %include <lib/driver/rc.h>
 161 %include <lib/gdi/fb.h>
 162 %include <lib/gdi/font.h>
 163 %include <lib/gdi/gpixmap.h>
 164 %include <lib/gdi/gfbdc.h>
 165 %include <lib/gdi/epoint.h>
 166 %include <lib/gdi/erect.h>
 167 %include <lib/gdi/esize.h>
 168 %include <lib/gui/ewidget.h>
 169 %include <lib/gui/elabel.h>
 170 %include <lib/gui/einput.h>
 171 %include <lib/gui/einputstring.h>
 172 %include <lib/gui/einputnumber.h>
 173 %include <lib/gui/epixmap.h>
 174 %include <lib/gui/ecanvas.h>
 175 %include <lib/gui/ebutton.h>
 176 %include <lib/gui/ewindow.h>
 177 %include <lib/gui/eslider.h>
 178 %include <lib/gui/epositiongauge.h>
 179 %include <lib/gui/ewidgetdesktop.h>
 180 %include <lib/gui/elistbox.h>
 181 %include <lib/gui/elistboxcontent.h>
 182 %include <lib/gui/ewindowstyle.h>
 183 %include <lib/gui/ewindowstyleskinned.h>
 184 %include <lib/gui/ewidgetanimation.h>
 185 %include <lib/gui/evideo.h>
 186 %include <lib/service/listboxservice.h>
 187 %include <lib/nav/pcore.h>
 188 %include <lib/actions/action.h>
 189 %include <lib/gdi/gfont.h>
 190 %include <lib/gdi/epng.h>
 191 %include <lib/dvb/volume.h>
 192 %include <lib/dvb/sec.h>
 193 %include <lib/dvb/epgcache.h>
 194 %include <lib/dvb/frontendparms.h>
 195 %include <lib/dvb/dvbtime.h>
 196 %include <lib/dvb/idvb.h>
 197 %include <lib/dvb/dvb.h>
 198 %include <lib/dvb/frontend.h>
 199 %include <lib/dvb/pmt.h>
 200 %include <lib/components/scan.h>
 201 %include <lib/components/file_eraser.h>
 202 %include <lib/driver/avswitch.h>
 203 %include <lib/driver/rfmod.h>
 204 %include <lib/driver/misc_options.h>
 205 %include <lib/driver/etimezone.h>
 206 %include <lib/gdi/lcd.h>
 207 %include <lib/mmi/mmi_ui.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 #ifndef SWIGTYPE_p_ePtrT_gPixmap_t
 266 #define SWIGTYPE_p_ePtrT_gPixmap_t SWIGTYPE_p_ePtrTgPixmap_t
 267 #endif
 268         if (SWIG_Python_ConvertPtr(obj, (void **)&res, SWIGTYPE_p_ePtrT_gPixmap_t, SWIG_POINTER_EXCEPTION | 0))
 269                 return -1;
 270         if (!res)
 271                 return -1;
 272         result = *res;
 273         return 0;
 274 }
 275 PyObject *New_eServiceReference(const eServiceReference &ref)
 276 {
 277     eServiceReference *result = new eServiceReference(ref);
 278     return SWIG_NewPointerObj((void*)(result), SWIGTYPE_p_eServiceReference, 1);
 279 }
 280 PyObject *New_iRecordableServicePtr(const ePtr<iRecordableService> &ptr)
 281 {
 282     ePtr<iRecordableService> *result = new ePtr<iRecordableService>(ptr);
 283 #ifndef SWIGTYPE_p_ePtrT_iRecordableService_t
 284 #define SWIGTYPE_p_ePtrT_iRecordableService_t SWIGTYPE_p_ePtrTiRecordableService_t
 285 #endif
 286     return SWIG_NewPointerObj((void*)(result), SWIGTYPE_p_ePtrT_iRecordableService_t, 1);
 287 }
 288 %}
 289
 290 /* needed for service groups */
 291
 292 PyObject *getBestPlayableServiceReference(const eServiceReference &bouquet_ref, const eServiceReference &ignore, bool simulate=false);
 293 %{
 294 PyObject *getBestPlayableServiceReference(const eServiceReference &bouquet_ref, const eServiceReference &ignore, bool simulate=false)
 295 {
 296         eStaticServiceDVBBouquetInformation info;
 297         if (info.isPlayable(bouquet_ref, ignore, simulate))
 298                 return New_eServiceReference(info.getPlayableService());
 299         Py_INCREF(Py_None);
 300         return Py_None;
 301 }
 302 %}
 303
 304 void setTunerTypePriorityOrder(int);
 305 %{
 306 void setTunerTypePriorityOrder(int order)
 307 {
 308         eDVBFrontend::setTypePriorityOrder(order);
 309 }
 310 %}
 311
 312 /************** temp *****************/
 313
 314         /* need a better place for this, i agree. */
 315 %{
 316 extern void runMainloop();
 317 extern void quitMainloop(int exit_code);
 318 extern eApplication *getApplication();
 319 extern int getPrevAsciiCode();
 320 extern void addFont(const char *filename, const char *alias, int scale_factor, int is_replacement);
 321 extern const char *getEnigmaVersionString();
 322 extern void dump_malloc_stats(void);
 323 %}
 324
 325 extern void addFont(const char *filename, const char *alias, int scale_factor, int is_replacement);
 326 extern int getPrevAsciiCode();
 327 extern void runMainloop();
 328 extern void quitMainloop(int exit_code);
 329 extern eApplication *getApplication();
 330 extern const char *getEnigmaVersionString();
 331 extern void dump_malloc_stats(void);