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

Class SelectionScriptLinker

java.lang.Object

com.google.gwt.core.ext.Linker

com.google.gwt.core.ext.linker.AbstractLinker

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

Direct Known Subclasses:

CrossSiteIframeLinker, D8ScriptLinker, HostedModeLinker, IFrameLinker, SingleScriptLinker, XSLinker

public abstract class SelectionScriptLinker
extends AbstractLinker

A base class for Linkers that use an external script to boostrap the GWT module. This implementation injects JavaScript Snippets into a JS program defined in an external file.
Created nocache.js files must provide an implementation of both __gwt_isKnownPropertyValue() and __gwt_getMetaProperty() to support the permutation selection process. These functions must be available within the nocache.js scope and must be made available to the permutation js scope.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	COMPUTE_SCRIPT_BASE_JS File name for computeScriptBase.js.
protected static String	FRAGMENT_EXTENSION The extension added to demand-loaded fragment files.
protected static String	FRAGMENT_SUBDIR A subdirectory to hold all the generated fragments.
protected static PermutationsUtil	permutationsUtil Utility class to handle insertion of permutations code.
protected static String	PROCESS_METAS_JS File name for processMetas.js.
static String	USE_SOURCE_MAPS_PROPERTY

Constructor Summary

Constructors

Constructor and Description
SelectionScriptLinker()

Method Summary

Methods

Modifier and Type	Method and Description
protected int	charsPerChunk(LinkerContext context, TreeLogger logger) Extract via CHUNK_SIZE_PROPERTY the number of characters to be included in each chunk.
protected Collection<Artifact<?>>	doEmitCompilation(TreeLogger logger, LinkerContext context, CompilationResult result, ArtifactSet artifacts)
protected List<Artifact<?>>	emitSelectionInformation(String strongName, CompilationResult result)
protected EmittedArtifact	emitSelectionScript(TreeLogger logger, LinkerContext context, ArtifactSet artifacts)
protected String	fillSelectionScriptTemplate(StringBuffer selectionScript, TreeLogger logger, LinkerContext context, ArtifactSet artifacts, CompilationResult result) Generate a selection script.
protected String	generateDeferredFragment(TreeLogger logger, LinkerContext context, int fragment, String js, ArtifactSet artifacts, CompilationResult result)
protected byte[]	generatePrimaryFragment(TreeLogger logger, LinkerContext context, CompilationResult result, String[] js, ArtifactSet artifacts) Generate the primary fragment.
protected String	generatePrimaryFragmentString(TreeLogger logger, LinkerContext context, CompilationResult result, String js, int length, ArtifactSet artifacts)
protected String	generateSelectionScript(TreeLogger logger, LinkerContext context, ArtifactSet artifacts)
protected String	generateSelectionScript(TreeLogger logger, LinkerContext context, ArtifactSet artifacts, CompilationResult result)
protected abstract String	getCompilationExtension(TreeLogger logger, LinkerContext context)
protected String	getDeferredFragmentPrefix(TreeLogger logger, LinkerContext context, int fragment)
protected String	getDeferredFragmentSuffix(TreeLogger logger, LinkerContext context, int fragment) Deprecated.
protected String	getDeferredFragmentSuffix2(TreeLogger logger, LinkerContext context, int fragment, String strongName) Returns the suffix at the end of a JavaScript fragment other than the initial fragment (new version).
protected String	getFragmentSubdir(TreeLogger logger, LinkerContext context) Returns the subdirectory name to be used by getModulPrefix when requesting a runAsync module.
protected String	getHostedFilename()
protected abstract String	getModulePrefix(TreeLogger logger, LinkerContext context, String strongName) Compute the beginning of a JavaScript file that will hold the main module implementation.
protected String	getModulePrefix(TreeLogger logger, LinkerContext context, String strongName, int numFragments) Compute the beginning of a JavaScript file that will hold the main module implementation.
protected String	getModuleSuffix(TreeLogger logger, LinkerContext context) Deprecated.
protected String	getModuleSuffix2(TreeLogger logger, LinkerContext context, String strongName) Returns the suffix for the initial JavaScript fragment (new version).
protected String	getScriptChunkSeparator(TreeLogger logger, LinkerContext context) Some subclasses support "chunking" of the primary fragment.
protected abstract String	getSelectionScriptTemplate(TreeLogger logger, LinkerContext context)
ArtifactSet	link(TreeLogger logger, LinkerContext context, ArtifactSet artifacts) This method is left in place for existing subclasses of SelectionScriptLinker that have not been upgraded for the sharding API.
ArtifactSet	link(TreeLogger logger, LinkerContext context, ArtifactSet artifacts, boolean onePermutation) This method is invoked for linkers annotated with Shardable.
protected void	maybeAddHostedModeFile(TreeLogger logger, LinkerContext context, ArtifactSet artifacts, CompilationResult result) Add the Development Mode file to the artifact set.
protected void	maybeOutputPropertyMap(TreeLogger logger, LinkerContext context, ArtifactSet toReturn)
protected StringBuffer	readFileToStringBuffer(String filename, TreeLogger logger)
protected static void	replaceAll(StringBuffer buf, String search, String replace)
static String	splitPrimaryJavaScript(StatementRanges ranges, String js, int charsPerChunk, String scriptChunkSeparator, LinkerContext context) Split a JavaScript string into multiple chunks, at statement boundaries.
boolean	supportsDevModeInJunit(LinkerContext context) Returns true if this linker supports DevMode.
protected String	wrapDeferredFragment(TreeLogger logger, LinkerContext context, int fragment, String script, ArtifactSet artifacts)
protected String	wrapPrimaryFragment(TreeLogger logger, LinkerContext context, String script, ArtifactSet artifacts, CompilationResult result)

Methods inherited from class com.google.gwt.core.ext.linker.AbstractLinker

emitBytes, emitBytes, emitInputStream, emitInputStream, emitString, emitString, emitWithStrongName, emitWithStrongName

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

getDescription, isShardable, relink

Methods inherited from class java.lang.Object

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

Field Detail

USE_SOURCE_MAPS_PROPERTY

public static final String USE_SOURCE_MAPS_PROPERTY

See Also:

Constant Field Values

COMPUTE_SCRIPT_BASE_JS

protected static final String COMPUTE_SCRIPT_BASE_JS

File name for computeScriptBase.js.

See Also:

Constant Field Values

FRAGMENT_EXTENSION

protected static final String FRAGMENT_EXTENSION

The extension added to demand-loaded fragment files.

See Also:

Constant Field Values

FRAGMENT_SUBDIR

protected static final String FRAGMENT_SUBDIR

A subdirectory to hold all the generated fragments.

See Also:

Constant Field Values

permutationsUtil

protected static PermutationsUtil permutationsUtil

Utility class to handle insertion of permutations code.

PROCESS_METAS_JS

protected static final String PROCESS_METAS_JS

File name for processMetas.js.

See Also:

Constant Field Values

Constructor Detail

SelectionScriptLinker

public SelectionScriptLinker()

Method Detail

splitPrimaryJavaScript

public static String splitPrimaryJavaScript(StatementRanges ranges,
                            String js,
                            int charsPerChunk,
                            String scriptChunkSeparator,
                            LinkerContext context)

Split a JavaScript string into multiple chunks, at statement boundaries. This method is made default access for testing.

Parameters:

ranges - Describes where the statements are located within the JavaScript code. If null, then return js unchanged.

js - The JavaScript code to be split up.

charsPerChunk - The number of characters to be put in each script tag.

scriptChunkSeparator - The string to insert between chunks.

context -

replaceAll

protected static void replaceAll(StringBuffer buf,
              String search,
              String replace)

link

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

This method is left in place for existing subclasses of SelectionScriptLinker that have not been upgraded for the sharding API.

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

Throws:

UnableToCompleteException - if compilation violates assumptions made by the Linker or for errors encountered by the Linker

link

public ArtifactSet link(TreeLogger logger,
               LinkerContext context,
               ArtifactSet artifacts,
               boolean onePermutation)
                 throws UnableToCompleteException

Description copied from class: Linker

This method is invoked for linkers annotated with Shardable. It is called at two points during compilation: after the compile of each permutation, and after all compilation has finished. The onePermutation is true for a per-permutation call and false for a global final-link call.

For one-permutation calls, this method is passed all artifacts generated for just the one permutation. For the global call at the end of compilation, this method sees artifacts for the whole compilation, but with two modifications intended to support builds on computer clusters:

1. All EmittedArtifacts have been converted to BinaryEmittedArtifacts
2. All artifacts not marked as Transferable have been discarded.

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

onePermutation - true for a one-permutation call

Returns:

the artifacts that should be propagated through the linker chain

Throws:

UnableToCompleteException - if compilation violates assumptions made by the Linker or for errors encountered by the Linker

supportsDevModeInJunit

public boolean supportsDevModeInJunit(LinkerContext context)

Description copied from class: Linker

Returns true if this linker supports DevMode.

Overrides:

supportsDevModeInJunit in class Linker

Parameters:

context - a LinkerContext

charsPerChunk

protected int charsPerChunk(LinkerContext context,
                TreeLogger logger)

Extract via CHUNK_SIZE_PROPERTY the number of characters to be included in each chunk.

doEmitCompilation

protected Collection<Artifact<?>> doEmitCompilation(TreeLogger logger,
                                        LinkerContext context,
                                        CompilationResult result,
                                        ArtifactSet artifacts)
                                             throws UnableToCompleteException

Throws:

UnableToCompleteException

emitSelectionInformation

protected List<Artifact<?>> emitSelectionInformation(String strongName,
                                         CompilationResult result)

emitSelectionScript

protected EmittedArtifact emitSelectionScript(TreeLogger logger,
                                  LinkerContext context,
                                  ArtifactSet artifacts)
                                       throws UnableToCompleteException

Throws:

UnableToCompleteException

fillSelectionScriptTemplate

protected String fillSelectionScriptTemplate(StringBuffer selectionScript,
                                 TreeLogger logger,
                                 LinkerContext context,
                                 ArtifactSet artifacts,
                                 CompilationResult result)
                                      throws UnableToCompleteException

Generate a selection script. The selection information should previously have been scanned using PermutationsUtil.setupPermutationsMap(ArtifactSet).

Throws:

UnableToCompleteException

generateDeferredFragment

protected String generateDeferredFragment(TreeLogger logger,
                              LinkerContext context,
                              int fragment,
                              String js,
                              ArtifactSet artifacts,
                              CompilationResult result)
                                   throws UnableToCompleteException

Parameters:

logger - a TreeLogger

context - a LinkerContext

fragment - the fragment number

Throws:

UnableToCompleteException

generatePrimaryFragment

protected byte[] generatePrimaryFragment(TreeLogger logger,
                             LinkerContext context,
                             CompilationResult result,
                             String[] js,
                             ArtifactSet artifacts)
                                  throws UnableToCompleteException

Generate the primary fragment. The default implementation is based on getModulePrefix(TreeLogger, LinkerContext, String, int) and getModuleSuffix(TreeLogger, LinkerContext).

Throws:

UnableToCompleteException

generatePrimaryFragmentString

protected String generatePrimaryFragmentString(TreeLogger logger,
                                   LinkerContext context,
                                   CompilationResult result,
                                   String js,
                                   int length,
                                   ArtifactSet artifacts)
                                        throws UnableToCompleteException

Throws:

UnableToCompleteException

generateSelectionScript

protected String generateSelectionScript(TreeLogger logger,
                             LinkerContext context,
                             ArtifactSet artifacts)
                                  throws UnableToCompleteException

Throws:

UnableToCompleteException

generateSelectionScript

protected String generateSelectionScript(TreeLogger logger,
                             LinkerContext context,
                             ArtifactSet artifacts,
                             CompilationResult result)
                                  throws UnableToCompleteException

Throws:

UnableToCompleteException

getCompilationExtension

protected abstract String getCompilationExtension(TreeLogger logger,
                             LinkerContext context)
                                           throws UnableToCompleteException

Throws:

UnableToCompleteException

getDeferredFragmentPrefix

protected String getDeferredFragmentPrefix(TreeLogger logger,
                               LinkerContext context,
                               int fragment)

getDeferredFragmentSuffix

@Deprecated
protected String getDeferredFragmentSuffix(TreeLogger logger,
                                          LinkerContext context,
                                          int fragment)

Deprecated.

Returns the suffix at the end of a JavaScript fragment other than the initial fragment (deprecated version). The default version returns null, which will cause getDeferredFragmentSuffix2(com.google.gwt.core.ext.TreeLogger, com.google.gwt.core.ext.LinkerContext, int, java.lang.String) to be called instead. Subclasses should switch to extending getDeferredFragmentSuffix2.

getDeferredFragmentSuffix2

protected String getDeferredFragmentSuffix2(TreeLogger logger,
                                LinkerContext context,
                                int fragment,
                                String strongName)

Returns the suffix at the end of a JavaScript fragment other than the initial fragment (new version). This method won't be called if getDeferredFragmentSuffix(com.google.gwt.core.ext.TreeLogger, com.google.gwt.core.ext.LinkerContext, int) is overridden to return non-null. Subclasses should stop implementing getDeferredFramgnentSuffix and implement getDeferredFragmentSuffix2 instead.

getFragmentSubdir

protected final String getFragmentSubdir(TreeLogger logger,
                       LinkerContext context)
                                  throws UnableToCompleteException

Returns the subdirectory name to be used by getModulPrefix when requesting a runAsync module. It is specified by PROP_FRAGMENT_SUBDIR_OVERRIDE and, aside from test cases, is always FRAGMENT_SUBDIR.

Throws:

UnableToCompleteException

getHostedFilename

protected String getHostedFilename()

getModulePrefix

protected abstract String getModulePrefix(TreeLogger logger,
                     LinkerContext context,
                     String strongName)
                                   throws UnableToCompleteException

Compute the beginning of a JavaScript file that will hold the main module implementation.

Throws:

UnableToCompleteException

getModulePrefix

protected String getModulePrefix(TreeLogger logger,
                     LinkerContext context,
                     String strongName,
                     int numFragments)
                          throws UnableToCompleteException

Compute the beginning of a JavaScript file that will hold the main module implementation. By default, calls getModulePrefix(TreeLogger, LinkerContext, String).

Parameters:

strongName - strong name of the module being emitted

numFragments - the number of fragments for this module, including the main fragment (fragment 0)

Throws:

UnableToCompleteException

getModuleSuffix

@Deprecated
protected String getModuleSuffix(TreeLogger logger,
                                LinkerContext context)
                          throws UnableToCompleteException

Deprecated.

Returns the suffix for the initial JavaScript fragment (deprecated version). The default returns null, which will cause getModuleSuffix2(com.google.gwt.core.ext.TreeLogger, com.google.gwt.core.ext.LinkerContext, java.lang.String) to be called instead. Subclasses should switch to extending getModuleSuffix2.

Throws:

UnableToCompleteException

getModuleSuffix2

protected String getModuleSuffix2(TreeLogger logger,
                      LinkerContext context,
                      String strongName)
                           throws UnableToCompleteException

Returns the suffix for the initial JavaScript fragment (new version). This version will not be called if getModuleSuffix(com.google.gwt.core.ext.TreeLogger, com.google.gwt.core.ext.LinkerContext) is overridden so that it doesn't return null. Subclasses should stop implementing getModuleSuffix and implmenet getModuleSuffix2 instead.

Throws:

UnableToCompleteException

getScriptChunkSeparator

protected String getScriptChunkSeparator(TreeLogger logger,
                             LinkerContext context)

Some subclasses support "chunking" of the primary fragment. If chunking will be supported, this function should be overridden to return the string which should be inserted between each chunk.

getSelectionScriptTemplate

protected abstract String getSelectionScriptTemplate(TreeLogger logger,
                                LinkerContext context)
                                              throws UnableToCompleteException

Throws:

UnableToCompleteException

maybeAddHostedModeFile

protected void maybeAddHostedModeFile(TreeLogger logger,
                          LinkerContext context,
                          ArtifactSet artifacts,
                          CompilationResult result)
                               throws UnableToCompleteException

Add the Development Mode file to the artifact set.

Throws:

UnableToCompleteException

maybeOutputPropertyMap

protected void maybeOutputPropertyMap(TreeLogger logger,
                          LinkerContext context,
                          ArtifactSet toReturn)

readFileToStringBuffer

protected StringBuffer readFileToStringBuffer(String filename,
                                  TreeLogger logger)
                                       throws UnableToCompleteException

Throws:

UnableToCompleteException

wrapDeferredFragment

protected String wrapDeferredFragment(TreeLogger logger,
                          LinkerContext context,
                          int fragment,
                          String script,
                          ArtifactSet artifacts)
                               throws UnableToCompleteException

Throws:

UnableToCompleteException

wrapPrimaryFragment

protected String wrapPrimaryFragment(TreeLogger logger,
                         LinkerContext context,
                         String script,
                         ArtifactSet artifacts,
                         CompilationResult result)
                              throws UnableToCompleteException

Throws:

UnableToCompleteException