ANTLRv3 grammar definition

Index

1. grammarDef
2. tokensSpec
3. tokenSpec
4. attrScope
5. action
6. actionScopeName
7. optionsSpec
8. option
9. optionValue
10. rule
11. ruleAction
12. throwsSpec
13. ruleScopeSpec
14. block
15. altpair
16. altList
17. alternative
18. exceptionGroup
19. exceptionGroup2
20. exceptionHandler
21. finallyClause
22. element
23. elementNoOptionSpecK
24. elementNoOptionSpec
25. atom
26. notSet
27. treeSpec
28. ebnf
29. range
30. terminal
31. notTerminal
32. ebnfSuffix
33. rewrite
34. rewrite_alternative
35. rewrite_tree_block
36. rewrite_tree_alternative
37. rewrite_tree_element
38. rewrite_tree_atom
39. rewrite_tree_ebnf
40. rewrite_tree
41. rewrite_template
42. rewrite_template_ref
43. rewrite_indirect_template_head
44. rewrite_template_args
45. rewrite_template_arg
46. id
47. SL_COMMENT
48. ML_COMMENT
49. CHAR_LITERAL
50. STRING_LITERAL
51. LITERAL_CHAR
52. DOUBLE_QUOTE_STRING_LITERAL
53. DOUBLE_ANGLE_STRING_LITERAL
54. ESC
55. XDIGIT
56. INT
57. ARG_ACTION
58. NESTED_ARG_ACTION
59. ACTION
60. NESTED_ACTION
61. ACTION_CHAR_LITERAL
62. ACTION_STRING_LITERAL
63. ACTION_ESC
64. TOKEN_REF
65. RULE_REF
66. OPTIONS
67. TOKENS
68. SRC
69. WS
70. WS_LOOP

• grammarDef Top

  EBNF notation:

  grammarDef ::= DOC_COMMENT? ('lexer' | 'parser' | 'tree' | ) 'grammar' id ';' optionsSpec? tokensSpec? attrScope* action* rule+ EOF

  Railroad notation:

  

• tokensSpec Top

  EBNF notation:

  tokensSpec ::= TOKENS tokenSpec+ '}'

  Railroad notation:

  

• tokenSpec Top

  EBNF notation:

  tokenSpec ::= TOKEN_REF ('=' (STRING_LITERAL | CHAR_LITERAL ) | ) ';'

  Railroad notation:

  

• attrScope Top

  EBNF notation:

  attrScope ::= 'scope' id ACTION

  Railroad notation:

  

• action Top

  Description:

  Match stuff like @parser::members {int i;}

  EBNF notation:

  action ::= '@' (actionScopeName '::' )? id ACTION

  Railroad notation:

  

• actionScopeName Top

  Description:

  Sometimes the scope names will collide with keywords; allow them as * ids for action scopes.

  EBNF notation:

  actionScopeName ::= id | 'lexer' | 'parser'

  Railroad notation:

  

• optionsSpec Top

  EBNF notation:

  optionsSpec ::= OPTIONS (option ';' )+ '}'

  Railroad notation:

  

• option Top

  EBNF notation:

  option ::= id '=' optionValue

  Railroad notation:

  

• optionValue Top

  EBNF notation:

  optionValue ::= id | STRING_LITERAL | CHAR_LITERAL | INT | '*'

  Railroad notation:

  

• rule Top

  EBNF notation:

  rule ::= DOC_COMMENT? (('protected' | 'public' | 'private' | 'fragment' ) )? id '!'? (ARG_ACTION )? ('returns' ARG_ACTION )? throwsSpec? optionsSpec? ruleScopeSpec? ruleAction* ':' altList ';' exceptionGroup?

  Railroad notation:

  

• ruleAction Top

  Description:

  Match stuff like @init {int i;}

  EBNF notation:

  ruleAction ::= '@' id ACTION

  Railroad notation:

  

• throwsSpec Top

  EBNF notation:

  throwsSpec ::= 'throws' id (',' id )*

  Railroad notation:

  

• ruleScopeSpec Top

  EBNF notation:

  ruleScopeSpec ::= 'scope' ACTION | 'scope' id (',' id )* ';' | 'scope' ACTION 'scope' id (',' id )* ';'

  Railroad notation:

  

• block Top

  EBNF notation:

  block ::= '(' ((optionsSpec )? ':' )? altpair ('|' altpair )* ')'

  Railroad notation:

  

• altpair Top

  EBNF notation:

  altpair ::= alternative rewrite

  Railroad notation:

  

• altList Top

  EBNF notation:

  altList ::= altpair ('|' altpair )*

  Railroad notation:

  

• alternative Top

  EBNF notation:

  alternative ::= element+ |

  Railroad notation:

  

• exceptionGroup Top

  EBNF notation:

  exceptionGroup ::= (exceptionHandler )+ (finallyClause )? | finallyClause

  Railroad notation:

  

• exceptionGroup2 Top

  EBNF notation:

  exceptionGroup2 ::= (exceptionHandler )+ finallyClause | finallyClause

  Railroad notation:

  

• exceptionHandler Top

  EBNF notation:

  exceptionHandler ::= 'catch' ARG_ACTION ACTION

  Railroad notation:

  

• finallyClause Top

  EBNF notation:

  finallyClause ::= 'finally' ACTION

  Railroad notation:

  

• element Top

  EBNF notation:

  element ::= elementNoOptionSpec

  Railroad notation:

  

• elementNoOptionSpecK Top

  EBNF notation:

  elementNoOptionSpecK ::= id ('=' | '+=' ) atom (ebnfSuffix | 'l' ) | id ('=' | '+=' ) block (ebnfSuffix | 'p' )

  Railroad notation:

  

• elementNoOptionSpec Top

  EBNF notation:

  elementNoOptionSpec ::= id ('=' | '+=' ) atom (ebnfSuffix | ) | id ('=' | '+=' ) block (ebnfSuffix | ) | atom (ebnfSuffix | ) | ebnf | ACTION | SEMPRED ('=>' | ) | treeSpec (ebnfSuffix | )

  Railroad notation:

  

• atom Top

  EBNF notation:

  atom ::= range (('^' | '!' ) | ) | terminal | notSet (('^' | '!' ) | ) | RULE_REF (ARG_ACTION )? (('^' | '!' ) )?

  Railroad notation:

  

• notSet Top

  EBNF notation:

  notSet ::= '~' (notTerminal | block )

  Railroad notation:

  

• treeSpec Top

  EBNF notation:

  treeSpec ::= '^(' element (element )+ ')'

  Railroad notation:

  

• ebnf Top

  Description:

  Matches ENBF blocks (and token sets via block rule)

  EBNF notation:

  ebnf ::= block ('?' | '*' | '+' | '=>' | )

  Railroad notation:

  

• range Top

  EBNF notation:

  range ::= CHAR_LITERAL RANGE CHAR_LITERAL

  Railroad notation:

  

• terminal Top

  EBNF notation:

  terminal ::= (CHAR_LITERAL | TOKEN_REF (ARG_ACTION | ) | STRING_LITERAL | '.' ) ('^' | '!' )?

  Railroad notation:

  

• notTerminal Top

  EBNF notation:

  notTerminal ::= CHAR_LITERAL | TOKEN_REF | STRING_LITERAL

  Railroad notation:

  

• ebnfSuffix Top

  EBNF notation:

  ebnfSuffix ::= '?' | '*' | '+'

  Railroad notation:

  

• rewrite Top

  EBNF notation:

  rewrite ::= ('->' SEMPRED rewrite_alternative )* '->' rewrite_alternative |

  Railroad notation:

  

• rewrite_alternative Top

  EBNF notation:

  rewrite_alternative ::= rewrite_template | rewrite_tree_alternative |

  Railroad notation:

  

• rewrite_tree_block Top

  EBNF notation:

  rewrite_tree_block ::= '(' rewrite_tree_alternative ')'

  Railroad notation:

  

• rewrite_tree_alternative Top

  EBNF notation:

  rewrite_tree_alternative ::= rewrite_tree_element+

  Railroad notation:

  

• rewrite_tree_element Top

  EBNF notation:

  rewrite_tree_element ::= rewrite_tree_atom | rewrite_tree_atom ebnfSuffix | rewrite_tree (ebnfSuffix | ) | rewrite_tree_ebnf

  Railroad notation:

  

• rewrite_tree_atom Top

  EBNF notation:

  rewrite_tree_atom ::= CHAR_LITERAL | TOKEN_REF ARG_ACTION? | RULE_REF | STRING_LITERAL | '$' id | ACTION

  Railroad notation:

  

• rewrite_tree_ebnf Top

  EBNF notation:

  rewrite_tree_ebnf ::= rewrite_tree_block ebnfSuffix

  Railroad notation:

  

• rewrite_tree Top

  EBNF notation:

  rewrite_tree ::= '^(' rewrite_tree_atom rewrite_tree_element* ')'

  Railroad notation:

  

• rewrite_template Top

  Description:

  Build a tree for a template rewrite: ^(TEMPLATE (ID|ACTION) ^(ARGLIST ^(ARG ID ACTION) ...) ) where ARGLIST is always there even if no args exist. ID can be "template" keyword. If first child is ACTION then it's an indirect template ref -> foo(a={...}, b={...}) -> ({string-e})(a={...}, b={...}) // e evaluates to template name -> {%{$ID.text}} // create literal template from string (done in ActionTranslator) -> {st-expr} // st-expr evaluates to ST

  EBNF notation:

  rewrite_template ::= id '(' rewrite_template_args ')' (DOUBLE_QUOTE_STRING_LITERAL | DOUBLE_ANGLE_STRING_LITERAL ) | rewrite_template_ref | rewrite_indirect_template_head | ACTION

  Railroad notation:

  

• rewrite_template_ref Top

  Description:

  -> foo(a={...}, ...)

  EBNF notation:

  rewrite_template_ref ::= id '(' rewrite_template_args ')'

  Railroad notation:

  

• rewrite_indirect_template_head Top

  Description:

  -> ({expr})(a={...}, ...)

  EBNF notation:

  rewrite_indirect_template_head ::= '(' ACTION ')' '(' rewrite_template_args ')'

  Railroad notation:

  

• rewrite_template_args Top

  EBNF notation:

  rewrite_template_args ::= rewrite_template_arg (',' rewrite_template_arg )* |

  Railroad notation:

  

• rewrite_template_arg Top

  EBNF notation:

  rewrite_template_arg ::= id '=' ACTION

  Railroad notation:

  

• id Top

  EBNF notation:

  id ::= TOKEN_REF | RULE_REF

  Railroad notation:

  

• SL_COMMENT Top

  EBNF notation:

  SL_COMMENT ::= '//' (' $ANTLR ' SRC | '~'('\r' | '\n' ) ) '\r'? '\n'

  Railroad notation:

  

• ML_COMMENT Top

  EBNF notation:

  ML_COMMENT ::= '/*' '.'* '*/'

  Railroad notation:

  

• CHAR_LITERAL Top

  EBNF notation:

  CHAR_LITERAL ::= '\'' LITERAL_CHAR '\''

  Railroad notation:

  

• STRING_LITERAL Top

  EBNF notation:

  STRING_LITERAL ::= '\'' LITERAL_CHAR LITERAL_CHAR* '\''

  Railroad notation:

  

• LITERAL_CHAR Top

  EBNF notation:

  LITERAL_CHAR ::= ESC | '~'('\'' | '\\' )

  Railroad notation:

  

• DOUBLE_QUOTE_STRING_LITERAL Top

  EBNF notation:

  DOUBLE_QUOTE_STRING_LITERAL ::= '"' (ESC | '~'('\\' | '"' ) )* '"'

  Railroad notation:

  

• DOUBLE_ANGLE_STRING_LITERAL Top

  EBNF notation:

  DOUBLE_ANGLE_STRING_LITERAL ::= '<<' '.'* '>>'

  Railroad notation:

  

• ESC Top

  EBNF notation:

  ESC ::= '\\' ('n' | 'r' | 't' | 'b' | 'f' | '"' | '\'' | '\\' | '>' | 'u' XDIGIT XDIGIT XDIGIT XDIGIT | '.' )

  Railroad notation:

  

• XDIGIT Top

  EBNF notation:

  XDIGIT ::= '0..9' | 'a..f' | 'A..F'

  Railroad notation:

  

• INT Top

  EBNF notation:

  INT ::= '0..9'+

  Railroad notation:

  

• ARG_ACTION Top

  EBNF notation:

  ARG_ACTION ::= NESTED_ARG_ACTION

  Railroad notation:

  

• NESTED_ARG_ACTION Top

  EBNF notation:

  NESTED_ARG_ACTION ::= '[' (NESTED_ARG_ACTION | ACTION_STRING_LITERAL | ACTION_CHAR_LITERAL | '.' )* ']'

  Railroad notation:

  

• ACTION Top

  EBNF notation:

  ACTION ::= NESTED_ACTION ('?' )?

  Railroad notation:

  

• NESTED_ACTION Top

  EBNF notation:

  NESTED_ACTION ::= '{' (NESTED_ACTION | SL_COMMENT | ML_COMMENT | ACTION_STRING_LITERAL | ACTION_CHAR_LITERAL | '.' )* '}'

  Railroad notation:

  

• ACTION_CHAR_LITERAL Top

  EBNF notation:

  ACTION_CHAR_LITERAL ::= '\'' (ACTION_ESC | '~'('\\' | '\'' ) ) '\''

  Railroad notation:

  

• ACTION_STRING_LITERAL Top

  EBNF notation:

  ACTION_STRING_LITERAL ::= '"' (ACTION_ESC | '~'('\\' | '"' ) )* '"'

  Railroad notation:

  

• ACTION_ESC Top

  EBNF notation:

  ACTION_ESC ::= '\\\'' | '\\' '"' | '\\' '~'('\'' | '"' )

  Railroad notation:

  

• TOKEN_REF Top

  EBNF notation:

  TOKEN_REF ::= 'A..Z' ('a..z' | 'A..Z' | '_' | '0..9' )*

  Railroad notation:

  

• RULE_REF Top

  EBNF notation:

  RULE_REF ::= 'a..z' ('a..z' | 'A..Z' | '_' | '0..9' )*

  Railroad notation:

  

• OPTIONS Top

  Description:

  Match the start of an options section. Don't allow normal * action processing on the {...} as it's not a action.

  EBNF notation:

  OPTIONS ::= 'options' WS_LOOP '{'

  Railroad notation:

  

• TOKENS Top

  EBNF notation:

  TOKENS ::= 'tokens' WS_LOOP '{'

  Railroad notation:

  

• SRC Top

  Description:

  Reset the file and line information; useful when the grammar * has been generated so that errors are shown relative to the * original file like the old C preprocessor used to do.

  EBNF notation:

  SRC ::= 'src' ' ' ACTION_STRING_LITERAL ' ' INT

  Railroad notation:

  

• WS Top

  EBNF notation:

  WS ::= (' ' | '\t' | '\r'? '\n' )+

  Railroad notation:

  

• WS_LOOP Top

  EBNF notation:

  WS_LOOP ::= (WS | SL_COMMENT | ML_COMMENT )*

  Railroad notation: