Chromium Code Reviews| Index: pkg/front_end/lib/incremental_resolved_ast_generator.dart |
| diff --git a/pkg/front_end/lib/incremental_resolved_ast_generator.dart b/pkg/front_end/lib/incremental_resolved_ast_generator.dart |
| new file mode 100644 |
| index 0000000000000000000000000000000000000000..7ed432ce09a231a6fb95a7bbd653417f33f8ecab |
| --- /dev/null |
| +++ b/pkg/front_end/lib/incremental_resolved_ast_generator.dart |
| @@ -0,0 +1,104 @@ |
| +// 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:front_end/src/base/processed_options.dart'; |
| +import 'package:front_end/src/incremental_resolved_ast_generator_impl.dart'; |
| +import 'package:analyzer/dart/ast/ast.dart'; |
| + |
| +import 'compiler_options.dart'; |
| + |
| +/// Represents the difference between "old" and "new" states of a program. |
| +/// |
| +/// Not intended to be implemented or extended by clients. |
| +class DeltaLibraries { |
| + /// The new state of the program, as a map from Uri to resolved AST. |
|
scheglov
2017/01/16 19:24:58
"to resolved library"?
Paul Berry
2017/01/17 13:45:31
Done.
|
| + /// |
| + /// Libraries whose resolved AST is known to be unchanged since the last |
| + /// [DeltaLibraries] are not included. |
| + final Map<Uri, ResolvedLibrary> newState; |
| + |
| + DeltaLibraries(this.newState); |
| + |
| +/// TODO(paulberry): add information about libraries that were removed. |
| +} |
| + |
| +/// Represents the resolved ASTs for all the compilation units in a single |
| +/// library. |
| +/// |
| +/// Not intended to be implemented or extended by clients. |
| +class ResolvedLibrary { |
| + final CompilationUnit definingCompilationUnit; |
| + |
| + ResolvedLibrary(this.definingCompilationUnit); |
| + |
| + // TODO(paulberry): add support for parts. |
| +} |
| + |
| +/// Interface for generating an initial resolved representation of a program and |
| +/// keeping it up to date as incremental changes are made. |
| +/// |
| +/// This class maintains an internal "previous program state"; each |
| +/// time [computeDelta] is called, it updates the previous program state and |
| +/// produces a representation of what has changed. When there are few changes, |
| +/// a call to [computeDelta] should be much faster than compiling the whole |
| +/// program from scratch. |
| +/// |
| +/// This class also maintains a set of "valid sources", which is a (possibly |
| +/// empty) subset of the sources constituting the previous program state. Files |
| +/// in this set are assumed to be unchanged since the last call to |
| +/// [computeDelta]. |
| +/// |
| +/// Behavior is undefined if the client does not obey the following concurrency |
| +/// restrictions: |
| +/// - no two invocations of [computeDelta] may be outstanding at any given time. |
| +/// - neither [invalidate] nor [invalidateAll] may be called while an invocation |
| +/// of [computeDelta] is outstanding. |
| +/// |
| +/// Not intended to be implemented or extended by clients. |
| +abstract class IncrementalResolvedAstGenerator { |
| + /// Creates an [IncrementalResolvedAstGenerator] which is prepared to generate |
| + /// resolved ASTs for the program whose main library is in the given |
| + /// [source]. |
| + /// |
| + /// No file system access is performed by this constructor; the initial |
| + /// "previous program state" is an empty program containing no code, and the |
| + /// initial set of valid sources is empty. To obtain a resolved AST |
| + /// representation of the program, call [computeDelta]. |
| + factory IncrementalResolvedAstGenerator(Uri source, CompilerOptions options) => |
| + new IncrementalResolvedAstGeneratorImpl(source, new ProcessedOptions(options)); |
| + |
| + /// Generates a resolved AST representation of the changes to the program, |
| + /// assuming that all valid sources are unchanged since the last call to |
| + /// [computeDelta]. |
| + /// |
| + /// Source files in the set of valid sources are guaranteed not to be re-read |
| + /// from disk; they are assumed to be unchanged regardless of the state of the |
| + /// filesystem. |
| + /// |
| + /// If the future completes successfully, the previous file state is updated |
| + /// and the set of valid sources is set to the set of all sources in the |
| + /// program. |
| + /// |
| + /// If the future completes with an error (due to errors in the compiled |
| + /// source code), the caller may consider the previous file state and the set |
| + /// of valid sources to be unchanged; this means that once the user fixes the |
| + /// errors, it is safe to call [computeDelta] again. |
| + Future<DeltaLibraries> computeDelta(); |
| + |
| + /// Remove any source file(s) associated with the given file path from the set |
| + /// of valid sources. This guarantees that those files will be re-read on the |
| + /// next call to [computeDelta]). |
| + void invalidate(String path); |
| + |
| + /// Remove all source files from the set of valid sources. This guarantees |
| + /// that all files will be re-read on the next call to [computeDelta]. |
| + /// |
| + /// Note that this does not erase the previous program state; the next time |
| + /// [computeDelta] is called, if parts of the program are discovered to be |
| + /// unchanged, parts of the previous program state will still be re-used to |
| + /// speed up compilation. |
| + void invalidateAll(); |
| +} |