Package com.google.javascript.jscomp

Class Es6RenameVariablesInParamLists

java.lang.Object

com.google.javascript.jscomp.Es6RenameVariablesInParamLists

All Implemented Interfaces:

CompilerPass, NodeTraversal.Callback, NodeTraversal.ScopedCallback

public final class Es6RenameVariablesInParamLists
extends java.lang.Object
implements NodeTraversal.ScopedCallback, CompilerPass

Renames variables declared in function bodies so they don't shadow any variable referenced in the param list.

This transformation prevents name collisions when executable code from the param list is moved into the function body.

Constructor Summary

Constructors

Constructor	Description
Es6RenameVariablesInParamLists(AbstractCompiler compiler)

Method Summary

Modifier and Type	Method	Description
void	enterScope(NodeTraversal t)	Called immediately after entering a new scope.
void	exitScope(NodeTraversal t)	Called immediately before exiting a scope.
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 its children should be traversed.
void	visit(NodeTraversal t, Node block, Node function)	Visits a node in postorder (after its children).

Methods inherited from class java.lang.Object

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

Constructor Detail

Es6RenameVariablesInParamLists

public Es6RenameVariablesInParamLists(AbstractCompiler compiler)

Method Detail

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 its children should be traversed. If the children should be traversed, they will be visited by NodeTraversal.Callback.shouldTraverse(NodeTraversal, Node, Node) in preorder and by NodeTraversal.Callback.visit(NodeTraversal, Node, Node) in postorder.

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

enterScope

public void enterScope(NodeTraversal t)

Description copied from interface: NodeTraversal.ScopedCallback

Called immediately after entering a new scope. The new scope can be accessed through t.getScope()

Specified by:

enterScope in interface NodeTraversal.ScopedCallback

exitScope

public void exitScope(NodeTraversal t)

Description copied from interface: NodeTraversal.ScopedCallback

Called immediately before exiting a scope. The ending scope can be accessed through t.getScope()

Specified by:

exitScope in interface NodeTraversal.ScopedCallback

visit

public void visit(NodeTraversal t,
                  Node block,
                  Node function)

Description copied from interface: NodeTraversal.Callback

Visits a node in postorder (after its children). A node is visited in postorder iff NodeTraversal.Callback.shouldTraverse(NodeTraversal, Node, Node) returned true for its parent. In particular, the root node is never visited in postorder.

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:

visit in interface NodeTraversal.Callback

Parameters:

t - The current traversal.

block - The current node.

function - The parent of the current node.

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