Ogre::ScriptCompiler Class Reference
[General]

This is the main class for the compiler. More...

#include <OgreScriptCompiler.h>

Inheritance diagram for Ogre::ScriptCompiler:

Classes
class	AbstractTreeBuilder
struct	Error
Public Types
enum	{ CE_STRINGEXPECTED, CE_NUMBEREXPECTED, CE_FEWERPARAMETERSEXPECTED, CE_VARIABLEEXPECTED, CE_UNDEFINEDVARIABLE, CE_OBJECTNAMEEXPECTED, CE_OBJECTALLOCATIONERROR, CE_INVALIDPARAMETERS, CE_DUPLICATEOVERRIDE, CE_UNEXPECTEDTOKEN, CE_OBJECTBASENOTFOUND, CE_UNSUPPORTEDBYRENDERSYSTEM, CE_REFERENCETOANONEXISTINGOBJECT }
enum	{ ID_ON = 1, ID_OFF = 2, ID_TRUE = 1, ID_FALSE = 2, ID_YES = 1, ID_NO = 2 }
typedef HashMap< String, uint32 >	IdMap
typedef SharedPtr< Error >	ErrorPtr
typedef list< ErrorPtr >::type	ErrorList
Public Member Functions
	ScriptCompiler ()
virtual	~ScriptCompiler ()
bool	compile (const String &str, const String &source, const String &group)
	Takes in a string of script code and compiles it into resources.
bool	compile (const ConcreteNodeListPtr &nodes, const String &group)
	Compiles resources from the given concrete node list.
AbstractNodeListPtr	_generateAST (const String &str, const String &source, bool doImports=false, bool doObjects=false, bool doVariables=false)
	Generates the AST from the given string script.
bool	_compile (AbstractNodeListPtr nodes, const String &group, bool doImports=true, bool doObjects=true, bool doVariables=true)
	Compiles the given abstract syntax tree.
void	addError (uint32 code, const String &file, int line, const String &msg="")
	Adds the given error to the compiler's list of errors.
void	setListener (ScriptCompilerListener *listener)
	Sets the listener used by the compiler.
ScriptCompilerListener *	getListener ()
	Returns the currently set listener.
const String &	getResourceGroup () const
	Returns the resource group currently set for this compiler.
void	addNameExclusion (const String &type)
	Adds a name exclusion to the map.
void	removeNameExclusion (const String &type)
	Removes a name exclusion.
bool	_fireEvent (ScriptCompilerEvent evt, void retval)
	Internal method for firing the handleEvent method.
void *	operator new (size_t sz, const char file, int line, const char func)
	operator new, with debug line info
void *	operator new (size_t sz)
void *	operator new (size_t sz, void *ptr)
	placement operator new
void *	operator new[] (size_t sz, const char file, int line, const char func)
	array operator new, with debug line info
void *	operator new[] (size_t sz)
void	operator delete (void *ptr)
void	operator delete (void ptr, void )
void	operator delete (void ptr, const char , int, const char *)
void	operator delete[] (void *ptr)
void	operator delete[] (void ptr, const char , int, const char *)
Static Public Member Functions
static String	formatErrorCode (uint32 code)
Private Types
typedef map< String, String >::type	Environment
typedef map< String, AbstractNodeListPtr >::type	ImportCacheMap
typedef multimap< String, String >::type	ImportRequestMap
Private Member Functions
AbstractNodeListPtr	convertToAST (const ConcreteNodeListPtr &nodes)
void	processImports (AbstractNodeListPtr &nodes)
	This built-in function processes import nodes.
AbstractNodeListPtr	loadImportPath (const String &name)
	Loads the requested script and converts it to an AST.
AbstractNodeListPtr	locateTarget (AbstractNodeList *nodes, const String &target)
	Returns the abstract nodes from the given tree which represent the target.
void	processObjects (AbstractNodeList *nodes, const AbstractNodeListPtr &top)
	Handles object inheritance and variable expansion.
void	processVariables (AbstractNodeList *nodes)
	Handles processing the variables.
void	overlayObject (const AbstractNodePtr &source, ObjectAbstractNode *dest)
	This function overlays the given object on the destination object following inheritance rules.
bool	isNameExcluded (const String &cls, AbstractNode *parent)
	Returns true if the given class is name excluded.
void	initWordMap ()
	This function sets up the initial values in word id map.
Private Attributes
String	mGroup
IdMap	mIds
Environment	mEnv
ImportCacheMap	mImports
ImportRequestMap	mImportRequests
AbstractNodeList	mImportTable
ErrorList	mErrors
ScriptCompilerListener *	mListener
Friends
class	AbstractTreeBuilder

Detailed Description

This is the main class for the compiler.

It calls the parser and processes the CST into an AST and then uses translators to translate the AST into the final resources.

Definition at line 187 of file OgreScriptCompiler.h.

Member Typedef Documentation

typedef map<String,String>::type Ogre::ScriptCompiler::Environment [private]

Definition at line 280 of file OgreScriptCompiler.h.

typedef list<ErrorPtr>::type Ogre::ScriptCompiler::ErrorList

Definition at line 201 of file OgreScriptCompiler.h.

typedef SharedPtr<Error> Ogre::ScriptCompiler::ErrorPtr

Definition at line 200 of file OgreScriptCompiler.h.

typedef HashMap<String,uint32> Ogre::ScriptCompiler::IdMap

Definition at line 191 of file OgreScriptCompiler.h.

typedef map<String,AbstractNodeListPtr>::type Ogre::ScriptCompiler::ImportCacheMap [private]

Definition at line 283 of file OgreScriptCompiler.h.

typedef multimap<String,String>::type Ogre::ScriptCompiler::ImportRequestMap [private]

Definition at line 285 of file OgreScriptCompiler.h.

Member Enumeration Documentation

anonymous enum

Enumerator:

ID_ON
ID_OFF
ID_TRUE
ID_FALSE
ID_YES
ID_NO

Definition at line 312 of file OgreScriptCompiler.h.

anonymous enum

Enumerator:

CE_STRINGEXPECTED
CE_NUMBEREXPECTED
CE_FEWERPARAMETERSEXPECTED
CE_VARIABLEEXPECTED
CE_UNDEFINEDVARIABLE
CE_OBJECTNAMEEXPECTED
CE_OBJECTALLOCATIONERROR
CE_INVALIDPARAMETERS
CE_DUPLICATEOVERRIDE
CE_UNEXPECTEDTOKEN
CE_OBJECTBASENOTFOUND
CE_UNSUPPORTEDBYRENDERSYSTEM
CE_REFERENCETOANONEXISTINGOBJECT

Definition at line 204 of file OgreScriptCompiler.h.

Constructor & Destructor Documentation

Ogre::ScriptCompiler::ScriptCompiler ( )

virtual Ogre::ScriptCompiler::~ScriptCompiler ( ) [virtual]

Definition at line 222 of file OgreScriptCompiler.h.

Member Function Documentation

bool Ogre::ScriptCompiler::_compile	(	AbstractNodeListPtr	nodes,
		const String &	group,
		bool	doImports = `true`,
		bool	doObjects = `true`,
		bool	doVariables = `true`
	)

Compiles the given abstract syntax tree.

bool Ogre::ScriptCompiler::_fireEvent	(	ScriptCompilerEvent *	evt,
		void *	retval
	)

Internal method for firing the handleEvent method.

AbstractNodeListPtr Ogre::ScriptCompiler::_generateAST	(	const String &	str,
		const String &	source,
		bool	doImports = `false`,
		bool	doObjects = `false`,
		bool	doVariables = `false`
	)

Generates the AST from the given string script.

void Ogre::ScriptCompiler::addError	(	uint32	code,
		const String &	file,
		int	line,
		const String &	msg = `""`
	)

Adds the given error to the compiler's list of errors.

void Ogre::ScriptCompiler::addNameExclusion ( const String & type )

Adds a name exclusion to the map.

Name exclusions identify object types which cannot accept names. This means that excluded types will always have empty names. All values in the object header are stored as object values.

bool Ogre::ScriptCompiler::compile	(	const ConcreteNodeListPtr &	nodes,
		const String &	group
	)

Compiles resources from the given concrete node list.

bool Ogre::ScriptCompiler::compile	(	const String &	str,
		const String &	source,
		const String &	group
	)

Takes in a string of script code and compiles it into resources.

Parameters:

	str	The script code
	source	The source of the script code (e.g. a script file)
	group	The resource group to place the compiled resources into

AbstractNodeListPtr Ogre::ScriptCompiler::convertToAST ( const ConcreteNodeListPtr & nodes ) [private]

static String Ogre::ScriptCompiler::formatErrorCode ( uint32 code ) [static]

ScriptCompilerListener* Ogre::ScriptCompiler::getListener ( )

Returns the currently set listener.

const String& Ogre::ScriptCompiler::getResourceGroup ( ) const

Returns the resource group currently set for this compiler.

void Ogre::ScriptCompiler::initWordMap ( ) [private]

This function sets up the initial values in word id map.

bool Ogre::ScriptCompiler::isNameExcluded	(	const String &	cls,
		AbstractNode *	parent
	)			`[private]`

Returns true if the given class is name excluded.

AbstractNodeListPtr Ogre::ScriptCompiler::loadImportPath ( const String & name ) [private]

Loads the requested script and converts it to an AST.

Reimplemented in Ogre::ParticleScriptCompiler.

AbstractNodeListPtr Ogre::ScriptCompiler::locateTarget	(	AbstractNodeList *	nodes,
		const String &	target
	)			`[private]`

Returns the abstract nodes from the given tree which represent the target.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)			`[inherited]`

Definition at line 107 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		void *
	)			`[inherited]`

Definition at line 101 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void * ptr ) [inherited]

Definition at line 95 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[]	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)			`[inherited]`

Definition at line 118 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] ( void * ptr ) [inherited]

Definition at line 112 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		void *	ptr
	)			`[inherited]`

placement operator new

Definition at line 78 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new ( size_t sz ) [inherited]

Definition at line 72 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)			`[inherited]`

operator new, with debug line info

Definition at line 67 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t sz ) [inherited]

Definition at line 90 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[]	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)			`[inherited]`

array operator new, with debug line info

Definition at line 85 of file OgreMemoryAllocatedObject.h.

void Ogre::ScriptCompiler::overlayObject	(	const AbstractNodePtr &	source,
		ObjectAbstractNode *	dest
	)			`[private]`

This function overlays the given object on the destination object following inheritance rules.

void Ogre::ScriptCompiler::processImports ( AbstractNodeListPtr & nodes ) [private]

This built-in function processes import nodes.

void Ogre::ScriptCompiler::processObjects	(	AbstractNodeList *	nodes,
		const AbstractNodeListPtr &	top
	)			`[private]`

Handles object inheritance and variable expansion.

void Ogre::ScriptCompiler::processVariables ( AbstractNodeList * nodes ) [private]

Handles processing the variables.

void Ogre::ScriptCompiler::removeNameExclusion ( const String & type )

Removes a name exclusion.

void Ogre::ScriptCompiler::setListener ( ScriptCompilerListener * listener )

Sets the listener used by the compiler.

Friends And Related Function Documentation

friend class AbstractTreeBuilder [friend]

Definition at line 309 of file OgreScriptCompiler.h.

Member Data Documentation

Environment Ogre::ScriptCompiler::mEnv [private]

Definition at line 281 of file OgreScriptCompiler.h.

ErrorList Ogre::ScriptCompiler::mErrors [private]

Definition at line 292 of file OgreScriptCompiler.h.

String Ogre::ScriptCompiler::mGroup [private]

Definition at line 276 of file OgreScriptCompiler.h.

IdMap Ogre::ScriptCompiler::mIds [private]

Definition at line 278 of file OgreScriptCompiler.h.

ImportRequestMap Ogre::ScriptCompiler::mImportRequests [private]

Definition at line 286 of file OgreScriptCompiler.h.

ImportCacheMap Ogre::ScriptCompiler::mImports [private]

Definition at line 284 of file OgreScriptCompiler.h.

AbstractNodeList Ogre::ScriptCompiler::mImportTable [private]

Definition at line 289 of file OgreScriptCompiler.h.

ScriptCompilerListener* Ogre::ScriptCompiler::mListener [private]

Reimplemented in Ogre::ParticleScriptCompiler.

Definition at line 295 of file OgreScriptCompiler.h.

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

OgreScriptCompiler.h

Ogre::ScriptCompiler Class Reference [General]

Classes

Public Types

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

Ogre::ScriptCompiler Class Reference
[General]