com.google.javascript.jscomp

Class ClosureCheckModule

java.lang.Object

com.google.javascript.jscomp.NodeTraversal.AbstractModuleCallback

com.google.javascript.jscomp.ClosureCheckModule

All Implemented Interfaces:

CompilerPass, HotSwapCompilerPass, NodeTraversal.Callback, NodeTraversal.ScopedCallback

public final class ClosureCheckModule
extends NodeTraversal.AbstractModuleCallback
implements HotSwapCompilerPass

Checks that goog.module() is used correctly.

Note that this file only does checks that can be done per-file. Whole program checks happen during goog.module rewriting, in ClosureRewriteModule.

Field Summary

Fields

Modifier and Type	Field and Description
static DiagnosticType	JSDOC_REFERENCE_TO_SHORT_IMPORT_BY_LONG_NAME_INCLUDING_SHORT_NAME
static DiagnosticType	REFERENCE_TO_SHORT_IMPORT_BY_LONG_NAME_INCLUDING_SHORT_NAME

Constructor Summary

Constructors

Constructor and Description
ClosureCheckModule(AbstractCompiler compiler)

Method Summary

Modifier and Type	Method and Description
void	enterModule(NodeTraversal t, Node scopeRoot) Called immediately after entering a module.
void	exitModule(NodeTraversal t, Node scopeRoot) Called immediately before exiting a module.
void	hotSwapScript(Node scriptRoot, Node originalRoot) Process the JS with root node root.
void	process(Node externs, Node root) Process the JS with root node root.
void	visit(NodeTraversal t, Node n, Node parent) Visits a node in postorder (after its children have been visited).

Methods inherited from class com.google.javascript.jscomp.NodeTraversal.AbstractModuleCallback

enterScope, exitScope, shouldTraverse

Methods inherited from class java.lang.Object

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

Field Detail

REFERENCE_TO_SHORT_IMPORT_BY_LONG_NAME_INCLUDING_SHORT_NAME

public static final DiagnosticType REFERENCE_TO_SHORT_IMPORT_BY_LONG_NAME_INCLUDING_SHORT_NAME

JSDOC_REFERENCE_TO_SHORT_IMPORT_BY_LONG_NAME_INCLUDING_SHORT_NAME

public static final DiagnosticType JSDOC_REFERENCE_TO_SHORT_IMPORT_BY_LONG_NAME_INCLUDING_SHORT_NAME

Constructor Detail

ClosureCheckModule

public ClosureCheckModule(AbstractCompiler compiler)

Method Detail

process

public void process(Node externs,
                    Node root)

Description copied from interface: CompilerPass

Process the JS with root node root. Can modify the contents of each Node tree

Specified by:

process in interface CompilerPass

Parameters:

externs - Top of external JS tree

root - Top of JS tree

hotSwapScript

public void hotSwapScript(Node scriptRoot,
                          Node originalRoot)

Description copied from interface: HotSwapCompilerPass

Process the JS with root node root. This is supposed to be significantly faster compared to corresponding full-compiler passes.

Specified by:

hotSwapScript in interface HotSwapCompilerPass

Parameters:

scriptRoot - Root node corresponding to the file that is modified, should be of type Token.SCRIPT.

originalRoot - Root node corresponding to the original version of the file that is modified. Should be of type token.SCRIPT.

enterModule

public void enterModule(NodeTraversal t,
                        Node scopeRoot)

Description copied from class: NodeTraversal.AbstractModuleCallback

Called immediately after entering a module.

Specified by:

enterModule in class NodeTraversal.AbstractModuleCallback

exitModule

public void exitModule(NodeTraversal t,
                       Node scopeRoot)

Description copied from class: NodeTraversal.AbstractModuleCallback

Called immediately before exiting a module.

Specified by:

exitModule in class NodeTraversal.AbstractModuleCallback

visit

public void visit(NodeTraversal t,
                  Node n,
                  Node parent)

Description copied from interface: NodeTraversal.Callback

Visits a node in postorder (after its children have been visited). A node is visited only if all its parents should be traversed (NodeTraversal.Callback.shouldTraverse(NodeTraversal, Node, Node)).

Implementations can have side effects (e.g. modifying the parse tree).

Specified by:

visit in interface NodeTraversal.Callback