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(adt_const_params)]
9 #![feature(let_chains)]
10 #![feature(never_type)]
11 #![feature(result_option_inspect)]
12 #![feature(rustc_attrs)]
13 #![allow(incomplete_features)]
16 extern crate rustc_macros;
21 pub use emitter::ColorConfig;
23 use rustc_lint_defs::LintExpectationId;
26 use emitter::{is_case_difference, Emitter, EmitterWriter};
27 use registry::Registry;
28 use rustc_data_structures::fx::{FxHashMap, FxHashSet, FxIndexMap, FxIndexSet};
29 use rustc_data_structures::stable_hasher::StableHasher;
30 use rustc_data_structures::sync::{self, Lock, Lrc};
31 use rustc_data_structures::AtomicRef;
32 pub use rustc_error_messages::{
33 fallback_fluent_bundle, fluent, fluent_bundle, DelayDm, DiagnosticMessage, FluentBundle,
34 LanguageIdentifier, LazyFallbackBundle, MultiSpan, SpanLabel, SubdiagnosticMessage,
35 DEFAULT_LOCALE_RESOURCES,
37 pub use rustc_lint_defs::{pluralize, Applicability};
38 use rustc_span::source_map::SourceMap;
39 use rustc_span::HashStableContext;
40 use rustc_span::{Loc, Span};
44 use std::num::NonZeroUsize;
47 use std::{error, fmt};
49 use termcolor::{Color, ColorSpec};
51 pub mod annotate_snippet_emitter_writer;
53 mod diagnostic_builder;
62 pub use diagnostic_builder::IntoDiagnostic;
63 pub use snippet::Style;
65 pub type PErr<'a> = DiagnosticBuilder<'a, ErrorGuaranteed>;
66 pub type PResult<'a, T> = Result<T, PErr<'a>>;
68 // `PResult` is used a lot. Make sure it doesn't unintentionally get bigger.
69 // (See also the comment on `DiagnosticBuilderInner`'s `diagnostic` field.)
70 #[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))]
71 rustc_data_structures::static_assert_size!(PResult<'_, ()>, 16);
72 #[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))]
73 rustc_data_structures::static_assert_size!(PResult<'_, bool>, 16);
75 #[derive(Debug, PartialEq, Eq, Clone, Copy, Hash, Encodable, Decodable)]
76 pub enum SuggestionStyle {
77 /// Hide the suggested code when displaying this suggestion inline.
79 /// Always hide the suggested code but display the message.
81 /// Do not display this suggestion in the cli output, it is only meant for tools.
83 /// Always show the suggested code.
84 /// This will *not* show the code if the suggestion is inline *and* the suggested code is
87 /// Always show the suggested code independently.
91 impl SuggestionStyle {
92 fn hide_inline(&self) -> bool {
93 !matches!(*self, SuggestionStyle::ShowCode)
97 #[derive(Clone, Debug, PartialEq, Hash, Encodable, Decodable)]
98 pub struct CodeSuggestion {
99 /// Each substitute can have multiple variants due to multiple
100 /// applicable suggestions
102 /// `foo.bar` might be replaced with `a.b` or `x.y` by replacing
103 /// `foo` and `bar` on their own:
105 /// ```ignore (illustrative)
107 /// Substitution { parts: vec![(0..3, "a"), (4..7, "b")] },
108 /// Substitution { parts: vec![(0..3, "x"), (4..7, "y")] },
112 /// or by replacing the entire span:
114 /// ```ignore (illustrative)
116 /// Substitution { parts: vec![(0..7, "a.b")] },
117 /// Substitution { parts: vec![(0..7, "x.y")] },
120 pub substitutions: Vec<Substitution>,
121 pub msg: DiagnosticMessage,
122 /// Visual representation of this suggestion.
123 pub style: SuggestionStyle,
124 /// Whether or not the suggestion is approximate
126 /// Sometimes we may show suggestions with placeholders,
127 /// which are useful for users but not useful for
128 /// tools like rustfix
129 pub applicability: Applicability,
132 #[derive(Clone, Debug, PartialEq, Hash, Encodable, Decodable)]
133 /// See the docs on `CodeSuggestion::substitutions`
134 pub struct Substitution {
135 pub parts: Vec<SubstitutionPart>,
138 #[derive(Clone, Debug, PartialEq, Hash, Encodable, Decodable)]
139 pub struct SubstitutionPart {
144 /// Used to translate between `Span`s and byte positions within a single output line in highlighted
145 /// code of structured suggestions.
146 #[derive(Debug, Clone, Copy)]
147 pub struct SubstitutionHighlight {
152 impl SubstitutionPart {
153 pub fn is_addition(&self, sm: &SourceMap) -> bool {
154 !self.snippet.is_empty() && !self.replaces_meaningful_content(sm)
157 pub fn is_deletion(&self, sm: &SourceMap) -> bool {
158 self.snippet.trim().is_empty() && self.replaces_meaningful_content(sm)
161 pub fn is_replacement(&self, sm: &SourceMap) -> bool {
162 !self.snippet.is_empty() && self.replaces_meaningful_content(sm)
165 fn replaces_meaningful_content(&self, sm: &SourceMap) -> bool {
166 sm.span_to_snippet(self.span)
167 .map_or(!self.span.is_empty(), |snippet| !snippet.trim().is_empty())
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.
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.
182 use rustc_span::{CharPos, Pos};
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.
188 line_opt: Option<&Cow<'_, str>>,
190 hi_opt: Option<&Loc>,
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));
198 Some(hi) if hi > lo => {
199 line_count = line[lo..hi].matches('\n').count();
200 buf.push_str(&line[lo..hi])
204 line_count = line[lo..].matches('\n').count();
205 buf.push_str(&line[lo..])
209 if hi_opt.is_none() {
216 assert!(!self.substitutions.is_empty());
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());
225 debug!("splice_lines: suggestion contains an invalid span: {:?}", subst);
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());
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());
243 // We can't splice anything if the source is unavailable.
244 if !sm.ensure_source_file_source_present(lines.file.clone()) {
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
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);
262 lines.lines.get(0).and_then(|line0| sf.get_line(line0.line_index));
263 let mut buf = String::new();
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.
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 {
273 push_trailing(&mut buf, prev_line.as_ref(), &prev_hi, Some(&cur_lo));
275 highlights.push(std::mem::take(&mut line_highlight));
281 highlights.push(std::mem::take(&mut line_highlight));
282 let mut count = push_trailing(&mut buf, prev_line.as_ref(), &prev_hi, None);
284 highlights.push(std::mem::take(&mut line_highlight));
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());
292 highlights.push(std::mem::take(&mut line_highlight));
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()) {
298 None => cur_line.len(),
300 buf.push_str(&cur_line[..end]);
303 // Add a whole line highlight per line in the snippet.
304 let len: isize = part
308 .unwrap_or(&part.snippet)
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,
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;
328 prev_line = sf.get_line(prev_hi.line - 1);
329 for line in part.snippet.split('\n').skip(1) {
331 highlights.push(std::mem::take(&mut line_highlight));
332 let end: usize = line
339 line_highlight.push(SubstitutionHighlight { start: 0, end });
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);
348 // remove trailing newlines
349 while buf.ends_with('\n') {
352 Some((buf, substitution.parts, highlights, only_capitalization))
358 pub use rustc_span::fatal_error::{FatalError, FatalErrorMarker};
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;
365 impl fmt::Display for ExplicitBug {
366 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
367 write!(f, "parser internal bug")
371 impl error::Error for ExplicitBug {}
373 pub use diagnostic::{
374 AddToDiagnostic, DecorateLint, Diagnostic, DiagnosticArg, DiagnosticArgFromDisplay,
375 DiagnosticArgValue, DiagnosticId, DiagnosticStyledString, IntoDiagnosticArg, SubDiagnostic,
377 pub use diagnostic_builder::{DiagnosticBuilder, EmissionGuarantee};
378 use std::backtrace::Backtrace;
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.
385 inner: Lock<HandlerInner>,
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 {
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.
397 /// This is not necessarily the count that's reported to the user once
398 /// compilation ends.
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,
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>,
414 /// Used to suggest rustc --explain `<error code>`
415 emitted_diagnostic_codes: FxIndexSet<DiagnosticId>,
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
420 emitted_diagnostics: FxHashSet<u128>,
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>,
428 /// The warning count, used for a recap upon finishing
429 deduplicated_warn_count: usize,
431 future_breakage_diagnostics: Vec<Diagnostic>,
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,
440 /// Expected [`Diagnostic`][diagnostic::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`][diagnostic::Diagnostic]s are the
445 /// submitted for storage and added to the list of fulfilled expectations.
446 unstable_expect_diagnostics: Vec<Diagnostic>,
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.
453 /// [RFC-2383]: https://rust-lang.github.io/rfcs/2383-lint-reasons.html
454 fulfilled_expectations: FxHashSet<LintExpectationId>,
457 /// A key denoting where from a diagnostic was stashed.
458 #[derive(Copy, Clone, PartialEq, Eq, Hash)]
461 UnderscoreForArrayLengths,
464 /// When an invalid lifetime e.g. `'2` should be reinterpreted
465 /// as a char literal in the parser
469 fn default_track_diagnostic(_: &Diagnostic) {}
471 pub static TRACK_DIAGNOSTICS: AtomicRef<fn(&Diagnostic)> =
472 AtomicRef::new(&(default_track_diagnostic as fn(&_)));
474 #[derive(Copy, Clone, Default)]
475 pub struct HandlerFlags {
476 /// If false, warning-level lints are suppressed.
477 /// (rustc: see `--allow warnings` and `--cap-lints`)
478 pub can_emit_warnings: bool,
479 /// If true, error-level diagnostics are upgraded to bug-level.
480 /// (rustc: see `-Z treat-err-as-bug`)
481 pub treat_err_as_bug: Option<NonZeroUsize>,
482 /// If true, immediately emit diagnostics that would otherwise be buffered.
483 /// (rustc: see `-Z dont-buffer-diagnostics` and `-Z treat-err-as-bug`)
484 pub dont_buffer_diagnostics: bool,
485 /// If true, immediately print bugs registered with `delay_span_bug`.
486 /// (rustc: see `-Z report-delayed-bugs`)
487 pub report_delayed_bugs: bool,
488 /// Show macro backtraces.
489 /// (rustc: see `-Z macro-backtrace`)
490 pub macro_backtrace: bool,
491 /// If true, identical diagnostics are reported only once.
492 pub deduplicate_diagnostics: bool,
495 impl Drop for HandlerInner {
497 self.emit_stashed_diagnostics();
499 if !self.has_errors() {
500 let bugs = std::mem::replace(&mut self.delayed_span_bugs, Vec::new());
501 self.flush_delayed(bugs, "no errors encountered even though `delay_span_bug` issued");
504 // FIXME(eddyb) this explains what `delayed_good_path_bugs` are!
505 // They're `delayed_span_bugs` but for "require some diagnostic happened"
506 // instead of "require some error happened". Sadly that isn't ideal, as
507 // lints can be `#[allow]`'d, potentially leading to this triggering.
508 // Also, "good path" should be replaced with a better naming.
509 if !self.has_any_message() && !self.suppressed_expected_diag {
510 let bugs = std::mem::replace(&mut self.delayed_good_path_bugs, Vec::new());
512 bugs.into_iter().map(DelayedDiagnostic::decorate),
513 "no warnings or errors encountered even though `delayed_good_path_bugs` issued",
517 if self.check_unstable_expect_diagnostics {
519 self.unstable_expect_diagnostics.is_empty(),
520 "all diagnostics with unstable expectations should have been converted",
527 pub fn with_tty_emitter(
528 color_config: ColorConfig,
529 can_emit_warnings: bool,
530 treat_err_as_bug: Option<NonZeroUsize>,
531 sm: Option<Lrc<SourceMap>>,
532 fluent_bundle: Option<Lrc<FluentBundle>>,
533 fallback_bundle: LazyFallbackBundle,
535 Self::with_tty_emitter_and_flags(
540 HandlerFlags { can_emit_warnings, treat_err_as_bug, ..Default::default() },
544 pub fn with_tty_emitter_and_flags(
545 color_config: ColorConfig,
546 sm: Option<Lrc<SourceMap>>,
547 fluent_bundle: Option<Lrc<FluentBundle>>,
548 fallback_bundle: LazyFallbackBundle,
551 let emitter = Box::new(EmitterWriter::stderr(
559 flags.macro_backtrace,
561 Self::with_emitter_and_flags(emitter, flags)
565 can_emit_warnings: bool,
566 treat_err_as_bug: Option<NonZeroUsize>,
567 emitter: Box<dyn Emitter + sync::Send>,
569 Handler::with_emitter_and_flags(
571 HandlerFlags { can_emit_warnings, treat_err_as_bug, ..Default::default() },
575 pub fn with_emitter_and_flags(
576 emitter: Box<dyn Emitter + sync::Send>,
581 inner: Lock::new(HandlerInner {
586 deduplicated_err_count: 0,
587 deduplicated_warn_count: 0,
589 delayed_span_bugs: Vec::new(),
590 delayed_good_path_bugs: Vec::new(),
591 suppressed_expected_diag: false,
592 taught_diagnostics: Default::default(),
593 emitted_diagnostic_codes: Default::default(),
594 emitted_diagnostics: Default::default(),
595 stashed_diagnostics: Default::default(),
596 future_breakage_diagnostics: Vec::new(),
597 check_unstable_expect_diagnostics: false,
598 unstable_expect_diagnostics: Vec::new(),
599 fulfilled_expectations: Default::default(),
604 // This is here to not allow mutation of flags;
605 // as of this writing it's only used in tests in librustc_middle.
606 pub fn can_emit_warnings(&self) -> bool {
607 self.flags.can_emit_warnings
610 /// Resets the diagnostic error count as well as the cached emitted diagnostics.
612 /// NOTE: *do not* call this function from rustc. It is only meant to be called from external
613 /// tools that want to reuse a `Parser` cleaning the previously emitted diagnostics as well as
614 /// the overall count of emitted error diagnostics.
615 pub fn reset_err_count(&self) {
616 let mut inner = self.inner.borrow_mut();
618 inner.warn_count = 0;
619 inner.deduplicated_err_count = 0;
620 inner.deduplicated_warn_count = 0;
622 // actually free the underlying memory (which `clear` would not do)
623 inner.delayed_span_bugs = Default::default();
624 inner.delayed_good_path_bugs = Default::default();
625 inner.taught_diagnostics = Default::default();
626 inner.emitted_diagnostic_codes = Default::default();
627 inner.emitted_diagnostics = Default::default();
628 inner.stashed_diagnostics = Default::default();
631 /// Stash a given diagnostic with the given `Span` and `StashKey` as the key for later stealing.
632 pub fn stash_diagnostic(&self, span: Span, key: StashKey, diag: Diagnostic) {
633 let mut inner = self.inner.borrow_mut();
634 inner.stash((span, key), diag);
637 /// Steal a previously stashed diagnostic with the given `Span` and `StashKey` as the key.
638 pub fn steal_diagnostic(&self, span: Span, key: StashKey) -> Option<DiagnosticBuilder<'_, ()>> {
639 let mut inner = self.inner.borrow_mut();
640 inner.steal((span, key)).map(|diag| DiagnosticBuilder::new_diagnostic(self, diag))
643 pub fn has_stashed_diagnostic(&self, span: Span, key: StashKey) -> bool {
644 self.inner.borrow().stashed_diagnostics.get(&(span, key)).is_some()
647 /// Emit all stashed diagnostics.
648 pub fn emit_stashed_diagnostics(&self) -> Option<ErrorGuaranteed> {
649 self.inner.borrow_mut().emit_stashed_diagnostics()
652 /// Construct a builder with the `msg` at the level appropriate for the specific `EmissionGuarantee`.
653 #[rustc_lint_diagnostics]
654 pub fn struct_diagnostic<G: EmissionGuarantee>(
656 msg: impl Into<DiagnosticMessage>,
657 ) -> DiagnosticBuilder<'_, G> {
658 G::make_diagnostic_builder(self, msg)
661 /// Construct a builder at the `Warning` level at the given `span` and with the `msg`.
663 /// Attempting to `.emit()` the builder will only emit if either:
664 /// * `can_emit_warnings` is `true`
665 /// * `is_force_warn` was set in `DiagnosticId::Lint`
666 #[rustc_lint_diagnostics]
667 pub fn struct_span_warn(
669 span: impl Into<MultiSpan>,
670 msg: impl Into<DiagnosticMessage>,
671 ) -> DiagnosticBuilder<'_, ()> {
672 let mut result = self.struct_warn(msg);
673 result.set_span(span);
677 /// Construct a builder at the `Warning` level at the given `span` and with the `msg`.
678 /// The `id` is used for lint emissions which should also fulfill a lint expectation.
680 /// Attempting to `.emit()` the builder will only emit if either:
681 /// * `can_emit_warnings` is `true`
682 /// * `is_force_warn` was set in `DiagnosticId::Lint`
683 pub fn struct_span_warn_with_expectation(
685 span: impl Into<MultiSpan>,
686 msg: impl Into<DiagnosticMessage>,
687 id: LintExpectationId,
688 ) -> DiagnosticBuilder<'_, ()> {
689 let mut result = self.struct_warn_with_expectation(msg, id);
690 result.set_span(span);
694 /// Construct a builder at the `Allow` level at the given `span` and with the `msg`.
695 #[rustc_lint_diagnostics]
696 pub fn struct_span_allow(
698 span: impl Into<MultiSpan>,
699 msg: impl Into<DiagnosticMessage>,
700 ) -> DiagnosticBuilder<'_, ()> {
701 let mut result = self.struct_allow(msg);
702 result.set_span(span);
706 /// Construct a builder at the `Warning` level at the given `span` and with the `msg`.
707 /// Also include a code.
708 #[rustc_lint_diagnostics]
709 pub fn struct_span_warn_with_code(
711 span: impl Into<MultiSpan>,
712 msg: impl Into<DiagnosticMessage>,
714 ) -> DiagnosticBuilder<'_, ()> {
715 let mut result = self.struct_span_warn(span, msg);
720 /// Construct a builder at the `Warning` level with the `msg`.
722 /// Attempting to `.emit()` the builder will only emit if either:
723 /// * `can_emit_warnings` is `true`
724 /// * `is_force_warn` was set in `DiagnosticId::Lint`
725 #[rustc_lint_diagnostics]
726 pub fn struct_warn(&self, msg: impl Into<DiagnosticMessage>) -> DiagnosticBuilder<'_, ()> {
727 DiagnosticBuilder::new(self, Level::Warning(None), msg)
730 /// Construct a builder at the `Warning` level with the `msg`. The `id` is used for
731 /// lint emissions which should also fulfill a lint expectation.
733 /// Attempting to `.emit()` the builder will only emit if either:
734 /// * `can_emit_warnings` is `true`
735 /// * `is_force_warn` was set in `DiagnosticId::Lint`
736 pub fn struct_warn_with_expectation(
738 msg: impl Into<DiagnosticMessage>,
739 id: LintExpectationId,
740 ) -> DiagnosticBuilder<'_, ()> {
741 DiagnosticBuilder::new(self, Level::Warning(Some(id)), msg)
744 /// Construct a builder at the `Allow` level with the `msg`.
745 #[rustc_lint_diagnostics]
746 pub fn struct_allow(&self, msg: impl Into<DiagnosticMessage>) -> DiagnosticBuilder<'_, ()> {
747 DiagnosticBuilder::new(self, Level::Allow, msg)
750 /// Construct a builder at the `Expect` level with the `msg`.
751 #[rustc_lint_diagnostics]
752 pub fn struct_expect(
754 msg: impl Into<DiagnosticMessage>,
755 id: LintExpectationId,
756 ) -> DiagnosticBuilder<'_, ()> {
757 DiagnosticBuilder::new(self, Level::Expect(id), msg)
760 /// Construct a builder at the `Error` level at the given `span` and with the `msg`.
761 #[rustc_lint_diagnostics]
762 pub fn struct_span_err(
764 span: impl Into<MultiSpan>,
765 msg: impl Into<DiagnosticMessage>,
766 ) -> DiagnosticBuilder<'_, ErrorGuaranteed> {
767 let mut result = self.struct_err(msg);
768 result.set_span(span);
772 /// Construct a builder at the `Error` level at the given `span`, with the `msg`, and `code`.
773 #[rustc_lint_diagnostics]
774 pub fn struct_span_err_with_code(
776 span: impl Into<MultiSpan>,
777 msg: impl Into<DiagnosticMessage>,
779 ) -> DiagnosticBuilder<'_, ErrorGuaranteed> {
780 let mut result = self.struct_span_err(span, msg);
785 /// Construct a builder at the `Error` level with the `msg`.
786 // FIXME: This method should be removed (every error should have an associated error code).
787 #[rustc_lint_diagnostics]
790 msg: impl Into<DiagnosticMessage>,
791 ) -> DiagnosticBuilder<'_, ErrorGuaranteed> {
792 DiagnosticBuilder::new_guaranteeing_error::<_, { Level::Error { lint: false } }>(self, msg)
795 /// This should only be used by `rustc_middle::lint::struct_lint_level`. Do not use it for hard errors.
797 pub fn struct_err_lint(&self, msg: impl Into<DiagnosticMessage>) -> DiagnosticBuilder<'_, ()> {
798 DiagnosticBuilder::new(self, Level::Error { lint: true }, msg)
801 /// Construct a builder at the `Error` level with the `msg` and the `code`.
802 #[rustc_lint_diagnostics]
803 pub fn struct_err_with_code(
805 msg: impl Into<DiagnosticMessage>,
807 ) -> DiagnosticBuilder<'_, ErrorGuaranteed> {
808 let mut result = self.struct_err(msg);
813 /// Construct a builder at the `Warn` level with the `msg` and the `code`.
814 #[rustc_lint_diagnostics]
815 pub fn struct_warn_with_code(
817 msg: impl Into<DiagnosticMessage>,
819 ) -> DiagnosticBuilder<'_, ()> {
820 let mut result = self.struct_warn(msg);
825 /// Construct a builder at the `Fatal` level at the given `span` and with the `msg`.
826 #[rustc_lint_diagnostics]
827 pub fn struct_span_fatal(
829 span: impl Into<MultiSpan>,
830 msg: impl Into<DiagnosticMessage>,
831 ) -> DiagnosticBuilder<'_, !> {
832 let mut result = self.struct_fatal(msg);
833 result.set_span(span);
837 /// Construct a builder at the `Fatal` level at the given `span`, with the `msg`, and `code`.
838 #[rustc_lint_diagnostics]
839 pub fn struct_span_fatal_with_code(
841 span: impl Into<MultiSpan>,
842 msg: impl Into<DiagnosticMessage>,
844 ) -> DiagnosticBuilder<'_, !> {
845 let mut result = self.struct_span_fatal(span, msg);
850 /// Construct a builder at the `Error` level with the `msg`.
851 #[rustc_lint_diagnostics]
852 pub fn struct_fatal(&self, msg: impl Into<DiagnosticMessage>) -> DiagnosticBuilder<'_, !> {
853 DiagnosticBuilder::new_fatal(self, msg)
856 /// Construct a builder at the `Help` level with the `msg`.
857 #[rustc_lint_diagnostics]
858 pub fn struct_help(&self, msg: impl Into<DiagnosticMessage>) -> DiagnosticBuilder<'_, ()> {
859 DiagnosticBuilder::new(self, Level::Help, msg)
862 /// Construct a builder at the `Note` level with the `msg`.
863 #[rustc_lint_diagnostics]
864 pub fn struct_note_without_error(
866 msg: impl Into<DiagnosticMessage>,
867 ) -> DiagnosticBuilder<'_, ()> {
868 DiagnosticBuilder::new(self, Level::Note, msg)
871 #[rustc_lint_diagnostics]
872 pub fn span_fatal(&self, span: impl Into<MultiSpan>, msg: impl Into<DiagnosticMessage>) -> ! {
873 self.emit_diag_at_span(Diagnostic::new(Fatal, msg), span);
877 #[rustc_lint_diagnostics]
878 pub fn span_fatal_with_code(
880 span: impl Into<MultiSpan>,
881 msg: impl Into<DiagnosticMessage>,
884 self.emit_diag_at_span(Diagnostic::new_with_code(Fatal, Some(code), msg), span);
888 #[rustc_lint_diagnostics]
891 span: impl Into<MultiSpan>,
892 msg: impl Into<DiagnosticMessage>,
893 ) -> ErrorGuaranteed {
894 self.emit_diag_at_span(Diagnostic::new(Error { lint: false }, msg), span).unwrap()
897 #[rustc_lint_diagnostics]
898 pub fn span_err_with_code(
900 span: impl Into<MultiSpan>,
901 msg: impl Into<DiagnosticMessage>,
904 self.emit_diag_at_span(
905 Diagnostic::new_with_code(Error { lint: false }, Some(code), msg),
910 #[rustc_lint_diagnostics]
911 pub fn span_warn(&self, span: impl Into<MultiSpan>, msg: impl Into<DiagnosticMessage>) {
912 self.emit_diag_at_span(Diagnostic::new(Warning(None), msg), span);
915 #[rustc_lint_diagnostics]
916 pub fn span_warn_with_code(
918 span: impl Into<MultiSpan>,
919 msg: impl Into<DiagnosticMessage>,
922 self.emit_diag_at_span(Diagnostic::new_with_code(Warning(None), Some(code), msg), span);
925 pub fn span_bug(&self, span: impl Into<MultiSpan>, msg: impl Into<DiagnosticMessage>) -> ! {
926 self.inner.borrow_mut().span_bug(span, msg)
930 pub fn delay_span_bug(
932 span: impl Into<MultiSpan>,
933 msg: impl Into<DiagnosticMessage>,
934 ) -> ErrorGuaranteed {
935 self.inner.borrow_mut().delay_span_bug(span, msg)
938 // FIXME(eddyb) note the comment inside `impl Drop for HandlerInner`, that's
939 // where the explanation of what "good path" is (also, it should be renamed).
940 pub fn delay_good_path_bug(&self, msg: impl Into<DiagnosticMessage>) {
941 self.inner.borrow_mut().delay_good_path_bug(msg)
944 pub fn span_bug_no_panic(&self, span: impl Into<MultiSpan>, msg: impl Into<DiagnosticMessage>) {
945 self.emit_diag_at_span(Diagnostic::new(Bug, msg), span);
948 pub fn span_note_without_error(
950 span: impl Into<MultiSpan>,
951 msg: impl Into<DiagnosticMessage>,
953 self.emit_diag_at_span(Diagnostic::new(Note, msg), span);
956 pub fn span_note_diag(
959 msg: impl Into<DiagnosticMessage>,
960 ) -> DiagnosticBuilder<'_, ()> {
961 let mut db = DiagnosticBuilder::new(self, Note, msg);
966 // NOTE: intentionally doesn't raise an error so rustc_codegen_ssa only reports fatal errors in the main thread
967 pub fn fatal(&self, msg: impl Into<DiagnosticMessage>) -> FatalError {
968 self.inner.borrow_mut().fatal(msg)
971 pub fn err(&self, msg: impl Into<DiagnosticMessage>) -> ErrorGuaranteed {
972 self.inner.borrow_mut().err(msg)
975 pub fn warn(&self, msg: impl Into<DiagnosticMessage>) {
976 let mut db = DiagnosticBuilder::new(self, Warning(None), msg);
980 pub fn note_without_error(&self, msg: impl Into<DiagnosticMessage>) {
981 DiagnosticBuilder::new(self, Note, msg).emit();
984 pub fn bug(&self, msg: impl Into<DiagnosticMessage>) -> ! {
985 self.inner.borrow_mut().bug(msg)
989 pub fn err_count(&self) -> usize {
990 self.inner.borrow().err_count()
993 pub fn has_errors(&self) -> Option<ErrorGuaranteed> {
994 if self.inner.borrow().has_errors() { Some(ErrorGuaranteed(())) } else { None }
996 pub fn has_errors_or_lint_errors(&self) -> Option<ErrorGuaranteed> {
997 if self.inner.borrow().has_errors_or_lint_errors() {
998 Some(ErrorGuaranteed(()))
1003 pub fn has_errors_or_delayed_span_bugs(&self) -> bool {
1004 self.inner.borrow().has_errors_or_delayed_span_bugs()
1007 pub fn print_error_count(&self, registry: &Registry) {
1008 self.inner.borrow_mut().print_error_count(registry)
1011 pub fn take_future_breakage_diagnostics(&self) -> Vec<Diagnostic> {
1012 std::mem::take(&mut self.inner.borrow_mut().future_breakage_diagnostics)
1015 pub fn abort_if_errors(&self) {
1016 self.inner.borrow_mut().abort_if_errors()
1019 /// `true` if we haven't taught a diagnostic with this code already.
1020 /// The caller must then teach the user about such a diagnostic.
1022 /// Used to suppress emitting the same error multiple times with extended explanation when
1023 /// calling `-Zteach`.
1024 pub fn must_teach(&self, code: &DiagnosticId) -> bool {
1025 self.inner.borrow_mut().must_teach(code)
1028 pub fn force_print_diagnostic(&self, db: Diagnostic) {
1029 self.inner.borrow_mut().force_print_diagnostic(db)
1032 pub fn emit_diagnostic(&self, diagnostic: &mut Diagnostic) -> Option<ErrorGuaranteed> {
1033 self.inner.borrow_mut().emit_diagnostic(diagnostic)
1036 pub fn emit_err<'a>(&'a self, err: impl IntoDiagnostic<'a>) -> ErrorGuaranteed {
1037 self.create_err(err).emit()
1040 pub fn create_err<'a>(
1042 err: impl IntoDiagnostic<'a>,
1043 ) -> DiagnosticBuilder<'a, ErrorGuaranteed> {
1044 err.into_diagnostic(self)
1047 pub fn create_warning<'a>(
1049 warning: impl IntoDiagnostic<'a, ()>,
1050 ) -> DiagnosticBuilder<'a, ()> {
1051 warning.into_diagnostic(self)
1054 pub fn emit_warning<'a>(&'a self, warning: impl IntoDiagnostic<'a, ()>) {
1055 self.create_warning(warning).emit()
1058 pub fn create_fatal<'a>(
1060 fatal: impl IntoDiagnostic<'a, !>,
1061 ) -> DiagnosticBuilder<'a, !> {
1062 fatal.into_diagnostic(self)
1065 pub fn emit_fatal<'a>(&'a self, fatal: impl IntoDiagnostic<'a, !>) -> ! {
1066 self.create_fatal(fatal).emit()
1069 fn emit_diag_at_span(
1071 mut diag: Diagnostic,
1072 sp: impl Into<MultiSpan>,
1073 ) -> Option<ErrorGuaranteed> {
1074 let mut inner = self.inner.borrow_mut();
1075 inner.emit_diagnostic(diag.set_span(sp))
1078 pub fn emit_artifact_notification(&self, path: &Path, artifact_type: &str) {
1079 self.inner.borrow_mut().emit_artifact_notification(path, artifact_type)
1082 pub fn emit_future_breakage_report(&self, diags: Vec<Diagnostic>) {
1083 self.inner.borrow_mut().emitter.emit_future_breakage_report(diags)
1086 pub fn emit_unused_externs(
1088 lint_level: rustc_lint_defs::Level,
1090 unused_externs: &[&str],
1092 let mut inner = self.inner.borrow_mut();
1094 if loud && lint_level.is_error() {
1095 inner.bump_err_count();
1098 inner.emit_unused_externs(lint_level, unused_externs)
1101 pub fn update_unstable_expectation_id(
1103 unstable_to_stable: &FxHashMap<LintExpectationId, LintExpectationId>,
1105 let mut inner = self.inner.borrow_mut();
1106 let diags = std::mem::take(&mut inner.unstable_expect_diagnostics);
1107 inner.check_unstable_expect_diagnostics = true;
1109 if !diags.is_empty() {
1110 inner.suppressed_expected_diag = true;
1111 for mut diag in diags.into_iter() {
1112 diag.update_unstable_expectation_id(unstable_to_stable);
1114 // Here the diagnostic is given back to `emit_diagnostic` where it was first
1115 // intercepted. Now it should be processed as usual, since the unstable expectation
1116 // id is now stable.
1117 inner.emit_diagnostic(&mut diag);
1122 .stashed_diagnostics
1124 .for_each(|diag| diag.update_unstable_expectation_id(unstable_to_stable));
1126 .future_breakage_diagnostics
1128 .for_each(|diag| diag.update_unstable_expectation_id(unstable_to_stable));
1131 /// This methods steals all [`LintExpectationId`]s that are stored inside
1132 /// [`HandlerInner`] and indicate that the linked expectation has been fulfilled.
1134 pub fn steal_fulfilled_expectation_ids(&self) -> FxHashSet<LintExpectationId> {
1136 self.inner.borrow().unstable_expect_diagnostics.is_empty(),
1137 "`HandlerInner::unstable_expect_diagnostics` should be empty at this point",
1139 std::mem::take(&mut self.inner.borrow_mut().fulfilled_expectations)
1142 pub fn flush_delayed(&self) {
1143 let mut inner = self.inner.lock();
1144 let bugs = std::mem::replace(&mut inner.delayed_span_bugs, Vec::new());
1145 inner.flush_delayed(bugs, "no errors encountered even though `delay_span_bug` issued");
1150 fn must_teach(&mut self, code: &DiagnosticId) -> bool {
1151 self.taught_diagnostics.insert(code.clone())
1154 fn force_print_diagnostic(&mut self, mut db: Diagnostic) {
1155 self.emitter.emit_diagnostic(&mut db);
1158 /// Emit all stashed diagnostics.
1159 fn emit_stashed_diagnostics(&mut self) -> Option<ErrorGuaranteed> {
1160 let has_errors = self.has_errors();
1161 let diags = self.stashed_diagnostics.drain(..).map(|x| x.1).collect::<Vec<_>>();
1162 let mut reported = None;
1163 for mut diag in diags {
1164 // Decrement the count tracking the stash; emitting will increment it.
1165 if diag.is_error() {
1166 if matches!(diag.level, Level::Error { lint: true }) {
1167 self.lint_err_count -= 1;
1169 self.err_count -= 1;
1172 if diag.is_force_warn() {
1173 self.warn_count -= 1;
1175 // Unless they're forced, don't flush stashed warnings when
1176 // there are errors, to avoid causing warning overload. The
1177 // stash would've been stolen already if it were important.
1183 let reported_this = self.emit_diagnostic(&mut diag);
1184 reported = reported.or(reported_this);
1189 // FIXME(eddyb) this should ideally take `diagnostic` by value.
1190 fn emit_diagnostic(&mut self, diagnostic: &mut Diagnostic) -> Option<ErrorGuaranteed> {
1191 // The `LintExpectationId` can be stable or unstable depending on when it was created.
1192 // Diagnostics created before the definition of `HirId`s are unstable and can not yet
1193 // be stored. Instead, they are buffered until the `LintExpectationId` is replaced by
1194 // a stable one by the `LintLevelsBuilder`.
1195 if let Some(LintExpectationId::Unstable { .. }) = diagnostic.level.get_expectation_id() {
1196 self.unstable_expect_diagnostics.push(diagnostic.clone());
1200 if diagnostic.level == Level::DelayedBug {
1201 // FIXME(eddyb) this should check for `has_errors` and stop pushing
1202 // once *any* errors were emitted (and truncate `delayed_span_bugs`
1203 // when an error is first emitted, also), but maybe there's a case
1204 // in which that's not sound? otherwise this is really inefficient.
1205 self.delayed_span_bugs.push(diagnostic.clone());
1207 if !self.flags.report_delayed_bugs {
1208 return Some(ErrorGuaranteed::unchecked_claim_error_was_emitted());
1212 if diagnostic.has_future_breakage() {
1213 self.future_breakage_diagnostics.push(diagnostic.clone());
1216 if let Some(expectation_id) = diagnostic.level.get_expectation_id() {
1217 self.suppressed_expected_diag = true;
1218 self.fulfilled_expectations.insert(expectation_id.normalize());
1221 if matches!(diagnostic.level, Warning(_))
1222 && !self.flags.can_emit_warnings
1223 && !diagnostic.is_force_warn()
1225 if diagnostic.has_future_breakage() {
1226 (*TRACK_DIAGNOSTICS)(diagnostic);
1231 (*TRACK_DIAGNOSTICS)(diagnostic);
1233 if matches!(diagnostic.level, Level::Expect(_) | Level::Allow) {
1237 if let Some(ref code) = diagnostic.code {
1238 self.emitted_diagnostic_codes.insert(code.clone());
1241 let already_emitted = |this: &mut Self| {
1242 let mut hasher = StableHasher::new();
1243 diagnostic.hash(&mut hasher);
1244 let diagnostic_hash = hasher.finish();
1245 !this.emitted_diagnostics.insert(diagnostic_hash)
1248 // Only emit the diagnostic if we've been asked to deduplicate or
1249 // haven't already emitted an equivalent diagnostic.
1250 if !(self.flags.deduplicate_diagnostics && already_emitted(self)) {
1251 debug!(?diagnostic);
1252 debug!(?self.emitted_diagnostics);
1253 let already_emitted_sub = |sub: &mut SubDiagnostic| {
1255 if sub.level != Level::OnceNote {
1258 let mut hasher = StableHasher::new();
1259 sub.hash(&mut hasher);
1260 let diagnostic_hash = hasher.finish();
1261 debug!(?diagnostic_hash);
1262 !self.emitted_diagnostics.insert(diagnostic_hash)
1265 diagnostic.children.drain_filter(already_emitted_sub).for_each(|_| {});
1267 self.emitter.emit_diagnostic(&diagnostic);
1268 if diagnostic.is_error() {
1269 self.deduplicated_err_count += 1;
1270 } else if let Warning(_) = diagnostic.level {
1271 self.deduplicated_warn_count += 1;
1274 if diagnostic.is_error() {
1275 if matches!(diagnostic.level, Level::Error { lint: true }) {
1276 self.bump_lint_err_count();
1278 self.bump_err_count();
1281 Some(ErrorGuaranteed::unchecked_claim_error_was_emitted())
1283 self.bump_warn_count();
1289 fn emit_artifact_notification(&mut self, path: &Path, artifact_type: &str) {
1290 self.emitter.emit_artifact_notification(path, artifact_type);
1293 fn emit_unused_externs(&mut self, lint_level: rustc_lint_defs::Level, unused_externs: &[&str]) {
1294 self.emitter.emit_unused_externs(lint_level, unused_externs);
1297 fn treat_err_as_bug(&self) -> bool {
1298 self.flags.treat_err_as_bug.map_or(false, |c| {
1299 self.err_count() + self.lint_err_count + self.delayed_bug_count() >= c.get()
1303 fn delayed_bug_count(&self) -> usize {
1304 self.delayed_span_bugs.len() + self.delayed_good_path_bugs.len()
1307 fn print_error_count(&mut self, registry: &Registry) {
1308 self.emit_stashed_diagnostics();
1310 let warnings = match self.deduplicated_warn_count {
1312 1 => "1 warning emitted".to_string(),
1313 count => format!("{count} warnings emitted"),
1315 let errors = match self.deduplicated_err_count {
1317 1 => "aborting due to previous error".to_string(),
1318 count => format!("aborting due to {count} previous errors"),
1320 if self.treat_err_as_bug() {
1324 match (errors.len(), warnings.len()) {
1326 (0, _) => self.emitter.emit_diagnostic(&Diagnostic::new(
1327 Level::Warning(None),
1328 DiagnosticMessage::Str(warnings),
1331 let _ = self.fatal(&errors);
1334 let _ = self.fatal(&format!("{}; {}", &errors, &warnings));
1338 let can_show_explain = self.emitter.should_show_explain();
1339 let are_there_diagnostics = !self.emitted_diagnostic_codes.is_empty();
1340 if can_show_explain && are_there_diagnostics {
1341 let mut error_codes = self
1342 .emitted_diagnostic_codes
1344 .filter_map(|x| match &x {
1345 DiagnosticId::Error(s)
1346 if registry.try_find_description(s).map_or(false, |o| o.is_some()) =>
1352 .collect::<Vec<_>>();
1353 if !error_codes.is_empty() {
1355 if error_codes.len() > 1 {
1356 let limit = if error_codes.len() > 9 { 9 } else { error_codes.len() };
1357 self.failure(&format!(
1358 "Some errors have detailed explanations: {}{}",
1359 error_codes[..limit].join(", "),
1360 if error_codes.len() > 9 { "..." } else { "." }
1362 self.failure(&format!(
1363 "For more information about an error, try \
1364 `rustc --explain {}`.",
1368 self.failure(&format!(
1369 "For more information about this error, try \
1370 `rustc --explain {}`.",
1378 fn stash(&mut self, key: (Span, StashKey), diagnostic: Diagnostic) {
1379 // Track the diagnostic for counts, but don't panic-if-treat-err-as-bug
1380 // yet; that happens when we actually emit the diagnostic.
1381 if diagnostic.is_error() {
1382 if matches!(diagnostic.level, Level::Error { lint: true }) {
1383 self.lint_err_count += 1;
1385 self.err_count += 1;
1388 // Warnings are only automatically flushed if they're forced.
1389 if diagnostic.is_force_warn() {
1390 self.warn_count += 1;
1394 // FIXME(Centril, #69537): Consider reintroducing panic on overwriting a stashed diagnostic
1395 // if/when we have a more robust macro-friendly replacement for `(span, key)` as a key.
1396 // See the PR for a discussion.
1397 self.stashed_diagnostics.insert(key, diagnostic);
1400 fn steal(&mut self, key: (Span, StashKey)) -> Option<Diagnostic> {
1401 let diagnostic = self.stashed_diagnostics.remove(&key)?;
1402 if diagnostic.is_error() {
1403 if matches!(diagnostic.level, Level::Error { lint: true }) {
1404 self.lint_err_count -= 1;
1406 self.err_count -= 1;
1409 if diagnostic.is_force_warn() {
1410 self.warn_count -= 1;
1417 fn err_count(&self) -> usize {
1421 fn has_errors(&self) -> bool {
1422 self.err_count() > 0
1424 fn has_errors_or_lint_errors(&self) -> bool {
1425 self.has_errors() || self.lint_err_count > 0
1427 fn has_errors_or_delayed_span_bugs(&self) -> bool {
1428 self.has_errors() || !self.delayed_span_bugs.is_empty()
1430 fn has_any_message(&self) -> bool {
1431 self.err_count() > 0 || self.lint_err_count > 0 || self.warn_count > 0
1434 fn abort_if_errors(&mut self) {
1435 self.emit_stashed_diagnostics();
1437 if self.has_errors() {
1442 fn span_bug(&mut self, sp: impl Into<MultiSpan>, msg: impl Into<DiagnosticMessage>) -> ! {
1443 self.emit_diag_at_span(Diagnostic::new(Bug, msg), sp);
1444 panic::panic_any(ExplicitBug);
1447 fn emit_diag_at_span(&mut self, mut diag: Diagnostic, sp: impl Into<MultiSpan>) {
1448 self.emit_diagnostic(diag.set_span(sp));
1454 sp: impl Into<MultiSpan>,
1455 msg: impl Into<DiagnosticMessage>,
1456 ) -> ErrorGuaranteed {
1457 // This is technically `self.treat_err_as_bug()` but `delay_span_bug` is called before
1458 // incrementing `err_count` by one, so we need to +1 the comparing.
1459 // FIXME: Would be nice to increment err_count in a more coherent way.
1460 if self.flags.treat_err_as_bug.map_or(false, |c| {
1461 self.err_count() + self.lint_err_count + self.delayed_bug_count() + 1 >= c.get()
1463 // FIXME: don't abort here if report_delayed_bugs is off
1464 self.span_bug(sp, msg);
1466 let mut diagnostic = Diagnostic::new(Level::DelayedBug, msg);
1467 diagnostic.set_span(sp.into());
1468 diagnostic.note(&format!("delayed at {}", std::panic::Location::caller()));
1469 self.emit_diagnostic(&mut diagnostic).unwrap()
1472 // FIXME(eddyb) note the comment inside `impl Drop for HandlerInner`, that's
1473 // where the explanation of what "good path" is (also, it should be renamed).
1474 fn delay_good_path_bug(&mut self, msg: impl Into<DiagnosticMessage>) {
1475 let mut diagnostic = Diagnostic::new(Level::DelayedBug, msg);
1476 if self.flags.report_delayed_bugs {
1477 self.emit_diagnostic(&mut diagnostic);
1479 let backtrace = std::backtrace::Backtrace::force_capture();
1480 self.delayed_good_path_bugs.push(DelayedDiagnostic::with_backtrace(diagnostic, backtrace));
1483 fn failure(&mut self, msg: impl Into<DiagnosticMessage>) {
1484 self.emit_diagnostic(&mut Diagnostic::new(FailureNote, msg));
1487 fn fatal(&mut self, msg: impl Into<DiagnosticMessage>) -> FatalError {
1488 self.emit(Fatal, msg);
1492 fn err(&mut self, msg: impl Into<DiagnosticMessage>) -> ErrorGuaranteed {
1493 self.emit(Error { lint: false }, msg)
1496 /// Emit an error; level should be `Error` or `Fatal`.
1497 fn emit(&mut self, level: Level, msg: impl Into<DiagnosticMessage>) -> ErrorGuaranteed {
1498 if self.treat_err_as_bug() {
1501 self.emit_diagnostic(&mut Diagnostic::new(level, msg)).unwrap()
1504 fn bug(&mut self, msg: impl Into<DiagnosticMessage>) -> ! {
1505 self.emit_diagnostic(&mut Diagnostic::new(Bug, msg));
1506 panic::panic_any(ExplicitBug);
1511 bugs: impl IntoIterator<Item = Diagnostic>,
1512 explanation: impl Into<DiagnosticMessage> + Copy,
1514 let mut no_bugs = true;
1515 for mut bug in bugs {
1517 // Put the overall explanation before the `DelayedBug`s, to
1518 // frame them better (e.g. separate warnings from them).
1519 self.emit_diagnostic(&mut Diagnostic::new(Bug, explanation));
1523 // "Undelay" the `DelayedBug`s (into plain `Bug`s).
1524 if bug.level != Level::DelayedBug {
1525 // NOTE(eddyb) not panicking here because we're already producing
1526 // an ICE, and the more information the merrier.
1528 "`flushed_delayed` got diagnostic with level {:?}, \
1529 instead of the expected `DelayedBug`",
1533 bug.level = Level::Bug;
1535 self.emit_diagnostic(&mut bug);
1538 // Panic with `ExplicitBug` to avoid "unexpected panic" messages.
1540 panic::panic_any(ExplicitBug);
1544 fn bump_lint_err_count(&mut self) {
1545 self.lint_err_count += 1;
1546 self.panic_if_treat_err_as_bug();
1549 fn bump_err_count(&mut self) {
1550 self.err_count += 1;
1551 self.panic_if_treat_err_as_bug();
1554 fn bump_warn_count(&mut self) {
1555 self.warn_count += 1;
1558 fn panic_if_treat_err_as_bug(&self) {
1559 if self.treat_err_as_bug() {
1561 self.err_count() + self.lint_err_count,
1562 self.delayed_bug_count(),
1563 self.flags.treat_err_as_bug.map(|c| c.get()).unwrap_or(0),
1565 (1, 0, 1) => panic!("aborting due to `-Z treat-err-as-bug=1`"),
1566 (0, 1, 1) => panic!("aborting due delayed bug with `-Z treat-err-as-bug=1`"),
1567 (count, delayed_count, as_bug) => {
1568 if delayed_count > 0 {
1570 "aborting after {} errors and {} delayed bugs due to `-Z treat-err-as-bug={}`",
1571 count, delayed_count, as_bug,
1575 "aborting after {} errors due to `-Z treat-err-as-bug={}`",
1585 struct DelayedDiagnostic {
1590 impl DelayedDiagnostic {
1591 fn with_backtrace(diagnostic: Diagnostic, backtrace: Backtrace) -> Self {
1592 DelayedDiagnostic { inner: diagnostic, note: backtrace }
1595 fn decorate(mut self) -> Diagnostic {
1596 self.inner.note(&format!("delayed at {}", self.note));
1601 #[derive(Copy, PartialEq, Eq, Clone, Hash, Debug, Encodable, Decodable)]
1607 /// If this error comes from a lint, don't abort compilation even when abort_if_errors() is called.
1610 /// This [`LintExpectationId`] is used for expected lint diagnostics, which should
1611 /// also emit a warning due to the `force-warn` flag. In all other cases this should
1613 Warning(Option<LintExpectationId>),
1615 /// A note that is only emitted once.
1620 Expect(LintExpectationId),
1623 impl fmt::Display for Level {
1624 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1625 self.to_str().fmt(f)
1630 fn color(self) -> ColorSpec {
1631 let mut spec = ColorSpec::new();
1633 Bug | DelayedBug | Fatal | Error { .. } => {
1634 spec.set_fg(Some(Color::Red)).set_intense(true);
1637 spec.set_fg(Some(Color::Yellow)).set_intense(cfg!(windows));
1639 Note | OnceNote => {
1640 spec.set_fg(Some(Color::Green)).set_intense(true);
1643 spec.set_fg(Some(Color::Cyan)).set_intense(true);
1646 Allow | Expect(_) => unreachable!(),
1651 pub fn to_str(self) -> &'static str {
1653 Bug | DelayedBug => "error: internal compiler error",
1654 Fatal | Error { .. } => "error",
1655 Warning(_) => "warning",
1656 Note | OnceNote => "note",
1658 FailureNote => "failure-note",
1659 Allow => panic!("Shouldn't call on allowed error"),
1660 Expect(_) => panic!("Shouldn't call on expected error"),
1664 pub fn is_failure_note(&self) -> bool {
1665 matches!(*self, FailureNote)
1668 pub fn get_expectation_id(&self) -> Option<LintExpectationId> {
1670 Level::Expect(id) | Level::Warning(Some(id)) => Some(*id),
1676 // FIXME(eddyb) this doesn't belong here AFAICT, should be moved to callsite.
1677 pub fn add_elided_lifetime_in_path_suggestion(
1678 source_map: &SourceMap,
1679 diag: &mut Diagnostic,
1682 incl_angl_brckt: bool,
1683 insertion_span: Span,
1685 diag.span_label(path_span, format!("expected lifetime parameter{}", pluralize!(n)));
1686 if !source_map.is_span_accessible(insertion_span) {
1687 // Do not try to suggest anything if generated by a proc-macro.
1690 let anon_lts = vec!["'_"; n].join(", ");
1692 if incl_angl_brckt { format!("<{}>", anon_lts) } else { format!("{}, ", anon_lts) };
1693 diag.span_suggestion_verbose(
1694 insertion_span.shrink_to_hi(),
1695 &format!("indicate the anonymous lifetime{}", pluralize!(n)),
1697 Applicability::MachineApplicable,
1701 /// Useful type to use with `Result<>` indicate that an error has already
1702 /// been reported to the user, so no need to continue checking.
1703 #[derive(Clone, Copy, Debug, Encodable, Decodable, Hash, PartialEq, Eq, PartialOrd, Ord)]
1704 #[derive(HashStable_Generic)]
1705 pub struct ErrorGuaranteed(());
1707 impl ErrorGuaranteed {
1708 /// To be used only if you really know what you are doing... ideally, we would find a way to
1709 /// eliminate all calls to this method.
1710 pub fn unchecked_claim_error_was_emitted() -> Self {