blob: 9c6044c35d71d6f44ea7ce0a222a37f3b009bd8a [file] [log] [blame]
// 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.
library fasta.loader;
import 'dart:async' show Future;
import 'dart:collection' show Queue;
import 'builder/builder.dart' show Declaration, LibraryBuilder;
import 'crash.dart' show firstSourceUri;
import 'messages.dart'
show
LocatedMessage,
Message,
noLength,
SummaryTemplate,
Template,
messagePlatformPrivateLibraryAccess,
templateInternalProblemContextSeverity,
templateInternalProblemMissingSeverity,
templateSourceBodySummary;
import 'problems.dart' show internalProblem;
import 'rewrite_severity.dart' show rewriteSeverity;
import 'severity.dart' show Severity;
import 'target_implementation.dart' show TargetImplementation;
import 'ticker.dart' show Ticker;
import 'type_inference/type_inference_engine.dart' show TypeInferenceEngine;
abstract class Loader<L> {
final Map<Uri, LibraryBuilder> builders = <Uri, LibraryBuilder>{};
final Queue<LibraryBuilder> unparsedLibraries = new Queue<LibraryBuilder>();
final List<L> libraries = <L>[];
final TargetImplementation target;
/// List of all handled compile-time errors seen so far by libraries loaded
/// by this loader.
///
/// A handled error is an error that has been added to the generated AST
/// already, for example, as a throw expression.
final List<LocatedMessage> handledErrors = <LocatedMessage>[];
/// List of all unhandled compile-time errors seen so far by libraries loaded
/// by this loader.
///
/// An unhandled error is an error that hasn't been handled, see
/// [handledErrors].
final List<LocatedMessage> unhandledErrors = <LocatedMessage>[];
final Set<String> seenMessages = new Set<String>();
LibraryBuilder coreLibrary;
/// The first library that we've been asked to compile. When compiling a
/// program (aka script), this is the library that should have a main method.
LibraryBuilder first;
int byteCount = 0;
Uri currentUriForCrashReporting;
Loader(this.target);
Ticker get ticker => target.ticker;
Template<SummaryTemplate> get outlineSummaryTemplate;
TypeInferenceEngine get typeInferenceEngine => null;
/// Look up a library builder by the name [uri], or if such doesn't
/// exist, create one. The canonical URI of the library is [uri], and its
/// actual location is [fileUri].
///
/// Canonical URIs have schemes like "dart", or "package", and the actual
/// location is often a file URI.
///
/// The [accessor] is the library that's trying to import, export, or include
/// as part [uri], and [charOffset] is the location of the corresponding
/// directive. If [accessor] isn't allowed to access [uri], it's a
/// compile-time error.
LibraryBuilder read(Uri uri, int charOffset,
{Uri fileUri, LibraryBuilder accessor, LibraryBuilder origin}) {
LibraryBuilder builder = builders.putIfAbsent(uri, () {
if (fileUri != null &&
(fileUri.scheme == "dart" ||
fileUri.scheme == "package" ||
fileUri.scheme == "dart-ext")) {
fileUri = null;
}
if (fileUri == null) {
switch (uri.scheme) {
case "package":
case "dart":
fileUri = target.translateUri(uri);
break;
default:
fileUri = uri;
break;
}
}
LibraryBuilder library =
target.createLibraryBuilder(uri, fileUri, origin);
if (uri.scheme == "dart" && uri.path == "core") {
coreLibrary = library;
target.loadExtraRequiredLibraries(this);
}
if (library.loader != this) {
// This library isn't owned by this loader, so not further processing
// should be attempted.
return library;
}
{
// Add any additional logic after this block. Setting the
// firstSourceUri and first library should be done as early as
// possible.
firstSourceUri ??= uri;
first ??= library;
}
if (target.backendTarget.mayDefineRestrictedType(origin?.uri ?? uri)) {
library.mayImplementRestrictedTypes = true;
}
if (uri.scheme == "dart") {
target.readPatchFiles(library);
}
unparsedLibraries.addLast(library);
return library;
});
if (accessor != null &&
!accessor.isPatch &&
!target.backendTarget
.allowPlatformPrivateLibraryAccess(accessor.uri, uri)) {
accessor.addCompileTimeError(messagePlatformPrivateLibraryAccess,
charOffset, noLength, accessor.fileUri);
}
return builder;
}
void ensureCoreLibrary() {
if (coreLibrary == null) {
read(Uri.parse("dart:core"), -1);
assert(coreLibrary != null);
}
}
Future<Null> buildBodies() async {
assert(coreLibrary != null);
for (LibraryBuilder library in builders.values) {
if (library.loader == this) {
currentUriForCrashReporting = library.uri;
await buildBody(library);
}
}
currentUriForCrashReporting = null;
logSummary(templateSourceBodySummary);
}
Future<Null> buildOutlines() async {
ensureCoreLibrary();
while (unparsedLibraries.isNotEmpty) {
LibraryBuilder library = unparsedLibraries.removeFirst();
currentUriForCrashReporting = library.uri;
await buildOutline(library);
}
currentUriForCrashReporting = null;
logSummary(outlineSummaryTemplate);
}
void logSummary(Template<SummaryTemplate> template) {
ticker.log((Duration elapsed, Duration sinceStart) {
int libraryCount = 0;
builders.forEach((Uri uri, LibraryBuilder library) {
if (library.loader == this) libraryCount++;
});
double ms = elapsed.inMicroseconds / Duration.microsecondsPerMillisecond;
Message message = template.withArguments(
libraryCount, byteCount, ms, byteCount / ms, ms / libraryCount);
print("$sinceStart: ${message.message}");
});
}
Future<Null> buildOutline(covariant LibraryBuilder library);
/// Builds all the method bodies found in the given [library].
Future<Null> buildBody(covariant LibraryBuilder library);
/// Register [message] as a compile-time error.
///
/// If [wasHandled] is true, this error is added to [handledErrors],
/// otherwise it is added to [unhandledErrors].
void addCompileTimeError(
Message message, int charOffset, int length, Uri fileUri,
{bool wasHandled: false, List<LocatedMessage> context}) {
addMessage(message, charOffset, length, fileUri, Severity.error,
wasHandled: wasHandled, context: context);
}
/// Register [message] as a problem with a severity determined by the
/// intrinsic severity of the message.
void addProblem(Message message, int charOffset, int length, Uri fileUri,
{List<LocatedMessage> context}) {
Severity severity = message.code.severity;
if (severity == null) {
addMessage(message, charOffset, length, fileUri, Severity.error,
context: context);
internalProblem(
templateInternalProblemMissingSeverity
.withArguments(message.code.name),
charOffset,
fileUri);
}
if (severity == Severity.errorLegacyWarning) {
severity =
target.backendTarget.strongMode ? Severity.error : Severity.warning;
}
addMessage(message, charOffset, length, fileUri, severity,
context: context);
}
/// All messages reported by the compiler (errors, warnings, etc.) are routed
/// through this method.
///
/// Returns true if the message is new, that is, not previously
/// reported. This is important as some parser errors may be reported up to
/// three times by `OutlineBuilder`, `DietListener`, and `BodyBuilder`.
bool addMessage(Message message, int charOffset, int length, Uri fileUri,
Severity severity,
{bool wasHandled: false, List<LocatedMessage> context}) {
severity = rewriteSeverity(severity, message.code, fileUri);
if (severity == Severity.ignored) return false;
String trace = """
message: ${message.message}
charOffset: $charOffset
fileUri: $fileUri
severity: $severity
""";
if (!seenMessages.add(trace)) return false;
if (message.code.severity == Severity.context) {
internalProblem(
templateInternalProblemContextSeverity
.withArguments(message.code.name),
charOffset,
fileUri);
}
target.context.report(
message.withLocation(fileUri, charOffset, length), severity,
context: context);
recordMessage(severity, message, charOffset, length, fileUri,
context: context);
if (severity == Severity.error) {
(wasHandled ? handledErrors : unhandledErrors)
.add(message.withLocation(fileUri, charOffset, length));
}
return true;
}
Declaration getAbstractClassInstantiationError() {
return target.getAbstractClassInstantiationError(this);
}
Declaration getCompileTimeError() => target.getCompileTimeError(this);
Declaration getDuplicatedFieldInitializerError() {
return target.getDuplicatedFieldInitializerError(this);
}
Declaration getNativeAnnotation() => target.getNativeAnnotation(this);
void recordMessage(Severity severity, Message message, int charOffset,
int length, Uri fileUri,
{List<LocatedMessage> context}) {}
}