fix completion target handling of comments

pkg/analysis_server/test/services/completion/completion_target_test.dart

 // Copyright (c) 2014, the Dart project authors.  Please see the AUTHORS file
 // 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.
 
 library test.services.completion.target;
 
 import 'package:analysis_server/src/services/completion/completion_target.dart';
 import 'package:analyzer/src/generated/ast.dart';
 import 'package:analyzer/src/generated/source.dart';
 import 'package:unittest/unittest.dart';
@@ skipping 41 matching lines @@
     assertCommon();
     expect(target.isFunctionalArgument(), isFunctionalArgument);
   }
 
   test_ArgumentList_InstanceCreationExpression() {
     // ArgumentList  InstanceCreationExpression  Block
     addTestSource('main() {new Foo(^)}');
     assertTarget(')', '()', argIndex: 0);
   }
 
+  test_ArgumentList_InstanceCreationExpression_functionArg2() {
+    // ArgumentList  InstanceCreationExpression  Block
+    addTestSource('main() {new B(^)} class B{B(f()){}}');
+    assertTarget(')', '()', argIndex: 0, isFunctionalArgument: true);
+  }
+
   test_ArgumentList_MethodInvocation() {
     // ArgumentList  MethodInvocation  Block
     addTestSource('main() {foo(^)}');
     assertTarget(')', '()', argIndex: 0);
   }
 
   test_ArgumentList_MethodInvocation2() {
     // ArgumentList  MethodInvocation  Block
     addTestSource('main() {foo(^n)}');
     assertTarget('n', '(n)', argIndex: 0);
@@ skipping 16 matching lines @@
     addTestSource('main() {foo(^)} foo(f()) {}');
     assertTarget(')', '()', argIndex: 0, isFunctionalArgument: true);
   }
 
   test_ArgumentList_MethodInvocation_functionArg2() {
     // ArgumentList  MethodInvocation  Block
     addTestSource('main() {new B().boo(^)} class B{boo(f()){}}');
     assertTarget(')', '()', argIndex: 0, isFunctionalArgument: true);
   }
 
-  test_ArgumentList_InstanceCreationExpression_functionArg2() {
-    // ArgumentList  InstanceCreationExpression  Block
-    addTestSource('main() {new B(^)} class B{B(f()){}}');
-    assertTarget(')', '()', argIndex: 0, isFunctionalArgument: true);
-  }
-
   test_AsExpression_identifier() {
     // SimpleIdentifier  TypeName  AsExpression
     addTestSource('class A {var b; X _c; foo() {var a; (a^ as String).foo();}');
     assertTarget('a as String', '(a as String)');
   }
 
   test_AsExpression_keyword() {
     // SimpleIdentifier  TypeName  AsExpression
     addTestSource('class A {var b; X _c; foo() {var a; (a ^as String).foo();}');
     assertTarget('as', 'a as String');
@@ skipping 34 matching lines @@
     addTestSource('class C {foo(){var f; {var x;} new^ }}');
     assertTarget('new ();', '{var f; {var x;} new ();}');
   }
 
   test_InstanceCreationExpression_keyword2() {
     // InstanceCreationExpression  ExpressionStatement  Block
     addTestSource('class C {foo(){var f; {var x;} new^ C();}}');
     assertTarget('new C();', '{var f; {var x;} new C();}');
   }
 
+  test_MethodDeclaration_inComment() {
+    // Comment  ClassDeclaration  CompilationUnit
+    addTestSource('class C2 {/* ^ */ zoo(z) {} String name;}');
+    assertTarget('/*  */', 'class C2 {zoo(z) {} String name;}');
+  }
+
+  test_MethodDeclaration_inComment2() {
+    // Comment  ClassDeclaration  CompilationUnit
+    addTestSource('''
+      class C2 {
+        // normal comment ^
+        zoo(z) { } String name; }''');
+    assertTarget('// normal comment ', 'class C2 {zoo(z) {} String name;}');
+  }
+
+  test_MethodDeclaration_inComment3() {
+    // Comment  ClassDeclaration  CompilationUnit
+    addTestSource('''
+      class C2 {
+        // normal ^comment
+        zoo(z) { } String name; }''');
+    assertTarget('// normal comment', 'class C2 {zoo(z) {} String name;}');
+  }
+
+  test_MethodDeclaration_inComment4() {
+    // Comment  ClassDeclaration  CompilationUnit
+    addTestSource('''
+      class C2 {
+        // normal comment ^
+        // normal comment 2
+        zoo(z) { } String name; }''');
+    assertTarget('// normal comment ', 'class C2 {zoo(z) {} String name;}');
+  }
+
+  test_MethodDeclaration_inComment5() {
+    // Comment  ClassDeclaration  CompilationUnit
+    addTestSource('''
+      class C2 {
+        // normal comment 
+        // normal comment 2^
+        zoo(z) { } String name; }''');
+    assertTarget('// normal comment 2', 'class C2 {zoo(z) {} String name;}');
+  }
+
+  test_MethodDeclaration_inDocComment() {
+    // Comment  MethodDeclaration  ClassDeclaration  CompilationUnit
+    addTestSource('class C2 {/** ^ */ zoo(z) { } String name; }');
+    assertTarget('/**  */', '');
+    expect(target.containingNode is Comment, isTrue);
+    expect(target.containingNode.parent.toSource(), 'zoo(z) {}');
+  }
+
+  test_MethodDeclaration_inDocComment2() {
+    // Comment  MethodDeclaration  ClassDeclaration  CompilationUnit
+    addTestSource('''
+      class C2 {
+        /// some dartdoc ^
+        zoo(z) { } String name; }''');
+    assertTarget('/// some dartdoc ', '');
+    expect(target.containingNode is Comment, isTrue);
+    expect(target.containingNode.parent.toSource(), 'zoo(z) {}');
+  }
+
+  test_MethodDeclaration_inDocComment3() {
+    // Comment  MethodDeclaration  ClassDeclaration  CompilationUnit
+    addTestSource('''
+      class C2 {
+        /// some ^dartdoc
+        zoo(z) { } String name; }''');
+    assertTarget('/// some dartdoc', '');
+    expect(target.containingNode is Comment, isTrue);
+    expect(target.containingNode.parent.toSource(), 'zoo(z) {}');
+  }
+
+  test_MethodDeclaration_returnType() {
+    // ClassDeclaration  CompilationUnit
+    addTestSource('class C2 {^ zoo(z) { } String name; }');
+    assertTarget('zoo(z) {}', 'class C2 {zoo(z) {} String name;}');
+  }
+
+  test_MethodDeclaration_returnType_afterComment() {
+    // ClassDeclaration  CompilationUnit
+    addTestSource('class C2 {/* */ ^ zoo(z) { } String name; }');
+    assertTarget('zoo(z) {}', 'class C2 {zoo(z) {} String name;}');
+  }
+
+  test_MethodDeclaration_returnType_afterComment2() {
+    // MethodDeclaration  ClassDeclaration  CompilationUnit
+    addTestSource('''
+      class C2 {
+        // normal comment
+        ^ zoo(z) {} String name;}''');
+    assertTarget('zoo(z) {}', 'class C2 {zoo(z) {} String name;}');
+  }
+
+  test_MethodDeclaration_returnType_afterDocComment() {
+    // MethodDeclaration  ClassDeclaration  CompilationUnit
+    addTestSource('class C2 {/** */ ^ zoo(z) { } String name; }');
+    assertTarget('zoo', 'zoo(z) {}');
+  }
+
+  test_MethodDeclaration_returnType_afterDocComment2() {
+    // SimpleIdentifier  MethodDeclaration  ClassDeclaration  CompilationUnit
+    addTestSource('''
+      class C2 {
+        /// some dartdoc
+        ^ zoo(z) { } String name; }''');
+    assertTarget('zoo', 'zoo(z) {}');
+  }
+

[Paul Berry, 2015/03/09 22:32:51]

I'd suggest adding some corner cases to test that the end of the comment is
detected correctly, e.g.:

1. Insertion point right after single-line comment:

// Comment
^zoo(z)

2. Insertion point right after C-style comment:

/* Comment */^ zoo(z)

3. Insertion point just before end of C-style comment (but still inside it):

/* Comment *^/ zoo(z)

Note that case 3 above should be considered inside the comment, since any
identifier typed at the insertion point will break the comment terminator and
therefore add text to the body of the comment.

[danrubel, 2015/03/11 15:01:56]

Great suggestion. Done.

   test_VariableDeclaration_lhs_identifier_after() {
     // VariableDeclaration  VariableDeclarationList
     addTestSource('main() {int b^ = 1;}');
     assertTarget('b = 1', 'int b = 1');
   }
 
   test_VariableDeclaration_lhs_identifier_before() {
     // VariableDeclaration  VariableDeclarationList
     addTestSource('main() {int ^b = 1;}');
     assertTarget('b = 1', 'int b = 1');
   }
 }