Top Description Fields Constructors Methods
org.antlr.runtime.debug

public Class ParseTreeBuilder

extends BlankDebugEventListener
Class Inheritance
Imports
org.antlr.runtime.RecognitionException, .Token, org.antlr.runtime.tree.ParseTree, java.util.Stack, .ArrayList, .List

This parser listener tracks rule entry/exit and token matches to build a simple parse tree using ParseTree nodes.

Field Summary

Modifier and TypeField and Description
pack-priv int
pack-priv Stack<ParseTree>
public static final String
pack-priv List<Token>

Constructor Summary

AccessConstructor and Description
public
ParseTreeBuilder(String grammarName)

Method Summary

Modifier and TypeMethod and Description
public void
public void
consumeToken(Token token)

Overrides org.antlr.runtime.debug.BlankDebugEventListener.consumeToken.

Implements org.antlr.runtime.debug.DebugEventListener.consumeToken.

An input token was consumed; matched by any kind of element.
public ParseTree
create(Object payload)

What kind of node to create.

public void
enterDecision(int d, boolean couldBacktrack)

Overrides org.antlr.runtime.debug.BlankDebugEventListener.enterDecision.

Implements org.antlr.runtime.debug.DebugEventListener.enterDecision.

Backtracking or cyclic DFA, don't want to add nodes to tree
public void
public ParseTree
public void
public void
exitRule(String filename, String ruleName)

Overrides org.antlr.runtime.debug.BlankDebugEventListener.exitRule.

Implements org.antlr.runtime.debug.DebugEventListener.exitRule.

This is the last thing executed before leaving a rule.
public ParseTree
public void
Inherited from org.antlr.runtime.debug.BlankDebugEventListener:
addChildbecomeRootbeginBacktrackbeginResynccommenceconsumeNodecreateNodecreateNodeendBacktrackendResyncenterAltenterSubRuleerrorNodeexitSubRulelocationLTLTmarknilNoderewindrewindsemanticPredicatesetTokenBoundariesterminate

Field Detail

backtrackingback to summary
pack-priv int backtracking
callStackback to summary
pack-priv Stack<ParseTree> callStack
EPSILON_PAYLOADback to summary
public static final String EPSILON_PAYLOAD
hiddenTokensback to summary
pack-priv List<Token> hiddenTokens

Constructor Detail

ParseTreeBuilderback to summary
public ParseTreeBuilder(String grammarName)

Method Detail

consumeHiddenTokenback to summary
public void consumeHiddenToken(Token token)

Overrides org.antlr.runtime.debug.BlankDebugEventListener.consumeHiddenToken.

Implements org.antlr.runtime.debug.DebugEventListener.consumeHiddenToken.

Doc from org.antlr.runtime.debug.DebugEventListener.consumeHiddenToken.

An off-channel input token was consumed. Trigger after the token was matched by things like match(), matchAny(). (unless of course the hidden token is first stuff in the input stream).

Annotations
@Override
consumeTokenback to summary
public void consumeToken(Token token)

Overrides org.antlr.runtime.debug.BlankDebugEventListener.consumeToken.

Implements org.antlr.runtime.debug.DebugEventListener.consumeToken.

Doc from org.antlr.runtime.debug.DebugEventListener.consumeToken.

An input token was consumed; matched by any kind of element. Trigger after the token was matched by things like match(), matchAny().

Annotations
@Override
createback to summary
public ParseTree create(Object payload)

What kind of node to create. You might want to override so I factored out creation here.

enterDecisionback to summary
public void enterDecision(int d, boolean couldBacktrack)

Overrides org.antlr.runtime.debug.BlankDebugEventListener.enterDecision.

Implements org.antlr.runtime.debug.DebugEventListener.enterDecision.

Backtracking or cyclic DFA, don't want to add nodes to tree

Annotations
@Override
enterRuleback to summary
public void enterRule(String filename, String ruleName)

Overrides org.antlr.runtime.debug.BlankDebugEventListener.enterRule.

Implements org.antlr.runtime.debug.DebugEventListener.enterRule.

Doc from org.antlr.runtime.debug.DebugEventListener.enterRule.

The parser has just entered a rule. No decision has been made about which alt is predicted. This is fired AFTER init actions have been executed. Attributes are defined and available etc... The grammarFileName allows composite grammars to jump around among multiple grammar files.

Annotations
@Override
epsilonNodeback to summary
public ParseTree epsilonNode()
exitDecisionback to summary
public void exitDecision(int i)

Overrides org.antlr.runtime.debug.BlankDebugEventListener.exitDecision.

Implements org.antlr.runtime.debug.DebugEventListener.exitDecision.

Annotations
@Override
exitRuleback to summary
public void exitRule(String filename, String ruleName)

Overrides org.antlr.runtime.debug.BlankDebugEventListener.exitRule.

Implements org.antlr.runtime.debug.DebugEventListener.exitRule.

Doc from org.antlr.runtime.debug.DebugEventListener.exitRule.

This is the last thing executed before leaving a rule. It is executed even if an exception is thrown. This is triggered after error reporting and recovery have occurred (unless the exception is not caught in this rule). This implies an "exitAlt" event. The grammarFileName allows composite grammars to jump around among multiple grammar files.

Annotations
@Override
getTreeback to summary
public ParseTree getTree()
recognitionExceptionback to summary
public void recognitionException(RecognitionException e)

Overrides org.antlr.runtime.debug.BlankDebugEventListener.recognitionException.

Implements org.antlr.runtime.debug.DebugEventListener.recognitionException.

Doc from org.antlr.runtime.debug.DebugEventListener.recognitionException.

A recognition exception occurred such as NoViableAltException. I made this a generic event so that I can alter the exception hierachy later without having to alter all the debug objects. Upon error, the stack of enter rule/subrule must be properly unwound. If no viable alt occurs it is within an enter/exit decision, which also must be rewound. Even the rewind for each mark must be unwount. In the Java target this is pretty easy using try/finally, if a bit ugly in the generated code. The rewind is generated in DFA.predict() actually so no code needs to be generated for that. For languages w/o this "finally" feature (C++?), the target implementor will have to build an event stack or something. Across a socket for remote debugging, only the RecognitionException data fields are transmitted. The token object or whatever that caused the problem was the last object referenced by LT. The immediately preceding LT event should hold the unexpected Token or char. Here is a sample event trace for grammar: b : C ({;}A|B) // {;} is there to prevent A|B becoming a set | D ; The sequence for this rule (with no viable alt in the subrule) for input 'c c' (there are 3 tokens) is: commence LT(1) enterRule b location 7 1 enter decision 3 LT(1) exit decision 3 enterAlt1 location 7 5 LT(1) consumeToken [c/<4>,1:0] location 7 7 enterSubRule 2 enter decision 2 LT(1) LT(1) recognitionException NoViableAltException 2 1 2 exit decision 2 exitSubRule 2 beginResync LT(1) consumeToken [c/<4>,1:1] LT(1) endResync LT(-1) exitRule b terminate

Annotations
@Override