DevTools: [JsDocValidator] Handle types declared as top-level vars

This patch allows the validator checks to handle types declared as
/** @constructor */ var MyType = function() {}

R=pfeldman, sergeyv

Review URL: https://codereview.chromium.org/218993012

git-svn-id: svn://svn.chromium.org/blink/trunk@170555 bbb929c8-8fbe-4397-9dbb-9b2b20218538

third_party/WebKit/Source/devtools/scripts/jsdoc-validator/hashes

-897c41ac961d3b29241cbc669a7b8de9bab29576011ba14d5221074236ef6eaf src
-c2d110cf773c37260c650b98086345d5a5796baec0552758d84d403c86306edb jsdoc-validator.jar
+2ab8423657e11313213f1650bc22a361b67ef9e17eb532c4c3ec3b1041a22654 src
+c763ce82987ebe06894c8b99bbc5db0ce7cd6e4882b6fddf2ced12051d61eaa6 jsdoc-validator.jar

third_party/WebKit/Source/devtools/scripts/jsdoc-validator/src/org/chromium/devtools/jsdoc/checks/AstUtil.java

@@ -6,17 +6,15 @@ import com.google.javascript.rhino.head.ast.AstNode;
 import com.google.javascript.rhino.head.ast.Comment;
 import com.google.javascript.rhino.head.ast.FunctionNode;
 import com.google.javascript.rhino.head.ast.ObjectProperty;
+import com.google.javascript.rhino.head.ast.VariableInitializer;
 
 public class AstUtil {
 
     private static final String PROTOTYPE_SUFFIX = ".prototype";
 
-    static boolean hasParentOfType(AstNode node, int tokenType) {
+    static AstNode parentOfType(AstNode node, int tokenType) {
         AstNode parent = node.getParent();
-        if (parent == null) {
-            return false;
-        }
-        return parent.getType() == tokenType;
+        return (parent == null || parent.getType() != tokenType) ? null : parent;
     }
 
     static AstNode getFunctionNameNode(FunctionNode functionNode) {
@@ -25,16 +23,24 @@ public class AstUtil {
             return nameNode;
         }
 
-        if (AstUtil.hasParentOfType(functionNode, Token.COLON)) {
-            return ((ObjectProperty) functionNode.getParent()).getLeft();
+        AstNode parentNode = functionNode.getParent();
+        if (parentNode == null) {
+            return null;
         }
 
-        if (AstUtil.hasParentOfType(functionNode, Token.ASSIGN)) {
-            Assignment assignment = (Assignment) functionNode.getParent();
+        switch (parentNode.getType()) {
+        case Token.COLON:
+            return ((ObjectProperty) parentNode).getLeft();
+        case Token.ASSIGN:
+            Assignment assignment = (Assignment) parentNode;
             if (assignment.getRight() == functionNode) {
                 return assignment.getLeft();
             }
+            break;
+        case Token.VAR:
+            return ((VariableInitializer) parentNode).getTarget();
         }
+
         return null;
     }
 
@@ -69,22 +75,24 @@ public class AstUtil {
         }
 
         // reader.onloadend = function() {...}
-        if (hasParentOfType(functionNode, Token.ASSIGN)) {
-            Assignment assignment = (Assignment) functionNode.getParent();
-            if (assignment.getRight() == functionNode) {
-                jsDocNode = assignment.getJsDocNode();
-                if (jsDocNode != null) {
-                    return jsDocNode;
-                }
-            }
+        AstNode parentNode = functionNode.getParent();
+        if (parentNode == null) {
+            return null;
         }
 
-        if (hasParentOfType(functionNode, Token.COLON)) {
-            jsDocNode = ((ObjectProperty) functionNode.getParent()).getLeft().getJsDocNode();
-            if (jsDocNode != null) {
-                return jsDocNode;
+        switch (parentNode.getType()) {
+        case Token.COLON:
+            return ((ObjectProperty) parentNode).getLeft().getJsDocNode();
+        case Token.ASSIGN:
+            Assignment assignment = (Assignment) parentNode;
+            if (assignment.getRight() == functionNode) {
+                return assignment.getJsDocNode();
             }
+            break;
+        case Token.VAR:
+            return parentNode.getParent().getJsDocNode();
         }
+
         return null;
     }
 

third_party/WebKit/Source/devtools/scripts/jsdoc-validator/src/org/chromium/devtools/jsdoc/checks/ContextTrackingValidationCheck.java

@@ -195,7 +195,9 @@ public class ContextTrackingValidationCheck extends ValidationCheck {
         List<InheritanceEntry> result = new ArrayList<>(2);
         Matcher matcher = EXTENDS_PATTERN.matcher(getNodeText(jsDocNode));
         while (matcher.find()) {
-            result.add(new InheritanceEntry(matcher.group(1), jsDocNode, matcher.start(1)));
+            String fullSuperType = matcher.group(1);
+            result.add(new InheritanceEntry(
+                    fullSuperType.replaceFirst("\\.<.+>", ""), jsDocNode, matcher.start(1)));
         }
 
         return result;

third_party/WebKit/Source/devtools/scripts/jsdoc-validator/src/org/chromium/devtools/jsdoc/checks/ReturnAnnotationChecker.java

@@ -30,7 +30,7 @@ public final class ReturnAnnotationChecker extends ContextTrackingChecker {
     }
 
     private void handleReturn(ReturnStatement node) {
-        if (node.getReturnValue() == null || AstUtil.hasParentOfType(node, Token.ASSIGN)) {
+        if (node.getReturnValue() == null || AstUtil.parentOfType(node, Token.ASSIGN) != null) {
             return;
         }
 
@@ -137,8 +137,9 @@ public final class ReturnAnnotationChecker extends ContextTrackingChecker {
             return nameNode;
         }
 
-        if (AstUtil.hasParentOfType(functionNode, Token.COLON)) {
-            return ((ObjectProperty) functionNode.getParent()).getLeft();
+        ObjectProperty parent = (ObjectProperty) AstUtil.parentOfType(functionNode, Token.COLON);
+        if (parent != null) {
+            return parent.getLeft();
         }
         // Do not require annotation for assignment-RHS functions.
         return null;

third_party/WebKit/Source/devtools/scripts/jsdoc-validator/tests/golden.dat

@@ -50,6 +50,14 @@ DerivedNoSuperCall = function() {
 DerivedBadSuperCall = function() {
 ^
 
+/usr/local/google/home/apavlov/dev/blink/src/third_party/WebKit/Source/devtools/scripts/jsdoc-validator/tests/proto.js:121: ERROR - No __proto__ assigned for type BadSetSubclass having @extends
+ * @extends {Set.<T>}
+             ^
+
+/usr/local/google/home/apavlov/dev/blink/src/third_party/WebKit/Source/devtools/scripts/jsdoc-validator/tests/proto.js:124: ERROR - Type BadSetSubclass extends Set but does not properly invoke its constructor
+var BadSetSubclass = function()
+    ^
+
 /usr/local/google/home/apavlov/dev/blink/src/third_party/WebKit/Source/devtools/scripts/jsdoc-validator/tests/return.js:1: ERROR - @return annotation is required for API functions that return value
 function badFuncNoAnnotation() {
          ^
@@ -278,4 +286,4 @@ function badFuncAnnotatedButNoReturnValue() // ERROR - no returned value.
         function callbackNotReferencingThisAnnotated()
                  ^
 
-Total errors: 70
+Total errors: 72

third_party/WebKit/Source/devtools/scripts/jsdoc-validator/tests/proto.js

@@ -88,3 +88,42 @@ GoodDerived = function() {
 GoodDerived.prototype = {
     __proto__: Base.prototype
 }
+
+/**
+ * @constructor
+ * @template T
+ */
+var Set = function() {}
+
+Set.prototype = {
+    add: function(item) {},
+    remove: function(item) {},
+    /** @return {boolean} */
+    contains: function(item) { return true; }
+}
+
+/**
+ * @constructor
+ * @extends {Set.<T>}
+ * @template T
+ */
+var GoodSetSubclass = function()
+{
+    Set.call(this);
+}
+
+GoodSetSubclass.prototype = {
+    __proto__: Set.prototype
+}
+
+/**
+ * @constructor
+ * @extends {Set.<T>}
+ * @template T
+ */
+var BadSetSubclass = function()
+{
+}
+
+BadSetSubclass.prototype = {
+}