PyObjectBase.h File Reference

#include <Python.h>
#include <iostream>
#include <bitset>
#include <typeinfo>
#include "Exception.h"
#include <CXX/Objects.hxx>

Go to the source code of this file.

Classes
class	Base::PyObjectBase
	The PyObjectBase class, exports the class as a python type PyObjectBase is the base class for all C++ classes which need to get exported into the python namespace. More...
union	PyType_Object
	Union to convert from PyTypeObject to PyObject pointer. More...
Namespaces
namespace	Base
	The namespace of the FreeCAD Base library.
Defines
#define	_getattr_up(Parent)
	This defines the _getattr_up macro which allows attribute and method calls to be properly passed up the hierarchy.
#define	PARENTSBasePyObjectBase &Base::PyObjectBase::Type,NULL
	Root definition of the inheritance tree of the FreeCAD python objects.
#define	Py_Assert(A, E, M) {if (!(A)) {PyErr_SetString(E, M); return NULL;}}
	assert which returns with an error on failure
#define	PY_CATCH
	see docu of PY_TRY
#define	Py_Error(E, M) {PyErr_SetString(E, M); return NULL;}
	returns an error
#define	Py_Header
	This must be the first line of each PyC++ class.
#define	Py_NEWARGS 1
	some basic python macros
#define	Py_Return Py_INCREF(Py_None); return Py_None;
	return with no retrnvalue if nothin happens
#define	PY_TRY try
	Exception handling for python callback functions Is a convenience macro to manage the exception handling of python callback functions defined in classes inheriting PyObjectBase and using PYMETHODEDEF .
#define	Py_Try(F) {if (!(F)) return NULL;}
	checks on a condition and returns an error on failure
#define	PYFUNCDEF_D(CLASS, DFUNC)
	Python dynamic class macro for definition sets up a static/dynamic function entry in a class inheriting from PyObjectBase.
#define	PYFUNCDEF_S(SFUNC) static PyObject* SFUNC (PyObject self,PyObject args,PyObject *kwd);
	Python static class macro for definition sets up a static function entry in a class inheriting from PyObjectBase.
#define	PYFUNCIMP_D(CLASS, DFUNC) PyObject* CLASS::DFUNC (PyObject *args)
	Python dynamic class macro for implementation used to set up a impementation for PYFUNCDEF_D definition.
#define	PYFUNCIMP_S(CLASS, SFUNC) PyObject* CLASS::SFUNC (PyObject self,PyObject args,PyObject *kwd)
	Python static class macro for implementation used to set up a implementation for PYFUNCDEF_S definition.
#define	PYMETHODEDEF(FUNC) {"" #FUNC "",(PyCFunction) s##FUNC,Py_NEWARGS},
	Python dynamic class macro for the method list used to fill the method list of a class derived from PyObjectBase.
#define	slots
Typedefs
typedef PyTypeObject *	PyParentObject
	Define the PyParent Object.
Functions
void	Base::Assert (int expr, char *msg)
PyObject *	Base::PyAsUnicodeObject (const std::string &str)
PyObject *	Base::PyAsUnicodeObject (const char *str)
	Python helper class This class encapsulate the Decoding of UTF8 to a python object.
int	Base::streq (const char A, const char B)

Define Documentation

#define _getattr_up ( Parent )

Value:

{                                                           \
    PyObject *rvalue = Py_FindMethod(Methods, this, attr);  \
    if (rvalue == NULL)                                     \
    {                                                       \
        PyErr_Clear();                                      \
        return Parent::_getattr(attr);                      \
    }                                                       \
    else                                                    \
        return rvalue;                                      \
}

This defines the _getattr_up macro which allows attribute and method calls to be properly passed up the hierarchy.

Definition at line 145 of file PyObjectBase.h.

Referenced by Gui::PyResource::_getattr(), TestGui::UnitTestPy::_getattr(), and ParameterGrpPy::_getattr().

#define PARENTSBasePyObjectBase &Base::PyObjectBase::Type,NULL

Root definition of the inheritance tree of the FreeCAD python objects.

Definition at line 477 of file PyObjectBase.h.

#define Py_Assert	(	A,
		E,
		M	)	{if (!(A)) {PyErr_SetString(E, M); return NULL;}}

assert which returns with an error on failure

Definition at line 125 of file PyObjectBase.h.

#define PY_CATCH

Value:

catch(Base::Exception &e)                        \
    {                                                               \
        std::string str;                                            \
        str += "FreeCAD exception thrown (";                        \
        str += e.what();                                            \
        str += ")";                                                 \
        e.ReportException();                                        \
        Py_Error(PyExc_Exception,str.c_str());                      \
    }                                                               \
    catch(std::exception &e)                                        \
    {                                                               \
        std::string str;                                            \
        str += "STL exception thrown (";                            \
        str += e.what();                                            \
        str += ")";                                                 \
        Base::Console().Error(str.c_str());                         \
        Py_Error(PyExc_Exception,str.c_str());                      \
    }                                                               \
    catch(const Py::Exception&)                                     \
    {                                                               \
        return NULL;                                                \
    }                                                               \
    catch(const char *e)                                            \
    {                                                               \
        Py_Error(PyExc_Exception,e);                                \
    }                                                               \
    catch(...)                                                      \
    {                                                               \
        Py_Error(PyExc_Exception,"Unknown C++ exception");          \
    }

see docu of PY_TRY

Definition at line 414 of file PyObjectBase.h.

#define Py_Error	(	E,
		M		)	{PyErr_SetString(E, M); return NULL;}

returns an error

Definition at line 121 of file PyObjectBase.h.

Referenced by Mesh::MeshPy::collapseFacets(), insert(), Robot::TrajectoryPy::insertWaypoints(), loftOnCurve(), open(), Base::ConsoleSingleton::sPySetStatus(), and writeCameraFile().

#define Py_Header

Value:

public:                                                     \
    static PyTypeObject   Type;                             \
    static PyMethodDef    Methods[];                        \
    static PyParentObject Parents[];                        \
    virtual PyTypeObject *GetType(void) {return &Type;};    \
    virtual PyParentObject *GetParents(void) {return Parents;}

This must be the first line of each PyC++ class.

Definition at line 133 of file PyObjectBase.h.

#define Py_NEWARGS 1

some basic python macros

Definition at line 117 of file PyObjectBase.h.

#define Py_Return Py_INCREF(Py_None); return Py_None;

return with no retrnvalue if nothin happens

Definition at line 119 of file PyObjectBase.h.

#define PY_TRY try

Exception handling for python callback functions Is a convenience macro to manage the exception handling of python callback functions defined in classes inheriting PyObjectBase and using PYMETHODEDEF .

You can automate this:

 PYFUNCIMP_D(DocTypeStdPy,AddFeature)
 {
   char *pstr;
   if (!PyArg_ParseTuple(args, "s", &pstr))     // convert args: Python->C 
      return NULL;                             // NULL triggers exception 
 
   try {
     Feature *pcFtr = _pcDocTypeStd->AddFeature(pstr);
   }catch(...)                                                        \
   {                                                                 \
                Py_Error(PyExc_Exception,"Unknown C++ exception");          \
   }catch(FCException e) ..... // and so on....                                                               \
 }

with that:

 PYFUNCIMP_D(DocTypeStdPy,AddFeature)
 {
   char *pstr;
   if (!PyArg_ParseTuple(args, "s", &pstr))     // convert args: Python->C 
      return NULL;                             // NULL triggers exception 
 
  PY_TRY {
    Feature *pcFtr = _pcDocTypeStd->AddFeature(pstr);
  }PY_CATCH;
 }

this catch maps all of the FreeCAD standard exception to a clear output for the Python exception.

See also:: PYMETHODEDEF; PyObjectBase

Definition at line 410 of file PyObjectBase.h.

#define Py_Try ( F ) {if (!(F)) return NULL;}

checks on a condition and returns an error on failure

Definition at line 123 of file PyObjectBase.h.

#define PYFUNCDEF_D	(	CLASS,
		DFUNC		)

Value:

PyObject * DFUNC (PyObject *args);  \
static PyObject * s##DFUNC (PyObject *self, PyObject *args, PyObject * /*kwd*/){return (( CLASS *)self)-> DFUNC (args);};

Python dynamic class macro for definition sets up a static/dynamic function entry in a class inheriting from PyObjectBase.

Its a pure convenience macro. You can also do it by hand if you want. It looks like that:

 PyObject *PyGetGrp(PyObject *args);
 static PyObject *sPyGetGrp(PyObject *self, PyObject *args, PyObject *kwd)
        {return ((FCPyParametrGrp*)self)->PyGetGrp(args);};

first the method is defined which have the functionality then the static wrapper is used to provide a callback for python. The call is simply mapped to the method.

Parameters:

	CLASS	is the class in which the macro take place.
	DFUNC	is the object method get defined and called sDFUNC is the static method name (use what you want)

See also:: PYFUNCIMP_D; PyObjectBase

Definition at line 326 of file PyObjectBase.h.

#define PYFUNCDEF_S ( SFUNC ) static PyObject* SFUNC (PyObject *self,PyObject *args,PyObject *kwd);

Python static class macro for definition sets up a static function entry in a class inheriting from PyObjectBase.

Its a pure convenience macro. You can also do it by hand if you want. It looks like that:

 static PyObject* X (PyObject *self,PyObject *args,PyObject *kwd);

Parameters:

SFUNC

is the static method name (use what you want)

See also:: PYFUNCIMP_S; FCPythonExport

Definition at line 60 of file PyObjectBase.h.

#define PYFUNCIMP_D	(	CLASS,
		DFUNC		)	PyObject* CLASS::DFUNC (PyObject *args)

Python dynamic class macro for implementation used to set up a impementation for PYFUNCDEF_D definition.

Its a pure confiniance macro. You can also do it by hand if you want. It looks like that:

 PyObject *FCPyParametrGrp::PyGetGrp(PyObject *args)

see PYFUNCDEF_D for details *

Parameters:

	CLASS	is the class in which the macro take place.
	DFUNC	is the object method get defined and called

See also:: PYFUNCDEF_D; PyObjectBase

Definition at line 341 of file PyObjectBase.h.

#define PYFUNCIMP_S	(	CLASS,
		SFUNC		)	PyObject* CLASS::SFUNC (PyObject self,PyObject args,PyObject *kwd)

Python static class macro for implementation used to set up a implementation for PYFUNCDEF_S definition.

Its a pure confiniance macro. You can also do it by hand if you want. It looks like that:

 PyObject* CLASS::SFUNC (PyObject *self,PyObject *args,PyObject *kwd)

see PYFUNCDEF_S for details

Parameters:

	CLASS	is the class in which the macro take place.
	SFUNC	is the object method get implemented

See also:: PYFUNCDEF_S; FCPythonExport

Definition at line 76 of file PyObjectBase.h.

#define PYMETHODEDEF ( FUNC ) {"" #FUNC "",(PyCFunction) s##FUNC,Py_NEWARGS},

Python dynamic class macro for the method list used to fill the method list of a class derived from PyObjectBase.

Its a pure confiniance macro. You can also do it by hand if you want. It looks like that:

 PyMethodDef DocTypeStdPy::Methods[] = {
        {"AddFeature",    (PyCFunction) sAddFeature,    Py_NEWARGS},
        {"RemoveFeature", (PyCFunction) sRemoveFeature, Py_NEWARGS},
        {NULL, NULL}            
 };

instead of:

 PyMethodDef DocTypeStdPy::Methods[] = {
        PYMETHODEDEF(AddFeature)
        PYMETHODEDEF(RemoveFeature)
        {NULL, NULL}            
 };

see PYFUNCDEF_D for details

Parameters:

FUNC

is the object method get defined

See also:: PYFUNCDEF_D; PyObjectBase

Definition at line 369 of file PyObjectBase.h.

#define slots

Definition at line 39 of file PyObjectBase.h.

Typedef Documentation

typedef PyTypeObject* PyParentObject

Define the PyParent Object.

Definition at line 129 of file PyObjectBase.h.

PyObjectBase.h File Reference

Classes

Namespaces

Defines

Typedefs

Functions

Define Documentation

Typedef Documentation