Parse type substitution comments /*=T*/ in variable declarations with Fasta.

pkg/analyzer/lib/src/fasta/ast_builder.dart

 // Copyright (c) 2016, 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 fasta.analyzer.ast_builder;
 
 import 'package:analyzer/analyzer.dart';
 import 'package:analyzer/dart/ast/ast_factory.dart' show AstFactory;
 import 'package:analyzer/dart/ast/standard_ast_factory.dart' as standard;
 import 'package:analyzer/dart/ast/token.dart' as analyzer show Token;
 import 'package:analyzer/dart/element/element.dart' show Element;
 import 'package:front_end/src/fasta/parser/parser.dart'
     show FormalParameterType;
+import 'package:front_end/src/fasta/scanner/precedence.dart';
+import 'package:front_end/src/fasta/scanner/string_scanner.dart';
 import 'package:front_end/src/fasta/scanner/token.dart'
-    show BeginGroupToken, Token;
+    show BeginGroupToken, CommentToken, Token;
 
 import 'package:front_end/src/fasta/errors.dart' show internalError;
 import 'package:front_end/src/fasta/fasta_codes.dart'
     show FastaMessage, codeExpectedExpression;
 import 'package:front_end/src/fasta/kernel/kernel_builder.dart'
     show Builder, KernelLibraryBuilder, ProcedureBuilder, Scope;
 import 'package:front_end/src/fasta/parser/identifier_context.dart'
     show IdentifierContext;
 import 'package:front_end/src/fasta/quote.dart';
 import 'package:front_end/src/fasta/source/scope_listener.dart'
@@ skipping 12 matching lines @@
   final AstFactory ast = standard.astFactory;
 
   final ErrorReporter errorReporter;
   final KernelLibraryBuilder library;
   final Builder member;
   final ElementStore elementStore;
 
   @override
   final Uri uri;
 
+  bool parseGenericMethodComments = false;
+
   /// The name of the class currently being parsed, or `null` if no class is
   /// being parsed.
   String className;
 
   AstBuilder(this.errorReporter, this.library, this.member, this.elementStore,
       Scope scope,
       [Uri uri])
       : uri = uri ?? library.fileUri,
         super(scope);
 
@@ skipping 1803 matching lines @@
     // See Parser.parseCommentAndMetadata
     var tokens = <analyzer.Token>[toAnalyzerCommentToken(comments)];
     var references = <CommentReference>[];
     return ast.documentationComment(tokens, references);
   }
 
   @override
   void debugEvent(String name) {
     // printEvent(name);
   }
+
+  @override
+  Token injectGenericCommentTypeAssign(Token token) {

[Paul Berry, 2017/04/07 16:03:32]

I'm concerned about putting these methods in AstBuilder because the code will
have to be duplicated in BodyBuilder.

However, since Peter is out on vacation next week, I think we should land the
code as is and discuss it when he's back (and I'm in Aarhus).  I'll make a note
to talk to him about it.

Would you mind adding a TODO comment to act as an additional reminder? (e.g.
"TODO(paulberry,scheglov,ahe): figure out how to share these methods with
BodyBuilder")

[scheglov, 2017/04/07 19:58:52]

Done.

+    return _injectGenericComment(token, GENERIC_METHOD_TYPE_ASSIGN, 3);
+  }
+
+  @override
+  Token injectGenericCommentTypeList(Token token) {
+    return _injectGenericComment(token, GENERIC_METHOD_TYPE_LIST, 2);
+  }
+
+  @override
+  Token replaceTokenWithGenericCommentTypeAssign(
+      Token tokenToStartReplacing, Token tokenWithComment) {
+    Token injected = injectGenericCommentTypeAssign(tokenWithComment);
+    if (!identical(injected, tokenWithComment)) {
+      Token prev = tokenToStartReplacing.previous;
+      prev.setNextWithoutSettingPrevious(injected);
+      tokenToStartReplacing = injected;
+      tokenToStartReplacing.previous = prev;
+    }
+    return tokenToStartReplacing;
+  }
+
+  /// Check if the given [token] has a comment token with the given [info],
+  /// which should be either [GENERIC_METHOD_TYPE_ASSIGN] or
+  /// [GENERIC_METHOD_TYPE_LIST].  If found, parse the comment into tokens and
+  /// inject into the token stream before the [token].
+  Token _injectGenericComment(Token token, PrecedenceInfo info, int prefixLen) {
+    if (parseGenericMethodComments) {
+      CommentToken t = token.precedingCommentTokens;
+      for (; t != null; t = t.next) {
+        if (t.info == info) {
+          String code = t.lexeme.substring(prefixLen, t.lexeme.length - 2);
+          Token tokens = _scanGenericMethodComment(code, t.offset + prefixLen);
+          if (tokens != null) {
+            // Remove the token from the comment stream.
+            t.remove();
+            // Insert the tokens into the stream.
+            _injectTokenList(token, tokens);
+            return tokens;
+          }
+        }
+      }
+    }
+    return token;
+  }
+
+  void _injectTokenList(Token beforeToken, Token firstToken) {
+    // Scanner creates a cyclic EOF token.
+    Token lastToken = firstToken;
+    while (lastToken.next.info != EOF_INFO) {
+      lastToken = lastToken.next;
+    }
+    // Inject these new tokens into the stream.
+    Token previous = beforeToken.previous;
+    lastToken.setNext(beforeToken);
+    previous.setNext(firstToken);
+    beforeToken = firstToken;
+  }
+
+  /// Scans the given [code], and returns the tokens, otherwise returns `null`.
+  Token _scanGenericMethodComment(String code, int offset) {
+    var scanner = new SubStringScanner(offset, code);
+    Token firstToken = scanner.tokenize();
+    if (scanner.hasErrors) {
+      return null;
+    }
+    return firstToken;
+  }
 }
 
 /// Data structure placed on the stack to represent a class body.
 ///
 /// This is needed because analyzer has no separate AST representation of a
 /// class body; it simply stores all of the relevant data in the
 /// [ClassDeclaration] object.
 class _ClassBody {
   final Token beginToken;
 
@@ skipping 84 matching lines @@
       } else if (identical('static', s)) {
         staticKeyword = token;
       } else if (identical('var', s)) {
         finalConstOrVarKeyword = token;
       } else {
         internalError('Unhandled modifier: $s');
       }
     }
   }
 }