New analyzer snapshot.

pkg/analyzer/lib/src/generated/source.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.
 
 // This code was auto-generated, is not intended to be edited, and is subject to
 // significant change. Please see the README file for more information.
 
 library engine.source;
 
 import 'java_core.dart';
 import 'sdk.dart' show DartSdk;
-import 'engine.dart' show AnalysisContext;
+import 'engine.dart' show AnalysisContext, TimestampedData;
 
 /**
  * Instances of interface `LocalSourcePredicate` are used to determine if the given
  * [Source] is "local" in some sense, so can be updated.
  *
  * @coverage dart.engine.source
  */
 abstract class LocalSourcePredicate {
   /**
    * Instance of [LocalSourcePredicate] that always returns `false`.
@@ skipping 38 matching lines @@
  *
  * @coverage dart.engine.source
  */
 class SourceFactory {
   /**
    * The analysis context that this source factory is associated with.
    */
   AnalysisContext context;
 
   /**
-   * A cache of content used to override the default content of a source.
-   */
-  ContentCache _contentCache;
-
-  /**
    * The resolvers used to resolve absolute URI's.
    */
   List<UriResolver> _resolvers;
 
   /**
    * The predicate to determine is [Source] is local.
    */
-  LocalSourcePredicate _localSourcePredicate;
-
-  /**
-   * Initialize a newly created source factory.
-   *
-   * @param contentCache the cache holding content used to override the default content of a source
-   * @param resolvers the resolvers used to resolve absolute URI's
-   */
-  SourceFactory.con1(ContentCache contentCache, List<UriResolver> resolvers) {
-    this._contentCache = contentCache;
-    this._resolvers = resolvers;
-    this._localSourcePredicate = LocalSourcePredicate.NOT_SDK;
-  }
+  LocalSourcePredicate _localSourcePredicate = LocalSourcePredicate.NOT_SDK;
 
   /**
    * Initialize a newly created source factory.
    *
    * @param resolvers the resolvers used to resolve absolute URI's
    */
-  SourceFactory.con2(List<UriResolver> resolvers) : this.con1(new ContentCache(), resolvers);
+  SourceFactory(List<UriResolver> resolvers) {
+    this._resolvers = resolvers;
+  }
 
   /**
    * Return a source object representing the given absolute URI, or `null` if the URI is not a
    * valid URI or if it is not an absolute URI.
    *
    * @param absoluteUri the absolute URI to be resolved
    * @return a source object representing the absolute URI
    */
   Source forUri(String absoluteUri) {
     try {
@@ skipping 18 matching lines @@
     if (encoding.length < 2) {
       throw new IllegalArgumentException("Invalid encoding length");
     }
     UriKind kind = UriKind.fromEncoding(encoding.codeUnitAt(0));
     if (kind == null) {
       throw new IllegalArgumentException("Invalid source kind in encoding: ${kind}");
     }
     try {
       Uri uri = parseUriWithException(encoding.substring(1));
       for (UriResolver resolver in _resolvers) {
-        Source result = resolver.fromEncoding(_contentCache, kind, uri);
+        Source result = resolver.fromEncoding(kind, uri);
         if (result != null) {
           return result;
         }
       }
       throw new IllegalArgumentException("No resolver for kind: ${kind}");
     } on JavaException catch (exception) {
       throw new IllegalArgumentException("Invalid URI in encoding");
     }
   }
 
   /**
-   * Return a cache of content used to override the default content of a source.
-   *
-   * @return a cache of content used to override the default content of a source
-   */
-  ContentCache get contentCache => _contentCache;
-
-  /**
    * Return the [DartSdk] associated with this [SourceFactory], or `null` if there
    * is no such SDK.
    *
    * @return the [DartSdk] associated with this [SourceFactory], or `null` if
    *         there is no such SDK
    */
   DartSdk get dartSdk {
     for (UriResolver resolver in _resolvers) {
       if (resolver is DartUriResolver) {
         DartUriResolver dartUriResolver = resolver;
@@ skipping 43 matching lines @@
     for (UriResolver resolver in _resolvers) {
       Uri uri = resolver.restoreAbsolute(source);
       if (uri != null) {
         return uri;
       }
     }
     return null;
   }
 
   /**
-   * Set the contents of the given source to the given contents. 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.
-   *
-   * @param source the source whose contents are being overridden
-   * @param contents the new contents of the source
-   * @return the original cached contents or `null` if none
-   */
-  String setContents(Source source, String contents) => _contentCache.setContents(source, contents);
-
-  /**
    * Sets the [LocalSourcePredicate].
    *
    * @param localSourcePredicate the predicate to determine is [Source] is local
    */
   void set localSourcePredicate(LocalSourcePredicate localSourcePredicate) {
     this._localSourcePredicate = localSourcePredicate;
   }
 
   /**
-   * Return the contents of the given source, or `null` if this factory does not override the
-   * contents of the source.
-   *
-   * <b>Note:</b> This method is not intended to be used except by
-   * [FileBasedSource#getContents].
-   *
-   * @param source the source whose content is to be returned
-   * @return the contents of the given source
-   */
-  String getContents(Source source) => _contentCache.getContents(source);
-
-  /**
-   * Return the modification stamp of the given source, or `null` if this factory does not
-   * override the contents of the source.
-   *
-   * <b>Note:</b> This method is not intended to be used except by
-   * [FileBasedSource#getModificationStamp].
-   *
-   * @param source the source whose modification stamp is to be returned
-   * @return the modification stamp of the given source
-   */
-  int getModificationStamp(Source source) => _contentCache.getModificationStamp(source);
-
-  /**
    * Return a source object representing the URI that results from resolving the given (possibly
    * relative) contained URI against the URI associated with an existing source object, or
    * `null` if either the contained URI is invalid or if it cannot be resolved against the
    * source object's URI.
    *
    * @param containingSource the source containing the given URI
    * @param containedUri the (possibly relative) URI to be resolved against the containing source
    * @return the source representing the contained URI
    */
   Source resolveUri2(Source containingSource, Uri containedUri) {
     if (containedUri.isAbsolute) {
       for (UriResolver resolver in _resolvers) {
-        Source result = resolver.resolveAbsolute(_contentCache, containedUri);
+        Source result = resolver.resolveAbsolute(containedUri);
         if (result != null) {
           return result;
         }
       }
       return null;
     } else {
       return containingSource.resolveRelative(containedUri);
     }
   }
 }
 
 /**
  * The abstract class `UriResolver` defines the behavior of objects that are used to resolve
  * URI's for a source factory. Subclasses of this class are expected to resolve a single scheme of
  * absolute URI.
  *
  * @coverage dart.engine.source
  */
 abstract class UriResolver {
   /**
    * If this resolver should be used for URI's of the given kind, resolve the given absolute URI.
    * The URI does not need to have the scheme handled by this resolver if the kind matches. Return a
    * [Source] representing the file to which it was resolved, or `null` if it
    * could not be resolved.
    *
-   * @param contentCache the content cache used to access the contents of the returned source
    * @param kind the kind of URI that was originally resolved in order to produce an encoding with
    *          the given URI
    * @param uri the URI to be resolved
    * @return a [Source] representing the file to which given URI was resolved
    */
-  Source fromEncoding(ContentCache contentCache, UriKind kind, Uri uri);
+  Source fromEncoding(UriKind kind, Uri uri);
 
   /**
    * Resolve the given absolute URI. Return a [Source] representing the file to which
    * it was resolved, or `null` if it could not be resolved.
    *
-   * @param contentCache the content cache used to access the contents of the returned source
    * @param uri the URI to be resolved
    * @return a [Source] representing the file to which given URI was resolved
    */
-  Source resolveAbsolute(ContentCache contentCache, Uri uri);
+  Source resolveAbsolute(Uri uri);
 
   /**
    * Return an absolute URI that represents the given source.
    *
    * @param source the source to get URI for
    * @return the absolute URI representing the given source, may be `null`
    */
   Uri restoreAbsolute(Source source) => null;
 }
 
@@ skipping 16 matching lines @@
    * @param object the object to be compared with this object
    * @return `true` if the given object is a source that represents the same source code as
    *         this source
    * @see Object#equals(Object)
    */
   bool operator ==(Object object);
 
   /**
    * Return `true` if this source exists.
    *
+   * Clients should consider using the the method [AnalysisContext#exists] because
+   * contexts can have local overrides of the content of a source that the source is not aware of
+   * and a source with local content is considered to exist even if there is no file on disk.
+   *
    * @return `true` if this source exists
    */
   bool exists();
 
   /**
-   * Get the contents of this source and pass it to the given receiver. Exactly one of the methods
-   * defined on the receiver will be invoked unless an exception is thrown. The method that will be
-   * invoked depends on which of the possible representations of the contents is the most efficient.
-   * Whichever method is invoked, it will be invoked before this method returns.
+   * Get the contents and timestamp of this source.
+   *
+   * Clients should consider using the the method [AnalysisContext#getContents]
+   * because contexts can have local overrides of the content of a source that the source is not
+   * aware of.
+   *
+   * @return the contents and timestamp of the source
+   * @throws Exception if the contents of this source could not be accessed
+   */
+  TimestampedData<String> get contents;
+
+  /**
+   * Get the contents of this source and pass it to the given content receiver.
+   *
+   * Clients should consider using the the method
+   * [AnalysisContext#getContents] because contexts can have local
+   * overrides of the content of a source that the source is not aware of.
    *
    * @param receiver the content receiver to which the content of this source will be passed
    * @throws Exception if the contents of this source could not be accessed
    */
-  void getContents(Source_ContentReceiver receiver);
+  void getContentsToReceiver(Source_ContentReceiver receiver);
 
   /**
    * Return an encoded representation of this source that can be used to create a source that is
    * equal to this source.
    *
    * @return an encoded representation of this source
    * @see SourceFactory#fromEncoding(String)
    */
   String get encoding;
 
   /**
    * Return the full (long) version of the name that can be displayed to the user to denote this
    * source. For example, for a source representing a file this would typically be the absolute path
    * of the file.
    *
    * @return a name that can be displayed to the user to denote this source
    */
   String get fullName;
 
   /**
    * Return the modification stamp for this source. A modification stamp is a non-negative integer
    * with the property that if the contents of the source have not been modified since the last time
    * the modification stamp was accessed then the same value will be returned, but if the contents
    * of the source have been modified one or more times (even if the net change is zero) the stamps
    * will be different.
    *
+   * Clients should consider using the the method
+   * [AnalysisContext#getModificationStamp] because contexts can have local overrides
+   * of the content of a source that the source is not aware of.
+   *
    * @return the modification stamp for this source
    */
   int get modificationStamp;
 
   /**
    * Return a short version of the name that can be displayed to the user to denote this source. For
    * example, for a source representing a file this would typically be the name of the file.
    *
    * @return a name that can be displayed to the user to denote this source
    */
@@ skipping 324 matching lines @@
   /**
    * Initialize a newly created resolver to resolve Dart URI's against the given platform within the
    * given Dart SDK.
    *
    * @param sdk the Dart SDK against which URI's are to be resolved
    */
   DartUriResolver(DartSdk sdk) {
     this._sdk = sdk;
   }
 
-  Source fromEncoding(ContentCache contentCache, UriKind kind, Uri uri) {
+  Source fromEncoding(UriKind kind, Uri uri) {
     if (identical(kind, UriKind.DART_URI)) {
-      return _sdk.fromEncoding(contentCache, kind, uri);
+      return _sdk.fromEncoding(kind, uri);
     }
     return null;
   }
 
   /**
    * Return the [DartSdk] against which URIs are to be resolved.
    *
    * @return the [DartSdk] against which URIs are to be resolved.
    */
   DartSdk get dartSdk => _sdk;
 
-  Source resolveAbsolute(ContentCache contentCache, Uri uri) {
+  Source resolveAbsolute(Uri uri) {
     if (!isDartUri(uri)) {
       return null;
     }
     return _sdk.mapDartUri(uri.toString());
   }
 }
 
 /**
  * Instances of the class `LineInfo` encapsulate information about line and column information
  * within a source file.
@@ skipping 80 matching lines @@
    * A table mapping sources to the modification stamps of those sources. This is used when the
    * default contents of a source has been overridden.
    */
   Map<Source, int> _stampMap = new Map<Source, int>();
 
   /**
    * Return the contents of the given source, or `null` if this cache does not override the
    * contents of the source.
    *
    * <b>Note:</b> This method is not intended to be used except by
-   * [SourceFactory#getContents].
+   * [AnalysisContext#getContents].
    *
    * @param source the source whose content is to be returned
    * @return the contents of the given source
    */
   String getContents(Source source) => _contentMap[source];
 
   /**
    * Return the modification stamp of the given source, or `null` if this cache does not
    * override the contents of the source.
    *
    * <b>Note:</b> This method is not intended to be used except by
-   * [SourceFactory#getModificationStamp].
+   * [AnalysisContext#getModificationStamp].
    *
    * @param source the source whose modification stamp is to be returned
    * @return the modification stamp of the given source
    */
   int getModificationStamp(Source source) => _stampMap[source];
 
   /**
    * Set the contents of the given source to the given contents. 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.
@@ skipping 11 matching lines @@
       int oldStamp = javaMapPut(_stampMap, source, newStamp);
       // Occasionally, if this method is called in rapid succession, the timestamps are equal.
       // Guard against this by artificially incrementing the new timestamp
       if (newStamp == oldStamp) {
         _stampMap[source] = newStamp + 1;
       }
       return javaMapPut(_contentMap, source, contents);
     }
   }
 }