wxScriptInterpreter Class Reference

A singleton class that wraps all the script interpreters supported. More...

#include <script.h>

List of all members.

Public Member Functions
	wxScriptInterpreter ()
virtual	~wxScriptInterpreter ()
virtual bool	isReady () const =0
	Returns TRUE if this script interpreter is ready to work.
virtual void	GetFunctionList (wxScriptFunctionArray &) const =0
	Returns the list of the functions currently recognized by the interpreter.
virtual wxString	GetVersionInfo () const =0
	Returns version info about this interpreter or a wxEmptyString if this interpreter does not supply any version info.
Static Public Member Functions
static bool	Init (bool bCINT=TRUE, bool bUnderC=TRUE, bool bLua=TRUE, bool bPython=TRUE)
	Initializes the script interpreter.
static void	Cleanup ()
	Deallocates the script interpreter.
static bool	areAllReady ()
	Returns TRUE if the script interpreter is ready to work.
static wxString	GetLastErr ()
	Returns the description of the last occured error (an empty string if there were no errors).
static void	GetTotalFunctionList (wxScriptFunctionArray &)
	Returns the list of the functions currently recognized by the interpreter.
static wxScriptFile *	Load (const wxString &filename, wxScriptFileType type=wxRECOGNIZE_FROM_EXTENSION)
	Load the given scriptfile and then returns an instance to the scriptfile wrapper, or NULL if the file couldn't be loaded.
Static Public Attributes
static wxString	m_strLastErr
	The description of the last error.
Static Protected Attributes
static wxCINT *	m_pCINT = NULL
	The shared instance of the wxScriptInterpreter.
static wxUnderC *	m_pUnderC = NULL
static wxLua *	m_pLua = NULL
static wxPython *	m_pPython = NULL

---

Detailed Description

A singleton class that wraps all the script interpreters supported.

---

Constructor & Destructor Documentation

wxScriptInterpreter::wxScriptInterpreter (   )

wxScriptInterpreter::~wxScriptInterpreter (   )  [virtual]

---

Member Function Documentation

bool wxScriptInterpreter::areAllReady (   )  [static]

Returns TRUE if the script interpreter is ready to work.

void wxScriptInterpreter::Cleanup (   )  [static]

Deallocates the script interpreter.

virtual void wxScriptInterpreter::GetFunctionList (  wxScriptFunctionArray &   )  const [pure virtual]

Returns the list of the functions currently recognized by the interpreter.

static wxString wxScriptInterpreter::GetLastErr (   )  [inline, static]

Returns the description of the last occured error (an empty string if there were no errors).

void wxScriptInterpreter::GetTotalFunctionList (  wxScriptFunctionArray &   )  [static]

Returns the list of the functions currently recognized by the interpreter.

virtual wxString wxScriptInterpreter::GetVersionInfo (   )  const [pure virtual]

Returns version info about this interpreter or a wxEmptyString if this interpreter does not supply any version info. The exact form of the string returned is interpreter-dependent, but it is usually given as "INTERPRETER_NAME VERSION_STRING".

bool wxScriptInterpreter::Init (  bool  bCINT = TRUE, bool  bUnderC = TRUE, bool  bLua = TRUE, bool  bPython = TRUE )  [static]

Initializes the script interpreter.

virtual bool wxScriptInterpreter::isReady (   )  const [pure virtual]

Returns TRUE if this script interpreter is ready to work.

wxScriptFile * wxScriptInterpreter::Load (  const wxString &  filename, wxScriptFileType  type = wxRECOGNIZE_FROM_EXTENSION )  [static]

Load the given scriptfile and then returns an instance to the scriptfile wrapper, or NULL if the file couldn't be loaded.

---

Member Data Documentation

wxCINT * wxScriptInterpreter::m_pCINT = NULL [static, protected]

The shared instance of the wxScriptInterpreter.

wxLua * wxScriptInterpreter::m_pLua = NULL [static, protected]

wxPython * wxScriptInterpreter::m_pPython = NULL [static, protected]

wxUnderC * wxScriptInterpreter::m_pUnderC = NULL [static, protected]

wxString wxScriptInterpreter::m_strLastErr [static]

The description of the last error.

---

The documentation for this class was generated from the following files:

• script.h
• script.cpp

---