Add public API generation with cr.makePublic() and handle it in compiler pass

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;
@@ skipping 19 matching lines @@
  */
 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_MAKE_PUBLIC = "cr.makePublic";
 
     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",
@@ skipping 10 matching lines @@
     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}\".");
 
+    static final DiagnosticType CR_MAKE_PUBLIC_HAS_NO_JSDOC =
+            DiagnosticType.error("JSC_CR_MAKE_PUBLIC_HAS_NO_JSDOC",
+                    "Private method exported by cr.makePublic() has no JSDoc.");
+
+    static final DiagnosticType CR_MAKE_PUBLIC_MISSED_DECLARATION =
+            DiagnosticType.error("JSC_CR_MAKE_PUBLIC_MISSED_DECLARATION",
+                    "Method \"{1}_\" exported by cr.makePublic() on \"{0}\" has no declaration.");
+
+    static final DiagnosticType CR_MAKE_PUBLIC_INVALID_SECOND_ARGUMENT =
+            DiagnosticType.error("JSC_CR_MAKE_PUBLIC_INVALID_SECOND_ARGUMENT",
+                    "Invalid second argument passed to cr.makePublic(): should be array of " +
+                    "strings.");
+
     public ChromePass(AbstractCompiler compiler) {
         this.compiler = compiler;
         // The global variable "cr" is declared in ui/webui/resources/js/cr.js.
         this.createdObjects = new HashSet<>(Arrays.asList("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();
+            } else if (callee.matchesQualifiedName(CR_MAKE_PUBLIC)) {
+                if (visitMakePublic(node, parent)) {
+                    compiler.reportCodeChange();
+                }
             }
         }
     }
 
     private void visitPropertyDefinition(Node call, Node parent) {
         Node callee = call.getFirstChild();
         String target = call.getChildAtIndex(1).getQualifiedName();
         if (callee.matchesQualifiedName(CR_DEFINE_PROPERTY) && !target.endsWith(".prototype")) {
             target += ".prototype";
         }
@@ skipping 28 matching lines @@
                 propertyKind.getQualifiedName()));
         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 boolean visitMakePublic(Node call, Node exprResult) {
+        boolean changesMade = false;
+        Node scope = exprResult.getParent();
+        String className = call.getChildAtIndex(1).getQualifiedName();
+        String prototype = className  + ".prototype";
+        Node publicAPI = call.getChildAtIndex(2);

[Dan Beam, 2014/09/10 19:26:27]

methods

[Vitaly Pavlenko, 2014/09/10 20:25:21]

Done.

+
+        if (publicAPI == null || !publicAPI.isArrayLit()) {
+            compiler.report(JSError.make(exprResult, CR_MAKE_PUBLIC_INVALID_SECOND_ARGUMENT));
+            return changesMade;
+        }
+
+        Set<String> publicAPIStrings = new HashSet<>();

[Dan Beam, 2014/09/10 19:26:27]

methodNames

[Vitaly Pavlenko, 2014/09/10 20:25:21]

Done.

+        for (Node methodName: publicAPI.children()) {
+            if (!methodName.isString()) {
+                compiler.report(JSError.make(methodName, CR_MAKE_PUBLIC_INVALID_SECOND_ARGUMENT));
+                return changesMade;
+            }
+            publicAPIStrings.add(methodName.getString());
+        }
+
+        for (Node child: scope.children()) {
+            if (isAssignmentToPrototype(child, prototype)) {
+                Node objectLit = child.getFirstChild().getChildAtIndex(1);
+                for (Node stringKey : objectLit.children()) {
+                    String field = stringKey.getString();
+                    changesMade |= maybeAddPublicDeclaration(field, publicAPIStrings, className,
+                                                             stringKey, scope, exprResult);
+                }
+            } else if (isAssignmentToPrototypeMethod(child, prototype)) {
+                Node assignNode = child.getFirstChild();
+                String qualifiedName = assignNode.getFirstChild().getQualifiedName();
+                String field = qualifiedName.substring(qualifiedName.lastIndexOf('.') + 1);
+                changesMade |= maybeAddPublicDeclaration(field, publicAPIStrings, className,
+                                                         assignNode, scope, exprResult);
+            } else if (isDummyPrototypeMethodDeclaration(child, prototype)) {
+                String qualifiedName = child.getFirstChild().getQualifiedName();
+                String field = qualifiedName.substring(qualifiedName.lastIndexOf('.') + 1);
+                changesMade |= maybeAddPublicDeclaration(field, publicAPIStrings, className,
+                                                         child.getFirstChild(), scope, exprResult);
+            }
+        }
+
+        for (String missedDeclaration : publicAPIStrings) {
+            compiler.report(JSError.make(exprResult, CR_MAKE_PUBLIC_MISSED_DECLARATION, className,
+                    missedDeclaration));
+        }
+
+        return changesMade;
+    }
+
+    private boolean isAssignmentToPrototype(Node node, String prototype) {
+        Node assignNode;
+        return node.isExprResult() && (assignNode = node.getFirstChild()).isAssign() &&
+                assignNode.getFirstChild().getQualifiedName().equals(prototype);
+    }
+
+    private boolean isAssignmentToPrototypeMethod(Node node, String prototype) {
+        Node assignNode;
+        return node.isExprResult() && (assignNode = node.getFirstChild()).isAssign() &&
+                assignNode.getFirstChild().getQualifiedName().startsWith(prototype + ".");
+    }
+
+    private boolean isDummyPrototypeMethodDeclaration(Node node, String prototype) {
+        Node getPropNode;
+        return node.isExprResult() && (getPropNode = node.getFirstChild()).isGetProp() &&
+                getPropNode.getQualifiedName().startsWith(prototype + ".");
+    }
+
+    private boolean maybeAddPublicDeclaration(String field, Set<String> publicAPIStrings,
+            String className, Node jsDocSourceNode, Node scope, Node exprResult) {
+        boolean changesMade = false;
+        if (field.endsWith("_")) {
+            String publicName = field.substring(0, field.length() - 1);
+            if (publicAPIStrings.contains(publicName)) {
+                Node methodDeclaration = NodeUtil.newQualifiedNameNode(
+                        compiler.getCodingConvention(), className + "." + publicName);
+                if (jsDocSourceNode.getJSDocInfo() != null) {
+                    methodDeclaration.setJSDocInfo(jsDocSourceNode.getJSDocInfo());
+                    scope.addChildBefore(
+                            IR.exprResult(methodDeclaration).srcrefTree(exprResult),
+                            exprResult);
+                    changesMade = true;
+                } else {
+                    compiler.report(JSError.make(jsDocSourceNode, CR_MAKE_PUBLIC_HAS_NO_JSDOC));
+                }
+                publicAPIStrings.remove(publicName);
+            }
+        }
+        return changesMade;
+    }
+
     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());
     }
@@ skipping 182 matching lines @@
                 }
             }
         }
 
         private Node buildQualifiedName(Node internalName) {
             String externalName = this.exports.get(internalName.getString());
             return NodeUtil.newQualifiedNameNode(compiler.getCodingConvention(),
                     this.namespaceName + "." + externalName).srcrefTree(internalName);
         }
     }
-
 }