com.google.gwt.core.ext.linker.impl

Class StandardLinkerContext

java.lang.Object

com.google.gwt.core.ext.Linker

com.google.gwt.core.ext.linker.impl.StandardLinkerContext

All Implemented Interfaces:

LinkerContext

public class StandardLinkerContext
extends Linker
implements LinkerContext

An implementation of LinkerContext that is initialized from a ModuleDef.

Field Summary

Fields

Modifier and Type	Field and Description
static Comparator<ConfigurationProperty>	CONFIGURATION_PROPERTY_COMPARATOR

Constructor Summary

Constructors

Constructor and Description
StandardLinkerContext(TreeLogger logger, ModuleDef module, ResourceOracle publicResourceOracle, JsOutputOption outputOption)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allLinkersAreShardable()
List<Linker>	findUnshardableLinkers() Find all linkers that are not updated to support running generators on compilations shards.
ArtifactSet	getArtifactsForPublicResources(TreeLogger logger, ModuleDef module) Convert all static resources in the specified module to artifacts.
SortedSet<ConfigurationProperty>	getConfigurationProperties() Returns all configuration properties defined in the module.
String	getDescription() Returns a human-readable String describing the Linker.
String	getExtraPathForLinker(Class<? extends Linker> linkerType, String partialPath) Return the full path for an artifact produced by linkertype that has the specified partial path.
String	getModuleFunctionName() Returns the name of the module's bootstrap function.
long	getModuleLastModified() Returns the time at which the module being compiled was last modified.
String	getModuleName() Returns the name of the module being compiled.
SortedSet<SelectionProperty>	getProperties() Returns all deferred binding properties defined in the module.
StandardSelectionProperty	getProperty(String name)
ArtifactSet	invokeFinalLink(TreeLogger logger, ArtifactSet artifacts)
ArtifactSet	invokeLegacyLinkers(TreeLogger logger, ArtifactSet artifacts) Run linkers that have not been updated for the shardable API.
ArtifactSet	invokeLinkForOnePermutation(TreeLogger logger, StandardCompilationResult permResult, ArtifactSet permArtifacts) Invoke the shardable linkers on one permutation result.
ArtifactSet	invokeRelink(TreeLogger logger, ArtifactSet newlyGeneratedArtifacts)
boolean	isOutputCompact() Returns true if the output should be as compact is possible and false if the output should be human-readable.
ArtifactSet	link(TreeLogger logger, LinkerContext context, ArtifactSet artifacts) This method is invoked for linkers not annotated with Shardable.
String	optimizeJavaScript(TreeLogger logger, String program) Applies optimizations to a JavaScript program.
void	produceOutput(TreeLogger logger, ArtifactSet artifacts, EmittedArtifact.Visibility visibility, OutputFileSet out) Emit EmittedArtifacts artifacts onto out.

Methods inherited from class com.google.gwt.core.ext.Linker

isShardable, link, relink, supportsDevModeInJunit

Methods inherited from class java.lang.Object

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

Field Detail

CONFIGURATION_PROPERTY_COMPARATOR

public static final Comparator<ConfigurationProperty> CONFIGURATION_PROPERTY_COMPARATOR

Constructor Detail

StandardLinkerContext

public StandardLinkerContext(TreeLogger logger,
                     ModuleDef module,
                     ResourceOracle publicResourceOracle,
                     JsOutputOption outputOption)
                      throws UnableToCompleteException

Throws:

UnableToCompleteException

Method Detail

allLinkersAreShardable

public boolean allLinkersAreShardable()

findUnshardableLinkers

public List<Linker> findUnshardableLinkers()

Find all linkers that are not updated to support running generators on compilations shards.

getArtifactsForPublicResources

public ArtifactSet getArtifactsForPublicResources(TreeLogger logger,
                                         ModuleDef module)

Convert all static resources in the specified module to artifacts.

getConfigurationProperties

public SortedSet<ConfigurationProperty> getConfigurationProperties()

Description copied from interface: LinkerContext

Returns all configuration properties defined in the module. Configuration properties do not have any impact on deferred-binding decisions, but may affect the behaviors of Generators and Linkers.

Specified by:

getConfigurationProperties in interface LinkerContext

getDescription

public String getDescription()

Description copied from class: Linker

Returns a human-readable String describing the Linker.

Specified by:

getDescription in class Linker

getExtraPathForLinker

public String getExtraPathForLinker(Class<? extends Linker> linkerType,
                           String partialPath)

Return the full path for an artifact produced by linkertype that has the specified partial path. The full path will be the linker's short name, as defined in the module file, followed by the given partial path.

getModuleFunctionName

public String getModuleFunctionName()

Description copied from interface: LinkerContext

Returns the name of the module's bootstrap function.

Specified by:

getModuleFunctionName in interface LinkerContext

getModuleLastModified

public long getModuleLastModified()

Description copied from interface: LinkerContext

Returns the time at which the module being compiled was last modified. Can be used to set an appropriate timestamp on artifacts which depend solely on the module definition.

Specified by:

getModuleLastModified in interface LinkerContext

getModuleName

public String getModuleName()

Description copied from interface: LinkerContext

Returns the name of the module being compiled.

Specified by:

getModuleName in interface LinkerContext

getProperties

public SortedSet<SelectionProperty> getProperties()

Description copied from interface: LinkerContext

Returns all deferred binding properties defined in the module. The SelectionProperties will be sorted by the standard string comparison function on the name of the property.

Specified by:

getProperties in interface LinkerContext

getProperty

public StandardSelectionProperty getProperty(String name)

invokeFinalLink

public ArtifactSet invokeFinalLink(TreeLogger logger,
                          ArtifactSet artifacts)
                            throws UnableToCompleteException

Throws:

UnableToCompleteException

invokeLegacyLinkers

public ArtifactSet invokeLegacyLinkers(TreeLogger logger,
                              ArtifactSet artifacts)
                                throws UnableToCompleteException

Run linkers that have not been updated for the shardable API.

Throws:

UnableToCompleteException

invokeLinkForOnePermutation

public ArtifactSet invokeLinkForOnePermutation(TreeLogger logger,
                                      StandardCompilationResult permResult,
                                      ArtifactSet permArtifacts)
                                        throws UnableToCompleteException

Invoke the shardable linkers on one permutation result. Those linkers run with the precompile artifacts as input.

Throws:

UnableToCompleteException

invokeRelink

public ArtifactSet invokeRelink(TreeLogger logger,
                       ArtifactSet newlyGeneratedArtifacts)
                         throws UnableToCompleteException

Throws:

UnableToCompleteException

isOutputCompact

public boolean isOutputCompact()

Description copied from interface: LinkerContext

Returns true if the output should be as compact is possible and false if the output should be human-readable.

Specified by:

isOutputCompact in interface LinkerContext

link

public ArtifactSet link(TreeLogger logger,
               LinkerContext context,
               ArtifactSet artifacts)

Description copied from class: Linker

This method is invoked for linkers not annotated with Shardable. It sees all artifacts across the whole compile and can modify them arbitrarily. This method is only called if the linker is not annotated with Shardable.

Overrides:

link in class Linker

Parameters:

logger - the TreeLogger to record to

context - provides access to the Linker's environment

artifacts - an unmodifiable view of the artifacts to link

Returns:

the artifacts that should be propagated through the linker chain

optimizeJavaScript

public String optimizeJavaScript(TreeLogger logger,
                        String program)
                          throws UnableToCompleteException

Description copied from interface: LinkerContext

Applies optimizations to a JavaScript program. This method is intended to be applied to bootstrap scripts in order to apply context-specific transformations to the program, based on the compiler's configuration. The return value will be functionally-equivalent JavaScript, although the exact transformations and structure of the output should be considered opaque. While this function can be safely applied multiple times, the best results will be obtained by performing all JavaScript assembly and calling the function just before writing the selection script to disk.

Specified by:

optimizeJavaScript in interface LinkerContext

Throws:

UnableToCompleteException

produceOutput

public void produceOutput(TreeLogger logger,
                 ArtifactSet artifacts,
                 EmittedArtifact.Visibility visibility,
                 OutputFileSet out)
                   throws UnableToCompleteException

Emit EmittedArtifacts artifacts onto out. Does not close out.

Parameters:

logger - where to log progress

artifacts - the artifacts to emit

visibility - the level of visibility of artifacts to output

out - where to emit the artifact contents

Throws:

UnableToCompleteException