com.goldencode.expr

Class ExtraAst

java.lang.Object

antlr.BaseAST

antlr.CommonAST

com.goldencode.expr.ExtraAst

All Implemented Interfaces:

antlr.collections.AST, java.io.Serializable

public class ExtraAst
extends antlr.CommonAST

A modified abstract syntax tree node which provides an additional service for storing a single object reference of the user's choosing. In addition, basic support for line and column number is available.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private int	column Source file column number associated with this AST
private java.lang.Object	extra Extra, user-defined object reference associated with this node.
private int	id Identifier which is unique to this node within an expression AST
private int	line Source file line number associated with this AST
private java.lang.Class	operandType Common operand type associated with this node (certain operators only).

Fields inherited from class antlr.BaseAST

down, right

Constructor Summary

Constructors

Constructor and Description
ExtraAst() Default constructor.
ExtraAst(antlr.Token token) Constructor which accepts and wrappers token.

Method Summary

Modifier and Type	Method and Description
java.lang.String	dumpTree() Dumps the tree represented by this node.
private void	dumpTreeImpl(java.lang.StringBuilder sb, java.lang.String indent) The implementation of the dump-tree method.
private void	extractTokenData(antlr.Token token) Extract token type, line number, and column information from a token and store this information as member data.
int	getColumn() Get the source code column number which designates where in the source code file the token wrappered by this node was found.
java.lang.Object	getExtra() Retrieve this AST's associated object reference.
int	getId() Get this AST node's identifier.
int	getLine() Get the source code line number which designates where in the source code file the token wrappered by this node was found.
java.lang.Class	getOperandType() Retrieve this AST's associated operand type.
void	initialize(antlr.collections.AST ast) Initialize this node with the specified AST.
void	initialize(antlr.Token token) Initialize this node with the specified token.
void	setExtra(java.lang.Object extra) Set this AST's associated object reference.
void	setId(int id) Set this AST node's identifier.
void	setOperandType(java.lang.Class type) Set this AST's associated operand type.

Methods inherited from class antlr.CommonAST

getText, getType, initialize, setText, setType

Methods inherited from class antlr.BaseAST

addChild, decode, encode, equals, equalsList, equalsListPartial, equalsTree, equalsTreePartial, findAll, findAllPartial, getFirstChild, getNextSibling, getNumberOfChildren, getTokenNames, removeChildren, setFirstChild, setNextSibling, setVerboseStringConversion, toString, toStringList, toStringTree, xmlSerialize, xmlSerializeNode, xmlSerializeRootClose, xmlSerializeRootOpen

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

extra

private java.lang.Object extra

Extra, user-defined object reference associated with this node.

operandType

private java.lang.Class operandType

Common operand type associated with this node (certain operators only).

line

private int line

Source file line number associated with this AST

column

private int column

Source file column number associated with this AST

id

private int id

Identifier which is unique to this node within an expression AST

Constructor Detail

ExtraAst

public ExtraAst()

Default constructor.

ExtraAst

public ExtraAst(antlr.Token token)

Constructor which accepts and wrappers token.

Parameters:

token - Token upon which this node is based.

Method Detail

getId

public int getId()

Get this AST node's identifier. This will be unique within an expression's syntax tree.

Returns:

Unique identifier for this node.

setId

public void setId(int id)

Set this AST node's identifier. This will be unique within an expression's syntax tree.

Parameters:

id - Unique identifier for this node.

getExtra

public java.lang.Object getExtra()

Retrieve this AST's associated object reference.

Returns:

The associated object reference or null if no reference has been assigned.

setExtra

public void setExtra(java.lang.Object extra)

Set this AST's associated object reference.

Parameters:

extra - The associated object reference or null if the reference should be removed.

getOperandType

public java.lang.Class getOperandType()

Retrieve this AST's associated operand type.

Returns:

The associated operand type or null if the reference should be removed.

setOperandType

public void setOperandType(java.lang.Class type)

Set this AST's associated operand type.

Parameters:

type - The associated operand type or null if the reference should be removed.

initialize

public void initialize(antlr.collections.AST ast)

Initialize this node with the specified AST. Delegates to the superclass and copies data from ast.

Specified by:

initialize in interface antlr.collections.AST

Overrides:

initialize in class antlr.CommonAST

Parameters:

ast - AST upon which this node is based. Expected to be an instance of ExtraAst.

initialize

public void initialize(antlr.Token token)

Initialize this node with the specified token. Delegates to the superclass and extracts data from token for later use in line number and column queries.

Specified by:

initialize in interface antlr.collections.AST

Overrides:

initialize in class antlr.CommonAST

Parameters:

token - Token upon which this node is based.

getLine

public int getLine()

Get the source code line number which designates where in the source code file the token wrappered by this node was found. This will always return 0 for an artificially manufactured AST (i.e., one not generated by a parser).

Specified by:

getLine in interface antlr.collections.AST

Overrides:

getLine in class antlr.BaseAST

Returns:

Source file line number where the token underlying this AST was found, or 0 for an artifical AST.

See Also:

getColumn()

getColumn

public int getColumn()

Get the source code column number which designates where in the source code file the token wrappered by this node was found. This will always return 0 for an artificially manufactured AST (i.e., one not generated by a parser).

Specified by:

getColumn in interface antlr.collections.AST

Overrides:

getColumn in class antlr.BaseAST

Returns:

Column number within a specific source code line, indicating where the token underlying this AST was found, or 0 for an artificial AST.

See Also:

getLine()

extractTokenData

private void extractTokenData(antlr.Token token)

Extract token type, line number, and column information from a token and store this information as member data.

Parameters:

token - Token from which information is to be extracted.

dumpTree

public java.lang.String dumpTree()

Dumps the tree represented by this node. Used for debugging. In the resulting string the current node is at le leftmost position and, as the position of the node is lower, the indentation increases. The information about each node is composed by:

1. the node's text (in original casing);
2. the node's type (in uppercase, between square brackets);
3. the node's position (line an column), after the @.

If needed, the id and extra fields can also be added.

Returns:

A string representation of the AST tree having the root at this node.

dumpTreeImpl

private void dumpTreeImpl(java.lang.StringBuilder sb,
                          java.lang.String indent)

The implementation of the dump-tree method. this recursively visit all sub-nodes and creates a character visual representation of the node.

Parameters:

sb - The StringBuilder used to compose the result.

indent - The indentation for current node.