org.apache.flex.compiler.internal.units

Class InvisibleCompilationUnit

java.lang.Object

org.apache.flex.compiler.internal.units.InvisibleCompilationUnit

All Implemented Interfaces:

ICompilationUnit, IInvisibleCompilationUnit

public class InvisibleCompilationUnit
extends Object
implements IInvisibleCompilationUnit

Implementation of IInvisibleCompilationUnit.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flex.compiler.units.ICompilationUnit

ICompilationUnit.Operation, ICompilationUnit.UnitType

Constructor Summary

Constructors

Constructor and Description
InvisibleCompilationUnit(CompilationUnitBase delegate, IFileSpecificationGetter fileSpecGetter) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	clean() Invalidates the processing results of this IInvisibleCompilationUnit.
boolean	clean(Map<ICompilerProject,Set<File>> invalidatedSWCFiles, Map<ICompilerProject,Set<ICompilationUnit>> cusToUpdate, boolean clearFileScope) Removes all data created during a compile Clients should not call this method directly, as it can potentially leave the ICompilationUnit in an invalid state.
void	clearProject() Called by ICompilerProject's when an ICompilationUnit is removed from a project.
IRequest<IABCBytesRequestResult,ICompilationUnit>	getABCBytesRequest() Gets the request object from which the caller can extract the abc bytes generated for this ICompilationUnit.
String	getAbsoluteFilename() Gets the path to the compilation unit instance.
ICompilationUnit.UnitType	getCompilationUnitType()
void	getCompilerProblems(Collection<ICompilerProblem> problems) Finds all the ICompilerProblem's in this IInvisibleCompilationUnit.
IDefinitionPriority	getDefinitionPriority() Gets the definition priority for definitions defined by the compilation unit.
List<IDefinition>	getDefinitionPromises()
CompilationUnitBase	getDelegate()
Collection<String>	getEmbeddedFilenames()
IRequest<IFileScopeRequestResult,ICompilationUnit>	getFileScopeRequest() Gets the request object from which the caller can extract the root scope, AST, and any parsing ICompilerProblems, for the CompilationUnit.
String	getName() Gets a string that is unique to the compilation unit instance and can be used to produce an ordering of compilation units that is stable across different compilation runs.
IRequest<IOutgoingDependenciesRequestResult,ICompilationUnit>	getOutgoingDependenciesRequest() Gets the request object from which the caller cause the dependency graph to be updated with all the dependencies from this compilation unit.
ICompilerProject	getProject()
List<String>	getQualifiedNames()
List<String>	getShortNames()
IRequest<ISWFTagsRequestResult,ICompilationUnit>	getSWFTagsRequest() Gets the request object with which the caller can add the SWF tags generated for this ICompilationUnit to a ISWF.
IRequest<ISyntaxTreeRequestResult,ICompilationUnit>	getSyntaxTreeRequest() Gets the request object from which the caller can extract the syntax tree and any source file parsing ICompilerProblem's for this ICompilationUnit.
boolean	isInvisible()
void	remove() Explicitly removes this IInvisibleCompilationUnit from an IASProject.
void	startBuildAsync(ITarget.TargetType targetType) This method starts to build the compilation unit asynchronously.
void	waitForBuildFinish(Collection<ICompilerProblem> problems, ITarget.TargetType targetType) Wait till the compilation unit finishes building, and collect compiler problems.

Methods inherited from class java.lang.Object

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

Constructor Detail

InvisibleCompilationUnit

public InvisibleCompilationUnit(CompilationUnitBase delegate,
                        IFileSpecificationGetter fileSpecGetter)

Constructor.

Parameters:

delegate - CompilationUnitBase that this class will delegate to.

fileSpecGetter - IFileSpecificationGetter that should be used to open files.

Method Detail

getProject

public ICompilerProject getProject()

Specified by:

getProject in interface ICompilationUnit

Returns:

The project that contains this ICompilationUnit.

getSyntaxTreeRequest

public IRequest<ISyntaxTreeRequestResult,ICompilationUnit> getSyntaxTreeRequest()

Description copied from interface: ICompilationUnit

Gets the request object from which the caller can extract the syntax tree and any source file parsing ICompilerProblem's for this ICompilationUnit. Implementations may update the dependency graph in the project as a side affect of this operation.

Specified by:

getSyntaxTreeRequest in interface ICompilationUnit

Returns:

The request object for the getFileScope operation.

getFileScopeRequest

public IRequest<IFileScopeRequestResult,ICompilationUnit> getFileScopeRequest()

Description copied from interface: ICompilationUnit

Gets the request object from which the caller can extract the root scope, AST, and any parsing ICompilerProblems, for the CompilationUnit. Implementations may update the dependency graph in the project as a side affect of this operation.

Specified by:

getFileScopeRequest in interface ICompilationUnit

Returns:

The request object for the getFileScope operation.

getOutgoingDependenciesRequest

public IRequest<IOutgoingDependenciesRequestResult,ICompilationUnit> getOutgoingDependenciesRequest()

Description copied from interface: ICompilationUnit

Gets the request object from which the caller cause the dependency graph to be updated with all the dependencies from this compilation unit.

Specified by:

getOutgoingDependenciesRequest in interface ICompilationUnit

Returns:

The request object for the getFileScope operation.

getABCBytesRequest

public IRequest<IABCBytesRequestResult,ICompilationUnit> getABCBytesRequest()

Description copied from interface: ICompilationUnit

Gets the request object from which the caller can extract the abc bytes generated for this ICompilationUnit. Implementations may update the dependency graph in the project as a side affect of this operation.

Specified by:

getABCBytesRequest in interface ICompilationUnit

Returns:

The request object for the getFileScope operation.

getSWFTagsRequest

public IRequest<ISWFTagsRequestResult,ICompilationUnit> getSWFTagsRequest()

Description copied from interface: ICompilationUnit

Gets the request object with which the caller can add the SWF tags generated for this ICompilationUnit to a ISWF. Implementations may update the dependency graph in the project as a side affect of this operation.

Specified by:

getSWFTagsRequest in interface ICompilationUnit

Returns:

The request object for the getFileScope operation.

getShortNames

public List<String> getShortNames()
                           throws InterruptedException

Specified by:

getShortNames in interface ICompilationUnit

Returns:

The identifier names defined by the compilation unit

Throws:

InterruptedException

getQualifiedNames

public List<String> getQualifiedNames()
                               throws InterruptedException

Specified by:

getQualifiedNames in interface ICompilationUnit

Returns:

The qualified names defined by the compilation unit

Throws:

InterruptedException

getName

public String getName()

Description copied from interface: ICompilationUnit

Gets a string that is unique to the compilation unit instance and can be used to produce an ordering of compilation units that is stable across different compilation runs. Note that is is critical that everyone who implements this interface implements this method correctly. If not, the compiler will act in a non-deterministic way. Also, note that this is the String that will be written to the link report as the name of this compilation unit.

Specified by:

getName in interface ICompilationUnit

Returns:

The unique name string for the compilation unit.

getAbsoluteFilename

public String getAbsoluteFilename()

Description copied from interface: ICompilationUnit

Gets the path to the compilation unit instance. The string is unique to the compilation unit instance. This string will also be used in reporting errors.

Specified by:

getAbsoluteFilename in interface ICompilationUnit

Returns:

The absolute path for the compilation unit.

getDefinitionPromises

public List<IDefinition> getDefinitionPromises()

Specified by:

getDefinitionPromises in interface ICompilationUnit

Returns:

List of definition promises

getCompilationUnitType

public ICompilationUnit.UnitType getCompilationUnitType()

Specified by:

getCompilationUnitType in interface ICompilationUnit

Returns:

the compilation unit type

clean

public boolean clean(Map<ICompilerProject,Set<File>> invalidatedSWCFiles,
            Map<ICompilerProject,Set<ICompilationUnit>> cusToUpdate,
            boolean clearFileScope)

Description copied from interface: ICompilationUnit

Removes all data created during a compile Clients should not call this method directly, as it can potentially leave the ICompilationUnit in an invalid state. Read the CompilerProject.clean implementation for more details.

Specified by:

clean in interface ICompilationUnit

Parameters:

invalidatedSWCFiles - Map of SWC filenames and depending projects which have been invalidated by this call

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 when cleaning is complete.

clearFileScope - Whether to clear the file scope

Returns:

whether an invalidation was done

getDefinitionPriority

public IDefinitionPriority getDefinitionPriority()

Description copied from interface: ICompilationUnit

Gets the definition priority for definitions defined by the compilation unit. The "priority" of a definition determines whether that definition shadows definitions from other compilation units that have the same qname.

Specified by:

getDefinitionPriority in interface ICompilationUnit

Returns:

The definition priority for definitions defined by the compilation unit.

clearProject

public void clearProject()

Description copied from interface: ICompilationUnit

Called by ICompilerProject's when an ICompilationUnit is removed from a project. Implementations should clear an references to the containing project when this method is called. After this method is called ICompilationUnit.getProject() should return null.

Specified by:

clearProject in interface ICompilationUnit

waitForBuildFinish

public void waitForBuildFinish(Collection<ICompilerProblem> problems,
                      ITarget.TargetType targetType)
                        throws InterruptedException

Description copied from interface: ICompilationUnit

Wait till the compilation unit finishes building, and collect compiler problems. After calling this method, this compilation unit will be in a fully compiled state.

Specified by:

waitForBuildFinish in interface ICompilationUnit

Parameters:

problems - Problems from executing the requests.

targetType - type of the active Target

Throws:

InterruptedException - Concurrency error.

See Also:

ICompilationUnit.startBuildAsync(org.apache.flex.compiler.targets.ITarget.TargetType)

startBuildAsync

public void startBuildAsync(ITarget.TargetType targetType)

Description copied from interface: ICompilationUnit

This method starts to build the compilation unit asynchronously. It kicks off all the request methods on the compilation unit.

Specified by:

startBuildAsync in interface ICompilationUnit

Parameters:

targetType - type of the active Target

isInvisible

public boolean isInvisible()

Specified by:

isInvisible in interface ICompilationUnit

Returns:

true if this ICompilationUnit does *not* put its global definitions in the ICompilerProject's symbol table, false otherwise.

getCompilerProblems

public void getCompilerProblems(Collection<ICompilerProblem> problems)
                         throws InterruptedException

Description copied from interface: IInvisibleCompilationUnit

Finds all the ICompilerProblem's in this IInvisibleCompilationUnit.

Specified by:

getCompilerProblems in interface IInvisibleCompilationUnit

Parameters:

problems - Collection the ICompilerProblem's should be added to.

Throws:

InterruptedException

clean

public void clean()

Description copied from interface: IInvisibleCompilationUnit

Invalidates the processing results of this IInvisibleCompilationUnit. Should be called by clients when ever any of the inputs of this IInvisibleCompilationUnit change. Changes to the IASProject's settings do *not* automatically invalidate the processing results of this IInvisibleCompilationUnit. Clients should manually call this methods after changing a IASProject settings ( we should fix this in the future... ).

Specified by:

clean in interface IInvisibleCompilationUnit

remove

public void remove()

Description copied from interface: IInvisibleCompilationUnit

Explicitly removes this IInvisibleCompilationUnit from an IASProject. This method will ensure that various cache entries in the IASProject and IWorkspace are purged.

Clients don't need to call this, but calling it allows certain resource cleanups to happen earlier than would normally.

Specified by:

remove in interface IInvisibleCompilationUnit

getEmbeddedFilenames

public Collection<String> getEmbeddedFilenames()

Specified by:

getEmbeddedFilenames in interface ICompilationUnit

Returns:

A collection of all filenames which are embedded in this ICompilationUnit through Embed metadata. This will never return null.

getDelegate

public CompilationUnitBase getDelegate()

Returns:

The delegate compilation unit for this InvisibleCompilationUnit