org.apache.flex.compiler.internal.scopes

Class ASFileScope

java.lang.Object

org.apache.flex.compiler.internal.scopes.ASScopeBase

org.apache.flex.compiler.internal.scopes.ASScope

org.apache.flex.compiler.internal.scopes.ASFileScope

All Implemented Interfaces:

IASScope, IFileScope

Direct Known Subclasses:

FXGFileScope, MXMLFileScope, SWCFileScopeProvider.SWCFileScope

public class ASFileScope
extends ASScope
implements IFileScope

IASScope implementation for FileNodes. Conceptually, the file scope contains all top-level definitions in the file. Any top-level definitions that don't reside in packages are in the scope itself (see ASScope). This scope's implementations of findDefinitionByName, findAllDefinitionsByName, and findAllDefinitions also look for definitions in package scopes within the file. That way, we use the versions of these classes in the (possibly unsaved) file, rather than the versions that are stored in the project scope.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flex.compiler.internal.scopes.ASScopeBase

ASScopeBase.FilteredCollection<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected WeakReference<ICompilationUnit>	compilationUnitReference
protected String	filePath the path of the file this file scope represents
protected Boolean	isEditableFile A flag indicating whether this is an editable file (AS/MXML) or not (SWC).

Fields inherited from class org.apache.flex.compiler.internal.scopes.ASScope

EMPTY_USE_ARRAY, scopedNodeRef

Fields inherited from class org.apache.flex.compiler.internal.scopes.ASScopeBase

allNamespacesSet, definitionStore

Constructor Summary

Constructors

Constructor and Description
ASFileScope(FileNode fileNode) Constructor
ASFileScope(IFileSpecificationGetter fileSpecGetter, String filePath) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	addDependencyOnBuiltinType(ICompilerProject project, IASLanguageConstants.BuiltinType builtinType, DependencyType dependencyType) Add a dependency to the given builtintype, from the compilation unit which contains this scope
void	addImplicitOpenNamespaces(CompilerProject compilerProject, Set<INamespaceDefinition> result)
void	addParsedFunctionBodies(FunctionNode functionNode) Add a function node the the collection of function nodes which have been parsed
void	collectExternallyVisibleDefinitions(Collection<IDefinition> defs, boolean includePrivateDefinitions) Finds the definitions in this scope which could be visible to other compilation units and adds them to a specified collection of definitions.
ICompilationUnit	getCompilationUnit() Get the ICompilationUnit related to this ASFileScope.
ScopedDefinitionBase	getContainingDefinition() Get's the ScopedDefinitionBase that contains this scope.
String	getContainingPath()
String	getContainingSourcePath(String qName, ICompilerProject project) Resolve the source file path of the given definition QName.
INamespaceDefinition.ILanguageNamespaceDefinition	getFilePrivateNamespaceReference()
static Collection<String>	getImplicitImportsForAS() Returns the implicit imports for an ActionScript file.
IASNode	getNode() Get the IASNode this FileScope came from.
OffsetLookup	getOffsetLookup()
IWorkspace	getWorkspace() Get's the IWorkspace in which this ASScope lives.
protected boolean	isEditableFile() Determine whether or not this is an editable file.
boolean	isPackageName(String p) Determine if p is the name of a package - at File Scope it checks declared package names in addition to package names introduced via import
boolean	isSWC()
protected boolean	namespaceSetSameAsContainingScopeNamespaceSet()
void	removeParsedFunctionBodies(FunctionNode functionNode) Remove a function node the the collection of function nodes which have been parsed, when the body is discarded
IASNode	reparseFile() Re-parse the file this scope was built for.
boolean	setCompilationUnit(ICompilationUnit compilationUnit) Set the ICompilationUnit related to this ASFileScope.
void	setOffsetLookup(OffsetLookup offsetLookup) Set the OffsetLookup utility.
protected String	toStringHeader() For debugging only.

Methods inherited from class org.apache.flex.compiler.internal.scopes.ASScope

addImport, addLocalImportsToNamespaceSet, addNamespaceDirective, addNamespacesFromContainingScope, addUseDirective, adjustNamespaceSetForSuper, canDelegateLookupToContainingScope, compact, findProperty, findProperty, findProperty, findProperty, findProperty, findProperty, findProperty, findProperty, findPropertyQualified, findPropertyQualified, findPropertyQualified, findPropertyQualified, getAllPropertiesForMemberAccess, getAllPropertiesForScopeChain, getContainingClass, getContainingScope, getContainingScopeExplicitImports, getDefinition, getExplicitImportQualifiers, getFileScope, getFirstNamespaceDirective, getImports, getNamespaceSet, getNamespaceSetForName, getNamespaceSetForSuper, getPropertiesByNameForMemberAccess, getPropertyByNameForMemberAccess, getPropertyForMemberAccess, getPropertyForMemberAccess, getPropertyForScopeChain, getPropertyFromDef, getPropertyFromDef, getQualifiedPropertyFromDef, getQualifiedPropertyFromDef, getScopeNode, getUsedNamespaces, hasAnyBindableDefinitions, isInWith, reconnectScopeNode, setAsContainingScopeOfAnonymousFunction, setContainingDefinition, setContainingScope

Methods inherited from class org.apache.flex.compiler.internal.scopes.ASScopeBase

addDefinition, addDefinitionToStore, getAllLocalDefinitions, getAllLocalDefinitionSets, getAllLocalNames, getAllLocalProperties, getLocalDefinitionSetByName, getLocalProperty, getLocalProperty, getLocalProperty, isContingentDefinitionNeeded, removeDefinition, removeDefinitionFromStore, toString, verify

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.scopes.IASScope

getAllLocalDefinitions, getAllLocalDefinitionSets, getAllLocalNames, getContainingScope, getDefinition, getLocalDefinitionSetByName, getScopeNode

Field Detail

filePath

protected String filePath

the path of the file this file scope represents

isEditableFile

protected Boolean isEditableFile

A flag indicating whether this is an editable file (AS/MXML) or not (SWC).

compilationUnitReference

protected WeakReference<ICompilationUnit> compilationUnitReference

Constructor Detail

ASFileScope

public ASFileScope(IFileSpecificationGetter fileSpecGetter,
           String filePath)

Constructor

Parameters:

fileSpecGetter - IFileSpecificationGetter that is used to open files associated with this ASFileScope.

filePath - Normalized absolute name of the file for which this ASFileScope is being created.

ASFileScope

public ASFileScope(FileNode fileNode)

Constructor

Parameters:

fileNode - file node whose scope this represents

Method Detail

getImplicitImportsForAS

public static Collection<String> getImplicitImportsForAS()

Returns the implicit imports for an ActionScript file.

For AS3, there is a single implicit import, "__AS3__.vec.Vector".

Returns:

A collection of Strings for the implicit imports.

isEditableFile

protected boolean isEditableFile()

Determine whether or not this is an editable file. This will check the attached FileNode to see if it represents a SWC file (as opposed to an AS or MXML file). If so, then we know not to prefer in-file definitions to those in the project scope.

Returns:

true if the file is editable

toStringHeader

protected String toStringHeader()

For debugging only.

Overrides:

toStringHeader in class ASScope

isPackageName

public boolean isPackageName(String p)

Determine if p is the name of a package - at File Scope it checks declared package names in addition to package names introduced via import

Overrides:

isPackageName in class ASScope

Parameters:

p - the string to test

Returns:

true it p is a known package name

namespaceSetSameAsContainingScopeNamespaceSet

protected boolean namespaceSetSameAsContainingScopeNamespaceSet()

Overrides:

namespaceSetSameAsContainingScopeNamespaceSet in class ASScope

getFilePrivateNamespaceReference

public INamespaceDefinition.ILanguageNamespaceDefinition getFilePrivateNamespaceReference()

getWorkspace

public IWorkspace getWorkspace()

Description copied from class: ASScope

Get's the IWorkspace in which this ASScope lives.

Overrides:

getWorkspace in class ASScope

Returns:

The IWorkspace in which this ASScope lives.

getContainingSourcePath

public String getContainingSourcePath(String qName,
                             ICompilerProject project)

Resolve the source file path of the given definition QName. The QName must be defined within this file scope.

If this ASFileScope comes from an ActionScript file, return the ActionScript file path. File scopes coming from ABC or SWC files will override this method to locate their source file path.

Overrides:

getContainingSourcePath in class ASScope

Parameters:

qName - QName of a definition

project - resolve the source path within this project

Returns:

Source file path of this ASFileScope.

getContainingPath

public String getContainingPath()

Specified by:

getContainingPath in interface IFileScope

collectExternallyVisibleDefinitions

public void collectExternallyVisibleDefinitions(Collection<IDefinition> defs,
                                       boolean includePrivateDefinitions)

Description copied from interface: IFileScope

Finds the definitions in this scope which could be visible to other compilation units and adds them to a specified collection of definitions.

The externally-visible definitions are the ones in a file scope or in a package scope.

Specified by:

collectExternallyVisibleDefinitions in interface IFileScope

Parameters:

defs - The collection of IDefinition's to which the externally-visible definitions in this scope are to be added.

includePrivateDefinitions - If true, definitions with private namespace qualifiers are added to the specified collection.

addImplicitOpenNamespaces

public void addImplicitOpenNamespaces(CompilerProject compilerProject,
                             Set<INamespaceDefinition> result)

Overrides:

addImplicitOpenNamespaces in class ASScope

reparseFile

public IASNode reparseFile()
                    throws InterruptedException

Re-parse the file this scope was built for.

Returns:

The root IASNode of the syntax tree.

Throws:

InterruptedException

setOffsetLookup

public void setOffsetLookup(OffsetLookup offsetLookup)

Set the OffsetLookup utility.

Parameters:

offsetLookup - offset lookup utility

getOffsetLookup

public OffsetLookup getOffsetLookup()

Returns:

Offset lookup utility for this file scope.

getContainingDefinition

public final ScopedDefinitionBase getContainingDefinition()

Description copied from class: ASScope

Get's the ScopedDefinitionBase that contains this scope. This method differs from ASScope.getDefinition() in that this method will walk up the scope chain.

Overrides:

getContainingDefinition in class ASScope

Returns:

The ScopedDefinitionBase that contains this scope

isSWC

public boolean isSWC()

Specified by:

isSWC in interface IFileScope

Returns:

true if this scope is from a SWC, false otherwise.

getNode

public IASNode getNode()

Get the IASNode this FileScope came from. This will reparse the file if necessary to rebuild the IASNode. If this FileScope did not come from a source file, this will return null.

Returns:

The IASNode that produced this FileScope, or null if this Scope did not come from a source file

setCompilationUnit

public boolean setCompilationUnit(ICompilationUnit compilationUnit)

Set the ICompilationUnit related to this ASFileScope. This class is overridden by SWCFileScope which will never set the project reference, as SWC scopes are shared across projects.

Parameters:

compilationUnit - A compilation unit.

Returns:

true if the ICompilationUnit was stored, false if not stored. This happens when trying to store a SWCCompilationUnit.

getCompilationUnit

public ICompilationUnit getCompilationUnit()

Get the ICompilationUnit related to this ASFileScope. SWCFileScope will override this class. Note that this class should only ever be called from ASProjectScope or CompilerProject. Clients should only ever use ASProjectScope.getCompilationUnitForScope()

Returns:

the ICompilationUnit. May be null when a SWCFileScopeProvider.SWCFileScope

addParsedFunctionBodies

public void addParsedFunctionBodies(FunctionNode functionNode)

Add a function node the the collection of function nodes which have been parsed

Parameters:

functionNode - the FunctionNode to add

removeParsedFunctionBodies

public void removeParsedFunctionBodies(FunctionNode functionNode)

Remove a function node the the collection of function nodes which have been parsed, when the body is discarded

Parameters:

functionNode - the FunctionNode to add

addDependencyOnBuiltinType

public void addDependencyOnBuiltinType(ICompilerProject project,
                              IASLanguageConstants.BuiltinType builtinType,
                              DependencyType dependencyType)

Description copied from class: ASScope

Add a dependency to the given builtintype, from the compilation unit which contains this scope

Overrides:

addDependencyOnBuiltinType in class ASScope

Parameters:

project - the active project

builtinType - the builtin type to depend on

dependencyType - the type of dependency to add