org.apache.flex.compiler.internal.units

Class SWCCompilationUnit

java.lang.Object

org.apache.flex.compiler.internal.units.CompilationUnitBase

org.apache.flex.compiler.internal.units.SWCCompilationUnit

All Implemented Interfaces:

ICompilationUnit

public class SWCCompilationUnit
extends CompilationUnitBase

This is a compilation unit for a script in a SWC library. Every SWC library has one or multiple libraries. (i.e. library.swf) Each library has multiple script definition. A script has a name which maps to a named DoABC tag in the library SWF.

A SWCCompilationUnit is similar to ABCCompilationUnit that they both deal with ABC byte code. The difference is that ABCCompilationUnit requires ABC byte code when created, while SWCCompilationUnit only need a pointer to the script location. SWCCompilationUnit does not request or digest the ABC byte code until any of the handlers is called.

Nested Class Summary

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

ICompilationUnit.Operation, ICompilationUnit.UnitType

Field Summary

Fields inherited from class org.apache.flex.compiler.internal.units.CompilationUnitBase

abc, DEFAULT_DO_ABC_TAG_NAME, fileScopeRequest, problems, syntaxTreeRequest

Constructor Summary

Constructors

Constructor and Description
SWCCompilationUnit(CompilerProject project, ISWC swc, ISWCLibrary library, ISWCScript script, List<String> qnames, int order) Create a compilation unit from ABC byte code in a SWF tag.

Method Summary

Methods

Modifier and Type	Method and Description
ICompilationUnit.UnitType	getCompilationUnitType()
protected static String	getLinkReportName(ICompilationUnit cu)
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.
protected IABCBytesRequestResult	handleABCBytesRequest() Find the DoABC tag from SWFCache by script name and extract the ABC bytes.
protected void	handleClean(boolean cleanFileScope, Map<ICompilerProject,Set<File>> invalidatedSWCFiles) This method is overriden by base classes to clean additional processing results not cleaned by the clean method above.
protected IFileScopeRequestResult	handleFileScopeRequest() Builds a IFileScopeRequestResult.
protected IOutgoingDependenciesRequestResult	handleOutgoingDependenciesRequest() Builds a IOutgoingDependenciesRequestResult.
protected ISWFTagsRequestResult	handleSWFTagsRequest() Add a DoABC tag for the definition of this compilation unit and its asset tags to the SWF.
protected ISyntaxTreeRequestResult	handleSyntaxTreeRequest() Builds a ISyntaxTreeRequestResult.
boolean	isANE() Test if this compilation unit comes from an ANE File.
String	toString() For debugging.

Methods inherited from class org.apache.flex.compiler.internal.units.CompilationUnitBase

addScopeToProjectScope, clean, clearIncludedFilesFromWorkspace, clearProject, getABCBytesRequest, getAbsoluteFilename, getDefinitionPriority, getDefinitionPromises, getEmbeddedFilenames, getEncodedDebugFiles, getFilenameNoPath, getFileScopeRequest, getFileSpecificationGetter, getOutgoingDependenciesRequest, getProject, getQualifiedNames, getRootFileSpecification, getShortNames, getSWFTagsRequest, getSyntaxTreeRequest, isInvisible, makeInvisible, operationsCompleted, removeAST, setFileSpecificationGetter, startBuildAsync, startParsingImports, startProfile, stopProfile, updateEmbedCompilationUnitDependencies, updateStyleCompilationUnitDependencies, verifyAST, waitForBuildFinish

Methods inherited from class java.lang.Object

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

Constructor Detail

SWCCompilationUnit

public SWCCompilationUnit(CompilerProject project,
                  ISWC swc,
                  ISWCLibrary library,
                  ISWCScript script,
                  List<String> qnames,
                  int order)

Create a compilation unit from ABC byte code in a SWF tag. If a script has multiple public definitions, they will share one SWCCompilationUnit.

Parameters:

project - compiler project

script - script information

qnames - of qnames within this swc

order - the order the SWC was added to the project. The lower the order the higher the priority of the compilation unit. The order is compared only if the timestamps of two compilation units are equal.

Method Detail

getCompilationUnitType

public ICompilationUnit.UnitType getCompilationUnitType()

Returns:

the compilation unit type

handleSyntaxTreeRequest

protected ISyntaxTreeRequestResult handleSyntaxTreeRequest()
                                                    throws InterruptedException

Description copied from class: CompilationUnitBase

Builds a ISyntaxTreeRequestResult. In many cases the ISyntaxTreeRequestResult is built by parsing a source file into a syntax tree.

Called by this class from potentially any thread. This class guarantees that this method will only be entered from one thread at a time for a given instance of this class, so implementations do not need to make this a synchronized method.

Specified by:

handleSyntaxTreeRequest in class CompilationUnitBase

Returns:

The ISyntaxTreeRequestResult for this compilation unit.

Throws:

InterruptedException

handleFileScopeRequest

protected IFileScopeRequestResult handleFileScopeRequest()
                                                  throws InterruptedException

Description copied from class: CompilationUnitBase

Builds a IFileScopeRequestResult. In many cases the IFileScopeRequestResult is built by walking an AST produced by a parser.

Called by this class from potentially any thread. This class guarantees that this method will only be entered from one thread at a time for a given instance of this class, so implementations do not need to make this a synchronized method.

Specified by:

handleFileScopeRequest in class CompilationUnitBase

Returns:

The IFileScopeRequestResult for this compilation unit.

Throws:

InterruptedException

handleABCBytesRequest

protected IABCBytesRequestResult handleABCBytesRequest()
                                                throws InterruptedException

Find the DoABC tag from SWFCache by script name and extract the ABC bytes.

Specified by:

handleABCBytesRequest in class CompilationUnitBase

Returns:

The IABCBytesRequestResult for this compilation unit.

Throws:

InterruptedException

handleSWFTagsRequest

protected ISWFTagsRequestResult handleSWFTagsRequest()
                                              throws InterruptedException

Add a DoABC tag for the definition of this compilation unit and its asset tags to the SWF. The DoABC tag is copied from the library SWF. The asset tags are from AssetTagCache.

Specified by:

handleSWFTagsRequest in class CompilationUnitBase

Returns:

The ISWFTagsRequestResult for this compilation unit.

Throws:

InterruptedException

handleOutgoingDependenciesRequest

protected IOutgoingDependenciesRequestResult handleOutgoingDependenciesRequest()
                                                                        throws InterruptedException

Description copied from class: CompilationUnitBase

Builds a IOutgoingDependenciesRequestResult. In many cases the IOutgoingDependenciesRequestResult is built getting the walking an AST.

Called by this class from potentially any thread. This class guarantees that this method will only be entered from one thread at a time for a given instance of this class, so implementations do not need to make this a synchronized method.

Specified by:

handleOutgoingDependenciesRequest in class CompilationUnitBase

Returns:

The IOutgoingDependenciesRequestResult for this compilation unit.

Throws:

InterruptedException

isANE

public boolean isANE()

Test if this compilation unit comes from an ANE File.

Returns:

true if the compilation unit comes from an ANE file, false otherwise.

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

Overrides:

getName in class CompilationUnitBase

Returns:

The unique name string for the compilation unit.

handleClean

protected void handleClean(boolean cleanFileScope,
               Map<ICompilerProject,Set<File>> invalidatedSWCFiles)

Description copied from class: CompilationUnitBase

This method is overriden by base classes to clean additional processing results not cleaned by the clean method above.

Overrides:

handleClean in class CompilationUnitBase

getLinkReportName

protected static String getLinkReportName(ICompilationUnit cu)

Returns:

A string for link reports

toString

public String toString()

For debugging.

Overrides:

toString in class CompilationUnitBase

Returns:

a string, which is helpful when inspecting in a debugger.