Add hook for listening to implicitly analyzed files

pkg/analyzer/lib/src/context/context.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 analyzer.src.context.context;
 
 import 'dart:async';
 import 'dart:collection';
 
 import 'package:analyzer/instrumentation/instrumentation.dart';
@@ skipping 149 matching lines @@
    * The [TypeProvider] for this context, `null` if not yet created.
    */
   TypeProvider _typeProvider;
 
   /**
    * The controller for sending [SourcesChangedEvent]s.
    */
   StreamController<SourcesChangedEvent> _onSourcesChangedController;
 
   /**
+   * A subscription for a stream of events indicating when files are (and are
+   * not) being implicitly analyzed.
+   */
+  StreamController<AnalyzedSourcesEvent> _analyzedSourcesController;

[Paul Berry, 2015/07/15 19:50:01]

How about naming this "_implicitlyAnalyzedSourcesController", just so that
there's no confusion about explicit vs. implicit sources.

+
+  /**
    * The listeners that are to be notified when various analysis results are
    * produced in this context.
    */
   List<AnalysisListener> _listeners = new List<AnalysisListener>();
 
   /**
    * The most recently incrementally resolved source, or `null` when it was
    * already validated, or the most recent change was not incrementally resolved.
    */
   Source incrementalResolutionValidation_lastUnitSource;
@@ skipping 33 matching lines @@
     _privatePartition = new UniversalCachePartition(this);
     _cache = createCacheFromSourceFactory(null);
     _taskManager = AnalysisEngine.instance.taskManager;
     // TODO(scheglov) Get WorkManager(Factory)(s) from plugins.
     dartWorkManager = new DartWorkManager(this);
     htmlWorkManager = new HtmlWorkManager(this);
     driver = new AnalysisDriver(
         _taskManager, <WorkManager>[dartWorkManager, htmlWorkManager], this);
     _onSourcesChangedController =
         new StreamController<SourcesChangedEvent>.broadcast();
+    _analyzedSourcesController =
+        new StreamController<AnalyzedSourcesEvent>.broadcast();
   }
 
   @override
   AnalysisCache get analysisCache => _cache;
 
   @override
   AnalysisOptions get analysisOptions => _options;
 
   @override
   void set analysisOptions(AnalysisOptions options) {
@@ skipping 41 matching lines @@
         _priorityOrder = Source.EMPTY_LIST;
       } else {
         _priorityOrder = sources;
       }
     }
     dartWorkManager.applyPriorityTargets(_priorityOrder);
     htmlWorkManager.applyPriorityTargets(_priorityOrder);
   }
 
   @override
+  Stream<AnalyzedSourcesEvent> get analyzedSources =>
+      _analyzedSourcesController.stream;
+
+  @override
   set contentCache(ContentCache value) {
     _contentCache = value;
   }
 
   @override
   DeclaredVariables get declaredVariables => _declaredVariables;
 
   @override
   List<AnalysisTarget> get explicitTargets {
     List<AnalysisTarget> targets = <AnalysisTarget>[];
@@ skipping 427 matching lines @@
 
   @override
   CacheEntry getCacheEntry(AnalysisTarget target) {
     CacheEntry entry = _cache.get(target);
     if (entry == null) {
       entry = new CacheEntry(target);
       if (target is Source) {
         entry.modificationTime = getModificationStamp(target);
       }
       _cache.put(entry);
+      if (target is Source) {
+        _analyzedSourcesController.add(new AnalyzedSourcesEvent(target, true));
+      }
     }
     return entry;
   }
 
   @override
   CompilationUnitElement getCompilationUnitElement(
       Source unitSource, Source librarySource) {
     AnalysisTarget target = new LibrarySpecificUnit(librarySource, unitSource);
     return _cache.getValue(target, COMPILATION_UNIT_ELEMENT);
   }
@@ skipping 471 matching lines @@
         }
       }
     }
     for (Source source in changedSources) {
       _sourceChanged(source);
     }
     int removalCount = 0;
     for (Source source in missingSources) {
       if (getLibrariesContaining(source).isEmpty &&
           getLibrariesDependingOn(source).isEmpty) {
-        _cache.remove(source);
+        _removeFromCache(source);
         removalCount++;
       }
     }
     int consistencyCheckEnd = JavaSystem.nanoTime();
     if (changedSources.length > 0 || missingSources.length > 0) {
       StringBuffer buffer = new StringBuffer();
       buffer.write("Consistency check took ");
       buffer.write((consistencyCheckEnd - consistencyCheckStart) / 1000000.0);
       buffer.writeln(" ms and found");
       buffer.write("  ");
@@ skipping 187 matching lines @@
   /**
    * Create a cache entry for the given [source]. The source was explicitly
    * added to this context if [explicitlyAdded] is `true`. Return the cache
    * entry that was created.
    */
   CacheEntry _createCacheEntry(Source source, bool explicitlyAdded) {
     CacheEntry entry = new CacheEntry(source);
     entry.modificationTime = getModificationStamp(source);
     entry.explicitlyAdded = explicitlyAdded;
     _cache.put(entry);
+    if (!explicitlyAdded) {
+      _analyzedSourcesController.add(new AnalyzedSourcesEvent(source, true));
+    }
     return entry;
   }
 
   /**
    * Return a list containing all of the cache entries for targets associated
    * with the given [source].
    */
   List<CacheEntry> _entriesFor(Source source) {
     List<CacheEntry> entries = <CacheEntry>[];
     MapIterator<AnalysisTarget, CacheEntry> iterator = _cache.iterator();
@@ skipping 190 matching lines @@
    * given [source] has been updated to the given [errors].
    */
   void _notifyErrors(
       Source source, List<AnalysisError> errors, LineInfo lineInfo) {
     int count = _listeners.length;
     for (int i = 0; i < count; i++) {
       _listeners[i].computedErrors(this, source, errors, lineInfo);
     }
   }
 
+  void _removeFromCache(Source source) {
+    CacheEntry entry = _cache.remove(source);
+    if (entry != null && entry.explicitlyAdded) {
+      _analyzedSourcesController.add(new AnalyzedSourcesEvent(source, false));
+    }
+  }
+
   /**
    * Remove the given [source] from the priority order if it is in the list.
    */
   void _removeFromPriorityOrder(Source source) {
     int count = _priorityOrder.length;
     List<Source> newOrder = <Source>[];
     for (int i = 0; i < count; i++) {
       if (_priorityOrder[i] != source) {
         newOrder.add(_priorityOrder[i]);
       }
@@ skipping 112 matching lines @@
 //          new AnalysisException("This source was marked as being deleted"),
 //          null));
 //    }
     _removeFromPriorityOrder(source);
   }
 
   /**
    * Record that the given [source] has been removed.
    */
   void _sourceRemoved(Source source) {
-    _cache.remove(source);
+    _removeFromCache(source);
     _removeFromPriorityOrder(source);
   }
 
   /**
    * TODO(scheglov) A hackish, limited incremental resolution implementation.
    */
   bool _tryPoorMansIncrementalResolution(Source unitSource, String newCode) {
     return PerformanceStatistics.incrementalAnalysis.makeCurrentWhile(() {
       incrementalResolutionValidation_lastUnitSource = null;
       incrementalResolutionValidation_lastLibrarySource = null;
@@ skipping 239 matching lines @@
         new PendingFuture<T>(_context, target, computeValue);
     if (!pendingFuture.evaluate(entry)) {
       _context._pendingFutureTargets
           .putIfAbsent(target, () => <PendingFuture>[])
           .add(pendingFuture);
       scheduleComputation();
     }
     return pendingFuture.future;
   }
 }