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

Class FileNode

java.lang.Object

org.apache.flex.compiler.common.SourceLocation

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

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

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

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

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

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

All Implemented Interfaces:

Serializable, ISourceLocation, IASNode, IBlockNode, IContainerNode, IFileNode, IFileNodeAccumulator, IScopedNode

Direct Known Subclasses:

FXGFileNode, ResourceBundleFileNode

public class FileNode
extends ScopedBlockNode
implements Serializable, IFileNode, IFileNodeAccumulator

ActionScript parse tree node representing a file

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flex.compiler.tree.as.IContainerNode

IContainerNode.ContainerType

Field Summary

Fields inherited from class org.apache.flex.compiler.internal.tree.as.ScopedBlockNode

scope

Fields inherited from class org.apache.flex.compiler.internal.tree.as.ContainerNode

EMPTY_CONTAINER

Fields inherited from class org.apache.flex.compiler.internal.tree.as.NodeBase

emptyNodeArray, parent

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

UNKNOWN

Constructor Summary

Constructors

Constructor and Description
FileNode(IFileSpecificationGetter fileSpecGetter) Constructor for a FileNode that does not have a source file associated with it.
FileNode(IFileSpecificationGetter fileSpecGetter, String pathName) Constructor for a FileNode that has a source file associated with it.

Method Summary

Methods

Modifier and Type	Method and Description
void	addDeferredFunctionNode(FunctionNode functionNode) Add a function node whose body contents are deferred.
void	addEmbedNode(IEmbedResolver node) Adds an embed node to the list of embed nodes within this file.
void	addImportNode(IImportNode node) Adds an import node to the list of import nodes within this file.
void	addProblem(ICompilerProblem problem)
void	addRequiredResourceBundle(String bundleName) Adds a Resource Bundle to the set of Resource Bundles that are referenced within this file.
protected void	analyze(EnumSet<PostProcessStep> set, ASScope scope, Collection<ICompilerProblem> problems)
void	collectImportNodes(Collection<IImportNode> importNodes) Collects the import nodes that are descendants of this node but which are not contained within a scoped node.
List<IEmbedResolver>	getEmbedNodes() Returns the list of EmbedNodes
IFileSpecificationGetter	getFileSpecificaitonGetter() Gets the IFileSpecificationGetter for that was used to open included files when this FileNode was parsed.
IFileSpecification	getFileSpecification() Get the IFileSpecification that produced this node
List<IImportNode>	getImportNodes() Returns the list of the ImportNodes
IncludeHandler	getIncludeHandler() Gets the IncludeHandler for this file node.
long	getIncludeTreeLastModified() Returns a last modification timestamp of the current include file tree
ASTNodeID	getNodeID() Get the opcode of this node
OffsetLookup	getOffsetLookup()
Collection<ICompilerProblem>	getProblems() Returns the problems that are contained in this file.
Set<String>	getRequiredResourceBundles()
ITargetAttributes	getTargetAttributes(ICompilerProject project) If this IFileNode can be used as the MXML main application or ActionScript main class, it returns attributes related to SWF target.
IASScope	getTemporaryEnclosingScope(RecursionGuard scopeGuard) Retrieve the temporary enclosing scope (which is used to make an included file look like it's inside the scope where the include statement lives.
IDefinitionNode[]	getTopLevelDefinitionNodes(boolean includeDefinitionsOutsideOfPackage, boolean includeNonPublicDefinitions) Gets definition nodes within this file node that are children of the file node or children of a package block node.
IDefinition[]	getTopLevelDefinitions(boolean includeDefinitionsOutsideOfPackage, boolean includeNonPublicDefinitions) Gets the definitions corresponding to the definitions nodes within this file node that are children of the file node or children of a package block node.
IWorkspace	getWorkspace() Get's the IWorkspace in which this NodeBase lives.
boolean	hasIncludes()
protected void	initializeScope(ASScope containingScope)
void	parseRequiredFunctionBodies() Run through all the deferredFunctionNodes, and if their containing scope isn't file, package or class, it needs to be parsed
void	populateFunctionNodes() Rebuild function body nodes.
void	processAST(EnumSet<PostProcessStep> features)
void	reconnectDefinitions(ASFileScope fileScope)
void	setOffsetLookup(OffsetLookup offsetLookup)
void	setParent(NodeBase parent) Set the parent node.
void	setProblems(Collection<ICompilerProblem> problems)

Methods inherited from class org.apache.flex.compiler.internal.tree.as.ScopedBlockNode

getAllImportNodes, getAllImports, getASScope, getScope, optimizeChildren, runPostProcess, runPostProcess, setScope

Methods inherited from class org.apache.flex.compiler.internal.tree.as.BlockNode

replaceChild

Methods inherited from class org.apache.flex.compiler.internal.tree.as.ContainerNode

addItem, addItemAfterNormalization, addTemporaryItem, buildInnerString, contains, getContainerType, getRemovedConditionalCompileNode, removeItem, removeTemporaryItem, setContainerType, setRemovedConditionalCompileNode

Methods inherited from class org.apache.flex.compiler.internal.tree.as.TreeNode

addChild, addChild, addChildInOrder, addChildPostNormalize, addTemporaryChild, getChild, getChildCount, getInitialChildCount, normalize, removeAllChildren, removeChild, removeTemporaryChild, sortChildren, swapChildren

Methods inherited from class org.apache.flex.compiler.internal.tree.as.NodeBase

buildStringRecursive, canContinueContainmentSearch, combineAttributes, connectedToProjectScope, endAfter, endAfter, endBefore, endBefore, fillInOffsets, getAbsoluteEnd, getAbsoluteStart, getAncestorOfType, getContainingFilePath, getContainingNode, getContainingScope, getEnd, getFileScope, getInnerString, getNodeKind, getPackageName, getParent, getScopeNode, getSpanningStart, getStart, getSucceedingNode, isTerminal, isTransparent, looselyContains, setChildren, span, span, span, startAfter, startAfter, startBefore, startBefore, toString, tryGetOffsetLookup, verify

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

getAllImportNodes, getAllImports, getScope

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

contains, getAncestorOfType, getChild, getChildCount, getContainingNode, getContainingScope, getPackageName, getParent, getSpanningStart, getSucceedingNode, isTerminal

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

getAbsoluteEnd, getAbsoluteStart, getColumn, getEnd, getEndColumn, getEndLine, getLine, getSourcePath, getStart

Constructor Detail

FileNode

public FileNode(IFileSpecificationGetter fileSpecGetter,
        String pathName)

Constructor for a FileNode that has a source file associated with it.

Parameters:

fileSpecGetter - The IFileSpecificationGetter to be used to open included files while parsing the file for this file node.

pathName - The path name of the file for this file node.

FileNode

public FileNode(IFileSpecificationGetter fileSpecGetter)

Constructor for a FileNode that does not have a source file associated with it.

Parameters:

fileSpecGetter - The IFileSpecificationGetter to be used to open included files while parsing this file node.

Method Detail

getNodeID

public ASTNodeID getNodeID()

Description copied from interface: IASNode

Get the opcode of this node

Specified by:

getNodeID in interface IASNode

Overrides:

getNodeID in class BlockNode

Returns:

the opcode - this is one of the constants defined in ASTConstants

getFileSpecification

public IFileSpecification getFileSpecification()

Description copied from interface: IASNode

Get the IFileSpecification that produced this node

Specified by:

getFileSpecification in interface IASNode

Overrides:

getFileSpecification in class NodeBase

Returns:

the source of this node

getWorkspace

public IWorkspace getWorkspace()

Description copied from class: NodeBase

Get's the IWorkspace in which this NodeBase lives.

Overrides:

getWorkspace in class NodeBase

Returns:

The IWorkspace in which this NodeBase lives.

setParent

public void setParent(NodeBase parent)

Description copied from class: NodeBase

Set the parent node. Used during parsing.

Overrides:

setParent in class NodeBase

Parameters:

parent - parent node

analyze

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

Overrides:

analyze in class ScopedBlockNode

collectImportNodes

public void collectImportNodes(Collection<IImportNode> importNodes)

Description copied from class: NodeBase

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.

Overrides:

collectImportNodes in class NodeBase

Parameters:

importNodes - The collection of import nodes being built.

getOffsetLookup

public OffsetLookup getOffsetLookup()

Specified by:

getOffsetLookup in interface IFileNode

Returns:

OffsetLookup object of this file node.

hasIncludes

public boolean hasIncludes()

Specified by:

hasIncludes in interface IFileNode

Returns:

True is this file contains any include statements

getIncludeTreeLastModified

public long getIncludeTreeLastModified()

Description copied from interface: IFileNode

Returns a last modification timestamp of the current include file tree

Specified by:

getIncludeTreeLastModified in interface IFileNode

Returns:

a timestamp

getTopLevelDefinitionNodes

public IDefinitionNode[] getTopLevelDefinitionNodes(boolean includeDefinitionsOutsideOfPackage,
                                           boolean includeNonPublicDefinitions)

Description copied from interface: IFileNode

Gets definition nodes within this file node that are children of the file node or children of a package block node.

Specified by:

getTopLevelDefinitionNodes in interface IFileNode

Parameters:

includeDefinitionsOutsideOfPackage - A flag indicating whether definition nodes that aren't in a package should be included.

includeNonPublicDefinitions - A flag indicating whether definition nodes that don't have a public keyword should be included.

Returns:

An array of IDefinitionNode objects.

getTopLevelDefinitions

public IDefinition[] getTopLevelDefinitions(boolean includeDefinitionsOutsideOfPackage,
                                   boolean includeNonPublicDefinitions)

Description copied from interface: IFileNode

Gets the definitions corresponding to the definitions nodes within this file node that are children of the file node or children of a package block node.

Specified by:

getTopLevelDefinitions in interface IFileNode

Parameters:

includeDefinitionsOutsideOfPackage - A flag indicating whether definitions that aren't in a package should be included.

includeNonPublicDefinitions - A flag indicating whether definitions that don't have a public keyword should be included.

Returns:

An array of IDefinition objects.

getTargetAttributes

public ITargetAttributes getTargetAttributes(ICompilerProject project)

Description copied from interface: IFileNode

If this IFileNode can be used as the MXML main application or ActionScript main class, it returns attributes related to SWF target. Otherwise, this method returns null.

Specified by:

getTargetAttributes in interface IFileNode

Parameters:

project - Context project.

Returns:

Target attributes collected from special MXML attributes or ActionScript metadata tag.

getProblems

public Collection<ICompilerProblem> getProblems()

Description copied from interface: IFileNode

Returns the problems that are contained in this file.

Specified by:

getProblems in interface IFileNode

Returns:

An array of ICompilerProblem objects

addImportNode

public void addImportNode(IImportNode node)

Description copied from interface: IFileNodeAccumulator

Adds an import node to the list of import nodes within this file.

Specified by:

addImportNode in interface IFileNodeAccumulator

Parameters:

node - Node to add

getImportNodes

public List<IImportNode> getImportNodes()

Description copied from interface: IFileNodeAccumulator

Returns the list of the ImportNodes

Specified by:

getImportNodes in interface IFileNodeAccumulator

Returns:

ImportNode list or empty list

addEmbedNode

public void addEmbedNode(IEmbedResolver node)

Description copied from interface: IFileNodeAccumulator

Adds an embed node to the list of embed nodes within this file.

Specified by:

addEmbedNode in interface IFileNodeAccumulator

Parameters:

node - Node to add

getEmbedNodes

public List<IEmbedResolver> getEmbedNodes()

Description copied from interface: IFileNodeAccumulator

Returns the list of EmbedNodes

Specified by:

getEmbedNodes in interface IFileNodeAccumulator

Returns:

IEmbedNode list or empty list

addRequiredResourceBundle

public void addRequiredResourceBundle(String bundleName)

Description copied from interface: IFileNodeAccumulator

Adds a Resource Bundle to the set of Resource Bundles that are referenced within this file. A ResourceBundle stated as required by either using a [ResourceBundle(...)] metadata or a @Resource compiler directive (MXML only).

Specified by:

addRequiredResourceBundle in interface IFileNodeAccumulator

Parameters:

bundleName - name of the Resource Bundle

getRequiredResourceBundles

public Set<String> getRequiredResourceBundles()

Specified by:

getRequiredResourceBundles in interface IFileNodeAccumulator

Returns:

the set of ResourceBundles required for the associated file.

addDeferredFunctionNode

public void addDeferredFunctionNode(FunctionNode functionNode)

Description copied from interface: IFileNodeAccumulator

Add a function node whose body contents are deferred.

Specified by:

addDeferredFunctionNode in interface IFileNodeAccumulator

Parameters:

functionNode - Function node.

populateFunctionNodes

public void populateFunctionNodes()

Description copied from interface: IFileNode

Rebuild function body nodes.

Specified by:

populateFunctionNodes in interface IFileNode

parseRequiredFunctionBodies

public void parseRequiredFunctionBodies()

Run through all the deferredFunctionNodes, and if their containing scope isn't file, package or class, it needs to be parsed

getFileSpecificaitonGetter

public IFileSpecificationGetter getFileSpecificaitonGetter()

Gets the IFileSpecificationGetter for that was used to open included files when this FileNode was parsed.

Returns:

The IFileSpecificationGetter for that was used to open included files when this FileNode was parsed.

setOffsetLookup

public void setOffsetLookup(OffsetLookup offsetLookup)

getIncludeHandler

public IncludeHandler getIncludeHandler()

Gets the IncludeHandler for this file node. The IncludeHandler can be used to get a list of files included by this file.

Returns:

The IncludeHandler for this file node.

getTemporaryEnclosingScope

public IASScope getTemporaryEnclosingScope(RecursionGuard scopeGuard)

Retrieve the temporary enclosing scope (which is used to make an included file look like it's inside the scope where the include statement lives. See Project.connectToIncluder for details.

Returns:

the temporary enclosing scope

processAST

public void processAST(EnumSet<PostProcessStep> features)

reconnectDefinitions

public void reconnectDefinitions(ASFileScope fileScope)

initializeScope

protected void initializeScope(ASScope containingScope)

setProblems

public void setProblems(Collection<ICompilerProblem> problems)

addProblem

public void addProblem(ICompilerProblem problem)