wrapper_utils.h File Reference

#include "PClassConfig.h"
#include "type_utils.h"
#include "wrapper_convertType.h"

Include dependency graph for wrapper_utils.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
PString	project_wrapper_attributeDef (const PClassAttribute &attr)
	Get the C++ definition of an attribute.
PString	project_wrapper_classImplPythonType (const PClassConfig &classConfig, const PString &moduleName, const PString &fromOtherType)
	Create the Python type of the given class.
PString	wrapper_getBuildValueStr (const PString &type)
	Get the string description of the Py_BuildValue call for the given type.
PString	wrapper_getClassName (const PClassConfig &classConfig)
	Get the corresponding wrapper class name.
PString	wrapper_getExpectedType (const PString &type)
	Get the expected type of a given python type.
PString	wrapper_getObjectParseTuple (const PString &varName)
	Get the proper code for PyArg_ParseTuple with one object.
PString	wrapper_getObjectToValue (const PString &type)
	Get the function to convert the given object to a value.
PString	wrapper_getValueToObject (const PString &type)
	Get the function to convert the given value to a PyObject.

Function Documentation

project_wrapper_attributeDef()

PString project_wrapper_attributeDef

(

const PClassAttribute &

attr

)

Get the C++ definition of an attribute.

Parameters

attr	: attribute of a class

Returns

corresponding C++

Definition at line 91 of file wrapper_utils.cpp.

                                                                  {
        PString body;
        body += "\t" + attr.getDocumentation() + "\n";
        if(getIsSimpleType(attr.getType())){
                body += "\t" + attr.getType();
        }else{
                body += "\tPyObject *";
        }
        body += " "+attr.getName()+";\n";
        return body;
}

References PClassAttribute::getDocumentation(), getIsSimpleType(), PClassAttribute::getName(), and PClassAttribute::getType().

Referenced by wrapper_generator_class_header().

Here is the call graph for this function:

Here is the caller graph for this function:

project_wrapper_classImplPythonType()

PString project_wrapper_classImplPythonType	(	const PClassConfig &	classConfig,
		const PString &	moduleName,
		const PString &	fromOtherType )

Create the Python type of the given class.

Parameters

classConfig	: class to be used
moduleName	: name of the module where the class should be defined
fromOtherType	: name of an other PyTypeObject to inheritate

Returns

corresponding C++

Definition at line 109 of file wrapper_utils.cpp.

                                                                                                                                        {
        PString body, className(wrapper_getClassName(classConfig));
        
        body += "///Define the type of the "+className+"\n";
        body += "PyTypeObject "+className+"Type = {\n";
        body += "\tPyVarObject_HEAD_INIT("+fromOtherType+", 0)\n";
        body += "\t\""+moduleName+"."+classConfig.getName()+"\", /* tp_name */\n";
        body += "\tsizeof("+className+"),  /* tp_basicsize */\n";
        body += "\t0,                         /* tp_itemsize */\n";
        body += "\t(destructor)"+className+"_dealloc, /* tp_dealloc */\n";
        body += "\t0,                         /* tp_print */\n";
        body += "\t0,                         /* tp_getattr */\n";
        body += "\t0,                         /* tp_setattr */\n";
        body += "\t0,                         /* tp_reserved */\n";
        body += "\t0,                         /* tp_repr */\n";
        body += "\t0,                         /* tp_as_number */\n";
        body += "\t0,                         /* tp_as_sequence */\n";
        body += "\t0,                         /* tp_as_mapping */\n";
        body += "\t0,                         /* tp_hash  */\n";
        body += "\t0,                         /* tp_call */\n";
        body += "\t0,                         /* tp_str */\n";
        body += "\t0,                         /* tp_getattro */\n";
        body += "\t0,                         /* tp_setattro */\n";
        body += "\t0,                         /* tp_as_buffer */\n";
        body += "\tPy_TPFLAGS_DEFAULT |\n";
        body += "\tPy_TPFLAGS_BASETYPE,   /* tp_flags */\n";
        body += "\t\""+className+" doc : "+classConfig.getClassDocumentation().replace("///", "")+"\",           /* tp_doc */\n";
        body += "\t0,                         /* tp_traverse */\n";
        body += "\t0,                         /* tp_clear */\n";
        body += "\t0,                         /* tp_richcompare */\n";
        body += "\t0,                         /* tp_weaklistoffset */\n";
        body += "\t0,                         /* tp_iter */\n";
        body += "\t0,                         /* tp_iternext */\n";
        body += "\t"+className+"_methods,  /* tp_methods */\n";
        body += "\t"+className+"_members,  /* tp_members */\n";
        body += "\t"+className+"_getseters,/* tp_getset */\n";
        body += "\t0,                         /* tp_base */\n";
        body += "\t0,                         /* tp_dict */\n";
        body += "\t0,                         /* tp_descr_get */\n";
        body += "\t0,                         /* tp_descr_set */\n";
        body += "\t0,                         /* tp_dictoffset */\n";
        body += "\t0,                         /* tp_init */\n";
        body += "\t0,                         /* tp_alloc */\n";
        body += "\t"+className+"_newC,            /* tp_new */\n";
        body += "};\n\n";
        return body;
}

References PClassConfig::getClassDocumentation(), PClassConfig::getName(), and wrapper_getClassName().

Referenced by wrapper_generator_class_source().

Here is the call graph for this function:

Here is the caller graph for this function:

wrapper_getBuildValueStr()

PString wrapper_getBuildValueStr

(

const PString &

type

)

Get the string description of the Py_BuildValue call for the given type.

Parameters

type	: type of the used

Returns

corresponding string description or UnknownType if the type is not yet supported by this function

Definition at line 14 of file wrapper_utils.cpp.

                                                      {
        if(type == "int"){return "i";}
        else if(type == "float"){return "f";}
        else if(type == "double"){return "d";}
        else if(type == "char"){return "c";}
        else if(type == "std::string"){return "s";}
        else{
                return "UnknownType";
        }
}

wrapper_getClassName()

PString wrapper_getClassName

(

const PClassConfig &

classConfig

)

Get the corresponding wrapper class name.

Parameters

classConfig

: PClassConfig to be used

Returns

corresponding wrapper class name

Definition at line 70 of file wrapper_utils.cpp.

                                                              {
        return "WP"+classConfig.getName();
}

References PClassConfig::getName().

Referenced by WrapperTraitDataStream::classMethodDeclaration(), WrapperTraitGetterSetter::classMethodDeclaration(), WrapperTraitTypeStream::classMethodDeclaration(), WrapperTraitDataStream::classMethodImplementation(), WrapperTraitGetterSetter::classMethodImplementation(), WrapperTraitTypeStream::classMethodImplementation(), data_stream_trait_wrapper_classImplCheck(), project_wrapper_classImplPythonType(), WrapperTraitGetterSetter::registerClassGetterSetter(), WrapperTraitGetterSetter::registerClassMember(), WrapperTraitDataStream::registerClassMethod(), WrapperTraitTypeStream::registerClassMethod(), wrapper_generator_class_header(), wrapper_generator_class_source(), and wrapper_generator_enum_header().

Here is the call graph for this function:

Here is the caller graph for this function:

wrapper_getExpectedType()

PString wrapper_getExpectedType

(

const PString &

type

)

Get the expected type of a given python type.

Parameters

type	: type ot be used

Returns

corresponding Python type or NoPythonTypeYet if the type is not yet supported by this function

Definition at line 57 of file wrapper_utils.cpp.

                                                     {
        if(type == "long" || type == "int" || type == "short" || type == "char"){return "int";}
        else if(type == "float" || type == "double"){return "float";}
        else if(type == "std::string"){return "std";}
        else{
                return "NoPythonTypeYet";
        }
}

Referenced by data_stream_trait_wrapper_classImplCheck().

Here is the caller graph for this function:

wrapper_getObjectParseTuple()

PString wrapper_getObjectParseTuple

(

const PString &

varName

)

Get the proper code for PyArg_ParseTuple with one object.

Parameters

varName

: name of the variable to be checked

Returns

corresponding C++

Definition at line 78 of file wrapper_utils.cpp.

                                                            {
        PString body;
        body += "\tif(!PyArg_ParseTuple(args, \"O\", &"+varName+")){\n";
        body += "\t\tPyErr_SetString(PyExc_RuntimeError, \"missing filename or keyword not supported\\n\");\n";
        body += "\t\treturn NULL;\n";
        body += "\t}\n";
        return body;
}

Referenced by data_stream_trait_wrapper_classPythonFromBytes().

Here is the caller graph for this function:

wrapper_getObjectToValue()

PString wrapper_getObjectToValue

(

const PString &

type

)

Get the function to convert the given object to a value.

Parameters

type	: tpye to be used

Returns

corresponding function or UnknownConvertFunctionToValue if the type is not yet supported by this function

Definition at line 29 of file wrapper_utils.cpp.

                                                      {
        if(type == "float" || type == "double"){return "PyFloat_AsDouble";}
        else if(type == "long" || type == "short" || type == "char"){return "PyLong_AsLong";}
        else if(type == "int"){return "PyLong_AsInt";}
        else if(type == "size_t"){return "PyLong_ToSize_t";}
        else{
                return "UnknownConvertFunctionToValue";
        }
}

Referenced by data_stream_trait_wrapper_classAttributeToMessage().

Here is the caller graph for this function:

wrapper_getValueToObject()

PString wrapper_getValueToObject

(

const PString &

type

)

Get the function to convert the given value to a PyObject.

Parameters

type	: tpye to be used

Returns

corresponding function or UnknownConvertFunctionFromValue if the type is not yet supported by this function

Definition at line 43 of file wrapper_utils.cpp.

                                                      {
        if(type == "float" || type == "double"){return "PyFloat_FromDouble";}
        else if(type == "long" || type == "short" || type == "char" || type == "int"){return "PyLong_FromLong";}
        else if(type == "unsigned long" || type == "unsigned short" || type == "unsigned char" || type == "unsigned int"){return "PyLong_FromLong";}
        else if(type == "size_t"){return "PyLong_FromSize_t";}
        else{
                return "UnknownConvertFunctionFromValue";
        }
}

Referenced by data_stream_trait_wrapper_classAttributeFromMessage().

Here is the caller graph for this function: