org.apache.flex.compiler.internal.tree.as

Class NodeBase

java.lang.Object

org.apache.flex.compiler.common.SourceLocation

org.apache.flex.compiler.internal.tree.as.NodeBase

All Implemented Interfaces:

ISourceLocation, IASNode

Direct Known Subclasses:

FixedChildrenNode, InstructionListNode, MXMLNodeBase, TreeNode

public abstract class NodeBase
extends SourceLocation
implements IASNode

Base class for ActionScript parse tree nodes

Field Summary

Fields

Modifier and Type	Field and Description
protected static IASNode[]	emptyNodeArray Used in calls to CheapArray functions.
protected IASNode	parent Parent node.

Fields inherited from interface org.apache.flex.compiler.common.ISourceLocation

UNKNOWN

Constructor Summary

Constructors

Constructor and Description
NodeBase() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	analyze(EnumSet<PostProcessStep> set, ASScope scope, Collection<ICompilerProblem> problems)
protected boolean	buildInnerString(StringBuilder sb) For debugging only.
void	buildStringRecursive(StringBuilder sb, int level, boolean skipSrcPath) For debugging only.
protected boolean	canContinueContainmentSearch(IASNode containingNode, IASNode currentNode, int childOffset, boolean offsetsStillValid)
void	collectImportNodes(Collection<IImportNode> importNodes) Collects the import nodes that are descendants of this node but which are not contained within a scoped node.
static String[]	combineAttributes(String[] superAttributes, String[] myAttributes) Combine the attributes from the base class with the attributes specific to this class
protected void	connectedToProjectScope() Allow various subclasses to do special kludgy things like identify mx.core.Application.application
boolean	contains(int offset) Determine whether the offset fits within this node.
void	endAfter(ISourceLocation location) Set the end offset of the node to fall just after the token.
void	endAfter(antlr.Token token) Set the end offset of the node to fall just after the token.
void	endBefore(ISourceLocation location) Set the end offset of the node to fall just before the token.
void	endBefore(antlr.Token token) Set the end offset of the node to fall just before the token.
protected void	fillInOffsets() If the start and end offsets haven't been set explicitly, fill them in based on the offsets of the children.
int	getAbsoluteEnd() Gets the absolute starting offset.
int	getAbsoluteStart() Gets the absolute starting offset.
IASNode	getAncestorOfType(Class<? extends IASNode> nodeType) Get the nearest ancestor of this node that has the specified type.
ASScope	getASScope() Get the scope this Node uses for name resolution as an ASScope.
IASNode	getChild(int i) Get a particular child of this node
int	getChildCount() Get the number of children
String	getContainingFilePath() Get the path of the file in which this parse tree node resides.
IASNode	getContainingNode(int offset) Gets the child node that contains the offset
IScopedNode	getContainingScope() Gets the containing scope for this node
int	getEnd() Get the node's local end offset.
ASFileScope	getFileScope()
IFileSpecification	getFileSpecification() Get the IFileSpecification that produced this node
String	getInnerString() For debugging only.
String	getNodeKind() Get the node type as a string.
String	getPackageName() Get package name that applies to this node.
IASNode	getParent() Get the parent of this node
IScopedNode	getScopeNode() Get the nearest containing scope for this node.
int	getSpanningStart() Gets the local offset where the node starts, including any extra items that may change the appearance of the node's start.
int	getStart() Get the node's local start offset.
IASNode	getSucceedingNode(int offset) Get the first node that succeeds the offset (i.e. which starts after the offset).
IWorkspace	getWorkspace() Get's the IWorkspace in which this NodeBase lives.
boolean	isTerminal() Determines if this node is a terminal node, meaning it cannot have children
boolean	isTransparent() Determine whether this node is transparent.
boolean	looselyContains(int offset) Determine whether the offset "loosely" fits within this node.
void	normalize(boolean fillInOffsets) Normalize the tree.
protected void	replaceChild(NodeBase child, NodeBase target) Replaces the child with the given target.
Collection<ICompilerProblem>	runPostProcess(EnumSet<PostProcessStep> set, ASScope containingScope)
protected void	setChildren(boolean fillInOffsets) If this node has custom children (names, arguments, etc), shove them into the list of children.
void	setParent(NodeBase parent) Set the parent node.
void	span(int start, int end, int line, int column) Set the start and end offsets of the node.
void	span(antlr.Token token) Set the start and end offsets of the node to coincide with the token's offsets.
void	span(antlr.Token firstToken, antlr.Token lastToken) Set the start and end offsets of the node to coincide with the tokens' offsets.
void	startAfter(ISourceLocation location) Set the start offset of the node to fall just after the token.
void	startAfter(antlr.Token token) Set the start offset of the node to fall just after the token.
void	startBefore(ISourceLocation location) Set the start offset of the node to fall just before the token.
void	startBefore(antlr.Token token) Set the start offset of the node to fall just before the token.
protected void	swapChildren(NodeBase child, NodeBase target) Changes the position of two children in our tree.
String	toString() For debugging only.
protected OffsetLookup	tryGetOffsetLookup()
boolean	verify() Used only in asserts.

Methods inherited from class org.apache.flex.compiler.common.SourceLocation

getColumn, getEndColumn, getEndLine, getLine, getLineColumnString, getOffsetsString, getSourcePath, getSourcePathString, setColumn, setEnd, setEndColumn, setEndLine, setLine, setSourceLocation, setSourcePath, setStart, span, span

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flex.compiler.tree.as.IASNode

getNodeID

Methods inherited from interface org.apache.flex.compiler.common.ISourceLocation

getColumn, getEndColumn, getEndLine, getLine, getSourcePath

Field Detail

emptyNodeArray

protected static final IASNode[] emptyNodeArray

Used in calls to CheapArray functions. It represents the type of objects that appear in fSymbols.

parent

protected IASNode parent

Parent node.

Methods (even in NodeBase itself) should use getParent() instead of accessing this member directly. getParent() is overridden in FileNode to do something special when the FileNode represents a shared file.

Constructor Detail

NodeBase

public NodeBase()

Constructor.

Method Detail

combineAttributes

public static String[] combineAttributes(String[] superAttributes,
                         String[] myAttributes)

Combine the attributes from the base class with the attributes specific to this class

Parameters:

superAttributes - The attributes of the base class.

myAttributes - The attributes of this class.

Returns:

attribute value

getParent

public IASNode getParent()

Description copied from interface: IASNode

Get the parent of this node

Specified by:

getParent in interface IASNode

Returns:

the parent of this node

getChildCount

public int getChildCount()

Description copied from interface: IASNode

Get the number of children

Specified by:

getChildCount in interface IASNode

Returns:

the number of children

getChild

public IASNode getChild(int i)

Description copied from interface: IASNode

Get a particular child of this node

Specified by:

getChild in interface IASNode

Parameters:

i - the child's index

Returns:

the specified child

getFileSpecification

public IFileSpecification getFileSpecification()

Description copied from interface: IASNode

Get the IFileSpecification that produced this node

Specified by:

getFileSpecification in interface IASNode

Returns:

the source of this node

getSpanningStart

public int getSpanningStart()

Description copied from interface: IASNode

Gets the local offset where the node starts, including any extra items that may change the appearance of the node's start. These can include namespaces, keywords, modifiers, etc

Specified by:

getSpanningStart in interface IASNode

Returns:

the start of the span

getNodeKind

public String getNodeKind()

Get the node type as a string. For example, this will return "IdentifierNode" for an IdentifierNode.

Returns:

the node type

contains

public boolean contains(int offset)

Description copied from interface: IASNode

Determine whether the offset fits within this node.

Specified by:

contains in interface IASNode

Parameters:

offset - the offset to test

Returns:

true if the offset is contained within this node

looselyContains

public boolean looselyContains(int offset)

Determine whether the offset "loosely" fits within this node. With normal nodes, this will return true if the offset matches fLocation.fStart or fLocation.fEnd or anything in between. With bogus nodes (which have fStart == fEnd), this will return true if the offset comes after fStart and before any other nodes in the parse tree

Parameters:

offset - the offset to test

Returns:

true if the offset is "loosely" contained within this node

getSucceedingNode

public IASNode getSucceedingNode(int offset)

Description copied from interface: IASNode

Get the first node that succeeds the offset (i.e. which starts after the offset).

Specified by:

getSucceedingNode in interface IASNode

Parameters:

offset - the offset for which to search

Returns:

the most general node that starts after the offset (or null, if the offset isn't contained within this node)

isTransparent

public boolean isTransparent()

Determine whether this node is transparent. If a node is transparent, it can never be returned from getContainingNode... the offset will be considered part of the parent node instead.

Returns:

true if the node is transparent

getContainingNode

public IASNode getContainingNode(int offset)

Description copied from interface: IASNode

Gets the child node that contains the offset

Specified by:

getContainingNode in interface IASNode

Parameters:

offset - an offest

Returns:

an IASNode or null

isTerminal

public boolean isTerminal()

Description copied from interface: IASNode

Determines if this node is a terminal node, meaning it cannot have children

Specified by:

isTerminal in interface IASNode

Returns:

true if this node is terminal

getContainingScope

public IScopedNode getContainingScope()

Description copied from interface: IASNode

Gets the containing scope for this node

Specified by:

getContainingScope in interface IASNode

Returns:

the current IScopedNode

canContinueContainmentSearch

protected boolean canContinueContainmentSearch(IASNode containingNode,
                                   IASNode currentNode,
                                   int childOffset,
                                   boolean offsetsStillValid)

getAncestorOfType

public IASNode getAncestorOfType(Class<? extends IASNode> nodeType)

Description copied from interface: IASNode

Get the nearest ancestor of this node that has the specified type.

Specified by:

getAncestorOfType in interface IASNode

Parameters:

nodeType - the node type for which to search

Returns:

the nearest ancestor that has the specified type (null if no such node exists)

getPackageName

public String getPackageName()

Description copied from interface: IASNode

Get package name that applies to this node. If this node doesn't reside inside a package definition, this method will return null.

Specified by:

getPackageName in interface IASNode

Returns:

String containing fully-qualified package name

startAfter

public void startAfter(antlr.Token token)

Set the start offset of the node to fall just after the token. Used during parsing.

Parameters:

token - start this node after this token

startAfter

public final void startAfter(ISourceLocation location)

Set the start offset of the node to fall just after the token. Used during parsing.

Parameters:

location - start this node after this token

startBefore

public final void startBefore(antlr.Token token)

Set the start offset of the node to fall just before the token. Used during parsing.

Parameters:

token - start this node before this token

startBefore

public final void startBefore(ISourceLocation location)

Set the start offset of the node to fall just before the token. Used during parsing.

Parameters:

location - start this node before this token

endAfter

public final void endAfter(antlr.Token token)

Set the end offset of the node to fall just after the token. Used during parsing.

Parameters:

token - end this node after this token

endAfter

public final void endAfter(ISourceLocation location)

Set the end offset of the node to fall just after the token. Used during parsing.

Parameters:

location - end this node after this token

endBefore

public final void endBefore(antlr.Token token)

Set the end offset of the node to fall just before the token. Used during parsing.

Parameters:

token - start this node before this token

endBefore

public final void endBefore(ISourceLocation location)

Set the end offset of the node to fall just before the token. Used during parsing.

Parameters:

location - start this node before this token

span

public final void span(antlr.Token token)

Set the start and end offsets of the node to coincide with the token's offsets. Used during parsing.

Parameters:

token - the token to take the offsets from

span

public final void span(antlr.Token firstToken,
        antlr.Token lastToken)

Set the start and end offsets of the node to coincide with the tokens' offsets. Used during parsing.

Parameters:

firstToken - the token to take the start offset and line number from

lastToken - the token to take the end offset from

span

public final void span(int start,
        int end,
        int line,
        int column)

Set the start and end offsets of the node. Used during parsing.

Parameters:

start - start offset for the node

end - end offset for the node

line - line number for the node

runPostProcess

public Collection<ICompilerProblem> runPostProcess(EnumSet<PostProcessStep> set,
                                          ASScope containingScope)

analyze

protected void analyze(EnumSet<PostProcessStep> set,
           ASScope scope,
           Collection<ICompilerProblem> problems)

swapChildren

protected void swapChildren(NodeBase child,
                NodeBase target)

Changes the position of two children in our tree. Neither child can be null and both must have the same parent

Parameters:

child - the child to replace target

target - the child to replace child

replaceChild

protected void replaceChild(NodeBase child,
                NodeBase target)

Replaces the child with the given target. The child will be removed from the tree, and its parentage will be updated

Parameters:

child - the NodeBase to replace

target - the NodeBase to replace the replaced

normalize

public void normalize(boolean fillInOffsets)

Normalize the tree. Move custom children into the real child list and fill in missing offsets so that offset lookup will work. Used during parsing.

connectedToProjectScope

protected void connectedToProjectScope()

Allow various subclasses to do special kludgy things like identify mx.core.Application.application

setChildren

protected void setChildren(boolean fillInOffsets)

If this node has custom children (names, arguments, etc), shove them into the list of children. Used during parsing.

fillInOffsets

protected void fillInOffsets()

If the start and end offsets haven't been set explicitly, fill them in based on the offsets of the children. Used during parsing. If the end offset is less than any of the kids' offsets, change fLocation.fEnd to encompass kids.

setParent

public void setParent(NodeBase parent)

Set the parent node. Used during parsing.

Parameters:

parent - parent node

getScopeNode

public IScopedNode getScopeNode()

Get the nearest containing scope for this node. Used during type decoration.

Returns:

nearest containing scope for this node

getContainingFilePath

public String getContainingFilePath()

Get the path of the file in which this parse tree node resides.

The tree builder can set a node's origin source file using SourceLocation.setSourcePath(String). If the source path was set, return the source path; Otherwise, use root FileNode's path.

Returns:

file path that contains this node

toString

public final String toString()

For debugging only. Displays this node and its children in a form like this:

 FileNode "D:\tests\UIComponent.as" 0:0 0-467464  D:\tests\UIComponent.as
   PackageNode "mx.core" 12:1 436-465667 D:\tests\UIComponent.as
     FullNameNode "mx.core" 0:0 444-451 null
       IdentifierNode "mx" 12:9 444-446 D:\tests\UIComponent.as
       IdentifierNode "core" 12:12 447-451 D:\tests\UIComponent.as
     ScopedBlockNode 13:1 454-465667 D:\tests\UIComponent.as
       ImportNode "flash.accessibility.Accessibility" 14:1 457-497 D:\tests\UIComponent.as
       FullNameNode "flash.accessibility.Accessibility" 0:0 464-497 null
         FullNameNode "flash.accessibility" 0:0 464-483 null
           IdentifierNode "flash" 14:8 464-469 D:\tests\UIComponent.as
           IdentifierNode "accessibility" 14:14 470-483 D:\tests\UIComponent.as
         IdentifierNode "Accessibility" 14:28 484-497 D:\tests\UIComponent.as
       ...
 

Subclasses may not override this, because we want to maintain regularity for how all nodes display.

Overrides:

toString in class SourceLocation

buildStringRecursive

public void buildStringRecursive(StringBuilder sb,
                        int level,
                        boolean skipSrcPath)

For debugging only. Called by toString(), and recursively by itself, to display this node on one line and each descendant node on subsequent indented lines. *

buildInnerString

protected boolean buildInnerString(StringBuilder sb)

For debugging only. This method is called by buildOuterString(). It is overridden by subclasses to display optional node-specific information in the middle of the string, between the node type and the location information.

getInnerString

public String getInnerString()

For debugging only.

getFileScope

public ASFileScope getFileScope()

tryGetOffsetLookup

protected final OffsetLookup tryGetOffsetLookup()

Returns:

OffsetLookup object for the current tree or null.

getWorkspace

public IWorkspace getWorkspace()

Get's the IWorkspace in which this NodeBase lives.

Returns:

The IWorkspace in which this NodeBase lives.

getASScope

public ASScope getASScope()

Get the scope this Node uses for name resolution as an ASScope.

Returns:

the ASScope for this node, or null if there isn't one.

getStart

public int getStart()

Get the node's local start offset.

Specified by:

getStart in interface ISourceLocation

Overrides:

getStart in class SourceLocation

Returns:

The local start offset

getEnd

public int getEnd()

Get the node's local end offset.

Specified by:

getEnd in interface ISourceLocation

Overrides:

getEnd in class SourceLocation

Returns:

The local end offset.

getAbsoluteStart

public int getAbsoluteStart()

Description copied from interface: ISourceLocation

Gets the absolute starting offset. It is zero-based.

Specified by:

getAbsoluteStart in interface ISourceLocation

Overrides:

getAbsoluteStart in class SourceLocation

Returns:

The node's absolute start offset.

getAbsoluteEnd

public int getAbsoluteEnd()

Description copied from interface: ISourceLocation

Gets the absolute starting offset. It is zero-based.

Specified by:

getAbsoluteEnd in interface ISourceLocation

Overrides:

getAbsoluteEnd in class SourceLocation

Returns:

The node's absolute end offset.

collectImportNodes

public void collectImportNodes(Collection<IImportNode> importNodes)

Collects the import nodes that are descendants of this node but which are not contained within a scoped node.

This is a helper method for IScopedNode.getAllImportNodes(java.util.Collection<org.apache.flex.compiler.tree.as.IImportNode>)(). Since that method walks up the chain of scoped nodes, we don't want to look inside scoped nodes that were already processed.

Parameters:

importNodes - The collection of import nodes being built.

verify

public boolean verify()

Used only in asserts.