com.google.javascript.jscomp

Class AbstractCompiler

java.lang.Object

com.google.javascript.jscomp.AbstractCompiler

All Implemented Interfaces:

SourceExcerptProvider

Direct Known Subclasses:

Compiler

public abstract class AbstractCompiler
extends Object
implements SourceExcerptProvider

An abstract compiler, to help remove the circular dependency of passes on JSCompiler. This is an abstract class, so that we can make the methods package-private.

Author:

[email protected] (Nick Santos)

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.javascript.jscomp.SourceExcerptProvider

SourceExcerptProvider.ExcerptFormatter, SourceExcerptProvider.SourceExcerpt

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	annotationMap

Constructor Summary

Constructors

Constructor and Description
AbstractCompiler()

Method Summary

Modifier and Type	Method and Description
abstract void	addExportedNames(Set<String> exportedVariableNames) Adds exported names to keep track.
abstract void	addInputSourceMap(String name, SourceMapInput sourceMap) Adds a SourceMapInput for the given sourceFileName, to be used for error reporting and source map combining.
abstract void	clearTypeIRegistry()
abstract CodingConvention	getCodingConvention() Gets the current coding convention.
abstract com.google.javascript.jscomp.IdGenerator	getCrossModuleIdGenerator() Gets the id generator for cross-module motion.
abstract ErrorManager	getErrorManager() Gets the error manager.
abstract Set<String>	getExportedNames() Gets the names that have been exported.
abstract com.google.javascript.jscomp.FunctionNames	getFunctionNames() Gets the fully qualified function name and globally unique id mapping.
abstract CompilerInput	getInput(InputId inputId) Looks up an input (possibly an externs input) by input id.
abstract double	getProgress()
abstract ReverseAbstractInterpreter	getReverseAbstractInterpreter() Get an interpreter for type analysis.
abstract Node	getRoot() Returns the root node of the AST, which includes both externs and source.
abstract TypedScope	getTopScope() Gets the top scope.
abstract TypeIRegistry	getTypeIRegistry()
abstract JSTypeRegistry	getTypeRegistry() Gets a central registry of type information from the compiled JS.
abstract void	report(JSError error) Report an error or warning.
abstract void	reportCodeChange() Deprecated. Use #reportChangeToEnclosingScope or NodeTraversal#reportCodeChange instead
abstract void	setAnonymousFunctionNameMap(VariableMap functionMap) Sets the naming map for anonymous functions
abstract void	setCssNames(Map<String,Integer> newCssNames) Sets the css names found during compilation.
abstract void	setFunctionNames(com.google.javascript.jscomp.FunctionNames functionNames) Sets the fully qualified function name and globally unique id mapping.
abstract void	setIdGeneratorMap(String serializedIdMappings) Sets the id generator for cross-module motion.
abstract void	setPropertyMap(VariableMap propertyMap) Sets the property renaming map
abstract void	setStringMap(VariableMap stringMap) Sets the string replacement map
abstract void	setVariableMap(VariableMap variableMap) Sets the variable renaming map
abstract String	toSource() Prints a node to source code.
abstract String	toSource(Node root) Prints a node to source code.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.javascript.jscomp.SourceExcerptProvider

getSourceLine, getSourceMapping, getSourceRegion

Field Detail

annotationMap

protected Map<String,Object> annotationMap

Constructor Detail

AbstractCompiler

public AbstractCompiler()

Method Detail

getInput

public abstract CompilerInput getInput(InputId inputId)

Looks up an input (possibly an externs input) by input id. May return null.

addExportedNames

public abstract void addExportedNames(Set<String> exportedVariableNames)

Adds exported names to keep track.

getExportedNames

public abstract Set<String> getExportedNames()

Gets the names that have been exported.

setVariableMap

public abstract void setVariableMap(VariableMap variableMap)

Sets the variable renaming map

setPropertyMap

public abstract void setPropertyMap(VariableMap propertyMap)

Sets the property renaming map

setStringMap

public abstract void setStringMap(VariableMap stringMap)

Sets the string replacement map

setFunctionNames

public abstract void setFunctionNames(com.google.javascript.jscomp.FunctionNames functionNames)

Sets the fully qualified function name and globally unique id mapping.

getFunctionNames

public abstract com.google.javascript.jscomp.FunctionNames getFunctionNames()

Gets the fully qualified function name and globally unique id mapping.

setCssNames

public abstract void setCssNames(Map<String,Integer> newCssNames)

Sets the css names found during compilation.

setIdGeneratorMap

public abstract void setIdGeneratorMap(String serializedIdMappings)

Sets the id generator for cross-module motion.

getCrossModuleIdGenerator

public abstract com.google.javascript.jscomp.IdGenerator getCrossModuleIdGenerator()

Gets the id generator for cross-module motion.

setAnonymousFunctionNameMap

public abstract void setAnonymousFunctionNameMap(VariableMap functionMap)

Sets the naming map for anonymous functions

getTypeRegistry

public abstract JSTypeRegistry getTypeRegistry()

Gets a central registry of type information from the compiled JS.

getTypeIRegistry

public abstract TypeIRegistry getTypeIRegistry()

clearTypeIRegistry

public abstract void clearTypeIRegistry()

getTopScope

public abstract TypedScope getTopScope()

Gets the top scope.

report

public abstract void report(JSError error)

Report an error or warning.

getCodingConvention

public abstract CodingConvention getCodingConvention()

Gets the current coding convention.

reportCodeChange

@Deprecated
public abstract void reportCodeChange()

Deprecated. Use #reportChangeToEnclosingScope or NodeTraversal#reportCodeChange instead

Report code changes. Passes should call reportCodeChange when they alter the JS tree. This is verified by CompilerTestCase. This allows us to optimize to a fixed point.

toSource

public abstract String toSource()

Prints a node to source code.

toSource

public abstract String toSource(Node root)

Prints a node to source code.

getReverseAbstractInterpreter

public abstract ReverseAbstractInterpreter getReverseAbstractInterpreter()

Get an interpreter for type analysis.

getErrorManager

public abstract ErrorManager getErrorManager()

Gets the error manager.

getRoot

public abstract Node getRoot()

Returns the root node of the AST, which includes both externs and source.

getProgress

public abstract double getProgress()

Returns:

a number in [0,1] range indicating an approximate progress of the last compile. Note this should only be used as a hint and no assumptions should be made on accuracy, even a completed compile may choose not to set this to 1.0 at the end.

addInputSourceMap

public abstract void addInputSourceMap(String name,
                                       SourceMapInput sourceMap)

Adds a SourceMapInput for the given sourceFileName, to be used for error reporting and source map combining.