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.
static String	DEREFERENCE_OP Deprecated. Use ParserUtil.DEREFERENCE_OP
static String	REFERENCE_OP Deprecated. Use ParserUtil.REFERENCE_OP

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.
Parser(NamespaceModel namespace, Collection<String> freeTypes, FreeTypeMapping freeTypeMapping, ParserVariableHelper variableHelper) 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
protected void	checkNamespace()
static String	createDateLiteral(Date date) Creates a date literal.
static String	createStringLiteral(String string) Deprecated. Use ParserUtil.createStringLiteral(String)
static String	createSymbolLiteral(String string) Deprecated. Use ParserUtil.createSymbolLiteral(String)
protected TypeParser	createTypeParser()
protected int	debugLine(org.antlr.runtime.tree.Tree tree)
static String	encodeIdentifier(String id) Deprecated. Use ParserUtil.encodeIdentifier(String)
protected ValidationException	error(String message, org.antlr.runtime.tree.Tree tree)
Type	findNamedType(QID qid) Finds a named type.
protected Visibility	getAccessiblePropertyVisibility(Expression primaryExpression, RecordType declarationType)
protected Set<String>	getFreeTypes()
static Set<String>	getLanguageKeywords() Deprecated. Use ParserUtil.getLanguageKeywords()
static Set<String>	getReservedKeywords() Deprecated. Use ParserUtil.getReservedKeywords()
ParserVariableHelper	getVariableHelper()
static boolean	isEmptyExpression(String source) Deprecated. Use ParserUtil.isEmptyExpression(String)
static boolean	isLanguageIdentifier(String id) Deprecated. Use ParserUtil.isLanguageIdentifier(String)
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.
protected IdentifierAst	parseIdentifierAst(org.antlr.runtime.tree.Tree tree)
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.
QID	parseQID(String string) Deprecated. Use QID.parse(String)
static String	parseStringLiteral(String text) Deprecated. Use ParserUtil.parseStringLiteral(String)
protected Type	parseType(org.antlr.runtime.tree.Tree tree)
void	setDebugLineOffset(int debugLineOffset) Sets the debug line offset that will be applied to parsed expressions.
protected void	setFreeTypes(Set<String> freeTypes)
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, parseIdentifier, parseIdentifier, parseInNamespace, parseInNewNamespace, parseInNewNamespace, parseQID, transform

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

begin, end, getASTNode, getFullText, getText, line, 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

REFERENCE_OP

@Deprecated
public static final String REFERENCE_OP

Deprecated. Use ParserUtil.REFERENCE_OP

A reference operator.

See Also:

Constant Field Values

DEREFERENCE_OP

@Deprecated
public static final String DEREFERENCE_OP

Deprecated. Use ParserUtil.DEREFERENCE_OP

A dereference operator.

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 -

Parser

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

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

Parameters:

namespace -

freeTypes -

freeTypeMapping -

variableHelper -

Method Detail

createTypeParser

protected TypeParser createTypeParser()

getFreeTypes

protected Set<String> getFreeTypes()

setFreeTypes

protected void setFreeTypes(Set<String> freeTypes)

getVariableHelper

public ParserVariableHelper getVariableHelper()

Returns:

the variable helper

error

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

isEmptyExpression

@Deprecated
public static boolean isEmptyExpression(String source)

Deprecated. Use ParserUtil.isEmptyExpression(String)

Returns true if the given expression is null, or an empty string, or a string containing only whitespaces or comments.

Parameters:

source -

Returns:

true if the given expression is empty

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

parseQID

@Deprecated
public QID parseQID(String string)
                         throws ValidationException

Deprecated. Use QID.parse(String)

Parses a qualified identifier from a string.

Parameters:

string -

Returns:

the parsed qualified identifier

Throws:

ValidationException - if the string is not a valid qualified identifier

NullPointerException - if the string is null

isLanguageIdentifier

@Deprecated
public static boolean isLanguageIdentifier(String id)

Deprecated. Use ParserUtil.isLanguageIdentifier(String)

Returns true if the given string is a language identifier and does not have to be quoted in expressions.

Parameters:

id -

Returns:

true if the given string is a language identifier

getLanguageKeywords

@Deprecated
public static Set<String> getLanguageKeywords()

Deprecated. Use ParserUtil.getLanguageKeywords()

Returns a set of language keywords.

Returns:

a set of language keywords

getReservedKeywords

@Deprecated
public static Set<String> getReservedKeywords()

Deprecated. Use ParserUtil.getReservedKeywords()

Returns a set of reserved language keywords.

Returns:

a set of reserved language keywords

encodeIdentifier

@Deprecated
public static String encodeIdentifier(String id)

Deprecated. Use ParserUtil.encodeIdentifier(String)

Encodes the given string as an identifier.

Parameters:

id -

Returns:

the encoded identifier

Throws:

NullPointerException - if the id is null

createStringLiteral

@Deprecated
public static String createStringLiteral(String string)

Deprecated. Use ParserUtil.createStringLiteral(String)

Creates a string literal which has the value as a given string.

Parameters:

string -

Returns:

the created string literal

createSymbolLiteral

@Deprecated
public static String createSymbolLiteral(String string)

Deprecated. Use ParserUtil.createSymbolLiteral(String)

Creates a symbol literal which has the value as a given string.

Parameters:

string -

Returns:

the created symbol literal

findNamedType

public final Type findNamedType(QID qid)
                         throws AmbiguousTypeException

Finds a named type.

Parameters:

qid -

Returns:

the type

Throws:

AmbiguousTypeException

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)

parseStringLiteral

@Deprecated
public static String parseStringLiteral(String text)

Deprecated. Use ParserUtil.parseStringLiteral(String)

Parses a string literal.

Parameters:

text -

Returns:

a string

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

parseIdentifierAst

protected IdentifierAst parseIdentifierAst(org.antlr.runtime.tree.Tree tree)

validateControlExpressions

protected Errors validateControlExpressions(Expression expression)