Public Member Functions
	ASTFactory ()
	ASTFactory (Hashtable tokenTypeToClassMap)
void	setTokenTypeASTNodeType (int tokenType, String className) throws IllegalArgumentException
Class	getASTNodeType (int tokenType)
void	addASTChild (ASTPair currentAST, AST child)
AST	create ()
AST	create (int type)
AST	create (int type, String txt)
AST	create (int type, String txt, String className)
AST	create (AST tr)
AST	create (Token tok)
AST	create (Token tok, String className)
AST	create (String className)
AST	dup (AST t)
AST	dupList (AST t)
AST	dupTree (AST t)
AST	make (AST[] nodes)
AST	make (ASTArray nodes)
void	makeASTRoot (ASTPair currentAST, AST root)
void	setASTNodeClass (Class c)
void	setASTNodeClass (String t)
void	setASTNodeType (String t)
Hashtable	getTokenTypeToASTClassMap ()
void	setTokenTypeToASTClassMap (Hashtable tokenTypeToClassMap)
void	error (String e)
Protected Member Functions
AST	createUsingCtor (Token token, String className)
AST	create (Class c)
Protected Attributes
String	theASTNodeType = null
Class	theASTNodeTypeClass = null
Hashtable	tokenTypeToASTClassMap = null

Detailed Description

AST Support code shared by TreeParser and Parser. We use delegation to share code (and have only one bit of code to maintain) rather than subclassing or superclassing (forces AST support code to be loaded even when you don't want to do AST stuff).

Typically, setASTNodeType is used to specify the homogeneous type of node to create, but you can override create to make heterogeneous nodes etc...

Constructor & Destructor Documentation

antlr.ASTFactory.ASTFactory ( )

antlr.ASTFactory.ASTFactory ( Hashtable tokenTypeToClassMap )

Create factory with a specific mapping from token type to Java AST node type. Your subclasses of ASTFactory can override and reuse the map stuff.

References antlr.ASTFactory.setTokenTypeToASTClassMap().

Member Function Documentation

void antlr.ASTFactory.addASTChild	(	ASTPair	currentAST,
		AST	child
	)

Add a child to the current AST

References antlr.ASTPair.advanceChildToEnd(), antlr.ASTPair.child, antlr.ASTPair.root, antlr.collections.AST.setFirstChild(), and antlr.collections.AST.setNextSibling().

AST antlr.ASTFactory.create ( )

Create a new empty AST node; if the user did not specify an AST node type, then create a default one: CommonAST.

Referenced by PascalParser.arrayType(), PascalParser.assignmentStatement(), PascalParser.block(), PascalParser.caseListElement(), PascalParser.caseStatement(), PascalParser.constantChr(), PascalParser.constantDefinition(), PascalParser.constantDefinitionPart(), PascalParser.constList(), antlr.ASTFactory.create(), antlr.ASTFactory.createUsingCtor(), PascalParser.doTreeAction(), tinybasic.Main.doTreeAction(), Main.doTreeAction(), PascalParser.element(), PascalParser.expression(), PascalParser.factor(), PascalParser.fieldList(), PascalParser.fileType(), PascalParser.forList(), PascalParser.formalParameterList(), PascalParser.formalParameterSection(), PascalParser.forStatement(), PascalParser.functionDeclaration(), PascalParser.functionDesignator(), PascalParser.functionType(), PascalParser.gotoStatement(), PascalParser.identifier(), PascalParser.identifierList(), PascalParser.ifStatement(), PascalParser.labelDeclarationPart(), antlr.debug.misc.ASTFrame.main(), PascalParser.parameterGroup(), PascalParser.parameterList(), PascalParser.pointerType(), PascalParser.procedureDeclaration(), PascalParser.procedureStatement(), PascalParser.procedureType(), PascalParser.programHeading(), PascalParser.recordSection(), PascalParser.recordType(), PascalParser.repeatStatement(), PascalParser.scalarType(), PascalParser.set(), PascalParser.setType(), PascalParser.sign(), PascalParser.signedFactor(), PascalParser.simpleExpression(), PascalParser.statement(), PascalParser.statements(), PascalParser.string(), PascalParser.stringtype(), PascalParser.structuredType(), PascalParser.subrangeType(), PascalParser.tag(), PascalParser.term(), TestASTFactory.testDefaultCreate(), TestASTFactory.testDynamicHeteroCreate(), TestASTFactory.testHeteroTreeDup(), TestASTFactory.testNodeDup(), TestASTFactory.testSpecificHomoCreate(), PascalParser.typeDefinition(), PascalParser.typeDefinitionPart(), PascalParser.typeIdentifier(), PascalParser.typeList(), PascalParser.unsignedConstant(), PascalParser.unsignedInteger(), PascalParser.unsignedReal(), PascalParser.usesUnitsPart(), PascalParser.variable(), PascalParser.variableDeclaration(), PascalParser.variableDeclarationPart(), PascalParser.variant(), PascalParser.variantPart(), PascalParser.whileStatement(), and PascalParser.withStatement().

AST antlr.ASTFactory.create ( AST tr )

Create a new empty AST node; if the user did not specify an AST node type, then create a default one: CommonAST.

References antlr.ASTFactory.create(), antlr.collections.AST.getType(), and antlr.collections.AST.initialize().

AST antlr.ASTFactory.create ( Token tok )

References antlr.ASTFactory.create(), antlr.Token.getType(), and antlr.collections.AST.initialize().

AST antlr.ASTFactory.create ( int type )

References antlr.ASTFactory.create(), antlr.ASTFactory.getASTNodeType(), and antlr.collections.AST.initialize().

AST antlr.ASTFactory.create	(	Token	tok,
		String	className
	)

ANTLR generates reference to this when you reference a token that has a specified heterogeneous AST node type. This is also a special case node creation routine for backward compatibility. Before, ANTLR generated "new T(tokenObject)" and so I must call the appropriate constructor not T().

Since:: 2.7.2

References antlr.ASTFactory.createUsingCtor().

AST antlr.ASTFactory.create ( String className )

Since:: 2.7.2

References antlr.ASTFactory.create().

AST antlr.ASTFactory.create	(	int	type,
		String	txt
	)

References antlr.ASTFactory.create(), and antlr.collections.AST.initialize().

AST antlr.ASTFactory.create ( Class c ) [protected]

Since:: 2.7.2

AST antlr.ASTFactory.create	(	int	type,
		String	txt,
		String	className
	)

Create an AST node with the token type and text passed in, but with a specific Java object type. Typically called when you say @[PLUS,"+",PLUSNode] in an antlr action.

Since:: 2.7.2

References antlr.ASTFactory.create(), and antlr.collections.AST.initialize().

AST antlr.ASTFactory.createUsingCtor	(	Token	token,
		String	className
	)			`[protected]`

Since:: 2.7.2

References antlr.ASTFactory.create(), and antlr.collections.AST.initialize().

Referenced by antlr.ASTFactory.create().

AST antlr.ASTFactory.dup ( AST t )

Copy a single node with same Java AST objec type. Ignore the tokenType->Class mapping since you know the type of the node, t.getClass(), and doing a dup.

clone() is not used because we want all AST creation to go thru the factory so creation can be tracked. Returns null if t is null.

References antlr.collections.AST.initialize().

Referenced by TestASTFactory.testNodeDup().

AST antlr.ASTFactory.dupList ( AST t )

Duplicate tree including siblings of root.

References antlr.collections.AST.getNextSibling(), and antlr.collections.AST.setNextSibling().

Referenced by TestASTFactory.testHeteroTreeDup().

AST antlr.ASTFactory.dupTree ( AST t )

Duplicate a tree, assuming this is a root node of a tree-- duplicate that node and what's below; ignore siblings of root node.

References antlr.collections.AST.getFirstChild(), and antlr.collections.AST.setFirstChild().

void antlr.ASTFactory.error ( String e )

To change where error messages go, can subclass/override this method and then setASTFactory in Parser and TreeParser. This method removes a prior dependency on class antlr.Tool.

Class antlr.ASTFactory.getASTNodeType ( int tokenType )

For a given token type, what is the AST node object type to create for it?

Since:: 2.7.2

References antlr.ASTFactory.theASTNodeTypeClass, and antlr.ASTFactory.tokenTypeToASTClassMap.

Referenced by antlr.ASTFactory.create().

Hashtable antlr.ASTFactory.getTokenTypeToASTClassMap ( )

AST antlr.ASTFactory.make ( AST[] nodes )

Make a tree from a list of nodes. The first element in the array is the root. If the root is null, then the tree is a simple list not a tree. Handles null children nodes correctly. For example, build(a, b, null, c) yields tree (a b c). build(null,a,b) yields tree (nil a b).

References antlr.collections.AST.getFirstChild(), antlr.collections.AST.getNextSibling(), antlr.collections.AST.setFirstChild(), and antlr.collections.AST.setNextSibling().

Referenced by PascalParser.constant(), PascalParser.constList(), PascalParser.fieldList(), PascalParser.functionDesignator(), PascalParser.identifierList(), PascalParser.parameterGroup(), PascalParser.parameterList(), PascalParser.procedureStatement(), PascalParser.recordSection(), PascalParser.statements(), PascalParser.tag(), TestASTFactory.testHeteroTreeDup(), and PascalParser.typeList().

AST antlr.ASTFactory.make ( ASTArray nodes )

Make a tree from a list of nodes, where the nodes are contained in an ASTArray object

References antlr.collections.impl.ASTArray.array.

void antlr.ASTFactory.makeASTRoot	(	ASTPair	currentAST,
		AST	root
	)

Make an AST the root of current AST

References antlr.collections.AST.addChild(), antlr.ASTPair.advanceChildToEnd(), antlr.ASTPair.child, and antlr.ASTPair.root.

void antlr.ASTFactory.setASTNodeClass ( String t )

void antlr.ASTFactory.setASTNodeClass ( Class c )

void antlr.ASTFactory.setASTNodeType ( String t )

Specify the type of node to create during tree building.

Deprecated:: since 2.7.1

Referenced by antlr.TreeParser.setASTNodeClass(), antlr.Parser.setASTNodeClass(), and TestASTFactory.testSpecificHomoCreate().

void antlr.ASTFactory.setTokenTypeASTNodeType	(	int	tokenType,
		String	className
	)			throws IllegalArgumentException

Specify an "override" for the Java AST object created for a specific token. It is provided as a convenience so you can specify node types dynamically. ANTLR sets the token type mapping automatically from the tokens{...} section, but you can change that mapping with this method. ANTLR does it's best to statically determine the node type for generating parsers, but it cannot deal with dynamic values like #[LT(1)]. In this case, it relies on the mapping. Beware differences in the tokens{...} section and what you set via this method. Make sure they are the same.

Set className to null to remove the mapping.

Since:: 2.7.2

References antlr.ASTFactory.tokenTypeToASTClassMap.

Referenced by TestASTFactory.testDynamicHeteroCreate().

void antlr.ASTFactory.setTokenTypeToASTClassMap ( Hashtable tokenTypeToClassMap )

Referenced by antlr.ASTFactory.ASTFactory().

Member Data Documentation

String antlr.ASTFactory.theASTNodeType = null [protected]

Name of AST class to create during tree construction. Null implies that the create method should create a default AST type such as CommonAST. This is for homogeneous nodes.

Class antlr.ASTFactory.theASTNodeTypeClass = null [protected]

Referenced by antlr.ASTFactory.getASTNodeType().

Hashtable antlr.ASTFactory.tokenTypeToASTClassMap = null [protected]

How to specify the classname to create for a particular token type. Note that ANTLR allows you to say, for example,

tokens { PLUS<AST=PLUSNode>; ... }

and it tracks everything statically. #[PLUS] will make you a PLUSNode w/o use of this table.

For tokens that ANTLR cannot track statically like #[i], you can use this table to map PLUS (Integer) -> PLUSNode (Class) etc... ANTLR sets the class map from the tokens {...} section via the ASTFactory(Hashtable) ctor in antlr.Parser.

Referenced by antlr.ASTFactory.getASTNodeType(), and antlr.ASTFactory.setTokenTypeASTNodeType().

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

ASTFactory.java

antlr.ASTFactory Class Reference

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation