Class JexlParser

java.lang.Object
org.apache.commons.jexl3.parser.StringParser
org.apache.commons.jexl3.parser.JexlParser
All Implemented Interfaces:
JexlScriptParser
Direct Known Subclasses:
Parser

public abstract class JexlParser extends StringParser implements JexlScriptParser
The base class for parsing, manages the parameter/local variable frame.
  • Field Details

    • PRAGMA_OPTIONS

      public static final String PRAGMA_OPTIONS
      The name of the options pragma.
      See Also:
    • PRAGMA_JEXLNS

      public static final String PRAGMA_JEXLNS
      The prefix of a namespace pragma.
      See Also:
    • PRAGMA_MODULE

      public static final String PRAGMA_MODULE
      The prefix of a module pragma.
      See Also:
    • PRAGMA_IMPORT

      public static final String PRAGMA_IMPORT
      The import pragma.
      See Also:
    • ASSIGN_NODES

      private static final Set<Class<? extends JexlNode>> ASSIGN_NODES
      The set of assignment operators as classes.
    • featureController

      protected final FeatureController featureController
      The associated controller.
    • info

      protected JexlInfo info
      The basic source info.
    • source

      protected String source
      The source being processed.
    • scopeReference

      protected final AtomicReference<Scope> scopeReference
      The map of named registers aka script parameters.

      Each parameter is associated with a register and is materialized as an offset in the registers array used during evaluation.

    • scopes

      protected final Deque<Scope> scopes
      When parsing inner functions/lambda, need to stack the scope (sic).
    • pragmas

      protected Map<String,Object> pragmas
      The list of pragma declarations.
    • fqcnResolver

      The optional class name and constant resolver.
    • imports

      protected final List<String> imports
      The list of imports.

      Imports are used to resolve simple class names into fully qualified class names.

    • autoSemicolon

      protected boolean autoSemicolon
      Whether automatic semicolon insertion is enabled.
    • namespaces

      protected Set<String> namespaces
      The known namespaces.
    • loopCount

      protected AtomicInteger loopCount
      The number of nested loops.
    • loopCounts

      protected final Deque<Integer> loopCounts
      Stack of parsing loop counts.
    • blockReference

      protected final AtomicReference<JexlParser.LexicalUnit> blockReference
      The current lexical block.
    • blocks

      protected final Deque<JexlParser.LexicalUnit> blocks
      Stack of lexical blocks.
    • blockScopes

      protected final Map<JexlParser.LexicalUnit,Scope> blockScopes
      The map of lexical to functional blocks.
    • parent

      protected final JexlParser parent
      The parent parser if any.
    • NIL

      public static final Object NIL
      The name of the null case constant.
    • DFLT

      public static final Object DFLT
      The name of the default case constant.
    • NAN

      public static final Object NAN
      The name of the default NaN constant.
  • Constructor Details

    • JexlParser

      protected JexlParser()
      Creates a new parser.

      This constructor is protected so that it can only be used by subclasses.

    • JexlParser

      protected JexlParser(JexlParser parser)
      Creates a new inner-parser.

      This is the constructor used to create a parser for template expressions.

  • Method Details

    • errorToken

      protected static Token errorToken(Token... tokens)
      Pick the most significant token for error reporting.
      Parameters:
      tokens - The tokens to choose from
      Returns:
      The token
    • assignToken

      static Token assignToken(Token src, Token dest)
      Assigns the content of a token to another token.
      Parameters:
      src - The source token, if null, the destination token is returned
      dest - The destination token, if null, the source token is returned
      Returns:
      The destination token with the content of the source token
    • readSourceLine

      protected static String readSourceLine(String src, int lineno)
      Reads a given source line.
      Parameters:
      src - The source
      lineno - The line number
      Returns:
      The line
    • stringify

      protected static String stringify(Iterable<String> lstr)
      Utility function to create '.' separated string from a list of string.
      Parameters:
      lstr - The list of strings
      Returns:
      The dotted version
    • addImport

      void addImport(String importName)
    • resolveConstant

      Object resolveConstant(String name)
    • switchCode

      static Object switchCode(Object value)
      Encode a value to a switch predicate.
      Parameters:
      value - The value.
      Returns:
      The encoded value, which is either the value itself, or NAN (for NaN) or NIL (for null).
    • switchSet

      protected JexlParser.SwitchSet switchSet()
      Constructs a set of constants amenable to switch expression.
    • allowRegisters

      public void allowRegisters(boolean registers)
      Internal, for debug purpose only.
      Parameters:
      registers - sets whether this parser recognizes the register syntax
    • allowVariable

      protected boolean allowVariable(String image)
      Tests whether a given variable name is allowed.
      Parameters:
      image - The name.
      Returns:
      true if allowed, false if reserved.
    • checkLambda

      protected void checkLambda(Token token)
      Check fat vs thin arrow syntax feature.
      Parameters:
      token - The arrow token.
    • checkVariable

      protected String checkVariable(ASTIdentifier identifier, String name)
      Checks whether an identifier is a local variable or argument, ie a symbol, stored in a register.
      Parameters:
      identifier - The identifier.
      name - The identifier name.
      Returns:
      The image.
    • cleanup

      protected void cleanup(JexlFeatures features)
      Cleanup.
      Parameters:
      features - The feature set to restore if any.
    • controlPragmaAnywhere

      protected void controlPragmaAnywhere()
      Disables pragma feature if pragma-anywhere feature is disabled.
    • declareFunction

      protected void declareFunction(ASTVar variable, Token token)
      Declares a local function.
      Parameters:
      variable - The identifier used to declare.
      token - The variable name token.
    • declareParameter

      protected void declareParameter(Token token, boolean lexical, boolean constant)
      Declares a local parameter.

      This method creates a new entry in the symbol map.

      Parameters:
      token - The parameter name token.
      lexical - whether the parameter is lexical or not.
      constant - whether the parameter is constant or not.
    • declarePragma

      protected void declarePragma(String key, Object value)
      Adds a pragma declaration.
      Parameters:
      key - The pragma key.
      value - The pragma value.
    • declareSymbol

      private boolean declareSymbol(int symbol)
      Declares a symbol.
      Parameters:
      symbol - The symbol index.
      Returns:
      true if symbol can be declared in lexical scope, false (error) if it is already declared.
    • declareVariable

      protected void declareVariable(ASTVar variable, Token token, boolean lexical, boolean constant)
      Declares a local variable.

      This method creates an new entry in the symbol map.

      Parameters:
      variable - The identifier used to declare.
      lexical - whether the symbol is lexical.
      constant - whether the symbol is constant.
      token - The variable name token.
    • getFeatures

      protected JexlFeatures getFeatures()
      Gets the current set of features active during parsing.
      Returns:
      The current set of features active during parsing.
    • getScope

      protected Scope getScope()
      Gets the frame used by this parser.

      Since local variables create new symbols, it is important to regain access after parsing to known which / how-many registers are needed.

      Returns:
      The named register map
    • getToken

      protected abstract Token getToken(int index)
      Overridden in actual parser to access tokens stack.
      Parameters:
      index - 0 to get current token.
      Returns:
      The token on the stack.
    • getUnit

      protected JexlParser.LexicalUnit getUnit()
      Gets the lexical unit used by this parser.
      Returns:
      The named register map.
    • Identifier

      protected void Identifier(boolean top) throws ParseException
      Default implementation does nothing but is overridden by generated code.
      Parameters:
      top - whether the identifier is beginning an l/r value.
      Throws:
      ParseException - subclasses may throw ParseException.
    • isConstant

      private boolean isConstant(int symbol)
      Checks whether a symbol has been declared as a const in the current stack of lexical units.
      Parameters:
      symbol - The symbol.
      Returns:
      true if constant, false otherwise.
    • isNamespace

      private boolean isNamespace(String name)
      Checks whether a name is a declared namespace.
      Parameters:
      name - The namespace name.
      Returns:
      true if declared, false otherwise.
    • isNamespaceFuncall

      protected boolean isNamespaceFuncall(Token ns, Token colon, Token fun, Token paren)
      Semantic check identifying whether a list of 4 tokens forms a namespace function call.

      This is needed to disambiguate ternary operator, map entries and actual calls.

      Note that this check is performed before syntactic check so the expected parameters need to be verified.

      Parameters:
      ns - The namespace token.
      colon - expected to be ":"
      fun - The function name
      paren - expected to be "("
      Returns:
      true if the name qualifies a namespace function call.
    • isSymbolDeclared

      private boolean isSymbolDeclared(JexlNode.Info info, int symbol)
      Checks if a symbol is defined in lexical scopes.

      This works with parsed scripts in template resolution only.

      Parameters:
      info - An info linked to a node.
      symbol - The symbol number.
      Returns:
      true if symbol accessible in lexical scope.
    • isVariable

      protected boolean isVariable(String name)
      Checks whether an identifier is a local variable or argument.
      Parameters:
      name - The variable name.
      Returns:
      true if a variable with that name was declared.
    • isAmbiguousStatement

      protected boolean isAmbiguousStatement(int semicolon)
      Checks whether a statement is ambiguous.

      This is used to detect statements that are not terminated by a semicolon, and that may be confused with an expression.

      Parameters:
      semicolon - The semicolon token kind.
      Returns:
      true if statement is ambiguous, false otherwise.
    • isAllDigits

      protected boolean isAllDigits(String image)
      Checks whether a token image is composed only of decimal digits.

      Used to recognize a floating point literal with an omitted leading zero (e.g. .1) that is tokenized as DOT DOT_IDENTIFIER.

      Parameters:
      image - the token image
      Returns:
      true if every character is a decimal digit
    • jjtreeCloseNodeScope

      protected void jjtreeCloseNodeScope(JexlNode node)
      Called by parser at end of node construction.

      Detects "Ambiguous statement" and 'non-left value assignment'.

      Parameters:
      node - The node.
      Throws:
      JexlException.Parsing - when parsing fails.
    • jxltParse

      public ASTJexlScript jxltParse(JexlInfo info, JexlFeatures features, String src, Scope scope)
      Parses an embedded Jexl expression within an interpolation node.

      This creates a sub-parser that shares the scopes of the parent parser.

      Specified by:
      jxltParse in interface JexlScriptParser
      Parameters:
      info - The JexlInfo
      src - The source to parse
      features - The set of parsing features
      scope - The script frame
      Returns:
      The parsed tree
    • parseInterpolation

      static JxltEngine.Expression parseInterpolation(JexlInfo info, String src, Scope scope)
      Parses an interpolation expression.

      Requires the JEXL engine to be accessible through its thread-local.

      Parameters:
      info - The JexlInfo
      src - The source to parse
      scope - The scope
      Returns:
      The expression
    • jjtreeOpenNodeScope

      protected void jjtreeOpenNodeScope(JexlNode node)
      Called by parser at the beginning of a node construction.
      Parameters:
      node - The node.
    • beginLambda

      protected void beginLambda(ASTJexlScript jjtThis)
      Starts the definition of a lambda.
      Parameters:
      jjtThis - The script.
    • endLambda

      protected void endLambda(ASTJexlScript jjtThis)
      Ends the definition of a lambda.
      Parameters:
      jjtThis - The script.
    • popScope

      protected void popScope()
      Pops back to previous local variable scope.
    • popUnit

      protected void popUnit(JexlParser.LexicalUnit unit)
      Restores the previous lexical unit.
      Parameters:
      unit - restores the previous lexical scope.
    • pushScope

      protected void pushScope()
      Creates a new local variable scope and push it as current.
    • pushUnit

      protected void pushUnit(JexlParser.LexicalUnit unit)
      Pushes a new lexical unit.
      Parameters:
      unit - The new lexical unit.
    • pushLoop

      protected void pushLoop()
      Escape any outer (parent) loops.

      A lambda definition embedded in a for-block escapes that block; break/continue are not valid within that lambda.

    • popLoop

      protected void popLoop()
      Restores the previous loop count.
    • setFeatures

      protected void setFeatures(JexlFeatures features)
      Sets a new set of options.
      Parameters:
      features - The parser features
    • throwAmbiguousException

      protected void throwAmbiguousException(JexlNode node)
      Throws Ambiguous exception.

      Seeks the end of the ambiguous statement to recover.

      Parameters:
      node - The first token in ambiguous expression.
      Throws:
      JexlException.Ambiguous - in all cases.
    • throwFeatureException

      protected void throwFeatureException(int feature, JexlInfo info)
      Throws a feature exception.
      Parameters:
      feature - The feature code.
      info - The exception surroundings.
      Throws:
      JexlException.Feature - in all cases.
    • throwFeatureException

      protected void throwFeatureException(int feature, Token trigger)
      Throws a feature exception.
      Parameters:
      feature - The feature code.
      trigger - The token that triggered it.
      Throws:
      JexlException.Parsing - if actual error token cannot be found.
      JexlException.Feature - in all other cases.
    • throwParsingException

      protected void throwParsingException(Token parsed)
      Throws a parsing exception.
      Parameters:
      parsed - The token to report.
      Throws:
      JexlException.Parsing - in all cases.