org.apache.flex.compiler.internal.projects

Class ASProject

java.lang.Object

org.apache.flex.compiler.internal.projects.CompilerProject

org.apache.flex.compiler.internal.projects.ASProject

All Implemented Interfaces:

IASProject, ICompilerProject

Direct Known Subclasses:

FlexProject

public abstract class ASProject
extends CompilerProject
implements IASProject

Implementation base class to implement functionality common to all IASProject implementations. DefinitionPromises ( aka "provisional definitions" ) are added to the project scope in this class.

Field Summary

Fields inherited from class org.apache.flex.compiler.internal.projects.CompilerProject

dependencyGraph, problems, targets

Constructor Summary

Constructors

Constructor and Description
ASProject(Workspace workspace, boolean useAS3) Constructor
ASProject(Workspace workspace, boolean useAS3, IASDocBundleDelegate asDocBundleDelegate)

Method Summary

Methods

Modifier and Type	Method and Description
void	addIncludeSourceFile(File file) Adds a new include source file to the project.
void	addIncludeSourceFile(File file, boolean overrideSourcePath) Adds a new include source file to the project.
void	addProjectDependeny(IASProject project, String swcFilename) Adds a new project dependency to this project.
boolean	addSourcePathFile(File f) Adds a file to the project if that file is on the project's source path.
void	attachExternalLibrarySourcePath(File library, File sourceDir) Attach the source directory to an external SWC library.
void	attachInternalLibrarySourcePath(File library, File sourceDir) Attach the source directory to a SWC library.
void	collectionCompilationUnitsForRootSourceFile(File rootSourceFile, Collection<ICompilationUnit> units) Finds all the ICompilationUnit's in this project whose root source file is the specified file.
void	collectProblems(Collection<ICompilerProblem> problems) Gets project level ICompilerProblem's target are not specific to any one target created by the project.
IInvisibleCompilationUnit	createInvisibleCompilationUnit(String rootSourceFile, IFileSpecificationGetter fileSpecGetter) Creates an IInvisibleCompilationUnit for the specified absolute file name.
IInvisibleCompilationUnit	createInvisibleCompilationUnit(String rootSourceFile, IFileSpecificationGetter fileSpecGetter, String qName) Creates an IInvisibleCompilationUnit for the specified absolute file name, specifying a qualified name.
IASDocBundleDelegate	getASDocBundleDelegate()
String	getAttachedSourceDirectory(String libraryFilename) Get the Directory for the specified library.
Integer	getCompatibilityVersion() Returns the compatibility version encoded as an integer.
String	getCompatibilityVersionString() Returns the compatibility version encoded as a string.
Set<IASProject>	getDependingProjects()
List<ISWC>	getLibraries() The libraries available to compiler source in this project.
SourceCompilationUnitFactory	getSourceCompilationUnitFactory()
ISWCFileEntry	getSourceFileFromLibraryPath(String file) Iterate through the library path list looking for the specified file.
String	getSourceFileFromSourcePath(String file) Iterate through the source path list looking for the specified file.
List<File>	getSourcePath() Get the list of source paths set.
boolean	handleAddedFile(File addedFile) Called by Workspace.fileAdded(org.apache.flex.compiler.filespecs.IFileSpecification) for each project in the workspace.
boolean	hasCompilationUnitForRootSourceFile(File rootSourceFile)
boolean	invalidateLibraries(Collection<File> swcFiles) Removes any calculated data related to a collection of libraries.
void	invalidateLibrary(ISWC swc) Removes any calculated data related to a SWC.
boolean	isAssetEmbeddingSupported() Test whether the project supports the embedding of assets.
boolean	isFileOnSourcePath(File f) Test if a file is on the source path or not.
boolean	isSupportedSourceFileType(String fileExtension) Determines if the specified file extension ( without the dot eg: as, not .as ) corresponds to a source file type that this project can create ICompilationUnits for.
void	removeIncludeSourceFile(File file) Removes an include source file to the project.
void	removeProjectDependeny(IASProject project) Removes a project dependency from this project.
void	removeSourceFile(File f) Removes a source file to the project, removing any references in the various managers - SourcePathManager, SourceListManager etc
void	setCompatibilityVersion(int major, int minor, int revision) Sets the SDK compatibility version.
void	setDependencies(Map<IASProject,String> newIProjectsDependencies) Resets the set of projects that this project depends on.
void	setIncludeSources(File[] files) Sets the include sources list for the project.
void	setLibraries(List<File> libraries) The libraries used to compile source files in a project.
void	setSourcePath(List<File> paths) Sets the source path for the project.

Methods inherited from class org.apache.flex.compiler.internal.projects.CompilerProject

addCompilationUnit, addCompilationUnits, addCompilationUnitsAndUpdateDefinitions, addConfigVariable, addConfigVariables, addDependency, addDependency, addDependency, addEmbedCompilationUnit, addGlobalUsedNamespacesToNamespaceSet, addToASTCache, addUnfoundDefinitionDependency, addUnfoundReferencedSourceFileDependency, clean, clearScopeCacheForCompilationUnit, collectConfigProblems, createSWFTarget, delete, doubleCheckAmbiguousDefinition, getActualPackageName, getBuiltinType, getCacheForScope, getCompilationUnit, getCompilationUnits, getCompilationUnits, getDependencies, getDependenciesOnDefinition, getDependenciesOnUnfoundDefinition, getDependenciesOnUnfoundReferencedSourceFile, getDependencyGraph, getDirectDependencies, getDirectReverseDependencies, getFatalProblems, getIncludingCompilationUnits, getProblems, getProjectConfigVariables, getReachableCompilationUnitsInSWFOrder, getScope, getUndefinedValue, getUseParallelCodeGeneration, getWorkspace, initProjectScope, isCompatibleOverrideReturnType, isInliningEnabled, isValidTypeConversion, removeAnyUnfoundDependencies, removeCompilationUnit, removeCompilationUnits, removeDependencies, resetScopeCacheForCompilationUnit, resolveQNameToCompilationUnit, resolveQNameToDefinition, setEnableInlining, setProblems, setUseParallelCodeGeneration, unitTestingEntryPointForRemovingCompilationUnit, updatePublicAndInternalDefinitions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.flex.compiler.projects.ICompilerProject

clean, createSWFTarget, delete, doubleCheckAmbiguousDefinition, getActualPackageName, getBuiltinType, getCompilationUnits, getCompilationUnits, getDirectDependencies, getDirectReverseDependencies, getIncludingCompilationUnits, getProblems, getReachableCompilationUnitsInSWFOrder, getScope, getUndefinedValue, getWorkspace, isCompatibleOverrideReturnType, isInliningEnabled, isValidTypeConversion, resolveQNameToCompilationUnit, resolveQNameToDefinition, setProblems, setUseParallelCodeGeneration

Constructor Detail

ASProject

public ASProject(Workspace workspace,
         boolean useAS3)

Constructor

Parameters:

workspace - The Workspace in which this project lives.

useAS3 - Indicate whether or not the AS3 namespace should be opened in all compilation units in the project.

ASProject

public ASProject(Workspace workspace,
         boolean useAS3,
         IASDocBundleDelegate asDocBundleDelegate)

Method Detail

getLibraries

public List<ISWC> getLibraries()

Description copied from interface: IASProject

The libraries available to compiler source in this project.

Specified by:

getLibraries in interface IASProject

Returns:

the libraries are returned in priority order from highest to lowest. The list may not be modified.

attachInternalLibrarySourcePath

public void attachInternalLibrarySourcePath(File library,
                                   File sourceDir)

Description copied from interface: IASProject

Attach the source directory to a SWC library.

Specified by:

attachInternalLibrarySourcePath in interface IASProject

Parameters:

library - SWC library

sourceDir - directory that contains the source for the SWC library

attachExternalLibrarySourcePath

public void attachExternalLibrarySourcePath(File library,
                                   File sourceDir)

Description copied from interface: IASProject

Attach the source directory to an external SWC library.

Specified by:

attachExternalLibrarySourcePath in interface IASProject

Parameters:

library - SWC library

sourceDir - directory that contains the source for the SWC library

getAttachedSourceDirectory

public String getAttachedSourceDirectory(String libraryFilename)

Description copied from interface: IASProject

Get the Directory for the specified library.

Specified by:

getAttachedSourceDirectory in interface IASProject

Returns:

Full path to the specified library, or null if there is no attached source directory for the specified library.

setSourcePath

public void setSourcePath(List<File> paths)

Description copied from interface: IASProject

Sets the source path for the project. Calling this method can invalidate a significant amount of incremental compilation results.

Specified by:

setSourcePath in interface IASProject

Parameters:

paths - List of directories that should be searched for source files.

getSourcePath

public List<File> getSourcePath()

Description copied from interface: IASProject

Get the list of source paths set.

Specified by:

getSourcePath in interface IASProject

Returns:

a list of source paths.

addSourcePathFile

public boolean addSourcePathFile(File f)

Adds a file to the project if that file is on the project's source path.

Parameters:

f - The file to be added.

Returns:

true if any new ICompilationUnit's were created as a result of this operation, false otherwise.

isFileOnSourcePath

public boolean isFileOnSourcePath(File f)

Test if a file is on the source path or not.

Parameters:

f - The file to test. May not be null.

Returns:

true if the file is on the source path, false otherwise.

setIncludeSources

public void setIncludeSources(File[] files)
                       throws InterruptedException

Description copied from interface: IASProject

Sets the include sources list for the project. Source files in this list are unconditionally added to the symbol table. Calling this method can invalidate a significant amount of incremental compilation results.

Specified by:

setIncludeSources in interface IASProject

Throws:

InterruptedException

addIncludeSourceFile

public void addIncludeSourceFile(File file)
                          throws InterruptedException

Description copied from interface: IASProject

Adds a new include source file to the project. Include source file's are files that should always be compiled into the project.

Specified by:

addIncludeSourceFile in interface IASProject

Parameters:

file - File to add.

Throws:

InterruptedException

addIncludeSourceFile

public void addIncludeSourceFile(File file,
                        boolean overrideSourcePath)
                          throws InterruptedException

Description copied from interface: IASProject

Adds a new include source file to the project. Include source file's are files that should always be compiled into the project.

Specified by:

addIncludeSourceFile in interface IASProject

Parameters:

file - File to add.

overrideSourcePath - Set to true to add the file to the source list even if it exists on the source path.

Throws:

InterruptedException

removeIncludeSourceFile

public void removeIncludeSourceFile(File file)
                             throws InterruptedException

Description copied from interface: IASProject

Removes an include source file to the project.

Specified by:

removeIncludeSourceFile in interface IASProject

Parameters:

file - File to remove.

Throws:

InterruptedException

See Also:

IASProject.addIncludeSourceFile(File)

removeSourceFile

public void removeSourceFile(File f)

Removes a source file to the project, removing any references in the various managers - SourcePathManager, SourceListManager etc

Parameters:

f - File to remove.

See Also:

addIncludeSourceFile(File)

getSourceCompilationUnitFactory

public SourceCompilationUnitFactory getSourceCompilationUnitFactory()

getDependingProjects

public Set<IASProject> getDependingProjects()

Specified by:

getDependingProjects in interface IASProject

Returns:

Set of projects which depend on this project

addProjectDependeny

public void addProjectDependeny(IASProject project,
                       String swcFilename)

Description copied from interface: IASProject

Adds a new project dependency to this project.

Specified by:

addProjectDependeny in interface IASProject

Parameters:

project - IASProject dependency to add to this project.

swcFilename - The SWC filename the project dependency generates

removeProjectDependeny

public void removeProjectDependeny(IASProject project)

Description copied from interface: IASProject

Removes a project dependency from this project.

Specified by:

removeProjectDependeny in interface IASProject

Parameters:

project - IASProject to remove from this projects dependencies.

setDependencies

public void setDependencies(Map<IASProject,String> newIProjectsDependencies)

Description copied from interface: IASProject

Resets the set of projects that this project depends on.

Specified by:

setDependencies in interface IASProject

Parameters:

newIProjectsDependencies - The new map of IASProjects that this project depends on. The value to the map is the SWC filename the IASProject generates.

collectProblems

public void collectProblems(Collection<ICompilerProblem> problems)

Description copied from class: CompilerProject

Gets project level ICompilerProblem's target are not specific to any one target created by the project.

Specified by:

collectProblems in class CompilerProject

collectionCompilationUnitsForRootSourceFile

public void collectionCompilationUnitsForRootSourceFile(File rootSourceFile,
                                               Collection<ICompilationUnit> units)

Finds all the ICompilationUnit's in this project whose root source file is the specified file.

hasCompilationUnitForRootSourceFile

public boolean hasCompilationUnitForRootSourceFile(File rootSourceFile)

invalidateLibraries

public boolean invalidateLibraries(Collection<File> swcFiles)

Description copied from interface: IASProject

Removes any calculated data related to a collection of libraries. Used by incremental compilation when swc files have been modified.

Specified by:

invalidateLibraries in interface IASProject

Parameters:

swcFiles - Collection of SWC files to invalidate.

Returns:

true if a library referenced by this project was invalidated

invalidateLibrary

public void invalidateLibrary(ISWC swc)

Description copied from interface: IASProject

Removes any calculated data related to a SWC. Used by incremental compilation when library projects have changed

Specified by:

invalidateLibrary in interface IASProject

Parameters:

swc - ISWC to invalidate

handleAddedFile

public boolean handleAddedFile(File addedFile)

Description copied from class: CompilerProject

Called by Workspace.fileAdded(org.apache.flex.compiler.filespecs.IFileSpecification) for each project in the workspace. Each subclass of this class must decide when an added file is interesting or should be ignored.

Specified by:

handleAddedFile in class CompilerProject

Parameters:

addedFile - File that was added.

Returns:

true if any new compilation units were created as a result of adding the file, false otherwise.

getSourceFileFromSourcePath

public String getSourceFileFromSourcePath(String file)

Description copied from interface: IASProject

Iterate through the source path list looking for the specified file.

Specified by:

getSourceFileFromSourcePath in interface IASProject

Parameters:

file - filename to look for

Returns:

Absolute path to the file, or null if file not found

getSourceFileFromLibraryPath

public ISWCFileEntry getSourceFileFromLibraryPath(String file)

Iterate through the library path list looking for the specified file.

Parameters:

file - to look for

Returns:

ISWCFileEntry to the file, or null if file not found

getASDocBundleDelegate

public IASDocBundleDelegate getASDocBundleDelegate()

setLibraries

public void setLibraries(List<File> libraries)

Description copied from interface: IASProject

The libraries used to compile source files in a project. The order of the libraries sets the priority of class definitions when name and the timestamp of a class are equal. Libraries at the beginning of the list have a higher priority than libraries at the end of the list.

Specified by:

setLibraries in interface IASProject

Parameters:

libraries - The libraries in priority order, may not be null.

setCompatibilityVersion

public void setCompatibilityVersion(int major,
                           int minor,
                           int revision)

Sets the SDK compatibility version. For this release, the only valid value is 2.0.1.

Parameters:

major - The major version. For this release, this value must be 2.

minor - The minor version. For this release, this value must be 0.

revision - For this release, this value must be 1.

getCompatibilityVersion

public Integer getCompatibilityVersion()

Description copied from interface: IASProject

Returns the compatibility version encoded as an integer.

Specified by:

getCompatibilityVersion in interface IASProject

Returns:

the compatibility version encoded as an integer. Null if compatibility version has not been set.

getCompatibilityVersionString

public String getCompatibilityVersionString()

Description copied from interface: IASProject

Returns the compatibility version encoded as a string.

Specified by:

getCompatibilityVersionString in interface IASProject

Returns:

the compatibility version encoded as a string. Null if compatibility version has not been set.

createInvisibleCompilationUnit

public IInvisibleCompilationUnit createInvisibleCompilationUnit(String rootSourceFile,
                                                       IFileSpecificationGetter fileSpecGetter)

Description copied from interface: IASProject

Creates an IInvisibleCompilationUnit for the specified absolute file name.

Specified by:

createInvisibleCompilationUnit in interface IASProject

Parameters:

rootSourceFile - The name of the file to create an IInvisibleCompilationUnit for.

fileSpecGetter - A IFileSpecificationGetter that can be used by the new IInvisibleCompilationUnit to open files.

Returns:

A new IInvisibleCompilationUnit or null if the specified. file name is not found on the current source path of this IASProject.

createInvisibleCompilationUnit

public IInvisibleCompilationUnit createInvisibleCompilationUnit(String rootSourceFile,
                                                       IFileSpecificationGetter fileSpecGetter,
                                                       String qName)

Description copied from interface: IASProject

Creates an IInvisibleCompilationUnit for the specified absolute file name, specifying a qualified name. This version of createInvisibleCompilationUnit() is called when creating a IInvisibleCompilationUnit for a source file which isn't contained within the source path, as the qualified name of the IInvisibleCompilationUnit to be created can't be computed automatically. This happens when creating a IInvisibleCompilationUnit for an external file.

Specified by:

createInvisibleCompilationUnit in interface IASProject

Parameters:

rootSourceFile - The name of the file to create an IInvisibleCompilationUnit for.

fileSpecGetter - A IFileSpecificationGetter that can be used by the new IInvisibleCompilationUnit to open files.

qName - The qualified name of the IInvisibleCompilationUnit

Returns:

A new IInvisibleCompilationUnit or null if the specified. file name is not found on the current source path of this IASProject.

isAssetEmbeddingSupported

public boolean isAssetEmbeddingSupported()

Description copied from interface: ICompilerProject

Test whether the project supports the embedding of assets.

Specified by:

isAssetEmbeddingSupported in interface ICompilerProject

Returns:

true if embedding is supported, false otherwise

isSupportedSourceFileType

public boolean isSupportedSourceFileType(String fileExtension)

Description copied from interface: IASProject

Determines if the specified file extension ( without the dot eg: as, not .as ) corresponds to a source file type that this project can create ICompilationUnits for.

Specified by:

isSupportedSourceFileType in interface IASProject

Parameters:

fileExtension - The file extension to check without a dot, for example mxml.

Returns:

true if the file type associated with the specified file extension is supported by this project, false otherwise.