Skip to content

Commit 40fb7d5

Browse files
nnethercotennethercote
committed
Reduce capabilities of Diagnostic.
Currently many diagnostic modifier methods are available on both `Diagnostic` and `DiagnosticBuilder`. This commit removes most of them from `Diagnostic`. To minimize the diff size, it keeps them within `diagnostic.rs` but changes the surrounding `impl Diagnostic` block to `impl DiagnosticBuilder`. (I intend to move things around later, to give a more sensible code layout.) `Diagnostic` keeps a few methods that it still needs, like `sub`, `arg`, and `replace_args`. The `forward!` macro, which defined two additional methods per call (e.g. `note` and `with_note`), is replaced by the `with_fn!` macro, which defines one additional method per call (e.g. `with_note`). It's now also only used when necessary -- not all modifier methods currently need a `with_*` form. (New ones can be easily added as necessary.) All this also requires changing `trait AddToDiagnostic` so its methods take `DiagnosticBuilder` instead of `Diagnostic`, which leads to many mechanical changes. `SubdiagnosticMessageOp` gains a type parameter `G`. There are three subdiagnostics -- `DelayedAtWithoutNewline`, `DelayedAtWithNewline`, and `InvalidFlushedDelayedDiagnosticLevel` -- that are created within the diagnostics machinery and appended to external diagnostics. These are created at the `Diagnostic` level, which means it's now hard to construct them via `derive(Diagnostic)`, so instead we build them up by hand. This has no effect on what they look like when printed. There are lots of new `allow` markers for `untranslatable_diagnostics` and `diagnostics_outside_of_impl`. This is because `#[rustc_lint_diagnostics]` annotations were present on the `Diagnostic` modifier methods, but missing from the `DiagnosticBuilder` modifier methods. They're now present.
1 parent 6204536 commit 40fb7d5

File tree

39 files changed

+485
-384
lines changed

39 files changed

+485
-384
lines changed

‎compiler/rustc_ast_lowering/src/errors.rs

+7-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
use rustc_errors::{
2-
codes::*, AddToDiagnostic, Diagnostic, DiagnosticArgFromDisplay, SubdiagnosticMessageOp,
2+
codes::*, AddToDiagnostic, DiagnosticArgFromDisplay, DiagnosticBuilder, EmissionGuarantee,
3+
SubdiagnosticMessageOp,
34
};
45
use rustc_macros::{Diagnostic, Subdiagnostic};
56
use rustc_span::{symbol::Ident, Span, Symbol};
@@ -41,7 +42,11 @@ pub struct InvalidAbi {
4142
pub struct InvalidAbiReason(pub &'static str);
4243

4344
impl AddToDiagnostic for InvalidAbiReason {
44-
fn add_to_diagnostic_with<F: SubdiagnosticMessageOp>(self, diag: &mut Diagnostic, _: F) {
45+
fn add_to_diagnostic_with<G: EmissionGuarantee, F: SubdiagnosticMessageOp<G>>(
46+
self,
47+
diag: &mut DiagnosticBuilder<'_, G>,
48+
_: F,
49+
) {
4550
#[allow(rustc::untranslatable_diagnostic)]
4651
diag.note(self.0);
4752
}

‎compiler/rustc_ast_passes/src/errors.rs

+14-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
//! Errors emitted by ast_passes.
22
33
use rustc_ast::ParamKindOrd;
4-
use rustc_errors::{codes::*, AddToDiagnostic, Applicability, Diagnostic, SubdiagnosticMessageOp};
4+
use rustc_errors::{
5+
codes::*, AddToDiagnostic, Applicability, DiagnosticBuilder, EmissionGuarantee,
6+
SubdiagnosticMessageOp,
7+
};
58
use rustc_macros::{Diagnostic, Subdiagnostic};
69
use rustc_span::{symbol::Ident, Span, Symbol};
710

@@ -372,7 +375,11 @@ pub struct EmptyLabelManySpans(pub Vec<Span>);
372375

373376
// The derive for `Vec<Span>` does multiple calls to `span_label`, adding commas between each
374377
impl AddToDiagnostic for EmptyLabelManySpans {
375-
fn add_to_diagnostic_with<F: SubdiagnosticMessageOp>(self, diag: &mut Diagnostic, _: F) {
378+
fn add_to_diagnostic_with<G: EmissionGuarantee, F: SubdiagnosticMessageOp<G>>(
379+
self,
380+
diag: &mut DiagnosticBuilder<'_, G>,
381+
_: F,
382+
) {
376383
diag.span_labels(self.0, "");
377384
}
378385
}
@@ -729,7 +736,11 @@ pub struct StableFeature {
729736
}
730737

731738
impl AddToDiagnostic for StableFeature {
732-
fn add_to_diagnostic_with<F: SubdiagnosticMessageOp>(self, diag: &mut Diagnostic, _: F) {
739+
fn add_to_diagnostic_with<G: EmissionGuarantee, F: SubdiagnosticMessageOp<G>>(
740+
self,
741+
diag: &mut DiagnosticBuilder<'_, G>,
742+
_: F,
743+
) {
733744
diag.arg("name", self.name);
734745
diag.arg("since", self.since);
735746
diag.help(fluent::ast_passes_stable_since);

‎compiler/rustc_ast_passes/src/feature_gate.rs

+3
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ macro_rules! gate {
2222
}};
2323
($visitor:expr, $feature:ident, $span:expr, $explain:expr, $help:expr) => {{
2424
if !$visitor.features.$feature && !$span.allows_unstable(sym::$feature) {
25+
// FIXME: make this translatable
26+
#[allow(rustc::diagnostic_outside_of_impl)]
27+
#[allow(rustc::untranslatable_diagnostic)]
2528
feature_err(&$visitor.sess, sym::$feature, $span, $explain).with_help($help).emit();
2629
}
2730
}};

‎compiler/rustc_borrowck/src/diagnostics/region_errors.rs

+15
Original file line numberDiff line numberDiff line change
@@ -249,6 +249,9 @@ impl<'a, 'tcx> MirBorrowckCtxt<'a, 'tcx> {
249249

250250
hrtb_bounds.iter().for_each(|bound| {
251251
let Trait(PolyTraitRef { trait_ref, span: trait_span, .. }, _) = bound else { return; };
252+
// FIXME: make this translatable
253+
#[allow(rustc::diagnostic_outside_of_impl)]
254+
#[allow(rustc::untranslatable_diagnostic)]
252255
diag.span_note(
253256
*trait_span,
254257
"due to current limitations in the borrow checker, this implies a `'static` lifetime"
@@ -419,6 +422,9 @@ impl<'a, 'tcx> MirBorrowckCtxt<'a, 'tcx> {
419422
/// ```
420423
///
421424
/// Here we would be invoked with `fr = 'a` and `outlived_fr = 'b`.
425+
// FIXME: make this translatable
426+
#[allow(rustc::diagnostic_outside_of_impl)]
427+
#[allow(rustc::untranslatable_diagnostic)]
422428
pub(crate) fn report_region_error(
423429
&mut self,
424430
fr: RegionVid,
@@ -683,12 +689,18 @@ impl<'a, 'tcx> MirBorrowckCtxt<'a, 'tcx> {
683689
borrowck_errors::borrowed_data_escapes_closure(self.infcx.tcx, *span, escapes_from);
684690

685691
if let Some((Some(outlived_fr_name), outlived_fr_span)) = outlived_fr_name_and_span {
692+
// FIXME: make this translatable
693+
#[allow(rustc::diagnostic_outside_of_impl)]
694+
#[allow(rustc::untranslatable_diagnostic)]
686695
diag.span_label(
687696
outlived_fr_span,
688697
format!("`{outlived_fr_name}` declared here, outside of the {escapes_from} body",),
689698
);
690699
}
691700

701+
// FIXME: make this translatable
702+
#[allow(rustc::diagnostic_outside_of_impl)]
703+
#[allow(rustc::untranslatable_diagnostic)]
692704
if let Some((Some(fr_name), fr_span)) = fr_name_and_span {
693705
diag.span_label(
694706
fr_span,
@@ -712,6 +724,9 @@ impl<'a, 'tcx> MirBorrowckCtxt<'a, 'tcx> {
712724
let outlived_fr_region_name = self.give_region_a_name(errci.outlived_fr).unwrap();
713725
outlived_fr_region_name.highlight_region_name(&mut diag);
714726

727+
// FIXME: make this translatable
728+
#[allow(rustc::diagnostic_outside_of_impl)]
729+
#[allow(rustc::untranslatable_diagnostic)]
715730
diag.span_label(
716731
*span,
717732
format!(

‎compiler/rustc_builtin_macros/src/errors.rs

+7-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
use rustc_errors::{
2-
codes::*, AddToDiagnostic, DiagCtxt, Diagnostic, DiagnosticBuilder, EmissionGuarantee,
3-
IntoDiagnostic, Level, MultiSpan, SingleLabelManySpans, SubdiagnosticMessageOp,
2+
codes::*, AddToDiagnostic, DiagCtxt, DiagnosticBuilder, EmissionGuarantee, IntoDiagnostic,
3+
Level, MultiSpan, SingleLabelManySpans, SubdiagnosticMessageOp,
44
};
55
use rustc_macros::{Diagnostic, Subdiagnostic};
66
use rustc_span::{symbol::Ident, Span, Symbol};
@@ -611,7 +611,11 @@ pub(crate) struct FormatUnusedArg {
611611
// Allow the singular form to be a subdiagnostic of the multiple-unused
612612
// form of diagnostic.
613613
impl AddToDiagnostic for FormatUnusedArg {
614-
fn add_to_diagnostic_with<F: SubdiagnosticMessageOp>(self, diag: &mut Diagnostic, f: F) {
614+
fn add_to_diagnostic_with<G: EmissionGuarantee, F: SubdiagnosticMessageOp<G>>(
615+
self,
616+
diag: &mut DiagnosticBuilder<'_, G>,
617+
f: F,
618+
) {
615619
diag.arg("named", self.named);
616620
let msg = f(diag, crate::fluent_generated::builtin_macros_format_unused_arg.into());
617621
diag.span_label(self.span, msg);

‎compiler/rustc_codegen_ssa/src/back/write.rs

+1-3
Original file line numberDiff line numberDiff line change
@@ -1854,9 +1854,7 @@ impl SharedEmitterMain {
18541854
Ok(SharedEmitterMessage::Diagnostic(diag)) => {
18551855
let dcx = sess.dcx();
18561856
let mut d = rustc_errors::Diagnostic::new_with_messages(diag.lvl, diag.msgs);
1857-
if let Some(code) = diag.code {
1858-
d.code(code);
1859-
}
1857+
d.code = diag.code; // may be `None`, that's ok
18601858
d.replace_args(diag.args);
18611859
dcx.emit_diagnostic(d);
18621860
}

‎compiler/rustc_const_eval/src/transform/check_consts/ops.rs

+5
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,9 @@ pub struct FnCallNonConst<'tcx> {
9393
}
9494

9595
impl<'tcx> NonConstOp<'tcx> for FnCallNonConst<'tcx> {
96+
// FIXME: make this translatable
97+
#[allow(rustc::diagnostic_outside_of_impl)]
98+
#[allow(rustc::untranslatable_diagnostic)]
9699
fn build_error(&self, ccx: &ConstCx<'_, 'tcx>, _: Span) -> DiagnosticBuilder<'tcx> {
97100
let FnCallNonConst { caller, callee, args, span, call_source, feature } = *self;
98101
let ConstCx { tcx, param_env, .. } = *ccx;
@@ -321,6 +324,8 @@ impl<'tcx> NonConstOp<'tcx> for FnCallUnstable {
321324
.dcx()
322325
.create_err(errors::UnstableConstFn { span, def_path: ccx.tcx.def_path_str(def_id) });
323326

327+
// FIXME: make this translatable
328+
#[allow(rustc::untranslatable_diagnostic)]
324329
if ccx.is_const_stable_const_fn() {
325330
err.help("const-stable functions can only call other const-stable functions");
326331
} else if ccx.tcx.sess.is_nightly_build() {

0 commit comments

Comments
 (0)