Navigation extension point.

pkg/analysis_server/lib/src/plugin/server_plugin.dart

 // Copyright (c) 2015, 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 analysis_server.src.plugin.server_plugin;
 
 import 'package:analysis_server/analysis/index/index_core.dart';
+import 'package:analysis_server/analysis/navigation/navigation_core.dart';
 import 'package:analysis_server/completion/completion_core.dart';
 import 'package:analysis_server/edit/assist/assist_core.dart';
 import 'package:analysis_server/edit/fix/fix_core.dart';
 import 'package:analysis_server/plugin/analyzed_files.dart';
 import 'package:analysis_server/plugin/assist.dart';
 import 'package:analysis_server/plugin/fix.dart';
+import 'package:analysis_server/plugin/navigation.dart';
 import 'package:analysis_server/src/analysis_server.dart';
 import 'package:analysis_server/src/domain_analysis.dart';
 import 'package:analysis_server/src/domain_completion.dart';
 import 'package:analysis_server/src/domain_execution.dart';
 import 'package:analysis_server/src/domain_server.dart';
+import 'package:analysis_server/src/domains/analysis/navigation_dart.dart';
 import 'package:analysis_server/src/edit/edit_domain.dart';
 import 'package:analysis_server/src/protocol.dart';
 import 'package:analysis_server/src/search/search_domain.dart';
 import 'package:analysis_server/src/services/correction/assist_internal.dart';
 import 'package:analysis_server/src/services/correction/fix_internal.dart';
 import 'package:analyzer/file_system/file_system.dart';
 import 'package:analyzer/src/generated/engine.dart';
 import 'package:plugin/plugin.dart';
 
 /**
@@ skipping 38 matching lines @@
    */
   static const String FIX_CONTRIBUTOR_EXTENSION_POINT = 'fixContributor';
 
   /**
    * The simple identifier of the extension point that allows plugins to
    * register index contributors.
    */
   static const String INDEX_CONTRIBUTOR_EXTENSION_POINT = 'indexContributor';
 
   /**
+   * The simple identifier of the extension point that allows plugins to
+   * register navigation contributors.
+   */
+  static const String NAVIGATION_CONTRIBUTOR_EXTENSION_POINT =
+      'navigationContributor';
+
+  /**
    * The unique identifier of this plugin.
    */
   static const String UNIQUE_IDENTIFIER = 'analysis_server.core';
 
   /**
    * The extension point that allows plugins to register functions that can
    * cause files to be analyzed.
    */
   ExtensionPoint analyzeFileExtensionPoint;
 
@@ skipping 19 matching lines @@
    * the server.
    */
   ExtensionPoint fixContributorExtensionPoint;
 
   /**
    * The extension point that allows plugins to register index contributors.
    */
   ExtensionPoint indexContributorExtensionPoint;
 
   /**
+   * The extension point that allows plugins to register navigation contributors.
+   */
+  ExtensionPoint navigationContributorExtensionPoint;
+
+  /**
    * Initialize a newly created plugin.
    */
   ServerPlugin();
 
   /**
    * Return a list containing all of the functions that can cause files to be
    * analyzed.
    */
   List<ShouldAnalyzeFile> get analyzeFileFunctions =>
       analyzeFileExtensionPoint.extensions;
@@ skipping 18 matching lines @@
   List<FixContributor> get fixContributors =>
       fixContributorExtensionPoint.extensions;
 
   /**
    * Return a list containing all of the index contributors that were
    * contributed.
    */
   List<IndexContributor> get indexContributors =>
       indexContributorExtensionPoint.extensions;
 
+  /**
+   * Return a list containing all of the navigation contributors that were
+   * contributed.
+   */
+  List<NavigationContributor> get navigationContributors =>
+      navigationContributorExtensionPoint.extensions;
+
   @override
   String get uniqueIdentifier => UNIQUE_IDENTIFIER;
 
   /**
    * Use the given [server] to create all of the domains ([RequestHandler]'s)
    * that have been registered and return the newly created domains.
    */
   List<RequestHandler> createDomains(AnalysisServer server) {
     if (domainExtensionPoint == null) {
       return <RequestHandler>[];
@@ skipping 12 matching lines @@
         _validateAssistContributorExtension);
     completionContributorExtensionPoint = registerExtensionPoint(
         COMPLETION_CONTRIBUTOR_EXTENSION_POINT,
         _validateCompletionContributorExtension);
     domainExtensionPoint = registerExtensionPoint(
         DOMAIN_EXTENSION_POINT, _validateDomainExtension);
     fixContributorExtensionPoint = registerExtensionPoint(
         FIX_CONTRIBUTOR_EXTENSION_POINT, _validateFixContributorExtension);
     indexContributorExtensionPoint = registerExtensionPoint(
         INDEX_CONTRIBUTOR_EXTENSION_POINT, _validateIndexContributorExtension);
+    navigationContributorExtensionPoint = registerExtensionPoint(
+        NAVIGATION_CONTRIBUTOR_EXTENSION_POINT,
+        _validateNavigationContributorExtension);
   }
 
   @override
   void registerExtensions(RegisterExtension registerExtension) {
     //
     // Register analyze file functions.
     //
-    registerExtension(ANALYZE_FILE_EXTENSION_POINT_ID,
+    registerExtension(
+        ANALYZE_FILE_EXTENSION_POINT_ID,
         (File file) => AnalysisEngine.isDartFileName(file.path) ||
             AnalysisEngine.isHtmlFileName(file.path));
     //
     // Register assist contributors.
     //
     registerExtension(
         ASSIST_CONTRIBUTOR_EXTENSION_POINT_ID, new DefaultAssistContributor());
     //
     // Register completion contributors.
     //
     // TODO(brianwilkerson) Register the completion contributors.
 //    registerExtension(COMPLETION_CONTRIBUTOR_EXTENSION_POINT_ID, ???);
     //
+    // Register navigation contributors.
+    //
+    registerExtension(NAVIGATION_CONTRIBUTOR_EXTENSION_POINT_ID,
+        new DartNavigationComputer());
+    //
     // Register domains.
     //
     String domainId = Plugin.join(UNIQUE_IDENTIFIER, DOMAIN_EXTENSION_POINT);
     registerExtension(
         domainId, (AnalysisServer server) => new ServerDomainHandler(server));
     registerExtension(
         domainId, (AnalysisServer server) => new AnalysisDomainHandler(server));
     registerExtension(
         domainId, (AnalysisServer server) => new EditDomainHandler(server));
     registerExtension(
@@ skipping 76 matching lines @@
   /**
    * Validate the given extension by throwing an [ExtensionError] if it is not a
    * valid index contributor.
    */
   void _validateIndexContributorExtension(Object extension) {
     if (extension is! IndexContributor) {
       String id = indexContributorExtensionPoint.uniqueIdentifier;
       throw new ExtensionError('Extensions to $id must be an IndexContributor');
     }
   }
+
+  /**
+   * Validate the given extension by throwing an [ExtensionError] if it is not a
+   * valid navigation contributor.
+   */
+  void _validateNavigationContributorExtension(Object extension) {
+    if (extension is! NavigationContributor) {
+      String id = navigationContributorExtensionPoint.uniqueIdentifier;
+      throw new ExtensionError(
+          'Extensions to $id must be an NavigationContributor');
+    }
+  }
 }