org.antlr.runtime.debug.TraceDebugEventListener Class Reference
Public Member Functions | |
| TraceDebugEventListener (TreeAdaptor adaptor) | |
| void | enterRule (String ruleName) |
| void | exitRule (String ruleName) |
| void | enterSubRule (int decisionNumber) |
| void | exitSubRule (int decisionNumber) |
| void | location (int line, int pos) |
| void | consumeNode (Object t) |
| void | LT (int i, Object t) |
| void | nilNode (Object t) |
| void | createNode (Object t) |
| void | createNode (Object node, Token token) |
| void | becomeRoot (Object newRoot, Object oldRoot) |
| void | addChild (Object root, Object child) |
| void | setTokenBoundaries (Object t, int tokenStartIndex, int tokenStopIndex) |
Package Attributes | |
| TreeAdaptor | adaptor |
Detailed Description
Print out (most of) the events... Useful for debugging, testing...Definition at line 34 of file TraceDebugEventListener.java.
Constructor & Destructor Documentation
| org.antlr.runtime.debug.TraceDebugEventListener.TraceDebugEventListener | ( | TreeAdaptor | adaptor | ) |
Definition at line 37 of file TraceDebugEventListener.java.
Member Function Documentation
| void org.antlr.runtime.debug.TraceDebugEventListener.enterRule | ( | String | ruleName | ) |
Definition at line 41 of file TraceDebugEventListener.java.
| void org.antlr.runtime.debug.TraceDebugEventListener.exitRule | ( | String | ruleName | ) |
Definition at line 42 of file TraceDebugEventListener.java.
| void org.antlr.runtime.debug.TraceDebugEventListener.enterSubRule | ( | int | decisionNumber | ) |
Track entry into any (...) subrule other EBNF construct
Reimplemented from org.antlr.runtime.debug.BlankDebugEventListener.
Definition at line 43 of file TraceDebugEventListener.java.
| void org.antlr.runtime.debug.TraceDebugEventListener.exitSubRule | ( | int | decisionNumber | ) |
Reimplemented from org.antlr.runtime.debug.BlankDebugEventListener.
Definition at line 44 of file TraceDebugEventListener.java.
| void org.antlr.runtime.debug.TraceDebugEventListener.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. 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.
Reimplemented from org.antlr.runtime.debug.BlankDebugEventListener.
Definition at line 45 of file TraceDebugEventListener.java.
| void org.antlr.runtime.debug.TraceDebugEventListener.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). 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.
- Parameters:
-
t
Reimplemented from org.antlr.runtime.debug.BlankDebugEventListener.
Definition at line 49 of file TraceDebugEventListener.java.
| void org.antlr.runtime.debug.TraceDebugEventListener.LT | ( | int | i, | |
| Object | t | |||
| ) |
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.
Reimplemented from org.antlr.runtime.debug.BlankDebugEventListener.
Definition at line 56 of file TraceDebugEventListener.java.
| void org.antlr.runtime.debug.TraceDebugEventListener.nilNode | ( | Object | t | ) |
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.
Reimplemented from org.antlr.runtime.debug.BlankDebugEventListener.
Definition at line 65 of file TraceDebugEventListener.java.
| void org.antlr.runtime.debug.TraceDebugEventListener.createNode | ( | Object | t | ) |
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.
Reimplemented from org.antlr.runtime.debug.BlankDebugEventListener.
Definition at line 67 of file TraceDebugEventListener.java.
| void org.antlr.runtime.debug.TraceDebugEventListener.createNode | ( | Object | node, | |
| Token | token | |||
| ) |
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.
Reimplemented from org.antlr.runtime.debug.BlankDebugEventListener.
Definition at line 74 of file TraceDebugEventListener.java.
| void org.antlr.runtime.debug.TraceDebugEventListener.becomeRoot | ( | Object | newRoot, | |
| Object | oldRoot | |||
| ) |
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.
Reimplemented from org.antlr.runtime.debug.BlankDebugEventListener.
Definition at line 81 of file TraceDebugEventListener.java.
| void org.antlr.runtime.debug.TraceDebugEventListener.addChild | ( | Object | root, | |
| Object | child | |||
| ) |
Make childID a child of rootID.
If you are receiving this event over a socket via RemoteDebugEventSocketListener then only IDs are set.
Reimplemented from org.antlr.runtime.debug.BlankDebugEventListener.
Definition at line 86 of file TraceDebugEventListener.java.
| void org.antlr.runtime.debug.TraceDebugEventListener.setTokenBoundaries | ( | Object | t, | |
| int | tokenStartIndex, | |||
| int | tokenStopIndex | |||
| ) |
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.
Reimplemented from org.antlr.runtime.debug.BlankDebugEventListener.
Definition at line 91 of file TraceDebugEventListener.java.
Member Data Documentation
Definition at line 35 of file TraceDebugEventListener.java.
The documentation for this class was generated from the following file:
- /Users/parrt/antlr/code/antlr/main/runtime/Java/src/org/antlr/runtime/debug/TraceDebugEventListener.java
