Add a mixin to handle analysis.getNavigation requests

pkg/analyzer_plugin/lib/plugin/navigation_mixin.dart

Index: pkg/analyzer_plugin/lib/plugin/navigation_mixin.dart
diff --git a/pkg/analyzer_plugin/lib/plugin/navigation_mixin.dart b/pkg/analyzer_plugin/lib/plugin/navigation_mixin.dart
new file mode 100644
index 0000000000000000000000000000000000000000..4445fadb85ab1113eb288d2b7dd8b488d6a215e6
--- /dev/null
+++ b/pkg/analyzer_plugin/lib/plugin/navigation_mixin.dart
@@ -0,0 +1,61 @@
+// 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/navigation/navigation.dart';
+import 'package:analyzer_plugin/utilities/generator.dart';
+import 'package:analyzer_plugin/utilities/navigation/navigation.dart';
+
+/**
+ * A mixin that can be used when creating a subclass of [ServerPlugin] to
+ * provide most of the implementation for handling navigation 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 NavigationMixin implements ServerPlugin {
+  /**
+   * Return a list containing the navigation contributors that should be used to
+   * create navigation information when used in the context of the given
+   * analysis [driver].
+   */
+  List<NavigationContributor> getNavigationContributors(
+      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> getResolveResultForNavigation(
+      covariant AnalysisDriverGeneric driver, String path);
+
+  @override
+  Future<AnalysisGetNavigationResult> handleAnalysisGetNavigation(
+      AnalysisGetNavigationParams 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 getResolveResultForNavigation(driver, path);
+    NavigationRequestImpl request = new NavigationRequestImpl(
+        resourceProvider, parameters.offset, parameters.length, analysisResult);
+    NavigationGenerator generator =
+        new NavigationGenerator(getNavigationContributors(driver));
+    GeneratorResult result =
+        await generator.generateNavigationResponse(request);
+    result.sendNotifications(channel);
+    return result.result;
+  }
+}