MADNESS  version 0.9
Public Types | Public Member Functions | List of all members
mu::ParserByteCode Class Reference

Bytecode implementation of the Math Parser. More...

#include <muParserBytecode.h>

Public Types

typedef bytecode_type map_type
 Underlying type of the container. More...
 

Public Member Functions

 ParserByteCode ()
 
 ~ParserByteCode ()
 Destructor (trivial). More...
 
 ParserByteCode (const ParserByteCode &a_ByteCode)
 Copy constructor. More...
 
ParserByteCodeoperator= (const ParserByteCode &a_ByteCode)
 Assignment operator. More...
 
void Assign (const ParserByteCode &a_ByteCode)
 Copy state of another object to this. More...
 
void AddVar (value_type *a_pVar)
 Add a Variable pointer to bytecode. More...
 
void AddVal (value_type a_fVal)
 Add a Variable pointer to bytecode. More...
 
void AddOp (ECmdCode a_Oprt)
 Add an operator identifier to bytecode. More...
 
void AddAssignOp (value_type *a_pVar)
 Add an assignement operator. More...
 
void AddFun (void *a_pFun, int a_iArgc)
 Add function to bytecode. More...
 
void AddStrFun (void *a_pFun, int a_iArgc, int a_iIdx)
 Add Strung function entry to the parser bytecode. More...
 
void Finalize ()
 Add end marker to bytecode. More...
 
void clear ()
 Delete the bytecode. More...
 
std::size_t GetBufSize () const
 
const map_typeGetRawData () const
 Get Pointer to bytecode data storage. More...
 
unsigned GetValSize () const
 Return size of a value entry. More...
 
unsigned GetPtrSize () const
 Return size of a pointer entry. More...
 
void RemoveValEntries (unsigned a_iNumber)
 Remove a value number of entries from the bytecode. More...
 
void AsciiDump ()
 Dump bytecode (for debugging only!). More...
 

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

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 ( )

Destructor (trivial).

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

Copy constructor.

Implemented in Terms of Assign(const ParserByteCode &a_ByteCode)

References Assign().

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

References mu::cmASSIGN.

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

Add function to bytecode.

Parameters
a_iArgcNumber of arguments, negative numbers indicate multiarg functions.
a_pFunPointer to function callback.

References mu::cmFUNC.

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
nothrowA 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.

References mu::cmFUNC_STR.

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_pValValue to be added.
Exceptions
nothrow

References mu::cmVAL.

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

Add a Variable pointer to bytecode.

Parameters
a_pVarPointer to be added.
Exceptions
nothrow

References mu::cmVAR.

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

Copy state of another object to this.

Exceptions
nowthrow

Referenced by operator=(), and ParserByteCode().

void mu::ParserByteCode::clear ( )

Delete the bytecode.

Exceptions
nothrowThe 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

References mu::cmEND.

std::size_t mu::ParserByteCode::GetBufSize ( ) const
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
const ParserByteCode::map_type * mu::ParserByteCode::GetRawData ( ) const

Get Pointer to bytecode data storage.

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)

References Assign().

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.

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