com.google.gwt.dev.javac

Class StandardGeneratorContext

java.lang.Object

com.google.gwt.dev.javac.StandardGeneratorContext

All Implemented Interfaces:

GeneratorContext

public class StandardGeneratorContext
extends Object
implements GeneratorContext

Manages generators and generated units during a single compilation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StandardGeneratorContext.GeneratedUnitImpl This generated unit acts as a normal generated unit as well as a buffer into which generators can write their source.

Constructor Summary

Constructors

Constructor and Description
StandardGeneratorContext(CompilerContext compilerContext, CompilationState compilationState, ArtifactSet allGeneratedArtifacts, boolean isProdMode) Normally, the compiler host would be aware of the same types that are available in the supplied type oracle although it isn't strictly required.

Method Summary

Modifier and Type	Method and Description
void	addGeneratedUnit(GeneratedUnit gu) Adds a generated unit to the context if not already present, but will not overwrite an existing unit.
void	addGeneratedUnits(Collection<GeneratedUnit> generatedUnits) Adds generated units to the context, but will not overwrite any existing units that might already be present.
void	addGeneratedUnitsFromCache() Adds all available cached generated units to the context.
void	addGeneratedUnitsMarkedForReuseFromCache() Adds cached generated units to the context that have been marked for reuse.
boolean	checkRebindRuleAvailable(String sourceTypeName) Checks whether a rebind rule is available for a given sourceTypeName.
void	clear() Frees memory used up by compilation state.
void	commit(TreeLogger logger, PrintWriter pw) Commits a pending generated type.
void	commitArtifact(TreeLogger logger, Artifact<?> artifact) Adds an Artifact to the context's ArtifactSets.
void	commitArtifactsFromCache(TreeLogger logger) Commits all available cached Artifacts to the context.
GeneratedResource	commitResource(TreeLogger logger, OutputStream os) Commits resource generation begun with GeneratorContext.tryCreateResource(TreeLogger, String).
ArtifactSet	finish(TreeLogger logger) Call this whenever generators are known to not be running to clear out uncommitted compilation units and to force committed compilation units to be parsed and added to the type oracle.
Set<String>	getActiveLinkerNames()
ArtifactSet	getArtifacts() Gets newly committed artifacts.
CachedGeneratorResult	getCachedGeneratorResult() Gets the previously cached rebind result for the current generator.
GeneratorContext	getCanonicalContext()
CompilationState	getCompilationState()
Map<String,GeneratedUnit>	getGeneratedUnitMap() Gets all committed Java units.
PropertyOracle	getPropertyOracle() Gets the property oracle for the current generator context.
ResourceOracle	getResourcesOracle() Returns a resource oracle containing all resources that are mapped into the module's source (or super-source) paths.
TypeOracle	getTypeOracle() Gets the type oracle for the current generator context.
boolean	isDirty()
boolean	isGeneratorResultCachingEnabled() Check whether generator result caching is currently enabled.
boolean	isGlobalCompile() Returns whether the current compile and generator passes are executing in the global phase of a compile, as opposed to further down in the dependency tree.
boolean	isProdMode() Returns true if generators are being run to produce code for a production compile.
void	reset() Clears all accumulated artifacts and state so that the context can be used as if from scratch.
String	runGenerator(TreeLogger logger, Class<? extends Generator> generatorClass, String typeName) This method is maintained for backwards compatibility.
RebindResult	runGeneratorIncrementally(TreeLogger logger, Class<? extends Generator> generatorClass, String typeName) Runs a generator incrementally, with support for managing the returned RebindResult object, which can contain cached results.
void	setCachedGeneratorResult(CachedGeneratorResult cachedRebindResult) Set previously cached rebind result for currently active generator.
void	setCurrentGenerator(Class<? extends Generator> currentGenerator)
void	setCurrentRebindBinaryTypeName(String currentRebindBinaryTypeName)
void	setGeneratorResultCachingEnabled(boolean enabled)
void	setPropertyOracle(PropertyOracle propertyOracle) Sets the current transient property oracle to answer current property questions.
void	setRebindRuleResolver(RebindRuleResolver resolver)
PrintWriter	tryCreate(TreeLogger logger, String packageName, String simpleTypeName) Attempts to get a PrintWriter so that the caller can generate the source code for the named type.
OutputStream	tryCreateResource(TreeLogger logger, String partialPath) Attempts to get an OutputStream so that the caller can write file contents into the named file underneath the compilation output directory.
boolean	tryReuseTypeFromCache(String typeName) Adds a type name to the list of types to be reused from cache, if available.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, toString

Constructor Detail

StandardGeneratorContext

public StandardGeneratorContext(CompilerContext compilerContext,
                                CompilationState compilationState,
                                ArtifactSet allGeneratedArtifacts,
                                boolean isProdMode)

Normally, the compiler host would be aware of the same types that are available in the supplied type oracle although it isn't strictly required.

Method Detail

addGeneratedUnit

public void addGeneratedUnit(GeneratedUnit gu)

Adds a generated unit to the context if not already present, but will not overwrite an existing unit.

addGeneratedUnits

public void addGeneratedUnits(Collection<GeneratedUnit> generatedUnits)

Adds generated units to the context, but will not overwrite any existing units that might already be present.

addGeneratedUnitsFromCache

public void addGeneratedUnitsFromCache()

Adds all available cached generated units to the context. Existing units for a given type will not be overwritten.

addGeneratedUnitsMarkedForReuseFromCache

public void addGeneratedUnitsMarkedForReuseFromCache()

Adds cached generated units to the context that have been marked for reuse. Existing units for a given type will not be overwritten.

checkRebindRuleAvailable

public boolean checkRebindRuleAvailable(String sourceTypeName)

Checks whether a rebind rule is available for a given sourceTypeName.

Specified by:

checkRebindRuleAvailable in interface GeneratorContext

Parameters:

sourceTypeName - the name of a type to check for rebind rule availability.

Returns:

true if a rebind rule is available

clear

public void clear()

Frees memory used up by compilation state.

commit

public final void commit(TreeLogger logger,
                         PrintWriter pw)

Commits a pending generated type.

Specified by:

commit in interface GeneratorContext

commitArtifact

public void commitArtifact(TreeLogger logger,
                           Artifact<?> artifact)

Adds an Artifact to the context's ArtifactSets. This will replace a pre-existing entry in allGeneratedArtifacts, but will not overwrite an entry in the newlyGeneratedArtifacts (since it is assumed by convention that only new entries will ever be inserted here for a given generator run).

Specified by:

commitArtifact in interface GeneratorContext

Parameters:

logger - a logger; normally the logger passed into the currently invoked generator or a branch thereof

artifact - the Artifact to provide to the Linker chain.

commitArtifactsFromCache

public void commitArtifactsFromCache(TreeLogger logger)

Commits all available cached Artifacts to the context.

commitResource

public GeneratedResource commitResource(TreeLogger logger,
                                        OutputStream os)
                                 throws UnableToCompleteException

Description copied from interface: GeneratorContext

Commits resource generation begun with GeneratorContext.tryCreateResource(TreeLogger, String).

Specified by:

commitResource in interface GeneratorContext

Returns:

the GeneratedResource that was created as a result of committing the OutputStream.

Throws:

UnableToCompleteException - if the resource cannot be written to disk, if the specified stream is unknown, or if the stream has already been committed

finish

public ArtifactSet finish(TreeLogger logger)
                   throws UnableToCompleteException

Call this whenever generators are known to not be running to clear out uncommitted compilation units and to force committed compilation units to be parsed and added to the type oracle.

Returns:

any newly generated artifacts since the last call

Throws:

UnableToCompleteException

isDirty

public boolean isDirty()

reset

public void reset()

Clears all accumulated artifacts and state so that the context can be used as if from scratch. Is useful for clearing out undesired changes after having used the context to explore some hypothetical situations, for example to run Generators for the purpose of discovering the properties they depend on.

getActiveLinkerNames

public Set<String> getActiveLinkerNames()

getArtifacts

public ArtifactSet getArtifacts()

Gets newly committed artifacts.

getCachedGeneratorResult

public CachedGeneratorResult getCachedGeneratorResult()

Gets the previously cached rebind result for the current generator.

Specified by:

getCachedGeneratorResult in interface GeneratorContext

Returns:

A CachedGeneratorResult object, if one has been provided to the context. Null is returned if there is no previous result available.

getCanonicalContext

public GeneratorContext getCanonicalContext()

getCompilationState

public CompilationState getCompilationState()

getGeneratedUnitMap

public Map<String,GeneratedUnit> getGeneratedUnitMap()

Gets all committed Java units.

getPropertyOracle

public final PropertyOracle getPropertyOracle()

Description copied from interface: GeneratorContext

Gets the property oracle for the current generator context. Generators can use the property oracle to query deferred binding properties.

Specified by:

getPropertyOracle in interface GeneratorContext

isGlobalCompile

public boolean isGlobalCompile()

Returns whether the current compile and generator passes are executing in the global phase of a compile, as opposed to further down in the dependency tree.

getResourcesOracle

public ResourceOracle getResourcesOracle()

Description copied from interface: GeneratorContext

Returns a resource oracle containing all resources that are mapped into the module's source (or super-source) paths. Conceptually, this resource oracle exposes resources which are "siblings" to GWT-compatible Java classes. For example, if the module includes com.google.gwt.core.client as a source package, then a resource at com/google/gwt/core/client/Foo.properties would be exposed by this resource oracle.

Specified by:

getResourcesOracle in interface GeneratorContext

getTypeOracle

public final TypeOracle getTypeOracle()

Description copied from interface: GeneratorContext

Gets the type oracle for the current generator context. Generators can use the type oracle to ask questions about the entire translatable code base.

Specified by:

getTypeOracle in interface GeneratorContext

Returns:

a TypeOracle over all the relevant translatable compilation units in the source path

isGeneratorResultCachingEnabled

public boolean isGeneratorResultCachingEnabled()

Description copied from interface: GeneratorContext

Check whether generator result caching is currently enabled.

Specified by:

isGeneratorResultCachingEnabled in interface GeneratorContext

isProdMode

public boolean isProdMode()

Description copied from interface: GeneratorContext

Returns true if generators are being run to produce code for a production compile. Returns false for dev mode. Generators can use this information to produce code optimized for the target.

Specified by:

isProdMode in interface GeneratorContext

runGenerator

public String runGenerator(TreeLogger logger,
                           Class<? extends Generator> generatorClass,
                           String typeName)
                    throws UnableToCompleteException

This method is maintained for backwards compatibility. runGeneratorIncrementally(com.google.gwt.core.ext.TreeLogger, java.lang.Class<? extends com.google.gwt.core.ext.Generator>, java.lang.String) should be used instead.

Throws:

UnableToCompleteException

runGeneratorIncrementally

public RebindResult runGeneratorIncrementally(TreeLogger logger,
                                              Class<? extends Generator> generatorClass,
                                              String typeName)
                                       throws UnableToCompleteException

Runs a generator incrementally, with support for managing the returned RebindResult object, which can contain cached results. This is a replacement for the runGenerator(com.google.gwt.core.ext.TreeLogger, java.lang.Class<? extends com.google.gwt.core.ext.Generator>, java.lang.String) method.

If the passed in generatorClass is an instance of IncrementalGenerator, it's IncrementalGenerator.generateIncrementally(com.google.gwt.core.ext.TreeLogger, com.google.gwt.core.ext.GeneratorContext, java.lang.String) method will be called.

Otherwise, for backwards compatibility, the generatorClass will be wrapped in a IncrementalGenerator instance, and it's Generator.generate(com.google.gwt.core.ext.TreeLogger, com.google.gwt.core.ext.GeneratorContext, java.lang.String) method will be called.

Parameters:

logger -

generatorClass -

typeName -

Returns:

a RebindResult

Throws:

UnableToCompleteException

setCachedGeneratorResult

public void setCachedGeneratorResult(CachedGeneratorResult cachedRebindResult)

Set previously cached rebind result for currently active generator.

setCurrentGenerator

public void setCurrentGenerator(Class<? extends Generator> currentGenerator)

setCurrentRebindBinaryTypeName

public void setCurrentRebindBinaryTypeName(String currentRebindBinaryTypeName)

setGeneratorResultCachingEnabled

public void setGeneratorResultCachingEnabled(boolean enabled)

setPropertyOracle

public void setPropertyOracle(PropertyOracle propertyOracle)

Sets the current transient property oracle to answer current property questions.

setRebindRuleResolver

public void setRebindRuleResolver(RebindRuleResolver resolver)

tryCreate

public PrintWriter tryCreate(TreeLogger logger,
                             String packageName,
                             String simpleTypeName)

Description copied from interface: GeneratorContext

Attempts to get a PrintWriter so that the caller can generate the source code for the named type. If the named types already exists, null is returned to indicate that no work needs to be done. The file is not committed until GeneratorContext.commit(TreeLogger, PrintWriter) is called.

Specified by:

tryCreate in interface GeneratorContext

Parameters:

logger - a logger; normally the logger passed into the currently invoked generator, or a branch thereof

packageName - the name of the package to which the create type belongs

simpleTypeName - the unqualified source name of the type being generated

Returns:

null if the package and class already exists, otherwise a PrintWriter is returned.

tryCreateResource

public OutputStream tryCreateResource(TreeLogger logger,
                                      String partialPath)
                               throws UnableToCompleteException

Description copied from interface: GeneratorContext

Attempts to get an OutputStream so that the caller can write file contents into the named file underneath the compilation output directory. The file is not committed until GeneratorContext.commitResource(TreeLogger, OutputStream) is called.

Specified by:

tryCreateResource in interface GeneratorContext

Parameters:

logger - a logger; normally the logger passed into the currently invoked generator, or a branch thereof

partialPath - the name of the file whose contents are to be written; the name can include subdirectories separated by forward slashes ('/')

Returns:

an OutputStream into which file contents can be written, or null if a resource by that name is already pending or already exists

Throws:

UnableToCompleteException - if the resource could not be initialized for some reason, such as if the specified partial path is invalid

tryReuseTypeFromCache

public boolean tryReuseTypeFromCache(String typeName)

Adds a type name to the list of types to be reused from cache, if available.

Specified by:

tryReuseTypeFromCache in interface GeneratorContext

Parameters:

typeName - The fully qualified name of a type.

Returns:

true, if the type is available in the cache and was successfully added to the list for reuse, false otherwise.