org.apache.flex.compiler.internal.scopes

Class ScopeView

java.lang.Object

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

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

org.apache.flex.compiler.internal.scopes.ScopeView

All Implemented Interfaces:

IASScope

public abstract class ScopeView
extends ASScope

Base class for instance and class scopes. This class wraps a TypeScope, to make the TypeScope appear as an instance scope (itraits) or static scope (ctraits). This is a common baseclass for the instance and static scopes - those class must simply implement the getScopeKind() method to get the correct behavior.

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

EMPTY_USE_ARRAY, scopedNodeRef

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

allNamespacesSet, definitionStore

Method Summary

Methods

Modifier and Type	Method and Description
void	addDefinition(IDefinition d) Adds the specified definition to this scope.
void	addImplicitOpenNamespaces(CompilerProject compilerProject, Set<INamespaceDefinition> result)
void	addImport(String target)
void	addLocalImportsToNamespaceSet(IWorkspace workspace, Set<INamespaceDefinition> namespaceSet) Adds INamespaceDefinition's for each import in this scope to the specified namespace set.
void	addNamespaceDirective(NamespaceDefinition.INamespaceDirective directive)
void	addUseDirective(NamespaceDefinition.IUseNamespaceDirective useDirective)
void	getAllLocalProperties(CompilerProject project, Collection<IDefinition> defs, Set<INamespaceDefinition> namespaceSet, INamespaceDefinition extraNamespace) Adds all local definitions from this scope to the specified collections of definitions that have a namespace qualifier in the specified definition set.
void	getAllPropertiesForMemberAccess(CompilerProject project, Collection<IDefinition> defs, Set<INamespaceDefinition> namespaceSet) Adds all definitions ( including definitions from base types ) in the current scope to the specified collections of definitions that have a namespace qualifier in the specified definition set, when looking for definitions through a member access.
void	getAllPropertiesForScopeChain(CompilerProject project, Collection<IDefinition> defs, Set<INamespaceDefinition> namespaceSet) Adds all definitions ( including definitions from base types ) in the current scope to the specified collections of definitions that have a namespace qualifier in the specified definition set, when looking for definitions in the scope chain.
ScopedDefinitionBase	getContainingDefinition() Get's the ScopedDefinitionBase that contains this scope.
String	getContainingSourcePath(String baseName, ICompilerProject project)
ScopedDefinitionBase	getDefinition() Gets the scoped definition that produced this scope.
Set<INamespaceDefinition>	getExplicitImportQualifiers(CompilerProject project, String name) Return the additional namespaces for a reference, if the name has been explicitly imported.
NamespaceDefinition.INamespaceDirective	getFirstNamespaceDirective() Gets the first namespace definition or use namespace directive in the scope.
IDefinitionSet	getLocalDefinitionSetByName(String name) Gets the set of definitions in this one scope that have the specified base name.
protected void	getPropertyForMemberAccess(CompilerProject project, Collection<IDefinition> defs, String baseName, NamespaceSetPredicate namespaceSet, boolean findAll) Finds all the definitions in this scope that match the specified namespace set and base name.
protected void	getPropertyForScopeChain(CompilerProject project, Collection<IDefinition> defs, String baseName, NamespaceSetPredicate namespaceSet, boolean findAll) Implementation of getPropertyForScopeChain.
protected abstract org.apache.flex.compiler.internal.scopes.TypeScope.ScopeKind	getScopeKind() Derived classes must implement this method to report what kind of scope they are (instance or static).
protected INamespaceReference[]	getUsedNamespaces()
boolean	isInstanceScope()
boolean	isPackageName(String p) Determine whether the string passed in is a known package name The scope will check if the package was introduced by any of it's imports, and if not will delegate to its containing scope.
boolean	isStaticScope()
protected boolean	namespaceSetSameAsContainingScopeNamespaceSet()
ASScope	resolveSuperScope(ICompilerProject project) Get the scope of the super class - this method will do the right thing depending on if this scope is the instance of static scope.

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

addDependencyOnBuiltinType, addNamespacesFromContainingScope, adjustNamespaceSetForSuper, canDelegateLookupToContainingScope, compact, findProperty, findProperty, findProperty, findProperty, findProperty, findProperty, findProperty, findProperty, findPropertyQualified, findPropertyQualified, findPropertyQualified, findPropertyQualified, getContainingClass, getContainingScope, getContainingScopeExplicitImports, getFileScope, getImports, getNamespaceSet, getNamespaceSetForName, getNamespaceSetForSuper, getPropertiesByNameForMemberAccess, getPropertyByNameForMemberAccess, getPropertyForMemberAccess, getPropertyFromDef, getPropertyFromDef, getQualifiedPropertyFromDef, getQualifiedPropertyFromDef, getScopeNode, getWorkspace, hasAnyBindableDefinitions, isInWith, reconnectScopeNode, setAsContainingScopeOfAnonymousFunction, setContainingDefinition, setContainingScope, toStringHeader

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

addDefinitionToStore, getAllLocalDefinitions, getAllLocalDefinitionSets, getAllLocalNames, 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

Method Detail

getScopeKind

protected abstract org.apache.flex.compiler.internal.scopes.TypeScope.ScopeKind getScopeKind()

Derived classes must implement this method to report what kind of scope they are (instance or static).

Returns:

The kind of Scope this class represents

getPropertyForScopeChain

protected void getPropertyForScopeChain(CompilerProject project,
                            Collection<IDefinition> defs,
                            String baseName,
                            NamespaceSetPredicate namespaceSet,
                            boolean findAll)

Description copied from class: ASScope

Implementation of getPropertyForScopeChain. This method will filter results based on baseName only - any additional filtering should be done by the Collection passed in.

Overrides:

getPropertyForScopeChain in class ASScope

Parameters:

project - CompilerProject to resolve things in

defs - The Collection to add the results to

baseName - The name of the definition to find

namespaceSet - the NamespaceSetPredicate to use if the namespace set needs to be adjusted during lookup

getPropertyForMemberAccess

protected void getPropertyForMemberAccess(CompilerProject project,
                              Collection<IDefinition> defs,
                              String baseName,
                              NamespaceSetPredicate namespaceSet,
                              boolean findAll)

Description copied from class: ASScope

Finds all the definitions in this scope that match the specified namespace set and base name. This method is intended to implement the getproperty operation defined by AS3 and the VM.

This version of the method expects that the Collection passed in will implement whatever filtering is necessary, other than filtering based on the base name. For most cases, this means the Collection will be an ASScopeBase.FilteredCollection with a NamespaceSetPredicate. The NamespaceSetPredicate must also be passed down as some name resolution may need it to apply extra namespaces (i.e. deal with protected namespaces)

If this scope is not for a class or interface definition then only definitions in this scope are considered.

If this scope is for a class or interface definition then definitions in this scope and the scope for any implemented or extended interfaces and classes are also considered. Unless findAll is true, then this function returns as soon as one or more definitions has been found that match the namespace set and base name.

Overrides:

getPropertyForMemberAccess in class ASScope

Parameters:

project - ICompilerProject whose symbol table is used to resolve namespace references in the "use namespace" set this scope.

defs - Collection of IDefinition's to add found definitions to. This collection must perform any necessary filtering of results, other than filtering based on the baseName.

baseName - The name of the definition(s) to find.

namespaceSet - The NamespaceSetPredicate which the name resolution code can use to modify the namespace set as necessary.

findAll - If true find all match definitions that match the baseName and namespace set not just those in the first scope that had one or more matches.

getAllPropertiesForScopeChain

public void getAllPropertiesForScopeChain(CompilerProject project,
                                 Collection<IDefinition> defs,
                                 Set<INamespaceDefinition> namespaceSet)

Description copied from class: ASScope

Adds all definitions ( including definitions from base types ) in the current scope to the specified collections of definitions that have a namespace qualifier in the specified definition set, when looking for definitions in the scope chain.

Overrides:

getAllPropertiesForScopeChain in class ASScope

Parameters:

project - CompilerProject used to resolve reference to definitions outside of the ICompilationUnit that contains this scope.

defs - Collection that found IDefinition's are added to.

namespaceSet - Namespace set in which the qualifier of any matching definition must exist to be considered a match.

getAllPropertiesForMemberAccess

public void getAllPropertiesForMemberAccess(CompilerProject project,
                                   Collection<IDefinition> defs,
                                   Set<INamespaceDefinition> namespaceSet)

Description copied from class: ASScope

Adds all definitions ( including definitions from base types ) in the current scope to the specified collections of definitions that have a namespace qualifier in the specified definition set, when looking for definitions through a member access.

Overrides:

getAllPropertiesForMemberAccess in class ASScope

Parameters:

project - CompilerProject used to resolve reference to definitions outside of the ICompilationUnit that contains this scope.

defs - Collection that found IDefinition's are added to.

namespaceSet - Namespace set in which the qualifier of any matching definition must exist to be considered a match.

getAllLocalProperties

public final void getAllLocalProperties(CompilerProject project,
                         Collection<IDefinition> defs,
                         Set<INamespaceDefinition> namespaceSet,
                         INamespaceDefinition extraNamespace)

Description copied from class: ASScopeBase

Adds all local definitions from this scope to the specified collections of definitions that have a namespace qualifier in the specified definition set.

Overrides:

getAllLocalProperties in class ASScopeBase

Parameters:

project - CompilerProject used to resolve reference to definitions outside of the ICompilationUnit that contains this scope.

defs - Collection that found IDefinition's are added to.

namespaceSet - Namespace set in which the qualifier of any matching definition must exist to be considered a match.

extraNamespace - A single extra INamespaceDefinition that is considered part of the namespace set by this method. This is used when resolving protected definitions in a class scope.

namespaceSetSameAsContainingScopeNamespaceSet

protected boolean namespaceSetSameAsContainingScopeNamespaceSet()

Overrides:

namespaceSetSameAsContainingScopeNamespaceSet in class ASScope

addImplicitOpenNamespaces

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

Overrides:

addImplicitOpenNamespaces in class ASScope

addDefinition

public void addDefinition(IDefinition d)

Description copied from class: ASScopeBase

Adds the specified definition to this scope.

Overrides:

addDefinition in class ASScopeBase

Parameters:

d - The IDefinition to be added.

getDefinition

public ScopedDefinitionBase getDefinition()

Description copied from interface: IASScope

Gets the scoped definition that produced this scope.

Specified by:

getDefinition in interface IASScope

Overrides:

getDefinition in class ASScope

Returns:

The IScopedDefinition that contains this scope.

getLocalDefinitionSetByName

public IDefinitionSet getLocalDefinitionSetByName(String name)

Description copied from interface: IASScope

Gets the set of definitions in this one scope that have the specified base name.

Specified by:

getLocalDefinitionSetByName in interface IASScope

Overrides:

getLocalDefinitionSetByName in class ASScopeBase

Parameters:

name - A String specifying a base name.

Returns:

An IDefinitionSet containing definitions with that base name, or null if there are no such definitions.

getContainingSourcePath

public String getContainingSourcePath(String baseName,
                             ICompilerProject project)

Overrides:

getContainingSourcePath in class ASScope

addImport

public void addImport(String target)

Overrides:

addImport in class ASScope

addLocalImportsToNamespaceSet

public void addLocalImportsToNamespaceSet(IWorkspace workspace,
                                 Set<INamespaceDefinition> namespaceSet)

Description copied from class: ASScope

Adds INamespaceDefinition's for each import in this scope to the specified namespace set.

Overrides:

addLocalImportsToNamespaceSet in class ASScope

Parameters:

workspace - IWorkspace used to construct INamespaceDefinition's for imported packages.

namespaceSet - Namespace set to add namespaces to.

getExplicitImportQualifiers

public Set<INamespaceDefinition> getExplicitImportQualifiers(CompilerProject project,
                                                    String name)

Description copied from class: ASScope

Return the additional namespaces for a reference, if the name has been explicitly imported. If 'a.b.Foo' has been imported, and we see reference to Foo, this will return the INamespaceDefinition for 'a.b'. If the name has not been explicitly imported then this method will return the empty set.

Overrides:

getExplicitImportQualifiers in class ASScope

Parameters:

project - CompilerProject to use to resolve the package INamespaces

name - The name of the reference

Returns:

A Set representing the packages from the imports if the name was explicitly imported. Returns the empty set if the name was not explicitly imported.

getUsedNamespaces

protected INamespaceReference[] getUsedNamespaces()

Overrides:

getUsedNamespaces in class ASScope

addUseDirective

public void addUseDirective(NamespaceDefinition.IUseNamespaceDirective useDirective)

Overrides:

addUseDirective in class ASScope

addNamespaceDirective

public void addNamespaceDirective(NamespaceDefinition.INamespaceDirective directive)

Overrides:

addNamespaceDirective in class ASScope

getFirstNamespaceDirective

public NamespaceDefinition.INamespaceDirective getFirstNamespaceDirective()

Gets the first namespace definition or use namespace directive in the scope.

Overrides:

getFirstNamespaceDirective in class ASScope

Returns:

The first namespace definition or use namespace directive in the 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

isPackageName

public final boolean isPackageName(String p)

Description copied from class: ASScope

Determine whether the string passed in is a known package name The scope will check if the package was introduced by any of it's imports, and if not will delegate to its containing scope.

Overrides:

isPackageName in class ASScope

Parameters:

p - the string to test

Returns:

true is p is a package name

isInstanceScope

public boolean isInstanceScope()

Returns:

true if this scope represents the instance scope of a class

isStaticScope

public boolean isStaticScope()

Returns:

true if this scope represents the static scope of a class

resolveSuperScope

public ASScope resolveSuperScope(ICompilerProject project)

Get the scope of the super class - this method will do the right thing depending on if this scope is the instance of static scope.

Parameters:

project - the Project to resolve things in

Returns:

the scope to use as the scope of the super class. This may be the instance scope of 'Class' (for static scopes), or the instance scope of the base class (for instance scopes)