FXPython.h

Go to the documentation of this file.

/********************************************************************************
*                                                                               *
*                           Python embedding support                            *
*                                                                               *
*********************************************************************************
*        Copyright (C) 2003-2006 by Niall Douglas.   All Rights Reserved.       *
*       NOTE THAT I DO NOT PERMIT ANY OF MY CODE TO BE PROMOTED TO THE GPL      *
*********************************************************************************
* This code is free software; you can redistribute it and/or modify it under    *
* the terms of the GNU Library General Public License v2.1 as published by the  *
* Free Software Foundation EXCEPT that clause 3 does not apply ie; you may not  *
* "upgrade" this code to the GPL without my prior written permission.           *
* Please consult the file "License_Addendum2.txt" accompanying this file.       *
*                                                                               *
* This code is distributed in the hope that it will be useful,                  *
* but WITHOUT ANY WARRANTY; without even the implied warranty of                *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                          *
*********************************************************************************
* $Id:                                                                          *
********************************************************************************/

#ifndef FXPYTHON_H

#ifndef FXPYTHON_FROMBOOSTINVOKE
// Include boost.python as it includes us
#ifndef BOOST_PYTHON_DYNAMIC_LIB
#define BOOST_PYTHON_DYNAMIC_LIB
#endif
#ifndef BOOST_PYTHON_MAX_ARITY
#define BOOST_PYTHON_MAX_ARITY 19
#endif
#include <boost/python.hpp>
#else
#define FXPYTHON_H
#include "../include/FXString.h"
#include "../include/FXGenericTools.h"
#include "../include/FXObject.h"
#include <boost/python/opaque_pointer_converter.hpp>

#ifdef WIN32
  #ifdef FOXPYTHONDLL_EXPORTS
    #define FXPYTHONAPI __declspec(dllexport)
  #else
    #define FXPYTHONAPI __declspec(dllimport)
  #endif
#else
  #ifdef GCC_HASCLASSVISIBILITY
    #define FXPYTHONAPI __attribute__ ((visibility("default")))
  #else
    #define FXPYTHONAPI
  #endif
#endif
#ifndef FXPYTHONAPI
  #define FXPYTHONAPI
#endif


namespace FX {

class QThread;
class FXComboBox;
class FXFoldingList;
class FXGLViewer;
class FXIconList;
class FXList;
class FXListBox;
class FXTreeList;
class FXTreeListBox;
class FXComposite;

class FXEXCEPTIONAPI(FXPYTHONAPI) FXPythonException : public FXException
{
    friend class FXPython;
    FXPythonException() { }
public:
    FXPythonException(const FXString &msg, FXuint flags)
        : FXException(0, 0, msg, FXEXCEPTION_PYTHONERROR, flags) { }
};
#define FXERRHPY(ret) { if((ret)<=0) FXPython::int_throwPythonException(); }


class FXPYTHONAPI FXPython
{
public:
    static FXString interpreterPath();
    static FXString version();
    static FXString platform();
    static FXString programName();
    static void setProgramName(const FXString &name);
    static void setArgv(int argc, char **argv);
    static boost::python::handle<> globals();
    static boost::python::handle<> execute(const FXString &code, boost::python::handle<> context=globals());
    static boost::python::handle<> evaluate(const FXString &code, boost::python::handle<> context=globals());
    static void setFXComboBoxSortFunc(FXComboBox &list, boost::python::api::object *code);
    static void setFXFoldingListSortFunc(FXFoldingList &list, boost::python::api::object *code);
    static void setFXGLViewerSortFunc(FXGLViewer &list, boost::python::api::object *code);
    static void setFXIconListSortFunc(FXIconList &list, boost::python::api::object *code);
    static void setFXListSortFunc(FXList &list, boost::python::api::object *code);
    static void setFXListBoxSortFunc(FXListBox &list, boost::python::api::object *code);
    static void setFXTreeListSortFunc(FXTreeList &list, boost::python::api::object *code);
    static void setFXTreeListBoxSortFunc(FXTreeListBox &list, boost::python::api::object *code);

    static void int_throwPythonException();
    static void int_initEmbeddedEnv();
    static void int_runPythonThread(PyObject *self, QThread *cthread);
    static void int_pythonObjectCreated(Generic::BoundFunctorV *detach);
    static void int_pythonObjectDeleted(Generic::BoundFunctorV *detach);
#ifndef FX_DISABLEGUI
    static bool int_FXObjectHandle(long *ret, FXObject *self, FXObject *sender, FXSelector sel, void *ptr);
#endif
};
inline PyObject *fxerrhpy(PyObject *ptr)
{
    if(ptr<=0) FXPython::int_throwPythonException();
    return ptr;
}
inline boost::python::handle<> py(const FXString &code) { return FXPython::execute(code); }
inline boost::python::handle<> pyeval(const FXString &code) { return FXPython::evaluate(code); }

struct FXPythonInterpPrivate;
class FXPYTHONAPI FXPythonInterp
{
    friend struct FXPythonInterpPrivate;
    friend class FXPython;
    FXPythonInterpPrivate *p;
    FXPythonInterp(const FXPythonInterp &);
    FXPythonInterp &operator=(const FXPythonInterp &);
    FXPythonInterp(void *ts);
public:
    FXPythonInterp(int argc=0, char **argv=0, const char *name=0);
    ~FXPythonInterp();
    const char *name() const throw();
    static FXPythonInterp *current();
    void setContext();
    void unsetContext();
    static void int_enterCPP();
    static void int_exitCPP();
};

class FXPython_CtxHold : public Generic::DoUndo<FXPythonInterp, void (FXPythonInterp::*)(), void (FXPythonInterp::*)()>
{
public:
    FXPython_CtxHold(FXPythonInterp *i=FXPythonInterp::current())
        : Generic::DoUndo<FXPythonInterp, void (FXPythonInterp::*)(), void (FXPythonInterp::*)()>(i, &FXPythonInterp::setContext, &FXPythonInterp::unsetContext)
    { }
};

class FXPython_DoCPP : public Generic::DoUndo<void, void (*)(), void (*)()>
{
public:
    FXPython_DoCPP()
        : Generic::DoUndo<void, void (*)(), void (*)()>(&FXPythonInterp::int_enterCPP, &FXPythonInterp::int_exitCPP)
    { }
};

class FXPython_DoPython : public Generic::DoUndo<void, void (*)(), void (*)()>
{
public:
    FXPython_DoPython()
        : Generic::DoUndo<void, void (*)(), void (*)()>(&FXPythonInterp::int_exitCPP, &FXPythonInterp::int_enterCPP)
    { }
};


} // namespace

#endif
#endif

---

(C) 2002-2009 Niall Douglas. Some parts (C) to assorted authors.