Validate cache consistency asynchronously. Compute modification times of physical files in a separa…

pkg/analyzer/lib/src/generated/engine.dart

 // Copyright (c) 2014, 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.generated.engine;
 
 import 'dart:async';
 import 'dart:collection';
 
 import 'package:analyzer/dart/ast/ast.dart';
@@ skipping 611 matching lines @@
    */
   void setConfigurationData(ResultDescriptor key, Object data);
 
   /**
    * Set the contents of the given [source] to the given [contents] and mark the
    * source as having changed. This has the effect of overriding the default
    * contents of the source. If the contents are `null` the override is removed
    * so that the default contents will be returned.
    */
   void setContents(Source source, String contents);
-
-  /**
-   * Check the cache for any invalid entries (entries whose modification time
-   * does not match the modification time of the source associated with the
-   * entry). Invalid entries will be marked as invalid so that the source will
-   * be re-analyzed. Return `true` if at least one entry was invalid.
-   */
-  bool validateCacheConsistency();
 }
 
 /**
  * A representation of changes to the types of analysis that should be
  * performed.
  */
 class AnalysisDelta {
   /**
    * A mapping from source to what type of analysis should be performed on that
    * source.
@@ skipping 915 matching lines @@
 
   /**
    * Number of sources which were deleted, but the context was not notified
    * about it, so this fact was detected only during cache consistency
    * validation.
    */
   int numOfDeleted = 0;
 }
 
 /**
+ * Interface for cache consistency validation in an [InternalAnalysisContext].
+ */
+abstract class CacheConsistencyValidator {
+  /**
+   * Return sources for which the contexts needs to know modification times.
+   */
+  List<Source> getSourcesToComputeModificationTimes();
+
+  /**
+   * Notify the validator that modification [times] were computed for [sources].
+   * If a source does not exist, its modification time is `-1`.
+   *
+   * It's up to the validator and the context how to use this information,
+   * the list of sources the context has might have been changed since the
+   * previous invocation of [getSourcesToComputeModificationTimes].
+   *
+   * Check the cache for any invalid entries (entries whose modification time
+   * does not match the modification time of the source associated with the
+   * entry). Invalid entries will be marked as invalid so that the source will
+   * be re-analyzed. Return `true` if at least one entry was invalid.
+   */
+  bool sourceModificationTimesComputed(List<Source> sources, List<int> times);
+}
+
+/**
  * The possible states of cached data.
  */
 class CacheState extends Enum<CacheState> {
   /**
    * The data is not in the cache and the last time an attempt was made to
    * compute the data an exception occurred, making it pointless to attempt to
    * compute the data again.
    *
    * Valid Transitions:
    * * [INVALID] if a source was modified that might cause the data to be
@@ skipping 464 matching lines @@
    */
   ResultProvider resultProvider;
 
   /**
    * A table mapping the sources known to the context to the information known
    * about the source.
    */
   AnalysisCache get analysisCache;
 
   /**
+   * The cache consistency validator for this context.
+   */
+  CacheConsistencyValidator get cacheConsistencyValidator;
+
+  /**
    * Allow the client to supply its own content cache.  This will take the
    * place of the content cache created by default, allowing clients to share
    * the content cache between contexts.
    */
   set contentCache(ContentCache value);
 
   /**
    * Get the [EmbedderYamlLocator] for this context.
    */
   @deprecated
@@ skipping 622 matching lines @@
    * The data that was created from the source.
    */
   final E data;
 
   /**
    * Initialize a newly created holder to associate the given [data] with the
    * given [modificationTime].
    */
   TimestampedData(this.modificationTime, this.data);
 }