com.google.javascript.jscomp

Class ExpandJqueryAliases

java.lang.Object

com.google.javascript.jscomp.NodeTraversal.AbstractPostOrderCallback

com.google.javascript.jscomp.ExpandJqueryAliases

All Implemented Interfaces:

CompilerPass, NodeTraversal.Callback

class ExpandJqueryAliases
extends NodeTraversal.AbstractPostOrderCallback
implements CompilerPass

Replace known jQuery aliases and methods with standard conventions so that the compiler recognizes them. Expected replacements include: - jQuery.fn -> jQuery.prototype - jQuery.extend -> expanded into direct object assignments - jQuery.expandedEach -> expand into direct assignments

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	ExpandJqueryAliases.FindCallbackArgumentReferences Given a jQuery.expandedEach callback function, traverse it and collect any references to its parameter names.

Field Summary

Fields

Modifier and Type	Field and Description
private AbstractCompiler	compiler
private CodingConvention	convention
private static java.lang.String	JQUERY_EXPANDED_EACH_NAME
private static java.util.Set<java.lang.String>	JQUERY_EXTEND_NAMES
(package private) static DiagnosticType	JQUERY_UNABLE_TO_EXPAND_INVALID_LIT_ERROR
(package private) static DiagnosticType	JQUERY_UNABLE_TO_EXPAND_INVALID_NAME_ERROR
(package private) static DiagnosticType	JQUERY_USELESS_EACH_EXPANSION
private static java.util.logging.Logger	logger
private PeepholeOptimizationsPass	peepholePasses

Constructor Summary

Constructors

Constructor and Description
ExpandJqueryAliases(AbstractCompiler compiler)

Method Summary

Modifier and Type	Method and Description
private boolean	isArrayLitValidForExpansion(Node n)
boolean	isJqueryExpandedEachCall(Node call, java.lang.String qName)
static boolean	isJqueryExtendCall(Node n, java.lang.String qname, AbstractCompiler compiler) Check that Node n is a call to one of the jQuery.extend methods that we can expand.
private void	maybeExpandJqueryEachCall(NodeTraversal t, Node n) Expand a jQuery.expandedEach call Expanded jQuery.expandedEach calls will replace the GETELEM nodes of a property assignment with GETPROP nodes to allow for renaming.
private void	maybeExpandJqueryExtendCall(Node n) Expand jQuery.extend (and derivative) calls into direct object assignments Example: jQuery.extend(obj1, {prop1: val1, prop2: val2}) -> obj1.prop1 = val1; obj1.prop2 = val2;
private void	maybeReplaceJqueryPrototypeAlias(Node n)
void	process(Node externs, Node root) Process the JS with root node root.
private void	replaceOriginalJqueryEachCall(Node n, Node expandedBlock)
private Node	tryExpandJqueryEachCall(NodeTraversal t, Node n, Node callbackFunction, java.util.List<Node> keyNodes, java.util.List<Node> valueNodes)
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.AbstractPostOrderCallback

shouldTraverse

Methods inherited from class java.lang.Object

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

Field Detail

compiler

private final AbstractCompiler compiler

convention

private final CodingConvention convention

logger

private static final java.util.logging.Logger logger

JQUERY_UNABLE_TO_EXPAND_INVALID_LIT_ERROR

static final DiagnosticType JQUERY_UNABLE_TO_EXPAND_INVALID_LIT_ERROR

JQUERY_UNABLE_TO_EXPAND_INVALID_NAME_ERROR

static final DiagnosticType JQUERY_UNABLE_TO_EXPAND_INVALID_NAME_ERROR

JQUERY_USELESS_EACH_EXPANSION

static final DiagnosticType JQUERY_USELESS_EACH_EXPANSION

JQUERY_EXTEND_NAMES

private static final java.util.Set<java.lang.String> JQUERY_EXTEND_NAMES

JQUERY_EXPANDED_EACH_NAME

private static final java.lang.String JQUERY_EXPANDED_EACH_NAME

See Also:

Constant Field Values

peepholePasses

private final PeepholeOptimizationsPass peepholePasses

Constructor Detail

ExpandJqueryAliases

ExpandJqueryAliases(AbstractCompiler compiler)

Method Detail

isJqueryExtendCall

public static boolean isJqueryExtendCall(Node n,
                                         java.lang.String qname,
                                         AbstractCompiler compiler)

Check that Node n is a call to one of the jQuery.extend methods that we can expand. Valid calls are single argument calls where the first argument is an object literal or two argument calls where the first argument is a name and the second argument is an object literal.

isJqueryExpandedEachCall

public boolean isJqueryExpandedEachCall(Node call,
                                        java.lang.String qName)

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

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

maybeReplaceJqueryPrototypeAlias

private void maybeReplaceJqueryPrototypeAlias(Node n)

maybeExpandJqueryExtendCall

private void maybeExpandJqueryExtendCall(Node n)

Expand jQuery.extend (and derivative) calls into direct object assignments Example: jQuery.extend(obj1, {prop1: val1, prop2: val2}) -> obj1.prop1 = val1; obj1.prop2 = val2;

maybeExpandJqueryEachCall

private void maybeExpandJqueryEachCall(NodeTraversal t,
                                       Node n)

Expand a jQuery.expandedEach call Expanded jQuery.expandedEach calls will replace the GETELEM nodes of a property assignment with GETPROP nodes to allow for renaming.

tryExpandJqueryEachCall

private Node tryExpandJqueryEachCall(NodeTraversal t,
                                     Node n,
                                     Node callbackFunction,
                                     java.util.List<Node> keyNodes,
                                     java.util.List<Node> valueNodes)

replaceOriginalJqueryEachCall

private void replaceOriginalJqueryEachCall(Node n,
                                           Node expandedBlock)

isArrayLitValidForExpansion

private boolean isArrayLitValidForExpansion(Node n)