Package com.google.javascript.jscomp

Class ExtraRequireRemover

java.lang.Object

com.google.javascript.jscomp.ExtraRequireRemover

All Implemented Interfaces:

CompilerPass, NodeTraversal.Callback

public final class ExtraRequireRemover
extends Object
implements CompilerPass, NodeTraversal.Callback

Walks the AST looking for usages of qualified names, and 'goog.require's of those names. Then, reconciles the two lists, and removes any unnecessary require statements.

Constructor Summary

Constructors

Constructor	Description
ExtraRequireRemover(AbstractCompiler compiler)

Method Summary

Modifier and Type	Method	Description
void	process(Node externs, Node root)	Process the JS with root node root.
boolean	shouldTraverse(NodeTraversal t, Node n, Node parent)	Visits a node in preorder (before its children) and decides whether the node and its children should be traversed.
void	visit(NodeTraversal t, Node n, Node parent)	Visits each corresponding node and tracks all goog.requires as well as their usages

Methods inherited from class java.lang.Object

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

Constructor Details

ExtraRequireRemover

public ExtraRequireRemover(AbstractCompiler compiler)

Method Details

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

shouldTraverse

public boolean shouldTraverse(NodeTraversal t,
 Node n,
 Node parent)

Description copied from interface: NodeTraversal.Callback

Visits a node in preorder (before its children) and decides whether the node and its children should be traversed.

If this method returns true, the node will be visited by NodeTraversal.Callback.visit(NodeTraversal, Node, Node) in postorder and its children will be visited by both NodeTraversal.Callback.shouldTraverse(NodeTraversal, Node, Node) in preorder and by NodeTraversal.Callback.visit(NodeTraversal, Node, Node) in postorder.

If this method returns false, the node will not be visited by NodeTraversal.Callback.visit(NodeTraversal, Node, Node) and its children will neither be visited by NodeTraversal.Callback.shouldTraverse(NodeTraversal, Node, Node) nor NodeTraversal.Callback.visit(NodeTraversal, Node, Node).

Siblings are always visited left-to-right.

Implementations can have side-effects (e.g. modify the parse tree). Removing the current node is legal, but removing or reordering nodes above the current node may cause nodes to be visited twice or not at all.

Specified by:

shouldTraverse in interface NodeTraversal.Callback

Parameters:

t - The current traversal.

n - The current node.

parent - The parent of the current node.

Returns:

whether the children of this node should be visited

visit

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

Visits each corresponding node and tracks all goog.requires as well as their usages

Specified by:

visit in interface NodeTraversal.Callback

Parameters:

t - The current traversal.

n - The current node.

parent - The parent of the current node.