zserio.ast

Class Expression

java.lang.Object

zserio.ast.AstNodeBase

zserio.ast.Expression

All Implemented Interfaces:

AstNode

public final class Expression
extends AstNodeBase

AST node for expressions defined in the language.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Expression.ExpressionFlag Defines expression flag for constructors.
static class	Expression.ExpressionType Defines evaluated type of the expression.
static class	Expression.OptionalFieldInfo Optional field information returned from the getReferencedOptionalFields() method.

Constructor Summary

Constructors

Constructor and Description
Expression(AstLocation location, Package pkg, int expressionType, java.lang.String expressionText, Expression.ExpressionFlag expressionFlag) Constructor.
Expression(AstLocation location, Package pkg, int expressionType, java.lang.String expressionText, Expression.ExpressionFlag expressionFlag, Expression operand1) Constructor.
Expression(AstLocation location, Package pkg, int expressionType, java.lang.String expressionText, Expression.ExpressionFlag expressionFlag, Expression operand1, Expression operand2) Constructor.
Expression(AstLocation location, Package pkg, int expressionType, java.lang.String expressionText, Expression.ExpressionFlag expressionFlag, Expression operand1, Expression operand2, Expression operand3) Constructor.

Method Summary

Modifier and Type	Method and Description
void	accept(ZserioAstVisitor visitor) Accept zserio visitor.
boolean	containsIndex() Checks if expression contains token "index".
boolean	containsTernaryOperator() Checks if expression contains ternary operator 'a ? b : c'.
ZserioType	getExprOwner() Gets the owner of the expression.
AstNode	getExprSymbolObject() Gets the evaluated identifier symbol object for the expression.
Expression.ExpressionType	getExprType() Gets the evaluated type of the expression.
ZserioType	getExprZserioType() Gets the evaluated Zserio type for the expression.
java.math.BigInteger	getIntegerLowerBound() Gets lower bound for integer expression.
java.math.BigInteger	getIntegerUpperBound() Gets upper bound for integer expression.
java.math.BigInteger	getIntegerValue() Gets value for integer expression.
java.util.Map<Field,Expression.OptionalFieldInfo>	getReferencedOptionalFields() Gets all optional Field objects referenced from the expression.
<T extends AstNode> java.util.Set<T>	getReferencedSymbolObjects(java.lang.Class<? extends T> clazz) Gets all objects of given class referenced from the expression.
java.lang.String	getStringValue() Gets value for string expression.
java.lang.String	getText() Gets the expression text given by the parser.
int	getType() Gets the expression type given by the parser.
boolean	isExplicitVariable() Checks if the expression contains explicit variable.
boolean	isMostLeftId() Checks if the expression is most left identifier.
boolean	needsBigInteger() Gets needs BigInteger flag.
boolean	needsBigIntegerCastingToNative() Gets needs BigInteger casting to native flag.
Expression	op1() Gets the first operand for the expression.
Expression	op2() Gets the second operand for the expression.
Expression	op3() Gets the third operand for the expression.
boolean	requiresOwnerContext() Returns true if the expression requires the context of its owner.
void	visitChildren(ZserioAstVisitor visitor) Visit children of the current AST node using given visitor.

Methods inherited from class zserio.ast.AstNodeBase

getLocation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Expression

public Expression(AstLocation location,
                  Package pkg,
                  int expressionType,
                  java.lang.String expressionText,
                  Expression.ExpressionFlag expressionFlag)

Constructor.

Parameters:

location - AST node location.

pkg - Package to which the expression belongs.

expressionType - Expression grammar token type.

expressionText - Expression grammar token text.

expressionFlag - Flag for the expression.

Expression

public Expression(AstLocation location,
                  Package pkg,
                  int expressionType,
                  java.lang.String expressionText,
                  Expression.ExpressionFlag expressionFlag,
                  Expression operand1)

Constructor.

Parameters:

location - AST node location.

pkg - Package to which the expression belongs.

expressionType - Expression grammar token type.

expressionText - Expression grammar token text.

expressionFlag - Flag for the expression.

operand1 - Operand of the expression.

Expression

public Expression(AstLocation location,
                  Package pkg,
                  int expressionType,
                  java.lang.String expressionText,
                  Expression.ExpressionFlag expressionFlag,
                  Expression operand1,
                  Expression operand2)

Constructor.

Parameters:

location - AST node location.

pkg - Package to which the expression belongs.

expressionType - Expression grammar token type.

expressionText - Expression grammar token text.

expressionFlag - Flag for the expression.

operand1 - Left operand of the expression.

operand2 - Right operand of the expression.

Expression

public Expression(AstLocation location,
                  Package pkg,
                  int expressionType,
                  java.lang.String expressionText,
                  Expression.ExpressionFlag expressionFlag,
                  Expression operand1,
                  Expression operand2,
                  Expression operand3)

Constructor.

Parameters:

location - AST node location.

pkg - Package to which the expression belongs.

expressionType - Expression grammar token type.

expressionText - Expression grammar token text.

expressionFlag - Flag for the expression.

operand1 - Left operand of the expression.

operand2 - Middle operand of the expression.

operand3 - Right operand of the expression.

Method Detail

accept

public void accept(ZserioAstVisitor visitor)

Description copied from interface: AstNode

Accept zserio visitor.

Parameters:

visitor - Visitor to accept.

visitChildren

public void visitChildren(ZserioAstVisitor visitor)

Description copied from interface: AstNode

Visit children of the current AST node using given visitor.

Specified by:

visitChildren in interface AstNode

Overrides:

visitChildren in class AstNodeBase

Parameters:

visitor - Visitor to use.

getType

public int getType()

Gets the expression type given by the parser. This method should not be public but it is used by expression formatters at the moment.

Returns:

Expression type given by grammar.

getText

public java.lang.String getText()

Gets the expression text given by the parser. This method should not be public but it is used by expression formatters at the moment.

Returns:

Expression text given by grammar.

op1

public Expression op1()

Gets the first operand for the expression. This method should not be public but it is used by expression formatters at the moment.

Returns:

Returns the first operand.

op2

public Expression op2()

Gets the second operand for the expression. This method should not be public but it is used by expression formatters at the moment.

Returns:

Returns the second operand.

op3

public Expression op3()

Gets the third operand for the expression. This method should not be public but it is used by expression formatters at the moment.

Returns:

Returns the third operand.

isExplicitVariable

public boolean isExplicitVariable()

Checks if the expression contains explicit variable.

Returns:

Returns true if expression is explicit otherwise false.

isMostLeftId

public boolean isMostLeftId()

Checks if the expression is most left identifier.

Returns:

Returns true if expression is not explicit and is dot left operand or single identifier.

getExprType

public Expression.ExpressionType getExprType()

Gets the evaluated type of the expression.

Returns:

Returns the type of the expression.

getExprZserioType

public ZserioType getExprZserioType()

Gets the evaluated Zserio type for the expression.

Returns:

Returns the Zserio type for the expression.

getExprSymbolObject

public AstNode getExprSymbolObject()

Gets the evaluated identifier symbol object for the expression.

Returns:

Returns the identifier symbol object for the expression.

getExprOwner

public ZserioType getExprOwner()

Gets the owner of the expression. Owner is valid only for expressions which represent fields, parameters and functions.

Returns:

The owner of the expression.

getIntegerValue

public java.math.BigInteger getIntegerValue()

Gets value for integer expression.

Returns:

Returns value for integer expression or null if expression is not integer or if value of integer expression is not possible to evaluate during compile time.

getStringValue

public java.lang.String getStringValue()

Gets value for string expression.

Returns:

Returns value for string expression or null if expression is not string or if value of string expression is not possible to evaluate during compile time.

getIntegerLowerBound

public java.math.BigInteger getIntegerLowerBound()

Gets lower bound for integer expression.

Returns:

Returns lower bound for integer expression or null if expression is not integer or if lower bound of integer expression is not possible to evaluate during compile time.

getIntegerUpperBound

public java.math.BigInteger getIntegerUpperBound()

Gets upper bound for integer expression.

Returns:

Returns upper bound for integer expression or null if expression is not integer or if upper bound of integer expression is not possible to evaluate during compile time.

needsBigInteger

public boolean needsBigInteger()

Gets needs BigInteger flag.

Returns:

Returns true if the expression contains value which needs BigInteger type.

needsBigIntegerCastingToNative

public boolean needsBigIntegerCastingToNative()

Gets needs BigInteger casting to native flag.

Returns:

Returns true if the expression contains value which needs BigInteger type but it is assigned to the native type.

getReferencedSymbolObjects

public <T extends AstNode> java.util.Set<T> getReferencedSymbolObjects(java.lang.Class<? extends T> clazz)

Gets all objects of given class referenced from the expression.

Type Parameters:

T - Type of the object which should be found.

Parameters:

clazz - Class of which object should be found.

Returns:

Set of objects of given class referenced from the expression.

getReferencedOptionalFields

public java.util.Map<Field,Expression.OptionalFieldInfo> getReferencedOptionalFields()

Gets all optional Field objects referenced from the expression. Method returns as well additional information about each referenced optional Field. This info is stored in OptionalFieldInfo object in map value.

Returns:

Map of optional Field objects referenced from the expression.

requiresOwnerContext

public boolean requiresOwnerContext()

Returns true if the expression requires the context of its owner. This is true if the expression references the compound type that contains the expression (i.e. a field, a parameter) or if the expression contains compound function.

Returns:

Returns true if the expression needs reference to its owner.

containsIndex

public boolean containsIndex()

Checks if expression contains token "index".

Returns:

Returns true if this expression contains token "index".

containsTernaryOperator

public boolean containsTernaryOperator()

Checks if expression contains ternary operator 'a ? b : c'.

Returns:

Returns true if this expression contains ternary operator.