org.apache.flex.compiler.internal.workspaces

Class Workspace

java.lang.Object

org.apache.flex.compiler.internal.workspaces.Workspace

All Implemented Interfaces:

IFileSpecificationGetter, IWorkspace

public final class Workspace
extends Object
implements IWorkspace

Maintains a collection of ICompilerProject's in the workspace and state that is shared across multiple CompilerProject's

Field Summary

Fields

Modifier and Type	Field and Description
ReadWriteLock	embedLock
protected Map<CompilerProject,Object>	projects

Fields inherited from interface org.apache.flex.compiler.workspaces.IWorkspace

NIL_COMPILATIONUNITS_TO_UPDATE

Constructor Summary

Constructors

Constructor and Description
Workspace() Constructor
Workspace(ExecutorService es) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	addCompilationUnit(ICompilationUnit compilationUnit) Maintain a mapping between filenames and compilation units.
void	addIncludedFilesToCompilationUnit(ICompilationUnit includingCompilationUnit, Collection<String> includedFiles) Specifies that the specified compilation unit includes the specified list of files.
void	addInvalidationListener(IInvalidationListener invalidationListner) Adds a IInvalidationListener on the workspace.
void	addProject(CompilerProject project)
void	close() Close the workspace.
void	deleteProject(ICompilerProject compilerProject) Delete the reference of compiler project from the workspace
void	doneBuilding() Allows the workspace to enter the idle state once all pending operations are completed.
void	endIdleState(Map<ICompilerProject,Set<ICompilationUnit>> cusToUpdate) Updates symbol table entries for all the ICompilationUnits in the specified map and unlocks the lock acquired by calling IWorkspace.startIdleState().
void	endRequest() Called by code in RequestMaker when a request has completed execution.
void	fileAdded(IFileSpecification addedFile) Called by clients of the driver object model when a file add has been detected.
void	fileChanged(IFileSpecification changedFile) Called by clients of the driver object model when a file change has been detected.
void	fileRemoved(IFileSpecification removedFile) Called by clients of the driver object model when a file remove has been detected.
IASDocDelegate	getASDocDelegate() Gets the IASDocDelegate that instances of ASParser will use to record information about ASDoc comments.
EmbedData	getCanonicalEmbedData(EmbedData data) If there is an existing EmbedData which is equivalent to the data EmbedData, return the equiv. otherwise return the entered EmbedData
Collection<WeakReference<ICompilationUnit>>	getCompilationUnits(String path) Get all compilation units from the filename across all projects
Collection<ICompilationUnit>	getCompilationUnits(String path, ICompilerProject project) Get all compilation units in the specified project related to the specified file name.
Map<EmbedData,EmbedData>	getEmbedDatas() Returns all EmbedDatas
ExecutorService	getExecutorService() Gets the ExecutorService to use in this workspace.
IFileSpecification	getFileSpecification(String path) Returns the most recent IFileSpecification given to the workspace for a specified path.
IFileSpecification	getFileSpecificationForCompilationUnit(ICompilationUnit compilationUnit) Gets the IFileSpecification for the root source file of the specified ICompilationUnit.
Collection<ICompilationUnit>	getIncludingCompilationUnits(String path, ICompilerProject project) Get all compilation units from which the filename is included related to the specified project
Iterable<ICompilationUnit>	getInvisibleAndVisibleCompilationUnits(String path, ICompilerProject project) Gets an iterator that iterates first over all invisible ICompilationUnit's for the specified file path in the specified ICompilerProject and then over all visible ICompilationUnit's for the specified file path in the specified ICompilerProject.
com.google.common.base.FinalizableReferenceQueue	getInvisibleCompilationUnitReferenceQueue() Returns the invisibleCompilationUnitReferenceQueue which is used to remove the backing Compilation Units when invisible compilation units get gc'd
Collection<WeakReference<ICompilationUnit>>	getInvisibleCompilationUnits(String path) Get all invisible compilation units from the filename across all projects
IBinaryFileSpecification	getLatestBinaryFileSpecification(String path) Returns the most recent IBinaryFileSpecification given to the workspace for a specified path.
IMXMLDataManager	getMXMLDataManager() Gets the singleton that manages DOM-like MXMLData objects for MXML files in the workspace.
PackageNamespaceDefinitionCache	getPackageNamespaceDefinitionCache()
IWorkspaceProfilingDelegate	getProfilingDelegate() Gets the IWorkspaceProfilingDelegate from the workspace.
ReferenceCache	getReferenceCache() Get the ReferenceCache used by this workspace.
ISWCManager	getSWCManager() Get the SWC manager.
IWorkspace	getWorkspace() Returns the IWorkspace associated with the implementation, must never be null.
boolean	isBuilding() Determines if there is any currently running build activity in the workspace.
void	removeCompilationUnit(ICompilationUnit compilationUnit) Remove a compilation unit from the filename to compilation unit map
void	removeIncludedFilesToCompilationUnit(ICompilationUnit includingCompilationUnit, Collection<String> includedFiles) Remove any references to the compilation unit to the collection of include files it includes.
void	removeInvalidationListener(IInvalidationListener invalidationListner) Removes a IInvalidationListener on the workspace.
void	setASDocDelegate(IASDocDelegate asDocDelegate) Sets the IASDocDelegate that instances of ASParser will use to record information about ASDoc comments.
void	setProfilingDelegate(IWorkspaceProfilingDelegate profilingDelegate) Sets the IWorkspaceProfilingDelegate on the workspace.
void	startBuilding() Waits for the workspace to leave the idle state and prevents all threads from putting the workspace into the idle state.
void	startIdleState() Waits for all pending operation on all ICompilationUnit's in all ICompilerProjects in this IWorkspace to complete.
void	startRequest(boolean requestNeededForFileScope) Called by code in RequestMaker when a request is about to be submitted for execution.
void	swcChanged(Collection<ICompilationUnit> unitsRemoved, Collection<ICompilationUnit> unitsAdded, Runnable runWhileIdle) When an ISWC has changed in memory, invalidate any compilation units which depend on the units which depend on the SWC

Methods inherited from class java.lang.Object

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

Field Detail

projects

protected final Map<CompilerProject,Object> projects

embedLock

public final ReadWriteLock embedLock

Constructor Detail

Workspace

public Workspace()

Constructor

Workspace

public Workspace(ExecutorService es)

Constructor

Parameters:

es - ExecutorService to use to do background work in this workspace.

Method Detail

getExecutorService

public ExecutorService getExecutorService()

Gets the ExecutorService to use in this workspace.

Returns:

The ExecutorService to use in this workspace.

startIdleState

public void startIdleState()

Description copied from interface: IWorkspace

Waits for all pending operation on all ICompilationUnit's in all ICompilerProjects in this IWorkspace to complete. The activity lock will also be acquired in this call, so once this method has been called, no new work can be submitted until after the lock has been released by calling IWorkspace.endIdleState(Map).

This method must never be called from an ICompilationUnit operation as that would result in dead lock.

Specified by:

startIdleState in interface IWorkspace

endIdleState

public void endIdleState(Map<ICompilerProject,Set<ICompilationUnit>> cusToUpdate)

Description copied from interface: IWorkspace

Updates symbol table entries for all the ICompilationUnits in the specified map and unlocks the lock acquired by calling IWorkspace.startIdleState().

Specified by:

endIdleState in interface IWorkspace

Parameters:

cusToUpdate - Map from ICompilerProject to Set of ICompilationUnits in the project whose externally visible symbols need to be re-registered with the symbol table of the containing ICompilerProject.

startBuilding

public void startBuilding()

Description copied from interface: IWorkspace

Waits for the workspace to leave the idle state and prevents all threads from putting the workspace into the idle state. Calls to this method must be balanced with calls to IWorkspace.doneBuilding().

Specified by:

startBuilding in interface IWorkspace

doneBuilding

public void doneBuilding()

Description copied from interface: IWorkspace

Allows the workspace to enter the idle state once all pending operations are completed. Each call to this method should succeed exactly one call to IWorkspace.startBuilding().

Specified by:

doneBuilding in interface IWorkspace

startRequest

public void startRequest(boolean requestNeededForFileScope)

Called by code in RequestMaker when a request is about to be submitted for execution. Blocks until the workspace has left the idle state.

Parameters:

requestNeededForFileScope - true if the request that is about to be submitted for execution is needed to build an IFileScope.

endRequest

public void endRequest()

Called by code in RequestMaker when a request has completed execution.

isBuilding

public boolean isBuilding()

Determines if there is any currently running build activity in the workspace. This method should only be called from assert statements, it is meant only for debugging.

Returns:

true if there is any build activity, false otherwise.

setProfilingDelegate

public void setProfilingDelegate(IWorkspaceProfilingDelegate profilingDelegate)

Description copied from interface: IWorkspace

Sets the IWorkspaceProfilingDelegate on the workspace.

Specified by:

setProfilingDelegate in interface IWorkspace

Parameters:

profilingDelegate - IWorkspaceProfilingDelegate that will receive profiling information. Can be null, in which case no profiling information is collected.

getProfilingDelegate

public IWorkspaceProfilingDelegate getProfilingDelegate()

Description copied from interface: IWorkspace

Gets the IWorkspaceProfilingDelegate from the workspace.

Specified by:

getProfilingDelegate in interface IWorkspace

Returns:

The IWorkspaceProfilingDelegate for this IWorkspace. Can be null.

addInvalidationListener

public void addInvalidationListener(IInvalidationListener invalidationListner)

Description copied from interface: IWorkspace

Adds a IInvalidationListener on the workspace.

Specified by:

addInvalidationListener in interface IWorkspace

Parameters:

invalidationListner - IInvalidationListener that will receive invalidation notifications.

removeInvalidationListener

public void removeInvalidationListener(IInvalidationListener invalidationListner)

Description copied from interface: IWorkspace

Removes a IInvalidationListener on the workspace.

Specified by:

removeInvalidationListener in interface IWorkspace

Parameters:

invalidationListner - IInvalidationListener that will be removed.

getSWCManager

public ISWCManager getSWCManager()

Description copied from interface: IWorkspace

Get the SWC manager.

Specified by:

getSWCManager in interface IWorkspace

Returns:

the swcManager

getPackageNamespaceDefinitionCache

public PackageNamespaceDefinitionCache getPackageNamespaceDefinitionCache()

close

public void close()

Close the workspace. It is illegal to use the workspace after it has been closed.

swcChanged

public void swcChanged(Collection<ICompilationUnit> unitsRemoved,
              Collection<ICompilationUnit> unitsAdded,
              Runnable runWhileIdle)

When an ISWC has changed in memory, invalidate any compilation units which depend on the units which depend on the SWC

Parameters:

unitsRemoved - The collection of compilation units to be removed.

unitsAdded - The collection compilation units to be added.

fileChanged

public void fileChanged(IFileSpecification changedFile)

Description copied from interface: IWorkspace

Called by clients of the driver object model when a file change has been detected. It is the duty of the caller to ensure no new threads are created until after this call has completed.

Specified by:

fileChanged in interface IWorkspace

Parameters:

changedFile - An IFileSpecification that can be used to get the change filename.

fileRemoved

public void fileRemoved(IFileSpecification removedFile)

Description copied from interface: IWorkspace

Called by clients of the driver object model when a file remove has been detected. It is the duty of the caller to ensure no new threads are created until after this call has completed.

Specified by:

fileRemoved in interface IWorkspace

Parameters:

removedFile - An IFileSpecification that can be used to get the new contents of the removed file.

fileAdded

public void fileAdded(IFileSpecification addedFile)

Description copied from interface: IWorkspace

Called by clients of the driver object model when a file add has been detected. It is the duty of the caller to ensure no new threads are created until after this call has completed.

Specified by:

fileAdded in interface IWorkspace

Parameters:

addedFile - An IFileSpecification that can be used to get the name and contents of the added file.

getFileSpecificationForCompilationUnit

public IFileSpecification getFileSpecificationForCompilationUnit(ICompilationUnit compilationUnit)

Gets the IFileSpecification for the root source file of the specified ICompilationUnit.

Parameters:

compilationUnit - A compilation unit.

Returns:

Tthe IFileSpecification for the root source file of the specified ICompilationUnit

addCompilationUnit

public void addCompilationUnit(ICompilationUnit compilationUnit)

Maintain a mapping between filenames and compilation units. Needed for incremental compilation.

addIncludedFilesToCompilationUnit

public void addIncludedFilesToCompilationUnit(ICompilationUnit includingCompilationUnit,
                                     Collection<String> includedFiles)

Specifies that the specified compilation unit includes the specified list of files. Called by ICompilationUnit's when they discover included files.

Parameters:

includingCompilationUnit - ICompilationUnit that contains include statements that reference the specified list of files.

includedFiles - The included files.

removeIncludedFilesToCompilationUnit

public void removeIncludedFilesToCompilationUnit(ICompilationUnit includingCompilationUnit,
                                        Collection<String> includedFiles)

Remove any references to the compilation unit to the collection of include files it includes.

Parameters:

includingCompilationUnit - ICompilationUnit that contains include statements that reference the specified list of files.

includedFiles - The included files.

removeCompilationUnit

public void removeCompilationUnit(ICompilationUnit compilationUnit)

Remove a compilation unit from the filename to compilation unit map

Parameters:

compilationUnit - The compilation unit to be removed.

getCompilationUnits

public Collection<WeakReference<ICompilationUnit>> getCompilationUnits(String path)

Get all compilation units from the filename across all projects

Parameters:

path - String to source filename

getInvisibleCompilationUnits

public Collection<WeakReference<ICompilationUnit>> getInvisibleCompilationUnits(String path)

Get all invisible compilation units from the filename across all projects

Parameters:

path - String to source filename

getCompilationUnits

public Collection<ICompilationUnit> getCompilationUnits(String path,
                                               ICompilerProject project)

Description copied from interface: IWorkspace

Get all compilation units in the specified project related to the specified file name. This method will not return any invisible compilation units.

Specified by:

getCompilationUnits in interface IWorkspace

Parameters:

path - String to source filename

project - containing project

getInvisibleAndVisibleCompilationUnits

public Iterable<ICompilationUnit> getInvisibleAndVisibleCompilationUnits(String path,
                                                                ICompilerProject project)

Description copied from interface: IWorkspace

Gets an iterator that iterates first over all invisible ICompilationUnit's for the specified file path in the specified ICompilerProject and then over all visible ICompilationUnit's for the specified file path in the specified ICompilerProject.

Specified by:

getInvisibleAndVisibleCompilationUnits in interface IWorkspace

Parameters:

path - Normalized absolute file name.

project - ICompilerProject that will contains all the ICompilationUnit in the returned Iterable.

Returns:

An iterator that iterates first over all invisible ICompilationUnit's for the specified file path in the specified ICompilerProject and then over all visible ICompilationUnit's for the specified file path in the specified ICompilerProject

getIncludingCompilationUnits

public Collection<ICompilationUnit> getIncludingCompilationUnits(String path,
                                                        ICompilerProject project)

Get all compilation units from which the filename is included related to the specified project

Parameters:

path - String to source filename

project - containing project

getCanonicalEmbedData

public EmbedData getCanonicalEmbedData(EmbedData data)

If there is an existing EmbedData which is equivalent to the data EmbedData, return the equiv. otherwise return the entered EmbedData

Parameters:

data - The embedding data.

Returns:

the canonical EmbedData

getEmbedDatas

public Map<EmbedData,EmbedData> getEmbedDatas()

Returns all EmbedDatas

Returns:

map of EmbedDatas

getInvisibleCompilationUnitReferenceQueue

public com.google.common.base.FinalizableReferenceQueue getInvisibleCompilationUnitReferenceQueue()

Returns the invisibleCompilationUnitReferenceQueue which is used to remove the backing Compilation Units when invisible compilation units get gc'd

Returns:

the invisibleCompilationUnitReferenceQueue

getMXMLDataManager

public IMXMLDataManager getMXMLDataManager()

Description copied from interface: IWorkspace

Gets the singleton that manages DOM-like MXMLData objects for MXML files in the workspace.

Specified by:

getMXMLDataManager in interface IWorkspace

Returns:

IMXMLDataManager object

getFileSpecification

public IFileSpecification getFileSpecification(String path)

Returns the most recent IFileSpecification given to the workspace for a specified path. If the workspace has not seen the specified path before a new FileSpecification is returned.

Specified by:

getFileSpecification in interface IFileSpecificationGetter

Parameters:

path - Path for which a IFileSpecification should be returned.

Returns:

The most recent IFileSpecification given to the workspace for a specified path.

getWorkspace

public IWorkspace getWorkspace()

Description copied from interface: IFileSpecificationGetter

Returns the IWorkspace associated with the implementation, must never be null.

Specified by:

getWorkspace in interface IFileSpecificationGetter

Returns:

the IWorkspace associated with the implementation, must never be null.

getLatestBinaryFileSpecification

public IBinaryFileSpecification getLatestBinaryFileSpecification(String path)

Returns the most recent IBinaryFileSpecification given to the workspace for a specified path. If the workspace has not seen the specified path before a new IBinaryFileSpecification is returned. This method assumes that if there is an existing filespec, it is a binary filespec.

Parameters:

path - Path for which a IBinaryFileSpecification should be returned.

Returns:

The most recent IBinaryFileSpecification given to the workspace for a specified path.

getReferenceCache

public ReferenceCache getReferenceCache()

Get the ReferenceCache used by this workspace. This is to facilitate caching of IReference objects across the workspace, as many references will be repeated throughout a workspace. Since the IReferences are immutable, they need not be tied to a particular Project

Returns:

the ReferenceCache this workspace is using.

deleteProject

public void deleteProject(ICompilerProject compilerProject)

Delete the reference of compiler project from the workspace

Parameters:

compilerProject - ICompilerProject

getASDocDelegate

public IASDocDelegate getASDocDelegate()

Description copied from interface: IWorkspace

Gets the IASDocDelegate that instances of ASParser will use to record information about ASDoc comments.

Specified by:

getASDocDelegate in interface IWorkspace

Returns:

The IASDocDelegate that instances of ASParser will use to record information about ASDoc comments.

setASDocDelegate

public void setASDocDelegate(IASDocDelegate asDocDelegate)

Description copied from interface: IWorkspace

Sets the IASDocDelegate that instances of ASParser will use to record information about ASDoc comments.

Specified by:

setASDocDelegate in interface IWorkspace

Parameters:

asDocDelegate - IASDocDelegate that instances of ASParser will use to record information about ASDoc comments.

addProject

public void addProject(CompilerProject project)