add eConsoleAppContainer to execute shell scripts or applications from python without...
[enigma2.git] / lib / python / enigma_python.i
index 15bc16e232205791112dc1ffc9766b4f250b7a02..42315ce78663de05314dbd6f87786cae79664e59 100644 (file)
+/*
+  NOTE: you have two options when adding classes so that
+  they are callable *from* python.
+  
+   - either you %include the header file
+   - or you re-declare it
+   
+  In both cases, you must #include the required
+  header file (i.e. the header file itself), otherwise
+  enigma_python_wrap.cxx won't build.
+  
+       In case you import the whole header file,
+       please make sure that no unimportant stuff
+       is wrapped, as this makes the wrapper stuff
+       much more complex and it can probably break 
+       very easily because of missing typemaps etc.
+       
+       you could make use of dizzy macros to ensure
+       that some stuff is left out when parsed as SWIG
+       definitions, but be sure to not modify the binary 
+       representation. DON'T USE #ifdef SWIG_COMPILE
+       for leaving out stuff (unless you *really* know
+       what you are doing,of course!). you WILL break it.
+               
+       The better way (with more work) is to re-declare
+       the class. It won't be compiled, so you can
+       leave out stuff as you like.
+
+
+
+Oh, things like "operator= is private in this context" etc.
+is usually caused by not marking PSignals as immutable. 
+*/
+
 %module enigma
 %{
+
 #define SWIG_COMPILE
+#include <lib/base/ebase.h>
 #include <lib/base/smartptr.h>
 #include <lib/base/eerror.h>
-#include <lib/base/econfig.h>
+#include <lib/base/console.h>
 #include <lib/service/iservice.h>
 #include <lib/service/service.h>
-
+#include <lib/service/event.h>
+#include <lib/gdi/font.h>
+#include <lib/gdi/gpixmap.h>
 #include <lib/gui/ewidget.h>
 #include <lib/gui/elabel.h>
+#include <lib/gui/einput.h>
+#include <lib/gui/einputstring.h>
+#include <lib/gui/einputnumber.h>
+#include <lib/gui/epixmap.h>
 #include <lib/gui/ebutton.h>
 #include <lib/gui/ewindow.h>
 #include <lib/gui/ewidgetdesktop.h>
+#include <lib/gui/ewindowstyle.h>
+#include <lib/gui/ewindowstyleskinned.h>
+#include <lib/gui/ewidgetanimation.h>
 #include <lib/gui/eslider.h>
+#include <lib/gui/epositiongauge.h>
 #include <lib/python/connections.h>
+#include <lib/gui/elistbox.h>
+#include <lib/gui/elistboxcontent.h>
+#include <lib/service/listboxservice.h>
+#include <lib/components/scan.h>
+#include <lib/components/listboxepg.h>
+#include <lib/nav/pcore.h>
+#include <lib/actions/action.h>
+#include <lib/gdi/gfont.h>
+#include <lib/gdi/epng.h>
+#include <lib/dvb/db.h>
+#include <lib/dvb/volume.h>
+#include <lib/dvb/sec.h>
+#include <lib/dvb/epgcache.h>
+#include <lib/dvb/frontendparms.h>
+#include <lib/dvb/dvbtime.h>
+#include <lib/driver/avswitch.h>
+#include <lib/driver/rfmod.h>
+#include <lib/driver/etimezone.h>
+#include <lib/gdi/lcd.h>
+#include <lib/dvb_ci/dvbci_ui.h>
+#include <lib/python/python.h>
+
+extern void runMainloop();
+extern void quitMainloop(int exit_code);
+extern void setLCD(const char *c);
+extern void setLCDClock(const char *c);
+extern eApplication *getApplication();
+
+extern PSignal1<void,int> &keyPressedSignal();
 %}
 
+%feature("ref")   iObject "$this->AddRef(); /* eDebug(\"AddRef (%s:%d)!\", __FILE__, __LINE__); */ "
+%feature("unref") iObject "$this->Release(); /* eDebug(\"Release! %s:%d\", __FILE__, __LINE__); */ "
+
+
+/* this magic allows smartpointer to be used as OUTPUT arguments, i.e. call-by-reference-styled return value. */
+
+%define %typemap_output_simple(Type)
+ %typemap(in,numinputs=0) Type *OUTPUT ($*1_ltype temp),
+              Type &OUTPUT ($*1_ltype temp)
+   "$1 = new Type;";
+ %fragment("t_out_helper"{Type},"header",
+     fragment="t_output_helper") {}
+ %typemap(argout,fragment="t_out_helper"{Type}) Type *OUTPUT, Type &OUTPUT
+   "$result = t_output_helper($result, (SWIG_NewPointerObj((void*)($1), $1_descriptor, 1)));"
+%enddef
+
+%define %typemap_output_ptr(Type)
+ %typemap(in,numinputs=0) Type *OUTPUT ($*1_ltype temp),
+              Type &OUTPUT ($*1_ltype temp)
+   "$1 = new Type;";
+ %fragment("t_out_helper"{Type},"header",
+     fragment="t_output_helper") {}
+ %typemap(argout,fragment="t_out_helper"{Type}) Type *OUTPUT, Type &OUTPUT
+               // generate None if smartpointer is NULL
+   "$result = t_output_helper($result, ((*$1) ? SWIG_NewPointerObj((void*)($1), $1_descriptor, 1) : (Py_INCREF(Py_None), Py_None)));"
+%enddef
+
+
 #define DEBUG
+typedef long time_t;
+%include "typemaps.i"
 %include "stl.i"
+%include <lib/python/swig.h>
 %include <lib/base/object.h>
 %include <lib/base/eerror.h>
-%include <lib/base/econfig.h>
+
+%immutable eTimer::timeout;
+%immutable eSocketNotifier::activated;
+%include <lib/base/ebase.h>
 %include <lib/base/smartptr.h>
 %include <lib/service/iservice.h>
 %include <lib/service/service.h>
+
 %template(eServiceCenterPtr) ePtr<eServiceCenter>;
+%include <lib/service/event.h>
+
 
+// TODO: embed these...
+%immutable eConsoleAppContainer::appClosed;
+%immutable eConsoleAppContainer::dataAvail;
+%immutable eConsoleAppContainer::dataSent;
 %immutable eButton::selected;
+%immutable eInput::changed;
+%immutable eComponentScan::statusChanged;
+%immutable eComponentScan::newService;
+%immutable pNavigation::m_event;
+%immutable eListbox::selectionChanged;
 
+%include <lib/base/console.h>
+%include <lib/gdi/font.h>
+%include <lib/gdi/gpixmap.h>
 %include <lib/gdi/epoint.h>
 %include <lib/gdi/erect.h>
 %include <lib/gdi/esize.h>
 %include <lib/gdi/region.h>
 %include <lib/gui/ewidget.h>
 %include <lib/gui/elabel.h>
+%include <lib/gui/einput.h>
+%include <lib/gui/einputstring.h>
+%include <lib/gui/einputnumber.h>
+%include <lib/gui/epixmap.h>
 %include <lib/gui/ebutton.h>
 %include <lib/gui/ewindow.h>
 %include <lib/gui/eslider.h>
+%include <lib/gui/epositiongauge.h>
 %include <lib/gui/ewidgetdesktop.h>
+%include <lib/gui/elistbox.h>
+%include <lib/gui/elistboxcontent.h>
+%include <lib/gui/ewindowstyle.h>
+%include <lib/gui/ewindowstyleskinned.h>
+%include <lib/gui/ewidgetanimation.h>
+%include <lib/service/listboxservice.h>
+%include <lib/components/scan.h>
+%include <lib/components/listboxepg.h>
+%include <lib/nav/pcore.h>
+%include <lib/actions/action.h>
+%include <lib/gdi/gfont.h>
+%include <lib/gdi/epng.h>
+%include <lib/dvb/volume.h>
+%include <lib/dvb/sec.h>
+%include <lib/dvb/epgcache.h>
+%include <lib/dvb/frontendparms.h>
+%include <lib/dvb/dvbtime.h>
+%include <lib/driver/avswitch.h>
+%include <lib/driver/rfmod.h>
+%include <lib/driver/etimezone.h>
+%include <lib/gdi/lcd.h>
+%include <lib/dvb_ci/dvbci_ui.h>
+%include <lib/dvb/db.h>
+%include <lib/python/python.h>
+/**************  eptr  **************/
+
+%template(eActionMapPtr) ePtr<eActionMap>;
+
+/**************  signals  **************/
 
 template<class R> class PSignal0
 {
@@ -45,27 +203,74 @@ public:
        PyObject *get();
 };
 
+%template(PSignal0V) PSignal0<void>;
+
+%typemap(out) PSignal0V {
+       $1 = $input->get();
+}
+
 template<class R, class P0> class PSignal1
 {
 public:
        PyObject *get();
 };
 
-template<class R, class P0, class P1> class PSignal2
+%template(PSignal1VI) PSignal1<void,int>;
+
+%typemap(out) PSignal1VI {
+       $1 = $input->get();
+}
+
+template<class R, class P0> class PSignal1Str
 {
 public:
        PyObject *get();
 };
 
-%template(PSignal1VI) PSignal1<void,int>;
+%template(PSignal1VS) PSignal1Str<void,const char*>;
 
-%typemap(out) PSignal1VI {
+%typemap(out) PSignal1VS {
        $1 = $input->get();
 }
 
-%template(PSignal0V) PSignal0<void>;
+template<class R, class P0, class P1> class PSignal2
+{
+public:
+       PyObject *get();
+};
 
-%typemap(out) PSignal0V {
-       $1 = $input->get();
-}
+/**************  debug  **************/
+
+void runMainloop();
+void quitMainloop(int exit_code);
+void setLCD(const char*);
+void setLCDClock(const char*);
+eApplication *getApplication();
+%immutable keyPressed;
+PSignal1<void,int> &keyPressedSignal();
+
+%{
+RESULT SwigFromPython(ePtr<gPixmap> &result, PyObject *obj)
+{      
+       ePtr<gPixmap> *res;
 
+       res = 0;
+       result = 0;
+       if (SWIG_Python_ConvertPtr(obj, (void **)&res, SWIGTYPE_p_ePtrTgPixmap_t, SWIG_POINTER_EXCEPTION | 0))
+               return -1;
+       if (!res)
+               return -1;
+       result = *res;
+       return 0;
+}
+PyObject *New_TestObj()
+{
+    TestObj *result = (TestObj *)new TestObj();
+    return SWIG_NewPointerObj((void*)(result), SWIGTYPE_p_TestObj, 1);
+}
+PyObject *New_eServiceReference(const eServiceReference &ref)
+{
+    eServiceReference *result = new eServiceReference(ref);
+    return SWIG_NewPointerObj((void*)(result), SWIGTYPE_p_eServiceReference, 1);
+}
+%}