pkg/front_end/lib/src/fasta/problems.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.

library fasta.problems;

import 'package:_fe_analyzer_shared/src/messages/severity.dart'
    show Severity, severityTexts;

import 'package:kernel/ast.dart' show FileUriNode, TreeNode;

import 'compiler_context.dart' show CompilerContext;

import 'messages.dart'
    show
        LocatedMessage,
        Message,
        noLength,
        templateInternalProblemDebugAbort,
        templateInternalProblemUnexpected,
        templateInternalProblemUnhandled,
        templateInternalProblemUnimplemented,
        templateInternalProblemUnsupported;

class DebugAbort {
  final LocatedMessage message;

  DebugAbort(Uri? uri, int charOffset, Severity severity, StackTrace trace)
      : message = uri != null
            ? templateInternalProblemDebugAbort
                .withArguments(severityTexts[severity]!, "$trace")
                .withLocation(uri, charOffset, noLength)
            : templateInternalProblemDebugAbort
                .withArguments(severityTexts[severity]!, "$trace")
                .withoutLocation();

  toString() => "DebugAbort: ${message.message}";
}

/// Used to report an internal error.
///
/// Internal errors should be avoided as best as possible, but are preferred
/// over assertion failures. The message should start with an upper-case letter
/// and contain a short description that may help a developer debug the issue.
/// This method should be called instead of using `throw`, as this allows us to
/// ensure that there are no throws anywhere else in the codebase.
///
/// Before printing the message, the string `"Internal error: "` is prepended.
Never internalProblem(Message message, int charOffset, Uri? uri) {
  if (uri != null) {
    throw CompilerContext.current
        .format(message.withLocation(uri, charOffset, noLength),
            Severity.internalProblem)
        .plain;
  } else {
    throw CompilerContext.current
        .format(message.withoutLocation(), Severity.internalProblem)
        .plain;
  }
}

Never unimplemented(String what, int charOffset, Uri? uri) {
  return internalProblem(
      templateInternalProblemUnimplemented.withArguments(what),
      charOffset,
      uri);
}

Never unhandled(String what, String where, int charOffset, Uri? uri) {
  return internalProblem(
      templateInternalProblemUnhandled.withArguments(what, where),
      charOffset,
      uri);
}

Never unexpected(String expected, String actual, int charOffset, Uri? uri) {
  return internalProblem(
      templateInternalProblemUnexpected.withArguments(expected, actual),
      charOffset,
      uri);
}

Never unsupported(String operation, int charOffset, Uri? uri) {
  return internalProblem(
      templateInternalProblemUnsupported.withArguments(operation),
      charOffset,
      uri);
}

Uri? getFileUri(TreeNode node) {
  TreeNode? parent = node;
  do {
    if (parent is FileUriNode) return parent.fileUri;
    parent = parent!.parent;
  } while (parent is TreeNode);
  return null;
}