Description:

This is a central class of library module ALib Expressions representing compiled, evaluable expressions.

The constructor is protected. Expressions are created using method Compiler::Compile. The result of this method is a shared pointer Expression which frees the user from the obligation to manage the life-cylce of ALib expressions.

For information about general use and features of this class consult the ALib Expressions User Manual.

Friends

class Compiler class detail::Program

Definition at line 35 of file expression.inl.

Collaboration diagram for alib::expressions::ExpressionVal:

[legend]

Public Field Index:
Ticks::Duration	DbgAssemblyTime

Ticks::Duration	DbgLastEvaluationTime

Ticks::Duration	DbgParseTime

Public Method Index:
ALIB_DLL	ExpressionVal (MonoAllocator &allocator, const String &sourceString, Scope *pCTScope)

ALIB_DLL	~ExpressionVal ()
	Destructor.

ALIB_DLL int	CtdOptimizations ()

ALIB_DLL Box	Evaluate (Scope &scope)

String	GetNormalizedString () const

ALIB_DLL String	GetOptimizedString ()

String	GetOriginalString () const

detail::ProgramBase *	GetProgram ()

ALIB_DLL integer	GetProgramLength ()

ALIB_DLL String	Name ()

ALIB_DLL Box	ResultType ()

Protected Field Index:
MonoAllocator &	allocator

Scope *	ctScope

String	name
	The name of the expression (if named, otherwise resourced, usually "ANONYMOUS" ).

AString	normalizedString
	The normalized string as a result of compilation.

AString	optimizedString
	The normalized string generated on request out of optimized expression program.

String	originalString
	The original source string of the expression.

detail::ProgramBase *	program
	The compiled expression program.

Field Details:

◆ allocator

MonoAllocator& alib::expressions::ExpressionVal::allocator

protected

The allocator, provided with construction. This usually is the 'self-contained' instance of type Expression. This allocator is forwarded to the ctScope and locked after compilation.

Definition at line 53 of file expression.inl.

◆ ctScope

Scope* alib::expressions::ExpressionVal::ctScope

protected

Compile-time scope object. Used to allocate constant program object copies. Also passed to the compiler plug-ins during compilation to add pre-calculated data.

Definition at line 58 of file expression.inl.

◆ DbgAssemblyTime

Ticks::Duration alib::expressions::ExpressionVal::DbgAssemblyTime

Provides the time needed to parse the expression into an abstract syntax tree.

Note: This field is available only with debug-builds of the library.

Definition at line 85 of file expression.inl.

◆ DbgLastEvaluationTime

Ticks::Duration alib::expressions::ExpressionVal::DbgLastEvaluationTime

Provides the time needed for the last evaluation of the expression.

Note: This field is available only with debug-builds of the library.

Definition at line 90 of file expression.inl.

◆ DbgParseTime

Ticks::Duration alib::expressions::ExpressionVal::DbgParseTime

Provides the time needed to parse the expression into an abstract syntax tree.

Note: This field is available only with debug-builds of the library.

Definition at line 80 of file expression.inl.

◆ name

String alib::expressions::ExpressionVal::name

protected

The name of the expression (if named, otherwise resourced, usually "ANONYMOUS" ).

Definition at line 61 of file expression.inl.

◆ normalizedString

AString alib::expressions::ExpressionVal::normalizedString

protected

The normalized string as a result of compilation.

Definition at line 70 of file expression.inl.

◆ optimizedString

AString alib::expressions::ExpressionVal::optimizedString

protected

The normalized string generated on request out of optimized expression program.

Definition at line 73 of file expression.inl.

◆ originalString

String alib::expressions::ExpressionVal::originalString

protected

The original source string of the expression.

Definition at line 67 of file expression.inl.

◆ program

detail::ProgramBase* alib::expressions::ExpressionVal::program

protected

The compiled expression program.

Definition at line 64 of file expression.inl.

Constructor(s) / Destructor Details:

◆ ExpressionVal()

alib::expressions::ExpressionVal::ExpressionVal	(	MonoAllocator &	allocator,
		const String &	sourceString,
		Scope *	pCTScope )

Constructor. Expressions are created using Compiler::Compile and thus, this constructor is available for the compiler only.

Note: The common way to assert accessibility would be to make this constructor protected and make class Compiler a friend. This is not possible, as this type is to be constructed by container type SharedVal. Therefore, an unused parameter of a protected type has to be passed, which can be created only by friend Compiler.

Parameters

allocator	The allocator to use. Usually this is the self-contained allocator of type Expression
sourceString	The original string that is to be compiled.
pCTScope	The compile-time scope.

Definition at line 35 of file expression.cpp.

Here is the call graph for this function:

◆ ~ExpressionVal()

alib::expressions::ExpressionVal::~ExpressionVal ( )

Destructor.

Definition at line 47 of file expression.cpp.

Here is the call graph for this function:

Method Details:

◆ CtdOptimizations()

int alib::expressions::ExpressionVal::CtdOptimizations ( )

Returns: The number of optimizations or -1 if optimizations were not activated during program assembly.

Definition at line 92 of file expression.cpp.

Here is the call graph for this function:

◆ Evaluate()

alib::Box alib::expressions::ExpressionVal::Evaluate ( Scope & scope )

Evaluates the expression by executing the compiled program.

With debug-builds of this library, ALib assertions may be raised. Usually this indicates that a native callback function returned a value of erroneous type, which usually are caused by erroneous compiler plug-ins, respectively the native callback functions that those provide.

The assertion will most probably give detailed information.

Parameters

scope The evaluation scope.

Returns: The result of this evaluation of this expression node.

Definition at line 68 of file expression.cpp.

Here is the call graph for this function:

◆ GetNormalizedString()

String alib::expressions::ExpressionVal::GetNormalizedString ( ) const

inline

Returns a normalized version of the original expression string.

The result of normalization can be tweaked with the flags in field configuration field Compiler::CfgNormalization. In any case, unnecessary (multiple) whitespaces and brackets are removed. Consult the documentation of enumeration Normalization for details of the options.

It is guaranteed that the normalized version of the expression string is parsable and leads to the identical evaluation program as the original expression string.

Software might choose to write back normalized expressions, for example into configuration files.

Note: This method does not perform the normalization, but returns a normalized version of the parsed expression string, which was created with the compilation of the expression. A normalized string is always created.

Returns: The normalized expression string.

Definition at line 170 of file expression.inl.

◆ GetOptimizedString()

String alib::expressions::ExpressionVal::GetOptimizedString ( )

Returns a normalized expression string reflecting an optimized version of this expression. The number of optimizations performed during compilation of the expression can be received by invoking Program::CtdOptimizations on the program returned by GetProgram. If this is 0, then the expression string returned here matches the normalized expression string received with GetNormalizedString.

Note: On the first invocation, the string is generated once. For this, an abstract syntax tree is created by decompiling the optimized program. This in turn is assembled back to a program (by omitting the generation of commands and without invoking on compiler plug-ins, etc.) which generates the normalized expression string from the AST.

Returns: The expression string requested.

Definition at line 82 of file expression.cpp.

◆ GetOriginalString()

String alib::expressions::ExpressionVal::GetOriginalString ( ) const

inline

Returns the originally given expression string.

Returns: The original expression string.

Definition at line 149 of file expression.inl.

◆ GetProgram()

detail::ProgramBase * alib::expressions::ExpressionVal::GetProgram ( )

inline

Returns the program that evaluates the expression.

Returns: The result of this evaluation of this expression node.

Definition at line 195 of file expression.inl.

◆ GetProgramLength()

integer alib::expressions::ExpressionVal::GetProgramLength ( )

Returns the number of VirtualMachine::Command that the program encompasses.

Returns: The program's length.

Definition at line 89 of file expression.cpp.

◆ Name()

String alib::expressions::ExpressionVal::Name ( )

The name of the expression. A name is only available if the expression was created with Compiler::AddNamed. This might be 'automatically' done when nested expressions get compiled and the compiler supports retrieval of expression strings by name from some custom location (or built-in ALib variable mechanics).

Otherwise, the name is "ANONYMOUS", which is a resourced string of key "ANON_EXPR_NAME".

Returns: The expression's name.

Definition at line 55 of file expression.cpp.

◆ ResultType()

alib::Box alib::expressions::ExpressionVal::ResultType ( )

Evaluates the expression by executing the compiled program.

Returns: The result of this evaluation of this expression node.

Definition at line 62 of file expression.cpp.

Here is the call graph for this function:

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

Description:

Friends

Public Field Index:

Public Method Index:

Protected Field Index:

Field Details:

◆ allocator

◆ ctScope

◆ DbgAssemblyTime

◆ DbgLastEvaluationTime

◆ DbgParseTime

◆ name

◆ normalizedString

◆ optimizedString

◆ originalString

◆ program

Constructor(s) / Destructor Details:

◆ ExpressionVal()

◆ ~ExpressionVal()

Method Details:

◆ CtdOptimizations()

◆ Evaluate()

◆ GetNormalizedString()

◆ GetOptimizedString()

◆ GetOriginalString()

◆ GetProgram()

◆ GetProgramLength()

◆ Name()

◆ ResultType()