| java.lang.Object
 org.antlr.runtime.tree.TreeWizard
| TreeWizard | | public class TreeWizard (Code) | | Build and navigate trees with this object. Must know about the names
of tokens so you have to pass in a map or array of token names (from which
this class can build the map). I.e., Token DECL means nothing unless the
class can translate it to a token type.
In order to create nodes and navigate, this class needs a TreeAdaptor.
This class can build a token type -> node index for repeated use or for
iterating over the various nodes with a particular type.
This class works in conjunction with the TreeAdaptor rather than moving
all this functionality into the adaptor. An adaptor helps build and
navigate trees using methods. This class helps you do it with string
patterns like "(A B C)". You can create a tree from that pattern or
match subtrees against it.
|
| Inner Class :public interface ContextVisitor | |
| Inner Class :abstract public static class Visitor implements ContextVisitor | |
| Inner Class :public static class TreePattern extends CommonTree | |
| Inner Class :public static class WildcardTreePattern extends TreePattern | |
| Method Summary | |
| protected static boolean | _equals(Object t1, Object t2, TreeAdaptor adaptor)
| | protected void | _index(Object t, Map m)
| | protected boolean | _parse(Object t1, TreePattern t2, Map labels)
Do the work for parse. | | protected void | _visit(Object t, Object parent, int childIndex, int ttype, ContextVisitor visitor)
| | public Map | computeTokenTypes(String[] tokenNames)
Compute a Map that is an inverted index of
tokenNames (which maps int token types to names). | | public Object | create(String pattern)
Create a tree or node from the indicated tree pattern that closely
follows ANTLR tree grammar tree element syntax:
(root child1 ... | | public static boolean | equals(Object t1, Object t2, TreeAdaptor adaptor)
Compare t1 and t2; return true if token types/text, structure match exactly.
The trees are examined in their entirety so that (A B) does not match
(A B C) nor (A (B C)). | | public boolean | equals(Object t1, Object t2)
Compare type, structure, and text of two trees, assuming adaptor in
this instance of a TreeWizard. | | public List | find(Object t, int ttype)
| | public List | find(Object t, String pattern)
Return a List of subtrees matching pattern. | | public Object | findFirst(Object t, int ttype)
| | public Object | findFirst(Object t, String pattern)
| | public int | getTokenType(String tokenName)
Using the map of token names to token types, return the type. | | public Map | index(Object t)
Walk the entire tree and make a node name to nodes mapping.
For now, use recursion but later nonrecursive version may be
more efficient. | | public boolean | parse(Object t, String pattern, Map labels)
Given a pattern like (ASSIGN %lhs:ID %rhs:.) with optional labels
on the various nodes and '.' (dot) as the node/subtree wildcard,
return true if the pattern matches and fill the labels Map with
the labels pointing at the appropriate nodes. | | public boolean | parse(Object t, String pattern)
| | public void | visit(Object t, int ttype, ContextVisitor visitor)
Visit every ttype node in t, invoking the visitor. | | public void | visit(Object t, String pattern, ContextVisitor visitor)
For all subtrees that match the pattern, execute the visit action. |
| tokenNameToTypeMap | | protected Map tokenNameToTypeMap(Code) | | |
| _parse | | protected boolean _parse(Object t1, TreePattern t2, Map labels)(Code) | | Do the work for parse. Check to see if the t2 pattern fits the
structure and token types in t1. Check text if the pattern has
text arguments on nodes. Fill labels map with pointers to nodes
in tree matched against nodes in pattern with labels.
|
| _visit | | protected void _visit(Object t, Object parent, int childIndex, int ttype, ContextVisitor visitor)(Code) | | Do the recursive work for visit
|
| computeTokenTypes | | public Map computeTokenTypes(String[] tokenNames)(Code) | | Compute a Map that is an inverted index of
tokenNames (which maps int token types to names).
|
| create | | public Object create(String pattern)(Code) | | Create a tree or node from the indicated tree pattern that closely
follows ANTLR tree grammar tree element syntax:
(root child1 ... child2).
You can also just pass in a node: ID
Any node can have a text argument: ID[foo]
(notice there are no quotes around foo--it's clear it's a string).
nil is a special name meaning "give me a nil node". Useful for
making lists: (nil A B C) is a list of A B C.
|
| equals | | public static boolean equals(Object t1, Object t2, TreeAdaptor adaptor)(Code) | | Compare t1 and t2; return true if token types/text, structure match exactly.
The trees are examined in their entirety so that (A B) does not match
(A B C) nor (A (B C)).
// TODO: allow them to pass in a comparator
TODO: have a version that is nonstatic so it can use instance adaptor
I cannot rely on the tree node's equals() implementation as I make
no constraints at all on the node types nor interface etc...
|
| equals | | public boolean equals(Object t1, Object t2)(Code) | | Compare type, structure, and text of two trees, assuming adaptor in
this instance of a TreeWizard.
|
| find | | public List find(Object t, int ttype)(Code) | | Return a List of tree nodes with token type ttype
|
| getTokenType | | public int getTokenType(String tokenName)(Code) | | Using the map of token names to token types, return the type.
|
| index | | public Map index(Object t)(Code) | | Walk the entire tree and make a node name to nodes mapping.
For now, use recursion but later nonrecursive version may be
more efficient. Returns Map where the List is
of your AST node type. The Integer is the token type of the node.
TODO: save this index so that find and visit are faster
|
| parse | | public boolean parse(Object t, String pattern, Map labels)(Code) | | Given a pattern like (ASSIGN %lhs:ID %rhs:.) with optional labels
on the various nodes and '.' (dot) as the node/subtree wildcard,
return true if the pattern matches and fill the labels Map with
the labels pointing at the appropriate nodes. Return false if
the pattern is malformed or the tree does not match.
If a node specifies a text arg in pattern, then that must match
for that node in t.
TODO: what's a better way to indicate bad pattern? Exceptions are a hassle
|
| visit | | public void visit(Object t, int ttype, ContextVisitor visitor)(Code) | | Visit every ttype node in t, invoking the visitor. This is a quicker
version of the general visit(t, pattern) method. The labels arg
of the visitor action method is never set (it's null) since using
a token type rather than a pattern doesn't let us set a label.
|
| visit | | public void visit(Object t, String pattern, ContextVisitor visitor)(Code) | | For all subtrees that match the pattern, execute the visit action.
The implementation uses the root node of the pattern in combination
with visit(t, ttype, visitor) so nil-rooted patterns are not allowed.
Patterns with wildcard roots are also not allowed.
|
|
|