org.antlr.runtime.debug
Class TraceDebugEventListener

java.lang.Object
  org.antlr.runtime.debug.BlankDebugEventListener
      org.antlr.runtime.debug.TraceDebugEventListener

All Implemented Interfaces:

DebugEventListener

public class TraceDebugEventListener
extends BlankDebugEventListener

Print out (most of) the events... Useful for debugging, testing...

Field Summary

Fields inherited from interface org.antlr.runtime.debug.DebugEventListener

FALSE, PROTOCOL_VERSION, TRUE

Constructor Summary

TraceDebugEventListener(TreeAdaptor adaptor)

Method Summary

void	addChild(Object root, Object child) Make childID a child of rootID.
void	becomeRoot(Object newRoot, Object oldRoot) Make a node the new root of an existing root.
void	consumeNode(Object t) Input for a tree parser is an AST, but we know nothing for sure about a node except its type and text (obtained from the adaptor).
void	createNode(Object t) Announce a new node built from token elements such as type etc...
void	createNode(Object node, Token token) Announce a new node built from an existing token.
void	enterRule(String ruleName)
void	enterSubRule(int decisionNumber) Track entry into any (...) subrule other EBNF construct
void	exitRule(String ruleName)
void	exitSubRule(int decisionNumber)
void	location(int line, int pos) To watch a parser move through the grammar, the parser needs to inform the debugger what line/charPos it is passing in the grammar.
void	LT(int i, Object t) The tree parser lookedahead.
void	nilNode(Object t) A nil was created (even nil nodes have a unique ID...
void	setTokenBoundaries(Object t, int tokenStartIndex, int tokenStopIndex) Set the token start/stop token index for a subtree root or node.

Methods inherited from class org.antlr.runtime.debug.BlankDebugEventListener

beginBacktrack, beginResync, commence, consumeHiddenToken, consumeToken, endBacktrack, endResync, enterAlt, enterDecision, enterRule, errorNode, exitDecision, exitRule, LT, mark, recognitionException, rewind, rewind, semanticPredicate, terminate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TraceDebugEventListener

public TraceDebugEventListener(TreeAdaptor adaptor)

Method Detail

enterRule

public void enterRule(String ruleName)

exitRule

public void exitRule(String ruleName)

enterSubRule

public void enterSubRule(int decisionNumber)

Description copied from interface: DebugEventListener

Track entry into any (...) subrule other EBNF construct

Specified by:

enterSubRule in interface DebugEventListener

Overrides:

enterSubRule in class BlankDebugEventListener

exitSubRule

public void exitSubRule(int decisionNumber)

Specified by:

exitSubRule in interface DebugEventListener

Overrides:

exitSubRule in class BlankDebugEventListener

location

public void location(int line,
                     int pos)

Description copied from interface: DebugEventListener

To watch a parser move through the grammar, the parser needs to inform the debugger what line/charPos it is passing in the grammar. For now, this does not know how to switch from one grammar to the other and back for island grammars etc... This should also allow breakpoints because the debugger can stop the parser whenever it hits this line/pos.

Specified by:

location in interface DebugEventListener

Overrides:

location in class BlankDebugEventListener

consumeNode

public void consumeNode(Object t)

Description copied from interface: DebugEventListener

Input for a tree parser is an AST, but we know nothing for sure about a node except its type and text (obtained from the adaptor). This is the analog of the consumeToken method. Again, the ID is the hashCode usually of the node so it only works if hashCode is not implemented. If the type is UP or DOWN, then the ID is not really meaningful as it's fixed--there is just one UP node and one DOWN navigation node.

Specified by:

consumeNode in interface DebugEventListener

Overrides:

consumeNode in class BlankDebugEventListener

LT

public void LT(int i,
               Object t)

Description copied from interface: DebugEventListener

The tree parser lookedahead. If the type is UP or DOWN, then the ID is not really meaningful as it's fixed--there is just one UP node and one DOWN navigation node.

Specified by:

LT in interface DebugEventListener

Overrides:

LT in class BlankDebugEventListener

nilNode

public void nilNode(Object t)

Description copied from interface: DebugEventListener

A nil was created (even nil nodes have a unique ID... they are not "null" per se). As of 4/28/2006, this seems to be uniquely triggered when starting a new subtree such as when entering a subrule in automatic mode and when building a tree in rewrite mode. If you are receiving this event over a socket via RemoteDebugEventSocketListener then only t.ID is set.

Specified by:

nilNode in interface DebugEventListener

Overrides:

nilNode in class BlankDebugEventListener

createNode

public void createNode(Object t)

Description copied from interface: DebugEventListener

Announce a new node built from token elements such as type etc... If you are receiving this event over a socket via RemoteDebugEventSocketListener then only t.ID, type, text are set.

Specified by:

createNode in interface DebugEventListener

Overrides:

createNode in class BlankDebugEventListener

createNode

public void createNode(Object node,
                       Token token)

Description copied from interface: DebugEventListener

Announce a new node built from an existing token. If you are receiving this event over a socket via RemoteDebugEventSocketListener then only node.ID and token.tokenIndex are set.

Specified by:

createNode in interface DebugEventListener

Overrides:

createNode in class BlankDebugEventListener

becomeRoot

public void becomeRoot(Object newRoot,
                       Object oldRoot)

Description copied from interface: DebugEventListener

Make a node the new root of an existing root. See Note: the newRootID parameter is possibly different than the TreeAdaptor.becomeRoot() newRoot parameter. In our case, it will always be the result of calling TreeAdaptor.becomeRoot() and not root_n or whatever. The listener should assume that this event occurs only when the current subrule (or rule) subtree is being reset to newRootID. If you are receiving this event over a socket via RemoteDebugEventSocketListener then only IDs are set.

Specified by:

becomeRoot in interface DebugEventListener

Overrides:

becomeRoot in class BlankDebugEventListener

See Also:

org.antlr.runtime.tree.TreeAdaptor.becomeRoot()

addChild

public void addChild(Object root,
                     Object child)

Description copied from interface: DebugEventListener

Make childID a child of rootID. If you are receiving this event over a socket via RemoteDebugEventSocketListener then only IDs are set.

Specified by:

addChild in interface DebugEventListener

Overrides:

addChild in class BlankDebugEventListener

See Also:

org.antlr.runtime.tree.TreeAdaptor.addChild()

setTokenBoundaries

public void setTokenBoundaries(Object t,
                               int tokenStartIndex,
                               int tokenStopIndex)

Description copied from interface: DebugEventListener

Set the token start/stop token index for a subtree root or node. If you are receiving this event over a socket via RemoteDebugEventSocketListener then only t.ID is set.

Specified by:

setTokenBoundaries in interface DebugEventListener

Overrides:

setTokenBoundaries in class BlankDebugEventListener