org.apache.flex.compiler.internal.units

Class CompilationUnitBase

java.lang.Object

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

All Implemented Interfaces:

ICompilationUnit

Direct Known Subclasses:

ABCCompilationUnit, ASCompilationUnit, EmbedCompilationUnit, FXGCompilationUnit, MXMLCompilationUnit, ResourceBundleCompilationUnit, ResourceModuleCompilationUnit, StyleModuleCompilationUnit, SWCCompilationUnit

public abstract class CompilationUnitBase
extends Object
implements ICompilationUnit

Abstract class used to share implementation of some ICompilationUnit methods across multiple concrete implementation classes.

This class converts calls to the getXXXRequest methods to calls into handleXXXRequest methods. Subclasses can just implement the handleXXXRequest methods without having to worry about creating an IRequest implementation.

Nested Class Summary

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

ICompilationUnit.Operation, ICompilationUnit.UnitType

Field Summary

Fields

Modifier and Type	Field and Description
protected AtomicReference<IRequest<IABCBytesRequestResult,ICompilationUnit>>	abc
protected static String	DEFAULT_DO_ABC_TAG_NAME
protected AtomicReference<IRequest<IFileScopeRequestResult,ICompilationUnit>>	fileScopeRequest
protected AtomicReference<IRequest<IOutgoingDependenciesRequestResult,ICompilationUnit>>	problems
protected AtomicReference<IRequest<ISyntaxTreeRequestResult,ICompilationUnit>>	syntaxTreeRequest

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CompilationUnitBase(CompilerProject project, String path, DefinitionPriority.BasePriority basePriority, boolean scopeBuiltFromSytaxTree) Use this constructor if derived class has no definition promises
protected	CompilationUnitBase(CompilerProject project, String path, DefinitionPriority.BasePriority basePriority, Collection<String> qnamesOfDefinitions) This is the most generic constructor
protected	CompilationUnitBase(CompilerProject project, String path, DefinitionPriority.BasePriority basePriority, String qnameOfDefinition) Use this constructor if the derived class has at most one definition promise

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addScopeToProjectScope(ASFileScope[] scopes)
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	clearIncludedFilesFromWorkspace() This method is used to update the Workspace includeFilesToIncludingCompilationUnitMapping map when a file get's cleaned.
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.
IDefinitionPriority	getDefinitionPriority() Gets the definition priority for definitions defined by the compilation unit.
List<IDefinition>	getDefinitionPromises()
Collection<String>	getEmbeddedFilenames()
protected Map<String,String>	getEncodedDebugFiles()
protected String	getFilenameNoPath()
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.
protected IFileSpecificationGetter	getFileSpecificationGetter()
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.
CompilerProject	getProject()
List<String>	getQualifiedNames()
protected IFileSpecification	getRootFileSpecification()
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.
protected abstract IABCBytesRequestResult	handleABCBytesRequest() Builds a IABCBytesRequestResult.
protected void	handleClean(boolean clearFileScope, 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 abstract IFileScopeRequestResult	handleFileScopeRequest() Builds a IFileScopeRequestResult.
protected abstract IOutgoingDependenciesRequestResult	handleOutgoingDependenciesRequest() Builds a IOutgoingDependenciesRequestResult.
protected abstract ISWFTagsRequestResult	handleSWFTagsRequest() Builds a ISWFTagsRequestResult.
protected abstract ISyntaxTreeRequestResult	handleSyntaxTreeRequest() Builds a ISyntaxTreeRequestResult.
boolean	isInvisible()
void	makeInvisible(InvisibleCompilationUnit invisibleCU) Marks this ICompilationUnit as the delegate of an IInvisibleCompilationUnit, which will prevent this ICompilationUnit from contributing any symbols to the containing ICompilerProject's ASProjectScope.
protected boolean	operationsCompleted(EnumSet<ICompilationUnit.Operation> operations) Atomically checks the state of this compilation unit to determine if all the specified operations are complete.
protected void	removeAST()
void	setFileSpecificationGetter(IFileSpecificationGetter getter)
void	startBuildAsync(ITarget.TargetType targetType) This method starts to build the compilation unit asynchronously.
protected void	startParsingImports(IFileNodeAccumulator fna) Iterate through all imports within a IFileNodeAccumulator and start parsing any non-wildcard imports.
protected void	startProfile(ICompilationUnit.Operation operation)
protected void	stopProfile(ICompilationUnit.Operation operation)
String	toString()
protected void	updateEmbedCompilationUnitDependencies(List<IEmbedResolver> embedNodes, Collection<ICompilerProblem> problems) Iterate through all specified embeds, adding the EmbedCompilationUnit dependencies, and removing any EmbedCompilationUnits which no longer exist This function adds an empty definition dependency to the DependencyGraph, so it will not be printed to the link-report
protected void	updateStyleCompilationUnitDependencies(CSSCompilationSession cssCompilationSession, IXMLNameResolver xmlNameResolver, Iterable<ICSSDocument> cssDocuments, Collection<ICompilerProblem> problems) Semantic analyze a collection of CSS model objects, and return a CSSCompilationSession that contains the resolved symbols.
protected void	verifyAST(IASNode ast)
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, wait, wait, wait

Methods inherited from interface org.apache.flex.compiler.units.ICompilationUnit

getCompilationUnitType

Field Detail

DEFAULT_DO_ABC_TAG_NAME

protected static final String DEFAULT_DO_ABC_TAG_NAME

See Also:

Constant Field Values

syntaxTreeRequest

protected final AtomicReference<IRequest<ISyntaxTreeRequestResult,ICompilationUnit>> syntaxTreeRequest

fileScopeRequest

protected final AtomicReference<IRequest<IFileScopeRequestResult,ICompilationUnit>> fileScopeRequest

abc

protected final AtomicReference<IRequest<IABCBytesRequestResult,ICompilationUnit>> abc

problems

protected final AtomicReference<IRequest<IOutgoingDependenciesRequestResult,ICompilationUnit>> problems

Constructor Detail

CompilationUnitBase

protected CompilationUnitBase(CompilerProject project,
                   String path,
                   DefinitionPriority.BasePriority basePriority,
                   Collection<String> qnamesOfDefinitions)

This is the most generic constructor

Parameters:

project -

path -

basePriority -

qnamesOfDefinitions - is a collection with all the definition promises for the compilation unit

CompilationUnitBase

protected CompilationUnitBase(CompilerProject project,
                   String path,
                   DefinitionPriority.BasePriority basePriority,
                   boolean scopeBuiltFromSytaxTree)

Use this constructor if derived class has no definition promises

CompilationUnitBase

protected CompilationUnitBase(CompilerProject project,
                   String path,
                   DefinitionPriority.BasePriority basePriority,
                   String qnameOfDefinition)

Use this constructor if the derived class has at most one definition promise

Parameters:

project -

path -

basePriority -

qnameOfDefinition - is the definition promise, or null

Method Detail

updateStyleCompilationUnitDependencies

protected void updateStyleCompilationUnitDependencies(CSSCompilationSession cssCompilationSession,
                                          IXMLNameResolver xmlNameResolver,
                                          Iterable<ICSSDocument> cssDocuments,
                                          Collection<ICompilerProblem> problems)

Semantic analyze a collection of CSS model objects, and return a CSSCompilationSession that contains the resolved symbols.

1. Resolve type selectors to IClassDefinition definitions.
2. Find all the dependencies introduced by ClassReference() and Embed() property values.

Parameters:

cssCompilationSession - A CSSCompilationSession object that contains resolved symbols from all the CSS models in cssDocuments collection.

xmlNameResolver - Resolve type selectors to definitions.

cssDocuments - A list of CSS model objects.

problems - Compiler problem collection.

operationsCompleted

protected final boolean operationsCompleted(EnumSet<ICompilationUnit.Operation> operations)

Atomically checks the state of this compilation unit to determine if all the specified operations are complete.

Parameters:

operations - The set of operation to check.

Returns:

true if all the specified operations are complete, false otherwise.

getDefinitionPromises

public List<IDefinition> getDefinitionPromises()

Specified by:

getDefinitionPromises in interface ICompilationUnit

Returns:

List of definition promises

getProject

public CompilerProject getProject()

Specified by:

getProject in interface ICompilationUnit

Returns:

The project that contains this ICompilationUnit.

handleSyntaxTreeRequest

protected abstract ISyntaxTreeRequestResult handleSyntaxTreeRequest()
                                                             throws InterruptedException

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.

Returns:

The ISyntaxTreeRequestResult for this compilation unit.

Throws:

InterruptedException

handleFileScopeRequest

protected abstract IFileScopeRequestResult handleFileScopeRequest()
                                                           throws InterruptedException

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.

Returns:

The IFileScopeRequestResult for this compilation unit.

Throws:

InterruptedException

handleABCBytesRequest

protected abstract IABCBytesRequestResult handleABCBytesRequest()
                                                         throws InterruptedException

Builds a IABCBytesRequestResult. In many cases the IABCBytesRequestResult is built running a code generator over 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.

Returns:

The IABCBytesRequestResult for this compilation unit.

Throws:

InterruptedException

handleSWFTagsRequest

protected abstract ISWFTagsRequestResult handleSWFTagsRequest()
                                                       throws InterruptedException

Builds a ISWFTagsRequestResult. In many cases the ISWFTagsRequestResult is built getting the IABCBytesRequestResult and wrapping its abc bytes in a DoABCTag.

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.

Returns:

The ISWFTagsRequestResult for this compilation unit.

Throws:

InterruptedException

handleOutgoingDependenciesRequest

protected abstract IOutgoingDependenciesRequestResult handleOutgoingDependenciesRequest()
                                                                                 throws InterruptedException

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.

Returns:

The IOutgoingDependenciesRequestResult for this compilation unit.

Throws:

InterruptedException

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.

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.

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.

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

getAbsoluteFilename

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

getFilenameNoPath

protected final String getFilenameNoPath()

getRootFileSpecification

protected IFileSpecification getRootFileSpecification()

getFileSpecificationGetter

protected IFileSpecificationGetter getFileSpecificationGetter()

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

clearIncludedFilesFromWorkspace

public void clearIncludedFilesFromWorkspace()

This method is used to update the Workspace includeFilesToIncludingCompilationUnitMapping map when a file get's cleaned. It goes to great pains to not reparse the file, as if the file hasn't been parsed, there shouldn't be any files related to this compilation unit in the map.

handleClean

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

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

Parameters:

invalidatedSWCFiles -

startProfile

protected final void startProfile(ICompilationUnit.Operation operation)

stopProfile

protected final void stopProfile(ICompilationUnit.Operation operation)

verifyAST

protected void verifyAST(IASNode ast)

addScopeToProjectScope

protected final void addScopeToProjectScope(ASFileScope[] scopes)

startParsingImports

protected void startParsingImports(IFileNodeAccumulator fna)

Iterate through all imports within a IFileNodeAccumulator and start parsing any non-wildcard imports. This will help speed discovery of dependencies to allow better thread utilization.

Parameters:

fna - IFileNodeAccumulator

updateEmbedCompilationUnitDependencies

protected void updateEmbedCompilationUnitDependencies(List<IEmbedResolver> embedNodes,
                                          Collection<ICompilerProblem> problems)
                                               throws InterruptedException

Iterate through all specified embeds, adding the EmbedCompilationUnit dependencies, and removing any EmbedCompilationUnits which no longer exist

This function adds an empty definition dependency to the DependencyGraph, so it will not be printed to the link-report

Throws:

InterruptedException

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.

removeAST

protected void removeAST()

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.

toString

public String toString()

Overrides:

toString in class Object

Returns:

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

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

setFileSpecificationGetter

public void setFileSpecificationGetter(IFileSpecificationGetter getter)

makeInvisible

public void makeInvisible(InvisibleCompilationUnit invisibleCU)

Marks this ICompilationUnit as the delegate of an IInvisibleCompilationUnit, which will prevent this ICompilationUnit from contributing any symbols to the containing ICompilerProject's ASProjectScope.

This method should be called very shortly after the constructor and before any other methods on this class or its sub-classes are called ( except setFileSpecificationGetter(IFileSpecificationGetter) ).

This method must only be called zero or one time on each ICompilationUnit.

isInvisible

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

getEncodedDebugFiles

protected Map<String,String> getEncodedDebugFiles()
                                           throws InterruptedException

Throws:

InterruptedException