1 //! Diagnostics creation and emission for `rustc`.
3 //! This module contains the code for creating and emitting diagnostics.
5 #![doc(html_root_url = "https://doc.rust-lang.org/nightly/nightly-rustc/")]
6 #![feature(drain_filter)]
7 #![feature(if_let_guard)]
8 #![feature(is_terminal)]
9 #![feature(adt_const_params)]
10 #![feature(let_chains)]
11 #![feature(never_type)]
12 #![feature(result_option_inspect)]
13 #![feature(rustc_attrs)]
14 #![allow(incomplete_features)]
17 extern crate rustc_macros;
22 pub use emitter::ColorConfig;
24 use rustc_lint_defs::LintExpectationId;
27 use emitter::{is_case_difference, Emitter, EmitterWriter};
28 use registry::Registry;
29 use rustc_data_structures::fx::{FxHashMap, FxHashSet, FxIndexMap, FxIndexSet};
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, DelayDm, DiagnosticMessage, FluentBundle,
35 LanguageIdentifier, LazyFallbackBundle, MultiSpan, SpanLabel, SubdiagnosticMessage,
36 DEFAULT_LOCALE_RESOURCES,
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};
45 use std::num::NonZeroUsize;
48 use std::{error, fmt};
50 use termcolor::{Color, ColorSpec};
52 pub mod annotate_snippet_emitter_writer;
54 mod diagnostic_builder;
64 pub use diagnostic_builder::IntoDiagnostic;
65 pub use snippet::Style;
67 pub type PErr<'a> = DiagnosticBuilder<'a, ErrorGuaranteed>;
68 pub type PResult<'a, T> = Result<T, PErr<'a>>;
70 // `PResult` is used a lot. Make sure it doesn't unintentionally get bigger.
71 // (See also the comment on `DiagnosticBuilderInner`'s `diagnostic` field.)
72 #[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))]
73 rustc_data_structures::static_assert_size!(PResult<'_, ()>, 16);
74 #[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))]
75 rustc_data_structures::static_assert_size!(PResult<'_, bool>, 16);
77 #[derive(Debug, PartialEq, Eq, Clone, Copy, Hash, Encodable, Decodable)]
78 pub enum SuggestionStyle {
79 /// Hide the suggested code when displaying this suggestion inline.
81 /// Always hide the suggested code but display the message.
83 /// Do not display this suggestion in the cli output, it is only meant for tools.
85 /// Always show the suggested code.
86 /// This will *not* show the code if the suggestion is inline *and* the suggested code is
89 /// Always show the suggested code independently.
93 impl SuggestionStyle {
94 fn hide_inline(&self) -> bool {
95 !matches!(*self, SuggestionStyle::ShowCode)
99 #[derive(Clone, Debug, PartialEq, Hash, Encodable, Decodable)]
100 pub struct CodeSuggestion {
101 /// Each substitute can have multiple variants due to multiple
102 /// applicable suggestions
104 /// `foo.bar` might be replaced with `a.b` or `x.y` by replacing
105 /// `foo` and `bar` on their own:
107 /// ```ignore (illustrative)
109 /// Substitution { parts: vec![(0..3, "a"), (4..7, "b")] },
110 /// Substitution { parts: vec![(0..3, "x"), (4..7, "y")] },
114 /// or by replacing the entire span:
116 /// ```ignore (illustrative)
118 /// Substitution { parts: vec![(0..7, "a.b")] },
119 /// Substitution { parts: vec![(0..7, "x.y")] },
122 pub substitutions: Vec<Substitution>,
123 pub msg: DiagnosticMessage,
124 /// Visual representation of this suggestion.
125 pub style: SuggestionStyle,
126 /// Whether or not the suggestion is approximate
128 /// Sometimes we may show suggestions with placeholders,
129 /// which are useful for users but not useful for
130 /// tools like rustfix
131 pub applicability: Applicability,
134 #[derive(Clone, Debug, PartialEq, Hash, Encodable, Decodable)]
135 /// See the docs on `CodeSuggestion::substitutions`
136 pub struct Substitution {
137 pub parts: Vec<SubstitutionPart>,
140 #[derive(Clone, Debug, PartialEq, Hash, Encodable, Decodable)]
141 pub struct SubstitutionPart {
146 /// Used to translate between `Span`s and byte positions within a single output line in highlighted
147 /// code of structured suggestions.
148 #[derive(Debug, Clone, Copy)]
149 pub struct SubstitutionHighlight {
154 impl SubstitutionPart {
155 pub fn is_addition(&self, sm: &SourceMap) -> bool {
156 !self.snippet.is_empty() && !self.replaces_meaningful_content(sm)
159 pub fn is_deletion(&self, sm: &SourceMap) -> bool {
160 self.snippet.trim().is_empty() && self.replaces_meaningful_content(sm)
163 pub fn is_replacement(&self, sm: &SourceMap) -> bool {
164 !self.snippet.is_empty() && self.replaces_meaningful_content(sm)
167 fn replaces_meaningful_content(&self, sm: &SourceMap) -> bool {
168 sm.span_to_snippet(self.span)
169 .map_or(!self.span.is_empty(), |snippet| !snippet.trim().is_empty())
173 impl CodeSuggestion {
174 /// Returns the assembled code suggestions, whether they should be shown with an underline
175 /// and whether the substitution only differs in capitalization.
179 ) -> Vec<(String, Vec<SubstitutionPart>, Vec<Vec<SubstitutionHighlight>>, bool)> {
180 // For the `Vec<Vec<SubstitutionHighlight>>` value, the first level of the vector
181 // corresponds to the output snippet's lines, while the second level corresponds to the
182 // substrings within that line that should be highlighted.
184 use rustc_span::{CharPos, Pos};
186 /// Append to a buffer the remainder of the line of existing source code, and return the
187 /// count of lines that have been added for accurate highlighting.
190 line_opt: Option<&Cow<'_, str>>,
192 hi_opt: Option<&Loc>,
194 let mut line_count = 0;
195 let (lo, hi_opt) = (lo.col.to_usize(), hi_opt.map(|hi| hi.col.to_usize()));
196 if let Some(line) = line_opt {
197 if let Some(lo) = line.char_indices().map(|(i, _)| i).nth(lo) {
198 let hi_opt = hi_opt.and_then(|hi| line.char_indices().map(|(i, _)| i).nth(hi));
200 Some(hi) if hi > lo => {
201 line_count = line[lo..hi].matches('\n').count();
202 buf.push_str(&line[lo..hi])
206 line_count = line[lo..].matches('\n').count();
207 buf.push_str(&line[lo..])
211 if hi_opt.is_none() {
218 assert!(!self.substitutions.is_empty());
223 // Suggestions coming from macros can have malformed spans. This is a heavy
224 // handed approach to avoid ICEs by ignoring the suggestion outright.
225 let invalid = subst.parts.iter().any(|item| sm.is_valid_span(item.span).is_err());
227 debug!("splice_lines: suggestion contains an invalid span: {:?}", subst);
232 .filter_map(|mut substitution| {
233 // Assumption: all spans are in the same file, and all spans
234 // are disjoint. Sort in ascending order.
235 substitution.parts.sort_by_key(|part| part.span.lo());
237 // Find the bounding span.
238 let lo = substitution.parts.iter().map(|part| part.span.lo()).min()?;
239 let hi = substitution.parts.iter().map(|part| part.span.hi()).max()?;
240 let bounding_span = Span::with_root_ctxt(lo, hi);
241 // The different spans might belong to different contexts, if so ignore suggestion.
242 let lines = sm.span_to_lines(bounding_span).ok()?;
243 assert!(!lines.lines.is_empty() || bounding_span.is_dummy());
245 // We can't splice anything if the source is unavailable.
246 if !sm.ensure_source_file_source_present(lines.file.clone()) {
250 let mut highlights = vec![];
251 // To build up the result, we do this for each span:
252 // - push the line segment trailing the previous span
253 // (at the beginning a "phantom" span pointing at the start of the line)
254 // - push lines between the previous and current span (if any)
255 // - if the previous and current span are not on the same line
256 // push the line segment leading up to the current span
257 // - splice in the span substitution
259 // Finally push the trailing line segment of the last span
260 let sf = &lines.file;
261 let mut prev_hi = sm.lookup_char_pos(bounding_span.lo());
262 prev_hi.col = CharPos::from_usize(0);
264 lines.lines.get(0).and_then(|line0| sf.get_line(line0.line_index));
265 let mut buf = String::new();
267 let mut line_highlight = vec![];
268 // We need to keep track of the difference between the existing code and the added
269 // or deleted code in order to point at the correct column *after* substitution.
271 for part in &substitution.parts {
272 let cur_lo = sm.lookup_char_pos(part.span.lo());
273 if prev_hi.line == cur_lo.line {
275 push_trailing(&mut buf, prev_line.as_ref(), &prev_hi, Some(&cur_lo));
277 highlights.push(std::mem::take(&mut line_highlight));
283 highlights.push(std::mem::take(&mut line_highlight));
284 let mut count = push_trailing(&mut buf, prev_line.as_ref(), &prev_hi, None);
286 highlights.push(std::mem::take(&mut line_highlight));
289 // push lines between the previous and current span (if any)
290 for idx in prev_hi.line..(cur_lo.line - 1) {
291 if let Some(line) = sf.get_line(idx) {
292 buf.push_str(line.as_ref());
294 highlights.push(std::mem::take(&mut line_highlight));
297 if let Some(cur_line) = sf.get_line(cur_lo.line - 1) {
298 let end = match cur_line.char_indices().nth(cur_lo.col.to_usize()) {
300 None => cur_line.len(),
302 buf.push_str(&cur_line[..end]);
305 // Add a whole line highlight per line in the snippet.
306 let len: isize = part
310 .unwrap_or(&part.snippet)
317 line_highlight.push(SubstitutionHighlight {
318 start: (cur_lo.col.0 as isize + acc) as usize,
319 end: (cur_lo.col.0 as isize + acc + len) as usize,
321 buf.push_str(&part.snippet);
322 let cur_hi = sm.lookup_char_pos(part.span.hi());
323 if prev_hi.line == cur_lo.line && cur_hi.line == cur_lo.line {
324 // Account for the difference between the width of the current code and the
325 // snippet being suggested, so that the *later* suggestions are correctly
326 // aligned on the screen.
327 acc += len as isize - (cur_hi.col.0 - cur_lo.col.0) as isize;
330 prev_line = sf.get_line(prev_hi.line - 1);
331 for line in part.snippet.split('\n').skip(1) {
333 highlights.push(std::mem::take(&mut line_highlight));
334 let end: usize = line
341 line_highlight.push(SubstitutionHighlight { start: 0, end });
344 highlights.push(std::mem::take(&mut line_highlight));
345 let only_capitalization = is_case_difference(sm, &buf, bounding_span);
346 // if the replacement already ends with a newline, don't print the next line
347 if !buf.ends_with('\n') {
348 push_trailing(&mut buf, prev_line.as_ref(), &prev_hi, None);
350 // remove trailing newlines
351 while buf.ends_with('\n') {
354 Some((buf, substitution.parts, highlights, only_capitalization))
360 pub use rustc_span::fatal_error::{FatalError, FatalErrorMarker};
362 /// Signifies that the compiler died with an explicit call to `.bug`
363 /// or `.span_bug` rather than a failed assertion, etc.
364 #[derive(Copy, Clone, Debug)]
365 pub struct ExplicitBug;
367 impl fmt::Display for ExplicitBug {
368 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
369 write!(f, "parser internal bug")
373 impl error::Error for ExplicitBug {}
375 pub use diagnostic::{
376 AddToDiagnostic, DecorateLint, Diagnostic, DiagnosticArg, DiagnosticArgValue, DiagnosticId,
377 DiagnosticStyledString, IntoDiagnosticArg, SubDiagnostic,
379 pub use diagnostic_builder::{DiagnosticBuilder, EmissionGuarantee, Noted};
380 pub use diagnostic_impls::{DiagnosticArgFromDisplay, DiagnosticSymbolList};
381 use std::backtrace::Backtrace;
383 /// A handler deals with errors and other compiler output.
384 /// Certain errors (fatal, bug, unimpl) may cause immediate exit,
385 /// others log errors for later reporting.
388 inner: Lock<HandlerInner>,
391 /// This inner struct exists to keep it all behind a single lock;
392 /// this is done to prevent possible deadlocks in a multi-threaded compiler,
393 /// as well as inconsistent state observation.
394 struct HandlerInner {
396 /// The number of lint errors that have been emitted.
397 lint_err_count: usize,
398 /// The number of errors that have been emitted, including duplicates.
400 /// This is not necessarily the count that's reported to the user once
401 /// compilation ends.
404 deduplicated_err_count: usize,
405 emitter: Box<dyn Emitter + sync::Send>,
406 delayed_span_bugs: Vec<Diagnostic>,
407 delayed_good_path_bugs: Vec<DelayedDiagnostic>,
408 /// This flag indicates that an expected diagnostic was emitted and suppressed.
409 /// This is used for the `delayed_good_path_bugs` check.
410 suppressed_expected_diag: bool,
412 /// This set contains the `DiagnosticId` of all emitted diagnostics to avoid
413 /// emitting the same diagnostic with extended help (`--teach`) twice, which
414 /// would be unnecessary repetition.
415 taught_diagnostics: FxHashSet<DiagnosticId>,
417 /// Used to suggest rustc --explain `<error code>`
418 emitted_diagnostic_codes: FxIndexSet<DiagnosticId>,
420 /// This set contains a hash of every diagnostic that has been emitted by
421 /// this handler. These hashes is used to avoid emitting the same error
423 emitted_diagnostics: FxHashSet<u128>,
425 /// Stashed diagnostics emitted in one stage of the compiler that may be
426 /// stolen by other stages (e.g. to improve them and add more information).
427 /// The stashed diagnostics count towards the total error count.
428 /// When `.abort_if_errors()` is called, these are also emitted.
429 stashed_diagnostics: FxIndexMap<(Span, StashKey), Diagnostic>,
431 /// The warning count, used for a recap upon finishing
432 deduplicated_warn_count: usize,
434 future_breakage_diagnostics: Vec<Diagnostic>,
436 /// The [`Self::unstable_expect_diagnostics`] should be empty when this struct is
437 /// dropped. However, it can have values if the compilation is stopped early
438 /// or is only partially executed. To avoid ICEs, like in rust#94953 we only
439 /// check if [`Self::unstable_expect_diagnostics`] is empty, if the expectation ids
440 /// have been converted.
441 check_unstable_expect_diagnostics: bool,
443 /// Expected [`Diagnostic`][diagnostic::Diagnostic]s store a [`LintExpectationId`] as part of
444 /// the lint level. [`LintExpectationId`]s created early during the compilation
445 /// (before `HirId`s have been defined) are not stable and can therefore not be
446 /// stored on disk. This buffer stores these diagnostics until the ID has been
447 /// replaced by a stable [`LintExpectationId`]. The [`Diagnostic`][diagnostic::Diagnostic]s are the
448 /// submitted for storage and added to the list of fulfilled expectations.
449 unstable_expect_diagnostics: Vec<Diagnostic>,
451 /// expected diagnostic will have the level `Expect` which additionally
452 /// carries the [`LintExpectationId`] of the expectation that can be
453 /// marked as fulfilled. This is a collection of all [`LintExpectationId`]s
454 /// that have been marked as fulfilled this way.
456 /// [RFC-2383]: https://rust-lang.github.io/rfcs/2383-lint-reasons.html
457 fulfilled_expectations: FxHashSet<LintExpectationId>,
460 /// A key denoting where from a diagnostic was stashed.
461 #[derive(Copy, Clone, PartialEq, Eq, Hash)]
464 UnderscoreForArrayLengths,
467 /// When an invalid lifetime e.g. `'2` should be reinterpreted
468 /// as a char literal in the parser
470 /// Maybe there was a typo where a comma was forgotten before
475 fn default_track_diagnostic(_: &Diagnostic) {}
477 pub static TRACK_DIAGNOSTICS: AtomicRef<fn(&Diagnostic)> =
478 AtomicRef::new(&(default_track_diagnostic as fn(&_)));
480 #[derive(Copy, Clone, Default)]
481 pub struct HandlerFlags {
482 /// If false, warning-level lints are suppressed.
483 /// (rustc: see `--allow warnings` and `--cap-lints`)
484 pub can_emit_warnings: bool,
485 /// If true, error-level diagnostics are upgraded to bug-level.
486 /// (rustc: see `-Z treat-err-as-bug`)
487 pub treat_err_as_bug: Option<NonZeroUsize>,
488 /// If true, immediately emit diagnostics that would otherwise be buffered.
489 /// (rustc: see `-Z dont-buffer-diagnostics` and `-Z treat-err-as-bug`)
490 pub dont_buffer_diagnostics: bool,
491 /// If true, immediately print bugs registered with `delay_span_bug`.
492 /// (rustc: see `-Z report-delayed-bugs`)
493 pub report_delayed_bugs: bool,
494 /// Show macro backtraces.
495 /// (rustc: see `-Z macro-backtrace`)
496 pub macro_backtrace: bool,
497 /// If true, identical diagnostics are reported only once.
498 pub deduplicate_diagnostics: bool,
499 /// Track where errors are created. Enabled with `-Ztrack-diagnostics`.
500 pub track_diagnostics: bool,
503 impl Drop for HandlerInner {
505 self.emit_stashed_diagnostics();
507 if !self.has_errors() {
508 let bugs = std::mem::replace(&mut self.delayed_span_bugs, Vec::new());
509 self.flush_delayed(bugs, "no errors encountered even though `delay_span_bug` issued");
512 // FIXME(eddyb) this explains what `delayed_good_path_bugs` are!
513 // They're `delayed_span_bugs` but for "require some diagnostic happened"
514 // instead of "require some error happened". Sadly that isn't ideal, as
515 // lints can be `#[allow]`'d, potentially leading to this triggering.
516 // Also, "good path" should be replaced with a better naming.
517 if !self.has_any_message() && !self.suppressed_expected_diag {
518 let bugs = std::mem::replace(&mut self.delayed_good_path_bugs, Vec::new());
520 bugs.into_iter().map(DelayedDiagnostic::decorate),
521 "no warnings or errors encountered even though `delayed_good_path_bugs` issued",
525 if self.check_unstable_expect_diagnostics {
527 self.unstable_expect_diagnostics.is_empty(),
528 "all diagnostics with unstable expectations should have been converted",
535 pub fn with_tty_emitter(
536 color_config: ColorConfig,
537 can_emit_warnings: bool,
538 treat_err_as_bug: Option<NonZeroUsize>,
539 sm: Option<Lrc<SourceMap>>,
540 fluent_bundle: Option<Lrc<FluentBundle>>,
541 fallback_bundle: LazyFallbackBundle,
543 Self::with_tty_emitter_and_flags(
548 HandlerFlags { can_emit_warnings, treat_err_as_bug, ..Default::default() },
552 pub fn with_tty_emitter_and_flags(
553 color_config: ColorConfig,
554 sm: Option<Lrc<SourceMap>>,
555 fluent_bundle: Option<Lrc<FluentBundle>>,
556 fallback_bundle: LazyFallbackBundle,
559 let emitter = Box::new(EmitterWriter::stderr(
567 flags.macro_backtrace,
568 flags.track_diagnostics,
570 Self::with_emitter_and_flags(emitter, flags)
574 can_emit_warnings: bool,
575 treat_err_as_bug: Option<NonZeroUsize>,
576 emitter: Box<dyn Emitter + sync::Send>,
578 Handler::with_emitter_and_flags(
580 HandlerFlags { can_emit_warnings, treat_err_as_bug, ..Default::default() },
584 pub fn with_emitter_and_flags(
585 emitter: Box<dyn Emitter + sync::Send>,
590 inner: Lock::new(HandlerInner {
595 deduplicated_err_count: 0,
596 deduplicated_warn_count: 0,
598 delayed_span_bugs: Vec::new(),
599 delayed_good_path_bugs: Vec::new(),
600 suppressed_expected_diag: false,
601 taught_diagnostics: Default::default(),
602 emitted_diagnostic_codes: Default::default(),
603 emitted_diagnostics: Default::default(),
604 stashed_diagnostics: Default::default(),
605 future_breakage_diagnostics: Vec::new(),
606 check_unstable_expect_diagnostics: false,
607 unstable_expect_diagnostics: Vec::new(),
608 fulfilled_expectations: Default::default(),
613 /// Translate `message` eagerly with `args`.
614 pub fn eagerly_translate<'a>(
616 message: DiagnosticMessage,
617 args: impl Iterator<Item = DiagnosticArg<'a, 'static>>,
618 ) -> SubdiagnosticMessage {
619 let inner = self.inner.borrow();
620 let args = crate::translation::to_fluent_args(args);
621 SubdiagnosticMessage::Eager(inner.emitter.translate_message(&message, &args).to_string())
624 // This is here to not allow mutation of flags;
625 // as of this writing it's only used in tests in librustc_middle.
626 pub fn can_emit_warnings(&self) -> bool {
627 self.flags.can_emit_warnings
630 /// Resets the diagnostic error count as well as the cached emitted diagnostics.
632 /// NOTE: *do not* call this function from rustc. It is only meant to be called from external
633 /// tools that want to reuse a `Parser` cleaning the previously emitted diagnostics as well as
634 /// the overall count of emitted error diagnostics.
635 pub fn reset_err_count(&self) {
636 let mut inner = self.inner.borrow_mut();
638 inner.warn_count = 0;
639 inner.deduplicated_err_count = 0;
640 inner.deduplicated_warn_count = 0;
642 // actually free the underlying memory (which `clear` would not do)
643 inner.delayed_span_bugs = Default::default();
644 inner.delayed_good_path_bugs = Default::default();
645 inner.taught_diagnostics = Default::default();
646 inner.emitted_diagnostic_codes = Default::default();
647 inner.emitted_diagnostics = Default::default();
648 inner.stashed_diagnostics = Default::default();
651 /// Stash a given diagnostic with the given `Span` and [`StashKey`] as the key.
652 /// Retrieve a stashed diagnostic with `steal_diagnostic`.
653 pub fn stash_diagnostic(&self, span: Span, key: StashKey, diag: Diagnostic) {
654 let mut inner = self.inner.borrow_mut();
655 inner.stash((span, key), diag);
658 /// Steal a previously stashed diagnostic with the given `Span` and [`StashKey`] as the key.
659 pub fn steal_diagnostic(&self, span: Span, key: StashKey) -> Option<DiagnosticBuilder<'_, ()>> {
660 let mut inner = self.inner.borrow_mut();
661 inner.steal((span, key)).map(|diag| DiagnosticBuilder::new_diagnostic(self, diag))
664 pub fn has_stashed_diagnostic(&self, span: Span, key: StashKey) -> bool {
665 self.inner.borrow().stashed_diagnostics.get(&(span, key)).is_some()
668 /// Emit all stashed diagnostics.
669 pub fn emit_stashed_diagnostics(&self) -> Option<ErrorGuaranteed> {
670 self.inner.borrow_mut().emit_stashed_diagnostics()
673 /// Construct a builder with the `msg` at the level appropriate for the specific `EmissionGuarantee`.
674 #[rustc_lint_diagnostics]
676 pub fn struct_diagnostic<G: EmissionGuarantee>(
678 msg: impl Into<DiagnosticMessage>,
679 ) -> DiagnosticBuilder<'_, G> {
680 G::make_diagnostic_builder(self, msg)
683 /// Construct a builder at the `Warning` level at the given `span` and with the `msg`.
685 /// Attempting to `.emit()` the builder will only emit if either:
686 /// * `can_emit_warnings` is `true`
687 /// * `is_force_warn` was set in `DiagnosticId::Lint`
688 #[rustc_lint_diagnostics]
690 pub fn struct_span_warn(
692 span: impl Into<MultiSpan>,
693 msg: impl Into<DiagnosticMessage>,
694 ) -> DiagnosticBuilder<'_, ()> {
695 let mut result = self.struct_warn(msg);
696 result.set_span(span);
700 /// Construct a builder at the `Warning` level at the given `span` and with the `msg`.
701 /// The `id` is used for lint emissions which should also fulfill a lint expectation.
703 /// Attempting to `.emit()` the builder will only emit if either:
704 /// * `can_emit_warnings` is `true`
705 /// * `is_force_warn` was set in `DiagnosticId::Lint`
707 pub fn struct_span_warn_with_expectation(
709 span: impl Into<MultiSpan>,
710 msg: impl Into<DiagnosticMessage>,
711 id: LintExpectationId,
712 ) -> DiagnosticBuilder<'_, ()> {
713 let mut result = self.struct_warn_with_expectation(msg, id);
714 result.set_span(span);
718 /// Construct a builder at the `Allow` level at the given `span` and with the `msg`.
719 #[rustc_lint_diagnostics]
721 pub fn struct_span_allow(
723 span: impl Into<MultiSpan>,
724 msg: impl Into<DiagnosticMessage>,
725 ) -> DiagnosticBuilder<'_, ()> {
726 let mut result = self.struct_allow(msg);
727 result.set_span(span);
731 /// Construct a builder at the `Warning` level at the given `span` and with the `msg`.
732 /// Also include a code.
733 #[rustc_lint_diagnostics]
735 pub fn struct_span_warn_with_code(
737 span: impl Into<MultiSpan>,
738 msg: impl Into<DiagnosticMessage>,
740 ) -> DiagnosticBuilder<'_, ()> {
741 let mut result = self.struct_span_warn(span, msg);
746 /// Construct a builder at the `Warning` level with the `msg`.
748 /// Attempting to `.emit()` the builder will only emit if either:
749 /// * `can_emit_warnings` is `true`
750 /// * `is_force_warn` was set in `DiagnosticId::Lint`
751 #[rustc_lint_diagnostics]
753 pub fn struct_warn(&self, msg: impl Into<DiagnosticMessage>) -> DiagnosticBuilder<'_, ()> {
754 DiagnosticBuilder::new(self, Level::Warning(None), msg)
757 /// Construct a builder at the `Warning` level with the `msg`. The `id` is used for
758 /// lint emissions which should also fulfill a lint expectation.
760 /// Attempting to `.emit()` the builder will only emit if either:
761 /// * `can_emit_warnings` is `true`
762 /// * `is_force_warn` was set in `DiagnosticId::Lint`
764 pub fn struct_warn_with_expectation(
766 msg: impl Into<DiagnosticMessage>,
767 id: LintExpectationId,
768 ) -> DiagnosticBuilder<'_, ()> {
769 DiagnosticBuilder::new(self, Level::Warning(Some(id)), msg)
772 /// Construct a builder at the `Allow` level with the `msg`.
773 #[rustc_lint_diagnostics]
775 pub fn struct_allow(&self, msg: impl Into<DiagnosticMessage>) -> DiagnosticBuilder<'_, ()> {
776 DiagnosticBuilder::new(self, Level::Allow, msg)
779 /// Construct a builder at the `Expect` level with the `msg`.
780 #[rustc_lint_diagnostics]
782 pub fn struct_expect(
784 msg: impl Into<DiagnosticMessage>,
785 id: LintExpectationId,
786 ) -> DiagnosticBuilder<'_, ()> {
787 DiagnosticBuilder::new(self, Level::Expect(id), msg)
790 /// Construct a builder at the `Error` level at the given `span` and with the `msg`.
791 #[rustc_lint_diagnostics]
793 pub fn struct_span_err(
795 span: impl Into<MultiSpan>,
796 msg: impl Into<DiagnosticMessage>,
797 ) -> DiagnosticBuilder<'_, ErrorGuaranteed> {
798 let mut result = self.struct_err(msg);
799 result.set_span(span);
803 /// Construct a builder at the `Error` level at the given `span`, with the `msg`, and `code`.
804 #[rustc_lint_diagnostics]
806 pub fn struct_span_err_with_code(
808 span: impl Into<MultiSpan>,
809 msg: impl Into<DiagnosticMessage>,
811 ) -> DiagnosticBuilder<'_, ErrorGuaranteed> {
812 let mut result = self.struct_span_err(span, msg);
817 /// Construct a builder at the `Error` level with the `msg`.
818 // FIXME: This method should be removed (every error should have an associated error code).
819 #[rustc_lint_diagnostics]
823 msg: impl Into<DiagnosticMessage>,
824 ) -> DiagnosticBuilder<'_, ErrorGuaranteed> {
825 DiagnosticBuilder::new_guaranteeing_error::<_, { Level::Error { lint: false } }>(self, msg)
828 /// This should only be used by `rustc_middle::lint::struct_lint_level`. Do not use it for hard errors.
831 pub fn struct_err_lint(&self, msg: impl Into<DiagnosticMessage>) -> DiagnosticBuilder<'_, ()> {
832 DiagnosticBuilder::new(self, Level::Error { lint: true }, msg)
835 /// Construct a builder at the `Error` level with the `msg` and the `code`.
836 #[rustc_lint_diagnostics]
838 pub fn struct_err_with_code(
840 msg: impl Into<DiagnosticMessage>,
842 ) -> DiagnosticBuilder<'_, ErrorGuaranteed> {
843 let mut result = self.struct_err(msg);
848 /// Construct a builder at the `Warn` level with the `msg` and the `code`.
849 #[rustc_lint_diagnostics]
851 pub fn struct_warn_with_code(
853 msg: impl Into<DiagnosticMessage>,
855 ) -> DiagnosticBuilder<'_, ()> {
856 let mut result = self.struct_warn(msg);
861 /// Construct a builder at the `Fatal` level at the given `span` and with the `msg`.
862 #[rustc_lint_diagnostics]
864 pub fn struct_span_fatal(
866 span: impl Into<MultiSpan>,
867 msg: impl Into<DiagnosticMessage>,
868 ) -> DiagnosticBuilder<'_, !> {
869 let mut result = self.struct_fatal(msg);
870 result.set_span(span);
874 /// Construct a builder at the `Fatal` level at the given `span`, with the `msg`, and `code`.
875 #[rustc_lint_diagnostics]
877 pub fn struct_span_fatal_with_code(
879 span: impl Into<MultiSpan>,
880 msg: impl Into<DiagnosticMessage>,
882 ) -> DiagnosticBuilder<'_, !> {
883 let mut result = self.struct_span_fatal(span, msg);
888 /// Construct a builder at the `Error` level with the `msg`.
889 #[rustc_lint_diagnostics]
891 pub fn struct_fatal(&self, msg: impl Into<DiagnosticMessage>) -> DiagnosticBuilder<'_, !> {
892 DiagnosticBuilder::new_fatal(self, msg)
895 /// Construct a builder at the `Help` level with the `msg`.
896 #[rustc_lint_diagnostics]
897 pub fn struct_help(&self, msg: impl Into<DiagnosticMessage>) -> DiagnosticBuilder<'_, ()> {
898 DiagnosticBuilder::new(self, Level::Help, msg)
901 /// Construct a builder at the `Note` level with the `msg`.
902 #[rustc_lint_diagnostics]
904 pub fn struct_note_without_error(
906 msg: impl Into<DiagnosticMessage>,
907 ) -> DiagnosticBuilder<'_, ()> {
908 DiagnosticBuilder::new(self, Level::Note, msg)
911 #[rustc_lint_diagnostics]
913 pub fn span_fatal(&self, span: impl Into<MultiSpan>, msg: impl Into<DiagnosticMessage>) -> ! {
914 self.emit_diag_at_span(Diagnostic::new(Fatal, msg), span);
918 #[rustc_lint_diagnostics]
920 pub fn span_fatal_with_code(
922 span: impl Into<MultiSpan>,
923 msg: impl Into<DiagnosticMessage>,
926 self.emit_diag_at_span(Diagnostic::new_with_code(Fatal, Some(code), msg), span);
930 #[rustc_lint_diagnostics]
934 span: impl Into<MultiSpan>,
935 msg: impl Into<DiagnosticMessage>,
936 ) -> ErrorGuaranteed {
937 self.emit_diag_at_span(Diagnostic::new(Error { lint: false }, msg), span).unwrap()
940 #[rustc_lint_diagnostics]
942 pub fn span_err_with_code(
944 span: impl Into<MultiSpan>,
945 msg: impl Into<DiagnosticMessage>,
948 self.emit_diag_at_span(
949 Diagnostic::new_with_code(Error { lint: false }, Some(code), msg),
954 #[rustc_lint_diagnostics]
956 pub fn span_warn(&self, span: impl Into<MultiSpan>, msg: impl Into<DiagnosticMessage>) {
957 self.emit_diag_at_span(Diagnostic::new(Warning(None), msg), span);
960 #[rustc_lint_diagnostics]
962 pub fn span_warn_with_code(
964 span: impl Into<MultiSpan>,
965 msg: impl Into<DiagnosticMessage>,
968 self.emit_diag_at_span(Diagnostic::new_with_code(Warning(None), Some(code), msg), span);
971 pub fn span_bug(&self, span: impl Into<MultiSpan>, msg: impl Into<DiagnosticMessage>) -> ! {
972 self.inner.borrow_mut().span_bug(span, msg)
976 pub fn delay_span_bug(
978 span: impl Into<MultiSpan>,
979 msg: impl Into<DiagnosticMessage>,
980 ) -> ErrorGuaranteed {
981 self.inner.borrow_mut().delay_span_bug(span, msg)
984 // FIXME(eddyb) note the comment inside `impl Drop for HandlerInner`, that's
985 // where the explanation of what "good path" is (also, it should be renamed).
986 pub fn delay_good_path_bug(&self, msg: impl Into<DiagnosticMessage>) {
987 self.inner.borrow_mut().delay_good_path_bug(msg)
991 pub fn span_bug_no_panic(&self, span: impl Into<MultiSpan>, msg: impl Into<DiagnosticMessage>) {
992 self.emit_diag_at_span(Diagnostic::new(Bug, msg), span);
996 pub fn span_note_without_error(
998 span: impl Into<MultiSpan>,
999 msg: impl Into<DiagnosticMessage>,
1001 self.emit_diag_at_span(Diagnostic::new(Note, msg), span);
1005 pub fn span_note_diag(
1008 msg: impl Into<DiagnosticMessage>,
1009 ) -> DiagnosticBuilder<'_, ()> {
1010 let mut db = DiagnosticBuilder::new(self, Note, msg);
1015 // NOTE: intentionally doesn't raise an error so rustc_codegen_ssa only reports fatal errors in the main thread
1016 pub fn fatal(&self, msg: impl Into<DiagnosticMessage>) -> FatalError {
1017 self.inner.borrow_mut().fatal(msg)
1020 pub fn err(&self, msg: impl Into<DiagnosticMessage>) -> ErrorGuaranteed {
1021 self.inner.borrow_mut().err(msg)
1024 pub fn warn(&self, msg: impl Into<DiagnosticMessage>) {
1025 let mut db = DiagnosticBuilder::new(self, Warning(None), msg);
1029 pub fn note_without_error(&self, msg: impl Into<DiagnosticMessage>) {
1030 DiagnosticBuilder::new(self, Note, msg).emit();
1033 pub fn bug(&self, msg: impl Into<DiagnosticMessage>) -> ! {
1034 self.inner.borrow_mut().bug(msg)
1038 pub fn err_count(&self) -> usize {
1039 self.inner.borrow().err_count()
1042 pub fn has_errors(&self) -> Option<ErrorGuaranteed> {
1043 if self.inner.borrow().has_errors() { Some(ErrorGuaranteed(())) } else { None }
1045 pub fn has_errors_or_lint_errors(&self) -> Option<ErrorGuaranteed> {
1046 if self.inner.borrow().has_errors_or_lint_errors() {
1047 Some(ErrorGuaranteed::unchecked_claim_error_was_emitted())
1052 pub fn has_errors_or_delayed_span_bugs(&self) -> Option<ErrorGuaranteed> {
1053 if self.inner.borrow().has_errors_or_delayed_span_bugs() {
1054 Some(ErrorGuaranteed::unchecked_claim_error_was_emitted())
1059 pub fn is_compilation_going_to_fail(&self) -> Option<ErrorGuaranteed> {
1060 if self.inner.borrow().is_compilation_going_to_fail() {
1061 Some(ErrorGuaranteed::unchecked_claim_error_was_emitted())
1067 pub fn print_error_count(&self, registry: &Registry) {
1068 self.inner.borrow_mut().print_error_count(registry)
1071 pub fn take_future_breakage_diagnostics(&self) -> Vec<Diagnostic> {
1072 std::mem::take(&mut self.inner.borrow_mut().future_breakage_diagnostics)
1075 pub fn abort_if_errors(&self) {
1076 self.inner.borrow_mut().abort_if_errors()
1079 /// `true` if we haven't taught a diagnostic with this code already.
1080 /// The caller must then teach the user about such a diagnostic.
1082 /// Used to suppress emitting the same error multiple times with extended explanation when
1083 /// calling `-Zteach`.
1084 pub fn must_teach(&self, code: &DiagnosticId) -> bool {
1085 self.inner.borrow_mut().must_teach(code)
1088 pub fn force_print_diagnostic(&self, db: Diagnostic) {
1089 self.inner.borrow_mut().force_print_diagnostic(db)
1092 pub fn emit_diagnostic(&self, diagnostic: &mut Diagnostic) -> Option<ErrorGuaranteed> {
1093 self.inner.borrow_mut().emit_diagnostic(diagnostic)
1096 pub fn emit_err<'a>(&'a self, err: impl IntoDiagnostic<'a>) -> ErrorGuaranteed {
1097 self.create_err(err).emit()
1100 pub fn create_err<'a>(
1102 err: impl IntoDiagnostic<'a>,
1103 ) -> DiagnosticBuilder<'a, ErrorGuaranteed> {
1104 err.into_diagnostic(self)
1107 pub fn create_warning<'a>(
1109 warning: impl IntoDiagnostic<'a, ()>,
1110 ) -> DiagnosticBuilder<'a, ()> {
1111 warning.into_diagnostic(self)
1114 pub fn emit_warning<'a>(&'a self, warning: impl IntoDiagnostic<'a, ()>) {
1115 self.create_warning(warning).emit()
1118 pub fn create_fatal<'a>(
1120 fatal: impl IntoDiagnostic<'a, !>,
1121 ) -> DiagnosticBuilder<'a, !> {
1122 fatal.into_diagnostic(self)
1125 pub fn emit_fatal<'a>(&'a self, fatal: impl IntoDiagnostic<'a, !>) -> ! {
1126 self.create_fatal(fatal).emit()
1129 fn emit_diag_at_span(
1131 mut diag: Diagnostic,
1132 sp: impl Into<MultiSpan>,
1133 ) -> Option<ErrorGuaranteed> {
1134 let mut inner = self.inner.borrow_mut();
1135 inner.emit_diagnostic(diag.set_span(sp))
1138 pub fn emit_artifact_notification(&self, path: &Path, artifact_type: &str) {
1139 self.inner.borrow_mut().emit_artifact_notification(path, artifact_type)
1142 pub fn emit_future_breakage_report(&self, diags: Vec<Diagnostic>) {
1143 self.inner.borrow_mut().emitter.emit_future_breakage_report(diags)
1146 pub fn emit_unused_externs(
1148 lint_level: rustc_lint_defs::Level,
1150 unused_externs: &[&str],
1152 let mut inner = self.inner.borrow_mut();
1154 if loud && lint_level.is_error() {
1155 inner.bump_err_count();
1158 inner.emit_unused_externs(lint_level, unused_externs)
1161 pub fn update_unstable_expectation_id(
1163 unstable_to_stable: &FxHashMap<LintExpectationId, LintExpectationId>,
1165 let mut inner = self.inner.borrow_mut();
1166 let diags = std::mem::take(&mut inner.unstable_expect_diagnostics);
1167 inner.check_unstable_expect_diagnostics = true;
1169 if !diags.is_empty() {
1170 inner.suppressed_expected_diag = true;
1171 for mut diag in diags.into_iter() {
1172 diag.update_unstable_expectation_id(unstable_to_stable);
1174 // Here the diagnostic is given back to `emit_diagnostic` where it was first
1175 // intercepted. Now it should be processed as usual, since the unstable expectation
1176 // id is now stable.
1177 inner.emit_diagnostic(&mut diag);
1182 .stashed_diagnostics
1184 .for_each(|diag| diag.update_unstable_expectation_id(unstable_to_stable));
1186 .future_breakage_diagnostics
1188 .for_each(|diag| diag.update_unstable_expectation_id(unstable_to_stable));
1191 /// This methods steals all [`LintExpectationId`]s that are stored inside
1192 /// [`HandlerInner`] and indicate that the linked expectation has been fulfilled.
1194 pub fn steal_fulfilled_expectation_ids(&self) -> FxHashSet<LintExpectationId> {
1196 self.inner.borrow().unstable_expect_diagnostics.is_empty(),
1197 "`HandlerInner::unstable_expect_diagnostics` should be empty at this point",
1199 std::mem::take(&mut self.inner.borrow_mut().fulfilled_expectations)
1202 pub fn flush_delayed(&self) {
1203 let mut inner = self.inner.lock();
1204 let bugs = std::mem::replace(&mut inner.delayed_span_bugs, Vec::new());
1205 inner.flush_delayed(bugs, "no errors encountered even though `delay_span_bug` issued");
1210 fn must_teach(&mut self, code: &DiagnosticId) -> bool {
1211 self.taught_diagnostics.insert(code.clone())
1214 fn force_print_diagnostic(&mut self, mut db: Diagnostic) {
1215 self.emitter.emit_diagnostic(&mut db);
1218 /// Emit all stashed diagnostics.
1219 fn emit_stashed_diagnostics(&mut self) -> Option<ErrorGuaranteed> {
1220 let has_errors = self.has_errors();
1221 let diags = self.stashed_diagnostics.drain(..).map(|x| x.1).collect::<Vec<_>>();
1222 let mut reported = None;
1223 for mut diag in diags {
1224 // Decrement the count tracking the stash; emitting will increment it.
1225 if diag.is_error() {
1226 if matches!(diag.level, Level::Error { lint: true }) {
1227 self.lint_err_count -= 1;
1229 self.err_count -= 1;
1232 if diag.is_force_warn() {
1233 self.warn_count -= 1;
1235 // Unless they're forced, don't flush stashed warnings when
1236 // there are errors, to avoid causing warning overload. The
1237 // stash would've been stolen already if it were important.
1243 let reported_this = self.emit_diagnostic(&mut diag);
1244 reported = reported.or(reported_this);
1249 // FIXME(eddyb) this should ideally take `diagnostic` by value.
1250 fn emit_diagnostic(&mut self, diagnostic: &mut Diagnostic) -> Option<ErrorGuaranteed> {
1251 // The `LintExpectationId` can be stable or unstable depending on when it was created.
1252 // Diagnostics created before the definition of `HirId`s are unstable and can not yet
1253 // be stored. Instead, they are buffered until the `LintExpectationId` is replaced by
1254 // a stable one by the `LintLevelsBuilder`.
1255 if let Some(LintExpectationId::Unstable { .. }) = diagnostic.level.get_expectation_id() {
1256 self.unstable_expect_diagnostics.push(diagnostic.clone());
1260 if diagnostic.level == Level::DelayedBug {
1261 // FIXME(eddyb) this should check for `has_errors` and stop pushing
1262 // once *any* errors were emitted (and truncate `delayed_span_bugs`
1263 // when an error is first emitted, also), but maybe there's a case
1264 // in which that's not sound? otherwise this is really inefficient.
1265 self.delayed_span_bugs.push(diagnostic.clone());
1267 if !self.flags.report_delayed_bugs {
1268 return Some(ErrorGuaranteed::unchecked_claim_error_was_emitted());
1272 if diagnostic.has_future_breakage() {
1273 // Future breakages aren't emitted if they're Level::Allowed,
1274 // but they still need to be constructed and stashed below,
1275 // so they'll trigger the good-path bug check.
1276 self.suppressed_expected_diag = true;
1277 self.future_breakage_diagnostics.push(diagnostic.clone());
1280 if let Some(expectation_id) = diagnostic.level.get_expectation_id() {
1281 self.suppressed_expected_diag = true;
1282 self.fulfilled_expectations.insert(expectation_id.normalize());
1285 if matches!(diagnostic.level, Warning(_))
1286 && !self.flags.can_emit_warnings
1287 && !diagnostic.is_force_warn()
1289 if diagnostic.has_future_breakage() {
1290 (*TRACK_DIAGNOSTICS)(diagnostic);
1295 (*TRACK_DIAGNOSTICS)(diagnostic);
1297 if matches!(diagnostic.level, Level::Expect(_) | Level::Allow) {
1301 if let Some(ref code) = diagnostic.code {
1302 self.emitted_diagnostic_codes.insert(code.clone());
1305 let already_emitted = |this: &mut Self| {
1306 let mut hasher = StableHasher::new();
1307 diagnostic.hash(&mut hasher);
1308 let diagnostic_hash = hasher.finish();
1309 !this.emitted_diagnostics.insert(diagnostic_hash)
1312 // Only emit the diagnostic if we've been asked to deduplicate or
1313 // haven't already emitted an equivalent diagnostic.
1314 if !(self.flags.deduplicate_diagnostics && already_emitted(self)) {
1315 debug!(?diagnostic);
1316 debug!(?self.emitted_diagnostics);
1317 let already_emitted_sub = |sub: &mut SubDiagnostic| {
1319 if sub.level != Level::OnceNote {
1322 let mut hasher = StableHasher::new();
1323 sub.hash(&mut hasher);
1324 let diagnostic_hash = hasher.finish();
1325 debug!(?diagnostic_hash);
1326 !self.emitted_diagnostics.insert(diagnostic_hash)
1329 diagnostic.children.drain_filter(already_emitted_sub).for_each(|_| {});
1331 self.emitter.emit_diagnostic(&diagnostic);
1332 if diagnostic.is_error() {
1333 self.deduplicated_err_count += 1;
1334 } else if let Warning(_) = diagnostic.level {
1335 self.deduplicated_warn_count += 1;
1338 if diagnostic.is_error() {
1339 if matches!(diagnostic.level, Level::Error { lint: true }) {
1340 self.bump_lint_err_count();
1342 self.bump_err_count();
1345 Some(ErrorGuaranteed::unchecked_claim_error_was_emitted())
1347 self.bump_warn_count();
1353 fn emit_artifact_notification(&mut self, path: &Path, artifact_type: &str) {
1354 self.emitter.emit_artifact_notification(path, artifact_type);
1357 fn emit_unused_externs(&mut self, lint_level: rustc_lint_defs::Level, unused_externs: &[&str]) {
1358 self.emitter.emit_unused_externs(lint_level, unused_externs);
1361 fn treat_err_as_bug(&self) -> bool {
1362 self.flags.treat_err_as_bug.map_or(false, |c| {
1363 self.err_count() + self.lint_err_count + self.delayed_bug_count() >= c.get()
1367 fn delayed_bug_count(&self) -> usize {
1368 self.delayed_span_bugs.len() + self.delayed_good_path_bugs.len()
1371 fn print_error_count(&mut self, registry: &Registry) {
1372 self.emit_stashed_diagnostics();
1374 let warnings = match self.deduplicated_warn_count {
1376 1 => "1 warning emitted".to_string(),
1377 count => format!("{count} warnings emitted"),
1379 let errors = match self.deduplicated_err_count {
1381 1 => "aborting due to previous error".to_string(),
1382 count => format!("aborting due to {count} previous errors"),
1384 if self.treat_err_as_bug() {
1388 match (errors.len(), warnings.len()) {
1390 (0, _) => self.emitter.emit_diagnostic(&Diagnostic::new(
1391 Level::Warning(None),
1392 DiagnosticMessage::Str(warnings),
1395 let _ = self.fatal(&errors);
1398 let _ = self.fatal(&format!("{}; {}", &errors, &warnings));
1402 let can_show_explain = self.emitter.should_show_explain();
1403 let are_there_diagnostics = !self.emitted_diagnostic_codes.is_empty();
1404 if can_show_explain && are_there_diagnostics {
1405 let mut error_codes = self
1406 .emitted_diagnostic_codes
1408 .filter_map(|x| match &x {
1409 DiagnosticId::Error(s)
1410 if registry.try_find_description(s).map_or(false, |o| o.is_some()) =>
1416 .collect::<Vec<_>>();
1417 if !error_codes.is_empty() {
1419 if error_codes.len() > 1 {
1420 let limit = if error_codes.len() > 9 { 9 } else { error_codes.len() };
1421 self.failure(&format!(
1422 "Some errors have detailed explanations: {}{}",
1423 error_codes[..limit].join(", "),
1424 if error_codes.len() > 9 { "..." } else { "." }
1426 self.failure(&format!(
1427 "For more information about an error, try \
1428 `rustc --explain {}`.",
1432 self.failure(&format!(
1433 "For more information about this error, try \
1434 `rustc --explain {}`.",
1442 fn stash(&mut self, key: (Span, StashKey), diagnostic: Diagnostic) {
1443 // Track the diagnostic for counts, but don't panic-if-treat-err-as-bug
1444 // yet; that happens when we actually emit the diagnostic.
1445 if diagnostic.is_error() {
1446 if matches!(diagnostic.level, Level::Error { lint: true }) {
1447 self.lint_err_count += 1;
1449 self.err_count += 1;
1452 // Warnings are only automatically flushed if they're forced.
1453 if diagnostic.is_force_warn() {
1454 self.warn_count += 1;
1458 // FIXME(Centril, #69537): Consider reintroducing panic on overwriting a stashed diagnostic
1459 // if/when we have a more robust macro-friendly replacement for `(span, key)` as a key.
1460 // See the PR for a discussion.
1461 self.stashed_diagnostics.insert(key, diagnostic);
1464 fn steal(&mut self, key: (Span, StashKey)) -> Option<Diagnostic> {
1465 let diagnostic = self.stashed_diagnostics.remove(&key)?;
1466 if diagnostic.is_error() {
1467 if matches!(diagnostic.level, Level::Error { lint: true }) {
1468 self.lint_err_count -= 1;
1470 self.err_count -= 1;
1473 if diagnostic.is_force_warn() {
1474 self.warn_count -= 1;
1481 fn err_count(&self) -> usize {
1485 fn has_errors(&self) -> bool {
1486 self.err_count() > 0
1488 fn has_errors_or_lint_errors(&self) -> bool {
1489 self.has_errors() || self.lint_err_count > 0
1491 fn has_errors_or_delayed_span_bugs(&self) -> bool {
1492 self.has_errors() || !self.delayed_span_bugs.is_empty()
1494 fn has_any_message(&self) -> bool {
1495 self.err_count() > 0 || self.lint_err_count > 0 || self.warn_count > 0
1498 fn is_compilation_going_to_fail(&self) -> bool {
1499 self.has_errors() || self.lint_err_count > 0 || !self.delayed_span_bugs.is_empty()
1502 fn abort_if_errors(&mut self) {
1503 self.emit_stashed_diagnostics();
1505 if self.has_errors() {
1511 fn span_bug(&mut self, sp: impl Into<MultiSpan>, msg: impl Into<DiagnosticMessage>) -> ! {
1512 self.emit_diag_at_span(Diagnostic::new(Bug, msg), sp);
1513 panic::panic_any(ExplicitBug);
1516 fn emit_diag_at_span(&mut self, mut diag: Diagnostic, sp: impl Into<MultiSpan>) {
1517 self.emit_diagnostic(diag.set_span(sp));
1523 sp: impl Into<MultiSpan>,
1524 msg: impl Into<DiagnosticMessage>,
1525 ) -> ErrorGuaranteed {
1526 // This is technically `self.treat_err_as_bug()` but `delay_span_bug` is called before
1527 // incrementing `err_count` by one, so we need to +1 the comparing.
1528 // FIXME: Would be nice to increment err_count in a more coherent way.
1529 if self.flags.treat_err_as_bug.map_or(false, |c| {
1530 self.err_count() + self.lint_err_count + self.delayed_bug_count() + 1 >= c.get()
1532 // FIXME: don't abort here if report_delayed_bugs is off
1533 self.span_bug(sp, msg);
1535 let mut diagnostic = Diagnostic::new(Level::DelayedBug, msg);
1536 diagnostic.set_span(sp.into());
1537 diagnostic.note(&format!("delayed at {}", std::panic::Location::caller()));
1538 self.emit_diagnostic(&mut diagnostic).unwrap()
1541 // FIXME(eddyb) note the comment inside `impl Drop for HandlerInner`, that's
1542 // where the explanation of what "good path" is (also, it should be renamed).
1543 fn delay_good_path_bug(&mut self, msg: impl Into<DiagnosticMessage>) {
1544 let mut diagnostic = Diagnostic::new(Level::DelayedBug, msg);
1545 if self.flags.report_delayed_bugs {
1546 self.emit_diagnostic(&mut diagnostic);
1548 let backtrace = std::backtrace::Backtrace::force_capture();
1549 self.delayed_good_path_bugs.push(DelayedDiagnostic::with_backtrace(diagnostic, backtrace));
1552 fn failure(&mut self, msg: impl Into<DiagnosticMessage>) {
1553 self.emit_diagnostic(&mut Diagnostic::new(FailureNote, msg));
1556 fn fatal(&mut self, msg: impl Into<DiagnosticMessage>) -> FatalError {
1557 self.emit(Fatal, msg);
1561 fn err(&mut self, msg: impl Into<DiagnosticMessage>) -> ErrorGuaranteed {
1562 self.emit(Error { lint: false }, msg)
1565 /// Emit an error; level should be `Error` or `Fatal`.
1566 fn emit(&mut self, level: Level, msg: impl Into<DiagnosticMessage>) -> ErrorGuaranteed {
1567 if self.treat_err_as_bug() {
1570 self.emit_diagnostic(&mut Diagnostic::new(level, msg)).unwrap()
1573 fn bug(&mut self, msg: impl Into<DiagnosticMessage>) -> ! {
1574 self.emit_diagnostic(&mut Diagnostic::new(Bug, msg));
1575 panic::panic_any(ExplicitBug);
1580 bugs: impl IntoIterator<Item = Diagnostic>,
1581 explanation: impl Into<DiagnosticMessage> + Copy,
1583 let mut no_bugs = true;
1584 for mut bug in bugs {
1586 // Put the overall explanation before the `DelayedBug`s, to
1587 // frame them better (e.g. separate warnings from them).
1588 self.emit_diagnostic(&mut Diagnostic::new(Bug, explanation));
1592 // "Undelay" the `DelayedBug`s (into plain `Bug`s).
1593 if bug.level != Level::DelayedBug {
1594 // NOTE(eddyb) not panicking here because we're already producing
1595 // an ICE, and the more information the merrier.
1597 "`flushed_delayed` got diagnostic with level {:?}, \
1598 instead of the expected `DelayedBug`",
1602 bug.level = Level::Bug;
1604 self.emit_diagnostic(&mut bug);
1607 // Panic with `ExplicitBug` to avoid "unexpected panic" messages.
1609 panic::panic_any(ExplicitBug);
1613 fn bump_lint_err_count(&mut self) {
1614 self.lint_err_count += 1;
1615 self.panic_if_treat_err_as_bug();
1618 fn bump_err_count(&mut self) {
1619 self.err_count += 1;
1620 self.panic_if_treat_err_as_bug();
1623 fn bump_warn_count(&mut self) {
1624 self.warn_count += 1;
1627 fn panic_if_treat_err_as_bug(&self) {
1628 if self.treat_err_as_bug() {
1630 self.err_count() + self.lint_err_count,
1631 self.delayed_bug_count(),
1632 self.flags.treat_err_as_bug.map(|c| c.get()).unwrap_or(0),
1634 (1, 0, 1) => panic!("aborting due to `-Z treat-err-as-bug=1`"),
1635 (0, 1, 1) => panic!("aborting due delayed bug with `-Z treat-err-as-bug=1`"),
1636 (count, delayed_count, as_bug) => {
1637 if delayed_count > 0 {
1639 "aborting after {} errors and {} delayed bugs due to `-Z treat-err-as-bug={}`",
1640 count, delayed_count, as_bug,
1644 "aborting after {} errors due to `-Z treat-err-as-bug={}`",
1654 struct DelayedDiagnostic {
1659 impl DelayedDiagnostic {
1660 fn with_backtrace(diagnostic: Diagnostic, backtrace: Backtrace) -> Self {
1661 DelayedDiagnostic { inner: diagnostic, note: backtrace }
1664 fn decorate(mut self) -> Diagnostic {
1665 self.inner.note(&format!("delayed at {}", self.note));
1670 #[derive(Copy, PartialEq, Eq, Clone, Hash, Debug, Encodable, Decodable)]
1676 /// If this error comes from a lint, don't abort compilation even when abort_if_errors() is called.
1679 /// This [`LintExpectationId`] is used for expected lint diagnostics, which should
1680 /// also emit a warning due to the `force-warn` flag. In all other cases this should
1682 Warning(Option<LintExpectationId>),
1684 /// A note that is only emitted once.
1689 Expect(LintExpectationId),
1692 impl fmt::Display for Level {
1693 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1694 self.to_str().fmt(f)
1699 fn color(self) -> ColorSpec {
1700 let mut spec = ColorSpec::new();
1702 Bug | DelayedBug | Fatal | Error { .. } => {
1703 spec.set_fg(Some(Color::Red)).set_intense(true);
1706 spec.set_fg(Some(Color::Yellow)).set_intense(cfg!(windows));
1708 Note | OnceNote => {
1709 spec.set_fg(Some(Color::Green)).set_intense(true);
1712 spec.set_fg(Some(Color::Cyan)).set_intense(true);
1715 Allow | Expect(_) => unreachable!(),
1720 pub fn to_str(self) -> &'static str {
1722 Bug | DelayedBug => "error: internal compiler error",
1723 Fatal | Error { .. } => "error",
1724 Warning(_) => "warning",
1725 Note | OnceNote => "note",
1727 FailureNote => "failure-note",
1728 Allow => panic!("Shouldn't call on allowed error"),
1729 Expect(_) => panic!("Shouldn't call on expected error"),
1733 pub fn is_failure_note(&self) -> bool {
1734 matches!(*self, FailureNote)
1737 pub fn get_expectation_id(&self) -> Option<LintExpectationId> {
1739 Level::Expect(id) | Level::Warning(Some(id)) => Some(*id),
1745 // FIXME(eddyb) this doesn't belong here AFAICT, should be moved to callsite.
1746 pub fn add_elided_lifetime_in_path_suggestion(
1747 source_map: &SourceMap,
1748 diag: &mut Diagnostic,
1751 incl_angl_brckt: bool,
1752 insertion_span: Span,
1754 diag.span_label(path_span, format!("expected lifetime parameter{}", pluralize!(n)));
1755 if !source_map.is_span_accessible(insertion_span) {
1756 // Do not try to suggest anything if generated by a proc-macro.
1759 let anon_lts = vec!["'_"; n].join(", ");
1761 if incl_angl_brckt { format!("<{}>", anon_lts) } else { format!("{}, ", anon_lts) };
1762 diag.span_suggestion_verbose(
1763 insertion_span.shrink_to_hi(),
1764 &format!("indicate the anonymous lifetime{}", pluralize!(n)),
1766 Applicability::MachineApplicable,
1770 /// Useful type to use with `Result<>` indicate that an error has already
1771 /// been reported to the user, so no need to continue checking.
1772 #[derive(Clone, Copy, Debug, Encodable, Decodable, Hash, PartialEq, Eq, PartialOrd, Ord)]
1773 #[derive(HashStable_Generic)]
1774 pub struct ErrorGuaranteed(());
1776 impl ErrorGuaranteed {
1777 /// To be used only if you really know what you are doing... ideally, we would find a way to
1778 /// eliminate all calls to this method.
1779 pub fn unchecked_claim_error_was_emitted() -> Self {