org.apache.flex.compiler.internal.targets

Class Target

java.lang.Object

org.apache.flex.compiler.internal.targets.Target

All Implemented Interfaces:

ITarget

Direct Known Subclasses:

JSTarget, SWCTarget, SWFTarget

public abstract class Target
extends Object
implements ITarget

Abstract base class to help subclasses implement ITarget.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Target.BuiltCompilationUnitSet Wad that holds a set of ICompilationUnits that have been built to build the output of this target and any ICompilerProblems found building those ICompilationUnits.
static class	Target.DirectDependencies Wad containing an Iterable of ICompilationUnits and an Iterable of ICompilerProblems found while constructing the Iterable of ICompilationUnits.
static class	Target.RootedCompilationUnits Wad containing the set of ICompilationUnits that root the dependency walk and any ICompilerProblems encountered computing the roots of the dependency walk.

Nested classes/interfaces inherited from interface org.apache.flex.compiler.targets.ITarget

ITarget.TargetType

Field Summary

Fields

Modifier and Type	Field and Description
protected ITargetProgressMonitor	progressMonitor
protected CompilerProject	project
protected ITargetSettings	targetSettings

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Target(CompilerProject project, ITargetSettings targetSettings, ITargetProgressMonitor progressMonitor) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	addASMetadataNames(Collection<String> metadataNames) Add metadata names to the target.
protected Target.BuiltCompilationUnitSet	buildAllCompilationUnits() Discovers all the compilation units (roots and dependencies) that will be linked into the target.
protected void	buildFinished() Gets called when build operation finishes.
protected void	buildStarted() Gets called when build operation starts.
protected Iterable<ICompilerProblem>	computeFatalProblems() Computes an Iterable of fatal ICompilerProblems that prevent this Target from being built.
protected abstract Target.RootedCompilationUnits	computeRootedCompilationUnits() Computes the set of compilation units that root the dependency walk.
protected abstract ITargetReport	computeTargetReport()
protected void	createLinkReport(Collection<ICompilerProblem> problems) Create a link report at the path setup in the targetSettings.getLinkReportPath.
protected Set<ICompilationUnit>	findAllCompilationUnitsToLink(Collection<ICompilationUnit> compilationUnits, Collection<ICompilerProblem> problems) Discovers dependent compilation units from a set of root compilation units.
static com.google.common.collect.ImmutableList<IDefinition>	getAllExternallyVisibleDefinitions(Collection<ICompilationUnit> compilationUnits) Find all the externally visible definitions in the given compilation unit list.
Set<String>	getASMetadataNames() Get the set of metadata names.
protected Target.BuiltCompilationUnitSet	getBuiltCompilationUnitSet()
protected Set<ICompilationUnit>	getDependentCompilationUnits(Collection<ICompilationUnit> compilationUnits, Collection<ICompilerProblem> problems) Computes the set of all all ICompilationUnit's whose output is part of the output of this target.
protected Target.DirectDependencies	getDirectDependencies(ICompilationUnit cu)
protected Iterable<ICompilerProblem>	getFatalProblems()
Collection<ICompilationUnit>	getIncludedResourceBundlesCompilationUnits(Collection<ICompilerProblem> problems)
protected Collection<ICompilationUnit>	getIncludeLibrariesCompilationUnits() Get a collection of compilation units for all of the classes found in all of the libraries found in the -include-libraries path.
Set<ICompilationUnit>	getIncludesCompilationUnits() Gets a set of ICompilationUnits that are included into the build process by -include-classes compiler argument.
protected LinkageChecker	getLinkageChecker() Get the target's linkage checker.
com.google.common.collect.ImmutableList<ICompilationUnit>	getReachableCompilationUnits(Collection<ICompilerProblem> problems)
abstract Target.RootedCompilationUnits	getRootedCompilationUnits()
ITargetReport	getTargetReport() Returns a report specific to this target.
ITargetSettings	getTargetSettings() Returns the settings specific to this target.
protected boolean	isCanceled()
protected boolean	isLinkageExternal(ICompilationUnit cu, ITargetSettings targetSettings) Determine if a compilation unit should be linked into the target.
protected void	setLinkageChecker(LinkageChecker linkageChecker) Set the project's linkage checker.
protected boolean	updateProgress(int percentageCompleted) Updates the value that represents the percentage of the main task that has been completed so far and notifies the progress monitor about this value if any.
protected boolean	updateProgress(int numTotalCompilationUnits, int totalCompilationUnitsWorkCompleted, int maxPercentage) Updates the value that represents the percentage of the work completed so far using the information specified and notifies the progress monitor about this value.
protected void	waitForCompilationUnitToFinish(ICompilationUnit cu, Collection<ICompilerProblem> problems) Waits for the specified ICompilationUnit to finish building and add any problems found in the specified ICompilationUnit to the specified Collection.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flex.compiler.targets.ITarget

getTargetType

Field Detail

project

protected final CompilerProject project

progressMonitor

protected final ITargetProgressMonitor progressMonitor

targetSettings

protected final ITargetSettings targetSettings

Constructor Detail

Target

protected Target(CompilerProject project,
      ITargetSettings targetSettings,
      ITargetProgressMonitor progressMonitor)

Constructor

Parameters:

project - CompilerProject that this target will be a part of.

targetSettings - ITargetSettings for this target

progressMonitor - ITargetProgressMonitor that will receive progress information. Can be null, in which case no progress information will be collected.

Method Detail

getAllExternallyVisibleDefinitions

public static com.google.common.collect.ImmutableList<IDefinition> getAllExternallyVisibleDefinitions(Collection<ICompilationUnit> compilationUnits)
                                                                                               throws InterruptedException

Find all the externally visible definitions in the given compilation unit list.

Parameters:

compilationUnits - A collection of compilation units.

Returns:

All the externally visible definitions in the given compilation unit list.

Throws:

InterruptedException - Concurrency error.

findAllCompilationUnitsToLink

protected Set<ICompilationUnit> findAllCompilationUnitsToLink(Collection<ICompilationUnit> compilationUnits,
                                                  Collection<ICompilerProblem> problems)
                                                       throws InterruptedException

Discovers dependent compilation units from a set of root compilation units. The return collection includes all compilation units in the argument collection.

This method delegates the dependency discovery to getDependentCompilationUnits(java.util.Collection<org.apache.flex.compiler.units.ICompilationUnit>, java.util.Collection<org.apache.flex.compiler.problems.ICompilerProblem>). Subclasses should override this method if they have more sophisticated dependency discovery algorithms.

Parameters:

compilationUnits - ICompilationUnits known to be linked into the target. Dependent compilation units will be added to this method.

problems - Problems building compilation units.

Returns:

All compilation units to link into the target. This collection includes all elements in the compilationUnits collection from argument.

Throws:

InterruptedException - Concurrency error.

waitForCompilationUnitToFinish

protected void waitForCompilationUnitToFinish(ICompilationUnit cu,
                                  Collection<ICompilerProblem> problems)
                                       throws InterruptedException

Waits for the specified ICompilationUnit to finish building and add any problems found in the specified ICompilationUnit to the specified Collection.

This method exists for the sole purpose of allowing the FlexLibrarySWFTarget to filter out ResourceBundleNotFoundProblems and ResourceBundleNotFoundForLocaleProblems from SWCCompilationUnit's that are externally linked.

If we rip out support for Flex or if we are willing to report missing resource bundles from external SWCs when linking a SWC, this method can be inlined at its call site.

If we plan on continuing to support Flex, a better way to do this would be to have the IOutgoingDependenciesRequestResult interface have method to get all the resource bundles referenced by an ICompilationUnit and wait to do the final resolution of resource bundles in Target or one of its sub-classes.

Parameters:

cu -

problems -

Throws:

InterruptedException

getTargetSettings

public ITargetSettings getTargetSettings()

Description copied from interface: ITarget

Returns the settings specific to this target.

Specified by:

getTargetSettings in interface ITarget

Returns:

settings for this target

computeTargetReport

protected abstract ITargetReport computeTargetReport()
                                              throws InterruptedException

Throws:

InterruptedException

getTargetReport

public final ITargetReport getTargetReport()
                                    throws InterruptedException

Description copied from interface: ITarget

Returns a report specific to this target. If the target has been created but not built before getTargetReport() has been called, this method will return null. If the Target could not be built, null will be returned.

Specified by:

getTargetReport in interface ITarget

Returns:

report on this target

Throws:

InterruptedException

buildAllCompilationUnits

protected Target.BuiltCompilationUnitSet buildAllCompilationUnits()
                                                           throws InterruptedException

Discovers all the compilation units (roots and dependencies) that will be linked into the target. Then builds these compilation units for all phases of processing.

Returns:

A Target.BuiltCompilationUnitSet that contains information about all the ICompilationUnits whose output contribute to this target and ICompilerProblems discovered while building all the ICompilationUnits.

Throws:

InterruptedException - Concurrency error.

getBuiltCompilationUnitSet

protected Target.BuiltCompilationUnitSet getBuiltCompilationUnitSet()
                                                             throws InterruptedException

Throws:

InterruptedException

getDependentCompilationUnits

protected final Set<ICompilationUnit> getDependentCompilationUnits(Collection<ICompilationUnit> compilationUnits,
                                                 Collection<ICompilerProblem> problems)
                                                            throws InterruptedException

Computes the set of all all ICompilationUnit's whose output is part of the output of this target. This method does NOT compute the dependencies introduced in CSS.

Parameters:

compilationUnits - A collection of root compilation units.

problems - Problems building compilation units.

Returns:

Set of all ICompilationUnit's whose output is part of the output of this target. The order of compilation units in this function does not matter because we topologically sort the dependency graph later when we are getting ready to add tags to the output SWF or SWC.

Throws:

InterruptedException

getDirectDependencies

protected Target.DirectDependencies getDirectDependencies(ICompilationUnit cu)
                                                   throws InterruptedException

Throws:

InterruptedException

getReachableCompilationUnits

public com.google.common.collect.ImmutableList<ICompilationUnit> getReachableCompilationUnits(Collection<ICompilerProblem> problems)
                                                                                       throws InterruptedException

Returns:

All the reachable compilation units in this job.

Throws:

InterruptedException

createLinkReport

protected void createLinkReport(Collection<ICompilerProblem> problems)
                         throws InterruptedException

Create a link report at the path setup in the targetSettings.getLinkReportPath. This method may be called after a target has been built.

Parameters:

problems -

Throws:

InterruptedException

computeRootedCompilationUnits

protected abstract Target.RootedCompilationUnits computeRootedCompilationUnits()
                                                                        throws InterruptedException

Computes the set of compilation units that root the dependency walk. The returned set of compilation units and their dependencies will be compiled.

Returns:

The set of rooted ICompilationUnit's.

Throws:

InterruptedException

getRootedCompilationUnits

public abstract Target.RootedCompilationUnits getRootedCompilationUnits()
                                                                 throws InterruptedException

Throws:

InterruptedException

getIncludesCompilationUnits

public final Set<ICompilationUnit> getIncludesCompilationUnits()
                                                        throws InterruptedException

Gets a set of ICompilationUnits that are included into the build process by -include-classes compiler argument.

This method is marked final until we have a use case to make it non-final.

Specified by:

getIncludesCompilationUnits in interface ITarget

Returns:

a set of ICompilationUnits that are included into the build process by -include-classes compiler argument.

Throws:

InterruptedException

getIncludedResourceBundlesCompilationUnits

public final Collection<ICompilationUnit> getIncludedResourceBundlesCompilationUnits(Collection<ICompilerProblem> problems)
                                                                              throws InterruptedException

Returns:

a collection of resource bundle compilation units that are included into the build process by -include-resource-bundles compiler argument.

Throws:

InterruptedException

getASMetadataNames

public final Set<String> getASMetadataNames()

Get the set of metadata names.

Specified by:

getASMetadataNames in interface ITarget

Returns:

The set of metadata names that will be preserved in a SWF target or recorded in a SWC target. May be null if all metadata names should be kept.

addASMetadataNames

public void addASMetadataNames(Collection<String> metadataNames)

Add metadata names to the target.

Parameters:

metadataNames - metadata names that should be kept. May not be null.

buildStarted

protected final void buildStarted()

Gets called when build operation starts.

updateProgress

protected boolean updateProgress(int numTotalCompilationUnits,
                     int totalCompilationUnitsWorkCompleted,
                     int maxPercentage)

Updates the value that represents the percentage of the work completed so far using the information specified and notifies the progress monitor about this value. Each compilation unit is assumed to complete 2 steps in order to be considered compiled. The first step is considered to be done when the semantic analysis phase is done. ( @see CompilationUnitBase#handleOutgoingDependenciesRequest ). The second step starts with byte code generation ( @see CompilationUnitBase#handleABCBytesRequest ) and ends when swf tags request is completed. ( @see CompilationUnitBase#handleSWFTagsRequest )

Parameters:

numTotalCompilationUnits - number of compilation units known to be included in the build process

totalCompilationUnitsWorkCompleted - total compilation unit work completed so far. As described above, each compilation unit has two steps. Therefore, this value would be equal to (2*numTotalCompilationUnits), when we are done with compiling all the compilation units.

maxPercentage - the value that represents the maximum percentage of the work can be considered completed so far in this method. This method guarantees not to report a percentage value that is higher than this value as completed to its clients via its progress monitor.

Returns:

whether or not the build operation should continue. false if the build operation has been requested to be terminated, true otherwise.

updateProgress

protected boolean updateProgress(int percentageCompleted)

Updates the value that represents the percentage of the main task that has been completed so far and notifies the progress monitor about this value if any.

Parameters:

percentageCompleted - the percentage of the main task that has been completed so far.

Returns:

whether or not the build operation should continue. false if the build operation has been requested to be terminated, true otherwise.

isCanceled

protected boolean isCanceled()

Returns:

returns whether the current compilation operation has been requested to be canceled.

buildFinished

protected final void buildFinished()

Gets called when build operation finishes.

isLinkageExternal

protected boolean isLinkageExternal(ICompilationUnit cu,
                        ITargetSettings targetSettings)
                             throws InterruptedException

Determine if a compilation unit should be linked into the target.

Parameters:

cu - The compilation unit to test.

targetSettings - The target settings.

Returns:

true if the compilation unit's linkage is external, false otherwise.

Throws:

InterruptedException

getLinkageChecker

protected final LinkageChecker getLinkageChecker()

Get the target's linkage checker.

Returns:

the target's linkage checker.

setLinkageChecker

protected void setLinkageChecker(LinkageChecker linkageChecker)

Set the project's linkage checker.

Parameters:

linkageChecker - linkage checker, may not be null.

getFatalProblems

protected Iterable<ICompilerProblem> getFatalProblems()
                                               throws InterruptedException

Throws:

InterruptedException

computeFatalProblems

protected Iterable<ICompilerProblem> computeFatalProblems()
                                                   throws InterruptedException

Computes an Iterable of fatal ICompilerProblems that prevent this Target from being built.

Sub-classes override this method to check for additional fatal ICompilerProblems.

Returns:

Iterable of fatal ICompilerProblems

Throws:

InterruptedException

getIncludeLibrariesCompilationUnits

protected final Collection<ICompilationUnit> getIncludeLibrariesCompilationUnits()

Get a collection of compilation units for all of the classes found in all of the libraries found in the -include-libraries path.

Returns:

collection of compilation units for all the classes found on the -include-libraries path.