Make server use the common protocol classes

pkg/analysis_server/lib/protocol/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.
 
 /**
  * Support for client code that needs to interact with the requests, responses
  * and notifications that are part of the analysis server's wire protocol.
  */
-library analysis_server.plugin.protocol.protocol;
-
-import 'dart:collection';
 import 'dart:convert' hide JsonDecoder;
 
 import 'package:analysis_server/protocol/protocol_generated.dart';
 import 'package:analysis_server/src/protocol/protocol_internal.dart';
 
+export 'package:analyzer_plugin/protocol/protocol.dart' show Enum;
+
 /**
  * A [RequestHandler] that supports [startup] and [shutdown] methods.
  *
  * Clients may not extend, implement or mix-in this class.
  */
 abstract class DomainHandler implements RequestHandler {
   /**
    * Perform any operations associated with the shutdown of the domain. It is
    * not guaranteed that this method will be called. If it is, it will be
    * called after the last [Request] has been made.
    */
   void shutdown() {}
 
   /**
    * Perform any operations associated with the startup of the domain. This
    * will be called before the first [Request].
    */
   void startup() {}
 }
 
 /**
- * An interface for enumerated types in the protocol.
+ * A notification that can be sent from the server about an event that occurred.
  *
  * Clients may not extend, implement or mix-in this class.
  */
-abstract class Enum {
-  /**
-   * The name of the enumerated value. This should match the name of the
-   * static getter which provides access to this enumerated value.
-   */
-  String get name;
-}
-
-/**
- * A notification from the server about an event that occurred.
- *
- * Clients may not extend, implement or mix-in this class.
- */
 class Notification {
   /**
    * The name of the JSON attribute containing the name of the event that
    * triggered the notification.
    */
   static const String EVENT = 'event';
 
   /**
    * The name of the JSON attribute containing the result values.
    */
   static const String PARAMS = 'params';
 
   /**
    * The name of the event that triggered the notification.
    */
   final String event;
 
   /**
    * A table mapping the names of notification parameters to their values, or
    * `null` if there are no notification parameters.
    */
   final Map<String, Object> params;
 
   /**
    * Initialize a newly created [Notification] to have the given [event] name.
-   * If [_params] is provided, it will be used as the params; otherwise no
+   * If [params] is provided, it will be used as the params; otherwise no
    * params will be used.
    */
   Notification(this.event, [this.params]);
 
   /**
    * Initialize a newly created instance based on the given JSON data.
    */
   factory Notification.fromJson(Map json) {
     return new Notification(json[Notification.EVENT],
         json[Notification.PARAMS] as Map<String, Object>);
@@ skipping 56 matching lines @@
   final Map<String, Object> params;
 
   /**
    * The time (milliseconds since epoch) at which the client made the request
    * or `null` if this information is not provided by the client.
    */
   final int clientRequestTime;
 
   /**
    * Initialize a newly created [Request] to have the given [id] and [method]
-   * name.  If [params] is supplied, it is used as the "params" map for the
-   * request.  Otherwise an empty "params" map is allocated.
+   * name. If [params] is supplied, it is used as the "params" map for the
+   * request. Otherwise an empty "params" map is allocated.
    */
   Request(this.id, this.method,
       [Map<String, Object> params, this.clientRequestTime])
-      : params = params ?? new HashMap<String, Object>();
+      : params = params ?? <String, Object>{};
 
   /**
    * Return a request parsed from the given json, or `null` if the [data] is
    * not a valid json representation of a request. The [data] is expected to
    * have the following format:
    *
    *   {
    *     'clientRequestTime': millisecondsSinceEpoch
    *     'id': String,
    *     'method': methodName,
    *     'params': {
    *       paramter_name: value
    *     }
    *   }
    *
    * where both the parameters and clientRequestTime are optional.
    *
    * The parameters can contain any number of name/value pairs. The
    * clientRequestTime must be an int representing the time at which the client
    * issued the request (milliseconds since epoch).
    */
-  factory Request.fromJson(Map<String, dynamic> result) {
+  factory Request.fromJson(Map<String, Object> result) {
     var id = result[Request.ID];
     var method = result[Request.METHOD];
     if (id is! String || method is! String) {
       return null;
     }
     var time = result[Request.CLIENT_REQUEST_TIME];
     if (time != null && time is! int) {
       return null;
     }
     var params = result[Request.PARAMS];
@@ skipping 29 matching lines @@
       var result = JSON.decode(data);
       if (result is Map) {
         return new Request.fromJson(result as Map<String, dynamic>);
       }
       return null;
     } catch (exception) {
       return null;
     }
   }
 
+  @override
+  int get hashCode {
+    return id.hashCode;
+  }
+
+  @override
+  bool operator ==(Object other) {
+    return other is Request &&
+        id == other.id &&
+        method == other.method &&
+        clientRequestTime == other.clientRequestTime &&
+        _equalMaps(params, other.params);
+  }
+
   /**
    * Return a table representing the structure of the Json object that will be
    * sent to the client to represent this response.
    */
   Map<String, Object> toJson() {
-    Map<String, Object> jsonObject = new HashMap<String, Object>();
+    Map<String, Object> jsonObject = <String, Object>{};
     jsonObject[ID] = id;
     jsonObject[METHOD] = method;
     if (params.isNotEmpty) {
       jsonObject[PARAMS] = params;
     }
     if (clientRequestTime != null) {
       jsonObject[CLIENT_REQUEST_TIME] = clientRequestTime;
     }
     return jsonObject;
   }
+
+  bool _equalLists(List first, List second) {
+    if (first == null) {
+      return second == null;
+    }
+    if (second == null) {
+      return false;
+    }
+    int length = first.length;
+    if (length != second.length) {
+      return false;
+    }
+    for (int i = 0; i < length; i++) {
+      if (!_equalObjects(first[i], second[i])) {
+        return false;
+      }
+    }
+    return true;
+  }
+
+  bool _equalMaps(Map first, Map second) {
+    if (first == null) {
+      return second == null;
+    }
+    if (second == null) {
+      return false;
+    }
+    if (first.length != second.length) {
+      return false;
+    }
+    for (var key in first.keys) {
+      if (!second.containsKey(key)) {
+        return false;
+      }
+      if (!_equalObjects(first[key], second[key])) {
+        return false;
+      }
+    }
+    return true;
+  }
+
+  bool _equalObjects(Object first, Object second) {
+    if (first == null) {
+      return second == null;
+    }
+    if (second == null) {
+      return false;
+    }
+    if (first is Map) {
+      if (second is Map) {
+        return _equalMaps(first, second);
+      }
+      return false;
+    }
+    if (first is List) {
+      if (second is List) {
+        return _equalLists(first, second);
+      }
+      return false;
+    }
+    return first == second;
+  }
 }
 
 /**
  * An exception that occurred during the handling of a request that requires
  * that an error be returned to the client.
  *
  * Clients may not extend, implement or mix-in this class.
  */
 class RequestFailure implements Exception {
   /**
@@ skipping 59 matching lines @@
   /**
    * The error that was caused by attempting to handle the request, or `null` if
    * there was no error.
    */
   final RequestError error;
 
   /**
    * A table mapping the names of result fields to their values.  Should be
    * `null` if there is no result to send.
    */
-  Map<String, Object> _result;
+  Map<String, Object> result;
 
   /**
    * Initialize a newly created instance to represent a response to a request
    * with the given [id].  If [_result] is provided, it will be used as the
    * result; otherwise an empty result will be used.  If an [error] is provided
    * then the response will represent an error condition.
    */
-  Response(this.id, {Map<String, Object> result, this.error})
-      : _result = result;
+  Response(this.id, {Map<String, Object> result, this.error}) : result = result;
 
   /**
    * Create and return the `DEBUG_PORT_COULD_NOT_BE_OPENED` error response.
    */
   Response.debugPortCouldNotBeOpened(Request request, dynamic error)
       : this(request.id,
             error: new RequestError(
                 RequestErrorCode.DEBUG_PORT_COULD_NOT_BE_OPENED, '$error'));
 
   /**
@@ skipping 209 matching lines @@
   /**
    * Initialize a newly created instance to represent an error condition caused
    * by a [request] for a service that is not supported.
    */
   Response.unsupportedFeature(String requestId, String message)
       : this(requestId,
             error: new RequestError(
                 RequestErrorCode.UNSUPPORTED_FEATURE, message));
 
   /**
-   * Return a table mapping the names of result fields to their values.  Should
-   * be `null` if there is no result to send.
-   */
-  Map<String, Object> get result => _result;
-
-  /**
    * Return a table representing the structure of the Json object that will be
    * sent to the client to represent this response.
    */
   Map<String, Object> toJson() {
-    Map<String, Object> jsonObject = new HashMap<String, Object>();
+    Map<String, Object> jsonObject = <String, Object>{};
     jsonObject[ID] = id;
     if (error != null) {
       jsonObject[ERROR] = error.toJson();
     }
-    if (_result != null) {
-      jsonObject[RESULT] = _result;
+    if (result != null) {
+      jsonObject[RESULT] = result;
     }
     return jsonObject;
   }
 }