fixup! Convert early lints to diag structs

Xiretza · Xiretza · commit 99f820561870 · 2024-04-21T20:43:15.000Z
diff --git a/compiler/rustc_expand/src/base.rs b/compiler/rustc_expand/src/base.rs
@@ -1555,14 +1555,14 @@ fn pretty_printing_compatibility_hack(item: &Item, sess: &Session) -> bool {
                                 // FIXME: make this translatable
                                 #[allow(rustc::untranslatable_diagnostic)]
                                 sess.psess.buffer_lint_with_diagnostic(
-                                        PROC_MACRO_BACK_COMPAT,
-                                        item.ident.span,
-                                        ast::CRATE_NODE_ID,
-                                        BuiltinLintDiag::ProcMacroBackCompat(
-                                        "older versions of the `rental` crate will stop compiling in future versions of Rust; \
-                                        please update to `rental` v0.5.6, or switch to one of the `rental` alternatives".to_string()
-                                        )
-                                    );
+                                    PROC_MACRO_BACK_COMPAT,
+                                    item.ident.span,
+                                    ast::CRATE_NODE_ID,
+                                    BuiltinLintDiag::ProcMacroBackCompat {
+                                        crate_name: "rental".to_string(),
+                                        fixed_version: "0.5.6".to_string(),
+                                    },
+                                );
                                 return true;
                             }
                         }
diff --git a/compiler/rustc_lint/messages.ftl b/compiler/rustc_lint/messages.ftl
@@ -254,6 +254,8 @@ lint_expectation = this lint expectation is unfulfilled
 lint_extern_crate_not_idiomatic = `extern crate` is not idiomatic in the new edition
 
 lint_extern_without_abi = extern declarations without an explicit ABI are deprecated
+    .label = ABI should be specified here
+    .help = the default ABI is {$default_abi}
 
 lint_for_loops_over_fallibles =
     for loop over {$article} `{$ty}`. This is more readably written as an `if let` statement
@@ -414,8 +416,8 @@ lint_invalid_reference_casting_note_book = for more information, visit <https://
 
 lint_invalid_reference_casting_note_ty_has_interior_mutability = even for types with interior mutability, the only legal way to obtain a mutable pointer from a shared reference is through `UnsafeCell::get`
 
-lint_legacy_derive_helpers =
-    derive helper attribute is used before it is introduced
+lint_legacy_derive_helpers = derive helper attribute is used before it is introduced
+    .label = the attribute is introduced here
 
 lint_lintpass_by_hand = implementing `LintPass` by hand
     .help = try using `declare_lint_pass!` or `impl_lint_pass!` instead
@@ -567,8 +569,8 @@ lint_opaque_hidden_inferred_bound = opaque type `{$ty}` does not satisfy its ass
 
 lint_opaque_hidden_inferred_bound_sugg = add this bound
 
-lint_or_patterns_back_compat =
-    the meaning of the `pat` fragment specifier is changing in Rust 2021, which may affect this macro
+lint_or_patterns_back_compat = the meaning of the `pat` fragment specifier is changing in Rust 2021, which may affect this macro
+    .suggestion = use pat_param to preserve semantics
 
 lint_overflowing_bin_hex = literal out of range for `{$ty}`
     .negative_note = the literal `{$lit}` (decimal `{$dec}`) does not fit into the type `{$ty}`
@@ -608,7 +610,8 @@ lint_pattern_in_foreign = patterns aren't allowed in foreign function declaratio
 lint_private_extern_crate_reexport =
     extern crate `{$ident}` is private, and cannot be re-exported (error E0365), consider declaring with `pub`
 
-lint_proc_macro_back_compat_rental = using an old version of `rental`
+lint_proc_macro_back_compat = using an old version of `{$crate_name}`
+    .note = older versions of the `{$crate_name}` crate will stop compiling in future versions of Rust; please update to `{$crate_name}` v{$fixed_version}, or switch to one of the `{$crate_name}` alternatives
 
 lint_proc_macro_derive_resolution_fallback = cannot find {$ns} `{$ident}` in this scope
     .label = names from parent modules are not accessible without an explicit import
@@ -652,6 +655,8 @@ lint_redundant_semicolons =
 
 lint_reference_without_lifetime_not_allowed = `&` without an explicit lifetime name cannot be used here
 
+lint_remove_mut_from_pattern = remove `mut` from the parameter
+
 lint_removed_lint = lint `{$name}` has been removed: {$reason}
 
 lint_renamed_lint = lint `{$name}` has been renamed to `{$replace}`
@@ -660,6 +665,10 @@ lint_renamed_lint = lint `{$name}` has been renamed to `{$replace}`
 
 lint_requested_level = requested on the command line with `{$level} {$lint_name}`
 
+lint_reserved_prefix = prefix `{$prefix}` is unknown
+    .label = unknown prefix
+    .suggestion = insert whitespace here to avoid this being parsed as a prefix in Rust 2021
+
 lint_span_use_eq_ctxt = use `.eq_ctxt()` instead of `.ctxt() == .ctxt()`
 
 lint_supertrait_as_deref_target = this `Deref` implementation is covered by an implicit supertrait coercion
@@ -763,6 +772,8 @@ lint_unused_delim = unnecessary {$delim} around {$item}
     .suggestion = remove these {$delim}
 
 lint_unused_doc_comment = unused doc comment
+    .label = rustdoc does not generate documentation for macro invocations
+    .help = to document an item produced by a macro, the macro must produce the documentation as part of its expansion
 
 lint_unused_import_braces = braces around {$node} is unnecessary
 
diff --git a/compiler/rustc_lint/src/context/diagnostics.rs b/compiler/rustc_lint/src/context/diagnostics.rs
@@ -19,46 +19,6 @@ mod check_cfg;
 
 fn buffered_decorate(sess: &Session, diagnostic: BuiltinLintDiag, diag: &mut Diag<'_, ()>) {
     match diagnostic {
-        BuiltinLintDiag::UnusedDocComment(span) => {
-            diag.span_label(span, "rustdoc does not generate documentation for macro invocations");
-            diag.help("to document an item produced by a macro, \
-                                  the macro must produce the documentation as part of its expansion");
-        }
-        BuiltinLintDiag::PatternsInFnsWithoutBody { span, ident, .. } => {
-            diag.span_suggestion(
-                span,
-                "remove `mut` from the parameter",
-                ident,
-                Applicability::MachineApplicable,
-            );
-        }
-        BuiltinLintDiag::MissingAbi(span, default_abi) => {
-            diag.span_label(span, "ABI should be specified here");
-            diag.help(format!("the default ABI is {}", default_abi.name()));
-        }
-        BuiltinLintDiag::LegacyDeriveHelpers(span) => {
-            diag.span_label(span, "the attribute is introduced here");
-        }
-        BuiltinLintDiag::ProcMacroBackCompat(note) => {
-            diag.note(note);
-        }
-        BuiltinLintDiag::OrPatternsBackCompat(span, suggestion) => {
-            diag.span_suggestion(
-                span,
-                "use pat_param to preserve semantics",
-                suggestion,
-                Applicability::MachineApplicable,
-            );
-        }
-        BuiltinLintDiag::ReservedPrefix(span, _) => {
-            diag.span_label(span, "unknown prefix");
-            diag.span_suggestion_verbose(
-                span.shrink_to_hi(),
-                "insert whitespace here to avoid this being parsed as a prefix in Rust 2021",
-                " ",
-                Applicability::MachineApplicable,
-            );
-        }
         BuiltinLintDiag::UnusedBuiltinAttribute { attr_name, macro_name, invoc_span } => {
             diag.span_note(
                         invoc_span,
@@ -257,6 +217,14 @@ fn buffered_decorate(sess: &Session, diagnostic: BuiltinLintDiag, diag: &mut Dia
         | BuiltinLintDiag::UnusedImports { .. }
         | BuiltinLintDiag::RedundantImport(_, _)
         | BuiltinLintDiag::DeprecatedMacro { .. }
+        | BuiltinLintDiag::UnusedDocComment(_)
+        | BuiltinLintDiag::PatternsInFnsWithoutBody { .. }
+        | BuiltinLintDiag::MissingAbi(_, _)
+        | BuiltinLintDiag::LegacyDeriveHelpers(_)
+        | BuiltinLintDiag::ProcMacroBackCompat{..}
+        | BuiltinLintDiag::OrPatternsBackCompat(_, _)
+        | BuiltinLintDiag::ReservedPrefix(_, _)
+        // ================== //
         | BuiltinLintDiag::MacroUseDeprecated
         | BuiltinLintDiag::UnusedMacroUse
         | BuiltinLintDiag::PrivateExternCrateReexport(_)
@@ -288,24 +256,9 @@ fn buffered_decorate(sess: &Session, diagnostic: BuiltinLintDiag, diag: &mut Dia
 
 fn buffered_message(diagnostic: &BuiltinLintDiag) -> DiagMessage {
     match diagnostic {
-        BuiltinLintDiag::MissingAbi(_, _) => fluent::lint_extern_without_abi,
-        BuiltinLintDiag::UnusedDocComment(_) => fluent::lint_unused_doc_comment,
         BuiltinLintDiag::UnusedBuiltinAttribute { attr_name, .. } => {
             format!("unused attribute `{attr_name}`").into()
         }
-        BuiltinLintDiag::PatternsInFnsWithoutBody { is_foreign, .. } => {
-            if *is_foreign {
-                fluent::lint_pattern_in_foreign
-            } else {
-                fluent::lint_pattern_in_bodiless
-            }
-        }
-        BuiltinLintDiag::LegacyDeriveHelpers(_) => fluent::lint_legacy_derive_helpers,
-        BuiltinLintDiag::ProcMacroBackCompat(_) => fluent::lint_proc_macro_back_compat_rental,
-        BuiltinLintDiag::OrPatternsBackCompat(_, _) => fluent::lint_or_patterns_back_compat,
-        BuiltinLintDiag::ReservedPrefix(_, prefix) => {
-            format!("prefix `{prefix}` is unknown").into()
-        }
         BuiltinLintDiag::TrailingMacro(_, _) => fluent::lint_trailing_semi_macro,
         BuiltinLintDiag::BreakWithLabelAndLoop(_) => fluent::lint_break_with_label_and_loop,
         BuiltinLintDiag::UnexpectedCfgName((name, _), _) => {
@@ -362,6 +315,14 @@ fn buffered_message(diagnostic: &BuiltinLintDiag) -> DiagMessage {
         | BuiltinLintDiag::UnusedImports { .. }
         | BuiltinLintDiag::RedundantImport(_, _)
         | BuiltinLintDiag::DeprecatedMacro { .. }
+        | BuiltinLintDiag::UnusedDocComment(_)
+        | BuiltinLintDiag::PatternsInFnsWithoutBody { .. }
+        | BuiltinLintDiag::MissingAbi(_, _)
+        | BuiltinLintDiag::LegacyDeriveHelpers(_)
+        | BuiltinLintDiag::ProcMacroBackCompat{..}
+        | BuiltinLintDiag::OrPatternsBackCompat(_, _)
+        | BuiltinLintDiag::ReservedPrefix(_, _)
+        // ================== //
         | BuiltinLintDiag::MacroUseDeprecated
         | BuiltinLintDiag::UnusedMacroUse
         | BuiltinLintDiag::PrivateExternCrateReexport(_)
@@ -398,14 +359,7 @@ pub(super) fn emit_buffered_lint<C: LintContext + ?Sized>(
     diagnostic: BuiltinLintDiag,
 ) {
     match diagnostic {
-        BuiltinLintDiag::MissingAbi(_, _)
-        | BuiltinLintDiag::UnusedDocComment(_)
-        | BuiltinLintDiag::UnusedBuiltinAttribute { .. }
-        | BuiltinLintDiag::PatternsInFnsWithoutBody { .. }
-        | BuiltinLintDiag::LegacyDeriveHelpers(_)
-        | BuiltinLintDiag::ProcMacroBackCompat(_)
-        | BuiltinLintDiag::OrPatternsBackCompat(_, _)
-        | BuiltinLintDiag::ReservedPrefix(_, _)
+        BuiltinLintDiag::UnusedBuiltinAttribute { .. }
         | BuiltinLintDiag::TrailingMacro(_, _)
         | BuiltinLintDiag::BreakWithLabelAndLoop(_)
         | BuiltinLintDiag::UnexpectedCfgName(_, _)
@@ -569,6 +523,59 @@ pub(super) fn emit_buffered_lint<C: LintContext + ?Sized>(
                 stability::Deprecated { sub, kind: "macro".to_string(), path, note, since_kind },
             );
         }
+        BuiltinLintDiag::UnusedDocComment(attr_span) => {
+            ctx.emit_span_lint(lint, span, lints::UnusedDocComment { span: attr_span });
+        }
+        BuiltinLintDiag::PatternsInFnsWithoutBody { span: remove_span, ident, is_foreign } => {
+            let sub = lints::PatternsInFnsWithoutBodySub { ident, span: remove_span };
+
+            ctx.emit_span_lint(
+                lint,
+                span,
+                if is_foreign {
+                    lints::PatternsInFnsWithoutBody::Foreign { sub }
+                } else {
+                    lints::PatternsInFnsWithoutBody::Bodiless { sub }
+                },
+            );
+        }
+        BuiltinLintDiag::MissingAbi(label_span, default_abi) => {
+            ctx.emit_span_lint(
+                lint,
+                span,
+                lints::MissingAbi { span: label_span, default_abi: default_abi.name() },
+            );
+        }
+        BuiltinLintDiag::LegacyDeriveHelpers(label_span) => {
+            ctx.emit_span_lint(lint, span, lints::LegacyDeriveHelpers { span: label_span });
+        }
+        BuiltinLintDiag::ProcMacroBackCompat { crate_name, fixed_version } => {
+            ctx.emit_span_lint(
+                lint,
+                span,
+                lints::ProcMacroBackCompat { crate_name, fixed_version },
+            );
+        }
+        BuiltinLintDiag::OrPatternsBackCompat(suggestion_span, suggestion) => {
+            ctx.emit_span_lint(
+                lint,
+                span,
+                lints::OrPatternsBackCompat { span: suggestion_span, suggestion },
+            );
+        }
+        BuiltinLintDiag::ReservedPrefix(label_span, prefix) => {
+            ctx.emit_span_lint(
+                lint,
+                span,
+                lints::ReservedPrefix {
+                    label: label_span,
+                    suggestion: label_span.shrink_to_hi(),
+                    prefix,
+                },
+            );
+        }
+
+        // ================== //
         BuiltinLintDiag::MacroUseDeprecated => {
             ctx.emit_span_lint(lint, span, lints::MacroUseDeprecated)
         }
diff --git a/compiler/rustc_lint/src/lints.rs b/compiler/rustc_lint/src/lints.rs
@@ -9,7 +9,7 @@ use rustc_errors::{
     ElidedLifetimeInPathSubdiag, EmissionGuarantee, LintDiagnostic, SubdiagMessageOp,
     Subdiagnostic, SuggestionStyle,
 };
-use rustc_hir::def_id::DefId;
+use rustc_hir::{def::Namespace, def_id::DefId};
 use rustc_macros::{LintDiagnostic, Subdiagnostic};
 use rustc_middle::ty::{
     inhabitedness::InhabitedPredicate, Clause, PolyExistentialTraitRef, Ty, TyCtxt,
@@ -2229,3 +2229,78 @@ pub enum RedundantImportSub {
     #[label(lint_label_defined_prelude)]
     DefinedPrelude(#[primary_span] Span),
 }
+
+#[derive(LintDiagnostic)]
+#[diag(lint_unused_doc_comment)]
+#[help]
+pub struct UnusedDocComment {
+    #[label]
+    pub span: Span,
+}
+
+#[derive(LintDiagnostic)]
+pub enum PatternsInFnsWithoutBody {
+    #[diag(lint_pattern_in_foreign)]
+    Foreign {
+        #[subdiagnostic]
+        sub: PatternsInFnsWithoutBodySub,
+    },
+    #[diag(lint_pattern_in_bodiless)]
+    Bodiless {
+        #[subdiagnostic]
+        sub: PatternsInFnsWithoutBodySub,
+    },
+}
+
+#[derive(Subdiagnostic)]
+#[suggestion(lint_remove_mut_from_pattern, code = "{ident}", applicability = "machine-applicable")]
+pub struct PatternsInFnsWithoutBodySub {
+    #[primary_span]
+    pub span: Span,
+
+    pub ident: Ident,
+}
+
+#[derive(LintDiagnostic)]
+#[diag(lint_extern_without_abi)]
+#[help]
+pub struct MissingAbi {
+    #[label]
+    pub span: Span,
+
+    pub default_abi: &'static str,
+}
+
+#[derive(LintDiagnostic)]
+#[diag(lint_legacy_derive_helpers)]
+pub struct LegacyDeriveHelpers {
+    #[label]
+    pub span: Span,
+}
+
+#[derive(LintDiagnostic)]
+#[diag(lint_proc_macro_back_compat)]
+#[note]
+pub struct ProcMacroBackCompat {
+    pub crate_name: String,
+    pub fixed_version: String,
+}
+
+#[derive(LintDiagnostic)]
+#[diag(lint_or_patterns_back_compat)]
+pub struct OrPatternsBackCompat {
+    #[suggestion(code = "{suggestion}", applicability = "machine-applicable")]
+    pub span: Span,
+    pub suggestion: String,
+}
+
+#[derive(LintDiagnostic)]
+#[diag(lint_reserved_prefix)]
+pub struct ReservedPrefix {
+    #[label]
+    pub label: Span,
+    #[suggestion(code = " ", applicability = "machine-applicable")]
+    pub suggestion: Span,
+
+    pub prefix: String,
+}
diff --git a/compiler/rustc_lint_defs/src/lib.rs b/compiler/rustc_lint_defs/src/lib.rs
@@ -619,7 +619,10 @@ pub enum BuiltinLintDiag {
         is_foreign: bool,
     },
     LegacyDeriveHelpers(Span),
-    ProcMacroBackCompat(String),
+    ProcMacroBackCompat {
+        crate_name: String,
+        fixed_version: String,
+    },
     OrPatternsBackCompat(Span, String),
     ReservedPrefix(Span, String),
     TrailingMacro(bool, Ident),
