State-carrying context API.

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 engine;
 
 import 'dart:async';
 import 'dart:collection';
 import 'dart:math' as math;
 
@@ skipping 572 matching lines @@
   /**
    * Return the element model corresponding to the compilation unit defined by
    * the given [unitSource] in the library defined by the given [librarySource],
    * or `null` if the element model does not currently exist or if the library
    * cannot be analyzed for some reason.
    */
   CompilationUnitElement getCompilationUnitElement(
       Source unitSource, Source librarySource);
 
   /**
+   * Return configuration data associated with the given key or `null` if no
+   * state has been associated with the given [key].
+   *
+   * See [setConfigurationData].
+   */
+  Object getConfigurationData(ResultDescriptor key);
+
+  /**
    * Return the contents and timestamp of the given [source].
    *
    * This method should be used rather than the method [Source.getContents]
    * because contexts can have local overrides of the content of a source that
    * the source is not aware of.
    */
   TimestampedData<String> getContents(Source source);
 
   /**
    * Return the element referenced by the given [location], or `null` if the
@@ skipping 276 matching lines @@
 
   /**
    * Set the contents of the given [source] to the given [contents] and mark the
    * source as having changed. The additional [offset] and [length] information
    * is used by the context to determine what reanalysis is necessary.
    */
   void setChangedContents(
       Source source, String contents, int offset, int oldLength, int newLength);
 
   /**
+   * Associate this configuration [data] object with the given descriptor [key].
+   *
+   * See [getConfigurationData].
+   */
+  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
@@ skipping 32 matching lines @@
    */
   final int _id = _NEXT_ID++;
 
   /**
    * A client-provided name used to identify this context, or `null` if the
    * client has not provided a name.
    */
   String name;
 
   /**
+   * Configuration data associated with this context.
+   */
+  final HashMap<ResultDescriptor, Object> _configurationData =
+      new HashMap<ResultDescriptor, Object>();
+
+  /**
    * The set of analysis options controlling the behavior of this context.
    */
   AnalysisOptionsImpl _options = new AnalysisOptionsImpl();
 
   /**
    * A flag indicating whether errors related to implicitly analyzed sources
    * should be generated and reported.
    */
   bool _generateImplicitErrors = true;
 
@@ skipping 982 matching lines @@
       for (CompilationUnitElement partUnit in libraryElement.parts) {
         if (partUnit.source == unitSource) {
           return partUnit;
         }
       }
     }
     return null;
   }
 
   @override
+  Object getConfigurationData(ResultDescriptor key) => _configurationData[key];
+
+  @override
   TimestampedData<String> getContents(Source source) {
     String contents = _contentCache.getContents(source);
     if (contents != null) {
       return new TimestampedData<String>(
           _contentCache.getModificationStamp(source), contents);
     }
     return source.contents;
   }
 
   @override
@@ skipping 676 matching lines @@
   @override
   void setChangedContents(Source source, String contents, int offset,
       int oldLength, int newLength) {
     if (_contentRangeChanged(source, contents, offset, oldLength, newLength)) {
       _onSourcesChangedController.add(new SourcesChangedEvent.changedRange(
           source, contents, offset, oldLength, newLength));
     }
   }
 
   @override
+  void setConfigurationData(ResultDescriptor key, Object data) {
+    _configurationData[key] = data;
+  }
+
+  @override
   void setContents(Source source, String contents) {
     _contentsChanged(source, contents, true);
   }
 
   @override
   bool shouldErrorsBeAnalyzed(Source source, Object entry) {
     DartEntry dartEntry = entry;
     if (source.isInSystemLibrary) {
       return _generateSdkErrors;
     } else if (!dartEntry.explicitlyAdded) {
@@ skipping 9415 matching lines @@
     PendingFuture pendingFuture =
         new PendingFuture<T>(_context, source, computeValue);
     if (!pendingFuture.evaluate(sourceEntry)) {
       _context._pendingFutureSources
           .putIfAbsent(source, () => <PendingFuture>[])
           .add(pendingFuture);
     }
     return pendingFuture.future;
   }
 }