Base::InterpreterSingleton Class Reference

The Interpreter class This class manage the python interpreter and hold a lot helper functions for handling python stuff. More...

#include <Interpreter.h>

List of all members.

Public Member Functions
	InterpreterSingleton ()
	~InterpreterSingleton ()
Cleanup

int	cleanup (void(*func)(void))
	Register a cleanup function to be called by finalize().
void	finalize ()
	This calls the registered cleanup functions.
void	systemExit ()
	This shuts down the application.
external wrapper libs
here we can access external dynamically loaded wrapper libs done e.g. by SWIG or SIP
void	cleanupSWIG (const char *TypeName)
bool	convertSWIGPointerObj (const char Module, const char TypeName, PyObject obj, void *ptr, int flags)
PyObject *	createSWIGPointerObj (const char Modole, const char TypeName, void *Pointer, int own)
	generate a SWIG object
methods for debugging facility

void	dbgObserveFile (const char *sFileName="")
	sets the file name which should be debugged
void	dbgSetBreakPoint (unsigned int uiLineNumber)
	sets a break point to a special line number in the current file
void	dbgStep (void)
	One step further.
void	dbgUnsetBreakPoint (unsigned int uiLineNumber)
	unsets a break point to a special line number in the current file
execution methods

void	runFile (const char *pxFileName)
	Run file (script) on the python interpreter.
void	runInteractiveString (const char *psCmd)
	Run a statement on the python interpreter and gives back a string with the representation of the result.
void	runMethod (PyObject pobject, const char method, const char resfmt=0, void cresult=0, const char *argfmt="()",...)
	runs a python method with arbitrary params
PyObject *	runMethodObject (PyObject pobject, const char method)
	runs a python object method which returns a arbitrary object
void	runMethodVoid (PyObject pobject, const char method)
	runs a python object method with no return value and no arguments
std::string	runString (const char *psCmd)
	Run a statement on the python interpreter and gives back a string with the representation of the result.
void	runStringArg (const char *psCom,...)
	Run a statement with arguments on the python interpreter.
Static Public Member Functions
static helper functions

static const std::string	strToPython (const std::string &Str)
static const std::string	strToPython (const char *Str)
	replaces all char with escapes for usage in python console
Static Protected Attributes
static InterpreterSingleton *	_pcSingelton = 0
Module handling

void	addPythonPath (const char *Path)
	Add an addtional pyhton path.
bool	loadModule (const char *psModName)
static void	addType (PyTypeObject Type, PyObject Module, const char *Name)
startup and singletons

const char *	init (int argc, char *argv[])
	init the interpreter and returns the module search path
int	runCommandLine (const char *prompt)
static void	Destruct (void)
static InterpreterSingleton &	Instance (void)

Detailed Description

The Interpreter class This class manage the python interpreter and hold a lot helper functions for handling python stuff.

Definition at line 136 of file Interpreter.h.

Constructor & Destructor Documentation

InterpreterSingleton::InterpreterSingleton ( )

Definition at line 93 of file Interpreter.cpp.

Referenced by Instance().

InterpreterSingleton::~InterpreterSingleton ( )

Definition at line 98 of file Interpreter.cpp.

Member Function Documentation

void InterpreterSingleton::addPythonPath ( const char * Path )

Add an addtional pyhton path.

Definition at line 264 of file Interpreter.cpp.

void InterpreterSingleton::addType	(	PyTypeObject *	Type,
		PyObject *	Module,
		const char *	Name
	)			`[static]`

Definition at line 254 of file Interpreter.cpp.

References PyType_Object::o.

int InterpreterSingleton::cleanup ( void(*)(void) func )

Register a cleanup function to be called by finalize().

The cleanup function will be called with no arguments and should return no value. At most 32 cleanup functions can be registered.When the registration is successful 0 is returned; on failure -1 is returned. The cleanup function registered last is called first. Each cleanup function will be called at most once. Since Python's internal finallization will have completed before the cleanup function, no Python APIs should be called by func.

Definition at line 287 of file Interpreter.cpp.

void InterpreterSingleton::cleanupSWIG ( const char * TypeName )

Definition at line 608 of file Interpreter.cpp.

References Swig_python::cleanupSWIG_T().

bool InterpreterSingleton::convertSWIGPointerObj	(	const char *	Module,
		const char *	TypeName,
		PyObject *	obj,
		void **	ptr,
		int	flags
	)

Definition at line 562 of file Interpreter.cpp.

References Swig_python::convertSWIGPointerObj_T(), getSWIGVersionFromModule(), and result.

PyObject * InterpreterSingleton::createSWIGPointerObj	(	const char *	Modole,
		const char *	TypeName,
		void *	Pointer,
		int	own
	)

generate a SWIG object

Definition at line 515 of file Interpreter.cpp.

References Swig_python::createSWIGPointerObj_T(), getSWIGVersionFromModule(), and result.

void InterpreterSingleton::dbgObserveFile ( const char * sFileName = "" )

sets the file name which should be debugged

Definition at line 408 of file Interpreter.cpp.

void InterpreterSingleton::dbgSetBreakPoint ( unsigned int uiLineNumber )

sets a break point to a special line number in the current file

Definition at line 416 of file Interpreter.cpp.

void InterpreterSingleton::dbgStep ( void )

One step further.

Definition at line 426 of file Interpreter.cpp.

void InterpreterSingleton::dbgUnsetBreakPoint ( unsigned int uiLineNumber )

unsets a break point to a special line number in the current file

Definition at line 421 of file Interpreter.cpp.

void InterpreterSingleton::Destruct ( void ) [static]

Definition at line 330 of file Interpreter.cpp.

References _pcSingelton.

void InterpreterSingleton::finalize ( )

This calls the registered cleanup functions.

See also:: cleanup() for more details.

Definition at line 292 of file Interpreter.cpp.

Referenced by App::Application::destruct().

const char * InterpreterSingleton::init	(	int	argc,
		char *	argv[]
	)

init the interpreter and returns the module search path

Definition at line 274 of file Interpreter.cpp.

InterpreterSingleton & InterpreterSingleton::Instance ( void ) [static]

Definition at line 322 of file Interpreter.cpp.

References _pcSingelton, and InterpreterSingleton().

Referenced by Base::Interpreter().

bool InterpreterSingleton::loadModule ( const char * psModName )

Definition at line 239 of file Interpreter.cpp.

References PP_Load_Module().

Referenced by Base::Type::createInstanceByName(), and App::Application::processCmdLineFiles().

int InterpreterSingleton::runCommandLine ( const char * prompt )

Definition at line 338 of file Interpreter.cpp.

References PP_Run_Command_Line().

Referenced by App::Application::runApplication().

void InterpreterSingleton::runFile ( const char * pxFileName )

Run file (script) on the python interpreter.

Definition at line 213 of file Interpreter.cpp.

References Base::FileInfo::toStdWString().

Referenced by App::Application::processCmdLineFiles().

void InterpreterSingleton::runInteractiveString ( const char * psCmd )

Run a statement on the python interpreter and gives back a string with the representation of the result.

Definition at line 178 of file Interpreter.cpp.

References PP_Load_Module(), and Base::Exception::setMessage().

void InterpreterSingleton::runMethod	(	PyObject *	pobject,
		const char *	method,
		const char *	resfmt = `0`,
		void *	cresult = `0`,
		const char *	argfmt = `"()"`,
			...
	)