org.apache.flex.compiler.internal.scopes

Class SWCFileScopeProvider.SWCFileScope

java.lang.Object

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

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

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

org.apache.flex.compiler.internal.scopes.SWCFileScopeProvider.SWCFileScope

All Implemented Interfaces:

IASScope, IFileScope

Enclosing class:

SWCFileScopeProvider

public static final class SWCFileScopeProvider.SWCFileScope
extends ASFileScope

This class is able to resolve the source file path of a given QName defined in a SWC library, if the source directory is set for that SWC library.

Nested Class Summary

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

ASScopeBase.FilteredCollection<T>

Field Summary

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

compilationUnitReference, filePath, isEditableFile

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
SWCFileScopeProvider.SWCFileScope(IWorkspace workspace, String filePath)

Method Summary

Methods

Modifier and Type	Method and Description
IASDocComment	getComment(ICompilerProject project, IDocumentableDefinition def)
ICompilationUnit	getCompilationUnit() Get the ICompilationUnit related to this ASFileScope.
String	getContainingSourcePath(String qName, ICompilerProject project) Resolve the source file path of the given definition QName.
boolean	isSWC()
boolean	setCompilationUnit(ICompilationUnit compilationUnit) Set the ICompilationUnit related to this ASFileScope.

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

addDependencyOnBuiltinType, addImplicitOpenNamespaces, addParsedFunctionBodies, collectExternallyVisibleDefinitions, getContainingDefinition, getContainingPath, getFilePrivateNamespaceReference, getImplicitImportsForAS, getNode, getOffsetLookup, getWorkspace, isEditableFile, isPackageName, namespaceSetSameAsContainingScopeNamespaceSet, removeParsedFunctionBodies, reparseFile, setOffsetLookup, toStringHeader

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

Constructor Detail

SWCFileScopeProvider.SWCFileScope

public SWCFileScopeProvider.SWCFileScope(IWorkspace workspace,
                                 String filePath)

Method Detail

getContainingSourcePath

public String getContainingSourcePath(String qName,
                             ICompilerProject project)

Description copied from class: ASFileScope

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 ASFileScope

Parameters:

qName - QName of a definition

project - resolve the source path within this project

Returns:

Source file path of this ASFileScope.

getComment

public IASDocComment getComment(ICompilerProject project,
                       IDocumentableDefinition def)

isSWC

public boolean isSWC()

Specified by:

isSWC in interface IFileScope

Overrides:

isSWC in class ASFileScope

Returns:

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

setCompilationUnit

public boolean setCompilationUnit(ICompilationUnit compilationUnit)

Description copied from class: ASFileScope

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.

Overrides:

setCompilationUnit in class ASFileScope

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()

Description copied from class: ASFileScope

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()

Overrides:

getCompilationUnit in class ASFileScope

Returns:

the ICompilationUnit. May be null when a SWCFileScopeProvider.SWCFileScope