compiler/rustc_errors/src/lib.rs

   1 //! Diagnostics creation and emission for `rustc`.
   2 //!
   3 //! This module contains the code for creating and emitting diagnostics.
   4
   5 #![doc(html_root_url = "https://doc.rust-lang.org/nightly/nightly-rustc/")]
   6 #![feature(drain_filter)]
   7 #![feature(if_let_guard)]
   8 #![feature(adt_const_params)]
   9 #![feature(let_chains)]
  10 #![feature(never_type)]
  11 #![feature(result_option_inspect)]
  12 #![feature(rustc_attrs)]
  13 #![allow(incomplete_features)]
  14
  15 #[macro_use]
  16 extern crate rustc_macros;
  17
  18 #[macro_use]
  19 extern crate tracing;
  20
  21 pub use emitter::ColorConfig;
  22
  23 use rustc_lint_defs::LintExpectationId;
  24 use Level::*;
  25
  26 use emitter::{is_case_difference, Emitter, EmitterWriter};
  27 use registry::Registry;
  28 use rustc_data_structures::fx::{FxHashMap, FxHashSet, FxIndexMap, FxIndexSet};
  29 use rustc_data_structures::stable_hasher::StableHasher;
  30 use rustc_data_structures::sync::{self, Lock, Lrc};
  31 use rustc_data_structures::AtomicRef;
  32 pub use rustc_error_messages::{
  33     fallback_fluent_bundle, fluent, fluent_bundle, DelayDm, DiagnosticMessage, FluentBundle,
  34     LanguageIdentifier, LazyFallbackBundle, MultiSpan, SpanLabel, SubdiagnosticMessage,
  35     DEFAULT_LOCALE_RESOURCES,
  36 };
  37 pub use rustc_lint_defs::{pluralize, Applicability};
  38 use rustc_span::source_map::SourceMap;
  39 use rustc_span::HashStableContext;
  40 use rustc_span::{Loc, Span};
  41
  42 use std::borrow::Cow;
  43 use std::hash::Hash;
  44 use std::num::NonZeroUsize;
  45 use std::panic;
  46 use std::path::Path;
  47 use std::{error, fmt};
  48
  49 use termcolor::{Color, ColorSpec};
  50
  51 pub mod annotate_snippet_emitter_writer;
  52 mod diagnostic;
  53 mod diagnostic_builder;
  54 mod diagnostic_impls;
  55 pub mod emitter;
  56 pub mod json;
  57 mod lock;
  58 pub mod registry;
  59 mod snippet;
  60 mod styled_buffer;
  61 pub mod translation;
  62
  63 pub use diagnostic_builder::IntoDiagnostic;
  64 pub use snippet::Style;
  65
  66 pub type PErr<'a> = DiagnosticBuilder<'a, ErrorGuaranteed>;
  67 pub type PResult<'a, T> = Result<T, PErr<'a>>;
  68
  69 // `PResult` is used a lot. Make sure it doesn't unintentionally get bigger.
  70 // (See also the comment on `DiagnosticBuilderInner`'s `diagnostic` field.)
  71 #[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))]
  72 rustc_data_structures::static_assert_size!(PResult<'_, ()>, 16);
  73 #[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))]
  74 rustc_data_structures::static_assert_size!(PResult<'_, bool>, 16);
  75
  76 #[derive(Debug, PartialEq, Eq, Clone, Copy, Hash, Encodable, Decodable)]
  77 pub enum SuggestionStyle {
  78     /// Hide the suggested code when displaying this suggestion inline.
  79     HideCodeInline,
  80     /// Always hide the suggested code but display the message.
  81     HideCodeAlways,
  82     /// Do not display this suggestion in the cli output, it is only meant for tools.
  83     CompletelyHidden,
  84     /// Always show the suggested code.
  85     /// This will *not* show the code if the suggestion is inline *and* the suggested code is
  86     /// empty.
  87     ShowCode,
  88     /// Always show the suggested code independently.
  89     ShowAlways,
  90 }
  91
  92 impl SuggestionStyle {
  93     fn hide_inline(&self) -> bool {
  94         !matches!(*self, SuggestionStyle::ShowCode)
  95     }
  96 }
  97
  98 #[derive(Clone, Debug, PartialEq, Hash, Encodable, Decodable)]
  99 pub struct CodeSuggestion {
 100     /// Each substitute can have multiple variants due to multiple
 101     /// applicable suggestions
 102     ///
 103     /// `foo.bar` might be replaced with `a.b` or `x.y` by replacing
 104     /// `foo` and `bar` on their own:
 105     ///
 106     /// ```ignore (illustrative)
 107     /// vec![
 108     ///     Substitution { parts: vec![(0..3, "a"), (4..7, "b")] },
 109     ///     Substitution { parts: vec![(0..3, "x"), (4..7, "y")] },
 110     /// ]
 111     /// ```
 112     ///
 113     /// or by replacing the entire span:
 114     ///
 115     /// ```ignore (illustrative)
 116     /// vec![
 117     ///     Substitution { parts: vec![(0..7, "a.b")] },
 118     ///     Substitution { parts: vec![(0..7, "x.y")] },
 119     /// ]
 120     /// ```
 121     pub substitutions: Vec<Substitution>,
 122     pub msg: DiagnosticMessage,
 123     /// Visual representation of this suggestion.
 124     pub style: SuggestionStyle,
 125     /// Whether or not the suggestion is approximate
 126     ///
 127     /// Sometimes we may show suggestions with placeholders,
 128     /// which are useful for users but not useful for
 129     /// tools like rustfix
 130     pub applicability: Applicability,
 131 }
 132
 133 #[derive(Clone, Debug, PartialEq, Hash, Encodable, Decodable)]
 134 /// See the docs on `CodeSuggestion::substitutions`
 135 pub struct Substitution {
 136     pub parts: Vec<SubstitutionPart>,
 137 }
 138
 139 #[derive(Clone, Debug, PartialEq, Hash, Encodable, Decodable)]
 140 pub struct SubstitutionPart {
 141     pub span: Span,
 142     pub snippet: String,
 143 }
 144
 145 /// Used to translate between `Span`s and byte positions within a single output line in highlighted
 146 /// code of structured suggestions.
 147 #[derive(Debug, Clone, Copy)]
 148 pub struct SubstitutionHighlight {
 149     start: usize,
 150     end: usize,
 151 }
 152
 153 impl SubstitutionPart {
 154     pub fn is_addition(&self, sm: &SourceMap) -> bool {
 155         !self.snippet.is_empty() && !self.replaces_meaningful_content(sm)
 156     }
 157
 158     pub fn is_deletion(&self, sm: &SourceMap) -> bool {
 159         self.snippet.trim().is_empty() && self.replaces_meaningful_content(sm)
 160     }
 161
 162     pub fn is_replacement(&self, sm: &SourceMap) -> bool {
 163         !self.snippet.is_empty() && self.replaces_meaningful_content(sm)
 164     }
 165
 166     fn replaces_meaningful_content(&self, sm: &SourceMap) -> bool {
 167         sm.span_to_snippet(self.span)
 168             .map_or(!self.span.is_empty(), |snippet| !snippet.trim().is_empty())
 169     }
 170 }
 171
 172 impl CodeSuggestion {
 173     /// Returns the assembled code suggestions, whether they should be shown with an underline
 174     /// and whether the substitution only differs in capitalization.
 175     pub fn splice_lines(
 176         &self,
 177         sm: &SourceMap,
 178     ) -> Vec<(String, Vec<SubstitutionPart>, Vec<Vec<SubstitutionHighlight>>, bool)> {
 179         // For the `Vec<Vec<SubstitutionHighlight>>` value, the first level of the vector
 180         // corresponds to the output snippet's lines, while the second level corresponds to the
 181         // substrings within that line that should be highlighted.
 182
 183         use rustc_span::{CharPos, Pos};
 184
 185         /// Append to a buffer the remainder of the line of existing source code, and return the
 186         /// count of lines that have been added for accurate highlighting.
 187         fn push_trailing(
 188             buf: &mut String,
 189             line_opt: Option<&Cow<'_, str>>,
 190             lo: &Loc,
 191             hi_opt: Option<&Loc>,
 192         ) -> usize {
 193             let mut line_count = 0;
 194             let (lo, hi_opt) = (lo.col.to_usize(), hi_opt.map(|hi| hi.col.to_usize()));
 195             if let Some(line) = line_opt {
 196                 if let Some(lo) = line.char_indices().map(|(i, _)| i).nth(lo) {
 197                     let hi_opt = hi_opt.and_then(|hi| line.char_indices().map(|(i, _)| i).nth(hi));
 198                     match hi_opt {
 199                         Some(hi) if hi > lo => {
 200                             line_count = line[lo..hi].matches('\n').count();
 201                             buf.push_str(&line[lo..hi])
 202                         }
 203                         Some(_) => (),
 204                         None => {
 205                             line_count = line[lo..].matches('\n').count();
 206                             buf.push_str(&line[lo..])
 207                         }
 208                     }
 209                 }
 210                 if hi_opt.is_none() {
 211                     buf.push('\n');
 212                 }
 213             }
 214             line_count
 215         }
 216
 217         assert!(!self.substitutions.is_empty());
 218
 219         self.substitutions
 220             .iter()
 221             .filter(|subst| {
 222                 // Suggestions coming from macros can have malformed spans. This is a heavy
 223                 // handed approach to avoid ICEs by ignoring the suggestion outright.
 224                 let invalid = subst.parts.iter().any(|item| sm.is_valid_span(item.span).is_err());
 225                 if invalid {
 226                     debug!("splice_lines: suggestion contains an invalid span: {:?}", subst);
 227                 }
 228                 !invalid
 229             })
 230             .cloned()
 231             .filter_map(|mut substitution| {
 232                 // Assumption: all spans are in the same file, and all spans
 233                 // are disjoint. Sort in ascending order.
 234                 substitution.parts.sort_by_key(|part| part.span.lo());
 235
 236                 // Find the bounding span.
 237                 let lo = substitution.parts.iter().map(|part| part.span.lo()).min()?;
 238                 let hi = substitution.parts.iter().map(|part| part.span.hi()).max()?;
 239                 let bounding_span = Span::with_root_ctxt(lo, hi);
 240                 // The different spans might belong to different contexts, if so ignore suggestion.
 241                 let lines = sm.span_to_lines(bounding_span).ok()?;
 242                 assert!(!lines.lines.is_empty() || bounding_span.is_dummy());
 243
 244                 // We can't splice anything if the source is unavailable.
 245                 if !sm.ensure_source_file_source_present(lines.file.clone()) {
 246                     return None;
 247                 }
 248
 249                 let mut highlights = vec![];
 250                 // To build up the result, we do this for each span:
 251                 // - push the line segment trailing the previous span
 252                 //   (at the beginning a "phantom" span pointing at the start of the line)
 253                 // - push lines between the previous and current span (if any)
 254                 // - if the previous and current span are not on the same line
 255                 //   push the line segment leading up to the current span
 256                 // - splice in the span substitution
 257                 //
 258                 // Finally push the trailing line segment of the last span
 259                 let sf = &lines.file;
 260                 let mut prev_hi = sm.lookup_char_pos(bounding_span.lo());
 261                 prev_hi.col = CharPos::from_usize(0);
 262                 let mut prev_line =
 263                     lines.lines.get(0).and_then(|line0| sf.get_line(line0.line_index));
 264                 let mut buf = String::new();
 265
 266                 let mut line_highlight = vec![];
 267                 // We need to keep track of the difference between the existing code and the added
 268                 // or deleted code in order to point at the correct column *after* substitution.
 269                 let mut acc = 0;
 270                 for part in &substitution.parts {
 271                     let cur_lo = sm.lookup_char_pos(part.span.lo());
 272                     if prev_hi.line == cur_lo.line {
 273                         let mut count =
 274                             push_trailing(&mut buf, prev_line.as_ref(), &prev_hi, Some(&cur_lo));
 275                         while count > 0 {
 276                             highlights.push(std::mem::take(&mut line_highlight));
 277                             acc = 0;
 278                             count -= 1;
 279                         }
 280                     } else {
 281                         acc = 0;
 282                         highlights.push(std::mem::take(&mut line_highlight));
 283                         let mut count = push_trailing(&mut buf, prev_line.as_ref(), &prev_hi, None);
 284                         while count > 0 {
 285                             highlights.push(std::mem::take(&mut line_highlight));
 286                             count -= 1;
 287                         }
 288                         // push lines between the previous and current span (if any)
 289                         for idx in prev_hi.line..(cur_lo.line - 1) {
 290                             if let Some(line) = sf.get_line(idx) {
 291                                 buf.push_str(line.as_ref());
 292                                 buf.push('\n');
 293                                 highlights.push(std::mem::take(&mut line_highlight));
 294                             }
 295                         }
 296                         if let Some(cur_line) = sf.get_line(cur_lo.line - 1) {
 297                             let end = match cur_line.char_indices().nth(cur_lo.col.to_usize()) {
 298                                 Some((i, _)) => i,
 299                                 None => cur_line.len(),
 300                             };
 301                             buf.push_str(&cur_line[..end]);
 302                         }
 303                     }
 304                     // Add a whole line highlight per line in the snippet.
 305                     let len: isize = part
 306                         .snippet
 307                         .split('\n')
 308                         .next()
 309                         .unwrap_or(&part.snippet)
 310                         .chars()
 311                         .map(|c| match c {
 312                             '\t' => 4,
 313                             _ => 1,
 314                         })
 315                         .sum();
 316                     line_highlight.push(SubstitutionHighlight {
 317                         start: (cur_lo.col.0 as isize + acc) as usize,
 318                         end: (cur_lo.col.0 as isize + acc + len) as usize,
 319                     });
 320                     buf.push_str(&part.snippet);
 321                     let cur_hi = sm.lookup_char_pos(part.span.hi());
 322                     if prev_hi.line == cur_lo.line && cur_hi.line == cur_lo.line {
 323                         // Account for the difference between the width of the current code and the
 324                         // snippet being suggested, so that the *later* suggestions are correctly
 325                         // aligned on the screen.
 326                         acc += len as isize - (cur_hi.col.0 - cur_lo.col.0) as isize;
 327                     }
 328                     prev_hi = cur_hi;
 329                     prev_line = sf.get_line(prev_hi.line - 1);
 330                     for line in part.snippet.split('\n').skip(1) {
 331                         acc = 0;
 332                         highlights.push(std::mem::take(&mut line_highlight));
 333                         let end: usize = line
 334                             .chars()
 335                             .map(|c| match c {
 336                                 '\t' => 4,
 337                                 _ => 1,
 338                             })
 339                             .sum();
 340                         line_highlight.push(SubstitutionHighlight { start: 0, end });
 341                     }
 342                 }
 343                 highlights.push(std::mem::take(&mut line_highlight));
 344                 let only_capitalization = is_case_difference(sm, &buf, bounding_span);
 345                 // if the replacement already ends with a newline, don't print the next line
 346                 if !buf.ends_with('\n') {
 347                     push_trailing(&mut buf, prev_line.as_ref(), &prev_hi, None);
 348                 }
 349                 // remove trailing newlines
 350                 while buf.ends_with('\n') {
 351                     buf.pop();
 352                 }
 353                 Some((buf, substitution.parts, highlights, only_capitalization))
 354             })
 355             .collect()
 356     }
 357 }
 358
 359 pub use rustc_span::fatal_error::{FatalError, FatalErrorMarker};
 360
 361 /// Signifies that the compiler died with an explicit call to `.bug`
 362 /// or `.span_bug` rather than a failed assertion, etc.
 363 #[derive(Copy, Clone, Debug)]
 364 pub struct ExplicitBug;
 365
 366 impl fmt::Display for ExplicitBug {
 367     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 368         write!(f, "parser internal bug")
 369     }
 370 }
 371
 372 impl error::Error for ExplicitBug {}
 373
 374 pub use diagnostic::{
 375     AddToDiagnostic, DecorateLint, Diagnostic, DiagnosticArg, DiagnosticArgValue, DiagnosticId,
 376     DiagnosticStyledString, IntoDiagnosticArg, SubDiagnostic,
 377 };
 378 pub use diagnostic_builder::{DiagnosticBuilder, EmissionGuarantee, Noted};
 379 pub use diagnostic_impls::DiagnosticArgFromDisplay;
 380 use std::backtrace::Backtrace;
 381
 382 /// A handler deals with errors and other compiler output.
 383 /// Certain errors (fatal, bug, unimpl) may cause immediate exit,
 384 /// others log errors for later reporting.
 385 pub struct Handler {
 386     flags: HandlerFlags,
 387     inner: Lock<HandlerInner>,
 388 }
 389
 390 /// This inner struct exists to keep it all behind a single lock;
 391 /// this is done to prevent possible deadlocks in a multi-threaded compiler,
 392 /// as well as inconsistent state observation.
 393 struct HandlerInner {
 394     flags: HandlerFlags,
 395     /// The number of lint errors that have been emitted.
 396     lint_err_count: usize,
 397     /// The number of errors that have been emitted, including duplicates.
 398     ///
 399     /// This is not necessarily the count that's reported to the user once
 400     /// compilation ends.
 401     err_count: usize,
 402     warn_count: usize,
 403     deduplicated_err_count: usize,
 404     emitter: Box<dyn Emitter + sync::Send>,
 405     delayed_span_bugs: Vec<Diagnostic>,
 406     delayed_good_path_bugs: Vec<DelayedDiagnostic>,
 407     /// This flag indicates that an expected diagnostic was emitted and suppressed.
 408     /// This is used for the `delayed_good_path_bugs` check.
 409     suppressed_expected_diag: bool,
 410
 411     /// This set contains the `DiagnosticId` of all emitted diagnostics to avoid
 412     /// emitting the same diagnostic with extended help (`--teach`) twice, which
 413     /// would be unnecessary repetition.
 414     taught_diagnostics: FxHashSet<DiagnosticId>,
 415
 416     /// Used to suggest rustc --explain `<error code>`
 417     emitted_diagnostic_codes: FxIndexSet<DiagnosticId>,
 418
 419     /// This set contains a hash of every diagnostic that has been emitted by
 420     /// this handler. These hashes is used to avoid emitting the same error
 421     /// twice.
 422     emitted_diagnostics: FxHashSet<u128>,
 423
 424     /// Stashed diagnostics emitted in one stage of the compiler that may be
 425     /// stolen by other stages (e.g. to improve them and add more information).
 426     /// The stashed diagnostics count towards the total error count.
 427     /// When `.abort_if_errors()` is called, these are also emitted.
 428     stashed_diagnostics: FxIndexMap<(Span, StashKey), Diagnostic>,
 429
 430     /// The warning count, used for a recap upon finishing
 431     deduplicated_warn_count: usize,
 432
 433     future_breakage_diagnostics: Vec<Diagnostic>,
 434
 435     /// The [`Self::unstable_expect_diagnostics`] should be empty when this struct is
 436     /// dropped. However, it can have values if the compilation is stopped early
 437     /// or is only partially executed. To avoid ICEs, like in rust#94953 we only
 438     /// check if [`Self::unstable_expect_diagnostics`] is empty, if the expectation ids
 439     /// have been converted.
 440     check_unstable_expect_diagnostics: bool,
 441
 442     /// Expected [`Diagnostic`][diagnostic::Diagnostic]s store a [`LintExpectationId`] as part of
 443     /// the lint level. [`LintExpectationId`]s created early during the compilation
 444     /// (before `HirId`s have been defined) are not stable and can therefore not be
 445     /// stored on disk. This buffer stores these diagnostics until the ID has been
 446     /// replaced by a stable [`LintExpectationId`]. The [`Diagnostic`][diagnostic::Diagnostic]s are the
 447     /// submitted for storage and added to the list of fulfilled expectations.
 448     unstable_expect_diagnostics: Vec<Diagnostic>,
 449
 450     /// expected diagnostic will have the level `Expect` which additionally
 451     /// carries the [`LintExpectationId`] of the expectation that can be
 452     /// marked as fulfilled. This is a collection of all [`LintExpectationId`]s
 453     /// that have been marked as fulfilled this way.
 454     ///
 455     /// [RFC-2383]: https://rust-lang.github.io/rfcs/2383-lint-reasons.html
 456     fulfilled_expectations: FxHashSet<LintExpectationId>,
 457 }
 458
 459 /// A key denoting where from a diagnostic was stashed.
 460 #[derive(Copy, Clone, PartialEq, Eq, Hash)]
 461 pub enum StashKey {
 462     ItemNoType,
 463     UnderscoreForArrayLengths,
 464     EarlySyntaxWarning,
 465     CallIntoMethod,
 466     /// When an invalid lifetime e.g. `'2` should be reinterpreted
 467     /// as a char literal in the parser
 468     LifetimeIsChar,
 469 }
 470
 471 fn default_track_diagnostic(_: &Diagnostic) {}
 472
 473 pub static TRACK_DIAGNOSTICS: AtomicRef<fn(&Diagnostic)> =
 474     AtomicRef::new(&(default_track_diagnostic as fn(&_)));
 475
 476 #[derive(Copy, Clone, Default)]
 477 pub struct HandlerFlags {
 478     /// If false, warning-level lints are suppressed.
 479     /// (rustc: see `--allow warnings` and `--cap-lints`)
 480     pub can_emit_warnings: bool,
 481     /// If true, error-level diagnostics are upgraded to bug-level.
 482     /// (rustc: see `-Z treat-err-as-bug`)
 483     pub treat_err_as_bug: Option<NonZeroUsize>,
 484     /// If true, immediately emit diagnostics that would otherwise be buffered.
 485     /// (rustc: see `-Z dont-buffer-diagnostics` and `-Z treat-err-as-bug`)
 486     pub dont_buffer_diagnostics: bool,
 487     /// If true, immediately print bugs registered with `delay_span_bug`.
 488     /// (rustc: see `-Z report-delayed-bugs`)
 489     pub report_delayed_bugs: bool,
 490     /// Show macro backtraces.
 491     /// (rustc: see `-Z macro-backtrace`)
 492     pub macro_backtrace: bool,
 493     /// If true, identical diagnostics are reported only once.
 494     pub deduplicate_diagnostics: bool,
 495     /// Track where errors are created. Enabled with `-Ztrack-diagnostics`.
 496     pub track_diagnostics: bool,
 497 }
 498
 499 impl Drop for HandlerInner {
 500     fn drop(&mut self) {
 501         self.emit_stashed_diagnostics();
 502
 503         if !self.has_errors() {
 504             let bugs = std::mem::replace(&mut self.delayed_span_bugs, Vec::new());
 505             self.flush_delayed(bugs, "no errors encountered even though `delay_span_bug` issued");
 506         }
 507
 508         // FIXME(eddyb) this explains what `delayed_good_path_bugs` are!
 509         // They're `delayed_span_bugs` but for "require some diagnostic happened"
 510         // instead of "require some error happened". Sadly that isn't ideal, as
 511         // lints can be `#[allow]`'d, potentially leading to this triggering.
 512         // Also, "good path" should be replaced with a better naming.
 513         if !self.has_any_message() && !self.suppressed_expected_diag {
 514             let bugs = std::mem::replace(&mut self.delayed_good_path_bugs, Vec::new());
 515             self.flush_delayed(
 516                 bugs.into_iter().map(DelayedDiagnostic::decorate),
 517                 "no warnings or errors encountered even though `delayed_good_path_bugs` issued",
 518             );
 519         }
 520
 521         if self.check_unstable_expect_diagnostics {
 522             assert!(
 523                 self.unstable_expect_diagnostics.is_empty(),
 524                 "all diagnostics with unstable expectations should have been converted",
 525             );
 526         }
 527     }
 528 }
 529
 530 impl Handler {
 531     pub fn with_tty_emitter(
 532         color_config: ColorConfig,
 533         can_emit_warnings: bool,
 534         treat_err_as_bug: Option<NonZeroUsize>,
 535         sm: Option<Lrc<SourceMap>>,
 536         fluent_bundle: Option<Lrc<FluentBundle>>,
 537         fallback_bundle: LazyFallbackBundle,
 538     ) -> Self {
 539         Self::with_tty_emitter_and_flags(
 540             color_config,
 541             sm,
 542             fluent_bundle,
 543             fallback_bundle,
 544             HandlerFlags { can_emit_warnings, treat_err_as_bug, ..Default::default() },
 545         )
 546     }
 547
 548     pub fn with_tty_emitter_and_flags(
 549         color_config: ColorConfig,
 550         sm: Option<Lrc<SourceMap>>,
 551         fluent_bundle: Option<Lrc<FluentBundle>>,
 552         fallback_bundle: LazyFallbackBundle,
 553         flags: HandlerFlags,
 554     ) -> Self {
 555         let emitter = Box::new(EmitterWriter::stderr(
 556             color_config,
 557             sm,
 558             fluent_bundle,
 559             fallback_bundle,
 560             false,
 561             false,
 562             None,
 563             flags.macro_backtrace,
 564             flags.track_diagnostics,
 565         ));
 566         Self::with_emitter_and_flags(emitter, flags)
 567     }
 568
 569     pub fn with_emitter(
 570         can_emit_warnings: bool,
 571         treat_err_as_bug: Option<NonZeroUsize>,
 572         emitter: Box<dyn Emitter + sync::Send>,
 573     ) -> Self {
 574         Handler::with_emitter_and_flags(
 575             emitter,
 576             HandlerFlags { can_emit_warnings, treat_err_as_bug, ..Default::default() },
 577         )
 578     }
 579
 580     pub fn with_emitter_and_flags(
 581         emitter: Box<dyn Emitter + sync::Send>,
 582         flags: HandlerFlags,
 583     ) -> Self {
 584         Self {
 585             flags,
 586             inner: Lock::new(HandlerInner {
 587                 flags,
 588                 lint_err_count: 0,
 589                 err_count: 0,
 590                 warn_count: 0,
 591                 deduplicated_err_count: 0,
 592                 deduplicated_warn_count: 0,
 593                 emitter,
 594                 delayed_span_bugs: Vec::new(),
 595                 delayed_good_path_bugs: Vec::new(),
 596                 suppressed_expected_diag: false,
 597                 taught_diagnostics: Default::default(),
 598                 emitted_diagnostic_codes: Default::default(),
 599                 emitted_diagnostics: Default::default(),
 600                 stashed_diagnostics: Default::default(),
 601                 future_breakage_diagnostics: Vec::new(),
 602                 check_unstable_expect_diagnostics: false,
 603                 unstable_expect_diagnostics: Vec::new(),
 604                 fulfilled_expectations: Default::default(),
 605             }),
 606         }
 607     }
 608
 609     /// Translate `message` eagerly with `args`.
 610     pub fn eagerly_translate<'a>(
 611         &self,
 612         message: DiagnosticMessage,
 613         args: impl Iterator<Item = DiagnosticArg<'a, 'static>>,
 614     ) -> SubdiagnosticMessage {
 615         let inner = self.inner.borrow();
 616         let args = crate::translation::to_fluent_args(args);
 617         SubdiagnosticMessage::Eager(inner.emitter.translate_message(&message, &args).to_string())
 618     }
 619
 620     // This is here to not allow mutation of flags;
 621     // as of this writing it's only used in tests in librustc_middle.
 622     pub fn can_emit_warnings(&self) -> bool {
 623         self.flags.can_emit_warnings
 624     }
 625
 626     /// Resets the diagnostic error count as well as the cached emitted diagnostics.
 627     ///
 628     /// NOTE: *do not* call this function from rustc. It is only meant to be called from external
 629     /// tools that want to reuse a `Parser` cleaning the previously emitted diagnostics as well as
 630     /// the overall count of emitted error diagnostics.
 631     pub fn reset_err_count(&self) {
 632         let mut inner = self.inner.borrow_mut();
 633         inner.err_count = 0;
 634         inner.warn_count = 0;
 635         inner.deduplicated_err_count = 0;
 636         inner.deduplicated_warn_count = 0;
 637
 638         // actually free the underlying memory (which `clear` would not do)
 639         inner.delayed_span_bugs = Default::default();
 640         inner.delayed_good_path_bugs = Default::default();
 641         inner.taught_diagnostics = Default::default();
 642         inner.emitted_diagnostic_codes = Default::default();
 643         inner.emitted_diagnostics = Default::default();
 644         inner.stashed_diagnostics = Default::default();
 645     }
 646
 647     /// Stash a given diagnostic with the given `Span` and `StashKey` as the key for later stealing.
 648     pub fn stash_diagnostic(&self, span: Span, key: StashKey, diag: Diagnostic) {
 649         let mut inner = self.inner.borrow_mut();
 650         inner.stash((span, key), diag);
 651     }
 652
 653     /// Steal a previously stashed diagnostic with the given `Span` and `StashKey` as the key.
 654     pub fn steal_diagnostic(&self, span: Span, key: StashKey) -> Option<DiagnosticBuilder<'_, ()>> {
 655         let mut inner = self.inner.borrow_mut();
 656         inner.steal((span, key)).map(|diag| DiagnosticBuilder::new_diagnostic(self, diag))
 657     }
 658
 659     pub fn has_stashed_diagnostic(&self, span: Span, key: StashKey) -> bool {
 660         self.inner.borrow().stashed_diagnostics.get(&(span, key)).is_some()
 661     }
 662
 663     /// Emit all stashed diagnostics.
 664     pub fn emit_stashed_diagnostics(&self) -> Option<ErrorGuaranteed> {
 665         self.inner.borrow_mut().emit_stashed_diagnostics()
 666     }
 667
 668     /// Construct a builder with the `msg` at the level appropriate for the specific `EmissionGuarantee`.
 669     #[rustc_lint_diagnostics]
 670     #[track_caller]
 671     pub fn struct_diagnostic<G: EmissionGuarantee>(
 672         &self,
 673         msg: impl Into<DiagnosticMessage>,
 674     ) -> DiagnosticBuilder<'_, G> {
 675         G::make_diagnostic_builder(self, msg)
 676     }
 677
 678     /// Construct a builder at the `Warning` level at the given `span` and with the `msg`.
 679     ///
 680     /// Attempting to `.emit()` the builder will only emit if either:
 681     /// * `can_emit_warnings` is `true`
 682     /// * `is_force_warn` was set in `DiagnosticId::Lint`
 683     #[rustc_lint_diagnostics]
 684     #[track_caller]
 685     pub fn struct_span_warn(
 686         &self,
 687         span: impl Into<MultiSpan>,
 688         msg: impl Into<DiagnosticMessage>,
 689     ) -> DiagnosticBuilder<'_, ()> {
 690         let mut result = self.struct_warn(msg);
 691         result.set_span(span);
 692         result
 693     }
 694
 695     /// Construct a builder at the `Warning` level at the given `span` and with the `msg`.
 696     /// The `id` is used for lint emissions which should also fulfill a lint expectation.
 697     ///
 698     /// Attempting to `.emit()` the builder will only emit if either:
 699     /// * `can_emit_warnings` is `true`
 700     /// * `is_force_warn` was set in `DiagnosticId::Lint`
 701     #[track_caller]
 702     pub fn struct_span_warn_with_expectation(
 703         &self,
 704         span: impl Into<MultiSpan>,
 705         msg: impl Into<DiagnosticMessage>,
 706         id: LintExpectationId,
 707     ) -> DiagnosticBuilder<'_, ()> {
 708         let mut result = self.struct_warn_with_expectation(msg, id);
 709         result.set_span(span);
 710         result
 711     }
 712
 713     /// Construct a builder at the `Allow` level at the given `span` and with the `msg`.
 714     #[rustc_lint_diagnostics]
 715     #[track_caller]
 716     pub fn struct_span_allow(
 717         &self,
 718         span: impl Into<MultiSpan>,
 719         msg: impl Into<DiagnosticMessage>,
 720     ) -> DiagnosticBuilder<'_, ()> {
 721         let mut result = self.struct_allow(msg);
 722         result.set_span(span);
 723         result
 724     }
 725
 726     /// Construct a builder at the `Warning` level at the given `span` and with the `msg`.
 727     /// Also include a code.
 728     #[rustc_lint_diagnostics]
 729     #[track_caller]
 730     pub fn struct_span_warn_with_code(
 731         &self,
 732         span: impl Into<MultiSpan>,
 733         msg: impl Into<DiagnosticMessage>,
 734         code: DiagnosticId,
 735     ) -> DiagnosticBuilder<'_, ()> {
 736         let mut result = self.struct_span_warn(span, msg);
 737         result.code(code);
 738         result
 739     }
 740
 741     /// Construct a builder at the `Warning` level with the `msg`.
 742     ///
 743     /// Attempting to `.emit()` the builder will only emit if either:
 744     /// * `can_emit_warnings` is `true`
 745     /// * `is_force_warn` was set in `DiagnosticId::Lint`
 746     #[rustc_lint_diagnostics]
 747     #[track_caller]
 748     pub fn struct_warn(&self, msg: impl Into<DiagnosticMessage>) -> DiagnosticBuilder<'_, ()> {
 749         DiagnosticBuilder::new(self, Level::Warning(None), msg)
 750     }
 751
 752     /// Construct a builder at the `Warning` level with the `msg`. The `id` is used for
 753     /// lint emissions which should also fulfill a lint expectation.
 754     ///
 755     /// Attempting to `.emit()` the builder will only emit if either:
 756     /// * `can_emit_warnings` is `true`
 757     /// * `is_force_warn` was set in `DiagnosticId::Lint`
 758     #[track_caller]
 759     pub fn struct_warn_with_expectation(
 760         &self,
 761         msg: impl Into<DiagnosticMessage>,
 762         id: LintExpectationId,
 763     ) -> DiagnosticBuilder<'_, ()> {
 764         DiagnosticBuilder::new(self, Level::Warning(Some(id)), msg)
 765     }
 766
 767     /// Construct a builder at the `Allow` level with the `msg`.
 768     #[rustc_lint_diagnostics]
 769     #[track_caller]
 770     pub fn struct_allow(&self, msg: impl Into<DiagnosticMessage>) -> DiagnosticBuilder<'_, ()> {
 771         DiagnosticBuilder::new(self, Level::Allow, msg)
 772     }
 773
 774     /// Construct a builder at the `Expect` level with the `msg`.
 775     #[rustc_lint_diagnostics]
 776     #[track_caller]
 777     pub fn struct_expect(
 778         &self,
 779         msg: impl Into<DiagnosticMessage>,
 780         id: LintExpectationId,
 781     ) -> DiagnosticBuilder<'_, ()> {
 782         DiagnosticBuilder::new(self, Level::Expect(id), msg)
 783     }
 784
 785     /// Construct a builder at the `Error` level at the given `span` and with the `msg`.
 786     #[rustc_lint_diagnostics]
 787     #[track_caller]
 788     pub fn struct_span_err(
 789         &self,
 790         span: impl Into<MultiSpan>,
 791         msg: impl Into<DiagnosticMessage>,
 792     ) -> DiagnosticBuilder<'_, ErrorGuaranteed> {
 793         let mut result = self.struct_err(msg);
 794         result.set_span(span);
 795         result
 796     }
 797
 798     /// Construct a builder at the `Error` level at the given `span`, with the `msg`, and `code`.
 799     #[rustc_lint_diagnostics]
 800     #[track_caller]
 801     pub fn struct_span_err_with_code(
 802         &self,
 803         span: impl Into<MultiSpan>,
 804         msg: impl Into<DiagnosticMessage>,
 805         code: DiagnosticId,
 806     ) -> DiagnosticBuilder<'_, ErrorGuaranteed> {
 807         let mut result = self.struct_span_err(span, msg);
 808         result.code(code);
 809         result
 810     }
 811
 812     /// Construct a builder at the `Error` level with the `msg`.
 813     // FIXME: This method should be removed (every error should have an associated error code).
 814     #[rustc_lint_diagnostics]
 815     #[track_caller]
 816     pub fn struct_err(
 817         &self,
 818         msg: impl Into<DiagnosticMessage>,
 819     ) -> DiagnosticBuilder<'_, ErrorGuaranteed> {
 820         DiagnosticBuilder::new_guaranteeing_error::<_, { Level::Error { lint: false } }>(self, msg)
 821     }
 822
 823     /// This should only be used by `rustc_middle::lint::struct_lint_level`. Do not use it for hard errors.
 824     #[doc(hidden)]
 825     #[track_caller]
 826     pub fn struct_err_lint(&self, msg: impl Into<DiagnosticMessage>) -> DiagnosticBuilder<'_, ()> {
 827         DiagnosticBuilder::new(self, Level::Error { lint: true }, msg)
 828     }
 829
 830     /// Construct a builder at the `Error` level with the `msg` and the `code`.
 831     #[rustc_lint_diagnostics]
 832     #[track_caller]
 833     pub fn struct_err_with_code(
 834         &self,
 835         msg: impl Into<DiagnosticMessage>,
 836         code: DiagnosticId,
 837     ) -> DiagnosticBuilder<'_, ErrorGuaranteed> {
 838         let mut result = self.struct_err(msg);
 839         result.code(code);
 840         result
 841     }
 842
 843     /// Construct a builder at the `Warn` level with the `msg` and the `code`.
 844     #[rustc_lint_diagnostics]
 845     #[track_caller]
 846     pub fn struct_warn_with_code(
 847         &self,
 848         msg: impl Into<DiagnosticMessage>,
 849         code: DiagnosticId,
 850     ) -> DiagnosticBuilder<'_, ()> {
 851         let mut result = self.struct_warn(msg);
 852         result.code(code);
 853         result
 854     }
 855
 856     /// Construct a builder at the `Fatal` level at the given `span` and with the `msg`.
 857     #[rustc_lint_diagnostics]
 858     #[track_caller]
 859     pub fn struct_span_fatal(
 860         &self,
 861         span: impl Into<MultiSpan>,
 862         msg: impl Into<DiagnosticMessage>,
 863     ) -> DiagnosticBuilder<'_, !> {
 864         let mut result = self.struct_fatal(msg);
 865         result.set_span(span);
 866         result
 867     }
 868
 869     /// Construct a builder at the `Fatal` level at the given `span`, with the `msg`, and `code`.
 870     #[rustc_lint_diagnostics]
 871     #[track_caller]
 872     pub fn struct_span_fatal_with_code(
 873         &self,
 874         span: impl Into<MultiSpan>,
 875         msg: impl Into<DiagnosticMessage>,
 876         code: DiagnosticId,
 877     ) -> DiagnosticBuilder<'_, !> {
 878         let mut result = self.struct_span_fatal(span, msg);
 879         result.code(code);
 880         result
 881     }
 882
 883     /// Construct a builder at the `Error` level with the `msg`.
 884     #[rustc_lint_diagnostics]
 885     #[track_caller]
 886     pub fn struct_fatal(&self, msg: impl Into<DiagnosticMessage>) -> DiagnosticBuilder<'_, !> {
 887         DiagnosticBuilder::new_fatal(self, msg)
 888     }
 889
 890     /// Construct a builder at the `Help` level with the `msg`.
 891     #[rustc_lint_diagnostics]
 892     pub fn struct_help(&self, msg: impl Into<DiagnosticMessage>) -> DiagnosticBuilder<'_, ()> {
 893         DiagnosticBuilder::new(self, Level::Help, msg)
 894     }
 895
 896     /// Construct a builder at the `Note` level with the `msg`.
 897     #[rustc_lint_diagnostics]
 898     #[track_caller]
 899     pub fn struct_note_without_error(
 900         &self,
 901         msg: impl Into<DiagnosticMessage>,
 902     ) -> DiagnosticBuilder<'_, ()> {
 903         DiagnosticBuilder::new(self, Level::Note, msg)
 904     }
 905
 906     #[rustc_lint_diagnostics]
 907     #[track_caller]
 908     pub fn span_fatal(&self, span: impl Into<MultiSpan>, msg: impl Into<DiagnosticMessage>) -> ! {
 909         self.emit_diag_at_span(Diagnostic::new(Fatal, msg), span);
 910         FatalError.raise()
 911     }
 912
 913     #[rustc_lint_diagnostics]
 914     #[track_caller]
 915     pub fn span_fatal_with_code(
 916         &self,
 917         span: impl Into<MultiSpan>,
 918         msg: impl Into<DiagnosticMessage>,
 919         code: DiagnosticId,
 920     ) -> ! {
 921         self.emit_diag_at_span(Diagnostic::new_with_code(Fatal, Some(code), msg), span);
 922         FatalError.raise()
 923     }
 924
 925     #[rustc_lint_diagnostics]
 926     #[track_caller]
 927     pub fn span_err(
 928         &self,
 929         span: impl Into<MultiSpan>,
 930         msg: impl Into<DiagnosticMessage>,
 931     ) -> ErrorGuaranteed {
 932         self.emit_diag_at_span(Diagnostic::new(Error { lint: false }, msg), span).unwrap()
 933     }
 934
 935     #[rustc_lint_diagnostics]
 936     #[track_caller]
 937     pub fn span_err_with_code(
 938         &self,
 939         span: impl Into<MultiSpan>,
 940         msg: impl Into<DiagnosticMessage>,
 941         code: DiagnosticId,
 942     ) {
 943         self.emit_diag_at_span(
 944             Diagnostic::new_with_code(Error { lint: false }, Some(code), msg),
 945             span,
 946         );
 947     }
 948
 949     #[rustc_lint_diagnostics]
 950     #[track_caller]
 951     pub fn span_warn(&self, span: impl Into<MultiSpan>, msg: impl Into<DiagnosticMessage>) {
 952         self.emit_diag_at_span(Diagnostic::new(Warning(None), msg), span);
 953     }
 954
 955     #[rustc_lint_diagnostics]
 956     #[track_caller]
 957     pub fn span_warn_with_code(
 958         &self,
 959         span: impl Into<MultiSpan>,
 960         msg: impl Into<DiagnosticMessage>,
 961         code: DiagnosticId,
 962     ) {
 963         self.emit_diag_at_span(Diagnostic::new_with_code(Warning(None), Some(code), msg), span);
 964     }
 965
 966     pub fn span_bug(&self, span: impl Into<MultiSpan>, msg: impl Into<DiagnosticMessage>) -> ! {
 967         self.inner.borrow_mut().span_bug(span, msg)
 968     }
 969
 970     #[track_caller]
 971     pub fn delay_span_bug(
 972         &self,
 973         span: impl Into<MultiSpan>,
 974         msg: impl Into<DiagnosticMessage>,
 975     ) -> ErrorGuaranteed {
 976         self.inner.borrow_mut().delay_span_bug(span, msg)
 977     }
 978
 979     // FIXME(eddyb) note the comment inside `impl Drop for HandlerInner`, that's
 980     // where the explanation of what "good path" is (also, it should be renamed).
 981     pub fn delay_good_path_bug(&self, msg: impl Into<DiagnosticMessage>) {
 982         self.inner.borrow_mut().delay_good_path_bug(msg)
 983     }
 984
 985     #[track_caller]
 986     pub fn span_bug_no_panic(&self, span: impl Into<MultiSpan>, msg: impl Into<DiagnosticMessage>) {
 987         self.emit_diag_at_span(Diagnostic::new(Bug, msg), span);
 988     }
 989
 990     #[track_caller]
 991     pub fn span_note_without_error(
 992         &self,
 993         span: impl Into<MultiSpan>,
 994         msg: impl Into<DiagnosticMessage>,
 995     ) {
 996         self.emit_diag_at_span(Diagnostic::new(Note, msg), span);
 997     }
 998
 999     #[track_caller]
1000     pub fn span_note_diag(
1001         &self,
1002         span: Span,
1003         msg: impl Into<DiagnosticMessage>,
1004     ) -> DiagnosticBuilder<'_, ()> {
1005         let mut db = DiagnosticBuilder::new(self, Note, msg);
1006         db.set_span(span);
1007         db
1008     }
1009
1010     // NOTE: intentionally doesn't raise an error so rustc_codegen_ssa only reports fatal errors in the main thread
1011     pub fn fatal(&self, msg: impl Into<DiagnosticMessage>) -> FatalError {
1012         self.inner.borrow_mut().fatal(msg)
1013     }
1014
1015     pub fn err(&self, msg: impl Into<DiagnosticMessage>) -> ErrorGuaranteed {
1016         self.inner.borrow_mut().err(msg)
1017     }
1018
1019     pub fn warn(&self, msg: impl Into<DiagnosticMessage>) {
1020         let mut db = DiagnosticBuilder::new(self, Warning(None), msg);
1021         db.emit();
1022     }
1023
1024     pub fn note_without_error(&self, msg: impl Into<DiagnosticMessage>) {
1025         DiagnosticBuilder::new(self, Note, msg).emit();
1026     }
1027
1028     pub fn bug(&self, msg: impl Into<DiagnosticMessage>) -> ! {
1029         self.inner.borrow_mut().bug(msg)
1030     }
1031
1032     #[inline]
1033     pub fn err_count(&self) -> usize {
1034         self.inner.borrow().err_count()
1035     }
1036
1037     pub fn has_errors(&self) -> Option<ErrorGuaranteed> {
1038         if self.inner.borrow().has_errors() { Some(ErrorGuaranteed(())) } else { None }
1039     }
1040     pub fn has_errors_or_lint_errors(&self) -> Option<ErrorGuaranteed> {
1041         if self.inner.borrow().has_errors_or_lint_errors() {
1042             Some(ErrorGuaranteed(()))
1043         } else {
1044             None
1045         }
1046     }
1047     pub fn has_errors_or_delayed_span_bugs(&self) -> bool {
1048         self.inner.borrow().has_errors_or_delayed_span_bugs()
1049     }
1050
1051     pub fn print_error_count(&self, registry: &Registry) {
1052         self.inner.borrow_mut().print_error_count(registry)
1053     }
1054
1055     pub fn take_future_breakage_diagnostics(&self) -> Vec<Diagnostic> {
1056         std::mem::take(&mut self.inner.borrow_mut().future_breakage_diagnostics)
1057     }
1058
1059     pub fn abort_if_errors(&self) {
1060         self.inner.borrow_mut().abort_if_errors()
1061     }
1062
1063     /// `true` if we haven't taught a diagnostic with this code already.
1064     /// The caller must then teach the user about such a diagnostic.
1065     ///
1066     /// Used to suppress emitting the same error multiple times with extended explanation when
1067     /// calling `-Zteach`.
1068     pub fn must_teach(&self, code: &DiagnosticId) -> bool {
1069         self.inner.borrow_mut().must_teach(code)
1070     }
1071
1072     pub fn force_print_diagnostic(&self, db: Diagnostic) {
1073         self.inner.borrow_mut().force_print_diagnostic(db)
1074     }
1075
1076     pub fn emit_diagnostic(&self, diagnostic: &mut Diagnostic) -> Option<ErrorGuaranteed> {
1077         self.inner.borrow_mut().emit_diagnostic(diagnostic)
1078     }
1079
1080     pub fn emit_err<'a>(&'a self, err: impl IntoDiagnostic<'a>) -> ErrorGuaranteed {
1081         self.create_err(err).emit()
1082     }
1083
1084     pub fn create_err<'a>(
1085         &'a self,
1086         err: impl IntoDiagnostic<'a>,
1087     ) -> DiagnosticBuilder<'a, ErrorGuaranteed> {
1088         err.into_diagnostic(self)
1089     }
1090
1091     pub fn create_warning<'a>(
1092         &'a self,
1093         warning: impl IntoDiagnostic<'a, ()>,
1094     ) -> DiagnosticBuilder<'a, ()> {
1095         warning.into_diagnostic(self)
1096     }
1097
1098     pub fn emit_warning<'a>(&'a self, warning: impl IntoDiagnostic<'a, ()>) {
1099         self.create_warning(warning).emit()
1100     }
1101
1102     pub fn create_fatal<'a>(
1103         &'a self,
1104         fatal: impl IntoDiagnostic<'a, !>,
1105     ) -> DiagnosticBuilder<'a, !> {
1106         fatal.into_diagnostic(self)
1107     }
1108
1109     pub fn emit_fatal<'a>(&'a self, fatal: impl IntoDiagnostic<'a, !>) -> ! {
1110         self.create_fatal(fatal).emit()
1111     }
1112
1113     fn emit_diag_at_span(
1114         &self,
1115         mut diag: Diagnostic,
1116         sp: impl Into<MultiSpan>,
1117     ) -> Option<ErrorGuaranteed> {
1118         let mut inner = self.inner.borrow_mut();
1119         inner.emit_diagnostic(diag.set_span(sp))
1120     }
1121
1122     pub fn emit_artifact_notification(&self, path: &Path, artifact_type: &str) {
1123         self.inner.borrow_mut().emit_artifact_notification(path, artifact_type)
1124     }
1125
1126     pub fn emit_future_breakage_report(&self, diags: Vec<Diagnostic>) {
1127         self.inner.borrow_mut().emitter.emit_future_breakage_report(diags)
1128     }
1129
1130     pub fn emit_unused_externs(
1131         &self,
1132         lint_level: rustc_lint_defs::Level,
1133         loud: bool,
1134         unused_externs: &[&str],
1135     ) {
1136         let mut inner = self.inner.borrow_mut();
1137
1138         if loud && lint_level.is_error() {
1139             inner.bump_err_count();
1140         }
1141
1142         inner.emit_unused_externs(lint_level, unused_externs)
1143     }
1144
1145     pub fn update_unstable_expectation_id(
1146         &self,
1147         unstable_to_stable: &FxHashMap<LintExpectationId, LintExpectationId>,
1148     ) {
1149         let mut inner = self.inner.borrow_mut();
1150         let diags = std::mem::take(&mut inner.unstable_expect_diagnostics);
1151         inner.check_unstable_expect_diagnostics = true;
1152
1153         if !diags.is_empty() {
1154             inner.suppressed_expected_diag = true;
1155             for mut diag in diags.into_iter() {
1156                 diag.update_unstable_expectation_id(unstable_to_stable);
1157
1158                 // Here the diagnostic is given back to `emit_diagnostic` where it was first
1159                 // intercepted. Now it should be processed as usual, since the unstable expectation
1160                 // id is now stable.
1161                 inner.emit_diagnostic(&mut diag);
1162             }
1163         }
1164
1165         inner
1166             .stashed_diagnostics
1167             .values_mut()
1168             .for_each(|diag| diag.update_unstable_expectation_id(unstable_to_stable));
1169         inner
1170             .future_breakage_diagnostics
1171             .iter_mut()
1172             .for_each(|diag| diag.update_unstable_expectation_id(unstable_to_stable));
1173     }
1174
1175     /// This methods steals all [`LintExpectationId`]s that are stored inside
1176     /// [`HandlerInner`] and indicate that the linked expectation has been fulfilled.
1177     #[must_use]
1178     pub fn steal_fulfilled_expectation_ids(&self) -> FxHashSet<LintExpectationId> {
1179         assert!(
1180             self.inner.borrow().unstable_expect_diagnostics.is_empty(),
1181             "`HandlerInner::unstable_expect_diagnostics` should be empty at this point",
1182         );
1183         std::mem::take(&mut self.inner.borrow_mut().fulfilled_expectations)
1184     }
1185
1186     pub fn flush_delayed(&self) {
1187         let mut inner = self.inner.lock();
1188         let bugs = std::mem::replace(&mut inner.delayed_span_bugs, Vec::new());
1189         inner.flush_delayed(bugs, "no errors encountered even though `delay_span_bug` issued");
1190     }
1191 }
1192
1193 impl HandlerInner {
1194     fn must_teach(&mut self, code: &DiagnosticId) -> bool {
1195         self.taught_diagnostics.insert(code.clone())
1196     }
1197
1198     fn force_print_diagnostic(&mut self, mut db: Diagnostic) {
1199         self.emitter.emit_diagnostic(&mut db);
1200     }
1201
1202     /// Emit all stashed diagnostics.
1203     fn emit_stashed_diagnostics(&mut self) -> Option<ErrorGuaranteed> {
1204         let has_errors = self.has_errors();
1205         let diags = self.stashed_diagnostics.drain(..).map(|x| x.1).collect::<Vec<_>>();
1206         let mut reported = None;
1207         for mut diag in diags {
1208             // Decrement the count tracking the stash; emitting will increment it.
1209             if diag.is_error() {
1210                 if matches!(diag.level, Level::Error { lint: true }) {
1211                     self.lint_err_count -= 1;
1212                 } else {
1213                     self.err_count -= 1;
1214                 }
1215             } else {
1216                 if diag.is_force_warn() {
1217                     self.warn_count -= 1;
1218                 } else {
1219                     // Unless they're forced, don't flush stashed warnings when
1220                     // there are errors, to avoid causing warning overload. The
1221                     // stash would've been stolen already if it were important.
1222                     if has_errors {
1223                         continue;
1224                     }
1225                 }
1226             }
1227             let reported_this = self.emit_diagnostic(&mut diag);
1228             reported = reported.or(reported_this);
1229         }
1230         reported
1231     }
1232
1233     // FIXME(eddyb) this should ideally take `diagnostic` by value.
1234     fn emit_diagnostic(&mut self, diagnostic: &mut Diagnostic) -> Option<ErrorGuaranteed> {
1235         // The `LintExpectationId` can be stable or unstable depending on when it was created.
1236         // Diagnostics created before the definition of `HirId`s are unstable and can not yet
1237         // be stored. Instead, they are buffered until the `LintExpectationId` is replaced by
1238         // a stable one by the `LintLevelsBuilder`.
1239         if let Some(LintExpectationId::Unstable { .. }) = diagnostic.level.get_expectation_id() {
1240             self.unstable_expect_diagnostics.push(diagnostic.clone());
1241             return None;
1242         }
1243
1244         if diagnostic.level == Level::DelayedBug {
1245             // FIXME(eddyb) this should check for `has_errors` and stop pushing
1246             // once *any* errors were emitted (and truncate `delayed_span_bugs`
1247             // when an error is first emitted, also), but maybe there's a case
1248             // in which that's not sound? otherwise this is really inefficient.
1249             self.delayed_span_bugs.push(diagnostic.clone());
1250
1251             if !self.flags.report_delayed_bugs {
1252                 return Some(ErrorGuaranteed::unchecked_claim_error_was_emitted());
1253             }
1254         }
1255
1256         if diagnostic.has_future_breakage() {
1257             self.future_breakage_diagnostics.push(diagnostic.clone());
1258         }
1259
1260         if let Some(expectation_id) = diagnostic.level.get_expectation_id() {
1261             self.suppressed_expected_diag = true;
1262             self.fulfilled_expectations.insert(expectation_id.normalize());
1263         }
1264
1265         if matches!(diagnostic.level, Warning(_))
1266             && !self.flags.can_emit_warnings
1267             && !diagnostic.is_force_warn()
1268         {
1269             if diagnostic.has_future_breakage() {
1270                 (*TRACK_DIAGNOSTICS)(diagnostic);
1271             }
1272             return None;
1273         }
1274
1275         (*TRACK_DIAGNOSTICS)(diagnostic);
1276
1277         if matches!(diagnostic.level, Level::Expect(_) | Level::Allow) {
1278             return None;
1279         }
1280
1281         if let Some(ref code) = diagnostic.code {
1282             self.emitted_diagnostic_codes.insert(code.clone());
1283         }
1284
1285         let already_emitted = |this: &mut Self| {
1286             let mut hasher = StableHasher::new();
1287             diagnostic.hash(&mut hasher);
1288             let diagnostic_hash = hasher.finish();
1289             !this.emitted_diagnostics.insert(diagnostic_hash)
1290         };
1291
1292         // Only emit the diagnostic if we've been asked to deduplicate or
1293         // haven't already emitted an equivalent diagnostic.
1294         if !(self.flags.deduplicate_diagnostics && already_emitted(self)) {
1295             debug!(?diagnostic);
1296             debug!(?self.emitted_diagnostics);
1297             let already_emitted_sub = |sub: &mut SubDiagnostic| {
1298                 debug!(?sub);
1299                 if sub.level != Level::OnceNote {
1300                     return false;
1301                 }
1302                 let mut hasher = StableHasher::new();
1303                 sub.hash(&mut hasher);
1304                 let diagnostic_hash = hasher.finish();
1305                 debug!(?diagnostic_hash);
1306                 !self.emitted_diagnostics.insert(diagnostic_hash)
1307             };
1308
1309             diagnostic.children.drain_filter(already_emitted_sub).for_each(|_| {});
1310
1311             self.emitter.emit_diagnostic(&diagnostic);
1312             if diagnostic.is_error() {
1313                 self.deduplicated_err_count += 1;
1314             } else if let Warning(_) = diagnostic.level {
1315                 self.deduplicated_warn_count += 1;
1316             }
1317         }
1318         if diagnostic.is_error() {
1319             if matches!(diagnostic.level, Level::Error { lint: true }) {
1320                 self.bump_lint_err_count();
1321             } else {
1322                 self.bump_err_count();
1323             }
1324
1325             Some(ErrorGuaranteed::unchecked_claim_error_was_emitted())
1326         } else {
1327             self.bump_warn_count();
1328
1329             None
1330         }
1331     }
1332
1333     fn emit_artifact_notification(&mut self, path: &Path, artifact_type: &str) {
1334         self.emitter.emit_artifact_notification(path, artifact_type);
1335     }
1336
1337     fn emit_unused_externs(&mut self, lint_level: rustc_lint_defs::Level, unused_externs: &[&str]) {
1338         self.emitter.emit_unused_externs(lint_level, unused_externs);
1339     }
1340
1341     fn treat_err_as_bug(&self) -> bool {
1342         self.flags.treat_err_as_bug.map_or(false, |c| {
1343             self.err_count() + self.lint_err_count + self.delayed_bug_count() >= c.get()
1344         })
1345     }
1346
1347     fn delayed_bug_count(&self) -> usize {
1348         self.delayed_span_bugs.len() + self.delayed_good_path_bugs.len()
1349     }
1350
1351     fn print_error_count(&mut self, registry: &Registry) {
1352         self.emit_stashed_diagnostics();
1353
1354         let warnings = match self.deduplicated_warn_count {
1355             0 => String::new(),
1356             1 => "1 warning emitted".to_string(),
1357             count => format!("{count} warnings emitted"),
1358         };
1359         let errors = match self.deduplicated_err_count {
1360             0 => String::new(),
1361             1 => "aborting due to previous error".to_string(),
1362             count => format!("aborting due to {count} previous errors"),
1363         };
1364         if self.treat_err_as_bug() {
1365             return;
1366         }
1367
1368         match (errors.len(), warnings.len()) {
1369             (0, 0) => return,
1370             (0, _) => self.emitter.emit_diagnostic(&Diagnostic::new(
1371                 Level::Warning(None),
1372                 DiagnosticMessage::Str(warnings),
1373             )),
1374             (_, 0) => {
1375                 let _ = self.fatal(&errors);
1376             }
1377             (_, _) => {
1378                 let _ = self.fatal(&format!("{}; {}", &errors, &warnings));
1379             }
1380         }
1381
1382         let can_show_explain = self.emitter.should_show_explain();
1383         let are_there_diagnostics = !self.emitted_diagnostic_codes.is_empty();
1384         if can_show_explain && are_there_diagnostics {
1385             let mut error_codes = self
1386                 .emitted_diagnostic_codes
1387                 .iter()
1388                 .filter_map(|x| match &x {
1389                     DiagnosticId::Error(s)
1390                         if registry.try_find_description(s).map_or(false, |o| o.is_some()) =>
1391                     {
1392                         Some(s.clone())
1393                     }
1394                     _ => None,
1395                 })
1396                 .collect::<Vec<_>>();
1397             if !error_codes.is_empty() {
1398                 error_codes.sort();
1399                 if error_codes.len() > 1 {
1400                     let limit = if error_codes.len() > 9 { 9 } else { error_codes.len() };
1401                     self.failure(&format!(
1402                         "Some errors have detailed explanations: {}{}",
1403                         error_codes[..limit].join(", "),
1404                         if error_codes.len() > 9 { "..." } else { "." }
1405                     ));
1406                     self.failure(&format!(
1407                         "For more information about an error, try \
1408                          `rustc --explain {}`.",
1409                         &error_codes[0]
1410                     ));
1411                 } else {
1412                     self.failure(&format!(
1413                         "For more information about this error, try \
1414                          `rustc --explain {}`.",
1415                         &error_codes[0]
1416                     ));
1417                 }
1418             }
1419         }
1420     }
1421
1422     fn stash(&mut self, key: (Span, StashKey), diagnostic: Diagnostic) {
1423         // Track the diagnostic for counts, but don't panic-if-treat-err-as-bug
1424         // yet; that happens when we actually emit the diagnostic.
1425         if diagnostic.is_error() {
1426             if matches!(diagnostic.level, Level::Error { lint: true }) {
1427                 self.lint_err_count += 1;
1428             } else {
1429                 self.err_count += 1;
1430             }
1431         } else {
1432             // Warnings are only automatically flushed if they're forced.
1433             if diagnostic.is_force_warn() {
1434                 self.warn_count += 1;
1435             }
1436         }
1437
1438         // FIXME(Centril, #69537): Consider reintroducing panic on overwriting a stashed diagnostic
1439         // if/when we have a more robust macro-friendly replacement for `(span, key)` as a key.
1440         // See the PR for a discussion.
1441         self.stashed_diagnostics.insert(key, diagnostic);
1442     }
1443
1444     fn steal(&mut self, key: (Span, StashKey)) -> Option<Diagnostic> {
1445         let diagnostic = self.stashed_diagnostics.remove(&key)?;
1446         if diagnostic.is_error() {
1447             if matches!(diagnostic.level, Level::Error { lint: true }) {
1448                 self.lint_err_count -= 1;
1449             } else {
1450                 self.err_count -= 1;
1451             }
1452         } else {
1453             if diagnostic.is_force_warn() {
1454                 self.warn_count -= 1;
1455             }
1456         }
1457         Some(diagnostic)
1458     }
1459
1460     #[inline]
1461     fn err_count(&self) -> usize {
1462         self.err_count
1463     }
1464
1465     fn has_errors(&self) -> bool {
1466         self.err_count() > 0
1467     }
1468     fn has_errors_or_lint_errors(&self) -> bool {
1469         self.has_errors() || self.lint_err_count > 0
1470     }
1471     fn has_errors_or_delayed_span_bugs(&self) -> bool {
1472         self.has_errors() || !self.delayed_span_bugs.is_empty()
1473     }
1474     fn has_any_message(&self) -> bool {
1475         self.err_count() > 0 || self.lint_err_count > 0 || self.warn_count > 0
1476     }
1477
1478     fn abort_if_errors(&mut self) {
1479         self.emit_stashed_diagnostics();
1480
1481         if self.has_errors() {
1482             FatalError.raise();
1483         }
1484     }
1485
1486     #[track_caller]
1487     fn span_bug(&mut self, sp: impl Into<MultiSpan>, msg: impl Into<DiagnosticMessage>) -> ! {
1488         self.emit_diag_at_span(Diagnostic::new(Bug, msg), sp);
1489         panic::panic_any(ExplicitBug);
1490     }
1491
1492     fn emit_diag_at_span(&mut self, mut diag: Diagnostic, sp: impl Into<MultiSpan>) {
1493         self.emit_diagnostic(diag.set_span(sp));
1494     }
1495
1496     #[track_caller]
1497     fn delay_span_bug(
1498         &mut self,
1499         sp: impl Into<MultiSpan>,
1500         msg: impl Into<DiagnosticMessage>,
1501     ) -> ErrorGuaranteed {
1502         // This is technically `self.treat_err_as_bug()` but `delay_span_bug` is called before
1503         // incrementing `err_count` by one, so we need to +1 the comparing.
1504         // FIXME: Would be nice to increment err_count in a more coherent way.
1505         if self.flags.treat_err_as_bug.map_or(false, |c| {
1506             self.err_count() + self.lint_err_count + self.delayed_bug_count() + 1 >= c.get()
1507         }) {
1508             // FIXME: don't abort here if report_delayed_bugs is off
1509             self.span_bug(sp, msg);
1510         }
1511         let mut diagnostic = Diagnostic::new(Level::DelayedBug, msg);
1512         diagnostic.set_span(sp.into());
1513         diagnostic.note(&format!("delayed at {}", std::panic::Location::caller()));
1514         self.emit_diagnostic(&mut diagnostic).unwrap()
1515     }
1516
1517     // FIXME(eddyb) note the comment inside `impl Drop for HandlerInner`, that's
1518     // where the explanation of what "good path" is (also, it should be renamed).
1519     fn delay_good_path_bug(&mut self, msg: impl Into<DiagnosticMessage>) {
1520         let mut diagnostic = Diagnostic::new(Level::DelayedBug, msg);
1521         if self.flags.report_delayed_bugs {
1522             self.emit_diagnostic(&mut diagnostic);
1523         }
1524         let backtrace = std::backtrace::Backtrace::force_capture();
1525         self.delayed_good_path_bugs.push(DelayedDiagnostic::with_backtrace(diagnostic, backtrace));
1526     }
1527
1528     fn failure(&mut self, msg: impl Into<DiagnosticMessage>) {
1529         self.emit_diagnostic(&mut Diagnostic::new(FailureNote, msg));
1530     }
1531
1532     fn fatal(&mut self, msg: impl Into<DiagnosticMessage>) -> FatalError {
1533         self.emit(Fatal, msg);
1534         FatalError
1535     }
1536
1537     fn err(&mut self, msg: impl Into<DiagnosticMessage>) -> ErrorGuaranteed {
1538         self.emit(Error { lint: false }, msg)
1539     }
1540
1541     /// Emit an error; level should be `Error` or `Fatal`.
1542     fn emit(&mut self, level: Level, msg: impl Into<DiagnosticMessage>) -> ErrorGuaranteed {
1543         if self.treat_err_as_bug() {
1544             self.bug(msg);
1545         }
1546         self.emit_diagnostic(&mut Diagnostic::new(level, msg)).unwrap()
1547     }
1548
1549     fn bug(&mut self, msg: impl Into<DiagnosticMessage>) -> ! {
1550         self.emit_diagnostic(&mut Diagnostic::new(Bug, msg));
1551         panic::panic_any(ExplicitBug);
1552     }
1553
1554     fn flush_delayed(
1555         &mut self,
1556         bugs: impl IntoIterator<Item = Diagnostic>,
1557         explanation: impl Into<DiagnosticMessage> + Copy,
1558     ) {
1559         let mut no_bugs = true;
1560         for mut bug in bugs {
1561             if no_bugs {
1562                 // Put the overall explanation before the `DelayedBug`s, to
1563                 // frame them better (e.g. separate warnings from them).
1564                 self.emit_diagnostic(&mut Diagnostic::new(Bug, explanation));
1565                 no_bugs = false;
1566             }
1567
1568             // "Undelay" the `DelayedBug`s (into plain `Bug`s).
1569             if bug.level != Level::DelayedBug {
1570                 // NOTE(eddyb) not panicking here because we're already producing
1571                 // an ICE, and the more information the merrier.
1572                 bug.note(&format!(
1573                     "`flushed_delayed` got diagnostic with level {:?}, \
1574                      instead of the expected `DelayedBug`",
1575                     bug.level,
1576                 ));
1577             }
1578             bug.level = Level::Bug;
1579
1580             self.emit_diagnostic(&mut bug);
1581         }
1582
1583         // Panic with `ExplicitBug` to avoid "unexpected panic" messages.
1584         if !no_bugs {
1585             panic::panic_any(ExplicitBug);
1586         }
1587     }
1588
1589     fn bump_lint_err_count(&mut self) {
1590         self.lint_err_count += 1;
1591         self.panic_if_treat_err_as_bug();
1592     }
1593
1594     fn bump_err_count(&mut self) {
1595         self.err_count += 1;
1596         self.panic_if_treat_err_as_bug();
1597     }
1598
1599     fn bump_warn_count(&mut self) {
1600         self.warn_count += 1;
1601     }
1602
1603     fn panic_if_treat_err_as_bug(&self) {
1604         if self.treat_err_as_bug() {
1605             match (
1606                 self.err_count() + self.lint_err_count,
1607                 self.delayed_bug_count(),
1608                 self.flags.treat_err_as_bug.map(|c| c.get()).unwrap_or(0),
1609             ) {
1610                 (1, 0, 1) => panic!("aborting due to `-Z treat-err-as-bug=1`"),
1611                 (0, 1, 1) => panic!("aborting due delayed bug with `-Z treat-err-as-bug=1`"),
1612                 (count, delayed_count, as_bug) => {
1613                     if delayed_count > 0 {
1614                         panic!(
1615                             "aborting after {} errors and {} delayed bugs due to `-Z treat-err-as-bug={}`",
1616                             count, delayed_count, as_bug,
1617                         )
1618                     } else {
1619                         panic!(
1620                             "aborting after {} errors due to `-Z treat-err-as-bug={}`",
1621                             count, as_bug,
1622                         )
1623                     }
1624                 }
1625             }
1626         }
1627     }
1628 }
1629
1630 struct DelayedDiagnostic {
1631     inner: Diagnostic,
1632     note: Backtrace,
1633 }
1634
1635 impl DelayedDiagnostic {
1636     fn with_backtrace(diagnostic: Diagnostic, backtrace: Backtrace) -> Self {
1637         DelayedDiagnostic { inner: diagnostic, note: backtrace }
1638     }
1639
1640     fn decorate(mut self) -> Diagnostic {
1641         self.inner.note(&format!("delayed at {}", self.note));
1642         self.inner
1643     }
1644 }
1645
1646 #[derive(Copy, PartialEq, Eq, Clone, Hash, Debug, Encodable, Decodable)]
1647 pub enum Level {
1648     Bug,
1649     DelayedBug,
1650     Fatal,
1651     Error {
1652         /// If this error comes from a lint, don't abort compilation even when abort_if_errors() is called.
1653         lint: bool,
1654     },
1655     /// This [`LintExpectationId`] is used for expected lint diagnostics, which should
1656     /// also emit a warning due to the `force-warn` flag. In all other cases this should
1657     /// be `None`.
1658     Warning(Option<LintExpectationId>),
1659     Note,
1660     /// A note that is only emitted once.
1661     OnceNote,
1662     Help,
1663     FailureNote,
1664     Allow,
1665     Expect(LintExpectationId),
1666 }
1667
1668 impl fmt::Display for Level {
1669     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1670         self.to_str().fmt(f)
1671     }
1672 }
1673
1674 impl Level {
1675     fn color(self) -> ColorSpec {
1676         let mut spec = ColorSpec::new();
1677         match self {
1678             Bug | DelayedBug | Fatal | Error { .. } => {
1679                 spec.set_fg(Some(Color::Red)).set_intense(true);
1680             }
1681             Warning(_) => {
1682                 spec.set_fg(Some(Color::Yellow)).set_intense(cfg!(windows));
1683             }
1684             Note | OnceNote => {
1685                 spec.set_fg(Some(Color::Green)).set_intense(true);
1686             }
1687             Help => {
1688                 spec.set_fg(Some(Color::Cyan)).set_intense(true);
1689             }
1690             FailureNote => {}
1691             Allow | Expect(_) => unreachable!(),
1692         }
1693         spec
1694     }
1695
1696     pub fn to_str(self) -> &'static str {
1697         match self {
1698             Bug | DelayedBug => "error: internal compiler error",
1699             Fatal | Error { .. } => "error",
1700             Warning(_) => "warning",
1701             Note | OnceNote => "note",
1702             Help => "help",
1703             FailureNote => "failure-note",
1704             Allow => panic!("Shouldn't call on allowed error"),
1705             Expect(_) => panic!("Shouldn't call on expected error"),
1706         }
1707     }
1708
1709     pub fn is_failure_note(&self) -> bool {
1710         matches!(*self, FailureNote)
1711     }
1712
1713     pub fn get_expectation_id(&self) -> Option<LintExpectationId> {
1714         match self {
1715             Level::Expect(id) | Level::Warning(Some(id)) => Some(*id),
1716             _ => None,
1717         }
1718     }
1719 }
1720
1721 // FIXME(eddyb) this doesn't belong here AFAICT, should be moved to callsite.
1722 pub fn add_elided_lifetime_in_path_suggestion(
1723     source_map: &SourceMap,
1724     diag: &mut Diagnostic,
1725     n: usize,
1726     path_span: Span,
1727     incl_angl_brckt: bool,
1728     insertion_span: Span,
1729 ) {
1730     diag.span_label(path_span, format!("expected lifetime parameter{}", pluralize!(n)));
1731     if !source_map.is_span_accessible(insertion_span) {
1732         // Do not try to suggest anything if generated by a proc-macro.
1733         return;
1734     }
1735     let anon_lts = vec!["'_"; n].join(", ");
1736     let suggestion =
1737         if incl_angl_brckt { format!("<{}>", anon_lts) } else { format!("{}, ", anon_lts) };
1738     diag.span_suggestion_verbose(
1739         insertion_span.shrink_to_hi(),
1740         &format!("indicate the anonymous lifetime{}", pluralize!(n)),
1741         suggestion,
1742         Applicability::MachineApplicable,
1743     );
1744 }
1745
1746 /// Useful type to use with `Result<>` indicate that an error has already
1747 /// been reported to the user, so no need to continue checking.
1748 #[derive(Clone, Copy, Debug, Encodable, Decodable, Hash, PartialEq, Eq, PartialOrd, Ord)]
1749 #[derive(HashStable_Generic)]
1750 pub struct ErrorGuaranteed(());
1751
1752 impl ErrorGuaranteed {
1753     /// To be used only if you really know what you are doing... ideally, we would find a way to
1754     /// eliminate all calls to this method.
1755     pub fn unchecked_claim_error_was_emitted() -> Self {
1756         ErrorGuaranteed(())
1757     }
1758 }