Issue 3752. Support for @override annotations (as structured doc comments)

compiler/javatests/com/google/dart/compiler/parser/CommentTest.java

 // Copyright (c) 2011, the Dart project authors.  Please see the AUTHORS file

[Brian Wilkerson, 2012/06/25 14:24:38]

nit: copyright year

[scheglov, 2012/06/26 19:46:34]

Done.

 // for details. 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.dart.compiler.parser;
 
+import com.google.common.collect.Lists;
 import com.google.dart.compiler.CompilerTestCase;
 import com.google.dart.compiler.DartCompilerListener;
 import com.google.dart.compiler.Source;
+import com.google.dart.compiler.ast.DartComment;
 import com.google.dart.compiler.ast.DartDeclaration;
 import com.google.dart.compiler.ast.DartNode;
 import com.google.dart.compiler.ast.DartUnit;
+import com.google.dart.compiler.common.SourceInfo;
 
-import java.util.ArrayList;
 import java.util.List;
 
 /**
  * Tests to ensure the scanner is correctly recording comments, as defined
  * in the javadoc for <code>DartScanner.recordCommentLocation().</code>
  */
 public class CommentTest extends CompilerTestCase {
-
-  /**
-   * A parser context that uses its own scanner.
-   */
-  class CommentParserContext extends DartScannerParserContext {
-
-    CommentParserContext(Source source, String sourceCode,
-        DartCompilerListener listener) {
-      super(source, sourceCode, listener);
-    }
-
-    @Override
-    protected DartScanner createScanner(String sourceCode) {
-      return new CommentScanner(sourceCode);
-    }
-  }
-
-  /**
-   * A specialized scanner that records comment locations. It would have been
-   * more natural to use the parser context to record comments, but the
-   * scanner doesn't know about the context.
-   */
-  class CommentScanner extends DartScanner {
-
-    CommentScanner(String sourceCode) {
-      super(sourceCode);
-    }
-
-    @Override
-    protected void recordCommentLocation(int start, int stop, int line, int col) {
-      int size = commentLocs.size();
-      if (size > 0) {
-        // check for duplicates
-        int[] loc = commentLocs.get(size - 1);
-        // use <= to allow parser to back up more than one token
-        if (start <= loc[0] && stop <= loc[1]) {
-          return;
-        }
-      }
-      commentLocs.add(new int[]{start, stop});
-    }
-  }
-
-  private List<int[]> commentLocs = new ArrayList<int[]>();
   private String source;
 
   private static String[] EXPECTED001 = {"/*\n * Beginning comment\n */",
     "// line comment", "// another", "/**/", "//", "/*/*nested*/*/",
   };
   private static String[] EXPECTED002 = {"/*\n*\n //comment\nX Y"};
 
   public void test001() {
-    parseUnit("Comments.dart");
-    compareComments(EXPECTED001);
+    DartUnit unit = parseUnit("Comments.dart");
+    compareComments(unit, EXPECTED001);
   }
 
   public void test002() {
-    parseUnitErrors("BadCommentNegativeTest.dart",
+    DartUnit unit = parseUnitErrors("BadCommentNegativeTest.dart",
                     "Unexpected token 'ILLEGAL' (expected end of file)", 1, 1);
-    compareComments(EXPECTED002);
+    compareComments(unit, EXPECTED002);
   }
 
   public void test003() {
     DartUnit unit = parseUnit("Comments2.dart");
     assertDeclComments(unit, "firstMethod", "/** Comments are good. */");
     assertDeclComments(unit, "secondMethod", null);
   }
   
   @Override
-  protected ParserContext makeParserContext(Source src, String sourceCode,
-      DartCompilerListener listener) {
-    // initializing source and commentLocs here is a bit of a hack but it
-    // means parseUnit() and parseUnitErrors() do not have to be overridden
+  protected DartParser makeParser(Source src, String sourceCode, DartCompilerListener listener) {
     source = sourceCode;
-    commentLocs.clear();
-    return new CommentParserContext(src, sourceCode, listener);
+    return super.makeParser(src, sourceCode, listener);
   }
 
-  private List<String> extractComments() {
-    List<String> comments = new ArrayList<String>();
-    for (int[] loc : commentLocs) {
-      comments.add(source.substring(loc[0], loc[1]));
+  private List<String> extractComments(DartUnit unit) {
+    List<String> comments = Lists.newArrayList();
+    List<DartComment> commentNodes = unit.getComments();
+    for (DartComment commentNode : commentNodes) {
+      SourceInfo sourceInfo = commentNode.getSourceInfo();
+      String comment = source.substring(sourceInfo.getOffset(), sourceInfo.getEnd());
+      comments.add(comment);
     }
     return comments;
   }
 
-  private void compareComments(String[] expected) {
-    List<String> comments = extractComments();
+  private void compareComments(DartUnit unit, String[] expected) {
+    List<String> comments = extractComments(unit);
     assertEquals(expected.length, comments.size());
     for (int i = 0; i < expected.length; i++) {
       assertEquals(expected[i], comments.get(i));
     }
   }
 
   private void assertDeclComments(DartUnit unit, String name, String comments) {
     for (DartNode node : unit.getTopLevelNodes()) {
       if (node instanceof DartDeclaration && node.getElement() != null
           && name.equals(node.getElement().getOriginalName())) {
         DartDeclaration<?> decl = (DartDeclaration<?>)node;
         String nodeComments = null;
 
         if (decl.getDartDoc() != null) {
           nodeComments = decl.getDartDoc().toSource();
         }
 
         assertEquals(comments, nodeComments);
       }
     }
   }
 }