org.apache.flex.compiler.internal.scopes

Class ASScopeBase

java.lang.Object

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

All Implemented Interfaces:

IASScope

Direct Known Subclasses:

ASProjectScope, ASScope

public abstract class ASScopeBase
extends Object
implements IASScope

ASScopeBase is the abstract base class for all lexical scopes. It has three concrete subclasses: ASProjectScope for project scopes, ASFileScope for file scopes, and ASScope for class, interface, function, and with scopes.

The primary purpose of a lexical scope is to store a set of definitions that are potentially visible if the scope is in the chain of scopes used to resolve an identifier.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ASScopeBase.FilteredCollection<T> Collection that ignores added items that for which a predicate returns false.

Field Summary

Fields

Modifier and Type	Field and Description
static Set<INamespaceDefinition>	allNamespacesSet
protected IDefinitionStore	definitionStore Storage for definitions in this scope, organized into sets of definitions with the same base name.

Constructor Summary

Constructors

Constructor and Description
ASScopeBase() Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	addDefinition(IDefinition definition) Adds the specified definition to this scope.
protected void	addDefinitionToStore(IDefinition definition) Helper method called by addDefinition(org.apache.flex.compiler.definitions.IDefinition)().
void	compact() Minimizes the memory used by this scope.
Collection<IDefinition>	getAllLocalDefinitions() Gets all the definitions in this one scope.
Collection<IDefinitionSet>	getAllLocalDefinitionSets() Gets all the definition sets in this one scope.
Collection<String>	getAllLocalNames() Gets all the base names of definitions in this one scope.
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.
IScopedDefinition	getDefinition() Gets the scoped definition that produced this scope.
IDefinitionSet	getLocalDefinitionSetByName(String baseName) Gets the set of definitions in this one scope that have the specified base name.
protected void	getLocalProperty(ICompilerProject project, Collection<IDefinition> defs, String baseName, boolean getContingents) Adds definitions with the specified base name to the specified collection of definitions.
void	getLocalProperty(ICompilerProject project, Collection<IDefinition> defs, String baseName, Set<INamespaceDefinition> namespaceSet) Adds definitions with the specified base name whose namespaces match the specified namespace set to the specified collection of definitions.
protected void	getLocalProperty(ICompilerProject project, Collection<IDefinition> defs, String baseName, Set<INamespaceDefinition> namespaceSet, boolean getContingents) Adds definitions with the specified base name whose namespaces match the specified namespace set to the specified collection of definitions.
IScopedNode	getScopeNode() Gets the scoped node corresponding to this scope.
boolean	isContingentDefinitionNeeded(ICompilerProject project, IDefinition definition) Check whether there is a matching definition in the class hierarchy already defined in which case the contingent definition is not needed.
void	removeDefinition(IDefinition definition) Removes the specified definition from this scope.
protected void	removeDefinitionFromStore(IDefinition definition) Helper method called by removeDefinition(org.apache.flex.compiler.definitions.IDefinition)().
String	toString() For debugging only.
protected String	toStringHeader() For debugging only.
boolean	verify() Used only in asserts.

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

getContainingScope

Field Detail

allNamespacesSet

public static final Set<INamespaceDefinition> allNamespacesSet

definitionStore

protected IDefinitionStore definitionStore

Storage for definitions in this scope, organized into sets of definitions with the same base name.

Constructor Detail

ASScopeBase

public ASScopeBase()

Constructor

Method Detail

compact

public void compact()

Minimizes the memory used by this scope.

The definition store does not get compacted, but subclasses override this to compact other data structures.

addDefinition

public void addDefinition(IDefinition definition)

Adds the specified definition to this scope.

Parameters:

definition - The IDefinition to be added.

addDefinitionToStore

protected void addDefinitionToStore(IDefinition definition)

Helper method called by addDefinition(org.apache.flex.compiler.definitions.IDefinition)().

It handles actually adding the definition to the store. It first tries to add it to the current store. If it won't fit, it creates a bigger store and adds it to that.

Parameters:

definition - The IDefinition to be added.

removeDefinition

public void removeDefinition(IDefinition definition)

Removes the specified definition from this scope.

Parameters:

definition - The IDefinition to be removed.

removeDefinitionFromStore

protected void removeDefinitionFromStore(IDefinition definition)

Helper method called by removeDefinition(org.apache.flex.compiler.definitions.IDefinition)().

It handles actually removing the definition from the store. It does not bother to check whether the store could be downgraded with one that has a smaller capacity.

Parameters:

definition - The IDefinition to be added.

getScopeNode

public IScopedNode getScopeNode()

Description copied from interface: IASScope

Gets the scoped node corresponding to this scope.

Specified by:

getScopeNode in interface IASScope

Returns:

The IScopedNode corresponding to this scope.

getDefinition

public IScopedDefinition getDefinition()

Description copied from interface: IASScope

Gets the scoped definition that produced this scope.

Specified by:

getDefinition in interface IASScope

Returns:

The IScopedDefinition that contains this scope.

getLocalDefinitionSetByName

public IDefinitionSet getLocalDefinitionSetByName(String baseName)

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

Parameters:

baseName - A String specifying a base name.

Returns:

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

getAllLocalNames

public Collection<String> getAllLocalNames()

Description copied from interface: IASScope

Gets all the base names of definitions in this one scope.

Specified by:

getAllLocalNames in interface IASScope

Returns:

The base names as a sorted array of Strings.

getAllLocalDefinitionSets

public Collection<IDefinitionSet> getAllLocalDefinitionSets()

Description copied from interface: IASScope

Gets all the definition sets in this one scope.

Specified by:

getAllLocalDefinitionSets in interface IASScope

Returns:

A Collection of IDefinitionSet objects.

getAllLocalDefinitions

public Collection<IDefinition> getAllLocalDefinitions()

Description copied from interface: IASScope

Gets all the definitions in this one scope.

Specified by:

getAllLocalDefinitions in interface IASScope

Returns:

A Collection of IDefinition objects.

getLocalProperty

public final void getLocalProperty(ICompilerProject project,
                    Collection<IDefinition> defs,
                    String baseName,
                    Set<INamespaceDefinition> namespaceSet)

Adds definitions with the specified base name whose namespaces match the specified namespace set to the specified collection of definitions.

If more that one definition is added to the collection by this method, then the reference is ambiguous

Parameters:

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

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

baseName - Name of property to find.

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

getLocalProperty

protected final void getLocalProperty(ICompilerProject project,
                    Collection<IDefinition> defs,
                    String baseName,
                    Set<INamespaceDefinition> namespaceSet,
                    boolean getContingents)

Adds definitions with the specified base name whose namespaces match the specified namespace set to the specified collection of definitions.

If more that one definition is added to the collection by this method, then the reference is ambiguous

Parameters:

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

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

baseName - Name of property to find.

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

getContingents - If true, non-contingent definitions are ignored. If false, contingent definitions are ignored.

getLocalProperty

protected final void getLocalProperty(ICompilerProject project,
                    Collection<IDefinition> defs,
                    String baseName,
                    boolean getContingents)

Adds definitions with the specified base name to the specified collection of definitions.

If additional constraints on the definitions are required, then the Collection passed in should implement those. Most commonly, this will be a ASScopeBase.FilteredCollection with a NamespaceSetPredicate as the predicate.

If more that one definition is added to the collection by this method, then the reference is ambiguous

Parameters:

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

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

baseName - Name of property to find.

getContingents - If true, non-contingent definitions are ignored. If false, contingent definitions are ignored.

isContingentDefinitionNeeded

public boolean isContingentDefinitionNeeded(ICompilerProject project,
                                   IDefinition definition)

Check whether there is a matching definition in the class hierarchy already defined in which case the contingent definition is not needed.

Parameters:

project - The compiler project.

definition - A definition.

getAllLocalProperties

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

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.

verify

public boolean verify()

Used only in asserts.

toString

public String toString()

For debugging only. This method displays the definitions contained in this scope, alphabetically by name. If the definitions have scopes, those scopes are recursively displayed in an indented fashion.

Overrides:

toString in class Object

toStringHeader

protected String toStringHeader()

For debugging only. Called by toString() to return the header that is displayed at the beginning.