Top Description Inners Fields Constructors Methods
org.antlr.runtime.tree

public Class TreeWizard

extends Object
Class Inheritance
Imports
org.antlr.runtime.Token, java.util.ArrayList, .HashMap, .List, .Map

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.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static interface
public static class
TreeWizard.TreePattern

When using %label:TOKENNAME in a tree for parse(), we must track the label.

public static class
TreeWizard.TreePatternTreeAdaptor

This adaptor creates TreePattern objects for use during scan()

public abstract static class
public static class

Field Summary

Modifier and TypeField and Description
protected TreeAdaptor
protected Map<String, Integer>

Constructor Summary

AccessConstructor and Description
public
TreeWizard(TreeAdaptor adaptor)

During fillBuffer(), we can make a reverse index from a set of token types of interest to the list of indexes into the node stream.

public
TreeWizard(TreeAdaptor adaptor, Map<String, Integer> tokenNameToTypeMap)

public
TreeWizard(TreeAdaptor adaptor, String[] tokenNames)

public
TreeWizard(String[] tokenNames)

Method Summary

Modifier and TypeMethod and Description
protected static boolean
_equals(Object t1, Object t2, TreeAdaptor adaptor)

protected void
_index(Object t, Map<Integer, List<Object>> m)

Do the work for index

protected boolean
_parse(Object t1, TreeWizard.TreePattern tpattern, Map<String, Object> labels)

Do the work for parse.

protected void
_visit(Object t, Object parent, int childIndex, int ttype, TreeWizard.ContextVisitor visitor)

Do the recursive work for visit

public Map<String, Integer>
computeTokenTypes(String[] tokenNames)

Compute a Map<String, Integer> 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.

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<? extends Object>
find(Object t, int ttype)

Return a List of tree nodes with token type ttype

public List<? extends Object>
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<Integer, List<Object>>
index(Object t)

Walk the entire tree and make a node name to nodes mapping.

public boolean
parse(Object t, String pattern, Map<String, Object> 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, TreeWizard.ContextVisitor visitor)

Visit every ttype node in t, invoking the visitor.

public void
visit(Object t, final String pattern, final TreeWizard.ContextVisitor visitor)

For all subtrees that match the pattern, execute the visit action.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

adaptorback to summary
protected TreeAdaptor adaptor
tokenNameToTypeMapback to summary
protected Map<String, Integer> tokenNameToTypeMap

Constructor Detail

TreeWizardback to summary
public TreeWizard(TreeAdaptor adaptor)

During fillBuffer(), we can make a reverse index from a set of token types of interest to the list of indexes into the node stream. This lets us convert a node pointer to a stream index semi-efficiently for a list of interesting nodes such as function definition nodes (you'll want to seek to their bodies for an interpreter). Also useful for doing dynamic searches; i.e., go find me all PLUS nodes. protected Map tokenTypeToStreamIndexesMap; /** If tokenTypesToReverseIndex set to INDEX_ALL then indexing occurs for all token types. public static final Set INDEX_ALL = new HashSet(); /** A set of token types user would like to index for faster lookup. If this is INDEX_ALL, then all token types are tracked. If null, then none are indexed. protected Set tokenTypesToReverseIndex = null;

TreeWizardback to summary
public TreeWizard(TreeAdaptor adaptor, Map<String, Integer> tokenNameToTypeMap)
TreeWizardback to summary
public TreeWizard(TreeAdaptor adaptor, String[] tokenNames)
TreeWizardback to summary
public TreeWizard(String[] tokenNames)

Method Detail

_equalsback to summary
protected static boolean _equals(Object t1, Object t2, TreeAdaptor adaptor)
_indexback to summary
protected void _index(Object t, Map<Integer, List<Object>> m)

Do the work for index

_parseback to summary
protected boolean _parse(Object t1, TreeWizard.TreePattern tpattern, Map<String, Object> labels)

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.

_visitback to summary
protected void _visit(Object t, Object parent, int childIndex, int ttype, TreeWizard.ContextVisitor visitor)

Do the recursive work for visit

computeTokenTypesback to summary
public Map<String, Integer> computeTokenTypes(String[] tokenNames)

Compute a Map<String, Integer> that is an inverted index of tokenNames (which maps int token types to names).

createback to summary
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 ... 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.

equalsback to summary
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)). // 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...

equalsback to summary
public boolean equals(Object t1, Object t2)

Compare type, structure, and text of two trees, assuming adaptor in this instance of a TreeWizard.

findback to summary
public List<? extends Object> find(Object t, int ttype)

Return a List of tree nodes with token type ttype

findback to summary
public List<? extends Object> find(Object t, String pattern)

Return a List of subtrees matching pattern.

findFirstback to summary
public Object findFirst(Object t, int ttype)
findFirstback to summary
public Object findFirst(Object t, String pattern)
getTokenTypeback to summary
public int getTokenType(String tokenName)

Using the map of token names to token types, return the type.

indexback to summary
public Map<Integer, List<Object>> 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. Returns Map<Integer, List> 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

parseback to summary
public boolean parse(Object t, String pattern, Map<String, Object> 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. 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

parseback to summary
public boolean parse(Object t, String pattern)
visitback to summary
public void visit(Object t, int ttype, TreeWizard.ContextVisitor visitor)

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.

visitback to summary
public void visit(Object t, final String pattern, final TreeWizard.ContextVisitor visitor)

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.

org.antlr.runtime.tree back to summary

public Interface TreeWizard.ContextVisitor

Known Direct Implementers
org.antlr.runtime.tree.TreeWizard.Visitor

Method Summary

Modifier and TypeMethod and Description
public void
visit(Object t, Object parent, int childIndex, Map<String, Object> labels)

Method Detail

visitback to summary
public void visit(Object t, Object parent, int childIndex, Map<String, Object> labels)
org.antlr.runtime.tree back to summary

public Class TreeWizard.TreePattern

extends CommonTree
Class Inheritance
Known Direct Subclasses
org.antlr.runtime.tree.TreeWizard.WildcardTreePattern

When using %label:TOKENNAME in a tree for parse(), we must track the label.

Field Summary

Modifier and TypeField and Description
public boolean
public String
Inherited from org.antlr.runtime.tree.CommonTree:
childIndexparentstartIndexstopIndextoken

Constructor Summary

AccessConstructor and Description
public
TreePattern(Token payload)

Method Summary

Modifier and TypeMethod and Description
public String
toString()

Overrides org.antlr.runtime.tree.CommonTree.toString.

Implements org.antlr.runtime.tree.Tree.toString.

Override to say how a node (not a tree) should look as text
Inherited from org.antlr.runtime.tree.CommonTree:
dupNodegetCharPositionInLinegetChildIndexgetLinegetParentgetTextgetTokengetTokenStartIndexgetTokenStopIndexgetTypeisNilsetChildIndexsetParentsetTokenStartIndexsetTokenStopIndexsetUnknownTokenBoundaries

Field Detail

hasTextArgback to summary
public boolean hasTextArg
labelback to summary
public String label

Constructor Detail

TreePatternback to summary
public TreePattern(Token payload)

Method Detail

toStringback to summary
public String toString()

Overrides org.antlr.runtime.tree.CommonTree.toString.

Implements org.antlr.runtime.tree.Tree.toString.

Doc from org.antlr.runtime.tree.BaseTree.toString.

Override to say how a node (not a tree) should look as text

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object.

Annotations
@Override
org.antlr.runtime.tree back to summary

public Class TreeWizard.TreePatternTreeAdaptor

extends CommonTreeAdaptor
Class Inheritance

This adaptor creates TreePattern objects for use during scan()

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public Object
create(Token payload)

Overrides org.antlr.runtime.tree.CommonTreeAdaptor.create.

Implements org.antlr.runtime.tree.TreeAdaptor.create.

Create a tree node from Token object; for CommonTree type trees, then the token just becomes the payload.
Inherited from org.antlr.runtime.tree.CommonTreeAdaptor:
createTokencreateTokendupNodegetChildgetChildCountgetChildIndexgetParentgetTextgetTokengetTokenStartIndexgetTokenStopIndexgetTypereplaceChildrensetChildIndexsetParentsetTokenBoundaries

Constructor Detail

TreePatternTreeAdaptorback to summary
public TreePatternTreeAdaptor()

Method Detail

createback to summary
public Object create(Token payload)

Overrides org.antlr.runtime.tree.CommonTreeAdaptor.create.

Implements org.antlr.runtime.tree.TreeAdaptor.create.

Doc from org.antlr.runtime.tree.TreeAdaptor.create.

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.

Annotations
@Override
org.antlr.runtime.tree back to summary

public abstract Class TreeWizard.Visitor

extends Object
implements ContextVisitor
Class Inheritance
All Implemented Interfaces
org.antlr.runtime.tree.TreeWizard.ContextVisitor

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public void
public abstract void
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

Visitorback to summary
public Visitor()

Method Detail

visitback to summary
public void visit(Object t, Object parent, int childIndex, Map<String, Object> labels)

Implements org.antlr.runtime.tree.TreeWizard.ContextVisitor.visit.

Annotations
@Override
visitback to summary
public abstract void visit(Object t)
org.antlr.runtime.tree back to summary

public Class TreeWizard.WildcardTreePattern

extends TreePattern
Class Inheritance

Field Summary

Inherited from org.antlr.runtime.tree.TreeWizard.TreePattern:
hasTextArglabel

Constructor Summary

AccessConstructor and Description
public

Method Summary

Inherited from org.antlr.runtime.tree.TreeWizard.TreePattern:
toString

Constructor Detail

WildcardTreePatternback to summary
public WildcardTreePattern(Token payload)