Index: pkg/analyzer_plugin/lib/plugin/assist_mixin.dart |
diff --git a/pkg/analyzer_plugin/lib/plugin/assist_mixin.dart b/pkg/analyzer_plugin/lib/plugin/assist_mixin.dart |
new file mode 100644 |
index 0000000000000000000000000000000000000000..5eb3e7a841e7a992d48c9b2f276ded67e691a083 |
--- /dev/null |
+++ b/pkg/analyzer_plugin/lib/plugin/assist_mixin.dart |
@@ -0,0 +1,59 @@ |
+// Copyright (c) 2017, 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. |
+ |
+import 'dart:async'; |
+ |
+import 'package:analyzer/dart/analysis/results.dart'; |
+import 'package:analyzer/src/dart/analysis/driver.dart'; |
+import 'package:analyzer_plugin/plugin/plugin.dart'; |
+import 'package:analyzer_plugin/protocol/protocol.dart'; |
+import 'package:analyzer_plugin/protocol/protocol_generated.dart'; |
+import 'package:analyzer_plugin/src/utilities/assist/assist.dart'; |
+import 'package:analyzer_plugin/utilities/assist/assist.dart'; |
+import 'package:analyzer_plugin/utilities/generator.dart'; |
+ |
+/** |
+ * A mixin that can be used when creating a subclass of [ServerPlugin] to |
+ * provide most of the implementation for handling assist requests. |
+ * |
+ * Clients may not extend or implement this class, but are allowed to use it as |
+ * a mix-in when creating a subclass of [ServerPlugin]. |
+ */ |
+abstract class AssistsMixin implements ServerPlugin { |
+ /** |
+ * Return a list containing the assist contributors that should be used to |
+ * create assists when used in the context of the given analysis [driver]. |
+ */ |
+ List<AssistContributor> getAssistContributors( |
+ covariant AnalysisDriverGeneric driver); |
+ |
+ /** |
+ * Return the result of using the given analysis [driver] to produce a fully |
+ * resolved AST for the file with the given [path]. |
+ */ |
+ Future<ResolveResult> getResolveResultForAssists( |
+ covariant AnalysisDriverGeneric driver, String path); |
+ |
+ @override |
+ Future<EditGetAssistsResult> handleEditGetAssists( |
+ EditGetAssistsParams parameters) async { |
+ String path = parameters.file; |
+ ContextRoot contextRoot = contextRootContaining(path); |
+ if (contextRoot == null) { |
+ // Return an error from the request. |
+ throw new RequestFailure( |
+ RequestErrorFactory.pluginError('Failed to analyze $path', null)); |
+ } |
+ AnalysisDriverGeneric driver = driverMap[contextRoot]; |
+ ResolveResult analysisResult = |
+ await getResolveResultForAssists(driver, path); |
+ AssistRequestImpl request = new AssistRequestImpl( |
+ resourceProvider, parameters.offset, parameters.length, analysisResult); |
+ AssistGenerator generator = |
+ new AssistGenerator(getAssistContributors(driver)); |
+ GeneratorResult result = await generator.generateAssistsResponse(request); |
+ result.sendNotifications(channel); |
+ return result.result; |
+ } |
+} |