类 DebugTreeAdaptor
- java.lang.Object
-
- org.antlr.runtime.debug.DebugTreeAdaptor
-
- 所有已实现的接口:
TreeAdaptor
public class DebugTreeAdaptor extends java.lang.Object implements TreeAdaptor
A TreeAdaptor proxy that fires debugging events to a DebugEventListener delegate and uses the TreeAdaptor delegate to do the actual work. All AST events are triggered by this adaptor; no code gen changes are needed in generated rules. Debugging events are triggered *after* invoking tree adaptor routines. Trees created with actions in rewrite actions like "-> ^(ADD {foo} {bar})" cannot be tracked as they might not use the adaptor to create foo, bar. The debug listener has to deal with tree node IDs for which it did not see a createNode event. A single <unknown> node is sufficient even if it represents a whole tree.
-
-
字段概要
字段 修饰符和类型 字段 说明 protected TreeAdaptor
adaptor
protected DebugEventListener
dbg
-
构造器概要
构造器 构造器 说明 DebugTreeAdaptor(DebugEventListener dbg, TreeAdaptor adaptor)
-
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 void
addChild(java.lang.Object t, java.lang.Object child)
Add a child to the tree t.void
addChild(java.lang.Object t, Token child)
java.lang.Object
becomeRoot(java.lang.Object newRoot, java.lang.Object oldRoot)
If oldRoot is a nil root, just copy or move the children to newRoot.java.lang.Object
becomeRoot(Token newRoot, java.lang.Object oldRoot)
Create a node for newRoot make it the root of oldRoot.java.lang.Object
create(int tokenType, java.lang.String text)
Create a new node derived from a token, with a new token type.java.lang.Object
create(int tokenType, Token fromToken)
Create a new node derived from a token, with a new token type.java.lang.Object
create(int tokenType, Token fromToken, java.lang.String text)
Same as create(tokenType,fromToken) except set the text too.java.lang.Object
create(Token payload)
Create a tree node from Token object; for CommonTree type trees, then the token just becomes the payload.java.lang.Object
deleteChild(java.lang.Object t, int i)
Remove ith child and shift children down from right.java.lang.Object
dupNode(java.lang.Object treeNode)
Duplicate a single tree node.java.lang.Object
dupTree(java.lang.Object tree)
Duplicate tree recursively, using dupNode() for each nodejava.lang.Object
errorNode(TokenStream input, Token start, Token stop, RecognitionException e)
Return a tree node representing an error.java.lang.Object
getChild(java.lang.Object t, int i)
Get a child 0..n-1 nodeint
getChildCount(java.lang.Object t)
How many children? If 0, then this is a leaf nodeint
getChildIndex(java.lang.Object t)
What index is this node in the child list? Range: 0..n-1 If your node type doesn't handle this, it's ok but the tree rewrites in tree parsers need this functionality.DebugEventListener
getDebugListener()
java.lang.Object
getParent(java.lang.Object t)
Who is the parent node of this node; if null, implies node is root.java.lang.String
getText(java.lang.Object t)
Token
getToken(java.lang.Object t)
Return the token object from which this node was created.int
getTokenStartIndex(java.lang.Object t)
Get the token start index for this subtree; return -1 if no such indexint
getTokenStopIndex(java.lang.Object t)
Get the token stop index for this subtree; return -1 if no such indexTreeAdaptor
getTreeAdaptor()
int
getType(java.lang.Object t)
For tree parsing, I need to know the token type of a nodeint
getUniqueID(java.lang.Object node)
For identifying trees.boolean
isNil(java.lang.Object tree)
Is tree considered a nil node used to make lists of child nodes?java.lang.Object
nil()
Return a nil node (an empty but non-null node) that can hold a list of element as the children.void
replaceChildren(java.lang.Object parent, int startChildIndex, int stopChildIndex, java.lang.Object t)
Replace from start to stop child index of parent with t, which might be a list.java.lang.Object
rulePostProcessing(java.lang.Object root)
Given the root of the subtree created for this rule, post process it to do any simplifications or whatever you want.void
setChild(java.lang.Object t, int i, java.lang.Object child)
Set ith child (0..n-1) to t; t must be non-null and non-nil nodevoid
setChildIndex(java.lang.Object t, int index)
void
setDebugListener(DebugEventListener dbg)
void
setParent(java.lang.Object t, java.lang.Object parent)
void
setText(java.lang.Object t, java.lang.String text)
Node constructors can set the text of a nodevoid
setTokenBoundaries(java.lang.Object t, Token startToken, Token stopToken)
Where are the bounds in the input token stream for this node and all children? Each rule that creates AST nodes will call this method right before returning.void
setType(java.lang.Object t, int type)
Node constructors can set the type of a nodeprotected void
simulateTreeConstruction(java.lang.Object t)
^(A B C): emit create A, create B, add child, ...
-
-
-
字段详细资料
-
dbg
protected DebugEventListener dbg
-
adaptor
protected TreeAdaptor adaptor
-
-
构造器详细资料
-
DebugTreeAdaptor
public DebugTreeAdaptor(DebugEventListener dbg, TreeAdaptor adaptor)
-
-
方法详细资料
-
create
public java.lang.Object create(Token payload)
从接口复制的说明:TreeAdaptor
Create a tree node from Token object; for CommonTree type trees, then the token just becomes the payload. This is the most common create call. Override if you want another kind of node to be built.- 指定者:
create
在接口中TreeAdaptor
-
errorNode
public java.lang.Object errorNode(TokenStream input, Token start, Token stop, RecognitionException e)
从接口复制的说明:TreeAdaptor
Return a tree node representing an error. This node records the tokens consumed during error recovery. The start token indicates the input symbol at which the error was detected. The stop token indicates the last symbol consumed during recovery. You must specify the input stream so that the erroneous text can be packaged up in the error node. The exception could be useful to some applications; default implementation stores ptr to it in the CommonErrorNode. This only makes sense during token parsing, not tree parsing. Tree parsing should happen only when parsing and tree construction succeed.- 指定者:
errorNode
在接口中TreeAdaptor
-
dupTree
public java.lang.Object dupTree(java.lang.Object tree)
从接口复制的说明:TreeAdaptor
Duplicate tree recursively, using dupNode() for each node- 指定者:
dupTree
在接口中TreeAdaptor
-
simulateTreeConstruction
protected void simulateTreeConstruction(java.lang.Object t)
^(A B C): emit create A, create B, add child, ...
-
dupNode
public java.lang.Object dupNode(java.lang.Object treeNode)
从接口复制的说明:TreeAdaptor
Duplicate a single tree node. Override if you want another kind of node to be built.- 指定者:
dupNode
在接口中TreeAdaptor
-
nil
public java.lang.Object nil()
从接口复制的说明:TreeAdaptor
Return a nil node (an empty but non-null node) that can hold a list of element as the children. If you want a flat tree (a list) use "t=adaptor.nil(); t.addChild(x); t.addChild(y);"- 指定者:
nil
在接口中TreeAdaptor
-
isNil
public boolean isNil(java.lang.Object tree)
从接口复制的说明:TreeAdaptor
Is tree considered a nil node used to make lists of child nodes?- 指定者:
isNil
在接口中TreeAdaptor
-
addChild
public void addChild(java.lang.Object t, java.lang.Object child)
从接口复制的说明:TreeAdaptor
Add a child to the tree t. If child is a flat tree (a list), make all in list children of t. Warning: if t has no children, but child does and child isNil then you can decide it is ok to move children to t via t.children = child.children; i.e., without copying the array. Just make sure that this is consistent with have the user will build ASTs. Do nothing if t or child is null.- 指定者:
addChild
在接口中TreeAdaptor
-
becomeRoot
public java.lang.Object becomeRoot(java.lang.Object newRoot, java.lang.Object oldRoot)
从接口复制的说明:TreeAdaptor
If oldRoot is a nil root, just copy or move the children to newRoot. If not a nil root, make oldRoot a child of newRoot. old=^(nil a b c), new=r yields ^(r a b c) old=^(a b c), new=r yields ^(r ^(a b c)) If newRoot is a nil-rooted single child tree, use the single child as the new root node. old=^(nil a b c), new=^(nil r) yields ^(r a b c) old=^(a b c), new=^(nil r) yields ^(r ^(a b c)) If oldRoot was null, it's ok, just return newRoot (even if isNil). old=null, new=r yields r old=null, new=^(nil r) yields ^(nil r) Return newRoot. Throw an exception if newRoot is not a simple node or nil root with a single child node--it must be a root node. If newRoot is ^(nil x) return x as newRoot. Be advised that it's ok for newRoot to point at oldRoot's children; i.e., you don't have to copy the list. We are constructing these nodes so we should have this control for efficiency.- 指定者:
becomeRoot
在接口中TreeAdaptor
-
rulePostProcessing
public java.lang.Object rulePostProcessing(java.lang.Object root)
从接口复制的说明:TreeAdaptor
Given the root of the subtree created for this rule, post process it to do any simplifications or whatever you want. A required behavior is to convert ^(nil singleSubtree) to singleSubtree as the setting of start/stop indexes relies on a single non-nil root for non-flat trees. Flat trees such as for lists like "idlist : ID+ ;" are left alone unless there is only one ID. For a list, the start/stop indexes are set in the nil node. This method is executed after all rule tree construction and right before setTokenBoundaries().- 指定者:
rulePostProcessing
在接口中TreeAdaptor
-
addChild
public void addChild(java.lang.Object t, Token child)
-
becomeRoot
public java.lang.Object becomeRoot(Token newRoot, java.lang.Object oldRoot)
从接口复制的说明:TreeAdaptor
Create a node for newRoot make it the root of oldRoot. If oldRoot is a nil root, just copy or move the children to newRoot. If not a nil root, make oldRoot a child of newRoot. Return node created for newRoot. Be advised: when debugging ASTs, the DebugTreeAdaptor manually calls create(Token child) and then plain becomeRoot(node, node) because it needs to trap calls to create, but it can't since it delegates to not inherits from the TreeAdaptor.- 指定者:
becomeRoot
在接口中TreeAdaptor
-
create
public java.lang.Object create(int tokenType, Token fromToken)
从接口复制的说明:TreeAdaptor
Create a new node derived from a token, with a new token type. This is invoked from an imaginary node ref on right side of a rewrite rule as IMAG[$tokenLabel]. This should invoke createToken(Token).- 指定者:
create
在接口中TreeAdaptor
-
create
public java.lang.Object create(int tokenType, Token fromToken, java.lang.String text)
从接口复制的说明:TreeAdaptor
Same as create(tokenType,fromToken) except set the text too. This is invoked from an imaginary node ref on right side of a rewrite rule as IMAG[$tokenLabel, "IMAG"]. This should invoke createToken(Token).- 指定者:
create
在接口中TreeAdaptor
-
create
public java.lang.Object create(int tokenType, java.lang.String text)
从接口复制的说明:TreeAdaptor
Create a new node derived from a token, with a new token type. This is invoked from an imaginary node ref on right side of a rewrite rule as IMAG["IMAG"]. This should invoke createToken(int,String).- 指定者:
create
在接口中TreeAdaptor
-
getType
public int getType(java.lang.Object t)
从接口复制的说明:TreeAdaptor
For tree parsing, I need to know the token type of a node- 指定者:
getType
在接口中TreeAdaptor
-
setType
public void setType(java.lang.Object t, int type)
从接口复制的说明:TreeAdaptor
Node constructors can set the type of a node- 指定者:
setType
在接口中TreeAdaptor
-
getText
public java.lang.String getText(java.lang.Object t)
- 指定者:
getText
在接口中TreeAdaptor
-
setText
public void setText(java.lang.Object t, java.lang.String text)
从接口复制的说明:TreeAdaptor
Node constructors can set the text of a node- 指定者:
setText
在接口中TreeAdaptor
-
getToken
public Token getToken(java.lang.Object t)
从接口复制的说明:TreeAdaptor
Return the token object from which this node was created. Currently used only for printing an error message. The error display routine in BaseRecognizer needs to display where the input the error occurred. If your tree of limitation does not store information that can lead you to the token, you can create a token filled with the appropriate information and pass that back. See BaseRecognizer.getErrorMessage().- 指定者:
getToken
在接口中TreeAdaptor
-
setTokenBoundaries
public void setTokenBoundaries(java.lang.Object t, Token startToken, Token stopToken)
从接口复制的说明:TreeAdaptor
Where are the bounds in the input token stream for this node and all children? Each rule that creates AST nodes will call this method right before returning. Flat trees (i.e., lists) will still usually have a nil root node just to hold the children list. That node would contain the start/stop indexes then.- 指定者:
setTokenBoundaries
在接口中TreeAdaptor
-
getTokenStartIndex
public int getTokenStartIndex(java.lang.Object t)
从接口复制的说明:TreeAdaptor
Get the token start index for this subtree; return -1 if no such index- 指定者:
getTokenStartIndex
在接口中TreeAdaptor
-
getTokenStopIndex
public int getTokenStopIndex(java.lang.Object t)
从接口复制的说明:TreeAdaptor
Get the token stop index for this subtree; return -1 if no such index- 指定者:
getTokenStopIndex
在接口中TreeAdaptor
-
getChild
public java.lang.Object getChild(java.lang.Object t, int i)
从接口复制的说明:TreeAdaptor
Get a child 0..n-1 node- 指定者:
getChild
在接口中TreeAdaptor
-
setChild
public void setChild(java.lang.Object t, int i, java.lang.Object child)
从接口复制的说明:TreeAdaptor
Set ith child (0..n-1) to t; t must be non-null and non-nil node- 指定者:
setChild
在接口中TreeAdaptor
-
deleteChild
public java.lang.Object deleteChild(java.lang.Object t, int i)
从接口复制的说明:TreeAdaptor
Remove ith child and shift children down from right.- 指定者:
deleteChild
在接口中TreeAdaptor
-
getChildCount
public int getChildCount(java.lang.Object t)
从接口复制的说明:TreeAdaptor
How many children? If 0, then this is a leaf node- 指定者:
getChildCount
在接口中TreeAdaptor
-
getUniqueID
public int getUniqueID(java.lang.Object node)
从接口复制的说明:TreeAdaptor
For identifying trees. How to identify nodes so we can say "add node to a prior node"? Even becomeRoot is an issue. Use System.identityHashCode(node) usually.- 指定者:
getUniqueID
在接口中TreeAdaptor
-
getParent
public java.lang.Object getParent(java.lang.Object t)
从接口复制的说明:TreeAdaptor
Who is the parent node of this node; if null, implies node is root. If your node type doesn't handle this, it's ok but the tree rewrites in tree parsers need this functionality.- 指定者:
getParent
在接口中TreeAdaptor
-
getChildIndex
public int getChildIndex(java.lang.Object t)
从接口复制的说明:TreeAdaptor
What index is this node in the child list? Range: 0..n-1 If your node type doesn't handle this, it's ok but the tree rewrites in tree parsers need this functionality.- 指定者:
getChildIndex
在接口中TreeAdaptor
-
setParent
public void setParent(java.lang.Object t, java.lang.Object parent)
- 指定者:
setParent
在接口中TreeAdaptor
-
setChildIndex
public void setChildIndex(java.lang.Object t, int index)
- 指定者:
setChildIndex
在接口中TreeAdaptor
-
replaceChildren
public void replaceChildren(java.lang.Object parent, int startChildIndex, int stopChildIndex, java.lang.Object t)
从接口复制的说明:TreeAdaptor
Replace from start to stop child index of parent with t, which might be a list. Number of children may be different after this call. If parent is null, don't do anything; must be at root of overall tree. Can't replace whatever points to the parent externally. Do nothing.- 指定者:
replaceChildren
在接口中TreeAdaptor
-
getDebugListener
public DebugEventListener getDebugListener()
-
setDebugListener
public void setDebugListener(DebugEventListener dbg)
-
getTreeAdaptor
public TreeAdaptor getTreeAdaptor()
-
-