mu::ParserByteCode Class Reference

Bytecode implementation of the Math Parser. More...

#include <muParserBytecode.h>

List of all members.

Public Types

typedef bytecode_type map_type

Underlying type of the container.

Public Member Functions

ParserByteCode ()

ParserByteCode (const ParserByteCode &a_ByteCode)

Copy constructor.

ParserByteCode & operator= (const ParserByteCode &a_ByteCode)

Assignment operator.

void Assign (const ParserByteCode &a_ByteCode)

Copy state of another object to this.

void AddVar (value_type *a_pVar)

Add a Variable pointer to bytecode.

void AddVal (value_type a_fVal)

Add a Variable pointer to bytecode.

void AddOp (ECmdCode a_Oprt)

Add an operator identifier to bytecode.

void AddAssignOp (value_type *a_pVar)

Add an assignement operator.

void AddFun (void *a_pFun, int a_iArgc)

Add function to bytecode.

void AddStrFun (void *a_pFun, int a_iArgc, int a_iIdx)

Add Strung function entry to the parser bytecode.

void Finalize ()

Add end marker to bytecode.

void clear ()

Delete the bytecode.

std::size_t GetMaxStackSize () const

std::size_t GetBufSize () const

const map_type * GetRawData () const

Get Pointer to bytecode data storage.

unsigned GetValSize () const

Return size of a value entry.

unsigned GetPtrSize () const

Return size of a pointer entry.

void RemoveValEntries (unsigned a_iNumber)

Remove a value number of entries from the bytecode.

void AsciiDump ()

Dump bytecode (for debugging only!).

Private Types

typedef ParserToken
< value_type, string_type > token_type

Token type for internal use only.

typedef std::vector< map_type > storage_type

Core type of the bytecode.

Private Member Functions

void StorePtr (void *a_pAddr)

Store an address in bytecode.

Private Attributes

unsigned m_iStackPos

Position in the Calculation array.

std::size_t m_iMaxStackSize

Maximum size needed for the stack.

storage_type m_vBase

Core type of the bytecode.

const int mc_iSizeVal

Size of a value entry in the bytecode, relative to TMapType size.

const int mc_iSizePtr

Size of a pointer, relative to size of underlying TMapType.

const int mc_iSizeValEntry

A value entry requires that much entires in the bytecode.

Detailed Description

Bytecode implementation of the Math Parser.

The bytecode contains the formula converted to revers polish notation stored in a continious memory area. Associated with this data are operator codes, variable pointers, constant values and function pointers. Those are necessary in order to calculate the result. All those data items will be casted to the underlying datatype of the bytecode.

Author:: (C) 2004, 2005 Ingo Berg

Member Typedef Documentation

typedef bytecode_type mu::ParserByteCode::map_type

Underlying type of the container.

The bytecode is a vector of this type containing control codes, values and pointers. Values and pointer will be casted to this type before their storage.

Constructor & Destructor Documentation

mu::ParserByteCode::ParserByteCode ( )

Bytecode default constructor.

mu::ParserByteCode::ParserByteCode ( const ParserByteCode & a_ByteCode )

Copy constructor.

Implemented in Terms of Assign(const ParserByteCode &a_ByteCode)

Member Function Documentation

void mu::ParserByteCode::AddAssignOp ( value_type * a_pVar )

Add an assignement operator.

Operator entries in byte code consist of:

cmASSIGN code
the pointer of the destination variable

See also:: ParserToken::ECmdCode

void mu::ParserByteCode::AddFun	(	void *	a_pFun,
		int	a_iArgc
	)

Add function to bytecode.

Parameters:

	a_iArgc	Number of arguments, negative numbers indicate multiarg functions.
	a_pFun	Pointer to function callback.

void mu::ParserByteCode::AddOp ( ECmdCode a_Oprt )

Add an operator identifier to bytecode.

Operator entries in byte code consist of:

value array position of the result
the operator code according to ParserToken::ECmdCode

See also:: ParserToken::ECmdCode

void mu::ParserByteCode::AddStrFun	(	void *	a_pFun,
		int	a_iArgc,
		int	a_iIdx
	)

Add Strung function entry to the parser bytecode.

Exceptions:

nothrow

A string function entry consists of the stack position of the return value, followed by a cmSTRFUNC code, the function pointer and an index into the string buffer maintained by the parser.

void mu::ParserByteCode::AddVal ( value_type a_fVal )

Add a Variable pointer to bytecode.

Value entries in byte code consist of:

value array position of the value
the operator code according to ParserToken::cmVAL
the value stored in mc_iSizeVal number of bytecode entries.

Parameters:

a_pVal

Value to be added.

Exceptions:

nothrow

void mu::ParserByteCode::AddVar ( value_type * a_pVar )

Add a Variable pointer to bytecode.

Parameters:

a_pVar

Pointer to be added.

Exceptions:

nothrow

void mu::ParserByteCode::Assign ( const ParserByteCode & a_ByteCode )

Copy state of another object to this.

Exceptions:

nowthrow

void mu::ParserByteCode::clear ( )

Delete the bytecode.

Exceptions:

nothrow

The name of this function is a violation of my own coding guidelines but this way it's more in line with the STL functions thus more intuitive.

void mu::ParserByteCode::Finalize ( )

Add end marker to bytecode.

Exceptions:

nothrow

unsigned mu::ParserByteCode::GetPtrSize ( ) const [inline]

Return size of a pointer entry.

That many bytecode entries are necessary to store a pointer.

See also:: mc_iSizePtr

unsigned mu::ParserByteCode::GetValSize ( ) const [inline]

Return size of a value entry.

That many bytecode entries are necessary to store a value.

See also:: mc_iSizeVal

ParserByteCode & mu::ParserByteCode::operator= ( const ParserByteCode & a_ByteCode )

Assignment operator.

Implemented in Terms of Assign(const ParserByteCode &a_ByteCode)

void mu::ParserByteCode::RemoveValEntries ( unsigned a_iNumber )

Remove a value number of entries from the bytecode.

Attention:: Currently I don't test if the entries are really value entries.

void mu::ParserByteCode::StorePtr ( void * a_pAddr ) [private]

Store an address in bytecode.

Parameters:

a_pAddr

Address to be stored.

Exceptions:

nothrow

Member Data Documentation

const int mu::ParserByteCode::mc_iSizePtr [private]

Size of a pointer, relative to size of underlying TMapType.

Attention:: The size is related to the size of TMapType not bytes!

const int mu::ParserByteCode::mc_iSizeValEntry [private]

A value entry requires that much entires in the bytecode.

Value entry consists of:

One entry for Stack index
One entry for Token identifier
mc_iSizeVal entries for the value
AddVal(TBaseData a_fVal)

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


Public Types
typedef bytecode_type	map_type
	Underlying type of the container.
Public Member Functions
	ParserByteCode ()
	ParserByteCode (const ParserByteCode &a_ByteCode)
	Copy constructor.
ParserByteCode &	operator= (const ParserByteCode &a_ByteCode)
	Assignment operator.
void	Assign (const ParserByteCode &a_ByteCode)
	Copy state of another object to this.
void	AddVar (value_type *a_pVar)
	Add a Variable pointer to bytecode.
void	AddVal (value_type a_fVal)
	Add a Variable pointer to bytecode.
void	AddOp (ECmdCode a_Oprt)
	Add an operator identifier to bytecode.
void	AddAssignOp (value_type *a_pVar)
	Add an assignement operator.
void	AddFun (void *a_pFun, int a_iArgc)
	Add function to bytecode.
void	AddStrFun (void *a_pFun, int a_iArgc, int a_iIdx)
	Add Strung function entry to the parser bytecode.
void	Finalize ()
	Add end marker to bytecode.
void	clear ()
	Delete the bytecode.
std::size_t	GetMaxStackSize () const
std::size_t	GetBufSize () const
const map_type *	GetRawData () const
	Get Pointer to bytecode data storage.
unsigned	GetValSize () const
	Return size of a value entry.
unsigned	GetPtrSize () const
	Return size of a pointer entry.
void	RemoveValEntries (unsigned a_iNumber)
	Remove a value number of entries from the bytecode.
void	AsciiDump ()
	Dump bytecode (for debugging only!).
Private Types
typedef ParserToken < value_type, string_type >	token_type
	Token type for internal use only.
typedef std::vector< map_type >	storage_type
	Core type of the bytecode.
Private Member Functions
void	StorePtr (void *a_pAddr)
	Store an address in bytecode.
Private Attributes
unsigned	m_iStackPos
	Position in the Calculation array.
std::size_t	m_iMaxStackSize
	Maximum size needed for the stack.
storage_type	m_vBase
	Core type of the bytecode.
const int	mc_iSizeVal
	Size of a value entry in the bytecode, relative to TMapType size.
const int	mc_iSizePtr
	Size of a pointer, relative to size of underlying TMapType.
const int	mc_iSizeValEntry
	A value entry requires that much entires in the bytecode.