Compiler (Closure Compiler v20160822 API)

java.lang.Object
- com.google.javascript.jscomp.AbstractCompiler
- - com.google.javascript.jscomp.Compiler

All Implemented Interfaces:

ErrorHandler, SourceExcerptProvider
```
public class Compiler
extends AbstractCompiler
implements ErrorHandler
```
Compiler (and the other classes in this package) does the following:
- parses JS code
- checks for undefined variables
- performs optimizations such as constant folding and constants inlining
- renames variables (to short names)
- outputs compact JavaScript code
External variables are declared in 'externs' files. For instance, the file may include definitions for global javascript/browser objects such as window, document.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Compiler.CodeBuilder
Stores a buffer of text to which more can be appended.
- Nested classes/interfaces inherited from interface com.google.javascript.jscomp.SourceExcerptProvider
  SourceExcerptProvider.ExcerptFormatter, SourceExcerptProvider.SourceExcerpt

Nested Classes
Modifier and Type	Class and Description
`static class`	`Compiler.CodeBuilder` Stores a buffer of text to which more can be appended.

Field Summary

Fields
Modifier and Type	Field and Description
`static DiagnosticType`	`MOTION_ITERATIONS_ERROR`
`static DiagnosticType`	`OPTIMIZE_LOOP_ERROR` Error strings used for reporting JSErrors
`protected com.google.javascript.jscomp.RecentChange`	`recentChange`
`PerformanceTracker`	`tracker`

Constructor Summary

Constructors
Constructor and Description
`Compiler()` Creates a Compiler that reports errors and warnings to its logger.
`Compiler(ErrorManager errorManager)` Creates a Compiler that uses a custom error manager.
`Compiler(PrintStream stream)` Creates a Compiler that reports errors and warnings to an output stream.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addNewScript(JsAst ast)` Adds a new Script AST to the compile state.
`SymbolTable`	`buildKnownSymbolTable()`
`void`	`check()`
`<T1 extends SourceFile,T2 extends SourceFile> Result`	`compile(List<T1> externs, List<T2> inputs, CompilerOptions options)` Compiles a list of inputs.
`Result`	`compile(SourceFile extern, SourceFile input, CompilerOptions options)`
`<T extends SourceFile> Result`	`compileModules(List<T> externs, List<JSModule> modules, CompilerOptions options)` Compiles a list of modules.
`protected Config`	`createConfig(Config.LanguageMode mode)`
`void`	`disableThreads()` Disable threads.
`String`	`getAstDotGraph()` Gets the DOT graph of the AST generated at the end of compilation.
`CodingConvention`	`getCodingConvention()` Gets the current coding convention.
`List<Comment>`	`getComments(String filename)` Returns all the comments from the given file.
`protected DiagnosticGroups`	`getDiagnosticGroups()` The warning classes that are available from the command-line, and are suppressible by the `@suppress` annotation.
`int`	`getErrorCount()` Gets the number of errors.
`CheckLevel`	`getErrorLevel(JSError error)`
`ErrorManager`	`getErrorManager()` Gets the error manager.
`JSError[]`	`getErrors()` Returns the array of errors (never null).
`CompilerInput`	`getInput(InputId id)` Looks up an input (possibly an externs input) by input id.
`Map<InputId,CompilerInput>`	`getInputsById()` Returns an unmodifiable view of the compiler inputs indexed by id.
`double`	`getProgress()`
`static String`	`getReleaseDate()` Returns the compiler date baked into the jar.
`static String`	`getReleaseVersion()` Returns the compiler version baked into the jar.
`Result`	`getResult()` Returns the result of the compilation.
`ReverseAbstractInterpreter`	`getReverseAbstractInterpreter()` Get an interpreter for type analysis.
`Node`	`getRoot()` Returns the root node of the AST, which includes both externs and source.
`String`	`getSourceLine(String sourceName, int lineNumber)` Get the line indicated by the line number.
`SourceMap`	`getSourceMap()`
`com.google.debugging.sourcemap.proto.Mapping.OriginalMapping`	`getSourceMapping(String sourceName, int lineNumber, int columnNumber)` If the source file is associated with an inputSourceMap, does a lookup for the original file position based on this source map.
`Region`	`getSourceRegion(String sourceName, int lineNumber)` Get a region around the indicated line number.
`TypedScope`	`getTopScope()` Gets the top scope.
`com.google.javascript.jscomp.MemoizedScopeCreator`	`getTypedScopeCreator()` Gets a memoized scope creator with type information.
`TypeIRegistry`	`getTypeIRegistry()`
`JSTypeRegistry`	`getTypeRegistry()` Gets a central registry of type information from the compiled JS.
`int`	`getWarningCount()` Gets the number of warnings.
`JSError[]`	`getWarnings()` Returns the array of warnings (never null).
`boolean`	`hasErrors()` Consults the `ErrorManager` to see if we've encountered errors that should halt compilation.
`<T1 extends SourceFile,T2 extends SourceFile> void`	`init(List<T1> externs, List<T2> inputs, CompilerOptions options)` Initializes the instance state needed for a compile job.
`<T extends SourceFile> void`	`initModules(List<T> externs, List<JSModule> modules, CompilerOptions options)` Initializes the instance state needed for a compile job if the sources are in modules.
`void`	`initOptions(CompilerOptions options)` Initializes the compiler options.
`static String`	`joinPathParts(String... pathParts)` Creates an OS specific path string from parts
`protected CompilerOptions`	`newCompilerOptions()` Allow subclasses to override the default CompileOptions object.
`void`	`normalize()`
`void`	`optimize()`
`void`	`parse()`
`Node`	`parse(SourceFile file)`
`void`	`printConfig(PrintStream printStream)`
`void`	`rebuildInputsFromModules()` Rebuilds the internal list of inputs by iterating over all modules.
`protected void`	`reconcileOptionsWithGuards()` When the CompilerOptions and its WarningsGuard overlap, reconcile any discrepencies.
`protected void`	`removeExternInput(InputId id)` Removes an input file from AST.
`void`	`replaceScript(JsAst ast)` Replaces one file in a hot-swap mode.
`void`	`report(CheckLevel ignoredLevel, JSError error)`
`void`	`report(JSError error)` Report an error or warning.
`void`	`reportCodeChange()` Report code changes.
`void`	`setErrorManager(ErrorManager errorManager)` Sets the error manager.
`static void`	`setLoggingLevel(Level level)` Sets the logging level for the com.google.javascript.jscomp package.
`void`	`setPassConfig(PassConfig passes)`
`void`	`setTimeout(int timeout)` Sets the timeout when Compiler is run in a thread
`String`	`toSource()` Converts the main parse tree back to JS code.
`void`	`toSource(Compiler.CodeBuilder cb, int inputSeqNum, Node root)` Writes out JS code from a root node.
`String`	`toSource(JSModule module)` Converts the parse tree for a module back to JS code.
`String`	`toSource(Node n)` Generates JavaScript source code for an AST, doesn't generate source map info.
`String[]`	`toSourceArray()` Converts the parse tree for each input back to JS code.
`String[]`	`toSourceArray(JSModule module)` Converts the parse tree for each input in a module back to JS code.
`void`	`transpileAndDontCheck()`
`void`	`whitespaceOnlyPasses()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - tracker
```
public PerformanceTracker tracker
```
  - OPTIMIZE_LOOP_ERROR
```
public static final DiagnosticType OPTIMIZE_LOOP_ERROR
```
    Error strings used for reporting JSErrors
  - MOTION_ITERATIONS_ERROR
```
public static final DiagnosticType MOTION_ITERATIONS_ERROR
```
  - recentChange
```
protected final com.google.javascript.jscomp.RecentChange recentChange
```
- Constructor Detail
  - Compiler
```
public Compiler()
```
    Creates a Compiler that reports errors and warnings to its logger.
  - Compiler
```
public Compiler(PrintStream stream)
```
    Creates a Compiler that reports errors and warnings to an output stream.
  - Compiler
```
public Compiler(ErrorManager errorManager)
```
    Creates a Compiler that uses a custom error manager.
- Method Detail
  - setErrorManager
```
public void setErrorManager(ErrorManager errorManager)
```
    Sets the error manager.
    
    Parameters:
    
    errorManager - the error manager, it cannot be null
  - initOptions
```
public void initOptions(CompilerOptions options)
```
    Initializes the compiler options. It's called as part of a normal compile() job. Public for the callers that are not doing a normal compile() job.
  - printConfig
```
public void printConfig(PrintStream printStream)
```
  - reconcileOptionsWithGuards
```
protected void reconcileOptionsWithGuards()
```
    When the CompilerOptions and its WarningsGuard overlap, reconcile any discrepencies.
  - init
```
public <T1 extends SourceFile,T2 extends SourceFile> void init(List<T1> externs,
                                                               List<T2> inputs,
                                                               CompilerOptions options)
```
    Initializes the instance state needed for a compile job.
  - initModules
```
public <T extends SourceFile> void initModules(List<T> externs,
                                               List<JSModule> modules,
                                               CompilerOptions options)
```
    Initializes the instance state needed for a compile job if the sources are in modules.
  - joinPathParts
```
public static String joinPathParts(String... pathParts)
```
    Creates an OS specific path string from parts
  - rebuildInputsFromModules
```
public void rebuildInputsFromModules()
```
    Rebuilds the internal list of inputs by iterating over all modules. This is necessary if inputs have been added to or removed from a module after the init(List, List, CompilerOptions) call.
  - compile
```
public Result compile(SourceFile extern,
                      SourceFile input,
                      CompilerOptions options)
```
  - compile
```
public <T1 extends SourceFile,T2 extends SourceFile> Result compile(List<T1> externs,
                                                                    List<T2> inputs,
                                                                    CompilerOptions options)
```
    Compiles a list of inputs.
  - compileModules
```
public <T extends SourceFile> Result compileModules(List<T> externs,
                                                    List<JSModule> modules,
                                                    CompilerOptions options)
```
    Compiles a list of modules.
  - disableThreads
```
public void disableThreads()
```
    Disable threads. This is for clients that run on AppEngine and don't have threads.
  - setTimeout
```
public void setTimeout(int timeout)
```
    Sets the timeout when Compiler is run in a thread
    
    Parameters:
    
    timeout - seconds to wait before timeout
  - parse
```
public void parse()
```
  - setPassConfig
```
public void setPassConfig(PassConfig passes)
```
    Parameters:
    
    passes - The PassConfig to use with this Compiler.
    
    Throws:
    
    NullPointerException - if passes is null
    
    IllegalStateException - if this.passes has already been assigned
  - whitespaceOnlyPasses
```
public void whitespaceOnlyPasses()
```
  - transpileAndDontCheck
```
public void transpileAndDontCheck()
```
  - check
```
public void check()
```
  - getResult
```
public Result getResult()
```
    Returns the result of the compilation.
  - getErrors
```
public JSError[] getErrors()
```
    Returns the array of errors (never null).
  - getWarnings
```
public JSError[] getWarnings()
```
    Returns the array of warnings (never null).
  - getRoot
```
public Node getRoot()
```
    Description copied from class: AbstractCompiler
    
    Returns the root node of the AST, which includes both externs and source.
  - getInput
```
public CompilerInput getInput(InputId id)
```
    Description copied from class: AbstractCompiler
    
    Looks up an input (possibly an externs input) by input id. May return null.
    
    Specified by:
    
    getInput in class AbstractCompiler
  - removeExternInput
```
protected void removeExternInput(InputId id)
```
    Removes an input file from AST.
    
    Parameters:
    
    id - The id of the input to be removed.
  - getTypeIRegistry
```
public TypeIRegistry getTypeIRegistry()
```
    Specified by:
    
    getTypeIRegistry in class AbstractCompiler
  - getTypeRegistry
```
public JSTypeRegistry getTypeRegistry()
```
    Description copied from class: AbstractCompiler
    
    Gets a central registry of type information from the compiled JS.
    
    Specified by:
    
    getTypeRegistry in class AbstractCompiler
  - getTypedScopeCreator
```
public com.google.javascript.jscomp.MemoizedScopeCreator getTypedScopeCreator()
```
    Description copied from class: AbstractCompiler
    
    Gets a memoized scope creator with type information. Only used by jsdev.
  - buildKnownSymbolTable
```
public SymbolTable buildKnownSymbolTable()
```
  - getTopScope
```
public TypedScope getTopScope()
```
    Description copied from class: AbstractCompiler
    
    Gets the top scope.
    
    Specified by:
    
    getTopScope in class AbstractCompiler
  - getReverseAbstractInterpreter
```
public ReverseAbstractInterpreter getReverseAbstractInterpreter()
```
    Description copied from class: AbstractCompiler
    
    Get an interpreter for type analysis.
    
    Specified by:
    
    getReverseAbstractInterpreter in class AbstractCompiler
  - parse
```
public Node parse(SourceFile file)
```
  - newCompilerOptions
```
protected CompilerOptions newCompilerOptions()
```
    Allow subclasses to override the default CompileOptions object.
  - toSource
```
public String toSource()
```
    Converts the main parse tree back to JS code.
    
    Specified by:
    
    toSource in class AbstractCompiler
  - toSourceArray
```
public String[] toSourceArray()
```
    Converts the parse tree for each input back to JS code.
  - toSource
```
public String toSource(JSModule module)
```
    Converts the parse tree for a module back to JS code.
  - toSourceArray
```
public String[] toSourceArray(JSModule module)
```
    Converts the parse tree for each input in a module back to JS code.
  - toSource
```
public void toSource(Compiler.CodeBuilder cb,
                     int inputSeqNum,
                     Node root)
```
    Writes out JS code from a root node. If printing input delimiters, this method will attach a comment to the start of the text indicating which input the output derived from. If there were any preserve annotations within the root's source, they will also be printed in a block comment at the beginning of the output.
  - toSource
```
public String toSource(Node n)
```
    Generates JavaScript source code for an AST, doesn't generate source map info.
    
    Specified by:
    
    toSource in class AbstractCompiler
  - optimize
```
public void optimize()
```
  - normalize
```
public void normalize()
```
  - reportCodeChange
```
public void reportCodeChange()
```
    Description copied from class: AbstractCompiler
    
    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.
    
    Specified by:
    
    reportCodeChange in class AbstractCompiler
  - getCodingConvention
```
public CodingConvention getCodingConvention()
```
    Description copied from class: AbstractCompiler
    
    Gets the current coding convention.
    
    Specified by:
    
    getCodingConvention in class AbstractCompiler
  - createConfig
```
protected Config createConfig(Config.LanguageMode mode)
```
  - getDiagnosticGroups
```
protected DiagnosticGroups getDiagnosticGroups()
```
    The warning classes that are available from the command-line, and are suppressible by the @suppress annotation.
  - report
```
public void report(JSError error)
```
    Description copied from class: AbstractCompiler
    
    Report an error or warning.
    
    Specified by:
    
    report in class AbstractCompiler
  - report
```
public void report(CheckLevel ignoredLevel,
                   JSError error)
```
    Specified by:
    
    report in interface ErrorHandler
    
    Parameters:
    
    ignoredLevel - the reporting level
    
    error - the error to report
  - getErrorLevel
```
public CheckLevel getErrorLevel(JSError error)
```
    Returns:
    
    The error level the given error object will be reported at.
  - getErrorCount
```
public int getErrorCount()
```
    Gets the number of errors.
  - getWarningCount
```
public int getWarningCount()
```
    Gets the number of warnings.
  - hasErrors
```
public boolean hasErrors()
```
    Consults the ErrorManager to see if we've encountered errors that should halt compilation.
    If CompilerOptions.canContinueAfterErrors() is true, this function always returns false without consulting the error manager. The error manager will continue to be told about new errors and warnings, but the compiler will complete compilation of all inputs.
  - getSourceMapping
```
public com.google.debugging.sourcemap.proto.Mapping.OriginalMapping getSourceMapping(String sourceName,
                                                                                     int lineNumber,
                                                                                     int columnNumber)
```
    Description copied from interface: SourceExcerptProvider
    
    If the source file is associated with an inputSourceMap, does a lookup for the original file position based on this source map.
    
    Specified by:
    
    getSourceMapping in interface SourceExcerptProvider
  - getSourceLine
```
public String getSourceLine(String sourceName,
                            int lineNumber)
```
    Description copied from interface: SourceExcerptProvider
    
    Get the line indicated by the line number. This call will return only the specific line.
    
    Specified by:
    
    getSourceLine in interface SourceExcerptProvider
    
    lineNumber - the line number, 1 being the first line of the file
    
    Returns:
    
    the line indicated, or null if it does not exist
  - getSourceRegion
```
public Region getSourceRegion(String sourceName,
                              int lineNumber)
```
    Description copied from interface: SourceExcerptProvider
    
    Get a region around the indicated line number. The exact definition of a region is implementation specific, but it must contain the line indicated by the line number. A region must not start or end by a carriage return.
    
    Specified by:
    
    getSourceRegion in interface SourceExcerptProvider
    
    lineNumber - the line number, 1 being the first line of the file
    
    Returns:
    
    the region around the line number indicated, or null if it does not exist
  - getSourceMap
```
public SourceMap getSourceMap()
```
  - setLoggingLevel
```
public static void setLoggingLevel(Level level)
```
    Sets the logging level for the com.google.javascript.jscomp package.
  - getAstDotGraph
```
public String getAstDotGraph()
                      throws IOException
```
    Gets the DOT graph of the AST generated at the end of compilation.
    
    Throws:
    
    IOException
  - getErrorManager
```
public ErrorManager getErrorManager()
```
    Description copied from class: AbstractCompiler
    
    Gets the error manager.
    
    Specified by:
    
    getErrorManager in class AbstractCompiler
  - getInputsById
```
public Map<InputId,CompilerInput> getInputsById()
```
    Returns an unmodifiable view of the compiler inputs indexed by id.
  - getProgress
```
public double getProgress()
```
    Specified by:
    
    getProgress in class AbstractCompiler
    
    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.
  - replaceScript
```
public void replaceScript(JsAst ast)
```
    Replaces one file in a hot-swap mode. The given JsAst should be made from a new version of a file that already was present in the last compile call. If the file is new, this will silently ignored.
    
    Parameters:
    
    ast - the ast of the file that is being replaced
  - addNewScript
```
public void addNewScript(JsAst ast)
```
    Adds a new Script AST to the compile state. If a script for the same file already exists the script will not be added, instead a call to #replaceScript should be used.
    
    Parameters:
    
    ast - the ast of the new file
  - getReleaseVersion
```
@GwtIncompatible(value="java.util.ResourceBundle")
public static String getReleaseVersion()
```
    Returns the compiler version baked into the jar.
  - getReleaseDate
```
@GwtIncompatible(value="java.util.ResourceBundle")
public static String getReleaseDate()
```
    Returns the compiler date baked into the jar.
  - getComments
```
public List<Comment> getComments(String filename)
```
    Description copied from class: AbstractCompiler
    
    Returns all the comments from the given file.

Class Compiler

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

tracker

OPTIMIZE_LOOP_ERROR

MOTION_ITERATIONS_ERROR

recentChange

Constructor Detail

Compiler

Compiler

Compiler

Method Detail

setErrorManager

initOptions

printConfig

reconcileOptionsWithGuards

init

initModules

joinPathParts

rebuildInputsFromModules

compile

compile

compileModules

disableThreads

setTimeout

parse

setPassConfig

whitespaceOnlyPasses

transpileAndDontCheck

check

getResult

getErrors

getWarnings

getRoot

getInput

removeExternInput

getTypeIRegistry

getTypeRegistry

getTypedScopeCreator

buildKnownSymbolTable

getTopScope

getReverseAbstractInterpreter

parse

newCompilerOptions

toSource

toSourceArray

toSource

toSourceArray

toSource

toSource

optimize

normalize

reportCodeChange

getCodingConvention

createConfig

getDiagnosticGroups

report

report

getErrorLevel

getErrorCount

getWarningCount

hasErrors

getSourceMapping

getSourceLine

getSourceRegion

getSourceMap

setLoggingLevel

getAstDotGraph

getErrorManager

getInputsById

getProgress

replaceScript

addNewScript

getReleaseVersion

getReleaseDate