ParserUtil (LSPS 3.3 SDK)

java.lang.Object
- com.whitestein.lsps.lang.parser.ParserUtil

public final class ParserUtil
extends Object

Parser utilities.

Since:: 3.2.1000
Author:: mvo

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BRACKET_OP` A bracket operator.
`static String`	`DECREMENT_OP` A decrement operator (--);
`static String`	`DEPRECATED_ANNOTATION` Annotation `@Deprecated`.
`static String`	`DEREFERENCE_OP` A dereference operator.
`static String`	`DISABLED_ANNOTATION` Annotation `@Disabled`.
`static String`	`DIVIDE` Division operator (/).
`static String`	`ELLIPSIS` Ellipsis used to declare variadic parameters.
`static String`	`EXTENSION_METHOD_ANNOTATION` Annotation `@ExtensionMethod`.
`static String`	`INCREMENT_OP` An increment operator (++).
`static String`	`META_ANNOTATION` Annotation `@Meta`.
`static String`	`MINUS` A minus operator (-);
`static String`	`MODULO` Remainder operator (%).
`static String`	`MULTIPLY` A multiplication operator (*).
`static String`	`PLUS` A plus operator (+).
`static String`	`POWER` Power operator (**).
`static String`	`REFERENCE_OP` A reference operator.
`static String`	`SIDE_EFFECT_ANNOTATION` Annotation `@SideEffect`.
`static String`	`STATUS_ANNOTATION` Annotation `@Status`.
`static String`	`SUPER` "super" keyword

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`createLocalDateLiteral(java.time.LocalDate localDate)` Creates a local date literal.
`static String`	`createStringLiteral(String string)` Creates a string literal which has the value as a given string.
`static String`	`createSymbolLiteral(String string)` Creates a symbol literal which has the value as a given string.
`static String`	`encodeIdentifier(String id)` Encodes the given string as an identifier.
`static Type`	`findCommonExpressionSupertype(Collection<? extends Expression> expressions)` Returns the most specific common supertype of given expressions.
`static Set<String>`	`getAllKeywords()` Returns a set of all keywords (both language and reserved).
`static Set<String>`	`getAnnotationKeywords()` Returns a set of annotation keywords.
`static ASTRange`	`getASTRange(org.antlr.runtime.tree.Tree tree)` Returns the AST range of the given tree.
`static int`	`getBeginIndex(org.antlr.runtime.CommonToken token)` Returns start index of the token in the underlying source.
`static int`	`getBeginIndex(org.antlr.runtime.tree.Tree tree)` Returns start index of the tree in the underlying source.
`static int`	`getEndIndex(org.antlr.runtime.CommonToken token)` Returns end index (exclusive) of the token in the underlying source.
`static int`	`getEndIndex(org.antlr.runtime.tree.Tree tree)` Returns end index (exclusive) of the tree in the underlying source.
`static Set<String>`	`getLanguageKeywords()` Returns a set of language keywords.
`static int`	`getLine(org.antlr.runtime.CommonToken token)` Returns the line number.
`static int`	`getLine(org.antlr.runtime.tree.Tree tree)` Returns the line number.
`static LocalVarRange`	`getLocalVarRange(org.antlr.runtime.tree.Tree tree)`
`static ClassType`	`getMethodDeclarationType(FunctionSignature method, ClassType classType)` Returns the type where the method is declared.
`static ClassType`	`getReferencedClassType(Type type)` If the given type is a class type or a reference to a class type, that class type is returned.
`static Set<String>`	`getReservedKeywords()` Returns a set of reserved language keywords.
`static boolean`	`isEmptyExpression(String source)` Returns `true` if the given expression is `null`, or an empty string, or a string containing only whitespaces or comments.
`static boolean`	`isLanguageIdentifier(String id)` Returns true if the given string is a language identifier and does not have to be quoted in expressions.
`static String`	`parseIdentifier(String text)` Parses the given text, assuming it is an identifier.
`static String`	`parseIdentifier(org.antlr.runtime.tree.Tree tree)` Parses identifier.
`static List<String>`	`parseIdentifierList(String string)` Parses an identifier list from a string.
`static List<IdentifierAst>`	`parseIdentifierListAst(String string)` Parses an identifier list from a string.
`static List<String>`	`parseIdentifierPath(String string)` Parses an identifier path from a given string.
`static List<String>`	`parseIdentifierPath(org.antlr.runtime.tree.Tree tree)` Parses an identifier path from the given ANTLR tree.
`static Decimal`	`parseIntegerLiteral(String str)` Parser a given string assuming it is an integer literal.
`static java.time.LocalDate`	`parseLocalDateLiteral(String text)` Parses a given local date literal.
`static Map<String,String>`	`parseMetadata(org.antlr.runtime.tree.Tree tree, Errors errors)` Parses the metadata annotation.
`static List<QID>`	`parseQualifiedIdentifierList(String string)` Parses a qualified identifier list from a string.
`static List<QIDAst>`	`parseQualifiedIdentifierListAst(String string)` Parses a qualified identifier list from a string.
`static String`	`parseStringLiteral(String text)` Parses a string literal.
`static void`	`transform(org.antlr.runtime.tree.CommonTree tree)` Prepares an expression tree to be parsed.
`static void`	`updateTokenRanges(org.antlr.runtime.tree.CommonTree tree)` Updates the token ranges (start, stop, line) recursively.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEPRECATED_ANNOTATION
```
public static final String DEPRECATED_ANNOTATION
```
    Annotation @Deprecated.
    
    See Also:
    
    Constant Field Values
  - DISABLED_ANNOTATION
```
public static final String DISABLED_ANNOTATION
```
    Annotation @Disabled.
    
    See Also:
    
    Constant Field Values
  - EXTENSION_METHOD_ANNOTATION
```
public static final String EXTENSION_METHOD_ANNOTATION
```
    Annotation @ExtensionMethod.
    
    See Also:
    
    Constant Field Values
  - STATUS_ANNOTATION
```
public static final String STATUS_ANNOTATION
```
    Annotation @Status.
    
    See Also:
    
    Constant Field Values
  - SIDE_EFFECT_ANNOTATION
```
public static final String SIDE_EFFECT_ANNOTATION
```
    Annotation @SideEffect.
    
    See Also:
    
    Constant Field Values
  - META_ANNOTATION
```
public static final String META_ANNOTATION
```
    Annotation @Meta.
    
    See Also:
    
    Constant Field Values
  - ELLIPSIS
```
public static final String ELLIPSIS
```
    Ellipsis used to declare variadic parameters.
    
    See Also:
    
    Constant Field Values
  - BRACKET_OP
```
public static final String BRACKET_OP
```
    A bracket operator.
    
    See Also:
    
    Constant Field Values
  - REFERENCE_OP
```
public static final String REFERENCE_OP
```
    A reference operator.
    
    See Also:
    
    Constant Field Values
  - DEREFERENCE_OP
```
public static final String DEREFERENCE_OP
```
    A dereference operator.
    
    See Also:
    
    Constant Field Values
  - PLUS
```
public static final String PLUS
```
    A plus operator (+).
    
    See Also:
    
    Constant Field Values
  - MINUS
```
public static final String MINUS
```
    A minus operator (-);
    
    See Also:
    
    Constant Field Values
  - MULTIPLY
```
public static final String MULTIPLY
```
    A multiplication operator (*).
    
    See Also:
    
    Constant Field Values
  - DIVIDE
```
public static final String DIVIDE
```
    Division operator (/).
    
    See Also:
    
    Constant Field Values
  - MODULO
```
public static final String MODULO
```
    Remainder operator (%).
    
    See Also:
    
    Constant Field Values
  - POWER
```
public static final String POWER
```
    Power operator (**).
    
    See Also:
    
    Constant Field Values
  - INCREMENT_OP
```
public static final String INCREMENT_OP
```
    An increment operator (++).
    
    See Also:
    
    Constant Field Values
  - DECREMENT_OP
```
public static final String DECREMENT_OP
```
    A decrement operator (--);
    
    See Also:
    
    Constant Field Values
  - SUPER
```
public static final String SUPER
```
    "super" keyword
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getLanguageKeywords
```
public static Set<String> getLanguageKeywords()
```
    Returns a set of language keywords.
    
    Returns:
    
    a set of language keywords
  - getReservedKeywords
```
public static Set<String> getReservedKeywords()
```
    Returns a set of reserved language keywords.
    
    Returns:
    
    a set of reserved language keywords
  - getAllKeywords
```
public static Set<String> getAllKeywords()
```
    Returns a set of all keywords (both language and reserved).
    
    Returns:
    
    a set of all keywords
  - getAnnotationKeywords
```
public static Set<String> getAnnotationKeywords()
```
    Returns a set of annotation keywords.
    
    Returns:
    
    a set of annotation keywords
  - createStringLiteral
```
public static String createStringLiteral(String string)
```
    Creates a string literal which has the value as a given string.
    
    Parameters:
    
    string -
    
    Returns:
    
    the created string literal
  - createSymbolLiteral
```
public static String createSymbolLiteral(String string)
```
    Creates a symbol literal which has the value as a given string.
    
    Parameters:
    
    string -
    
    Returns:
    
    the created symbol literal
  - parseStringLiteral
```
public static String parseStringLiteral(String text)
                                 throws ValidationException
```
    Parses a string literal.
    
    Parameters:
    
    text -
    
    Returns:
    
    a string
    
    Throws:
    
    ValidationException
  - parseIntegerLiteral
```
public static Decimal parseIntegerLiteral(String str)
```
    Parser a given string assuming it is an integer literal.
    
    Parameters:
    
    str -
    
    Returns:
    
    a decimal object
  - createLocalDateLiteral
```
public static String createLocalDateLiteral(java.time.LocalDate localDate)
```
    Creates a local date literal.
    
    Parameters:
    
    localDate -
    
    Returns:
    
    the local date literal
  - parseLocalDateLiteral
```
public static java.time.LocalDate parseLocalDateLiteral(String text)
                                                 throws ValidationException
```
    Parses a given local date literal.
    
    Parameters:
    
    text -
    
    Returns:
    
    a local date
    
    Throws:
    
    ValidationException
  - encodeIdentifier
```
public static String encodeIdentifier(String id)
```
    Encodes the given string as an identifier.
    
    Parameters:
    
    id -
    
    Returns:
    
    the encoded identifier
    
    Throws:
    
    NullPointerException - if the id is null
  - isLanguageIdentifier
```
public static boolean isLanguageIdentifier(String id)
```
    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
  - parseIdentifier
```
public static String parseIdentifier(String text)
```
    Parses the given text, assuming it is an identifier.
    
    Parameters:
    
    text -
    
    Returns:
    
    the identifier
  - parseIdentifier
```
public static String parseIdentifier(org.antlr.runtime.tree.Tree tree)
```
    Parses identifier.
    
    Parameters:
    
    tree -
    
    Returns:
    
    the identifier
  - isEmptyExpression
```
public static boolean isEmptyExpression(String source)
```
    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
  - parseIdentifierPath
```
public static List<String> parseIdentifierPath(String string)
                                        throws ValidationException
```
    Parses an identifier path from a given string.
    
    Parameters:
    
    string -
    
    Returns:
    
    the list of path segments
    
    Throws:
    
    ValidationException - if the string is not a valid list of identifiers
    
    NullPointerException - if the string is null
  - parseIdentifierPath
```
public static List<String> parseIdentifierPath(org.antlr.runtime.tree.Tree tree)
```
    Parses an identifier path from the given ANTLR tree.
    
    Parameters:
    
    tree -
    
    Returns:
    
    the list of path segments
  - parseIdentifierList
```
public static List<String> parseIdentifierList(String string)
                                        throws ValidationException
```
    Parses an identifier list from a string.
    
    Parameters:
    
    string -
    
    Returns:
    
    the list of identifiers
    
    Throws:
    
    ValidationException - if the string is not a valid list of identifiers
  - parseIdentifierListAst
```
public static List<IdentifierAst> parseIdentifierListAst(String string)
                                                  throws ValidationException
```
    Parses an identifier list from a string.
    
    Parameters:
    
    string -
    
    Returns:
    
    the list of identifiers
    
    Throws:
    
    ValidationException - if the string is not a valid list of identifiers
  - parseQualifiedIdentifierList
```
public static List<QID> parseQualifiedIdentifierList(String string)
                                              throws ValidationException
```
    Parses a qualified identifier list from a string.
    
    Parameters:
    
    string -
    
    Returns:
    
    the list of qualified identifiers
    
    Throws:
    
    ValidationException - if the string is not a valid list of identifiers
  - parseQualifiedIdentifierListAst
```
public static List<QIDAst> parseQualifiedIdentifierListAst(String string)
                                                    throws ValidationException
```
    Parses a qualified identifier list from a string.
    
    Parameters:
    
    string -
    
    Returns:
    
    the list of qualified identifiers
    
    Throws:
    
    ValidationException - if the string is not a valid list of identifiers
  - getReferencedClassType
```
public static ClassType getReferencedClassType(Type type)
```
    If the given type is a class type or a reference to a class type, that class type is returned. Otherwise the method returns null.
    
    Parameters:
    
    type -
    
    Returns:
    
    the class type
  - findCommonExpressionSupertype
```
public static Type findCommonExpressionSupertype(Collection<? extends Expression> expressions)
```
    Returns the most specific common supertype of given expressions.
    
    Parameters:
    
    expressions -
    
    Returns:
    
    the most specific common supertype
  - transform
```
public static void transform(org.antlr.runtime.tree.CommonTree tree)
```
    Prepares an expression tree to be parsed.
    
    Parameters:
    
    tree -
  - updateTokenRanges
```
public static void updateTokenRanges(org.antlr.runtime.tree.CommonTree tree)
```
    Updates the token ranges (start, stop, line) recursively.
    
    Parameters:
    
    tree -
  - getBeginIndex
```
public static int getBeginIndex(org.antlr.runtime.tree.Tree tree)
```
    Returns start index of the tree in the underlying source.
    
    Parameters:
    
    tree -
    
    Returns:
    
    start index of the tree in the underlying source
  - getBeginIndex
```
public static int getBeginIndex(org.antlr.runtime.CommonToken token)
```
    Returns start index of the token in the underlying source.
    
    Parameters:
    
    token -
    
    Returns:
    
    start index of the token in the underlying source
  - getEndIndex
```
public static int getEndIndex(org.antlr.runtime.tree.Tree tree)
```
    Returns end index (exclusive) of the tree in the underlying source.
    
    Parameters:
    
    tree -
    
    Returns:
    
    end index of the tree in the underlying source
  - getEndIndex
```
public static int getEndIndex(org.antlr.runtime.CommonToken token)
```
    Returns end index (exclusive) of the token in the underlying source.
    
    Parameters:
    
    token -
    
    Returns:
    
    end index of the token in the underlying source
  - getLine
```
public static int getLine(org.antlr.runtime.tree.Tree tree)
```
    Returns the line number. The number of the first line is 0.
    
    Parameters:
    
    tree -
    
    Returns:
    
    the line number (0-based)
  - getLine
```
public static int getLine(org.antlr.runtime.CommonToken token)
```
    Returns the line number. The number of the first line is 0.
    
    Parameters:
    
    token -
    
    Returns:
    
    the line number (0-based)
  - getASTRange
```
public static ASTRange getASTRange(org.antlr.runtime.tree.Tree tree)
```
    Returns the AST range of the given tree.
    
    Parameters:
    
    tree -
    
    Returns:
    
    the range
  - getLocalVarRange
```
public static LocalVarRange getLocalVarRange(org.antlr.runtime.tree.Tree tree)
```
    Parameters:
    
    tree -
    
    Returns:
    
    the range
  - getMethodDeclarationType
```
public static ClassType getMethodDeclarationType(FunctionSignature method,
                                                 ClassType classType)
```
    Returns the type where the method is declared. Can be used only for protected or private visibility. (Public method declaration type may be in interface and is not well defined.)
    
    Parameters:
    
    method -
    
    classType -
    
    Returns:
    
    the type where the method is declared
  - parseMetadata
```
public static Map<String,String> parseMetadata(org.antlr.runtime.tree.Tree tree,
                                               Errors errors)
```
    Parses the metadata annotation.
    
    Parameters:
    
    tree -
    
    errors -
    
    Returns:
    
    the map of metadata

Class ParserUtil

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEPRECATED_ANNOTATION

DISABLED_ANNOTATION

EXTENSION_METHOD_ANNOTATION

STATUS_ANNOTATION

SIDE_EFFECT_ANNOTATION

META_ANNOTATION

ELLIPSIS

BRACKET_OP

REFERENCE_OP

DEREFERENCE_OP

PLUS

MINUS

MULTIPLY

DIVIDE

MODULO

POWER

INCREMENT_OP

DECREMENT_OP

SUPER

Method Detail

getLanguageKeywords

getReservedKeywords

getAllKeywords

getAnnotationKeywords

createStringLiteral

createSymbolLiteral

parseStringLiteral

parseIntegerLiteral

createLocalDateLiteral

parseLocalDateLiteral

encodeIdentifier

isLanguageIdentifier

parseIdentifier

parseIdentifier

isEmptyExpression

parseIdentifierPath

parseIdentifierPath

parseIdentifierList

parseIdentifierListAst

parseQualifiedIdentifierList

parseQualifiedIdentifierListAst

getReferencedClassType

findCommonExpressionSupertype

transform

updateTokenRanges

getBeginIndex

getBeginIndex

getEndIndex

getEndIndex

getLine

getLine

getASTRange

getLocalVarRange

getMethodDeclarationType

parseMetadata