org.apache.flex.compiler.internal.definitions

Class FunctionDefinition

java.lang.Object

org.apache.flex.compiler.internal.definitions.DefinitionBase

org.apache.flex.compiler.internal.definitions.ScopedDefinitionBase

org.apache.flex.compiler.internal.definitions.FunctionDefinition

All Implemented Interfaces:

IDefinition, IDocumentableDefinition, IFunctionDefinition, IScopedDefinition, IDefinitionSet

Direct Known Subclasses:

AccessorDefinition

public class FunctionDefinition
extends ScopedDefinitionBase
implements IFunctionDefinition

Each instance of this class represents the definition of an ActionScript function in the symbol table.

After a function definition is in the symbol table, it should always be accessed through the read-only IFunctionDefinition interface.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flex.compiler.definitions.IFunctionDefinition

IFunctionDefinition.FunctionClassification

Field Summary

Fields inherited from class org.apache.flex.compiler.internal.definitions.DefinitionBase

FLAG_CAST_FUNCTION, FLAG_CONSTRUCTOR, FLAG_CONTINGENT, FLAG_DECLARED_IN_CONTROL_FLOW, FLAG_DEFAULT, FLAG_DEPRECATED, FLAG_DYNAMIC, FLAG_FINAL, FLAG_GENERATED_EMBED_CLASS, FLAG_HAS_INIT, FLAG_IMPLICIT, FLAG_NATIVE, FLAG_OVERRIDE, FLAG_REST, FLAG_STATIC, flags, nodeRef, singletonEmptyMetaTags

Constructor Summary

Constructors

Constructor and Description
FunctionDefinition(String name)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	buildInnerString(StringBuilder sb) For debugging only.
protected boolean	canFunctionBeInlined()
IFunctionDefinition.FunctionClassification	getFunctionClassification() Get the classification for this function (local, argument, class member, etc)
IFunctionNode	getFunctionNode() Returns the IFunctionNode from which this definition was created, if the definition came from the AST for a source file.
ParameterDefinition[]	getParameters() Get the parameters of this function as an array of IParameterDefinition elements
String	getReturnTypeAsDisplayString() Converts this definition's IReference for its return type to a human-readable String.
IReference	getReturnTypeReference() Gets a reference to the return type for this function.
boolean	hasCompatibleSignature(IFunctionDefinition other, ICompilerProject project)
boolean	hasRequiredParameters() Returns true if the function has required parameters.
boolean	inlineFunction() Can this function be inlined
boolean	isCastFunction() Is this a cast function?
boolean	isConstructor() Is this a constructor?
boolean	isImplementation(ICompilerProject project) Determines whether this function is an implementation of a function from an implements Interface
boolean	isInline() Is this function marked as inline?
boolean	isTopLevelDefinition() Is this definition a toplevel definition - constructors are special, which is why this is overriden here
boolean	matches(DefinitionBase definition)
boolean	overridesAncestor(ICompilerProject project) Is this function actually overriding a function in a base class
IFunctionDefinition	resolveImplementedFunction(ICompilerProject project) Finds the definition of the IFunctionDefinition that defines this function
FunctionDefinition	resolveOverriddenFunction(ICompilerProject project) Finds the definition of the IFunctionDefinition that we are overriding
List<IFunctionDefinition>	resolveOverridenInterfaceFunctions(ICompilerProject project) Return a list of FunctionDefinitions from the base interfaces that this FunctionDefinition overrides.
ITypeDefinition	resolveReturnType(ICompilerProject project) Resolve this function's return type in the given scope and find its definition
void	setAsConstructor(ClassDefinition classDef)
void	setCastFunction()
void	setNode(IDefinitionNode node) Attaches a weak reference to the source node that produced this definition, and copies over enough source-location information to re-associate the node if it is garbage-collected.
void	setParameters(ParameterDefinition[] value)
void	setReturnTypeReference(IReference returnTypeReference) Sets a reference to the return type for this function.

Methods inherited from class org.apache.flex.compiler.internal.definitions.ScopedDefinitionBase

getContainedScope, setContainedScope, verify

Methods inherited from class org.apache.flex.compiler.internal.definitions.DefinitionBase

addMetaTag, buildString, getAbsoluteEnd, getAbsoluteStart, getAllMetaTags, getAncestorOfType, getArrayElementType, getBaseName, getBindableEventNames, getColumn, getContainingASScope, getContainingFilePath, getContainingScope, getContainingSourceFilePath, getDefinition, getDeprecationInfo, getEnd, getExplicitSourceComment, getFileScope, getFileSpecification, getInstanceType, getLine, getLocationString, getMaxSize, getMetaTagByName, getMetaTagsByName, getMName, getModifiers, getNameColumn, getNameEnd, getNameLine, getNamespaceReference, getNamespaceReferenceAsString, getNameStart, getNode, getPackageName, getParent, getPercentProxy, getQualifiedName, getSize, getSkinPart, getSourcePath, getStart, getStorageName, getTypeAsDisplayString, getTypeDependencyType, getTypeReference, hasCollapseWhiteSpace, hasExplicitComment, hasMetaTagByName, hasModifier, hasNamespace, hasRichTextContent, inPackageNamespace, isBindable, isBindableStyle, isColor, isContingent, isContingentNeeded, isDeprecated, isDynamic, isEmpty, isFinal, isGeneratedEmbedClass, isImplicit, isInProject, isInternal, isNative, isOverride, isPrivate, isProtected, isPublic, isRequiredSkinPart, isStatic, resolveNamespace, resolveType, resolveType, resolveType, resolveType, resolveType, setBindable, setContainingScope, setContingent, setDynamic, setFinal, setGeneratedEmbedClass, setImplicit, setLocation, setMetaTags, setModifier, setNameLocation, setNamespaceReference, setNative, setOverride, setPublic, setStatic, setTypeReference, toStorageName, toString, unsetOverride

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.definitions.IScopedDefinition

getContainedScope

Methods inherited from interface org.apache.flex.compiler.definitions.IDocumentableDefinition

getExplicitSourceComment, hasExplicitComment

Methods inherited from interface org.apache.flex.compiler.definitions.IDefinition

getAbsoluteEnd, getAbsoluteStart, getAllMetaTags, getAncestorOfType, getBaseName, getBindableEventNames, getColumn, getContainingFilePath, getContainingScope, getContainingSourceFilePath, getDeprecationInfo, getEnd, getLine, getMetaTagByName, getMetaTagsByName, getModifiers, getNameColumn, getNameEnd, getNameLine, getNamespaceReference, getNameStart, getNode, getPackageName, getParent, getQualifiedName, getSourcePath, getStart, getTypeAsDisplayString, getTypeReference, hasMetaTagByName, hasModifier, hasNamespace, isBindable, isBindableStyle, isContingent, isContingentNeeded, isDeprecated, isDynamic, isFinal, isGeneratedEmbedClass, isImplicit, isInProject, isInternal, isNative, isOverride, isPrivate, isProtected, isPublic, isStatic, resolveNamespace, resolveType

Constructor Detail

FunctionDefinition

public FunctionDefinition(String name)

Method Detail

setNode

public void setNode(IDefinitionNode node)

Description copied from class: DefinitionBase

Attaches a weak reference to the source node that produced this definition, and copies over enough source-location information to re-associate the node if it is garbage-collected.

Overrides:

setNode in class DefinitionBase

Parameters:

node - The IDefinitionNode that is producing this definition.

getFunctionClassification

public IFunctionDefinition.FunctionClassification getFunctionClassification()

Description copied from interface: IFunctionDefinition

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

Specified by:

getFunctionClassification in interface IFunctionDefinition

Returns:

function classification

getParameters

public ParameterDefinition[] getParameters()

Description copied from interface: IFunctionDefinition

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

Specified by:

getParameters in interface IFunctionDefinition

Returns:

the parameters of this function

hasRequiredParameters

public boolean hasRequiredParameters()

Description copied from interface: IFunctionDefinition

Returns true if the function has required parameters.

Specified by:

hasRequiredParameters in interface IFunctionDefinition

setParameters

public void setParameters(ParameterDefinition[] value)

getReturnTypeAsDisplayString

public String getReturnTypeAsDisplayString()

Description copied from interface: IFunctionDefinition

Converts this definition's IReference for its return type to a human-readable String.

If the definition does not have a return type reference, this method returns the empty string.

This method should only be used for displaying return types in problems, and not for making semantic decisions.

Note:

Specified by:

getReturnTypeAsDisplayString in interface IFunctionDefinition

Returns:

The result of calling IReference.getDisplayString()() on the IReference representing this definition's return type.

setReturnTypeReference

public void setReturnTypeReference(IReference returnTypeReference)

Sets a reference to the return type for this function.

Parameters:

returnTypeReference - An IReference to a class or interface.

getReturnTypeReference

public IReference getReturnTypeReference()

Description copied from interface: IFunctionDefinition

Gets a reference to the return type for this function.

For example, for the function private function f(i:int):String, this is a reference to the String class.

Specified by:

getReturnTypeReference in interface IFunctionDefinition

Returns:

An IReference to a class or interface.

resolveReturnType

public ITypeDefinition resolveReturnType(ICompilerProject project)

Description copied from interface: IFunctionDefinition

Resolve this function's return type in the given scope and find its definition

Specified by:

resolveReturnType in interface IFunctionDefinition

Parameters:

project - the ICompilerProject in which to resolve references

Returns:

an ITypeDefinition representing this function's return type, or null

isConstructor

public boolean isConstructor()

Description copied from interface: IFunctionDefinition

Is this a constructor?

Specified by:

isConstructor in interface IFunctionDefinition

Returns:

true if the member is a constructor

setAsConstructor

public void setAsConstructor(ClassDefinition classDef)

isCastFunction

public boolean isCastFunction()

Description copied from interface: IFunctionDefinition

Is this a cast function?

Specified by:

isCastFunction in interface IFunctionDefinition

Returns:

true if the member is a cast function

setCastFunction

public void setCastFunction()

inlineFunction

public boolean inlineFunction()

Description copied from interface: IFunctionDefinition

Can this function be inlined

Specified by:

inlineFunction in interface IFunctionDefinition

Returns:

true if function can be inlined

isInline

public final boolean isInline()

Description copied from interface: IFunctionDefinition

Is this function marked as inline?

Specified by:

isInline in interface IFunctionDefinition

Returns:

true if the function is inline.

canFunctionBeInlined

protected final boolean canFunctionBeInlined()

overridesAncestor

public boolean overridesAncestor(ICompilerProject project)

Description copied from interface: IFunctionDefinition

Is this function actually overriding a function in a base class

Specified by:

overridesAncestor in interface IFunctionDefinition

Returns:

true if overriding Note that for valid code, isOverride and overridesAncestor are the same, but overridesAncestor can return true even if the override keyword is missing. Conversely, isOverride can return true, even if there is no matching function in a parent interface

resolveOverriddenFunction

public FunctionDefinition resolveOverriddenFunction(ICompilerProject project)

Description copied from interface: IFunctionDefinition

Finds the definition of the IFunctionDefinition that we are overriding

Specified by:

resolveOverriddenFunction in interface IFunctionDefinition

Returns:

an IFunctionDefinition or null

isImplementation

public boolean isImplementation(ICompilerProject project)

Description copied from interface: IFunctionDefinition

Determines whether this function is an implementation of a function from an implements Interface

Specified by:

isImplementation in interface IFunctionDefinition

Returns:

true if this is an implementation

resolveOverridenInterfaceFunctions

public List<IFunctionDefinition> resolveOverridenInterfaceFunctions(ICompilerProject project)

Return a list of FunctionDefinitions from the base interfaces that this FunctionDefinition overrides. We do not allow overriding of Interface methods, but we need to find the methods that would be overriden so that we can issue a diagnostic. This method will only work for FunctionDefinitions that are interface members.

Parameters:

project - The project to use to resolve references

Returns:

A list of IFunctionDefinitions from any base interfaces that have the same base name as this FunctionDefinition. If there are none, an empty list will be returned

resolveImplementedFunction

public IFunctionDefinition resolveImplementedFunction(ICompilerProject project)

Description copied from interface: IFunctionDefinition

Finds the definition of the IFunctionDefinition that defines this function

Specified by:

resolveImplementedFunction in interface IFunctionDefinition

Returns:

the parent IFunctionDefinition or null

hasCompatibleSignature

public boolean hasCompatibleSignature(IFunctionDefinition other,
                             ICompilerProject project)

getFunctionNode

public IFunctionNode getFunctionNode()

Description copied from interface: IFunctionDefinition

Returns the IFunctionNode from which this definition was created, if the definition came from the AST for a source file.

This method may require the AST to be reloaded or regenerated and therefore may be slow.

Specified by:

getFunctionNode in interface IFunctionDefinition

isTopLevelDefinition

public boolean isTopLevelDefinition()

Is this definition a toplevel definition - constructors are special, which is why this is overriden here

Overrides:

isTopLevelDefinition in class DefinitionBase

Returns:

true if this definition is declared at file scope, or package scope.

matches

public boolean matches(DefinitionBase definition)

Overrides:

matches in class DefinitionBase

buildInnerString

protected void buildInnerString(StringBuilder sb)

For debugging only. Produces a string such as public function f(int, String):void.

Overrides:

buildInnerString in class DefinitionBase