Top Description Inners Fields Constructors Methods
org.antlr.grammar.v3

public Class CodeGenTreeWalker

extends TreeParser
Class Inheritance
Annotations
@SuppressWarnings:all
Imports
org.antlr.analysis.*, org.antlr.misc.*, org.antlr.tool.*, org.antlr.codegen.*, java.util.HashSet, .Set, .Collection, .Stack, .List, .ArrayList, .Map, .HashMap, org.antlr.runtime.BitSet, .DFA, org.antlr.runtime.*, org.stringtemplate.v4.ST, .STGroup, org.antlr.runtime.tree.*
Walk a grammar and generate code by gradually building up a bigger and bigger ST. Terence Parr University of San Francisco June 15, 2004

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
CodeGenTreeWalker.alternative_return

public static class
CodeGenTreeWalker.atom_return

public static class
CodeGenTreeWalker.block_return

public static class
CodeGenTreeWalker.ebnf_return

public static class
CodeGenTreeWalker.element_action_return

public static class
CodeGenTreeWalker.element_return

public static class
CodeGenTreeWalker.modifier_return

public static class
CodeGenTreeWalker.rewrite_atom_return

public static class
CodeGenTreeWalker.rewrite_ebnf_return

public static class
CodeGenTreeWalker.rewrite_element_return

public static class
CodeGenTreeWalker.rewrite_return

public static class
CodeGenTreeWalker.rewrite_tree_return

public static class
CodeGenTreeWalker.rule_return

public static class
CodeGenTreeWalker.setBlock_return

public static class
CodeGenTreeWalker.tree__return

Field Summary

Modifier and TypeField and Description
public static final int
ACTION

public static final int
ACTION_CHAR_LITERAL

public static final int
ACTION_ESC

public static final int
ACTION_STRING_LITERAL

public static final int
ALT

public static final int
AMPERSAND

public static final int
ARG

public static final int
ARG_ACTION

public static final int
ARGLIST

public static final int
ASSIGN

public static final int
BACKTRACK_SEMPRED

public static final int
BANG

public static final int
BLOCK

protected int
blockNestingLevel

public static final int
CATCH

public static final int
CHAR_LITERAL

public static final int
CHAR_RANGE

public static final int
CLOSE_ELEMENT_OPTION

public static final int
CLOSURE

public static final int
COLON

public static final int
COMBINED_GRAMMAR

public static final int
COMMA

public static final int
COMMENT

protected boolean
currentAltHasASTRewrite

protected ST
currentBlockST

private String
currentRuleName

public static final int
DIGIT

public static final int
DOC_COMMENT

public static final int
DOLLAR

public static final int
DOT

public static final int
DOUBLE_ANGLE_STRING_LITERAL

public static final int
DOUBLE_QUOTE_STRING_LITERAL

public static final int
EOA

public static final int
EOB

public static final int
EOF

public static final int
EOR

public static final int
EPSILON

public static final int
ESC

public static final int
ETC

public static final int
FINALLY

public static final BitSet
FOLLOW_ACTION_in_attrScope140

public static final BitSet
FOLLOW_ACTION_in_element_action1134

public static final BitSet
FOLLOW_ACTION_in_exceptionHandler770

public static final BitSet
FOLLOW_ACTION_in_finallyClause790

public static final BitSet
FOLLOW_ACTION_in_rewrite_atom2176

public static final BitSet
FOLLOW_ACTION_in_rewrite_template2223

public static final BitSet
FOLLOW_ACTION_in_rewrite_template2254

public static final BitSet
FOLLOW_ACTION_in_rewrite_template2324

public static final BitSet
FOLLOW_ACTION_in_ruleScopeSpec558

public static final BitSet
FOLLOW_ALT_in_alternative820

public static final BitSet
FOLLOW_ALT_in_rewrite_alternative1823

public static final BitSet
FOLLOW_ALT_in_rewrite_template2199

public static final BitSet
FOLLOW_ALT_in_setAlternative717

public static final BitSet
FOLLOW_alternative_in_block643

public static final BitSet
FOLLOW_AMPERSAND_in_attrScope131

public static final BitSet
FOLLOW_AMPERSAND_in_grammarSpec235

public static final BitSet
FOLLOW_AMPERSAND_in_rule441

public static final BitSet
FOLLOW_AMPERSAND_in_ruleScopeSpec548

public static final BitSet
FOLLOW_ARG_ACTION_in_atom1493

public static final BitSet
FOLLOW_ARG_ACTION_in_atom1516

public static final BitSet
FOLLOW_ARG_ACTION_in_exceptionHandler768

public static final BitSet
FOLLOW_ARG_ACTION_in_rewrite_atom2133

public static final BitSet
FOLLOW_ARG_ACTION_in_rule387

public static final BitSet
FOLLOW_ARG_ACTION_in_rule399

public static final BitSet
FOLLOW_ARG_in_rewrite_template2246

public static final BitSet
FOLLOW_ARG_in_rule384

public static final BitSet
FOLLOW_ARGLIST_in_rewrite_template2236

public static final BitSet
FOLLOW_ASSIGN_in_element942

public static final BitSet
FOLLOW_atom_in_atom1573

public static final BitSet
FOLLOW_atom_in_element1035

public static final BitSet
FOLLOW_attrScope_in_grammarSpec226

public static final BitSet
FOLLOW_BACKTRACK_SEMPRED_in_element1105

public static final BitSet
FOLLOW_BANG_in_element903

public static final BitSet
FOLLOW_BLOCK_in_block618

public static final BitSet
FOLLOW_block_in_ebnf1261

public static final BitSet
FOLLOW_block_in_ebnf1284

public static final BitSet
FOLLOW_block_in_ebnf1309

public static final BitSet
FOLLOW_block_in_ebnf1334

public static final BitSet
FOLLOW_BLOCK_in_notElement1214

public static final BitSet
FOLLOW_BLOCK_in_rewrite_block1771

public static final BitSet
FOLLOW_block_in_rule455

public static final BitSet
FOLLOW_BLOCK_in_set1631

public static final BitSet
FOLLOW_BLOCK_in_setBlock697

public static final BitSet
FOLLOW_CATCH_in_exceptionHandler766

public static final BitSet
FOLLOW_CHAR_LITERAL_in_atom1532

public static final BitSet
FOLLOW_CHAR_LITERAL_in_element991

public static final BitSet
FOLLOW_CHAR_LITERAL_in_element995

public static final BitSet
FOLLOW_CHAR_LITERAL_in_notElement1174

public static final BitSet
FOLLOW_CHAR_LITERAL_in_rewrite_atom2144

public static final BitSet
FOLLOW_CHAR_LITERAL_in_setElement1651

public static final BitSet
FOLLOW_CHAR_LITERAL_in_setElement1669

public static final BitSet
FOLLOW_CHAR_LITERAL_in_setElement1671

public static final BitSet
FOLLOW_CHAR_RANGE_in_element987

public static final BitSet
FOLLOW_CHAR_RANGE_in_setElement1667

public static final BitSet
FOLLOW_CLOSURE_in_ebnf1305

public static final BitSet
FOLLOW_CLOSURE_in_rewrite_ebnf1984

public static final BitSet
FOLLOW_COMBINED_GRAMMAR_in_grammar_103

public static final BitSet
FOLLOW_DOC_COMMENT_in_grammarSpec165

public static final BitSet
FOLLOW_DOT_in_atom1567

public static final BitSet
FOLLOW_DOUBLE_ANGLE_STRING_LITERAL_in_rewrite_template2300

public static final BitSet
FOLLOW_DOUBLE_QUOTE_STRING_LITERAL_in_rewrite_template2287

public static final BitSet
FOLLOW_ebnf_in_element1024

public static final BitSet
FOLLOW_element_action_in_element1056

public static final BitSet
FOLLOW_element_action_in_synpred2_CodeGenTreeWalker1405

public static final BitSet
FOLLOW_element_action_in_tree_1416

public static final BitSet
FOLLOW_element_in_alternative833

public static final BitSet
FOLLOW_element_in_element890

public static final BitSet
FOLLOW_element_in_element907

public static final BitSet
FOLLOW_element_in_element950

public static final BitSet
FOLLOW_element_in_element973

public static final BitSet
FOLLOW_element_in_tree_1379

public static final BitSet
FOLLOW_element_in_tree_1438

public static final BitSet
FOLLOW_EOA_in_alternative851

public static final BitSet
FOLLOW_EOA_in_rewrite_alternative1878

public static final BitSet
FOLLOW_EOA_in_rewrite_template2203

public static final BitSet
FOLLOW_EOA_in_setAlternative722

public static final BitSet
FOLLOW_EOB_in_block665

public static final BitSet
FOLLOW_EOB_in_rewrite_block1788

public static final BitSet
FOLLOW_EOR_in_rule476

public static final BitSet
FOLLOW_EPSILON_in_element1117

public static final BitSet
FOLLOW_EPSILON_in_rewrite_alternative1862

public static final BitSet
FOLLOW_EPSILON_in_rewrite_template2201

public static final BitSet
FOLLOW_ETC_in_rewrite_alternative1904

public static final BitSet
FOLLOW_exceptionGroup_in_rule468

public static final BitSet
FOLLOW_exceptionHandler_in_exceptionGroup737

public static final BitSet
FOLLOW_FINALLY_in_finallyClause788

public static final BitSet
FOLLOW_finallyClause_in_exceptionGroup744

public static final BitSet
FOLLOW_finallyClause_in_exceptionGroup752

public static final BitSet
FOLLOW_FORCED_ACTION_in_element_action1145

public static final BitSet
FOLLOW_GATED_SEMPRED_in_element1075

public static final BitSet
FOLLOW_grammarSpec_in_grammar_105

public static final BitSet
FOLLOW_grammarSpec_in_grammar_69

public static final BitSet
FOLLOW_grammarSpec_in_grammar_81

public static final BitSet
FOLLOW_grammarSpec_in_grammar_93

public static final BitSet
FOLLOW_ID_in_atom1569

public static final BitSet
FOLLOW_ID_in_attrScope126

public static final BitSet
FOLLOW_ID_in_element946

public static final BitSet
FOLLOW_ID_in_element969

public static final BitSet
FOLLOW_ID_in_grammarSpec157

public static final BitSet
FOLLOW_ID_in_rewrite_template2219

public static final BitSet
FOLLOW_ID_in_rewrite_template2250

public static final BitSet
FOLLOW_ID_in_rule363

public static final BitSet
FOLLOW_ID_in_ruleScopeSpec564

public static final BitSet
FOLLOW_ID_in_throwsSpec528

public static final BitSet
FOLLOW_IMPORT_in_grammarSpec200

public static final BitSet
FOLLOW_LABEL_in_rewrite_atom2166

public static final BitSet
FOLLOW_LEXER_GRAMMAR_in_grammar_67

public static final BitSet
FOLLOW_modifier_in_rule376

public static final BitSet
FOLLOW_NOT_in_element923

public static final BitSet
FOLLOW_notElement_in_element927

public static final BitSet
FOLLOW_OPTIONAL_in_ebnf1280

public static final BitSet
FOLLOW_OPTIONAL_in_rewrite_ebnf1964

public static final BitSet
FOLLOW_OPTIONS_in_block626

public static final BitSet
FOLLOW_OPTIONS_in_grammarSpec186

public static final BitSet
FOLLOW_OPTIONS_in_rule418

public static final BitSet
FOLLOW_PARSER_GRAMMAR_in_grammar_79

public static final BitSet
FOLLOW_PLUS_ASSIGN_in_element965

public static final BitSet
FOLLOW_POSITIVE_CLOSURE_in_ebnf1330

public static final BitSet
FOLLOW_POSITIVE_CLOSURE_in_rewrite_ebnf2004

public static final BitSet
FOLLOW_PREC_RULE_in_rules317

public static final BitSet
FOLLOW_RET_in_rule396

public static final BitSet
FOLLOW_rewrite_alternative_in_rewrite1728

public static final BitSet
FOLLOW_rewrite_alternative_in_rewrite_block1783

public static final BitSet
FOLLOW_rewrite_atom_in_rewrite_element1924

public static final BitSet
FOLLOW_rewrite_atom_in_rewrite_tree2046

public static final BitSet
FOLLOW_rewrite_block_in_rewrite_ebnf1966

public static final BitSet
FOLLOW_rewrite_block_in_rewrite_ebnf1986

public static final BitSet
FOLLOW_rewrite_block_in_rewrite_ebnf2006

public static final BitSet
FOLLOW_rewrite_ebnf_in_rewrite_element1934

public static final BitSet
FOLLOW_rewrite_element_in_rewrite_alternative1841

public static final BitSet
FOLLOW_rewrite_element_in_rewrite_tree2066

public static final BitSet
FOLLOW_rewrite_in_block648

public static final BitSet
FOLLOW_REWRITE_in_rewrite1717

public static final BitSet
FOLLOW_rewrite_template_in_rewrite_alternative1891

public static final BitSet
FOLLOW_rewrite_tree_in_rewrite_element1943

public static final BitSet
FOLLOW_REWRITES_in_rewrite1696

public static final BitSet
FOLLOW_ROOT_in_element886

public static final BitSet
FOLLOW_RULE_in_rule359

public static final BitSet
FOLLOW_rule_in_rules291

public static final BitSet
FOLLOW_RULE_in_rules305

public static final BitSet
FOLLOW_RULE_REF_in_atom1488

public static final BitSet
FOLLOW_RULE_REF_in_rewrite_atom2111

public static final BitSet
FOLLOW_rules_in_grammarSpec246

public static final BitSet
FOLLOW_ruleScopeSpec_in_rule431

public static final BitSet
FOLLOW_SCOPE_in_attrScope124

public static final BitSet
FOLLOW_SCOPE_in_ruleScopeSpec543

public static final BitSet
FOLLOW_SEMPRED_in_element1071

public static final BitSet
FOLLOW_SEMPRED_in_rewrite1722

public static final BitSet
FOLLOW_set_in_atom1586

public static final BitSet
FOLLOW_set_in_synpred1_CodeGenTreeWalker1009

public static final BitSet
FOLLOW_setBlock_in_block605

public static final BitSet
FOLLOW_setElement_in_setAlternative719

public static final BitSet
FOLLOW_STRING_LITERAL_in_atom1544

public static final BitSet
FOLLOW_STRING_LITERAL_in_notElement1187

public static final BitSet
FOLLOW_STRING_LITERAL_in_rewrite_atom2152

public static final BitSet
FOLLOW_STRING_LITERAL_in_setElement1661

public static final BitSet
FOLLOW_SYN_SEMPRED_in_element1086

public static final BitSet
FOLLOW_SYNPRED_in_element1094

public static final BitSet
FOLLOW_TEMPLATE_in_rewrite_template2214

public static final BitSet
FOLLOW_THROWS_in_throwsSpec526

public static final BitSet
FOLLOW_throwsSpec_in_rule408

public static final BitSet
FOLLOW_TOKEN_REF_in_atom1511

public static final BitSet
FOLLOW_TOKEN_REF_in_notElement1200

public static final BitSet
FOLLOW_TOKEN_REF_in_rewrite_atom2128

public static final BitSet
FOLLOW_TOKEN_REF_in_setElement1656

public static final BitSet
FOLLOW_TOKENS_in_grammarSpec214

public static final BitSet
FOLLOW_tree__in_element1046

public static final BitSet
FOLLOW_TREE_BEGIN_in_rewrite_tree2039

public static final BitSet
FOLLOW_TREE_BEGIN_in_tree_1372

public static final BitSet
FOLLOW_TREE_GRAMMAR_in_grammar_91

public static final BitSet
FOLLOW_WILDCARD_in_atom1556

public static final int
FORCED_ACTION

public static final int
FRAGMENT

public static final int
GATED_SEMPRED

protected CodeGenerator
generator

public static final int
GRAMMAR

protected Grammar
grammar

protected ST
headerFileST

public static final int
ID

public static final int
IMPLIES

public static final int
IMPORT

public static final int
INITACTION

public static final int
INT

public static final int
LABEL

public static final int
LEXER

public static final int
LEXER_GRAMMAR

public static final int
LPAREN

public static final int
ML_COMMENT

public static final int
NESTED_ACTION

public static final int
NESTED_ARG_ACTION

public static final int
NOT

public static final int
OPEN_ELEMENT_OPTION

public static final int
OPTIONAL

public static final int
OPTIONS

public static final int
OR

protected static final int
OUTER_REWRITE_NESTING_LEVEL

private int
outerAltNum

protected ST
outputFileST

protected String
outputOption

public static final int
PARSER

public static final int
PARSER_GRAMMAR

public static final int
PLUS

public static final int
PLUS_ASSIGN

public static final int
POSITIVE_CLOSURE

public static final int
PREC_RULE

public static final int
PRIVATE

public static final int
PROTECTED

public static final int
PUBLIC

public static final int
QUESTION

public static final int
RANGE

public static final int
RCURLY

protected ST
recognizerST

The overall lexer/parser template; simulate dynamically scoped attributes by making this an instance var of the walker.

public static final int
RECURSIVE_RULE_REF

public static final int
RET

public static final int
RETURNS

public static final int
REWRITE

protected int
rewriteBlockNestingLevel

protected HashSet<Object>
rewriteRuleRefs

public static final int
REWRITES

protected int
rewriteTreeNestingLevel

public static final int
ROOT

public static final int
RPAREN

public static final int
RULE

protected static final int
RULE_BLOCK_NESTING_LEVEL

public static final int
RULE_REF

public static final int
SCOPE

public static final int
SEMI

public static final int
SEMPRED

public static final int
SL_COMMENT

public static final int
SRC

public static final int
STAR

public static final int
STRAY_BRACKET

public static final int
STRING_LITERAL

public static final int
SYN_SEMPRED

public static final int
SYNPRED

public static final int
TEMPLATE

protected STGroup
templates

public static final int
THROWS

public static final int
TOKEN_REF

public static final String[]
tokenNames

public static final int
TOKENS

public static final int
TREE

public static final int
TREE_BEGIN

public static final int
TREE_GRAMMAR

public static final int
WILDCARD

public static final int
WS

public static final int
WS_LOOP

public static final int
WS_OPT

public static final int
XDIGIT

Inherited from org.antlr.runtime.tree.TreeParser:
DOWNinputUP

Constructor Summary

AccessConstructor and Description
public
CodeGenTreeWalker(TreeNodeStream input)

public
CodeGenTreeWalker(TreeNodeStream input, RecognizerSharedState state)

Method Summary

Modifier and TypeMethod and Description
public final CodeGenTreeWalker.alternative_return
alternative(GrammarAST label)

public final void
ast_suffix()

public final CodeGenTreeWalker.atom_return
atom(GrammarAST scope, GrammarAST label, GrammarAST astSuffix)

public final void
attrScope()

public final CodeGenTreeWalker.block_return
block(String blockTemplateName, DFA dfa, GrammarAST label)

public final CodeGenTreeWalker.ebnf_return
ebnf(GrammarAST label)

public final CodeGenTreeWalker.element_return
element(GrammarAST label, GrammarAST astSuffix)

public final CodeGenTreeWalker.element_action_return
element_action()

public final void
exceptionGroup(ST ruleST)

public final void
exceptionHandler(ST ruleST)

public final void
finallyClause(ST ruleST)

public String
getCurrentRuleName()

public TreeParser[]
getDelegates()

public String
getGrammarFileName()

Overrides org.antlr.runtime.BaseRecognizer.getGrammarFileName.

For debugging and other purposes, might want the grammar name.
public int
getOuterAltNum()

protected final ST
getRuleElementST(String name, String ruleTargetName, GrammarAST elementAST, GrammarAST ast_suffix, String label)

protected final String
getSTSuffix(GrammarAST elementAST, GrammarAST ast_suffix, String label)

Return a non-empty template name suffix if the token is to be tracked, added to a tree, or both.

protected final ST
getTokenElementST(String name, String elementName, GrammarAST elementAST, GrammarAST ast_suffix, String label)

public String[]
getTokenNames()

Overrides org.antlr.runtime.BaseRecognizer.getTokenNames.

Used to print out token names like ID during debugging and error reporting.
protected final List<String>
getTokenTypesAsTargetLabels(Collection<GrammarAST> refs)

Convert rewrite AST lists to target labels list

protected final ST
getWildcardST(GrammarAST elementAST, GrammarAST ast_suffix, String label)

public final void
grammar_(Grammar g, ST recognizerST, ST outputFileST, ST headerFileST)

public final void
grammarSpec()

public final void
init(Grammar g)

public final boolean
isListLabel(String label)

public final CodeGenTreeWalker.modifier_return
modifier()

public final ST
notElement(GrammarAST n, GrammarAST label, GrammarAST astSuffix)

public void
reportError(RecognitionException ex)

Overrides org.antlr.runtime.BaseRecognizer.reportError.

Report a recognition problem.
public final void
reportError(String s)

public final CodeGenTreeWalker.rewrite_return
rewrite()

public final ST
rewrite_alternative()

public final CodeGenTreeWalker.rewrite_atom_return
rewrite_atom(boolean isRoot)

public final ST
rewrite_block(String blockTemplateName)

public final CodeGenTreeWalker.rewrite_ebnf_return
rewrite_ebnf()

public final CodeGenTreeWalker.rewrite_element_return
rewrite_element()

public final ST
rewrite_template()

public final CodeGenTreeWalker.rewrite_tree_return
rewrite_tree()

public final CodeGenTreeWalker.rule_return
rule()

public final void
rules(ST recognizerST)

public final void
ruleScopeSpec()

public final ST
set(GrammarAST label, GrammarAST astSuffix)

public final void
setAlternative()

public final CodeGenTreeWalker.setBlock_return
setBlock()

public void
setCurrentRuleName(String value)

public final void
setElement()

public void
setOuterAltNum(int value)

public final boolean
synpred1_CodeGenTreeWalker()

public final void
synpred1_CodeGenTreeWalker_fragment()

public final boolean
synpred2_CodeGenTreeWalker()

public final void
synpred2_CodeGenTreeWalker_fragment()

public final void
throwsSpec()

public final CodeGenTreeWalker.tree__return
tree_()

Inherited from org.antlr.runtime.tree.TreeParser:
getAncestorgetCurrentInputSymbolgetErrorHeadergetErrorMessagegetMissingSymbolgetSourceNamegetTreeNodeStreaminContextinContextmatchAnyrecoverFromMismatchedTokenresetsetTreeNodeStreamtraceIntraceOut