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

Class FunctionNode

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

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

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

All Implemented Interfaces:

ISourceLocation, IASNode, IDefinitionNode, IDocumentableDefinitionNode, IFunctionNode, IScopedDefinitionNode, ITypedNode

Direct Known Subclasses:

AccessorNode

public class FunctionNode
extends BaseTypedDefinitionNode
implements IFunctionNode

ActionScript parse tree node representing a function definition

Field Summary

Fields

Modifier and Type	Field and Description
protected IFunctionContentsPart	contentsPart Contents of the function, including args, etc

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

typeNode, typeOperatorStart

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

definition, nameNode

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
FunctionNode(IASToken functionKeyword, IdentifierNode nameNode) Constructor.
FunctionNode(IdentifierNode node, IFunctionContentsPart part) 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.
boolean	containsLocalFunctions() Does this function have a local functions within
protected IFunctionContentsPart	createContentsPart()
protected FunctionDefinition	createFunctionDefinition(String name) Method to create the correct Definition class - needed so we can create different Definition types for getters, setters, and plain old functions
void	discardFunctionBody() Delete all children nodes in a function body.
INamespaceDecorationNode	getActualNamespaceNode() Get the real namespace node, or null if there isn't one.
FunctionDefinition	getDefinition()
boolean	getEmittingLocalFunctions() flag to determine whether to emit the local function or a reference to it
IFunctionDefinition.FunctionClassification	getFunctionClassification() Get the classification for this function (local, argument, class member, etc)
KeywordNode	getFunctionKeywordNode() Get the function keyword
protected int	getInitialChildCount() Take a guess as to an efficient initial child count.
List<IFunctionNode>	getLocalFunctions() Get local functions within
String	getNamespace() Returns the namespace that this member belongs to
INamespaceDecorationNode	getNamespaceNode()
ASTNodeID	getNodeID() Get the opcode of this node
IParameterNode[]	getParameterNodes() Get the parameters of this function as an array of IParameterNode elements
ContainerNode	getParametersContainerNode() Returns the container for parameters of this function
Collection<ICompilerProblem>	getParsingProblems() Get any saved parsing problems from lazily parsing the function body.
String	getQualifiedName() Get the qualified name of this type
String	getReturnType() Returns the type of this function as it exist in source.
IExpressionNode	getReturnTypeNode() Returns the IExpressionNode that corresponds to the return type node of this IFunctionNode
ScopedBlockNode	getScopedNode() Returns the scope that is contained with this definition.
String	getShortName() Get the short name of this type (without any package information)
int	getSpanningStart() Gets the local offset where the node starts, including any extra items that may change the appearance of the node's start.
boolean	hasBeenParsed()
boolean	hasBody() Does this function have a non-empty body
boolean	hasNamespace(String namespace) Is the given namespace present on this definition?
protected void	init(ExpressionNodeBase idNode)
boolean	isCastFunction() Is this a cast function?
boolean	isConstructor() Is this a constructor?
boolean	isConstructorOf(ClassNode classNode) Is this a constructor of the specified class (assumes that this function definition is actually located in the body of the specified class)
boolean	isGetter() Is this function a getter?
boolean	isImplicit() Is this definition an implicit definition that doesn't actually appear in the source file?
boolean	isPackageLevelFunction() Determine whether this is a package-level function (i.e. a function defined in a package, as opposed to a class or some other scope)
boolean	isSetter() Is this function a setter?
void	normalize(boolean fillInOffsets) Normalize the tree.
void	parseFunctionBody(Collection<ICompilerProblem> problems) Build AST for the function body from the buffered function body text.
void	rememberLocalFunction(IFunctionNode value) Remember local Functions in this function node().
protected void	setChildren(boolean fillInOffsets) If this node has custom children (names, arguments, etc), shove them into the list of children.
protected void	setDefinition(IDefinition def)
void	setEmittingLocalFunctions(boolean emit) flag to determine whether to emit the local function or a reference to it
void	setFunctionBodyInfo(ASToken openT, ASToken lastTokenInBody, ConfigProcessor configProcessor, StringBuilder bodyCache) Store the function body text on the function node so that the AST nodes can be rebuilt later.

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

buildBindableGetter, buildBindableSetter, fillinDefinition, getTypeName, getTypeNode, getTypeOperatorEnd, getTypeOperatorStart, hasExplicitType, hasTypeOperator, isAnyType, isVoidType, setType

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

addDecorationChildren, addModifier, createDecorationPart, fillInMetadata, fillInModifiers, fillInNamespaceAndModifiers, getASDocComment, getDecorationPart, getMetaInfos, getMetaTags, getMetaTagsNode, getModifiers, getModifiersContainer, getName, getNameAbsoluteEnd, getNameAbsoluteStart, getNameEnd, getNameExpressionNode, getNameStart, getNodeStartForTooling, hasExplicitComment, hasModifier, setASDocComment, setMetaTags, setModifiersContainer, setNamespace

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

addChild, addChild, addChildInOrder, addChildPostNormalize, addTemporaryChild, getChild, getChildCount, optimizeChildren, removeAllChildren, removeChild, removeTemporaryChild, replaceChild, sortChildren, swapChildren

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

buildStringRecursive, canContinueContainmentSearch, collectImportNodes, combineAttributes, connectedToProjectScope, contains, endAfter, endAfter, endBefore, endBefore, fillInOffsets, getAbsoluteEnd, getAbsoluteStart, getAncestorOfType, getASScope, getContainingFilePath, getContainingNode, getContainingScope, getEnd, getFileScope, getFileSpecification, getInnerString, getNodeKind, getPackageName, getParent, getScopeNode, getStart, getSucceedingNode, getWorkspace, isTerminal, isTransparent, looselyContains, runPostProcess, setParent, 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.IDocumentableDefinitionNode

getASDocComment, hasExplicitComment

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

getContainingFilePath, getMetaInfos, getMetaTags, getName, getNameAbsoluteEnd, getNameAbsoluteStart, getNameEnd, getNameExpressionNode, getNameStart, getPackageName, hasModifier

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

contains, getAncestorOfType, getChild, getChildCount, getContainingNode, getContainingScope, getFileSpecification, getParent, getSucceedingNode, isTerminal

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

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

Field Detail

contentsPart

protected IFunctionContentsPart contentsPart

Contents of the function, including args, etc

Constructor Detail

FunctionNode

public FunctionNode(IASToken functionKeyword,
            IdentifierNode nameNode)

Constructor.

Creates a FunctionNode from the "new" keyword token and the function name node.

Parameters:

functionKeyword - function keyword

nameNode - node containing the name of this function

FunctionNode

public FunctionNode(IdentifierNode node,
            IFunctionContentsPart part)

Constructor.

Creates a new FunctionNode with a custom part for this functions contents.

Parameters:

node - the name of the node

part - the IFunctionContentsPart

Method Detail

getNodeID

public ASTNodeID getNodeID()

Description copied from interface: IASNode

Get the opcode of this node

Specified by:

getNodeID in interface IASNode

Returns:

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

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

Overrides:

getSpanningStart in class BaseDefinitionNode

Returns:

the start of the span

setChildren

protected void setChildren(boolean fillInOffsets)

Description copied from class: NodeBase

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

Overrides:

setChildren in class NodeBase

normalize

public void normalize(boolean fillInOffsets)

Description copied from class: NodeBase

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.

Overrides:

normalize in class BaseDefinitionNode

analyze

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

Overrides:

analyze in class BaseDefinitionNode

buildInnerString

protected boolean buildInnerString(StringBuilder sb)

Description copied from class: NodeBase

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.

Overrides:

buildInnerString in class NodeBase

getInitialChildCount

protected int getInitialChildCount()

Description copied from class: TreeNode

Take a guess as to an efficient initial child count. We can override this in nodes that have a fixed number of children.

Overrides:

getInitialChildCount in class TreeNode

Returns:

initial size to use when creating children

init

protected void init(ExpressionNodeBase idNode)

Overrides:

init in class BaseTypedDefinitionNode

getNamespaceNode

public INamespaceDecorationNode getNamespaceNode()

Overrides:

getNamespaceNode in class BaseDefinitionNode

getNamespace

public String getNamespace()

Description copied from interface: IDefinitionNode

Returns the namespace that this member belongs to

Specified by:

getNamespace in interface IDefinitionNode

Overrides:

getNamespace in class BaseDefinitionNode

Returns:

public, private, protected, internal, custom namespace or null

hasNamespace

public boolean hasNamespace(String namespace)

Description copied from interface: IDefinitionNode

Is the given namespace present on this definition? Namespaces include private, protected, public and internal, plus any custom namespaces available in scope

Specified by:

hasNamespace in interface IDefinitionNode

Overrides:

hasNamespace in class BaseDefinitionNode

Parameters:

namespace - the namespace to check for

Returns:

true if the namespace exists

getDefinition

public FunctionDefinition getDefinition()

Specified by:

getDefinition in interface IDefinitionNode

Specified by:

getDefinition in interface IFunctionNode

Overrides:

getDefinition in class BaseDefinitionNode

setDefinition

protected void setDefinition(IDefinition def)

Overrides:

setDefinition in class BaseDefinitionNode

isImplicit

public boolean isImplicit()

Description copied from interface: IDefinitionNode

Is this definition an implicit definition that doesn't actually appear in the source file? Examples include this, super, default constructors, and cast functions.

Specified by:

isImplicit in interface IDefinitionNode

getQualifiedName

public String getQualifiedName()

Description copied from interface: IDefinitionNode

Get the qualified name of this type

Specified by:

getQualifiedName in interface IDefinitionNode

Returns:

the fully qualified name of this type

getShortName

public String getShortName()

Description copied from interface: IDefinitionNode

Get the short name of this type (without any package information)

Specified by:

getShortName in interface IDefinitionNode

Returns:

the short name of this type (without any package information)

getScopedNode

public final ScopedBlockNode getScopedNode()

Description copied from interface: IScopedDefinitionNode

Returns the scope that is contained with this definition. The scope will contain all the children of this definition

Specified by:

getScopedNode in interface IScopedDefinitionNode

Returns:

the scope within this IDefinitionNode

getFunctionClassification

public IFunctionDefinition.FunctionClassification getFunctionClassification()

Description copied from interface: IFunctionNode

Get the classification for this function (local, argument, class member, etc)

Specified by:

getFunctionClassification in interface IFunctionNode

Returns:

function classification

isGetter

public boolean isGetter()

Description copied from interface: IFunctionNode

Is this function a getter?

Specified by:

isGetter in interface IFunctionNode

Returns:

true if the function is a getter

isSetter

public boolean isSetter()

Description copied from interface: IFunctionNode

Is this function a setter?

Specified by:

isSetter in interface IFunctionNode

Returns:

true if the function is a setter

isConstructor

public boolean isConstructor()

Description copied from interface: IFunctionNode

Is this a constructor?

Specified by:

isConstructor in interface IFunctionNode

Returns:

true if the member is a constructor

isCastFunction

public boolean isCastFunction()

Description copied from interface: IFunctionNode

Is this a cast function?

Specified by:

isCastFunction in interface IFunctionNode

Returns:

true if the member is a cast function

getParametersContainerNode

public ContainerNode getParametersContainerNode()

Description copied from interface: IFunctionNode

Returns the container for parameters of this function

Specified by:

getParametersContainerNode in interface IFunctionNode

getParameterNodes

public IParameterNode[] getParameterNodes()

Description copied from interface: IFunctionNode

Get the parameters of this function as an array of IParameterNode elements

Specified by:

getParameterNodes in interface IFunctionNode

Returns:

the parameters of this function

getReturnTypeNode

public IExpressionNode getReturnTypeNode()

Description copied from interface: IFunctionNode

Returns the IExpressionNode that corresponds to the return type node of this IFunctionNode

Specified by:

getReturnTypeNode in interface IFunctionNode

Returns:

an IExpressionNode or null

getReturnType

public String getReturnType()

Description copied from interface: IFunctionNode

Returns the type of this function as it exist in source. If a function does not have an explicit type, void is returned

Specified by:

getReturnType in interface IFunctionNode

Returns:

type of function as seen in source

hasBody

public boolean hasBody()

Description copied from interface: IFunctionNode

Does this function have a non-empty body

Specified by:

hasBody in interface IFunctionNode

createContentsPart

protected IFunctionContentsPart createContentsPart()

createFunctionDefinition

protected FunctionDefinition createFunctionDefinition(String name)

Method to create the correct Definition class - needed so we can create different Definition types for getters, setters, and plain old functions

Returns:

A Definition object to represent this function

getFunctionKeywordNode

public KeywordNode getFunctionKeywordNode()

Get the function keyword

Returns:

node containing the function keyword

isPackageLevelFunction

public boolean isPackageLevelFunction()

Determine whether this is a package-level function (i.e. a function defined in a package, as opposed to a class or some other scope)

Returns:

true if this is a package-level function

getActualNamespaceNode

public INamespaceDecorationNode getActualNamespaceNode()

Get the real namespace node, or null if there isn't one. Used by semantics. This differs from getNamespaceNode above, as it will not construct an implicit public namespace if one is missing

isConstructorOf

public boolean isConstructorOf(ClassNode classNode)

Is this a constructor of the specified class (assumes that this function definition is actually located in the body of the specified class)

getParsingProblems

public Collection<ICompilerProblem> getParsingProblems()

Get any saved parsing problems from lazily parsing the function body. This list will be nulled out after this method is called, so we don't start leaking parser problems.

Returns:

Collection of problems encountered while parsing the function or an empty list if there were none.

parseFunctionBody

public final void parseFunctionBody(Collection<ICompilerProblem> problems)

Build AST for the function body from the buffered function body text.

Make sure PostProcessStep.POPULATE_SCOPE has been applied to the containing FileNode This method always populate scopes of the rebuilt function node. If the scopes for the containing nodes weren't initialized, the rebuilt scopes can attach itself to it's parent.

discardFunctionBody

public final void discardFunctionBody()

Delete all children nodes in a function body.

hasBeenParsed

public final boolean hasBeenParsed()

setFunctionBodyInfo

public final void setFunctionBodyInfo(ASToken openT,
                       ASToken lastTokenInBody,
                       ConfigProcessor configProcessor,
                       StringBuilder bodyCache)

Store the function body text on the function node so that the AST nodes can be rebuilt later.

getLocalFunctions

public List<IFunctionNode> getLocalFunctions()

Description copied from interface: IFunctionNode

Get local functions within

Specified by:

getLocalFunctions in interface IFunctionNode

containsLocalFunctions

public boolean containsLocalFunctions()

Description copied from interface: IFunctionNode

Does this function have a local functions within

Specified by:

containsLocalFunctions in interface IFunctionNode

rememberLocalFunction

public void rememberLocalFunction(IFunctionNode value)

Description copied from interface: IFunctionNode

Remember local Functions in this function node(). JS codegen needs to know about them.

Specified by:

rememberLocalFunction in interface IFunctionNode

getEmittingLocalFunctions

public boolean getEmittingLocalFunctions()

Description copied from interface: IFunctionNode

flag to determine whether to emit the local function or a reference to it

Specified by:

getEmittingLocalFunctions in interface IFunctionNode

setEmittingLocalFunctions

public void setEmittingLocalFunctions(boolean emit)

Description copied from interface: IFunctionNode

flag to determine whether to emit the local function or a reference to it

Specified by:

setEmittingLocalFunctions in interface IFunctionNode