ExpressionParser (Soy Complete)

java.lang.Object
- com.google.template.soy.exprparse.ExpressionParser

All Implemented Interfaces:: ExpressionParserConstants

public final class ExpressionParser
extends Object
implements ExpressionParserConstants

This parser's specification is in ExpressionParser.jj, which is read by JavaCC and transformed into ExpressionParser.java. To modify this parser, please edit ExpressionParser.jj. Do not edit ExpressionParser.java directly.

Important: Do not use outside of Soy code (treat as superpackage-private).

 This parser parses several related things: variables, data references, globals, expression lists,
 and expressions.

 A. Variable:
    + A dollar sign "$" followed by an identifier (no space between).

 B. Data reference:
    + The first part must be "$" followed by the first key name (no space between).
    + The first key name cannot be a number.
    + A variable will only have the first part. A data reference may have subsequent parts.
    + Subsequent parts may be:
       - A dot "." or question-dot "?." followed by a key name or array index (spaces between are
         allowed).
       - Brackets "[ ]" or question-brackets "?[ ]" with any expression inside the brackets (see
         below for definition of expression).
    + A special case is when the first key name is "ij". In this case, it's a reference to
      injected data, and the reference is considered to start from the second key (i.e. the second
      key actually becomes the first key in the parsed node).
    Examples:   $aaa   $ij.aaa   $aaa.bbb.0.ccc.12   $aaa[0]['bbb'].ccc   $aaa[$bbb + $ccc]
                $aaa?.bbb   $aaa.bbb?[0]?.ccc?['ddd']   $ij?.aaa

 C. Global:
    + One or more identifiers. If more than one, a dot "." is used to separate them.
    + Must not be preceded by a dollar sign "$".
    Examples:   AAA   aaa.bbb.CCC   a22.b88_

 D. Expression list:
    + A comma-separated list of one or more expressions (see below for definition of expression).
    Example:   $aaa, $bbb.ccc + 1, round(3.14)

 E. Expression:

    1. Data reference:
       + See above for definition.

    2. Global:
       + See above for definition.

    3. Null:   null

    4. Boolean:   false   true

    5. Integer:
       + No octal numbers.
       + Hex numbers have strict lower case "x" in "0x" and upper case "A-F".
       Examples:   0   26   -729   0x1A2B

    6. Float:
       + Decimal numbers only.
       + Must have digits on both sides of decimal point.
       + Exponents have strict lower case "e".
       Examples:   0.0   3.14159   -20.0   6.03e23   -3e-3

    7. String:
       + Single quotes only.
       + Escape sequences:   \\   \'   \"   \n   \r   \t   \b   \f
       + Unicode escape:   \ u ####   (backslash, "u", four hex digits -- no spaces in between)
       Examples:   ''   'abc'   'blah bleh bluh'   'aa\\bb\'cc\ndd'

    8. List literal:
       + Delimited by brackets.
       Examples:   []   ['blah', 123, $foo]

    9. Map literal:
       + Delimited by brackets.
       + Empty map has a single colon within the brackets (to distinguish from empty list).
       + Keys must be strings (or expressions that will evaluate to strings).
       Examples:   [:]   ['aaa': 'blah', 'bbb': 123, $boo: $foo]

    10. Operators:
       + Parentheses can be used to override precedence rules:   ( )
       + Precedence 8:   - (unary)   not
       + Precedence 7:   *   /   %
       + Precedence 6:   +   - (binary)
       + Precedence 5:   <   >   <=   >=
       + Precedence 4:   ==   !=
       + Precedence 3:   and
       + Precedence 2:   or
       + Precedence 1:   ?: (binary)   ? : (ternary)

    11. Functions:
       + Function name, open parenthesis, optional expression list, close parenthesis.
       + The function name is one identifier.
       + See above for the definition of an expression list.
       Examples:   isFirst($item)   foo()   myFunction(2, 'aa')

Field Summary

Fields
Modifier and Type	Field and Description
`static SoyError`	`INVALID_EXPRESSION_LIST`
`static SoyError`	`INVALID_VAR_NAME`
`Token`	`jj_nt` Next token.
`Token`	`token` Current token.
`ExpressionParserTokenManager`	`token_source` Generated Token Manager.

Fields inherited from interface com.google.template.soy.exprparse.ExpressionParserConstants
BOOLEAN, DEC_DIGITS, DEFAULT, DOLLAR_IDENT, DOT_IDENT, DOT_INDEX, EOF, FLOAT, HEX_DIGIT, IDENT, INTEGER, NULL, ONLY_BINARY_OP, ONLY_UNARY_OP, QUESTION_DOT_IDENT, QUESTION_DOT_INDEX, STRING, tokenImage, UNARY_OR_BINARY_OP, WS

Constructor Summary

Constructors
Constructor and Description
`ExpressionParser(ExpressionParserTokenManager tm)` Constructor with generated Token Manager.
`ExpressionParser(InputStream stream)` Constructor with InputStream.
`ExpressionParser(InputStream stream, String encoding)` Constructor with InputStream and supplied encoding
`ExpressionParser(Reader stream)` Constructor.
`ExpressionParser(String input, SourceLocation parentSourceLocation, ErrorReporter errorReporter)` Constructor that takes a string input.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`disable_tracing()` Disable tracing.
`void`	`enable_tracing()` Enable tracing.
`ParseException`	`generateParseException()` Generate ParseException.
`Token`	`getNextToken()` Get the next Token.
`Token`	`getToken(int index)` Get the specific Token.
`ExprNode`	`parseDataReference()` Parses the input as a data reference.
`ExprNode`	`parseExpression()` Parses the input as an expression.
`List<ExprNode>`	`parseExpressionList()` Parses the input as a comma-separated list of expressions.
`GlobalNode`	`parseGlobal()` Parses the input as a global.
`VarNode`	`parseVariable()` Parses the input as a variable name.
`void`	`ReInit(ExpressionParserTokenManager tm)` Reinitialise.
`void`	`ReInit(InputStream stream)` Reinitialise.
`void`	`ReInit(InputStream stream, String encoding)` Reinitialise.
`void`	`ReInit(Reader stream)` Reinitialise.

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

- Field Detail
  - INVALID_EXPRESSION_LIST
```
public static final SoyError INVALID_EXPRESSION_LIST
```
  - INVALID_VAR_NAME
```
public static final SoyError INVALID_VAR_NAME
```
  - token_source
```
public ExpressionParserTokenManager token_source
```
    Generated Token Manager.
  - token
```
public Token token
```
    Current token.
  - jj_nt
```
public Token jj_nt
```
    Next token.
- Constructor Detail
  - ExpressionParser
```
public ExpressionParser(String input,
                        SourceLocation parentSourceLocation,
                        ErrorReporter errorReporter)
```
    Constructor that takes a string input.
    
    Parameters:
    
    input - The input to parse.
    
    parentSourceLocation - the source location associated with the input.
    
    errorReporter - For reporting syntax errors.
  - ExpressionParser
```
public ExpressionParser(InputStream stream)
```
    Constructor with InputStream.
  - ExpressionParser
```
public ExpressionParser(InputStream stream,
                        String encoding)
```
    Constructor with InputStream and supplied encoding
  - ExpressionParser
```
public ExpressionParser(Reader stream)
```
    Constructor.
  - ExpressionParser
```
public ExpressionParser(ExpressionParserTokenManager tm)
```
    Constructor with generated Token Manager.
- Method Detail
  - parseExpressionList
```
public List<ExprNode> parseExpressionList()
```
    Parses the input as a comma-separated list of expressions.
    Maintains the following invariant: an empty list is returned if and only if an error is reported to the parser's ErrorReporter.
  - parseExpression
```
public ExprNode parseExpression()
```
    Parses the input as an expression.
    Maintains the following invariant: an error node is returned if and only if an error is reported to the parser's ErrorReporter.
  - parseVariable
```
public VarNode parseVariable()
```
    Parses the input as a variable name.
    Maintains the following invariant: an error node is returned if and only if an error is reported to the parser's ErrorReporter.
  - parseDataReference
```
public ExprNode parseDataReference()
```
    Parses the input as a data reference.
    Maintains the following invariant: an error node is returned if and only if an error is reported to the parser's ErrorReporter.
  - parseGlobal
```
public GlobalNode parseGlobal()
```
    Parses the input as a global.
    Maintains the following invariant: an error node is returned if and only if am error is reported to the parser's ErrorReporter.
  - ReInit
```
public void ReInit(InputStream stream)
```
    Reinitialise.
  - ReInit
```
public void ReInit(InputStream stream,
                   String encoding)
```
    Reinitialise.
  - ReInit
```
public void ReInit(Reader stream)
```
    Reinitialise.
  - ReInit
```
public void ReInit(ExpressionParserTokenManager tm)
```
    Reinitialise.
  - getNextToken
```
public final Token getNextToken()
```
    Get the next Token.
  - getToken
```
public final Token getToken(int index)
```
    Get the specific Token.
  - generateParseException
```
public ParseException generateParseException()
```
    Generate ParseException.
  - enable_tracing
```
public final void enable_tracing()
```
    Enable tracing.
  - disable_tracing
```
public final void disable_tracing()
```
    Disable tracing.

Class ExpressionParser

Field Summary

Fields inherited from interface com.google.template.soy.exprparse.ExpressionParserConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INVALID_EXPRESSION_LIST

INVALID_VAR_NAME

token_source

token

jj_nt

Constructor Detail

ExpressionParser

ExpressionParser

ExpressionParser

ExpressionParser

ExpressionParser

Method Detail

parseExpressionList

parseExpression

parseVariable

parseDataReference

parseGlobal

ReInit

ReInit

ReInit

ReInit

getNextToken

getToken

generateParseException

enable_tracing

disable_tracing