Add AnalysisSession to analyzer

pkg/analyzer/lib/dart/analysis/session.dart

+// Copyright (c) 2017, 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 'package:analyzer/dart/analysis/results.dart';
+import 'package:analyzer/dart/element/element.dart';
+import 'package:analyzer/exception/exception.dart';
+import 'package:analyzer/src/dart/analysis/top_level_declaration.dart';
+import 'package:analyzer/src/generated/resolver.dart';
+import 'package:analyzer/src/generated/source.dart';
+
+/**
+ * A consistent view of the results of analyzing one or more files.
+ *
+ * The methods in this class that return analysis results will throw an
+ * InconsistentAnalysisException if the result to be returned might be

[scheglov, 2017/06/26 15:30:03]

Maybe [InconsistentAnalysisException] to make it indexable.

[Brian Wilkerson, 2017/06/26 16:06:19]

Done

+ * inconsistent with any previously returned results.
+ *
+ * Clients may not extend, implement or mix-in this class.
+ */
+abstract class AnalysisSession {
+  /**
+   * Return a type provider that is consistent with the results returned by this
+   * session.
+   */
+  Future<TypeProvider> get typeProvider;
+
+  /**
+   * Return the type system being used by this session.
+   */
+  Future<TypeSystem> get typeSystem;
+
+  /**
+   * Return a future that will complete with information about the errors
+   * contained in the file with the given absolute, normalized [path].
+   *
+   * If the file cannot be analyzed by this session, then the result will have
+   * a result state indicating the nature of the problem.
+   */
+  Future<ErrorsResult> getErrors(String path);
+
+  /**
+   * Return a future that will complete with the library element representing
+   * the library with the given [uri].
+   */
+  Future<LibraryElement> getLibraryByUri(String uri);
+
+  /**
+   * Return a future that will complete with information about the results of
+   * parsing the file with the given absolute, normalized [path].
+   */
+  Future<ParseResult> getParsedAst(String path);
+
+  /**
+   * Return a future that will complete with information about the results of
+   * resolving the file with the given absolute, normalized [path].
+   */
+  Future<ResolveResult> getResolvedAst(String path);
+
+  /**
+   * Return a future that will complete with the source kind of the file with
+   * the given absolute, normalized [path]. If the path does not represent a
+   * file or if the kind of the file cannot be determined, then the future will
+   * complete with [SourceKind.UNKNOWN].
+   */
+  Future<SourceKind> getSourceKind(String path);
+
+  /**
+   * Return a future that will complete with a list of the top-level
+   * declarations with the given [name] in all known libraries.
+   */
+  Future<List<TopLevelDeclarationInSource>> getTopLevelDeclarations(
+      String name);
+
+  /**
+   * Return a future that will complete with information about the results of
+   * building the element model for the file with the given absolute, normalized
+   * [path].
+   */
+  Future<UnitElementResult> getUnitElement(String path);
+
+  /**
+   * Return a future that will complete with the signature for the file with the
+   * given absolute, normalized [path], or `null` if the file cannot be analyzed.
+   * This is the same signature returned in the result from [getUnitElement].
+   *
+   * The signature is based on the APIs of the files of the library (including
+   * the file itself), and the transitive closure of files imported and exported
+   * by the library. If the signature of a file has not changed, then there have
+   * been no changes that would cause any files that depend on it to need to be
+   * re-analyzed.
+   */
+  Future<String> getUnitElementSignature(String path);
+}
+
+/**
+ * The exception thrown by an [AnalysisSession] if a result is requested that
+ * might be inconsistent with any previously returned results.
+ */
+class InconsistentAnalysisException extends AnalysisException {
+  /**
+   * Initialize a newly created exception to have the given [message] and
+   * [cause].
+   */
+  InconsistentAnalysisException([String message, CaughtException cause])
+      : super(message, cause);
+}