Unify the server and plugin versions of the generators

pkg/analysis_server/tool/spec/codegen_dart_protocol.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 codegen.protocol;
-
 import 'dart:convert';
 
 import 'package:analyzer/src/codegen/tools.dart';
 import 'package:front_end/src/codegen/tools.dart';
 import 'package:html/dom.dart' as dom;
+import 'package:path/path.dart' as path;
 
 import 'api.dart';
 import 'codegen_dart.dart';
 import 'from_html.dart';
 import 'implied_types.dart';
 import 'to_html.dart';
 
 /**
  * Special flags that need to be inserted into the declaration of the Element
  * class.
  */
 const Map<String, String> specialElementFlags = const {
   'abstract': '0x01',
   'const': '0x02',
   'final': '0x04',
   'static': '0x08',
   'private': '0x10',
   'deprecated': '0x20'
 };
 
-final GeneratedFile target = new GeneratedFile(
-    'lib/plugin/protocol/generated_protocol.dart', (String pkgPath) {
-  CodegenProtocolVisitor visitor = new CodegenProtocolVisitor(readApi(pkgPath));
+final GeneratedFile target =
+    new GeneratedFile('lib/protocol/protocol_generated.dart', (String pkgPath) {
+  CodegenProtocolVisitor visitor =
+      new CodegenProtocolVisitor(path.basename(pkgPath), readApi(pkgPath));
   return visitor.collectCode(visitor.visitApi);
 });
 
 /**
  * Callback type used to represent arbitrary code generation.
  */
 typedef void CodegenCallback();
 
 typedef String FromJsonSnippetCallback(String jsonPath, String json);
 
@@ skipping 16 matching lines @@
   };
 
   /**
    * The disclaimer added to the documentation comment for each of the classes
    * that are generated.
    */
   static const String disclaimer =
       'Clients may not extend, implement or mix-in this class.';
 
   /**
+   * The name of the package into which code is being generated.
+   */
+  final String packageName;
+
+  /**
    * Visitor used to produce doc comments.
    */
   final ToHtmlVisitor toHtmlVisitor;
 
   /**
    * Types implied by the API.  This includes types explicitly named in the
    * API as well as those implied by the definitions of requests, responses,
    * notifications, etc.
    */
   final Map<String, ImpliedType> impliedTypes;
 
-  CodegenProtocolVisitor(Api api)
+  CodegenProtocolVisitor(this.packageName, Api api)
       : toHtmlVisitor = new ToHtmlVisitor(api),
         impliedTypes = computeImpliedTypes(api),
         super(api) {
     codeGeneratorSettings.commentLineLength = 79;
     codeGeneratorSettings.languageName = 'dart';
   }
 
   /**
    * Compute the code necessary to compare two objects for equality.
    */
@@ skipping 17 matching lines @@
       return 'mapEqual($thisVar, $otherVar, $closure)';
     }
     throw new Exception(
         "Don't know how to compare for equality: $resolvedType");
   }
 
   /**
    * Translate each type implied by the API to a class.
    */
   void emitClasses() {
-    for (ImpliedType impliedType in impliedTypes.values) {
+    List<ImpliedType> types = impliedTypes.values.toList();
+    types.sort((first, second) =>
+        capitalize(first.camelName).compareTo(capitalize(second.camelName)));
+    for (ImpliedType impliedType in types) {
       TypeDecl type = impliedType.type;
       String dartTypeName = capitalize(impliedType.camelName);
       if (type == null) {
+        writeln();
         emitEmptyObjectClass(dartTypeName, impliedType);
       } else if (type is TypeObject) {
         writeln();
         emitObjectClass(dartTypeName, type, impliedType);
       } else if (type is TypeEnum) {
         writeln();
         emitEnumClass(dartTypeName, type, impliedType);
       }
     }
   }
@@ skipping 12 matching lines @@
     // Constructor call to create the JsonDecoder object.
     String makeDecoder;
     // Name of the constructor to create.
     String constructorName;
     // Extra arguments for the constructor.
     List<String> extraArgs = <String>[];
     switch (impliedType.kind) {
       case 'requestParams':
         inputType = 'Request';
         inputName = 'request';
-        fieldName = '_params';
+        fieldName = 'params';
         makeDecoder = 'new RequestDecoder(request)';
         constructorName = 'fromRequest';
         break;
       case 'requestResult':
         inputType = 'Response';
         inputName = 'response';
-        fieldName = '_result';
+        fieldName = 'result';
         makeDecoder =
             'new ResponseDecoder(REQUEST_ID_REFACTORING_KINDS.remove(response.id))';
         constructorName = 'fromResponse';
         break;
       case 'notificationParams':
         inputType = 'Notification';
         inputName = 'notification';
-        fieldName = '_params';
+        fieldName = 'params';
         makeDecoder = 'new ResponseDecoder(null)';
         constructorName = 'fromNotification';
         break;
       case 'refactoringOptions':
         inputType = 'EditGetRefactoringParams';
         inputName = 'refactoringParams';
         fieldName = 'options';
         makeDecoder = 'new RequestDecoder(request)';
         constructorName = 'fromRefactoringParams';
         extraArgs.add('Request request');
@@ skipping 30 matching lines @@
     docComment(toHtmlVisitor.collectHtml(() {
       toHtmlVisitor.p(() {
         toHtmlVisitor.write(impliedType.humanReadableName);
       });
       toHtmlVisitor.p(() {
         toHtmlVisitor.write(disclaimer);
       });
     }));
     write('class $className');
     if (impliedType.kind == 'refactoringFeedback') {
-      writeln(' extends RefactoringFeedback {');
+      writeln(' extends RefactoringFeedback implements HasToJson {');
     } else if (impliedType.kind == 'refactoringOptions') {
-      writeln(' extends RefactoringOptions {');
+      writeln(' extends RefactoringOptions implements HasToJson {');
+    } else if (impliedType.kind == 'requestParams') {
+      writeln(' implements RequestParams {');
+    } else if (impliedType.kind == 'requestResult') {
+      writeln(' implements ResponseResult {');
     } else {
       writeln(' {');
     }
     indent(() {
+      if (impliedType.kind == 'requestResult' ||
+          impliedType.kind == 'requestParams') {
+        emitEmptyToJsonMember();
+        writeln();
+      }
       if (emitToRequestMember(impliedType)) {
         writeln();
       }
       if (emitToResponseMember(impliedType)) {
         writeln();
       }
       if (emitToNotificationMember(impliedType)) {
         writeln();
       }
       emitObjectEqualsMember(null, className);
       writeln();
       emitObjectHashCode(null, className);
     });
     writeln('}');
   }
 
   /**
+   * Emit the toJson() code for an empty class.
+   */
+  void emitEmptyToJsonMember() {
+    writeln('@override');
+    writeln('Map<String, dynamic> toJson() => <String, dynamic>{};');
+  }
+
+  /**
    * Emit a class to encapsulate an enum.
    */
   void emitEnumClass(String className, TypeEnum type, ImpliedType impliedType) {
     docComment(toHtmlVisitor.collectHtml(() {
       toHtmlVisitor.p(() {
         toHtmlVisitor.write(impliedType.humanReadableName);
       });
       if (impliedType.type != null) {
         toHtmlVisitor.showType(null, impliedType.type);
       }
@@ skipping 29 matching lines @@
         if (first) {
           first = false;
         } else {
           write(', ');
         }
         write(value.value);
       }
       writeln('];');
       writeln();
 
+      writeln('@override');
       writeln('final String name;');
       writeln();
       writeln('const $className._(this.name);');
       writeln();
       emitEnumClassConstructor(className, type);
       writeln();
       emitEnumFromJsonConstructor(className, type, impliedType);
       writeln();
       if (emitSpecialConstructors(className)) {
         writeln();
@@ skipping 77 matching lines @@
       }
       toHtmlVisitor.p(() {
         toHtmlVisitor.write(disclaimer);
       });
     }));
     write('class $className');
     if (impliedType.kind == 'refactoringFeedback') {
       writeln(' extends RefactoringFeedback {');
     } else if (impliedType.kind == 'refactoringOptions') {
       writeln(' extends RefactoringOptions {');
+    } else if (impliedType.kind == 'requestParams') {
+      writeln(' implements RequestParams {');
+    } else if (impliedType.kind == 'requestResult') {
+      writeln(' implements ResponseResult {');
     } else {
       writeln(' implements HasToJson {');
     }
     indent(() {
       if (emitSpecialStaticMembers(className)) {
         writeln();
       }
       for (TypeObjectField field in type.fields) {
         if (field.value != null) {
           continue;
@@ skipping 222 matching lines @@
           indent(() {
             String fromJson =
                 fromJsonCode(fieldType).asSnippet(jsonPath, fieldAccessor);
             writeln('${field.name} = $fromJson;');
           });
           write('}');
           if (!field.optional) {
             writeln(' else {');
             indent(() {
               writeln(
-                  "throw jsonDecoder.missingKey(jsonPath, $fieldNameString);");
+                  "throw jsonDecoder.mismatch(jsonPath, $fieldNameString);");
             });
             writeln('}');
           } else {
             writeln();
           }
         }
         args.addAll(optionalArgs);
         writeln('return new $className(${args.join(', ')});');
       });
       writeln('} else {');
@@ skipping 188 matching lines @@
         return true;
       default:
         return false;
     }
   }
 
   /**
    * Emit the toJson() code for an object class.
    */
   void emitToJsonMember(TypeObject type) {
+    writeln('@override');
     writeln('Map<String, dynamic> toJson() {');
     indent(() {
       writeln('Map<String, dynamic> result = {};');
       for (TypeObjectField field in type.fields) {
         String fieldNameString = literalString(field.name);
         if (field.value != null) {
           writeln('result[$fieldNameString] = ${literalString(field.value)};');
           continue;
         }
         String fieldToJson = toJsonCode(field.type).asSnippet(field.name);
@@ skipping 31 matching lines @@
     }
     return false;
   }
 
   /**
    * Emit the toRequest() code for a class, if appropriate.  Returns true if
    * code was emitted.
    */
   bool emitToRequestMember(ImpliedType impliedType) {
     if (impliedType.kind == 'requestParams') {
+      writeln('@override');
       writeln('Request toRequest(String id) {');
       indent(() {
         String methodString =
             literalString((impliedType.apiNode as Request).longMethod);
         String jsonPart = impliedType.type != null ? 'toJson()' : 'null';
         writeln('return new Request(id, $methodString, $jsonPart);');
       });
       writeln('}');
       return true;
     }
     return false;
   }
 
   /**
    * Emit the toResponse() code for a class, if appropriate.  Returns true if
    * code was emitted.
    */
   bool emitToResponseMember(ImpliedType impliedType) {
     if (impliedType.kind == 'requestResult') {
+      writeln('@override');
       writeln('Response toResponse(String id) {');
       indent(() {
         String jsonPart = impliedType.type != null ? 'toJson()' : 'null';
         writeln('return new Response(id, result: $jsonPart);');
       });
       writeln('}');
       return true;
     }
     return false;
   }
@@ skipping 165 matching lines @@
     } else if (resolvedType is TypeObject || resolvedType is TypeEnum) {
       return new ToJsonSnippet(
           dartType(type), (String value) => '$value.toJson()');
     } else {
       throw new Exception("Can't convert $resolvedType from JSON");
     }
   }
 
   @override
   visitApi() {
-    outputHeader();
+    outputHeader(year: '2017');
     writeln();
-    writeln('part of analysis_server.plugin.protocol.protocol;');
+    writeln("import 'dart:convert' hide JsonDecoder;");
     writeln();
+    writeln("import 'package:analyzer/src/generated/utilities_general.dart';");
+    writeln("import 'package:$packageName/protocol/protocol.dart';");
+    writeln(
+        "import 'package:$packageName/src/protocol/protocol_internal.dart';");
     emitClasses();
   }
 }
 
 /**
  * Container for code that can be used to translate a data type from JSON.
  */
 abstract class FromJsonCode {
   /**
    * Get the translation code in the form of a closure.
@@ skipping 11 matching lines @@
    * is the variable holding the JSON path, and [json] is the variable holding
    * the raw JSON.
    */
   String asSnippet(String jsonPath, String json);
 }
 
 /**
  * Representation of FromJsonCode for a function defined elsewhere.
  */
 class FromJsonFunction extends FromJsonCode {
+  @override
   final String asClosure;
 
   FromJsonFunction(this.asClosure);
 
   @override
   bool get isIdentity => false;
 
   @override
   String asSnippet(String jsonPath, String json) =>
       '$asClosure($jsonPath, $json)';
@@ skipping 51 matching lines @@
    * Get the translation code in the form of a code snippet, where [value]
    * is the variable holding the object to be translated.
    */
   String asSnippet(String value);
 }
 
 /**
  * Representation of ToJsonCode for a function defined elsewhere.
  */
 class ToJsonFunction extends ToJsonCode {
+  @override
   final String asClosure;
 
   ToJsonFunction(this.asClosure);
 
   @override
   bool get isIdentity => false;
 
   @override
   String asSnippet(String value) => '$asClosure($value)';
 }
@@ skipping 27 matching lines @@
 
   @override
   String get asClosure => '($type value) => ${callback('value')}';
 
   @override
   bool get isIdentity => false;
 
   @override
   String asSnippet(String value) => callback(value);
 }