org.apache.flex.compiler.internal.scopes

Class ASScope

java.lang.Object

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

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

All Implemented Interfaces:

IASScope

Direct Known Subclasses:

ASFileScope, ClosureScope, FunctionScope, NoDefinitionScope, PackageScope, ScopeView, TypeScope

public abstract class ASScope
extends ASScopeBase

IASScope implementation for class, interface, function, and 'with' scopes.

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 static NamespaceDefinition.IUseNamespaceDirective[]	EMPTY_USE_ARRAY
protected NodeReference	scopedNodeRef Weak ref back to the Block node to which this scope belongs TODO: Remove once code model clients don't depend on this anymore

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

allNamespacesSet, definitionStore

Constructor Summary

Constructors

Constructor and Description
ASScope(ASScope containingScope)
ASScope(ASScope containingScope, ScopedBlockNode block) 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	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)
protected void	addNamespacesFromContainingScope(CompilerProject compilerProject, Set<INamespaceDefinition> result) Add the open namespaces from the containing scope to the namespace set passed in
void	addUseDirective(NamespaceDefinition.IUseNamespaceDirective useDirective)
Set<INamespaceDefinition>	adjustNamespaceSetForSuper(IDefinition superDef, Set<INamespaceDefinition> nsSet) Adjust the namespace set passed in so it's the right set for a super access.
protected boolean	canDelegateLookupToContainingScope(String name) Is it ok to skip this scope, and just ask the containing scope to perform the lookup.
void	compact() Compact the ArrayLists in this scope (so that they don't take up as much space)
protected void	findProperty(Collection<IDefinition> accumulator, CompilerProject project, String baseName, NamespaceSetPredicate nsPred, DependencyType dt, boolean findAll) This is the implementation of the various findproperty() methods.
void	findProperty(Collection<IDefinition> accumulator, CompilerProject project, String baseName, Set<INamespaceDefinition> namespaceSet, DependencyType dt, boolean findAll) This is the core findproperty() method.
List<IDefinition>	findProperty(CompilerProject project, String baseName, com.google.common.base.Predicate<IDefinition> additional, Set<INamespaceDefinition> namespaceSet, DependencyType dt) Version of findProperty that determine the results based on the namespace set passed in, along with any additional constraints passed in via the Predicate.
List<IDefinition>	findProperty(CompilerProject project, String baseName, Set<INamespaceDefinition> namespaceSet, DependencyType dt) This is called by ASScopeCache when there was a cache miss.
IDefinition	findProperty(ICompilerProject project, String baseName, DependencyType dt) The main public entry point for the findprop operation in the compiler.
IDefinition	findProperty(ICompilerProject project, String baseName, DependencyType dt, boolean canEscapeWith) The main public entry point for the findprop operation in the compiler.
IDefinition	findProperty(ICompilerProject project, String baseName, com.google.common.base.Predicate<IDefinition> additional, DependencyType dt, boolean canEscapeWith) An alternate entry point for findprop operations.
IDefinition	findProperty(ICompilerProject project, String baseName, com.google.common.base.Predicate<IDefinition> additional, Set<INamespaceDefinition> nsSet, DependencyType dt, boolean canEscapeWith)
IDefinition	findPropertyQualified(ICompilerProject project, INamespaceDefinition qual, String baseName, DependencyType dt) The main public entry point for the findprop operation in the compiler with an explicit qualifier namespace.
IDefinition	findPropertyQualified(ICompilerProject project, INamespaceDefinition qual, String baseName, DependencyType dt, boolean canEscapeWith) The main public entry point for the findprop operation in the compiler with an explicit qualifier namespace.
IDefinition	findPropertyQualified(ICompilerProject project, IQualifiers qual, String baseName, DependencyType dt, boolean canEscapeWith) The main public entry point for the findprop operation in the compiler with an explicit set of qualifier namespaces.
IDefinition	findPropertyQualified(ICompilerProject project, com.google.common.base.Predicate<IDefinition> additional, INamespaceDefinition qual, String baseName, DependencyType dt) The main public entry point for the findprop operation in the compiler with an explicit qualifier namespace.
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.
ClassDefinitionBase	getContainingClass() Helper method to return the ClassDefinition this scope is inside of, if there is one.
IScopedDefinition	getContainingDefinition() Get's the ScopedDefinitionBase that contains this scope.
ASScope	getContainingScope() Gets the scope that lexically contains this scope.
protected void	getContainingScopeExplicitImports(CompilerProject project, String name, Set<INamespaceDefinition> nsSet) Get the additional namespaces for a reference, if the name has been explicitly imported in a containing scope
String	getContainingSourcePath(String qName, 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.
ASFileScope	getFileScope()
NamespaceDefinition.INamespaceDirective	getFirstNamespaceDirective() Gets the first namespace definition or use namespace directive in the scope.
String[]	getImports()
Set<INamespaceDefinition>	getNamespaceSet(ICompilerProject project) Computes and returns the namespace set for this scope.
Set<INamespaceDefinition>	getNamespaceSetForName(ICompilerProject project, String name) Calculate the namespace set to use to resolve name.
Set<INamespaceDefinition>	getNamespaceSetForSuper(ICompilerProject project, IDefinition superDef) Helper method to get the namespace set to use for a super reference.
List<IDefinition>	getPropertiesByNameForMemberAccess(CompilerProject project, String memberName, Set<INamespaceDefinition> namespaceSet) Gets all definitions (including definitions from base types) that have the specified name to the specified collections of definitions that have a namespace qualifier in the specified definition set, when looking for definitions through a member access.
IDefinition	getPropertyByNameForMemberAccess(CompilerProject project, String memberName, Set<INamespaceDefinition> namespaceSet) Gets the definition (including definitions from base types) that has the specified name and that has a namespace qualifier in the specified namespace set, when looking for definitions through a member access.
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.
void	getPropertyForMemberAccess(CompilerProject project, Collection<IDefinition> defs, String baseName, Set<INamespaceDefinition> 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.
IDefinition	getPropertyFromDef(ICompilerProject project, IDefinition def, String name, boolean isSuperRef) Find a property in an IDefinition, using the open namespaces & packages of this scope.
IDefinition	getPropertyFromDef(ICompilerProject project, IDefinition def, String name, com.google.common.base.Predicate<IDefinition> additional, boolean isSuperRef) Find a property in an IDefinition, using the open namespaces & packages of this scope, and any additional constraints that are passed in as a Predicate.
IDefinition	getQualifiedPropertyFromDef(ICompilerProject project, IDefinition def, String name, INamespaceDefinition qualifier, boolean isSuperRef) Find a property in an IDefinition, using the namespace passed in as the qualifier.
IDefinition	getQualifiedPropertyFromDef(ICompilerProject project, IDefinition def, String name, IQualifiers qualifiers, boolean isSuperRef) Find a property in an IDefinition, using the qualifiers passed in to provide the namespace set.
IScopedNode	getScopeNode() Gets the scoped node corresponding to this scope.
protected INamespaceReference[]	getUsedNamespaces()
IWorkspace	getWorkspace() Get's the IWorkspace in which this ASScope lives.
boolean	hasAnyBindableDefinitions() Determine if any of the definitions in this scope are Bindable
boolean	isInWith() Is this scope inside a with scope.
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.
protected boolean	namespaceSetSameAsContainingScopeNamespaceSet()
void	reconnectScopeNode(IScopedNode node) Re-connects this scope to the syntax tree node that corresponds to this scope.
void	setAsContainingScopeOfAnonymousFunction(FunctionDefinition anonymousFunction) Makes this scope be the containing scope of the specified anonymous function.
void	setContainingDefinition(ScopedDefinitionBase value)
void	setContainingScope(ASScope containingScope) Sets the scope which lexically contains this scope.
protected String	toStringHeader() For debugging only.

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

Field Detail

EMPTY_USE_ARRAY

protected static final NamespaceDefinition.IUseNamespaceDirective[] EMPTY_USE_ARRAY

scopedNodeRef

protected NodeReference scopedNodeRef

Weak ref back to the Block node to which this scope belongs TODO: Remove once code model clients don't depend on this anymore

Constructor Detail

ASScope

public ASScope(ASScope containingScope,
       ScopedBlockNode block)

Constructor

Parameters:

block - block node to which this scope belongs

ASScope

public ASScope(ASScope containingScope)

Method Detail

setContainingScope

public void setContainingScope(ASScope containingScope)

Sets the scope which lexically contains this scope.

Parameters:

containingScope - The containing scope.

compact

public void compact()

Compact the ArrayLists in this scope (so that they don't take up as much space)

Overrides:

compact in class ASScopeBase

addNamespaceDirective

public void addNamespaceDirective(NamespaceDefinition.INamespaceDirective directive)

addUseDirective

public void addUseDirective(NamespaceDefinition.IUseNamespaceDirective useDirective)

addImport

public void addImport(String target)

getContainingScope

public ASScope getContainingScope()

Description copied from interface: IASScope

Gets the scope that lexically contains this scope.

Returns:

The IASScope that contains this scope, or null if there is no such scope.

reconnectScopeNode

public void reconnectScopeNode(IScopedNode node)

Re-connects this scope to the syntax tree node that corresponds to this scope.

Parameters:

node - IScopedNode that corresponds to this scope.

getScopeNode

public IScopedNode getScopeNode()

Description copied from interface: IASScope

Gets the scoped node corresponding to this scope.

Specified by:

getScopeNode in interface IASScope

Overrides:

getScopeNode in class ASScopeBase

Returns:

The IScopedNode corresponding to this scope.

getImports

public String[] getImports()

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 ASScopeBase

Returns:

The IScopedDefinition that contains this scope.

setContainingDefinition

public void setContainingDefinition(ScopedDefinitionBase value)

toStringHeader

protected String toStringHeader()

For debugging only.

Overrides:

toStringHeader in class ASScopeBase

isPackageName

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

Parameters:

p - the string to test

Returns:

true is p is a package name

getExplicitImportQualifiers

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

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.

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.

getContainingScopeExplicitImports

protected void getContainingScopeExplicitImports(CompilerProject project,
                                     String name,
                                     Set<INamespaceDefinition> nsSet)

Get the additional namespaces for a reference, if the name has been explicitly imported in a containing scope

Parameters:

project - the active project

name - the name of the reference

nsSet - the namespace set to add the namespaces to

getUsedNamespaces

protected INamespaceReference[] getUsedNamespaces()

getFirstNamespaceDirective

public NamespaceDefinition.INamespaceDirective getFirstNamespaceDirective()

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

Returns:

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

addLocalImportsToNamespaceSet

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

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

Parameters:

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

namespaceSet - Namespace set to add namespaces to.

getNamespaceSetForName

public Set<INamespaceDefinition> getNamespaceSetForName(ICompilerProject project,
                                               String name)

Calculate the namespace set to use to resolve name. If name is an explicitly imported definition, then the namespace set will consist of the package name from the import(s) plus the open namespace set. If name was not explitly imported then the open namespace set will be calculated and returned

Parameters:

project - The compiler project

name - A name.

Returns:

the namespace set to use to lookup name. This set should not be modified

namespaceSetSameAsContainingScopeNamespaceSet

protected boolean namespaceSetSameAsContainingScopeNamespaceSet()

getNamespaceSet

public Set<INamespaceDefinition> getNamespaceSet(ICompilerProject project)

Computes and returns the namespace set for this scope.

The returned set should not be modified.

Parameters:

project - The compiler project.

Returns:

The namespace set for this scope. The returned set should not be modified

addNamespacesFromContainingScope

protected void addNamespacesFromContainingScope(CompilerProject compilerProject,
                                    Set<INamespaceDefinition> result)

Add the open namespaces from the containing scope to the namespace set passed in

Parameters:

compilerProject - the active project

result - the Namespace Set to add namespaces to

addImplicitOpenNamespaces

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

getAllPropertiesForScopeChain

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

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)

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.

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.

getPropertiesByNameForMemberAccess

public List<IDefinition> getPropertiesByNameForMemberAccess(CompilerProject project,
                                                   String memberName,
                                                   Set<INamespaceDefinition> namespaceSet)

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

Parameters:

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

memberName - the name of the desired definition(s).

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

Returns:

the collection of matching definitions.

getPropertyByNameForMemberAccess

public IDefinition getPropertyByNameForMemberAccess(CompilerProject project,
                                           String memberName,
                                           Set<INamespaceDefinition> namespaceSet)

Gets the definition (including definitions from base types) that has the specified name and that has a namespace qualifier in the specified namespace set, when looking for definitions through a member access.

Parameters:

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

memberName - the name of the desired definition(s).

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

Returns:

The first definition that matches the name and namespaceSet. May return the AmbiguousDefinition if more than one definition in a scope matches.

getPropertyForMemberAccess

public void getPropertyForMemberAccess(CompilerProject project,
                              Collection<IDefinition> defs,
                              String baseName,
                              Set<INamespaceDefinition> namespaceSet,
                              boolean findAll)

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.

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.

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.

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

namespaceSet - The namespace set in which a found definition's qualifier must be in.

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.

getPropertyForMemberAccess

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

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.

getPropertyFromDef

public IDefinition getPropertyFromDef(ICompilerProject project,
                             IDefinition def,
                             String name,
                             boolean isSuperRef)

Find a property in an IDefinition, using the open namespaces & packages of this scope.

Parameters:

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

def - The definition to resolve the property in

name - The name of the definition to find

isSuperRef - whether this lookup is through a 'super' reference - if it is then the namespace set will be adjusted to use the base classes protected namespace instead of the containing classes protected namespace

Returns:

The IDefinition for the property, or null if one is not found

getPropertyFromDef

public IDefinition getPropertyFromDef(ICompilerProject project,
                             IDefinition def,
                             String name,
                             com.google.common.base.Predicate<IDefinition> additional,
                             boolean isSuperRef)

Find a property in an IDefinition, using the open namespaces & packages of this scope, and any additional constraints that are passed in as a Predicate.

Parameters:

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

def - The definition to resolve the property in

name - The name of the definition to find

additional - A Predicate that will perform additional filtering of the results. This Predicate will run before any namespace set checking.

isSuperRef - whether this lookup is through a 'super' reference - if it is then the namespace set will be adjusted to use the base classes protected namespace instead of the containing classes protected namespace

Returns:

The IDefinition for the property, or null if one is not found

getQualifiedPropertyFromDef

public IDefinition getQualifiedPropertyFromDef(ICompilerProject project,
                                      IDefinition def,
                                      String name,
                                      INamespaceDefinition qualifier,
                                      boolean isSuperRef)

Find a property in an IDefinition, using the namespace passed in as the qualifier.

Parameters:

project - ICompilerProject whose symbol table is used to resolve references.

def - The definition to resolve the property in

name - The name of the definition to find

qualifier - The namespace to us to look up name

isSuperRef - whether this lookup is through a 'super' reference - if it is then the namespace set will be adjusted to use the base classes protected namespace instead of the containing classes protected namespace

Returns:

The IDefinition for the property, or null if one is not found

getQualifiedPropertyFromDef

public IDefinition getQualifiedPropertyFromDef(ICompilerProject project,
                                      IDefinition def,
                                      String name,
                                      IQualifiers qualifiers,
                                      boolean isSuperRef)

Find a property in an IDefinition, using the qualifiers passed in to provide the namespace set.

Parameters:

project - ICompilerProject whose symbol table is used to resolve references.

def - The definition to resolve the property in

name - The name of the definition to find

qualifiers - The namespace(s) to us to look up name

isSuperRef - whether this lookup is through a 'super' reference - if it is then the namespace set will be adjusted to use the base classes protected namespace instead of the containing classes protected namespace

Returns:

The IDefinition for the property, or null if one is not found

getPropertyForScopeChain

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

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

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

findProperty

public List<IDefinition> findProperty(CompilerProject project,
                             String baseName,
                             Set<INamespaceDefinition> namespaceSet,
                             DependencyType dt)

This is called by ASScopeCache when there was a cache miss.

Parameters:

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

baseName - base name of the property we are looking for.

namespaceSet - Namespace set in which the qualifier of any found definition must found.

dt - The type of dependency that should be added to the dependency graph when resolving this reference across a compilation unit boundary.

Returns:

One or more IDefinition's matched by the namespace set and base name.

findProperty

public List<IDefinition> findProperty(CompilerProject project,
                             String baseName,
                             com.google.common.base.Predicate<IDefinition> additional,
                             Set<INamespaceDefinition> namespaceSet,
                             DependencyType dt)

Version of findProperty that determine the results based on the namespace set passed in, along with any additional constraints passed in via the Predicate.

Parameters:

project - The CompilerProject to resolve things in

baseName - The name to find

additional - Any additional constraints on the lookup. This predicate will run before any namespace checking occurs.

namespaceSet - The Namespace set to use for the lookup

dt - The dependency type to introduce if this resolves to something from another compilation unit

Returns:

a List of IDefinition that matched the name, namespace set, and any additional constraints specified by the predicate.

findProperty

public void findProperty(Collection<IDefinition> accumulator,
                CompilerProject project,
                String baseName,
                Set<INamespaceDefinition> namespaceSet,
                DependencyType dt,
                boolean findAll)

This is the core findproperty() method. It implements the equivalent of the findprop AVM instruction in Falcon.

The algorithm searches up the scope chain, starting with this scope, for definitions with the specified base name and namespace set.

After the file scope, the project scope is searched if necessary. If definitions are found in the project scope, a dependency is created on the compilation unit that produced them.

If the findAll parameter is false, the search stops with the first scope that has one or more matching definition; if it is true, the search continues to find all matching definitions in the entire chain, including the project scope.

Parameters:

accumulator - Collection to which definitions that match the namespace set and base name are added.

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

baseName - base name of the property we are looking for.

namespaceSet - Namespace set in which the qualifier of any found definition must found.

dt - The type of dependency that should be added to the dependency graph when resolving this reference across a compilation unit boundary.

findAll - If true, then find all definitions that match the namespace set and base name, not just those from the first scope with a single match.

findProperty

protected void findProperty(Collection<IDefinition> accumulator,
                CompilerProject project,
                String baseName,
                NamespaceSetPredicate nsPred,
                DependencyType dt,
                boolean findAll)

This is the implementation of the various findproperty() methods. It implements the equivalent of the findprop AVM instruction in Falcon.

The algorithm searches up the scope chain, starting with this scope, for definitions with the specified base name.

If any additional constraints are required (e.g. filtering based on the namespace set), then callers should pass in an ASScopeBase.FilteredCollection as the accumulator that will implement those constraints. For the common case, the accumulator will be an ASScopeBase.FilteredCollection with a NamespaceSetPredicate.

After the file scope, the project scope is searched if necessary. If definitions are found in the project scope, a dependency is created on the compilation unit that produced them.

If the findAll parameter is false, the search stops with the first scope that has one or more matching definition; if it is true, the search continues to find all matching definitions in the entire chain, including the project scope.

Parameters:

accumulator - Collection to which definitions that match the base name are added.

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

baseName - base name of the property we are looking for.

nsPred - The NamespaceSetPredicate, if one is being used, that the lookup can modify as it walks up the scope chain (necessary to handle protected correctly).

dt - The type of dependency that should be added to the dependency graph when resolving this reference across a compilation unit boundary.

findAll - If true, then find all definitions that match the namespace set and base name, not just those from the first scope with a single match.

isInWith

public boolean isInWith()

Is this scope inside a with scope.

Returns:

true if this scope is nested in a with scope, or this scope is a with scope

findProperty

public IDefinition findProperty(ICompilerProject project,
                       String baseName,
                       DependencyType dt)

The main public entry point for the findprop operation in the compiler. This method uses the ASScopeCache to improve performance.

Parameters:

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

baseName - base name of the property we are looking for.

dt - The type of dependency that should be added to the dependency graph when resolving this reference across a compilation unit boundary.

Returns:

A single IDefinition to which the specified base name resolves to in this scope, or null. Null is returned when no definition is found and when more than one definition is found.

findProperty

public IDefinition findProperty(ICompilerProject project,
                       String baseName,
                       DependencyType dt,
                       boolean canEscapeWith)

The main public entry point for the findprop operation in the compiler. This method uses the ASScopeCache to improve performance.

Parameters:

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

baseName - base name of the property we are looking for.

dt - The type of dependency that should be added to the dependency graph when resolving this reference across a compilation unit boundary.

canEscapeWith - should this lookup find definitions that occur outside of a containing with scope

Returns:

A single IDefinition to which the specified base name resolves to in this scope, or null. Null is returned when no definition is found and when more than one definition is found.

findProperty

public IDefinition findProperty(ICompilerProject project,
                       String baseName,
                       com.google.common.base.Predicate<IDefinition> additional,
                       DependencyType dt,
                       boolean canEscapeWith)

An alternate entry point for findprop operations. This method takes an addition Predicate that allows custom filtering of the results, instead of just using the namespace set. This method will still use the namespace set, but the predicate passed in will be called first to filter the results.

Parameters:

project - the active project

baseName - base name of the property we're looking for

additional - A Predicate that performs custom filtering on the results

dt - The dependency type that should be added to the dependency graph when resolving this reference across a compilation boundary

canEscapeWith - should this lookup find definitions that occur outside of a containing with scope

Returns:

A single IDefinition to which the specified base name resolves to in this scope, given the additional constraints supplied by the additional Predicate.

findProperty

public IDefinition findProperty(ICompilerProject project,
                       String baseName,
                       com.google.common.base.Predicate<IDefinition> additional,
                       Set<INamespaceDefinition> nsSet,
                       DependencyType dt,
                       boolean canEscapeWith)

canDelegateLookupToContainingScope

protected boolean canDelegateLookupToContainingScope(String name)

Is it ok to skip this scope, and just ask the containing scope to perform the lookup. This is possible if this scope does not contribute to the set of open namespaces, and if we have no definitions with the simple name we are looking for.

Returns:

true if we can just ask the containing scope to perform the lookup

findPropertyQualified

public IDefinition findPropertyQualified(ICompilerProject project,
                                INamespaceDefinition qual,
                                String baseName,
                                DependencyType dt)

The main public entry point for the findprop operation in the compiler with an explicit qualifier namespace. This method uses the ASScopeCache to improve performance.

Parameters:

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

qual - INamespaceDefinition which must match the qualifier namespace of the found IDefinition.

baseName - base name of the property we are looking for.

dt - The type of dependency that should be added to the dependency graph when resolving this reference across a compilation unit boundary.

Returns:

A single IDefinition to which the specified qualifier and base name resolves to in this scope, or null. Null is returned when no definition is found and when more than one definition is found.

findPropertyQualified

public IDefinition findPropertyQualified(ICompilerProject project,
                                com.google.common.base.Predicate<IDefinition> additional,
                                INamespaceDefinition qual,
                                String baseName,
                                DependencyType dt)

The main public entry point for the findprop operation in the compiler with an explicit qualifier namespace. This method uses the ASScopeCache to improve performance.

Parameters:

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

qual - INamespaceDefinition which must match the qualifier namespace of the found IDefinition.

baseName - base name of the property we are looking for.

dt - The type of dependency that should be added to the dependency graph when resolving this reference across a compilation unit boundary.

Returns:

A single IDefinition to which the specified qualifier and base name resolves to in this scope, or null. Null is returned when no definition is found and when more than one definition is found.

findPropertyQualified

public IDefinition findPropertyQualified(ICompilerProject project,
                                INamespaceDefinition qual,
                                String baseName,
                                DependencyType dt,
                                boolean canEscapeWith)

The main public entry point for the findprop operation in the compiler with an explicit qualifier namespace. This method uses the ASScopeCache to improve performance.

Parameters:

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

qual - The qualifier(s) to use to lookup the property.

baseName - base name of the property we are looking for.

canEscapeWith - should this lookup find definitions that occur outside of a containing with scope

dt - The type of dependency that should be added to the dependency graph when resolving this reference across a compilation unit boundary.

Returns:

A single IDefinition to which the specified qualifier and base name resolves to in this scope, or null. Null is returned when no definition is found and when more than one definition is found.

findPropertyQualified

public IDefinition findPropertyQualified(ICompilerProject project,
                                IQualifiers qual,
                                String baseName,
                                DependencyType dt,
                                boolean canEscapeWith)

The main public entry point for the findprop operation in the compiler with an explicit set of qualifier namespaces. This method uses the ASScopeCache to improve performance.

Parameters:

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

baseName - base name of the property we are looking for.

qual - The qualifier(s) to use to lookup the property.

canEscapeWith - should this lookup find definitions that occur outside of a containing with scope

dt - The type of dependency that should be added to the dependency graph when resolving this reference across a compilation unit boundary.

Returns:

A single IDefinition to which the specified qualifier and base name resolves to in this scope, or null. Null is returned when no definition is found and when more than one definition is found.

getNamespaceSetForSuper

public Set<INamespaceDefinition> getNamespaceSetForSuper(ICompilerProject project,
                                                IDefinition superDef)

Helper method to get the namespace set to use for a super reference. This will replace the protected namespace for this class with the protected namespace for the super class in the returned namespace set.

Parameters:

project - project used to resolve namespaces

superDef - the IDefinition representing the base class

Returns:

The correct namespace set to use for a super reference

adjustNamespaceSetForSuper

public Set<INamespaceDefinition> adjustNamespaceSetForSuper(IDefinition superDef,
                                                   Set<INamespaceDefinition> nsSet)

Adjust the namespace set passed in so it's the right set for a super access. This will replace the protected namespace for this class with the protected namespace for the super class in the returned namespace set.

Parameters:

superDef - the IDefinition representing the base class

nsSet - the namespace set to adjust

Returns:

The correct namespace set to use for a super reference

getContainingClass

public ClassDefinitionBase getContainingClass()

Helper method to return the ClassDefinition this scope is inside of, if there is one.

Returns:

the ClassDefinition that contains this scope, or null if this scope is not in a ClassDefinition

getFileScope

public ASFileScope getFileScope()

getWorkspace

public IWorkspace getWorkspace()

Get's the IWorkspace in which this ASScope lives.

Returns:

The IWorkspace in which this ASScope lives.

getContainingSourcePath

public String getContainingSourcePath(String qName,
                             ICompilerProject project)

hasAnyBindableDefinitions

public boolean hasAnyBindableDefinitions()

Determine if any of the definitions in this scope are Bindable

Returns:

true, if any non-static definitions in this scope are explicitly marked bindable, false if there are none.

getContainingDefinition

public IScopedDefinition getContainingDefinition()

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

Returns:

The ScopedDefinitionBase that contains this scope

setAsContainingScopeOfAnonymousFunction

public void setAsContainingScopeOfAnonymousFunction(FunctionDefinition anonymousFunction)

Makes this scope be the containing scope of the specified anonymous function. Anonymous functions do not get added to scopes, but they do need to know which scope they are inside of.

addDependencyOnBuiltinType

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

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

Parameters:

project - the active project

builtinType - the builtin type to depend on

dependencyType - the type of dependency to add