Package com.google.javascript.jscomp

Class CrossChunkReferenceCollector

java.lang.Object

com.google.javascript.jscomp.CrossChunkReferenceCollector

All Implemented Interfaces:

CompilerPass, NodeTraversal.Callback, NodeTraversal.ScopedCallback

public final class CrossChunkReferenceCollector
extends Object
implements NodeTraversal.ScopedCallback, CompilerPass

Collects global variable references for use by CrossChunkCodeMotion.

Method Summary

Modifier and Type	Method	Description
void	enterScope(NodeTraversal t)	Updates block stack and invokes any additional behavior.
void	exitScope(NodeTraversal t)	Updates block stack and invokes any additional behavior.
void	process(Node root)
void	process(Node externs, Node root)	Convenience method for running this pass over a tree with this class as a callback.
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)	For each node, update the block stack and reference collection as appropriate.

Methods inherited from class java.lang.Object

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

Method Details

process

public void process(Node externs,
 Node root)

Convenience method for running this pass over a tree with this class as a callback.

Specified by:

process in interface CompilerPass

Parameters:

externs - Top of external JS tree

root - Top of JS tree

process

public void process(Node root)

visit

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

For each node, update the block stack and reference collection as appropriate.

Specified by:

visit in interface NodeTraversal.Callback

Parameters:

t - The current traversal.

n - The current node.

parent - The parent of the current node.

enterScope

public void enterScope(NodeTraversal t)

Updates block stack and invokes any additional behavior.

Specified by:

enterScope in interface NodeTraversal.ScopedCallback

exitScope

public void exitScope(NodeTraversal t)

Updates block stack and invokes any additional behavior.

Specified by:

exitScope in interface NodeTraversal.ScopedCallback

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