Handle cr.exportPath() in compiler pass, declare every object only once

third_party/closure_compiler/runner/src/com/google/javascript/jscomp/ChromePass.java

 // Copyright 2014 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 package com.google.javascript.jscomp;
 
 import com.google.javascript.jscomp.NodeTraversal.AbstractPostOrderCallback;
 import com.google.javascript.rhino.IR;
 import com.google.javascript.rhino.JSDocInfoBuilder;
 import com.google.javascript.rhino.JSTypeExpression;
 import com.google.javascript.rhino.Node;
 import com.google.javascript.rhino.Token;
 
 import java.util.ArrayList;
 import java.util.HashMap;
+import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
+import java.util.Set;
 
 /**
  * Compiler pass for Chrome-specific needs. It handles the following Chrome JS features:
  * <ul>
  * <li>namespace declaration using {@code cr.define()},
  * <li>unquoted property declaration using {@code {cr|Object}.defineProperty()}.
  * </ul>
  *
  * <p>For the details, see tests inside ChromePassTest.java.
  */
 public class ChromePass extends AbstractPostOrderCallback implements CompilerPass {
     final AbstractCompiler compiler;
 
+    private Set<String> createdObjects;
+
     private static final String CR_DEFINE = "cr.define";
-
+    private static final String CR_EXPORT_PATH = "cr.exportPath";
     private static final String OBJECT_DEFINE_PROPERTY = "Object.defineProperty";
-
     private static final String CR_DEFINE_PROPERTY = "cr.defineProperty";
 
     private static final String CR_DEFINE_COMMON_EXPLANATION = "It should be called like this: " +
             "cr.define('name.space', function() '{ ... return {Export: Internal}; }');";
 
     static final DiagnosticType CR_DEFINE_WRONG_NUMBER_OF_ARGUMENTS =
             DiagnosticType.error("JSC_CR_DEFINE_WRONG_NUMBER_OF_ARGUMENTS",
                     "cr.define() should have exactly 2 arguments. " + CR_DEFINE_COMMON_EXPLANATION);
 
+    static final DiagnosticType CR_EXPORT_PATH_WRONG_NUMBER_OF_ARGUMENTS =
+            DiagnosticType.error("JSC_CR_EXPORT_PATH_WRONG_NUMBER_OF_ARGUMENTS",
+                    "cr.exportPath() should have exactly 1 argument: namespace name.");
+
     static final DiagnosticType CR_DEFINE_INVALID_FIRST_ARGUMENT =
             DiagnosticType.error("JSC_CR_DEFINE_INVALID_FIRST_ARGUMENT",
                     "Invalid first argument for cr.define(). " + CR_DEFINE_COMMON_EXPLANATION);
 
     static final DiagnosticType CR_DEFINE_INVALID_SECOND_ARGUMENT =
             DiagnosticType.error("JSC_CR_DEFINE_INVALID_SECOND_ARGUMENT",
                     "Invalid second argument for cr.define(). " + CR_DEFINE_COMMON_EXPLANATION);
 
     static final DiagnosticType CR_DEFINE_INVALID_RETURN_IN_FUNCTION =
             DiagnosticType.error("JSC_CR_DEFINE_INVALID_RETURN_IN_SECOND_ARGUMENT",
                     "Function passed as second argument of cr.define() should return the " +
                     "dictionary in its last statement. " + CR_DEFINE_COMMON_EXPLANATION);
 
     static final DiagnosticType CR_DEFINE_PROPERTY_INVALID_PROPERTY_KIND =
             DiagnosticType.error("JSC_CR_DEFINE_PROPERTY_INVALID_PROPERTY_KIND",
                     "Invalid cr.PropertyKind passed to cr.defineProperty(): expected ATTR, " +
                     "BOOL_ATTR or JS, found \"{0}\".");
 
     public ChromePass(AbstractCompiler compiler) {
         this.compiler = compiler;
+        this.createdObjects = new HashSet<>();

[Dan Beam, 2014/08/14 02:23:02]

nit: this.createdObjects = new HashSet<>(Arrays.asList("cr"));

[Vitaly Pavlenko, 2014/08/14 02:40:59]

Done.

+        // This variable is declared in ui/webui/resources/js/cr.js

[Dan Beam, 2014/08/14 02:23:01]

nit: end with .

[Vitaly Pavlenko, 2014/08/14 02:40:59]

Done.

+        createdObjects.add("cr");
     }
 
     @Override
     public void process(Node externs, Node root) {
         NodeTraversal.traverse(compiler, root, this);
     }
 
     @Override
     public void visit(NodeTraversal t, Node node, Node parent) {
         if (node.isCall()) {
             Node callee = node.getFirstChild();
             if (callee.matchesQualifiedName(CR_DEFINE)) {
                 visitNamespaceDefinition(node, parent);
                 compiler.reportCodeChange();
+            } else if (callee.matchesQualifiedName(CR_EXPORT_PATH)) {
+                visitExportPath(node, parent);
+                compiler.reportCodeChange();
             } else if (callee.matchesQualifiedName(OBJECT_DEFINE_PROPERTY) ||
                     callee.matchesQualifiedName(CR_DEFINE_PROPERTY)) {
                 visitPropertyDefinition(node, parent);
                 compiler.reportCodeChange();
             }
         }
     }
 
     private void visitPropertyDefinition(Node call, Node parent) {
         Node callee = call.getFirstChild();
@@ skipping 27 matching lines @@
             return null;
         }
     }
 
     private void setJsDocWithType(Node target, Node type) {
         JSDocInfoBuilder builder = new JSDocInfoBuilder(false);
         builder.recordType(new JSTypeExpression(type, ""));
         target.setJSDocInfo(builder.build(target));
     }
 
+    private void visitExportPath(Node crExportPathNode, Node parent) {
+        if (crExportPathNode.getChildCount() != 2) {
+            compiler.report(JSError.make(crExportPathNode,
+                    CR_EXPORT_PATH_WRONG_NUMBER_OF_ARGUMENTS));
+            return;
+        }
+
+        createAndInsertObjectsForQualifiedName(parent,
+                crExportPathNode.getChildAtIndex(1).getString());
+    }
+
+    private void createAndInsertObjectsForQualifiedName(Node scriptChild, String namespace) {
+        List<Node> objectsForQualifiedName = createObjectsForQualifiedName(namespace);
+        for (Node n : objectsForQualifiedName) {
+            scriptChild.getParent().addChildBefore(n, scriptChild);
+        }
+    }
+
     private void visitNamespaceDefinition(Node crDefineCallNode, Node parent) {
         if (crDefineCallNode.getChildCount() != 3) {
             compiler.report(JSError.make(crDefineCallNode, CR_DEFINE_WRONG_NUMBER_OF_ARGUMENTS));
         }
 
         Node namespaceArg = crDefineCallNode.getChildAtIndex(1);
         Node function = crDefineCallNode.getChildAtIndex(2);
 
         if (!namespaceArg.isString()) {
             compiler.report(JSError.make(namespaceArg, CR_DEFINE_INVALID_FIRST_ARGUMENT));
             return;
         }
 
         // TODO(vitalyp): Check namespace name for validity here. It should be a valid chain of
         // identifiers.
         String namespace = namespaceArg.getString();
 
-        List<Node> objectsForQualifiedName = createObjectsForQualifiedName(namespace);
-        for (Node n : objectsForQualifiedName) {
-            parent.getParent().addChildBefore(n, parent);
-        }
+        createAndInsertObjectsForQualifiedName(parent, namespace);
 
         Node returnNode, functionBlock, objectLit;
         if (!function.isFunction()) {
             compiler.report(JSError.make(namespaceArg, CR_DEFINE_INVALID_SECOND_ARGUMENT));
             return;
         }
 
         if ((functionBlock = function.getLastChild()) == null ||
                 (returnNode = functionBlock.getLastChild()) == null ||
                 !returnNode.isReturn() ||
@@ skipping 30 matching lines @@
      *
      * <p><pre>
      * var a = a || {};
      * a.b = a.b || {};
      * a.b.c = a.b.c || {};</pre>
      */
     private List<Node> createObjectsForQualifiedName(String namespace) {
         List<Node> objects = new ArrayList<>();
         String[] parts = namespace.split("\\.");
 
-        objects.add(createJsNode("var " + parts[0] + " = " + parts[0] + " || {};"));
+        createObjectIfNew(objects, parts[0], true);
 
         if (parts.length >= 2) {
             StringBuilder currPrefix = new StringBuilder().append(parts[0]);
             for (int i = 1; i < parts.length; ++i) {
                 currPrefix.append(".").append(parts[i]);
-                String code = currPrefix + " = " + currPrefix + " || {};";
-                objects.add(createJsNode(code));
+                createObjectIfNew(objects, currPrefix.toString(), false);
             }
         }
 
         return objects;
     }
 
+    private void createObjectIfNew(List<Node> objects, String name, boolean needVar) {
+        if (!createdObjects.contains(name)) {
+            objects.add(createJsNode((needVar ? "var " : "") + name + " = " + name + " || {};"));
+            createdObjects.add(name);
+        }
+    }
+
     private Node createJsNode(String code) {
         // The parent node after parseSyntheticCode() is SCRIPT node, we need to get rid of it.
         return compiler.parseSyntheticCode(code).removeFirstChild();
     }
 
     private class RenameInternalsToExternalsCallback extends AbstractPostOrderCallback {
         final private String namespaceName;
         final private Map<String, String> exports;
         final private Node namespaceBlock;
 
@@ skipping 76 matching lines @@
         }
 
         private Node buildQualifiedName(Node internalName) {
             String externalName = this.exports.get(internalName.getString());
             return NodeUtil.newQualifiedNameNode(compiler.getCodingConvention(),
                     this.namespaceName + "." + externalName).srcrefTree(internalName);
         }
     }
 
 }