Rework analyzed files support to use globs

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/plugin/analysis/analysis_domain.dart';
 import 'package:analysis_server/plugin/analysis/analyzed_files.dart';
 import 'package:analysis_server/plugin/analysis/navigation/navigation.dart';
 import 'package:analysis_server/plugin/analysis/navigation/navigation_core.dart';
@@ skipping 13 matching lines @@
 import 'package:analysis_server/src/domain_experimental.dart';
 import 'package:analysis_server/src/domain_server.dart';
 import 'package:analysis_server/src/domains/analysis/navigation_dart.dart';
 import 'package:analysis_server/src/domains/analysis/occurrences_dart.dart';
 import 'package:analysis_server/src/edit/edit_domain.dart';
 import 'package:analysis_server/src/provisional/completion/completion_core.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:analysis_server/src/services/index/index_contributor.dart';
-import 'package:analyzer/file_system/file_system.dart';
 import 'package:analyzer/src/generated/engine.dart';
 import 'package:plugin/plugin.dart';
 
 /**
  * A function that will create a request handler that can be used by the given
  * [server].
  */
 typedef RequestHandler RequestHandlerFactory(AnalysisServer server);
 
 /**
  * A plugin that defines the extension points and extensions that are inherently
  * defined by the analysis server.
  */
 class ServerPlugin implements Plugin {
   /**
    * The simple identifier of the extension point that allows plugins to
-   * register functions that can cause files to be analyzed.
+   * register file patterns that will cause files to be analyzed.
    */
-  static const String ANALYZE_FILE_EXTENSION_POINT = 'analyzeFile';
+  static const String ANALYZED_FILE_PATTERNS_EXTENSION_POINT =
+      'analyzedFilePatterns';
 
   /**
    * The simple identifier of the extension point that allows plugins to
    * register assist contributors.
    */
   static const String ASSIST_CONTRIBUTOR_EXTENSION_POINT = 'assistContributor';
 
   /**
    * The simple identifier of the extension point that allows plugins to
    * register completion contributors.
@@ skipping 38 matching lines @@
    * 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
+   * The extension point that allows plugins to register file patterns that will
    * cause files to be analyzed.
    */
-  ExtensionPoint analyzeFileExtensionPoint;
+  ExtensionPoint analyzedFilePatternsExtensionPoint;
 
   /**
    * The extension point that allows plugins to register assist contributors.
    */
   ExtensionPoint assistContributorExtensionPoint;
 
   /**
    * The extension point that allows plugins to register completion
    * contributors.
    */
@@ skipping 33 matching lines @@
    * domain.
    */
   ExtensionPoint setAnalysisDomainExtensionPoint;
 
   /**
    * Initialize a newly created plugin.
    */
   ServerPlugin();
 
   /**
-   * Return a list containing all of the functions that can cause files to be
-   * analyzed.
+   * Return a list containing all of the file patterns that can cause files to
+   * be analyzed.
    */
-  List<ShouldAnalyzeFile> get analyzeFileFunctions =>
-      analyzeFileExtensionPoint.extensions;
+  List<String> get analyzedFilePatterns {
+    List<String> patterns = <String>[];
+    for (List<String> extension
+        in analyzedFilePatternsExtensionPoint.extensions) {
+      patterns.addAll(extension);
+    }
+    return patterns;
+  }
 
   /**
    * Return a list containing all of the assist contributors that were
    * contributed.
    */
   List<AssistContributor> get assistContributors =>
       assistContributorExtensionPoint.extensions;
 
   /**
    * Return a list containing all of the completion contributors that were
@@ skipping 50 matching lines @@
     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);
+    analyzedFilePatternsExtensionPoint = registerExtensionPoint(
+        ANALYZED_FILE_PATTERNS_EXTENSION_POINT,
+        _validateAnalyzedFilePatternsExtension);
     assistContributorExtensionPoint = registerExtensionPoint(
         ASSIST_CONTRIBUTOR_EXTENSION_POINT,
         _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);
     occurrencesContributorExtensionPoint = registerExtensionPoint(
         OCCURRENCES_CONTRIBUTOR_EXTENSION_POINT,
         _validateOccurrencesContributorExtension);
   }
 
   @override
   void registerExtensions(RegisterExtension registerExtension) {
     //
-    // Register analyze file functions.
+    // Register analyzed file patterns.
     //
-    registerExtension(
-        ANALYZE_FILE_EXTENSION_POINT_ID,
-        (File file) => AnalysisEngine.isDartFileName(file.path) ||
-            AnalysisEngine.isHtmlFileName(file.path) ||
-            AnalysisEngine.isAnalysisOptionsFileName(file.path));
+    List<String> patterns = <String>[];
+    for (String extension in [
+      AnalysisEngine.SUFFIX_DART,
+      AnalysisEngine.SUFFIX_HTML,
+      AnalysisEngine.SUFFIX_HTM
+    ]) {
+      patterns.add('**/*.$extension');
+      patterns.add('/**/*.$extension');

[scheglov, 2015/11/02 16:27:49]

Do we need two globs?
Wouldn't just one "/**/.*$extension" work for absolute paths?
Does it work on Windows?

[Brian Wilkerson, 2015/11/02 16:54:38]

Yes, I forgot that we always have an absolute path.
According to the README for the glob package, yes. Globs are always specified
using a POSIX notation but will work on Windows if you pass the right path
context in when you create it (which I also forgot to do).

+    }
+    patterns.add('**/${AnalysisEngine.ANALYSIS_OPTIONS_FILE}');
+    patterns.add('/**/${AnalysisEngine.ANALYSIS_OPTIONS_FILE}');
+    registerExtension(ANALYZED_FILE_PATTERNS_EXTENSION_POINT_ID, patterns);
     //
     // 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, ???);
@@ skipping 25 matching lines @@
     //
     // Register fix contributors.
     //
     registerExtension(
         FIX_CONTRIBUTOR_EXTENSION_POINT_ID, new DefaultFixContributor());
     //
     // Register index contributors.
     //
     registerExtension(
         INDEX_CONTRIBUTOR_EXTENSION_POINT_ID, new DartIndexContributor());
+  }
 
+  /**
+   * Return `true` if the list being used as an [extension] contains any
+   * elements that are not strings.
+   */
+  bool _containsNonString(List extension) {
+    for (Object element in extension) {
+      if (element is! String) {
+        return true;
+      }
+    }
+    return false;
   }
 
   /**
    * Validate the given extension by throwing an [ExtensionError] if it is not a
-   * valid assist contributor.
+   * valid list of analyzed file patterns.
    */
-  void _validateAnalyzeFileExtension(Object extension) {
-    if (extension is! ShouldAnalyzeFile) {
-      String id = analyzeFileExtensionPoint.uniqueIdentifier;
-      throw new ExtensionError(
-          'Extensions to $id must be a ShouldAnalyzeFile function');
+  void _validateAnalyzedFilePatternsExtension(Object extension) {
+    if (extension is! List || _containsNonString(extension)) {
+      String id = analyzedFilePatternsExtensionPoint.uniqueIdentifier;
+      throw new ExtensionError('Extensions to $id must be a List of Strings');
     }
   }
 
   /**
    * 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 77 matching lines @@
    * 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');
     }
   }
 }