MacroExpression Class

Macro expression - represents a syntactic tree of the macro expression.

Inheritance Hierarchy

System.Object
  CMS.MacroEngine.MacroExpression

Namespace: CMS.MacroEngine
Assembly: CMS.MacroEngine (in CMS.MacroEngine.dll) Version: 8.2.23

Syntax

public class MacroExpression

The MacroExpression type exposes the following members.

Constructors

	Name	Description
Protected method	MacroExpression(List<MacroElement>)	Constructor.
Protected method	MacroExpression(List<MacroElement>, Int32, Int32)	Constructor.

Methods

	Name	Description
Public method Static member	ExtractParameter	Extracts specified parameter of Rule expression.
Protected method	GetElement	Gets the element on specific index of this expression.
Protected method	GetInfixMethodCall	Returns string representation of the method in format MyMethod(First, Second, Third).
Protected method	GetPrefixMethodCall	Returns string representation of the method in format First.MyMethod(Second, Third).
Protected method	GetPriority	Gets the priority of the evaluation for the given method.
Protected method	GetRoot	Gets the root of the expression.
Protected method	HasNumberOfChildren	Returns true if the current expression node has exactly specified number of children.
Protected method	CheckSyntax	Checks the syntactic tree of parsed expression if everything is OK and ready for correct evaluation.
Protected method	InitMethodOnResult	Transfers the current result to a first child (for the parameter of method).
Protected method	InitPropertyOnDataMember	Transfers the current result to a first child.
Protected method	IsFlatOperator	Returns true for operators which can be made flat - without subexpressions (||, &&, +, etc.)
Protected method	IsMethodWithName	Returns true if the type of current expression is MethodCall with specified name.
Protected method	IsSpecialCommand	Returns true for special commands such as break or continue, otherwise false.
Public method	MakeFlatter	Modifies the syntactic tree of the expression to the flat structure. Changes expressions like "(a || b) || c" to "a || b || c", etc.
Protected method	MakeChildOfPrevious	Makes current element child of the previous element if exists.
Protected method	Parse(Int32)	Parses the expression.
Protected method	Parse(Int32, Boolean)	Parses the expression.
Protected method	ParseAll	Parses the whole expression tree.
Public method Static member	ParseExpression	Returns the root of parsed expression. Uses cache of the parsed expressions to speedup the process.
Protected method	ParseParameters	Parses the method or indexer parameters.
Protected method	ReplaceChild	Replaces the given child expression with the given one.
Protected method	SyntaxError	Aborts the parsing of the expression due to a syntactic error
Public method	ToString()	Returns string representation of this MacroExpression. (Overrides Object.ToString().)
Public method	ToString(Boolean)	Returns string representation of this MacroExpression.
Protected method	ToStringBlock	Handles block of code: { [some code] }
Protected method	ToStringCommand	Handles special commands like return, break, etc.
Protected method	ToStringConstant	Handles constants (string literal, numbers, booleans, etc.).
Protected method	ToStringControlFlowStatements	Handles structures like [commandname] { [some code] }
Protected method	ToStringIndexer	Handles indexer expressions.
Protected method	ToStringMethod	Handles classic method calls.
Protected method	ToStringProperty	Handles properties.

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
Protected field	mChildren	Children expressions (parameters of method or subexpression).
Protected field	mParameters	Parameters for the given expression (backward compatibility).
Protected field	mPriority	Priority of the method.
Protected field Static member	mSyntacticTreeTable	Hash table with cached parsed expressions to speedup the macro evaluation.

Properties

	Name	Description
Protected property	EndIndex	Ending index of the expression in the source.
Public property	Children	Child expressions of the expression.
Public property	Name	Name of the data member or method call.
Protected property	Next	Next expression to evaluate.
Public property	Parameters	Parameters for the given expression; i.e. |(paramname)value expressions.
Public property	Parent	Parent expression.
Protected property	Previous	Previous expression (the expression from which this expression is the next).
Protected property	Priority	Gets the element priority.
Protected property	SourceElements	Elements from the source expression.
Protected property	StartIndex	Starting index of the expression in the source.
Public property	Type	Returns the expression type.
Public property	Value	Value of the value expression (is null for expression types like method, property, etc.).