Extension point for AnalysisResultListener(s).

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/analysis_domain.dart';
 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';
@@ skipping 60 matching lines @@
   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 simple identifier of the extension point that allows plugins to
+   * register analysis result listeners.
+   */
+  static const String SET_ANALISYS_DOMAIN_EXTENSION_POINT = 'setAnalysisDomain';
+
+  /**
    * 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 24 matching lines @@
    * The extension point that allows plugins to register index contributors.
    */
   ExtensionPoint indexContributorExtensionPoint;
 
   /**
    * The extension point that allows plugins to register navigation contributors.
    */
   ExtensionPoint navigationContributorExtensionPoint;
 
   /**
+   * The extension point that allows plugins to get access to the `analysis`
+   * domain.
+   */
+  ExtensionPoint setAnalysisDomainExtensionPoint;
+
+  /**
    * 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 25 matching lines @@
   List<IndexContributor> get indexContributors =>
       indexContributorExtensionPoint.extensions;
 
   /**
    * Return a list containing all of the navigation contributors that were
    * contributed.
    */
   List<NavigationContributor> get navigationContributors =>
       navigationContributorExtensionPoint.extensions;
 
+  /**
+   * Return a list containing all of the receivers of the `analysis` domain
+   * instance.
+   */
+  List<SetAnalysisDomain> get setAnalysisDomainFunctions =>
+      setAnalysisDomainExtensionPoint.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>[];
     }
     return domainExtensionPoint.extensions
         .map((RequestHandlerFactory factory) => factory(server))
         .toList();
   }
 
   @override
   void registerExtensionPoints(RegisterExtensionPoint registerExtensionPoint) {
+    setAnalysisDomainExtensionPoint = registerExtensionPoint(
+        SET_ANALISYS_DOMAIN_EXTENSION_POINT,
+        _validateSetAnalysisDomainFunction);
     analyzeFileExtensionPoint = registerExtensionPoint(
         ANALYZE_FILE_EXTENSION_POINT, _validateAnalyzeFileExtension);
     assistContributorExtensionPoint = registerExtensionPoint(
         ASSIST_CONTRIBUTOR_EXTENSION_POINT,
         _validateAssistContributorExtension);
     completionContributorExtensionPoint = registerExtensionPoint(
         COMPLETION_CONTRIBUTOR_EXTENSION_POINT,
         _validateCompletionContributorExtension);
     domainExtensionPoint = registerExtensionPoint(
         DOMAIN_EXTENSION_POINT, _validateDomainExtension);
@@ skipping 59 matching lines @@
   }
 
   /**
    * Validate the given extension by throwing an [ExtensionError] if it is not a
    * valid assist contributor.
    */
   void _validateAnalyzeFileExtension(Object extension) {
     if (extension is! ShouldAnalyzeFile) {
       String id = analyzeFileExtensionPoint.uniqueIdentifier;
       throw new ExtensionError(
-          'Extensions to $id must be an ShouldAnalyzeFile function');
+          'Extensions to $id must be a ShouldAnalyzeFile function');
     }
   }
 
   /**
    * Validate the given extension by throwing an [ExtensionError] if it is not a
    * valid assist contributor.
    */
   void _validateAssistContributorExtension(Object extension) {
     if (extension is! AssistContributor) {
       String id = assistContributorExtensionPoint.uniqueIdentifier;
@@ skipping 52 matching lines @@
    * 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');
     }
   }
+
+  /**
+   * Validate the given extension by throwing an [ExtensionError] if it is not a
+   * valid analysis domain receiver.
+   */
+  void _validateSetAnalysisDomainFunction(Object extension) {
+    if (extension is! SetAnalysisDomain) {
+      String id = setAnalysisDomainExtensionPoint.uniqueIdentifier;
+      throw new ExtensionError(
+          'Extensions to $id must be a SetAnalysisDomain function');
+    }
+  }
 }