org.apache.royale.compiler.units

Interface ICompilationUnit

public interface ICompilationUnit

A unit of compilation. Implementations provide methods to request definitions ( getFileScopeRequest ), semantic errors/warnings ( getOutgoingDependenciesRequest ), abc bytes ( getABCBytesRequest ), and SWF tags ( getSWFTagsRequest ). Implementations of this interface are the main means that AS3, MXML, and associated source files are converted to bytes in SWF.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ICompilationUnit.Operation An enumeration with an entry for each ICompilationUnit operation.
static class	ICompilationUnit.UnitType An enumeration with an entry for each ICompilationUnit source type.

Method Summary

Modifier and Type	Method and Description
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()
IDefinitionPriority	getDefinitionPriority() Gets the definition priority for definitions defined by the compilation unit.
List<IDefinition>	getDefinitionPromises()
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	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.

Method Detail

getProject

ICompilerProject getProject()

Returns:

The project that contains this ICompilationUnit.

getSyntaxTreeRequest

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. Implementations may update the dependency graph in the project as a side affect of this operation.

Returns:

The request object for the getFileScope operation.

getFileScopeRequest

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. Implementations may update the dependency graph in the project as a side affect of this operation.

Returns:

The request object for the getFileScope operation.

getOutgoingDependenciesRequest

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.

Returns:

The request object for the getFileScope operation.

getABCBytesRequest

IRequest<IABCBytesRequestResult,ICompilationUnit> getABCBytesRequest()

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.

Returns:

The request object for the getFileScope operation.

getSWFTagsRequest

IRequest<ISWFTagsRequestResult,ICompilationUnit> getSWFTagsRequest()

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.

Returns:

The request object for the getFileScope operation.

getShortNames

List<String> getShortNames()
                    throws InterruptedException

Returns:

The identifier names defined by the compilation unit

Throws:

InterruptedException

getQualifiedNames

List<String> getQualifiedNames()
                        throws InterruptedException

Returns:

The qualified names defined by the compilation unit

Throws:

InterruptedException

getName

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

Returns:

The unique name string for the compilation unit.

getAbsoluteFilename

String getAbsoluteFilename()

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.

Returns:

The absolute path for the compilation unit.

getDefinitionPromises

List<IDefinition> getDefinitionPromises()

Returns:

List of definition promises

getCompilationUnitType

ICompilationUnit.UnitType getCompilationUnitType()

Returns:

the compilation unit type

clean

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. Read the CompilerProject.clean implementation for more details.

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

IDefinitionPriority getDefinitionPriority()

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.

Returns:

The definition priority for definitions defined by the compilation unit.

clearProject

void clearProject()

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 getProject() should return null.

waitForBuildFinish

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

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.

Parameters:

problems - Problems from executing the requests.

targetType - type of the active Target

Throws:

InterruptedException - Concurrency error.

See Also:

startBuildAsync(org.apache.royale.compiler.targets.ITarget.TargetType)

startBuildAsync

void startBuildAsync(ITarget.TargetType targetType)

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

Parameters:

targetType - type of the active Target

isInvisible

boolean isInvisible()

Returns:

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

getEmbeddedFilenames

Collection<String> getEmbeddedFilenames()

Returns:

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