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