org.apache.flex.compiler.tree.as

Interface IFunctionNode

All Superinterfaces:

IASNode, IDefinitionNode, IDocumentableDefinitionNode, IScopedDefinitionNode, ISourceLocation

All Known Subinterfaces:

IAccessorNode, IGetterNode, ISetterNode

All Known Implementing Classes:

AccessorNode, FunctionNode, GetterNode, SetterNode

public interface IFunctionNode
extends IScopedDefinitionNode, IDocumentableDefinitionNode

An AST node representing a function declaration, either for a regular function, a getter, or a setter.

The shape of this node is:

 IFunctionNode
   IMetaTagsNode            <-- getMetaTagsNode()
   INamespaceDecorationNode <-- getNamespaceNode()
   IKeywordNode             <-- getKeywordNode()
   IKeywordNode             <-- getAccessorKeywordNode()
   IExpressionNode          <-- getNameExpressionNode()
   IContainerNode           <-- getParametersContainerNode()
   IExpressionNode          <-- getReturnTypeNode()
   IScopedNode              <-- getScopedNode()
 

For example,

 [Foo]
 [Bar]
 public function f(i:int, j:int = 0):void
 {
     ...
 }
 

is represented as

 IVariableNode
   IMetaTagsNode
     IMetaTagNode "Foo"
     IMetaTagNode "Bar"
   INamespaceDecorationNode "public"
   IKeywordNode "function"
   IIdentifierNode "f"
   IContainerNode
     IParameterNode
       IIdentifierNode "a"
       IIdentifierNode "*"
     IParameterNode
       IIdentifierNode "b"
       IIdentifierNode "int"
       INumericLiteralNode 0
    IIdentifierNode "void"
   IScopedNode
     ...
 

If there is no metadata, the corresponding child node is not present.

If there is no namespace, the corresponding child node is not present.

For a getter or setter, there are two child nodes which are IKeywordNode, one for "function" and one for "get" or "set". For a plain function, the second keyword node is not present.

If there are no parameters, there is an empty child IContainerNode.

If there is no return type, the corresponding child node is not present.

Field Summary

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

UNKNOWN

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsLocalFunctions() Does this function have a local functions within
IFunctionDefinition	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)
List<IFunctionNode>	getLocalFunctions() Get local functions within
IParameterNode[]	getParameterNodes() Get the parameters of this function as an array of IParameterNode elements
IContainerNode	getParametersContainerNode() Returns the container for parameters of this function
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
boolean	hasBody() Does this function have a non-empty body
boolean	isCastFunction() Is this a cast function?
boolean	isConstructor() Is this a constructor?
boolean	isGetter() Is this function a getter?
boolean	isSetter() Is this function a setter?
void	rememberLocalFunction(IFunctionNode localFunction) Remember local Functions in this function node().
void	setEmittingLocalFunctions(boolean emit) flag to determine whether to emit the local function or a reference to it

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

getScopedNode

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, getNamespace, getNameStart, getPackageName, getQualifiedName, getShortName, hasModifier, hasNamespace, isImplicit

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

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

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

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

Method Detail

getParameterNodes

IParameterNode[] getParameterNodes()

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

Returns:

the parameters of this function

getParametersContainerNode

IContainerNode getParametersContainerNode()

Returns the container for parameters of this function

getReturnType

String getReturnType()

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

Returns:

type of function as seen in source

getReturnTypeNode

IExpressionNode getReturnTypeNode()

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

Returns:

an IExpressionNode or null

isConstructor

boolean isConstructor()

Is this a constructor?

Returns:

true if the member is a constructor

isCastFunction

boolean isCastFunction()

Is this a cast function?

Returns:

true if the member is a cast function

getFunctionClassification

IFunctionDefinition.FunctionClassification getFunctionClassification()

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

Returns:

function classification

isGetter

boolean isGetter()

Is this function a getter?

Returns:

true if the function is a getter

isSetter

boolean isSetter()

Is this function a setter?

Returns:

true if the function is a setter

getDefinition

IFunctionDefinition getDefinition()

Specified by:

getDefinition in interface IDefinitionNode

hasBody

boolean hasBody()

Does this function have a non-empty body

containsLocalFunctions

boolean containsLocalFunctions()

Does this function have a local functions within

getLocalFunctions

List<IFunctionNode> getLocalFunctions()

Get local functions within

rememberLocalFunction

void rememberLocalFunction(IFunctionNode localFunction)

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

getEmittingLocalFunctions

boolean getEmittingLocalFunctions()

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

setEmittingLocalFunctions

void setEmittingLocalFunctions(boolean emit)

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