com.whitestein.lsps.lang.parser

Class Parser

java.lang.Object

com.whitestein.lsps.lang.parser.ParserBase

com.whitestein.lsps.lang.parser.AbstractParser

com.whitestein.lsps.lang.parser.Parser

Direct Known Subclasses:

ConstraintParser, SignatureParser, TaskParametersParser

public class Parser
extends AbstractParser

Parser of the LSPS expression language. The result of the parsing is an Expression which can be interpreted using Interpreter.

Each expression is parsed in context of NamespaceModel which provides variables, functions, etc.

Author:

rba

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEBUG A debug expression keyword.
static String	DEBUG_ELEMENT_ID A debug expression element id attribute key.
static String	DEBUG_PROPERTY A debug expression property attribute key.

Constructor Summary

Constructors

Constructor and Description
Parser() Creates a new parser.
Parser(NamespaceModel namespace) Creates a new parser.
Parser(NamespaceModel namespace, Collection<String> freeTypes) Creates a new parser with a collection of free type names that can be used in the expression.
Parser(NamespaceModel namespace, Collection<String> freeTypes, FreeTypeMapping freeTypeMapping) Creates a new parser with a collection of free type names that can be used in the expression.

Method Summary

Modifier and Type	Method and Description
void	addVariableListener(ParserVariableListener listener) Adds a variable listener.
protected void	checkNamespace()
static String	createDateLiteral(Date date) Creates a date literal.
protected TypeParser	createTypeParser()
protected int	debugLine(org.antlr.runtime.tree.Tree tree)
protected ValidationException	error(String message, org.antlr.runtime.tree.Tree tree)
protected Visibility	getAccessiblePropertyVisibility(Expression primaryExpression, RecordType declarationType)
protected Set<String>	getFreeTypes()
protected com.whitestein.lsps.lang.parser.ParserVariableFactory	getVariableFactory()
protected String	intern(String str)
protected boolean	isPropertyReadonly(PropertyExpression pe)
Expression	parse(AntlrExpressionTree expressionTree, Type expectedType) Parses an expression from a pre-parsed antlr tree for the given expected type.
Expression	parse(String source, Type expectedType) Parses an expression from a string source for the given expected type.
static Date	parseDateLiteral(String text) Parses a given date literal.
ParsedExpression	parseLax(AntlrExpressionTree expressionTree, Type expectedType) Parses an expression from a pre-parsed antlr tree for the given expected type.
protected ParsedExpression	parseNoCheck(org.antlr.runtime.tree.Tree tree, Type expectedType) Parse expression.
protected Type	parseType(org.antlr.runtime.tree.Tree tree)
void	removeVariableListener(ParserVariableListener listener) Removes a variable listener.
void	setDebugLineOffset(int debugLineOffset) Sets the debug line offset that will be applied to parsed expressions.
protected void	setFreeTypes(Set<String> freeTypes)
void	setIntern(boolean intern) Sets the intern flag.
protected Errors	validateControlExpressions(Expression expression)
protected ParsedExpression	validateOrConvert(ParsedExpression expr, Type expectedType) Provides some validation and conversion

Methods inherited from class com.whitestein.lsps.lang.parser.AbstractParser

checkTreeType, createConstant, createConstant, getAstInfo, getNamespace, parse, parseInNamespace, parseInNewNamespace, parseInNewNamespace

Methods inherited from class com.whitestein.lsps.lang.parser.ParserBase

begin, end, getASTNode, getFullText, getText, line, parseIdentifierAst, parseQIDAst, setFullText

Methods inherited from class java.lang.Object

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

Field Detail

DEBUG

public static final String DEBUG

A debug expression keyword.

See Also:

Constant Field Values

DEBUG_ELEMENT_ID

public static final String DEBUG_ELEMENT_ID

A debug expression element id attribute key.

See Also:

Constant Field Values

DEBUG_PROPERTY

public static final String DEBUG_PROPERTY

A debug expression property attribute key.

See Also:

Constant Field Values

Constructor Detail

Parser

public Parser()

Creates a new parser. DO NOT USE for parsing records. Information about shared records will be incorrect.

Parser

public Parser(NamespaceModel namespace)

Creates a new parser.

Parameters:

namespace -

Parser

public Parser(NamespaceModel namespace,
              Collection<String> freeTypes)

Creates a new parser with a collection of free type names that can be used in the expression.

Parameters:

namespace -

freeTypes -

Parser

public Parser(NamespaceModel namespace,
              Collection<String> freeTypes,
              FreeTypeMapping freeTypeMapping)

Creates a new parser with a collection of free type names that can be used in the expression.

Parameters:

namespace -

freeTypes -

freeTypeMapping -

Method Detail

setIntern

public void setIntern(boolean intern)

Sets the intern flag. When set to true, the parser interns some strings, e.g. record field names, local variable names etc.

Parameters:

intern -

intern

protected final String intern(String str)

createTypeParser

protected TypeParser createTypeParser()

getFreeTypes

protected Set<String> getFreeTypes()

setFreeTypes

protected void setFreeTypes(Set<String> freeTypes)

addVariableListener

public void addVariableListener(ParserVariableListener listener)

Adds a variable listener.

Parameters:

listener -

removeVariableListener

public void removeVariableListener(ParserVariableListener listener)

Removes a variable listener.

Parameters:

listener -

getVariableFactory

protected com.whitestein.lsps.lang.parser.ParserVariableFactory getVariableFactory()

error

protected ValidationException error(String message,
                                    org.antlr.runtime.tree.Tree tree)

parse

public Expression parse(String source,
                        Type expectedType)
                 throws ValidationException

Parses an expression from a string source for the given expected type.

Returns null if the source string is null or empty or contains only whitespaces or comments.

Parameters:

source -

expectedType -

Returns:

expression

Throws:

NullPointerException - if expectedType is null

ValidationException - if the source is not a valid expression or it is not of the expectedType

parse

public Expression parse(AntlrExpressionTree expressionTree,
                        Type expectedType)
                 throws ValidationException

Parses an expression from a pre-parsed antlr tree for the given expected type.

Returns null if the source string is null or empty or contains only whitespaces or comments.

Parameters:

expressionTree -

expectedType -

Returns:

expression

Throws:

NullPointerException - if expectedType is null

ValidationException - if the source is not a valid expression or it is not of the expectedType

parseLax

public ParsedExpression parseLax(AntlrExpressionTree expressionTree,
                                 Type expectedType)

Parses an expression from a pre-parsed antlr tree for the given expected type.

Returns null if the source string is null or empty or contains only whitespaces or comments.

Parameters:

expressionTree -

expectedType -

Returns:

expression

Throws:

NullPointerException - if expectedType is null

checkNamespace

protected final void checkNamespace()

parseType

protected Type parseType(org.antlr.runtime.tree.Tree tree)
                  throws ValidationException

Throws:

ValidationException

parseNoCheck

protected ParsedExpression parseNoCheck(org.antlr.runtime.tree.Tree tree,
                                        Type expectedType)

Description copied from class: AbstractParser

Parse expression. This should be the main method performing parsing

Specified by:

parseNoCheck in class AbstractParser

Returns:

parsed expression

setDebugLineOffset

public void setDebugLineOffset(int debugLineOffset)

Sets the debug line offset that will be applied to parsed expressions.

Parameters:

debugLineOffset -

debugLine

protected int debugLine(org.antlr.runtime.tree.Tree tree)

Overrides:

debugLine in class AbstractParser

getAccessiblePropertyVisibility

protected Visibility getAccessiblePropertyVisibility(Expression primaryExpression,
                                                     RecordType declarationType)

validateOrConvert

protected ParsedExpression validateOrConvert(ParsedExpression expr,
                                             Type expectedType)

Description copied from class: AbstractParser

Provides some validation and conversion

Overrides:

validateOrConvert in class AbstractParser

Returns:

converted expression

isPropertyReadonly

protected boolean isPropertyReadonly(PropertyExpression pe)

parseDateLiteral

public static Date parseDateLiteral(String text)
                             throws ValidationException

Parses a given date literal.

Parameters:

text -

Returns:

a date

Throws:

ValidationException

createDateLiteral

public static String createDateLiteral(Date date)

Creates a date literal.

Parameters:

date -

Returns:

a string representing a date literal

validateControlExpressions

protected Errors validateControlExpressions(Expression expression)