org.apache.flex.compiler.projects

Interface ICompilerProject

All Known Subinterfaces:

IASCProject, IASProject, IFlexProject

All Known Implementing Classes:

ASCProject, ASProject, CompilerProject, FlexJSProject, FlexProject

public interface ICompilerProject

All IProject implementations aggregate a project scope containing global definitions, a set of CompilationUnits, and a graph of dependencies between the CompilationUnits.

Method Summary

Methods

Modifier and Type	Method and Description
void	clean() Removes all data created during a compile
ISWFTarget	createSWFTarget(ITargetSettings targetSettings, ITargetProgressMonitor progressMonitor) Create a SWF target
void	delete() Called before a project is deleted.
IDefinition	doubleCheckAmbiguousDefinition(ASScope scope, String name, IDefinition def1, IDefinition def2) Override this to do try harder to disambiguate between two ambiguous definitions
String	getActualPackageName(String packageName) Override this to permit package aliasing on imports and elsewhere
ITypeDefinition	getBuiltinType(IASLanguageConstants.BuiltinType type) Helper method to get some of the built-in types (*, String, Number, etc).
Collection<ICompilationUnit>	getCompilationUnits()
Collection<ICompilationUnit>	getCompilationUnits(String filename) Get all compilation units from the filename
Set<ICompilationUnit>	getDirectDependencies(ICompilationUnit cu) Gets the set of compilation units depended on directly by the specified compilation unit.
Set<ICompilationUnit>	getDirectReverseDependencies(ICompilationUnit cu, DependencyTypeSet types) Gets the set of compilation units that directly depend on the specified compilation unit.
Collection<ICompilationUnit>	getIncludingCompilationUnits(String filename) Get all compilation units from which the filename is included.
Collection<ICompilerProblem>	getProblems()
List<ICompilationUnit>	getReachableCompilationUnitsInSWFOrder(Collection<ICompilationUnit> roots) Given a set of roots node in the dependency graph, compute a list of ICompilationUnit's that are reachable from the specified roots.
IASScope	getScope()
IDefinition	getUndefinedValue() Helper method to get the only built-in value (undefined).
IWorkspace	getWorkspace()
boolean	isAssetEmbeddingSupported() Test whether the project supports the embedding of assets.
boolean	isCompatibleOverrideReturnType(ITypeDefinition overrideDefinition, ITypeDefinition baseDefinition)
boolean	isInliningEnabled() Test whether the project supports function inlining
boolean	isValidTypeConversion(IASNode node, IDefinition actualDefinition, IDefinition expectedDefinition, FunctionDefinition func)
ICompilationUnit	resolveQNameToCompilationUnit(String qName) Resolve a QName such as mx.controls.Button to the containing ICompilationUnit
IDefinition	resolveQNameToDefinition(String qName) Resolve a QName such as mx.controls.Button to a class definition.
void	setProblems(Collection<ICompilerProblem> problems)
void	setUseParallelCodeGeneration(boolean useParallelCodeGeneration) Enables or disables parallel code generation of method bodies.

Method Detail

getWorkspace

IWorkspace getWorkspace()

Returns:

The workspace in which this project lives.

getScope

IASScope getScope()

Returns:

The project scope for the project. This scope object contains all the global definitions in the project.

getCompilationUnits

Collection<ICompilationUnit> getCompilationUnits()

Returns:

All the compilation units in the project.

getCompilationUnits

Collection<ICompilationUnit> getCompilationUnits(String filename)

Get all compilation units from the filename

Parameters:

filename - path to source file

getIncludingCompilationUnits

Collection<ICompilationUnit> getIncludingCompilationUnits(String filename)

Get all compilation units from which the filename is included.

The returned collection does not include invisible compilation units.

Parameters:

filename - path to source file

clean

void clean()

Removes all data created during a compile

delete

void delete()

Called before a project is deleted. This method will remove all compilation units associated with the project from the workspace, along with the project itself from the workspace. Once this method has been called, the project will no longer be in a valid state. SWC caches which are shared across projects will not be invalidated.

createSWFTarget

ISWFTarget createSWFTarget(ITargetSettings targetSettings,
                         ITargetProgressMonitor progressMonitor)
                           throws InterruptedException

Create a SWF target

Parameters:

targetSettings - The settings to use for this target

progressMonitor - to collect progress information, can be null

Returns:

The newly created ISWFTarget

Throws:

InterruptedException

getReachableCompilationUnitsInSWFOrder

List<ICompilationUnit> getReachableCompilationUnitsInSWFOrder(Collection<ICompilationUnit> roots)

Given a set of roots node in the dependency graph, compute a list of ICompilationUnit's that are reachable from the specified roots. The returned list of ICompilationUnit's is in the order in which the ICompilationUnit's should be added to a SWF.

Parameters:

roots - The roots of the dependency graph that is walked to compute which CompilationUnits to include in the return value.

Returns:

A list of ICompilationUnit's reachable from the specified roots in the order the ICompilationUnit's should be added to a SWF.

resolveQNameToDefinition

IDefinition resolveQNameToDefinition(String qName)

Resolve a QName such as mx.controls.Button to a class definition.

Parameters:

qName - Qualified name.

Returns:

The IDefinition corresponds to the given QName; Null if the name can't be resolved.

resolveQNameToCompilationUnit

ICompilationUnit resolveQNameToCompilationUnit(String qName)

Resolve a QName such as mx.controls.Button to the containing ICompilationUnit

Parameters:

qName - Qualified name.

Returns:

The ICompilationUnit corresponds to the given QName; Null if the name can't be resolved.

getBuiltinType

ITypeDefinition getBuiltinType(IASLanguageConstants.BuiltinType type)

Helper method to get some of the built-in types (*, String, Number, etc). Looks right in the project scope, so won't find any intervening definitions that could hide a built-in.

getUndefinedValue

IDefinition getUndefinedValue()

Helper method to get the only built-in value (undefined). Looks right in the project scope, so won't find any intervening definitions that could hide a built-in.

Returns:

the definition for the constant whose qname is "undefined". Note that if we add more built-in values we will need to change this api to take an enum, just like getBuiltinType().

isAssetEmbeddingSupported

boolean isAssetEmbeddingSupported()

Test whether the project supports the embedding of assets.

Returns:

true if embedding is supported, false otherwise

setUseParallelCodeGeneration

void setUseParallelCodeGeneration(boolean useParallelCodeGeneration)

Enables or disables parallel code generation of method bodies.

Parameters:

useParallelCodeGeneration - If true, method bodies will be generated in parallel.

getDirectDependencies

Set<ICompilationUnit> getDirectDependencies(ICompilationUnit cu)

Gets the set of compilation units depended on directly by the specified compilation unit.

Parameters:

cu - The ICompilationUnit whose set of direct dependencies will be returned.

Returns:

A new set of compilation units that the specified compilation unit directly depends on.

getDirectReverseDependencies

Set<ICompilationUnit> getDirectReverseDependencies(ICompilationUnit cu,
                                                 DependencyTypeSet types)

Gets the set of compilation units that directly depend on the specified compilation unit.

Parameters:

cu - An ICompilationUnit.

types - A DependencyTypeSet of dependency types used to filter the returned set of compilation units.

Returns:

A new set of compilation units that directly depend on the specified compilation unit.

isInliningEnabled

boolean isInliningEnabled()

Test whether the project supports function inlining

Returns:

true if inlining enabled, false otherwise.

getActualPackageName

String getActualPackageName(String packageName)

Override this to permit package aliasing on imports and elsewhere

Parameters:

packageName - The imported class

doubleCheckAmbiguousDefinition

IDefinition doubleCheckAmbiguousDefinition(ASScope scope,
                                         String name,
                                         IDefinition def1,
                                         IDefinition def2)

Override this to do try harder to disambiguate between two ambiguous definitions

Parameters:

scope - The current scope.

name - Definition name.

def1 - One possibility.

def2 - The other possibility.

Returns:

null if still ambiguous or else def1 or def2.

getProblems

Collection<ICompilerProblem> getProblems()

Returns:

All the problems collected so far. Add new ones here if you don't have another place to add them.

setProblems

void setProblems(Collection<ICompilerProblem> problems)

Parameters:

problems - All the problems collected so far. Set this to the main collection so parts of the compiler can add a problem if they don't have another place to add them.

isCompatibleOverrideReturnType

boolean isCompatibleOverrideReturnType(ITypeDefinition overrideDefinition,
                                     ITypeDefinition baseDefinition)

Parameters:

overrideDefinition - The definition overriding the base definition.

baseDefinition - The definition being overridden.

Returns:

True if compatible (default is if they are the same)

isValidTypeConversion

boolean isValidTypeConversion(IASNode node,
                            IDefinition actualDefinition,
                            IDefinition expectedDefinition,
                            FunctionDefinition func)

Parameters:

node - The node being converted.

actualDefinition - The actual definition.

expectedDefinition - The expected definition.

func - The function being called.

Returns:

True if valid