org.antlr.runtime.tree.TreeWizard Class Reference

Collaboration diagram for org.antlr.runtime.tree.TreeWizard:

List of all members.

Public Member Functions

TreeWizard (TreeAdaptor adaptor)

TreeWizard (TreeAdaptor adaptor, Map tokenNameToTypeMap)

TreeWizard (TreeAdaptor adaptor, String[] tokenNames)

TreeWizard (String[] tokenNames)

Map computeTokenTypes (String[] tokenNames)

int getTokenType (String tokenName)

Map index (Object t)

List find (Object t, int ttype)

List find (Object t, String pattern)

Object findFirst (Object t, int ttype)

Object findFirst (Object t, String pattern)

void visit (Object t, int ttype, ContextVisitor visitor)

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

boolean parse (Object t, String pattern, Map labels)

boolean parse (Object t, String pattern)

Object create (String pattern)

boolean equals (Object t1, Object t2)

Static Public Member Functions

static boolean equals (Object t1, Object t2, TreeAdaptor adaptor)

Protected Member Functions

void _index (Object t, Map m)

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

boolean _parse (Object t1, TreePattern t2, Map labels)

Static Protected Member Functions

static boolean _equals (Object t1, Object t2, TreeAdaptor adaptor)

Protected Attributes

TreeAdaptor adaptor

Map tokenNameToTypeMap

Classes

interface ContextVisitor

class TreePattern

class TreePatternTreeAdaptor

class Visitor

class WildcardTreePattern

Detailed Description

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.

Definition at line 50 of file TreeWizard.java.

Constructor & Destructor Documentation

org.antlr.runtime.tree.TreeWizard.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;

Definition at line 119 of file TreeWizard.java.

org.antlr.runtime.tree.TreeWizard.TreeWizard	(	TreeAdaptor	adaptor,
		Map	tokenNameToTypeMap
	)

Definition at line 123 of file TreeWizard.java.

org.antlr.runtime.tree.TreeWizard.TreeWizard	(	TreeAdaptor	adaptor,
		String[]	tokenNames
	)

Definition at line 128 of file TreeWizard.java.

org.antlr.runtime.tree.TreeWizard.TreeWizard ( String[] tokenNames )

Definition at line 133 of file TreeWizard.java.

Member Function Documentation

Map org.antlr.runtime.tree.TreeWizard.computeTokenTypes ( String[] tokenNames )

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

Definition at line 140 of file TreeWizard.java.

int org.antlr.runtime.tree.TreeWizard.getTokenType ( String tokenName )

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

Definition at line 153 of file TreeWizard.java.

Map org.antlr.runtime.tree.TreeWizard.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

Definition at line 171 of file TreeWizard.java.

void org.antlr.runtime.tree.TreeWizard._index	(	Object	t,
		Map	m
	)			`[protected]`

Do the work for index

Definition at line 178 of file TreeWizard.java.

List org.antlr.runtime.tree.TreeWizard.find	(	Object	t,
		int	ttype
	)

Return a List of tree nodes with token type ttype

Definition at line 197 of file TreeWizard.java.

List org.antlr.runtime.tree.TreeWizard.find	(	Object	t,
		String	pattern
	)

Return a List of subtrees matching pattern.

Definition at line 208 of file TreeWizard.java.

Object org.antlr.runtime.tree.TreeWizard.findFirst	(	Object	t,
		int	ttype
	)

Definition at line 233 of file TreeWizard.java.

Object org.antlr.runtime.tree.TreeWizard.findFirst	(	Object	t,
		String	pattern
	)

Definition at line 237 of file TreeWizard.java.

void org.antlr.runtime.tree.TreeWizard.visit	(	Object	t,
		int	ttype,
		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.

Definition at line 246 of file TreeWizard.java.

void org.antlr.runtime.tree.TreeWizard._visit	(	Object	t,
		Object	parent,
		int	childIndex,
		int	ttype,
		ContextVisitor	visitor
	)			`[protected]`

Do the recursive work for visit

Definition at line 251 of file TreeWizard.java.

void org.antlr.runtime.tree.TreeWizard.visit	(	Object	t,
		final String	pattern,
		final 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.

Definition at line 270 of file TreeWizard.java.

boolean org.antlr.runtime.tree.TreeWizard.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. 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

Definition at line 307 of file TreeWizard.java.

boolean org.antlr.runtime.tree.TreeWizard.parse	(	Object	t,
		String	pattern
	)

Definition at line 320 of file TreeWizard.java.

boolean org.antlr.runtime.tree.TreeWizard._parse	(	Object	t1,
		TreePattern	t2,
		Map	labels
	)			`[protected]`

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.

Definition at line 329 of file TreeWizard.java.

Object org.antlr.runtime.tree.TreeWizard.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.

Definition at line 376 of file TreeWizard.java.

static boolean org.antlr.runtime.tree.TreeWizard.equals	(	Object	t1,
		Object	t2,
		TreeAdaptor	adaptor
	)			`[static]`

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...

Definition at line 392 of file TreeWizard.java.

boolean org.antlr.runtime.tree.TreeWizard.equals	(	Object	t1,
		Object	t2
	)

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

Definition at line 399 of file TreeWizard.java.

static boolean org.antlr.runtime.tree.TreeWizard._equals	(	Object	t1,
		Object	t2,
		TreeAdaptor	adaptor
	)			`[static, protected]`

Definition at line 403 of file TreeWizard.java.

Member Data Documentation

TreeAdaptor org.antlr.runtime.tree.TreeWizard.adaptor [protected]

Definition at line 51 of file TreeWizard.java.

Map org.antlr.runtime.tree.TreeWizard.tokenNameToTypeMap [protected]

Definition at line 52 of file TreeWizard.java.

The documentation for this class was generated from the following file:

/Users/parrt/antlr/code/antlr/main/runtime/Java/src/org/antlr/runtime/tree/TreeWizard.java


Public Member Functions
	TreeWizard (TreeAdaptor adaptor)
	TreeWizard (TreeAdaptor adaptor, Map tokenNameToTypeMap)
	TreeWizard (TreeAdaptor adaptor, String[] tokenNames)
	TreeWizard (String[] tokenNames)
Map	computeTokenTypes (String[] tokenNames)
int	getTokenType (String tokenName)
Map	index (Object t)
List	find (Object t, int ttype)
List	find (Object t, String pattern)
Object	findFirst (Object t, int ttype)
Object	findFirst (Object t, String pattern)
void	visit (Object t, int ttype, ContextVisitor visitor)
void	visit (Object t, final String pattern, final ContextVisitor visitor)
boolean	parse (Object t, String pattern, Map labels)
boolean	parse (Object t, String pattern)
Object	create (String pattern)
boolean	equals (Object t1, Object t2)
Static Public Member Functions
static boolean	equals (Object t1, Object t2, TreeAdaptor adaptor)
Protected Member Functions
void	_index (Object t, Map m)
void	_visit (Object t, Object parent, int childIndex, int ttype, ContextVisitor visitor)
boolean	_parse (Object t1, TreePattern t2, Map labels)
Static Protected Member Functions
static boolean	_equals (Object t1, Object t2, TreeAdaptor adaptor)
Protected Attributes
TreeAdaptor	adaptor
Map	tokenNameToTypeMap
Classes
interface	ContextVisitor
class	TreePattern
class	TreePatternTreeAdaptor
class	Visitor
class	WildcardTreePattern