Create a public API for contributing fixes and make fixes pluggable

pkg/analysis_server/lib/src/services/correction/fix.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 services.correction.fix;
+library analysis_server.src.services.correction.fix;
 
-import 'package:analysis_server/src/protocol.dart' show SourceChange;
-import 'package:analysis_server/src/services/correction/fix_internal.dart';
-import 'package:analyzer/src/generated/ast.dart';
+import 'package:analysis_server/edit/fix/fix_core.dart';
+import 'package:analysis_server/src/plugin/server_plugin.dart';
+import 'package:analyzer/src/generated/engine.dart';
 import 'package:analyzer/src/generated/error.dart';
+import 'package:analyzer/src/generated/java_engine.dart';
 
 /**
- * Computes [Fix]s for the given [AnalysisError].
- *
- * Returns the computed [Fix]s, not `null`.
+ * Compute and return the fixes available for the given [error]. The error was
+ * reported after it's source was analyzed in the given [context]. The [plugin]
+ * is used to get the list of fix contributors.
  */
-List<Fix> computeFixes(CompilationUnit unit, AnalysisError error) {
-  var processor = new FixProcessor(unit, error);
-  List<Fix> fixes = processor.compute();
-  fixes.sort((Fix a, Fix b) {
-    return a.kind.relevance - b.kind.relevance;
-  });
+List<Fix> computeFixes(
+    ServerPlugin plugin, AnalysisContext context, AnalysisError error) {
+  List<Fix> fixes = <Fix>[];
+  List<FixContributor> contributors = plugin.fixContributors();
+  for (FixContributor contributor in contributors) {
+    try {
+      List<Fix> contributedFixes = contributor.computeFixes(context, error);
+      if (contributedFixes != null) {
+        fixes.addAll(contributedFixes);
+      }
+    } catch (exception, stackTrace) {
+      AnalysisEngine.instance.logger.logError(
+          'Exception from fix contributor: ${contributor.runtimeType}',
+          new CaughtException(exception, stackTrace));
+    }
+  }
+  fixes.sort(Fix.SORT_BY_RELEVANCE);
   return fixes;
 }
 
 /**
- * A description of a single proposed fix for some problem.
- */
-class Fix {
-  final FixKind kind;
-  final SourceChange change;
-
-  Fix(this.kind, this.change);
-
-  @override
-  String toString() {
-    return '[kind=$kind, change=$change]';
-  }
-}
-
-/**
  * An enumeration of possible quick fix kinds.
  */
-class FixKind {
+class DartFixKind {
   static const ADD_ASYNC =
       const FixKind('ADD_ASYNC', 50, "Add 'async' modifier");
   static const ADD_FIELD_FORMAL_PARAMETERS = const FixKind(
       'ADD_FIELD_FORMAL_PARAMETERS', 30, "Add final field formal parameters");
   static const ADD_PACKAGE_DEPENDENCY = const FixKind(
       'ADD_PACKAGE_DEPENDENCY', 50, "Add dependency on package '{0}'");
   static const ADD_SUPER_CONSTRUCTOR_INVOCATION = const FixKind(
       'ADD_SUPER_CONSTRUCTOR_INVOCATION', 50,
       "Add super constructor {0} invocation");
   static const CHANGE_TO = const FixKind('CHANGE_TO', 49, "Change to '{0}'");
@@ skipping 37 matching lines @@
   static const MAKE_CLASS_ABSTRACT =
       const FixKind('MAKE_CLASS_ABSTRACT', 50, "Make class '{0}' abstract");
   static const REMOVE_PARAMETERS_IN_GETTER_DECLARATION = const FixKind(
       'REMOVE_PARAMETERS_IN_GETTER_DECLARATION', 50,
       "Remove parameters in getter declaration");
   static const REMOVE_PARENTHESIS_IN_GETTER_INVOCATION = const FixKind(
       'REMOVE_PARENTHESIS_IN_GETTER_INVOCATION', 50,
       "Remove parentheses in getter invocation");
   static const REMOVE_UNNECASSARY_CAST =
       const FixKind('REMOVE_UNNECASSARY_CAST', 50, "Remove unnecessary cast");
-  static const REMOVE_UNUSED_CATCH_CLAUSE = const FixKind(
-      'REMOVE_UNUSED_CATCH', 50, "Remove unused 'catch' clause");
+  static const REMOVE_UNUSED_CATCH_CLAUSE =
+      const FixKind('REMOVE_UNUSED_CATCH', 50, "Remove unused 'catch' clause");
   static const REMOVE_UNUSED_CATCH_STACK = const FixKind(
       'REMOVE_UNUSED_CATCH_STACK', 50, "Remove unused stack trace variable");
   static const REMOVE_UNUSED_IMPORT =
       const FixKind('REMOVE_UNUSED_IMPORT', 50, "Remove unused import");
   static const REPLACE_BOOLEAN_WITH_BOOL = const FixKind(
       'REPLACE_BOOLEAN_WITH_BOOL', 50, "Replace 'boolean' with 'bool'");
   static const REPLACE_IMPORT_URI =
       const FixKind('REPLACE_IMPORT_URI', 50, "Replace with '{0}'");
   static const REPLACE_VAR_WITH_DYNAMIC = const FixKind(
       'REPLACE_VAR_WITH_DYNAMIC', 50, "Replace 'var' with 'dynamic'");
   static const REPLACE_RETURN_TYPE_FUTURE = const FixKind(
       'REPLACE_RETURN_TYPE_FUTURE', 50,
       "Return 'Future' from 'async' function");
   static const USE_CONST = const FixKind('USE_CONST', 50, "Change to constant");
   static const USE_EFFECTIVE_INTEGER_DIVISION = const FixKind(
       'USE_EFFECTIVE_INTEGER_DIVISION', 50,
       "Use effective integer division ~/");
   static const USE_EQ_EQ_NULL =
       const FixKind('USE_EQ_EQ_NULL', 50, "Use == null instead of 'is Null'");
   static const USE_NOT_EQ_NULL =
       const FixKind('USE_NOT_EQ_NULL', 50, "Use != null instead of 'is! Null'");
-
-  final name;
-  final int relevance;
-  final String message;
-
-  const FixKind(this.name, this.relevance, this.message);
-
-  @override
-  String toString() => name;
 }