Class Parser

java.lang.Object
org.apache.velocity.runtime.parser.Parser
All Implemented Interfaces:
ParserConstants, ParserTreeConstants

public class Parser extends Object implements ParserTreeConstants, ParserConstants
This class is responsible for parsing a Velocity template. This class was generated by JavaCC using the JJTree extension to produce an Abstract Syntax Tree (AST) of the template. Please look at the Parser.jjt file which is what controls the generation of this class.
Version:
$Id: Parser.java 928463 2010-03-28 18:11:34Z nbubna $
  • Field Details

    • jjtree

      protected JJTParserState jjtree
    • macroNames

      private Map macroNames
      Keep track of defined macros, used for escape processing
    • currentTemplateName

      public String currentTemplateName
      Name of current template we are parsing. Passed to us in parse()
    • strictEscape

      public boolean strictEscape
      Set to true if the property RuntimeConstants.RUNTIME_REFERENCES_STRICT_ESCAPE is set to true
    • velcharstream

      VelocityCharStream velcharstream
    • rsvc

      private RuntimeServices rsvc
    • token_source

      public ParserTokenManager token_source
      Generated Token Manager.
    • token

      public Token token
      Current token.
    • jj_nt

      public Token jj_nt
      Next token.
    • jj_ntk

      private int jj_ntk
    • jj_scanpos

      private Token jj_scanpos
    • jj_lastpos

      private Token jj_lastpos
    • jj_la

      private int jj_la
    • jj_gen

      private int jj_gen
    • jj_la1

      private final int[] jj_la1
    • jj_la1_0

      private static int[] jj_la1_0
    • jj_la1_1

      private static int[] jj_la1_1
    • jj_la1_2

      private static int[] jj_la1_2
    • jj_2_rtns

      private final Parser.JJCalls[] jj_2_rtns
    • jj_rescan

      private boolean jj_rescan
    • jj_gc

      private int jj_gc
    • jj_ls

      private final Parser.LookaheadSuccess jj_ls
    • jj_expentries

      private List jj_expentries
    • jj_expentry

      private int[] jj_expentry
    • jj_kind

      private int jj_kind
    • jj_lasttokens

      private int[] jj_lasttokens
    • jj_endpos

      private int jj_endpos
  • Constructor Details

    • Parser

      public Parser(RuntimeServices rs)
      This constructor was added to allow the re-use of parsers. The normal constructor takes a single argument which an InputStream. This simply creates a re-usable parser object, we satisfy the requirement of an InputStream by using a newline character as an input stream.
    • Parser

      public Parser(CharStream stream)
      Constructor with user supplied CharStream.
    • Parser

      public Parser(ParserTokenManager tm)
      Constructor with generated Token Manager.
  • Method Details

    • parse

      public SimpleNode parse(Reader reader, String templateName) throws ParseException
      This was also added to allow parsers to be re-usable. Normal JavaCC use entails passing an input stream to the constructor and the parsing process is carried out once. We want to be able to re-use parsers: we do this by adding this method and re-initializing the lexer with the new stream that we want parsed.
      Throws:
      ParseException
    • getDirective

      public Directive getDirective(String directive)
      This method gets a Directive from the directives Hashtable
    • isDirective

      public boolean isDirective(String directive)
      This method finds out of the directive exists in the directives Map.
    • escapedDirective

      private String escapedDirective(String strImage)
      Produces a processed output for an escaped control or pluggable directive
    • isLeftParenthesis

      private boolean isLeftParenthesis()
      Check whether there is a left parenthesis with leading optional whitespaces. This method is used in the semantic look ahead of Directive method. This is done in code instead of as a production for simplicity and efficiency.
    • process

      public final SimpleNode process() throws ParseException
      This method is what starts the whole parsing process. After the parsing is complete and the template has been turned into an AST, this method returns the root of AST which can subsequently be traversed by a visitor which implements the ParserVisitor interface which is generated automatically by JavaCC
      Throws:
      ParseException
    • Statement

      public final void Statement() throws ParseException
      These are the types of statements that are acceptable in Velocity templates.
      Throws:
      ParseException
    • EscapedDirective

      public final void EscapedDirective() throws ParseException
      used to separate the notion of a valid directive that has been escaped, versus something that looks like a directive and is just schmoo. This is important to do as a separate production that creates a node, because we want this, in either case, to stop the further parsing of the Directive() tree.
      Throws:
      ParseException
    • Escape

      public final void Escape() throws ParseException
      Used to catch and process escape sequences in grammatical constructs as escapes outside of VTL are just characters. Right now we have both this and the EscapeDirective() construction because in the EscapeDirective() case, we want to suck in the # and here we don't. We just want the escapes to render correctly
      Throws:
      ParseException
    • Comment

      public final void Comment() throws ParseException
      Throws:
      ParseException
    • Textblock

      public final void Textblock() throws ParseException
      Throws:
      ParseException
    • FloatingPointLiteral

      public final void FloatingPointLiteral() throws ParseException
      Throws:
      ParseException
    • IntegerLiteral

      public final void IntegerLiteral() throws ParseException
      Throws:
      ParseException
    • StringLiteral

      public final void StringLiteral() throws ParseException
      Throws:
      ParseException
    • Identifier

      public final void Identifier() throws ParseException
      This method corresponds to variable references in Velocity templates. The following are examples of variable references that may be found in a template: $foo $bar
      Throws:
      ParseException
    • Word

      public final void Word() throws ParseException
      Throws:
      ParseException
    • DirectiveArg

      public final int DirectiveArg() throws ParseException
      Supports the arguments for the Pluggable Directives
      Throws:
      ParseException
    • Directive

      public final SimpleNode Directive() throws ParseException
      Supports the Pluggable Directives #foo( arg+ )
      Throws:
      ParseException
    • Map

      public final void Map() throws ParseException
      for creating a map in a #set #set($foo = {$foo : $bar, $blargh : $thingy})
      Throws:
      ParseException
    • ObjectArray

      public final void ObjectArray() throws ParseException
      Throws:
      ParseException
    • IntegerRange

      public final void IntegerRange() throws ParseException
      supports the [n..m] vector generator for use in the #foreach() to generate measured ranges w/o needing explicit support from the app/servlet
      Throws:
      ParseException
    • IndexParameter

      public final void IndexParameter() throws ParseException
      A Simplified parameter more suitable for an index position: $foo[$index]
      Throws:
      ParseException
    • Parameter

      public final void Parameter() throws ParseException
      This method has yet to be fully implemented but will allow arbitrarily nested method calls
      Throws:
      ParseException
    • Method

      public final void Method() throws ParseException
      This method has yet to be fully implemented but will allow arbitrarily nested method calls
      Throws:
      ParseException
    • Index

      public final void Index() throws ParseException
      Throws:
      ParseException
    • Reference

      public final void Reference() throws ParseException
      Throws:
      ParseException
    • True

      public final void True() throws ParseException
      Throws:
      ParseException
    • False

      public final void False() throws ParseException
      Throws:
      ParseException
    • Text

      public final void Text() throws ParseException
      This method is responsible for allowing all non-grammar text to pass through unscathed.
      Throws:
      ParseException
    • IfStatement

      public final void IfStatement() throws ParseException
      Throws:
      ParseException
    • ElseStatement

      public final void ElseStatement() throws ParseException
      Throws:
      ParseException
    • ElseIfStatement

      public final void ElseIfStatement() throws ParseException
      Throws:
      ParseException
    • SetDirective

      public final void SetDirective() throws ParseException
      Currently support both types of set : #set( expr ) #set expr
      Throws:
      ParseException
    • Expression

      public final void Expression() throws ParseException
      Throws:
      ParseException
    • Assignment

      public final void Assignment() throws ParseException
      Throws:
      ParseException
    • ConditionalOrExpression

      public final void ConditionalOrExpression() throws ParseException
      Throws:
      ParseException
    • ConditionalAndExpression

      public final void ConditionalAndExpression() throws ParseException
      Throws:
      ParseException
    • EqualityExpression

      public final void EqualityExpression() throws ParseException
      Throws:
      ParseException
    • RelationalExpression

      public final void RelationalExpression() throws ParseException
      Throws:
      ParseException
    • AdditiveExpression

      public final void AdditiveExpression() throws ParseException
      Throws:
      ParseException
    • MultiplicativeExpression

      public final void MultiplicativeExpression() throws ParseException
      Throws:
      ParseException
    • UnaryExpression

      public final void UnaryExpression() throws ParseException
      Throws:
      ParseException
    • PrimaryExpression

      public final void PrimaryExpression() throws ParseException
      Throws:
      ParseException
    • jj_2_1

      private boolean jj_2_1(int xla)
    • jj_2_2

      private boolean jj_2_2(int xla)
    • jj_2_3

      private boolean jj_2_3(int xla)
    • jj_2_4

      private boolean jj_2_4(int xla)
    • jj_2_5

      private boolean jj_2_5(int xla)
    • jj_2_6

      private boolean jj_2_6(int xla)
    • jj_2_7

      private boolean jj_2_7(int xla)
    • jj_2_8

      private boolean jj_2_8(int xla)
    • jj_2_9

      private boolean jj_2_9(int xla)
    • jj_2_10

      private boolean jj_2_10(int xla)
    • jj_2_11

      private boolean jj_2_11(int xla)
    • jj_2_12

      private boolean jj_2_12(int xla)
    • jj_3_7

      private boolean jj_3_7()
    • jj_3R_61

      private boolean jj_3R_61()
    • jj_3R_39

      private boolean jj_3R_39()
    • jj_3R_40

      private boolean jj_3R_40()
    • jj_3R_88

      private boolean jj_3R_88()
    • jj_3R_87

      private boolean jj_3R_87()
    • jj_3R_86

      private boolean jj_3R_86()
    • jj_3R_38

      private boolean jj_3R_38()
    • jj_3R_85

      private boolean jj_3R_85()
    • jj_3R_84

      private boolean jj_3R_84()
    • jj_3R_83

      private boolean jj_3R_83()
    • jj_3R_67

      private boolean jj_3R_67()
    • jj_3R_24

      private boolean jj_3R_24()
    • jj_3R_82

      private boolean jj_3R_82()
    • jj_3R_81

      private boolean jj_3R_81()
    • jj_3R_80

      private boolean jj_3R_80()
    • jj_3R_79

      private boolean jj_3R_79()
    • jj_3R_72

      private boolean jj_3R_72()
    • jj_3R_73

      private boolean jj_3R_73()
    • jj_3R_35

      private boolean jj_3R_35()
    • jj_3_11

      private boolean jj_3_11()
    • jj_3R_62

      private boolean jj_3R_62()
    • jj_3_6

      private boolean jj_3_6()
    • jj_3R_33

      private boolean jj_3R_33()
    • jj_3R_59

      private boolean jj_3R_59()
    • jj_3R_58

      private boolean jj_3R_58()
    • jj_3R_57

      private boolean jj_3R_57()
    • jj_3R_56

      private boolean jj_3R_56()
    • jj_3R_55

      private boolean jj_3R_55()
    • jj_3R_54

      private boolean jj_3R_54()
    • jj_3R_53

      private boolean jj_3R_53()
    • jj_3R_52

      private boolean jj_3R_52()
    • jj_3R_51

      private boolean jj_3R_51()
    • jj_3R_29

      private boolean jj_3R_29()
    • jj_3R_100

      private boolean jj_3R_100()
    • jj_3R_96

      private boolean jj_3R_96()
    • jj_3R_95

      private boolean jj_3R_95()
    • jj_3R_94

      private boolean jj_3R_94()
    • jj_3R_93

      private boolean jj_3R_93()
    • jj_3R_92

      private boolean jj_3R_92()
    • jj_3R_99

      private boolean jj_3R_99()
    • jj_3_2

      private boolean jj_3_2()
    • jj_3R_76

      private boolean jj_3R_76()
    • jj_3R_101

      private boolean jj_3R_101()
    • jj_3R_91

      private boolean jj_3R_91()
    • jj_3R_98

      private boolean jj_3R_98()
    • jj_3R_75

      private boolean jj_3R_75()
    • jj_3R_78

      private boolean jj_3R_78()
    • jj_3R_66

      private boolean jj_3R_66()
    • jj_3R_26

      private boolean jj_3R_26()
    • jj_3R_69

      private boolean jj_3R_69()
    • jj_3R_77

      private boolean jj_3R_77()
    • jj_3_5

      private boolean jj_3_5()
    • jj_3R_25

      private boolean jj_3R_25()
    • jj_3R_68

      private boolean jj_3R_68()
    • jj_3_1

      private boolean jj_3_1()
    • jj_3R_50

      private boolean jj_3R_50()
    • jj_3R_90

      private boolean jj_3R_90()
    • jj_3R_49

      private boolean jj_3R_49()
    • jj_3_3

      private boolean jj_3_3()
    • jj_3R_48

      private boolean jj_3R_48()
    • jj_3R_89

      private boolean jj_3R_89()
    • jj_3R_47

      private boolean jj_3R_47()
    • jj_3R_46

      private boolean jj_3R_46()
    • jj_3R_45

      private boolean jj_3R_45()
    • jj_3R_34

      private boolean jj_3R_34()
    • jj_3R_37

      private boolean jj_3R_37()
    • jj_3R_32

      private boolean jj_3R_32()
    • jj_3R_44

      private boolean jj_3R_44()
    • jj_3R_27

      private boolean jj_3R_27()
    • jj_3R_43

      private boolean jj_3R_43()
    • jj_3R_42

      private boolean jj_3R_42()
    • jj_3R_36

      private boolean jj_3R_36()
    • jj_3R_41

      private boolean jj_3R_41()
    • jj_3R_28

      private boolean jj_3R_28()
    • jj_3_10

      private boolean jj_3_10()
    • jj_3R_64

      private boolean jj_3R_64()
    • jj_3R_31

      private boolean jj_3R_31()
    • jj_3_8

      private boolean jj_3_8()
    • jj_3R_74

      private boolean jj_3R_74()
    • jj_3R_60

      private boolean jj_3R_60()
    • jj_3R_97

      private boolean jj_3R_97()
    • jj_3R_71

      private boolean jj_3R_71()
    • jj_3_4

      private boolean jj_3_4()
    • jj_3R_63

      private boolean jj_3R_63()
    • jj_3R_30

      private boolean jj_3R_30()
    • jj_3R_70

      private boolean jj_3R_70()
    • jj_3_9

      private boolean jj_3_9()
    • jj_3_12

      private boolean jj_3_12()
    • jj_3R_65

      private boolean jj_3R_65()
    • jj_la1_init_0

      private static void jj_la1_init_0()
    • jj_la1_init_1

      private static void jj_la1_init_1()
    • jj_la1_init_2

      private static void jj_la1_init_2()
    • ReInit

      public void ReInit(CharStream stream)
      Reinitialise.
    • ReInit

      public void ReInit(ParserTokenManager tm)
      Reinitialise.
    • jj_consume_token

      private Token jj_consume_token(int kind) throws ParseException
      Throws:
      ParseException
    • jj_scan_token

      private boolean jj_scan_token(int kind)
    • getNextToken

      public final Token getNextToken()
      Get the next Token.
    • getToken

      public final Token getToken(int index)
      Get the specific Token.
    • jj_ntk

      private int jj_ntk()
    • jj_add_error_token

      private void jj_add_error_token(int kind, int pos)
    • generateParseException

      public ParseException generateParseException()
      Generate ParseException.
    • enable_tracing

      public final void enable_tracing()
      Enable tracing.
    • disable_tracing

      public final void disable_tracing()
      Disable tracing.
    • jj_rescan_token

      private void jj_rescan_token()
    • jj_save

      private void jj_save(int index, int xla)