mirror of
https://github.com/carbon-language/carbon-lang.git
synced 2026-09-24 22:02:23 +01:00
Dana Jansens
fbc8d59d32
Introduces `Context` and `SoftContext` messages, which can be introduced
through a `ContextBuilder`:
- The `Context` messages come before the diagnostic in the output.
- The first `Context` message steals the diagnostic level from the main
diagnostic, and turns the main diagnostic into a Note attached to the
context.
- A `SoftContext` message works similarly, but if it's preceeded by a
`Context` or `SoftContext` message, then it is dropped. This can be used
as a default/backup scope when nothing more interesting is provided up
the stack, such as in `TryEvalBlockForSpecific`.
The `ContextBuilder` is provided to a callback through
`Diagnostics::ContextScope`, an RAII type `AnnotationScope` but for
context messages.
This allows a high level operation to provide a context message like
"failed to identify facet type {0}" which will then be used as the error
if a diagnostic is produced during identification, with the latter
diagnostic attached as a note to explain why the contextual operation
failed.
In particular, this allows monomorphization errors (such as an array
bound being negative) to be attached to a higher lever operation instead
of being top-level diagnostics themselves, with the monomorphization
site being a note. This inverts the source code locations that appear in
the diagnostic, so that the top-level diagnostic points to the "user
code" which causes the monomorphization.
This is presented as an alternative strategy to #6753, which plumbed
diagnoser callbacks around to achieve the same goals.
We replace the diagnoser callbacks in type completion and operators with
ContextScope callbacks instead, which now provide better diagnostics for
monomorphization errors. Other callers to MakeSpecific do not yet have
ContextScopes introduced in order to turn monomorphization errors into
more interesting diagnostics.
84 lines
2.9 KiB
C++
84 lines
2.9 KiB
C++
// Part of the Carbon Language project, under the Apache License v2.0 with LLVM
|
|
// Exceptions. See /LICENSE for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
|
|
#include <gtest/gtest.h>
|
|
|
|
#include "absl/flags/flag.h"
|
|
#include "toolchain/diagnostics/kind.h"
|
|
#include "toolchain/testing/coverage_helper.h"
|
|
|
|
ABSL_FLAG(std::string, testdata_manifest, "",
|
|
"A path to a file containing repo-relative names of test files.");
|
|
|
|
namespace Carbon::Diagnostics {
|
|
namespace {
|
|
|
|
constexpr Kind Kinds[] = {
|
|
#define CARBON_DIAGNOSTIC_KIND(Name) Kind::Name,
|
|
#include "toolchain/diagnostics/kind.def"
|
|
};
|
|
|
|
constexpr Kind UntestedKinds[] = {
|
|
// These exist only for unit tests.
|
|
Kind::TestDiagnostic,
|
|
Kind::TestDiagnosticContext,
|
|
Kind::TestDiagnosticContext2,
|
|
Kind::TestDiagnosticNote,
|
|
Kind::TestDiagnosticOnScope,
|
|
Kind::TestDiagnosticSoftContext,
|
|
Kind::TestDiagnosticSoftContext2,
|
|
|
|
// Diagnosing erroneous install conditions, but test environments are
|
|
// typically correct.
|
|
Kind::CompilePreludeManifestError,
|
|
Kind::ConfigFailedToReadDigest,
|
|
Kind::ConfigFailedToSetupTarget,
|
|
Kind::DriverInstallInvalid,
|
|
|
|
// These diagnose filesystem issues that are hard to unit test.
|
|
Kind::ErrorReadingFile,
|
|
Kind::ErrorStattingFile,
|
|
Kind::FileTooLarge,
|
|
Kind::FailureBuildingRuntimes,
|
|
Kind::FailureRunningClang,
|
|
Kind::FailureRunningClangToLink,
|
|
|
|
// These aren't feasible to test with a normal testcase, but are tested in
|
|
// lex/tokenized_buffer_test.cpp.
|
|
Kind::TooManyTokens,
|
|
Kind::UnsupportedCrLineEnding,
|
|
Kind::UnsupportedLfCrLineEnding,
|
|
|
|
// This is a little long but is tested in lex/numeric_literal_test.cpp.
|
|
Kind::TooManyDigits,
|
|
|
|
// Producing an emit failure may be infeasible.
|
|
Kind::CodeGenUnableToEmit,
|
|
|
|
// TODO: This is currently hard to test because it requires building and
|
|
// importing a module, which attempts to create additional files with
|
|
// unpredictable names in the module cache, which bazel doesn't permit.
|
|
Kind::InCppModule,
|
|
|
|
// TODO: This can only fire if the first message in a diagnostic is rooted
|
|
// in a file other than the file being compiled. The language server
|
|
// currently only supports compiling one file at a time. Do one of:
|
|
// - When imports are supported, find a diagnostic whose first message isn't
|
|
// in the current file.
|
|
// - Require all diagnostics produced by compiling have their first location
|
|
// be in the file being compiled, never an import.
|
|
Kind::LanguageServerDiagnosticInWrongFile,
|
|
};
|
|
|
|
// Looks for diagnostic kinds that aren't covered by a file_test.
|
|
TEST(Coverage, Kind) {
|
|
Testing::TestKindCoverage(absl::GetFlag(FLAGS_testdata_manifest),
|
|
R"(^ *// CHECK:STDERR: .* \[(\w+)\]$)",
|
|
llvm::ArrayRef(Kinds),
|
|
llvm::ArrayRef(UntestedKinds));
|
|
}
|
|
|
|
} // namespace
|
|
} // namespace Carbon::Diagnostics
|