Add result interfaces used by AnalysisSession

pkg/analyzer/lib/src/dart/analysis/driver.dart

 // Copyright (c) 2016, 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.
 
 import 'dart:async';
 import 'dart:collection';
 import 'dart:typed_data';
 
 import 'package:analyzer/context/context_root.dart';
 import 'package:analyzer/context/declared_variables.dart';
+import 'package:analyzer/dart/analysis/results.dart' as results;
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/element/element.dart'
     show CompilationUnitElement, LibraryElement;
 import 'package:analyzer/error/error.dart';
 import 'package:analyzer/error/listener.dart';
 import 'package:analyzer/exception/exception.dart';
 import 'package:analyzer/file_system/file_system.dart';
 import 'package:analyzer/src/dart/analysis/file_state.dart';
 import 'package:analyzer/src/dart/analysis/file_tracker.dart';
 import 'package:analyzer/src/dart/analysis/index.dart';
@@ skipping 1030 matching lines @@
     FileState library = file.library ?? file;
 
     // Create the AnalysisContext to resynthesize elements in.
     LibraryContext libraryContext = _createLibraryContext(library);
 
     // Resynthesize the CompilationUnitElement in the context.
     try {
       CompilationUnitElement element =
           libraryContext.computeUnitElement(library.source, file.source);
       String signature = library.transitiveSignature;
-      return new UnitElementResult(path, signature, element);
+      return new UnitElementResult(path, file.uri, signature, element);
     } finally {
       libraryContext.dispose();
     }
   }
 
   String _computeUnitElementSignature(String path) {
     FileState file = _fsState.getFileForPath(path);
     FileState library = file.library ?? file;
     return library.transitiveSignature;
   }
@@ skipping 511 matching lines @@
  * The result of analyzing of a single file.
  *
  * These results are self-consistent, i.e. [content], [contentHash], the
  * resolved [unit] correspond to each other. All referenced elements, even
  * external ones, are also self-consistent. But none of the results is
  * guaranteed to be consistent with the state of the files.
  *
  * Every result is independent, and is not guaranteed to be consistent with
  * any previously returned result, even inside of the same library.
  */
-class AnalysisResult {
+class AnalysisResult implements results.ResolveResult {
   static final _UNCHANGED = new AnalysisResult(
       null, null, null, null, null, null, null, null, null, null, null);
 
   /**
    * The [AnalysisDriver] that produced this result.
    */
   final AnalysisDriver driver;
 
   /**
    * The [SourceFactory] with which the file was analyzed.
    */
   final SourceFactory sourceFactory;
 
-  /**
-   * The path of the analysed file, absolute and normalized.
-   */
-  final String path;
+  @override
+  final String filePath;
 
-  /**
-   * The URI of the file that corresponded to the [path] in the used
-   * [SourceFactory] at some point. Is it not guaranteed to be still consistent
-   * to the [path], and provided as FYI.
-   */
+  @override
   final Uri uri;
 
   /**
    * Return `true` if the file exists.
    */
   final bool exists;
 
-  /**
-   * The content of the file that was scanned, parsed and resolved.
-   */
+  @override
   final String content;
 
-  /**
-   * Information about lines in the [content].
-   */
+  @override
   final LineInfo lineInfo;
 
   /**
    * The signature of the result based on the content of the file, and the
    * transitive closure of files imported and exported by the library of
    * the requested file.
    */
   final String _signature;
 
-  /**
-   * The fully resolved compilation unit for the [content].
-   */
+  @override
   final CompilationUnit unit;
 
-  /**
-   * The full list of computed analysis errors, both syntactic and semantic.
-   */
+  @override
   final List<AnalysisError> errors;
 
   /**
    * The index of the unit.
    */
   final AnalysisDriverUnitIndex _index;
 
   AnalysisResult(
       this.driver,
       this.sourceFactory,
-      this.path,
+      this.filePath,
       this.uri,
       this.exists,
       this.content,
       this.lineInfo,
       this._signature,
       this.unit,
       this.errors,
       this._index);
+
+  /**
+   * The path of the analysed file, absolute and normalized.
+   */
+  //@deprecated
+  String get path => filePath;
+
+  @override
+  results.ResultState get state =>
+      exists ? results.ResultState.VALID : results.ResultState.NOT_A_FILE;
 }
 
 /**
  * An object that watches for the creation and removal of analysis drivers.
  *
  * Clients may not extend, implement or mix-in this class.
  */
 abstract class DriverWatcher {
   /**
    * The context manager has just added the given analysis [driver]. This method
    * must be called before the driver has been allowed to perform any analysis.
    */
   void addedDriver(AnalysisDriver driver, ContextRoot contextRoot);
 
   /**
    * The context manager has just removed the given analysis [driver].
    */
   void removedDriver(AnalysisDriver driver);
 }
 
 /**
  * The errors in a single file.
  *
  * These results are self-consistent, i.e. [content], [contentHash], [errors]
  * correspond to each other. But none of the results is guaranteed to be
  * consistent with the state of the files.
  */
-class ErrorsResult {
+class ErrorsResult implements results.ErrorsResult {
+  @override
+  final String filePath;
+
+  @override
+  final Uri uri;
+
+  @override
+  final LineInfo lineInfo;
+
+  @override
+  final List<AnalysisError> errors;
+
+  ErrorsResult(this.filePath, this.uri, this.lineInfo, this.errors);
+
   /**
    * The path of the parsed file, absolute and normalized.
    */
-  final String path;
+  //@deprecated
+  String get path => filePath;
 
-  /**
-   * The URI of the file that corresponded to the [path].
-   */
-  final Uri uri;
-
-  /**
-   * Information about lines in the [content].
-   */
-  final LineInfo lineInfo;
-
-  /**
-   * The full list of computed analysis errors, both syntactic and semantic.
-   */
-  final List<AnalysisError> errors;
-
-  ErrorsResult(this.path, this.uri, this.lineInfo, this.errors);
+  @override
+  results.ResultState get state => results.ResultState.VALID;
 }
 
 /**
  * Exception that happened during analysis.
  */
 class ExceptionResult {
   /**
    * The path of the file being analyzed when the [exception] happened.
    *
    * Absolute and normalized.
@@ skipping 16 matching lines @@
   ExceptionResult(this.path, this.exception, this.contextKey);
 }
 
 /**
  * The result of parsing of a single file.
  *
  * These results are self-consistent, i.e. [content], [contentHash], the
  * resolved [unit] correspond to each other. But none of the results is
  * guaranteed to be consistent with the state of the files.
  */
-class ParseResult {
+class ParseResult implements results.ParseResult {
+  @override
+  final String filePath;
+
+  @override
+  final Uri uri;
+
+  @override
+  final String content;
+
+  @override
+  final LineInfo lineInfo;
+
+  @override
+  final CompilationUnit unit;
+
+  @override
+  final List<AnalysisError> errors;
+
+  ParseResult(this.filePath, this.uri, this.content, this.lineInfo, this.unit,
+      this.errors);
+
   /**
    * The path of the parsed file, absolute and normalized.
    */
-  final String path;
+  //@deprecated
+  String get path => filePath;
 
-  /**
-   * The URI of the file that corresponded to the [path].
-   */
-  final Uri uri;
-
-  /**
-   * The content of the file that was scanned and parsed.
-   */
-  final String content;
-
-  /**
-   * Information about lines in the [content].
-   */
-  final LineInfo lineInfo;
-
-  /**
-   * The parsed, unresolved compilation unit for the [content].
-   */
-  final CompilationUnit unit;
-
-  /**
-   * The scanning and parsing errors.
-   */
-  final List<AnalysisError> errors;
-
-  ParseResult(
-      this.path, this.uri, this.content, this.lineInfo, this.unit, this.errors);
+  @override
+  results.ResultState get state => results.ResultState.VALID;
 }
 
 /**
  * The result with the [CompilationUnitElement] of a single file.
  *
  * These results are self-consistent, i.e. all elements and types accessible
  * through [element], including defined in other files, correspond to each
  * other. But none of the results is guaranteed to be consistent with the state
  * of the files.
  *
  * Every result is independent, and is not guaranteed to be consistent with
  * any previously returned result, even inside of the same library.
  */
-class UnitElementResult {
-  /**
-   * The path of the file, absolute and normalized.
-   */
-  final String path;
+class UnitElementResult implements results.UnitElementResult {
+  @override
+  final String filePath;
+
+  @override
+  final Uri uri;
 
   /**
    * The signature of the [element] is based the APIs of the files of the
    * library (including the file itself) of the requested file and the
    * transitive closure of files imported and exported by the library.
    */
   final String signature;
 
   /**
    * The element of the file.
    */
   final CompilationUnitElement element;
 
-  UnitElementResult(this.path, this.signature, this.element);
+  UnitElementResult(this.filePath, this.uri, this.signature, this.element);
+
+  /**
+   * The path of the file, absolute and normalized.
+   */
+  //@deprecated
+  String get path => filePath;
+
+  @override
+  results.ResultState get state => results.ResultState.VALID;
 }
 
 /**
  * Information about an exception and its context.
  */
 class _ExceptionState {
   final exception;
   final StackTrace stackTrace;
 
   /**
@@ skipping 174 matching lines @@
           libraryDeclarations.add(new TopLevelDeclarationInSource(
               file.source, declaration, isExported));
         }
       }
     }
 
     // We're not done yet.
     return false;
   }
 }