Format and sort analyzer and analysis_server packages.

pkg/analysis_server/tool/spec/api.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.
 
 /**
  * Data structures representing an API definition, and visitor base classes
  * for visiting those data structures.
  */
 library api;
 
 import 'dart:collection';
 
 import 'package:html5lib/dom.dart' as dom;
 
 /**
+ * Toplevel container for the API.
+ */
+class Api extends ApiNode {
+  final String version;
+  final List<Domain> domains;
+  final Types types;
+  final Refactorings refactorings;
+
+  Api(this.version, this.domains, this.types, this.refactorings,
+      dom.Element html)
+      : super(html);
+}
+
+/**
+ * Base class for objects in the API model.
+ */
+class ApiNode {
+  /**
+   * Html element representing this part of the API.
+   */
+  final dom.Element html;
+
+  ApiNode(this.html);
+}
+
+/**
  * Base class for visiting the API definition.
  */
 abstract class ApiVisitor<T> {
-  T visitTypeReference(TypeReference typeReference);
-  T visitTypeUnion(TypeUnion typeUnion);
-  T visitTypeObject(TypeObject typeObject);
-  T visitTypeList(TypeList typeList);
-  T visitTypeMap(TypeMap typeMap);
-  T visitTypeEnum(TypeEnum typeEnum);
-
   /**
    * Dispatch the given [type] to the visitor.
    */
   T visitTypeDecl(TypeDecl type) => type.accept(this);
+  T visitTypeEnum(TypeEnum typeEnum);
+  T visitTypeList(TypeList typeList);
+  T visitTypeMap(TypeMap typeMap);
+  T visitTypeObject(TypeObject typeObject);
+  T visitTypeReference(TypeReference typeReference);
+
+  T visitTypeUnion(TypeUnion typeUnion);
 }
 
 /**
+ * Definition of a single domain.
+ */
+class Domain extends ApiNode {
+  final String name;
+  final List<Request> requests;
+  final List<Notification> notifications;
+
+  Domain(this.name, this.requests, this.notifications, dom.Element html)
+      : super(html);
+}
+
+/**
  * API visitor that visits the entire API hierarchically by default.
  */
 class HierarchicalApiVisitor extends ApiVisitor {
   /**
    * The API to visit.
    */
   final Api api;
 
   HierarchicalApiVisitor(this.api);
 
+  /**
+   * If [type] is a [TypeReference] that is defined in the API, follow the
+   * chain until a non-[TypeReference] is found, if possible.
+   *
+   * If it is not possible (because the chain ends with a [TypeReference] that
+   * is not defined in the API), then that final [TypeReference] is returned.
+   */
+  TypeDecl resolveTypeReferenceChain(TypeDecl type) {
+    while (type is TypeReference && api.types.containsKey(type.typeName)) {
+      type = api.types[(type as TypeReference).typeName].type;
+    }
+    return type;
+  }
+
   void visitApi() {
     api.domains.forEach(visitDomain);
     visitTypes(api.types);
     visitRefactorings(api.refactorings);
   }
 
-  void visitRefactorings(Refactorings refactorings) {
-    refactorings.forEach(visitRefactoring);
+  void visitDomain(Domain domain) {
+    domain.requests.forEach(visitRequest);
+    domain.notifications.forEach(visitNotification);
+  }
+
+  void visitNotification(Notification notification) {
+    if (notification.params != null) {
+      visitTypeDecl(notification.params);
+    }
   }
 
   void visitRefactoring(Refactoring refactoring) {
     if (refactoring.feedback != null) {
       visitTypeDecl(refactoring.feedback);
     }
     if (refactoring.options != null) {
       visitTypeDecl(refactoring.options);
     }
   }
 
-  void visitTypes(Types types) {
-    types.forEach(visitTypeDefinition);
-  }
-
-  void visitDomain(Domain domain) {
-    domain.requests.forEach(visitRequest);
-    domain.notifications.forEach(visitNotification);
-  }
-
-  void visitNotification(Notification notification) {
-    if (notification.params != null) {
-      visitTypeDecl(notification.params);
-    }
+  void visitRefactorings(Refactorings refactorings) {
+    refactorings.forEach(visitRefactoring);
   }
 
   void visitRequest(Request request) {
     if (request.params != null) {
       visitTypeDecl(request.params);
     }
     if (request.result != null) {
       visitTypeDecl(request.result);
     }
   }
@@ skipping 27 matching lines @@
   }
 
   void visitTypeObjectField(TypeObjectField typeObjectField) {
     visitTypeDecl(typeObjectField.type);
   }
 
   @override
   void visitTypeReference(TypeReference typeReference) {
   }
 
+  void visitTypes(Types types) {
+    types.forEach(visitTypeDefinition);
+  }
+
   @override
   void visitTypeUnion(TypeUnion typeUnion) {
     typeUnion.choices.forEach(visitTypeDecl);
   }
+}
+
+/**
+ * Description of a request method.
+ */
+class Notification extends ApiNode {
+  /**
+   * Name of the domain enclosing this request.
+   */
+  final String domainName;
 
   /**
-   * If [type] is a [TypeReference] that is defined in the API, follow the
-   * chain until a non-[TypeReference] is found, if possible.
-   *
-   * If it is not possible (because the chain ends with a [TypeReference] that
-   * is not defined in the API), then that final [TypeReference] is returned.
+   * Name of the notification, without the domain prefix.
    */
-  TypeDecl resolveTypeReferenceChain(TypeDecl type) {
-    while (type is TypeReference && api.types.containsKey(type.typeName)) {
-      type = api.types[(type as TypeReference).typeName].type;
+  final String event;
+
+  /**
+   * Type of the object associated with the "params" key in the notification
+   * object, or null if the notification has no parameters.
+   */
+  final TypeObject params;
+
+  Notification(this.domainName, this.event, this.params, dom.Element html)
+      : super(html);
+
+  /**
+   * Get the name of the notification, including the domain prefix.
+   */
+  String get longEvent => '$domainName.$event';
+
+  /**
+   * Get the full type of the notification object, including the common "id"
+   * and "error" fields.
+   */
+  TypeDecl get notificationType {
+    List<TypeObjectField> fields = [
+        new TypeObjectField(
+            'event',
+            new TypeReference('String', null),
+            null,
+            value: '$domainName.$event')];
+    if (params != null) {
+      fields.add(new TypeObjectField('params', params, null));
     }
-    return type;
+    return new TypeObject(fields, null);
   }
 }
 
 /**
- * Base class for objects in the API model.
- */
-class ApiNode {
-  /**
-   * Html element representing this part of the API.
-   */
-  final dom.Element html;
-
-  ApiNode(this.html);
-}
-
-/**
- * Toplevel container for the API.
- */
-class Api extends ApiNode {
-  final String version;
-  final List<Domain> domains;
-  final Types types;
-  final Refactorings refactorings;
-
-  Api(this.version, this.domains, this.types, this.refactorings, dom.Element
-      html) : super(html);
-}
-
-/**
- * A collection of refactoring definitions.
- */
-class Refactorings extends ApiNode with IterableMixin<Refactoring> {
-  final List<Refactoring> refactorings;
-
-  Refactorings(this.refactorings, dom.Element html) : super(html);
-
-  @override
-  Iterator<Refactoring> get iterator => refactorings.iterator;
-}
-
-/**
  * Description of a single refactoring.
  */
 class Refactoring extends ApiNode {
   /**
    * Name of the refactoring.  This should match one of the values allowed for
    * RefactoringKind.
    */
   final String kind;
 
   /**
    * Type of the refactoring feedback, or null if the refactoring has no
    * feedback.
    */
   final TypeObject feedback;
 
   /**
    * Type of the refactoring options, or null if the refactoring has no options.
    */
   final TypeObject options;
 
-  Refactoring(this.kind, this.feedback, this.options, dom.Element html) : super(
-      html);
+  Refactoring(this.kind, this.feedback, this.options, dom.Element html)
+      : super(html);
 }
 
 /**
- * A collection of type definitions.
+ * A collection of refactoring definitions.
  */
-class Types extends ApiNode with IterableMixin<TypeDefinition> {
-  final Map<String, TypeDefinition> types;
+class Refactorings extends ApiNode with IterableMixin<Refactoring> {
+  final List<Refactoring> refactorings;
 
-  Types(this.types, dom.Element html) : super(html);
-
-  bool containsKey(String typeName) => types.containsKey(typeName);
+  Refactorings(this.refactorings, dom.Element html) : super(html);
 
   @override
-  Iterator<TypeDefinition> get iterator => types.values.iterator;
-
-  TypeDefinition operator [](String typeName) => types[typeName];
-
-  Iterable<String> get keys => types.keys;
+  Iterator<Refactoring> get iterator => refactorings.iterator;
 }
 
 /**
- * Definition of a single domain.
- */
-class Domain extends ApiNode {
-  final String name;
-  final List<Request> requests;
-  final List<Notification> notifications;
-
-  Domain(this.name, this.requests, this.notifications, dom.Element html) :
-      super(html);
-}
-
-/**
  * Description of a request method.
  */
 class Request extends ApiNode {
   /**
    * Name of the domain enclosing this request.
    */
   final String domainName;
 
   /**
    * Name of the request, without the domain prefix.
    */
   final String method;
 
   /**
    * Type of the object associated with the "params" key in the request object,
    * or null if the request has no parameters.
    */
   final TypeObject params;
 
   /**
    * Type of the object associated with the "result" key in the response object,
    * or null if the response has no results.
    */
   final TypeObject result;
 
-  Request(this.domainName, this.method, this.params, this.result, dom.Element
-      html) : super(html);
+  Request(this.domainName, this.method, this.params, this.result,
+      dom.Element html)
+      : super(html);
 
   /**
    * Get the name of the request, including the domain prefix.
    */
   String get longMethod => '$domainName.$method';
 
   /**
    * Get the full type of the request object, including the common "id" and
    * "method" fields.
    */
   TypeDecl get requestType {
-    List<TypeObjectField> fields = [new TypeObjectField('id', new TypeReference(
-        'String', null), null), new TypeObjectField('method', new TypeReference(
-        'String', null), null, value: '$domainName.$method')];
+    List<TypeObjectField> fields = [
+        new TypeObjectField('id', new TypeReference('String', null), null),
+        new TypeObjectField(
+            'method',
+            new TypeReference('String', null),
+            null,
+            value: '$domainName.$method')];
     if (params != null) {
       fields.add(new TypeObjectField('params', params, null));
     }
     return new TypeObject(fields, null);
   }
 
   /**
    * Get the full type of the response object, including the common "id" and
    * "error" fields.
    */
   TypeDecl get responseType {
     List<TypeObjectField> fields = [
         new TypeObjectField('id', new TypeReference('String', null), null),
         new TypeObjectField(
             'error',
             new TypeReference('RequestError', null),
             null,
             optional: true)];
     if (result != null) {
       fields.add(new TypeObjectField('result', result, null));
     }
     return new TypeObject(fields, null);
   }
 }
 
 /**
- * Description of a request method.
+ * Base class for all possible types.
  */
-class Notification extends ApiNode {
-  /**
-   * Name of the domain enclosing this request.
-   */
-  final String domainName;
+abstract class TypeDecl extends ApiNode {
+  TypeDecl(dom.Element html) : super(html);
 
-  /**
-   * Name of the notification, without the domain prefix.
-   */
-  final String event;
-
-  /**
-   * Type of the object associated with the "params" key in the notification
-   * object, or null if the notification has no parameters.
-   */
-  final TypeObject params;
-
-  Notification(this.domainName, this.event, this.params, dom.Element html) :
-      super(html);
-
-  /**
-   * Get the name of the notification, including the domain prefix.
-   */
-  String get longEvent => '$domainName.$event';
-
-  /**
-   * Get the full type of the notification object, including the common "id"
-   * and "error" fields.
-   */
-  TypeDecl get notificationType {
-    List<TypeObjectField> fields = [new TypeObjectField('event',
-        new TypeReference('String', null), null, value: '$domainName.$event')];
-    if (params != null) {
-      fields.add(new TypeObjectField('params', params, null));
-    }
-    return new TypeObject(fields, null);
-  }
+  accept(ApiVisitor visitor);
 }
 
 /**
  * Description of a named type definition.
  */
 class TypeDefinition extends ApiNode {
   final String name;
   final TypeDecl type;
 
   TypeDefinition(this.name, this.type, dom.Element html) : super(html);
 }
 
 /**
- * Base class for all possible types.
+ * Type of an enum.  We represent enums in JSON as strings, so this type
+ * declaration simply lists the allowed values.
  */
-abstract class TypeDecl extends ApiNode {
-  TypeDecl(dom.Element html) : super(html);
+class TypeEnum extends TypeDecl {
+  final List<TypeEnumValue> values;
 
-  accept(ApiVisitor visitor);
+  TypeEnum(this.values, dom.Element html) : super(html);
+
+  accept(ApiVisitor visitor) => visitor.visitTypeEnum(this);
 }
 
 /**
- * A reference to a type which is either defined elsewhere in the API or which
- * is built-in ([String], [bool], or [int]).
+ * Description of a single allowed value for an enum.
  */
-class TypeReference extends TypeDecl {
-  final String typeName;
+class TypeEnumValue extends ApiNode {
+  final String value;
 
-  TypeReference(this.typeName, dom.Element html) : super(html) {
-    if (typeName.isEmpty) {
-      throw new Exception('Empty type name');
-    }
-  }
-
-  accept(ApiVisitor visitor) => visitor.visitTypeReference(this);
+  TypeEnumValue(this.value, dom.Element html) : super(html);
 }
 
 /**
- * Type which represents a union among multiple choices.
+ * Type of a JSON list.
  */
-class TypeUnion extends TypeDecl {
-  final List<TypeDecl> choices;
+class TypeList extends TypeDecl {
+  final TypeDecl itemType;
 
-  /**
-   * The field that is used to disambiguate this union
-   */
-  final String field;
+  TypeList(this.itemType, dom.Element html) : super(html);
 
-  TypeUnion(this.choices, this.field, dom.Element html) : super(html);
-
-  accept(ApiVisitor visitor) => visitor.visitTypeUnion(this);
+  accept(ApiVisitor visitor) => visitor.visitTypeList(this);
 }
 
 /**
+ * Type of a JSON map.
+ */
+class TypeMap extends TypeDecl {
+  /**
+   * Type of map keys.  Note that since JSON map keys must always be strings,
+   * this must either be a [TypeReference] for [String], or a [TypeReference]
+   * to a type which is defined in the API as an enum or a synonym for [String].
+   */
+  final TypeReference keyType;
+
+  /**
+   * Type of map values.
+   */
+  final TypeDecl valueType;
+
+  TypeMap(this.keyType, this.valueType, dom.Element html) : super(html);
+
+  accept(ApiVisitor visitor) => visitor.visitTypeMap(this);
+}
+
+/**
  * Type of a JSON object with specified fields, some of which may be optional.
  */
 class TypeObject extends TypeDecl {
   final List<TypeObjectField> fields;
 
   TypeObject(this.fields, dom.Element html) : super(html);
 
   accept(ApiVisitor visitor) => visitor.visitTypeObject(this);
 
   /**
@@ skipping 15 matching lines @@
 class TypeObjectField extends ApiNode {
   final String name;
   final TypeDecl type;
   final bool optional;
 
   /**
    * Value which the field is required to contain, or null if it may vary.
    */
   final Object value;
 
-  TypeObjectField(this.name, this.type, dom.Element html, {this.optional:
-      false, this.value}) : super(html);
+  TypeObjectField(this.name, this.type, dom.Element html, {this.optional: false,
+      this.value})
+      : super(html);
 }
 
 /**
- * Type of a JSON list.
+ * A reference to a type which is either defined elsewhere in the API or which
+ * is built-in ([String], [bool], or [int]).
  */
-class TypeList extends TypeDecl {
-  final TypeDecl itemType;
+class TypeReference extends TypeDecl {
+  final String typeName;
 
-  TypeList(this.itemType, dom.Element html) : super(html);
+  TypeReference(this.typeName, dom.Element html) : super(html) {
+    if (typeName.isEmpty) {
+      throw new Exception('Empty type name');
+    }
+  }
 
-  accept(ApiVisitor visitor) => visitor.visitTypeList(this);
+  accept(ApiVisitor visitor) => visitor.visitTypeReference(this);
 }
 
 /**
- * Type of a JSON map.
+ * A collection of type definitions.
  */
-class TypeMap extends TypeDecl {
-  /**
-   * Type of map keys.  Note that since JSON map keys must always be strings,
-   * this must either be a [TypeReference] for [String], or a [TypeReference]
-   * to a type which is defined in the API as an enum or a synonym for [String].
-   */
-  final TypeReference keyType;
+class Types extends ApiNode with IterableMixin<TypeDefinition> {
+  final Map<String, TypeDefinition> types;
 
-  /**
-   * Type of map values.
-   */
-  final TypeDecl valueType;
+  Types(this.types, dom.Element html) : super(html);
 
-  TypeMap(this.keyType, this.valueType, dom.Element html) : super(html);
+  @override
+  Iterator<TypeDefinition> get iterator => types.values.iterator;
 
-  accept(ApiVisitor visitor) => visitor.visitTypeMap(this);
+  Iterable<String> get keys => types.keys;
+
+  TypeDefinition operator [](String typeName) => types[typeName];
+
+  bool containsKey(String typeName) => types.containsKey(typeName);
 }
 
 /**
- * Type of an enum.  We represent enums in JSON as strings, so this type
- * declaration simply lists the allowed values.
+ * Type which represents a union among multiple choices.
  */
-class TypeEnum extends TypeDecl {
-  final List<TypeEnumValue> values;
+class TypeUnion extends TypeDecl {
+  final List<TypeDecl> choices;
 
-  TypeEnum(this.values, dom.Element html) : super(html);
+  /**
+   * The field that is used to disambiguate this union
+   */
+  final String field;
 
-  accept(ApiVisitor visitor) => visitor.visitTypeEnum(this);
+  TypeUnion(this.choices, this.field, dom.Element html) : super(html);
+
+  accept(ApiVisitor visitor) => visitor.visitTypeUnion(this);
 }
-
-/**
- * Description of a single allowed value for an enum.
- */
-class TypeEnumValue extends ApiNode {
-  final String value;
-
-  TypeEnumValue(this.value, dom.Element html) : super(html);
-}