org.apache.flex.compiler.internal.targets

Class SWFTarget

java.lang.Object

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

org.apache.flex.compiler.internal.targets.SWFTarget

All Implemented Interfaces:

ISWFTarget, ITarget

Direct Known Subclasses:

AppSWFTarget, LibrarySWFTarget

public abstract class SWFTarget
extends Target
implements ISWFTarget

Concrete implementation of ITarget for building a collection of source files into a SWF.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	SWFTarget.FramesInformation Contains information about the skeleton of a SWF that is being built by a SWFTarget and provides methods to create SWFFrames and add them to a ISWF.
protected static class	SWFTarget.SWFFrameInfo

Nested classes/interfaces inherited from class org.apache.flex.compiler.internal.targets.Target

Target.BuiltCompilationUnitSet, Target.DirectDependencies, Target.RootedCompilationUnits

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

ITarget.TargetType

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<String>	metadataDonators

Fields inherited from class org.apache.flex.compiler.internal.targets.Target

progressMonitor, project, targetSettings

Constructor Summary

Constructors

Constructor and Description
SWFTarget(CompilerProject project, ITargetSettings targetSettings, ITargetProgressMonitor progressMonitor)

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	addCompilationUnitsAndDependenciesToFrame(SWFFrame frame, Collection<ICompilationUnit> rootedUnitsForFrame, boolean allowExternals, Set<ICompilationUnit> emittedCompilationUnits)
protected abstract void	addLinkedABCToFrame(SWFFrame targetFrame, Iterable<DoABCTag> inputABCs, ABCLinker.ABCLinkerSettings linkSettings)
ISWF	build(Collection<ICompilerProblem> problems) Adds frames and tags to those frames for all the content generated by the target.
protected SWF	buildEmptySWF() Creates a new instance of a SWF.
protected abstract SWFTarget.FramesInformation	computeFramesInformation() Create the SWFTarget.FramesInformation which contains the skeleton for the frames of this SWF.
protected Target.RootedCompilationUnits	computeRootedCompilationUnits() Computes the set of compilation units that root the dependency walk.
protected abstract ITargetAttributes	computeTargetAttributes() round-up user specified target attributes All derived classes must provide one, but they are free to provide "do nothing" implementations (like NilTargetAttributes)
protected ITargetReport	computeTargetReport()
protected SWFFrame	createWithClassesAndItsDependencies(SWFFrame frame, Collection<ClassDefinition> frameRootClasses, ASProjectScope projectScope, boolean allowExternals, Set<ICompilationUnit> emittedCompilationUnits) Add a set of root classes and its dependencies to a new frame or to an existing frame.
protected void	doAddMetadataNamesToTarget(ICompilationUnit cu, boolean linkedIn) Add metadata names to the target for this compilation unit.
protected void	doPostBuildWork(com.google.common.collect.ImmutableSet<ICompilationUnit> compilationUnits, Collection<ICompilerProblem> problems) Check the build and analyze the results before the SWF target is initialized.
protected RGB	getBackgroundColor()
protected SWFTarget.FramesInformation	getFramesInformation()
Target.RootedCompilationUnits	getRootedCompilationUnits() Gets the set of ICompilationUnits that are the roots of the graph of ICompilationUnits whose output will be in the generate SWF.
protected ITargetAttributes	getTargetAttributes()
ITarget.TargetType	getTargetType() Returns the type of this target.
protected ISWF	initializeSWF(List<ICompilationUnit> reachableCompilationUnits) Initialize SWF model with default header values from the target settings when not overridden by the target attributes.
protected ISWF	linkSWF(ISWF unLinked) Link the swf - this handles merging the DoABC tags inside each frame, and will also handle stripping debug opcodes, optimizing the abcs, and/or stripping metadata
protected void	reportProblem(ICompilerProblem problem) Add to the collection of compiler problems.
protected abstract void	setKeepAS3MetadataLinkerSetting(ABCLinker.ABCLinkerSettings linkSettings)
protected boolean	shouldAddMetadataNamesToTarget(ICompilationUnit cu, boolean linkedIn) Test if any metadata names associated with the compilation unit should be added to the target.
protected boolean	testCompilationUnitLinkage(ICompilationUnit cu, boolean allowExternals) Test if a compilation unit should be include in this target.

Methods inherited from class org.apache.flex.compiler.internal.targets.Target

addASMetadataNames, buildAllCompilationUnits, buildFinished, buildStarted, computeFatalProblems, createLinkReport, findAllCompilationUnitsToLink, getAllExternallyVisibleDefinitions, getASMetadataNames, getBuiltCompilationUnitSet, getDependentCompilationUnits, getDirectDependencies, getFatalProblems, getIncludedResourceBundlesCompilationUnits, getIncludeLibrariesCompilationUnits, getIncludesCompilationUnits, getLinkageChecker, getReachableCompilationUnits, getTargetReport, getTargetSettings, isCanceled, isLinkageExternal, setLinkageChecker, updateProgress, updateProgress, waitForCompilationUnitToFinish

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

getASMetadataNames, getIncludesCompilationUnits, getTargetReport, getTargetSettings

Field Detail

metadataDonators

protected Set<String> metadataDonators

Constructor Detail

SWFTarget

public SWFTarget(CompilerProject project,
         ITargetSettings targetSettings,
         ITargetProgressMonitor progressMonitor)

Method Detail

getRootedCompilationUnits

public Target.RootedCompilationUnits getRootedCompilationUnits()
                                                        throws InterruptedException

Gets the set of ICompilationUnits that are the roots of the graph of ICompilationUnits whose output will be in the generate SWF.

Specified by:

getRootedCompilationUnits in class Target

Returns:

The set of ICompilationUnits that are the roots of the graph of ICompilationUnits whose output will be in the generate SWF

Throws:

InterruptedException

build

public ISWF build(Collection<ICompilerProblem> problems)

Description copied from interface: ISWFTarget

Adds frames and tags to those frames for all the content generated by the target. When this method returns false, the ISWF should be considered invalid and the specified problemCollection should be searched for the cause.

Specified by:

build in interface ISWFTarget

Parameters:

problems - Collection to which all problems of all CompilationUnits whose output is added to the specified ISWF are added.

Returns:

ISWF if all tags generated by the target we added to the specified SWF.

getTargetType

public ITarget.TargetType getTargetType()

Description copied from interface: ITarget

Returns the type of this target.

Specified by:

getTargetType in interface ITarget

Returns:

type of this target

getTargetAttributes

protected final ITargetAttributes getTargetAttributes()
                                               throws InterruptedException

Throws:

InterruptedException

computeTargetAttributes

protected abstract ITargetAttributes computeTargetAttributes()
                                                      throws InterruptedException

round-up user specified target attributes All derived classes must provide one, but they are free to provide "do nothing" implementations (like NilTargetAttributes)

Throws:

InterruptedException

computeFramesInformation

protected abstract SWFTarget.FramesInformation computeFramesInformation()
                                                                 throws InterruptedException

Create the SWFTarget.FramesInformation which contains the skeleton for the frames of this SWF. The actual frames will be create in doCreateFrames().

Throws:

InterruptedException

getFramesInformation

protected final SWFTarget.FramesInformation getFramesInformation()
                                                          throws InterruptedException

Throws:

InterruptedException

doPostBuildWork

protected void doPostBuildWork(com.google.common.collect.ImmutableSet<ICompilationUnit> compilationUnits,
                   Collection<ICompilerProblem> problems)
                        throws InterruptedException

Check the build and analyze the results before the SWF target is initialized.

Parameters:

compilationUnits - The set of compilation units after buildAndCollectProblems() has run.

problems - A collection where discovered problems are appended.

Throws:

InterruptedException

buildEmptySWF

protected SWF buildEmptySWF()

Creates a new instance of a SWF.

Returns:

a new instance of a SWF.

reportProblem

protected void reportProblem(ICompilerProblem problem)

Add to the collection of compiler problems.

Parameters:

problem -

createWithClassesAndItsDependencies

protected SWFFrame createWithClassesAndItsDependencies(SWFFrame frame,
                                           Collection<ClassDefinition> frameRootClasses,
                                           ASProjectScope projectScope,
                                           boolean allowExternals,
                                           Set<ICompilationUnit> emittedCompilationUnits)
                                                throws InterruptedException

Add a set of root classes and its dependencies to a new frame or to an existing frame.

Parameters:

frame - if null a new frame will be created for the classes. Otherwise the classes will be added to the existing frame.

frameRootClasses -

projectScope -

allowExternals -

emittedCompilationUnits -

Returns:

The SWF frame.

Throws:

InterruptedException

addCompilationUnitsAndDependenciesToFrame

protected boolean addCompilationUnitsAndDependenciesToFrame(SWFFrame frame,
                                                Collection<ICompilationUnit> rootedUnitsForFrame,
                                                boolean allowExternals,
                                                Set<ICompilationUnit> emittedCompilationUnits)
                                                     throws InterruptedException

Throws:

InterruptedException

doAddMetadataNamesToTarget

protected void doAddMetadataNamesToTarget(ICompilationUnit cu,
                              boolean linkedIn)

Add metadata names to the target for this compilation unit.

Parameters:

cu -

linkedIn - true if the compilation unit is linked in, false if external.

shouldAddMetadataNamesToTarget

protected boolean shouldAddMetadataNamesToTarget(ICompilationUnit cu,
                                     boolean linkedIn)

Test if any metadata names associated with the compilation unit should be added to the target.

Parameters:

cu -

linkedIn - true if the compilation unit is linked in, false if external.

Returns:

true if the metadata names should be included, false otherwise.

testCompilationUnitLinkage

protected boolean testCompilationUnitLinkage(ICompilationUnit cu,
                                 boolean allowExternals)
                                      throws InterruptedException

Test if a compilation unit should be include in this target.

Parameters:

cu -

allowExternals -

Returns:

True if the compilation should be included, false otherwise.

Throws:

InterruptedException

addLinkedABCToFrame

protected abstract void addLinkedABCToFrame(SWFFrame targetFrame,
                       Iterable<DoABCTag> inputABCs,
                       ABCLinker.ABCLinkerSettings linkSettings)
                                     throws Exception

Throws:

Exception

setKeepAS3MetadataLinkerSetting

protected abstract void setKeepAS3MetadataLinkerSetting(ABCLinker.ABCLinkerSettings linkSettings)

linkSWF

protected ISWF linkSWF(ISWF unLinked)

Link the swf - this handles merging the DoABC tags inside each frame, and will also handle stripping debug opcodes, optimizing the abcs, and/or stripping metadata

Parameters:

unLinked - the SWF to process

Returns:

A SWF that is the resulting of merging, optimizing, etc.

computeRootedCompilationUnits

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

For SWFTarget's the set of rooted ICompilationUnits is computed by enumerating all the frames and collecting all the ICompilationUnits assigned to each of the frames.

Specified by:

computeRootedCompilationUnits in class Target

Returns:

The set of rooted ICompilationUnit's.

Throws:

InterruptedException

initializeSWF

protected ISWF initializeSWF(List<ICompilationUnit> reachableCompilationUnits)
                      throws InterruptedException

Initialize SWF model with default header values from the target settings when not overridden by the target attributes.

Returns:

SWF model.

Throws:

InterruptedException

getBackgroundColor

protected final RGB getBackgroundColor()
                                throws InterruptedException

Throws:

InterruptedException

computeTargetReport

protected ITargetReport computeTargetReport()
                                     throws InterruptedException

Specified by:

computeTargetReport in class Target

Throws:

InterruptedException