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