Encapsulation of the data for a single formula token. More...

#include <muParserToken.h>

Collaboration diagram for mu::ParserToken< TBase, TString >:

Public Member Functions
	ParserToken ()
	Constructor (default). More...

	ParserToken (const ParserToken &a_Tok)
	Create token from another one. More...

ParserToken &	operator= (const ParserToken &a_Tok)
	Assignement operator. More...

void	Assign (const ParserToken &a_Tok)
	Copy token information from argument. More...

ParserToken &	Set (ECmdCode a_iType, const TString &a_strTok=TString())
	Assign a token type. More...

ParserToken &	Set (const ParserCallback &a_pCallback, const TString &a_sTok)
	Set Callback type. More...

ParserToken &	SetVal (TBase a_fVal, const TString &a_strTok=TString())
	Make this token a value token. More...

ParserToken &	SetVar (TBase *a_pVar, const TString &a_strTok)
	make this token a variable token. More...

ParserToken &	SetString (const TString &a_strTok, std::size_t a_iSize)
	Make this token a variable token. More...

void	SetIdx (int a_iIdx)
	Set an index associated with the token related data. More...

int	GetIdx () const
	Return Index associated with the token related data. More...

ECmdCode	GetCode () const
	Return the token type. More...

ETypeCode	GetType () const

int	GetPri () const

EOprtAssociativity	GetAssociativity () const

bool	IsOptimizable () const

generic_fun_type	GetFuncAddr () const
	Return the address of the callback function assoziated with function and operator tokens. More...

TBase	GetVal () const

TBase *	GetVar () const
	Get address of a variable token. More...

int	GetArgCount () const
	Return the number of function arguments. More...

const TString &	GetAsString () const
	Return the token identifier. More...

Private Attributes
ECmdCode	m_iCode
	Type of the token; The token type is a constant of type ECmdCode. More...

ETypeCode	m_iType

void *	m_pTok
	Stores Token pointer; not applicable for all tokens. More...

int	m_iIdx
	An otional index to an external buffer storing the token data. More...

TString	m_strTok
	Token string. More...

TString	m_strVal
	Value for string variables. More...

value_type	m_fVal
	the value More...

std::unique_ptr< ParserCallback >	m_pCallback

Detailed Description

template<typename TBase, typename TString>
class mu::ParserToken< TBase, TString >

Encapsulation of the data for a single formula token.

Formula token implementation. Part of the Math Parser Package. Formula tokens can be either one of the following:

value
variable
function with numerical arguments
functions with a string as argument
prefix operators
infix operators
binary operator

Author: (C) 2004-2012 Ingo Berg

Definition at line 61 of file muParserToken.h.

Constructor & Destructor Documentation

◆ ParserToken() [1/2]

template<typename TBase , typename TString >

mu::ParserToken< TBase, TString >::ParserToken ( )

inline

Constructor (default).

Sets token to an neutral state of type cmUNKNOWN.

Exceptions

nothrow

See also: ECmdCode

Definition at line 83 of file muParserToken.h.

◆ ParserToken() [2/2]

template<typename TBase , typename TString >

mu::ParserToken< TBase, TString >::ParserToken ( const ParserToken< TBase, TString > & a_Tok )

inline

Create token from another one.

Implemented by calling Assign(...)

Exceptions

nothrow

Postcondition: m_iType==cmUNKNOWN

See also: Assign

Definition at line 100 of file muParserToken.h.

References mu::ParserToken< TBase, TString >::Assign().

Here is the call graph for this function:

Member Function Documentation

◆ Assign()

template<typename TBase , typename TString >

void mu::ParserToken< TBase, TString >::Assign ( const ParserToken< TBase, TString > & a_Tok )

inline

Copy token information from argument.

Exceptions

nothrow

Definition at line 123 of file muParserToken.h.

References mu::ParserToken< TBase, TString >::m_fVal, mu::ParserToken< TBase, TString >::m_iCode, mu::ParserToken< TBase, TString >::m_iIdx, mu::ParserToken< TBase, TString >::m_iType, mu::ParserToken< TBase, TString >::m_pCallback, mu::ParserToken< TBase, TString >::m_pTok, mu::ParserToken< TBase, TString >::m_strTok, and mu::ParserToken< TBase, TString >::m_strVal.

Referenced by mu::ParserToken< TBase, TString >::operator=(), and mu::ParserToken< TBase, TString >::ParserToken().

◆ GetArgCount()

template<typename TBase , typename TString >

int mu::ParserToken< TBase, TString >::GetArgCount ( ) const

inline

Return the number of function arguments.

Valid only if m_iType==CmdFUNC.

Definition at line 384 of file muParserToken.h.

References mu::ecINTERNAL_ERROR, and mu::ParserToken< TBase, TString >::m_pCallback.

Referenced by mu::ParserBase::ApplyFunc(), and mu::ParserBase::ApplyStrFunc().

◆ GetAssociativity()

template<typename TBase , typename TString >

EOprtAssociativity mu::ParserToken< TBase, TString >::GetAssociativity ( ) const

inline

Definition at line 310 of file muParserToken.h.

References mu::cmOPRT_BIN, mu::ecINTERNAL_ERROR, and mu::ParserToken< TBase, TString >::m_pCallback.

Referenced by mu::ParserBase::GetOprtAssociativity().

◆ GetAsString()

template<typename TBase , typename TString >

const TString & mu::ParserToken< TBase, TString >::GetAsString ( ) const

inline

Return the token identifier.

If m_iType is cmSTRING the token identifier is the value of the string argument for a string function.

Returns: m_strTok

Exceptions

nothrow

See also: m_strTok

Definition at line 403 of file muParserToken.h.

References mu::ParserToken< TBase, TString >::m_strTok.

Referenced by mu::ParserBase::ApplyFunc(), mu::ParserBase::ApplyStrFunc(), mu::ParserBase::CreateRPN(), mu::ParserTokenReader::IsFunTok(), mu::ParserTokenReader::IsInfixOpTok(), mu::ParserTokenReader::IsUndefVarTok(), and mu::ParserBase::StackDump().

◆ GetCode()

template<typename TBase , typename TString >

ECmdCode mu::ParserToken< TBase, TString >::GetCode ( ) const

inline

Return the token type.

Returns: m_iType

Exceptions

nothrow

Definition at line 272 of file muParserToken.h.

References mu::ParserToken< TBase, TString >::m_iCode, and mu::ParserToken< TBase, TString >::m_pCallback.

Referenced by mu::ParserBase::ApplyFunc(), mu::ParserBase::ApplyIfElse(), mu::ParserBase::ApplyRemainingOprt(), mu::ParserBase::CreateRPN(), mu::ParserBase::GetOprtAssociativity(), mu::ParserBase::GetOprtPrecedence(), mu::ParserTokenReader::IsBuiltIn(), mu::ParserTokenReader::IsInfixOpTok(), and mu::ParserTokenReader::ReadNextToken().

◆ GetFuncAddr()

template<typename TBase , typename TString >

generic_fun_type mu::ParserToken< TBase, TString >::GetFuncAddr ( ) const

inline

Return the address of the callback function assoziated with function and operator tokens.

Returns: The pointer stored in m_pTok.

Exceptions

exception_type

if token type is non of:

cmFUNC
cmSTRFUNC
cmPOSTOP
cmINFIXOP
cmOPRT_BIN

See also: ECmdCode

Definition at line 341 of file muParserToken.h.

References mu::ParserToken< TBase, TString >::m_pCallback.

Referenced by mu::ParserBase::ApplyFunc(), and mu::ParserBase::ApplyStrFunc().

◆ GetIdx()

template<typename TBase , typename TString >

int mu::ParserToken< TBase, TString >::GetIdx ( ) const

inline

Return Index associated with the token related data.

In cmSTRFUNC - This is the index to a string table in the main parser.

Exceptions

exception_type if m_iIdx<0 or m_iType!=cmSTRING

Returns: The index the result will take in the Bytecode calculatin array (m_iIdx).

Definition at line 258 of file muParserToken.h.

References mu::cmSTRING, mu::ecINTERNAL_ERROR, mu::ParserToken< TBase, TString >::m_iCode, and mu::ParserToken< TBase, TString >::m_iIdx.

◆ GetPri()

template<typename TBase , typename TString >

int mu::ParserToken< TBase, TString >::GetPri ( ) const

inline

Definition at line 298 of file muParserToken.h.

References mu::cmOPRT_BIN, mu::cmOPRT_INFIX, mu::ecINTERNAL_ERROR, and mu::ParserToken< TBase, TString >::m_pCallback.

Referenced by mu::ParserBase::GetOprtPrecedence().

◆ GetType()

template<typename TBase , typename TString >

ETypeCode mu::ParserToken< TBase, TString >::GetType ( ) const

inline

Definition at line 285 of file muParserToken.h.

References mu::ParserToken< TBase, TString >::m_iType, and mu::ParserToken< TBase, TString >::m_pCallback.

Referenced by mu::ParserBase::ApplyBinOprt(), mu::ParserBase::ApplyFunc(), and mu::ParserBase::StackDump().

◆ GetVal()

template<typename TBase , typename TString >

TBase mu::ParserToken< TBase, TString >::GetVal ( ) const

inline

\biref Get value of the token.

Only applicable to variable and value tokens.

Exceptions

exception_type if token is no value/variable token.

Definition at line 352 of file muParserToken.h.

References mu::cmVAL, mu::cmVAR, mu::ecVAL_EXPECTED, mu::ParserToken< TBase, TString >::m_fVal, mu::ParserToken< TBase, TString >::m_iCode, and mu::ParserToken< TBase, TString >::m_pTok.

Referenced by mu::ParserBase::ApplyIfElse(), mu::ParserBase::CreateRPN(), and mu::ParserBase::StackDump().

◆ GetVar()

template<typename TBase , typename TString >

TBase * mu::ParserToken< TBase, TString >::GetVar ( ) const

inline

Get address of a variable token.

Valid only if m_iType==CmdVar.

Exceptions

exception_type if token is no variable token.

Definition at line 371 of file muParserToken.h.

References mu::cmVAR, mu::ecINTERNAL_ERROR, mu::ParserToken< TBase, TString >::m_iCode, and mu::ParserToken< TBase, TString >::m_pTok.

Referenced by mu::ParserBase::CreateRPN().

◆ IsOptimizable()

template<typename TBase , typename TString >

bool mu::ParserToken< TBase, TString >::IsOptimizable ( ) const

inline

Definition at line 319 of file muParserToken.h.

References mu::ecINTERNAL_ERROR, and mu::ParserToken< TBase, TString >::m_pCallback.

Referenced by mu::ParserBase::ApplyFunc().

◆ operator=()

template<typename TBase , typename TString >

ParserToken & mu::ParserToken< TBase, TString >::operator= ( const ParserToken< TBase, TString > & a_Tok )

inline

Assignement operator.

Copy token state from another token and return this. Implemented by calling Assign(...).

Exceptions

nothrow

Definition at line 112 of file muParserToken.h.

References mu::ParserToken< TBase, TString >::Assign().

Here is the call graph for this function:

◆ Set() [1/2]

template<typename TBase , typename TString >

ParserToken & mu::ParserToken< TBase, TString >::Set	(	const ParserCallback &	a_pCallback,
		const TString &	a_sTok
	)

inline

Set Callback type.

Definition at line 165 of file muParserToken.h.

References mu::ParserCallback::GetAddr(), mu::ParserCallback::GetCode(), mu::ParserToken< TBase, TString >::m_iCode, mu::ParserToken< TBase, TString >::m_iIdx, mu::ParserToken< TBase, TString >::m_iType, mu::ParserToken< TBase, TString >::m_pCallback, mu::ParserToken< TBase, TString >::m_pTok, mu::ParserToken< TBase, TString >::m_strTok, and mu::tpVOID.

Here is the call graph for this function:

◆ Set() [2/2]

template<typename TBase , typename TString >

ParserToken & mu::ParserToken< TBase, TString >::Set	(	ECmdCode	a_iType,
		const TString &	a_strTok = `TString()`
	)

inline

Assign a token type.

Token may not be of type value, variable or function. Those have seperate set functions.

Precondition: [assert] a_iType!=cmVAR; [assert] a_iType!=cmVAL; [assert] a_iType!=cmFUNC

Postcondition: m_fVal = 0; m_pTok = 0

Definition at line 147 of file muParserToken.h.

References mu::cmFUNC, mu::cmVAL, mu::cmVAR, mu::ParserToken< TBase, TString >::m_iCode, mu::ParserToken< TBase, TString >::m_iIdx, mu::ParserToken< TBase, TString >::m_iType, mu::ParserToken< TBase, TString >::m_pTok, mu::ParserToken< TBase, TString >::m_strTok, and mu::tpVOID.

Referenced by mu::ParserTokenReader::IsArgSep(), mu::ParserTokenReader::IsBuiltIn(), mu::ParserTokenReader::IsEOF(), mu::ParserTokenReader::IsFunTok(), mu::ParserTokenReader::IsInfixOpTok(), mu::ParserTokenReader::IsOprt(), and mu::ParserTokenReader::IsPostOpTok().

◆ SetIdx()

template<typename TBase , typename TString >

void mu::ParserToken< TBase, TString >::SetIdx ( int a_iIdx )

inline

Set an index associated with the token related data.

In cmSTRFUNC - This is the index to a string table in the main parser.

Parameters

a_iIdx The index the string function result will take in the bytecode parser.

Exceptions

exception_type if #a_iIdx<0 or m_iType!=cmSTRING

Definition at line 242 of file muParserToken.h.

References mu::cmSTRING, mu::ecINTERNAL_ERROR, mu::ParserToken< TBase, TString >::m_iCode, and mu::ParserToken< TBase, TString >::m_iIdx.

Referenced by mu::ParserBase::CreateRPN().

◆ SetString()

template<typename TBase , typename TString >

ParserToken & mu::ParserToken< TBase, TString >::SetString	(	const TString &	a_strTok,
		std::size_t	a_iSize
	)

inline

Make this token a variable token.

Member variables not necessary for variable tokens will be invalidated.

Exceptions

nothrow

Definition at line 223 of file muParserToken.h.

References mu::cmSTRING, mu::ParserToken< TBase, TString >::m_iCode, mu::ParserToken< TBase, TString >::m_iIdx, mu::ParserToken< TBase, TString >::m_iType, mu::ParserToken< TBase, TString >::m_pCallback, mu::ParserToken< TBase, TString >::m_pTok, mu::ParserToken< TBase, TString >::m_strTok, and mu::tpSTR.

Referenced by mu::ParserTokenReader::IsString(), and mu::ParserTokenReader::IsStrVarTok().

◆ SetVal()

template<typename TBase , typename TString >

ParserToken & mu::ParserToken< TBase, TString >::SetVal	(	TBase	a_fVal,
		const TString &	a_strTok = `TString()`
	)

inline

Make this token a value token.

Member variables not necessary for value tokens will be invalidated.

Exceptions

nothrow

Definition at line 186 of file muParserToken.h.

References mu::cmVAL, mu::ParserToken< TBase, TString >::m_fVal, mu::ParserToken< TBase, TString >::m_iCode, mu::ParserToken< TBase, TString >::m_iIdx, mu::ParserToken< TBase, TString >::m_iType, mu::ParserToken< TBase, TString >::m_pCallback, mu::ParserToken< TBase, TString >::m_pTok, mu::ParserToken< TBase, TString >::m_strTok, and mu::tpDBL.

Referenced by mu::ParserBase::ApplyFunc(), mu::ParserBase::ApplyStrFunc(), and mu::ParserTokenReader::IsValTok().

◆ SetVar()

template<typename TBase , typename TString >

ParserToken & mu::ParserToken< TBase, TString >::SetVar	(	TBase *	a_pVar,
		const TString &	a_strTok
	)

inline

make this token a variable token.

Member variables not necessary for variable tokens will be invalidated.

Exceptions

nothrow

Definition at line 206 of file muParserToken.h.

References mu::cmVAR, mu::ParserToken< TBase, TString >::m_iCode, mu::ParserToken< TBase, TString >::m_iIdx, mu::ParserToken< TBase, TString >::m_iType, mu::ParserToken< TBase, TString >::m_pCallback, mu::ParserToken< TBase, TString >::m_pTok, mu::ParserToken< TBase, TString >::m_strTok, and mu::tpDBL.

Referenced by mu::ParserTokenReader::IsUndefVarTok(), and mu::ParserTokenReader::IsVarTok().

Member Data Documentation

◆ m_fVal

template<typename TBase , typename TString >

value_type mu::ParserToken< TBase, TString >::m_fVal

private

the value

Definition at line 71 of file muParserToken.h.

Referenced by mu::ParserToken< TBase, TString >::Assign(), mu::ParserToken< TBase, TString >::GetVal(), and mu::ParserToken< TBase, TString >::SetVal().

◆ m_iCode

template<typename TBase , typename TString >

ECmdCode mu::ParserToken< TBase, TString >::m_iCode

private

Type of the token; The token type is a constant of type ECmdCode.

Definition at line 65 of file muParserToken.h.

Referenced by mu::ParserToken< TBase, TString >::Assign(), mu::ParserToken< TBase, TString >::GetCode(), mu::ParserToken< TBase, TString >::GetIdx(), mu::ParserToken< TBase, TString >::GetVal(), mu::ParserToken< TBase, TString >::GetVar(), mu::ParserToken< TBase, TString >::Set(), mu::ParserToken< TBase, TString >::SetIdx(), mu::ParserToken< TBase, TString >::SetString(), mu::ParserToken< TBase, TString >::SetVal(), and mu::ParserToken< TBase, TString >::SetVar().

◆ m_iIdx

template<typename TBase , typename TString >

int mu::ParserToken< TBase, TString >::m_iIdx

private

An otional index to an external buffer storing the token data.

Definition at line 68 of file muParserToken.h.

Referenced by mu::ParserToken< TBase, TString >::Assign(), mu::ParserToken< TBase, TString >::GetIdx(), mu::ParserToken< TBase, TString >::Set(), mu::ParserToken< TBase, TString >::SetIdx(), mu::ParserToken< TBase, TString >::SetString(), mu::ParserToken< TBase, TString >::SetVal(), and mu::ParserToken< TBase, TString >::SetVar().

◆ m_iType

template<typename TBase , typename TString >

ETypeCode mu::ParserToken< TBase, TString >::m_iType

private

Definition at line 66 of file muParserToken.h.

Referenced by mu::ParserToken< TBase, TString >::Assign(), mu::ParserToken< TBase, TString >::GetType(), mu::ParserToken< TBase, TString >::Set(), mu::ParserToken< TBase, TString >::SetString(), mu::ParserToken< TBase, TString >::SetVal(), and mu::ParserToken< TBase, TString >::SetVar().

◆ m_pCallback

template<typename TBase , typename TString >

std::unique_ptr<ParserCallback> mu::ParserToken< TBase, TString >::m_pCallback

private

Definition at line 72 of file muParserToken.h.

◆ m_pTok

template<typename TBase , typename TString >

void* mu::ParserToken< TBase, TString >::m_pTok

private

Stores Token pointer; not applicable for all tokens.

Definition at line 67 of file muParserToken.h.

Referenced by mu::ParserToken< TBase, TString >::Assign(), mu::ParserToken< TBase, TString >::GetVal(), mu::ParserToken< TBase, TString >::GetVar(), mu::ParserToken< TBase, TString >::Set(), mu::ParserToken< TBase, TString >::SetString(), mu::ParserToken< TBase, TString >::SetVal(), and mu::ParserToken< TBase, TString >::SetVar().

◆ m_strTok

template<typename TBase , typename TString >

TString mu::ParserToken< TBase, TString >::m_strTok

private

Token string.

Definition at line 69 of file muParserToken.h.

Referenced by mu::ParserToken< TBase, TString >::Assign(), mu::ParserToken< TBase, TString >::GetAsString(), mu::ParserToken< TBase, TString >::Set(), mu::ParserToken< TBase, TString >::SetString(), mu::ParserToken< TBase, TString >::SetVal(), and mu::ParserToken< TBase, TString >::SetVar().

◆ m_strVal

template<typename TBase , typename TString >

TString mu::ParserToken< TBase, TString >::m_strVal

private

Value for string variables.

Definition at line 70 of file muParserToken.h.

Referenced by mu::ParserToken< TBase, TString >::Assign().

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

D:/CPP/numere-source/trunk/kernel/core/ParserLib/muParserToken.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ParserToken() [1/2]

◆ ParserToken() [2/2]

Member Function Documentation

◆ Assign()

◆ GetArgCount()

◆ GetAssociativity()

◆ GetAsString()

◆ GetCode()

◆ GetFuncAddr()

◆ GetIdx()

◆ GetPri()

◆ GetType()

◆ GetVal()

◆ GetVar()

◆ IsOptimizable()

◆ operator=()

◆ Set() [1/2]

◆ Set() [2/2]

◆ SetIdx()

◆ SetString()

◆ SetVal()

◆ SetVar()

Member Data Documentation

◆ m_fVal

◆ m_iCode

◆ m_iIdx

◆ m_iType

◆ m_pCallback

◆ m_pTok

◆ m_strTok

◆ m_strVal