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;
63 pub use diagnostic_builder::IntoDiagnostic;
64 pub use snippet::Style;
66 pub type PErr<'a> = DiagnosticBuilder<'a, ErrorGuaranteed>;
67 pub type PResult<'a, T> = Result<T, PErr<'a>>;
69 // `PResult` is used a lot. Make sure it doesn't unintentionally get bigger.
70 // (See also the comment on `DiagnosticBuilderInner`'s `diagnostic` field.)
71 #[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))]
72 rustc_data_structures::static_assert_size!(PResult<'_, ()>, 16);
73 #[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))]
74 rustc_data_structures::static_assert_size!(PResult<'_, bool>, 16);
76 #[derive(Debug, PartialEq, Eq, Clone, Copy, Hash, Encodable, Decodable)]
77 pub enum SuggestionStyle {
78 /// Hide the suggested code when displaying this suggestion inline.
80 /// Always hide the suggested code but display the message.
82 /// Do not display this suggestion in the cli output, it is only meant for tools.
84 /// Always show the suggested code.
85 /// This will *not* show the code if the suggestion is inline *and* the suggested code is
88 /// Always show the suggested code independently.
92 impl SuggestionStyle {
93 fn hide_inline(&self) -> bool {
94 !matches!(*self, SuggestionStyle::ShowCode)
98 #[derive(Clone, Debug, PartialEq, Hash, Encodable, Decodable)]
99 pub struct CodeSuggestion {
100 /// Each substitute can have multiple variants due to multiple
101 /// applicable suggestions
103 /// `foo.bar` might be replaced with `a.b` or `x.y` by replacing
104 /// `foo` and `bar` on their own:
106 /// ```ignore (illustrative)
108 /// Substitution { parts: vec![(0..3, "a"), (4..7, "b")] },
109 /// Substitution { parts: vec![(0..3, "x"), (4..7, "y")] },
113 /// or by replacing the entire span:
115 /// ```ignore (illustrative)
117 /// Substitution { parts: vec![(0..7, "a.b")] },
118 /// Substitution { parts: vec![(0..7, "x.y")] },
121 pub substitutions: Vec<Substitution>,
122 pub msg: DiagnosticMessage,
123 /// Visual representation of this suggestion.
124 pub style: SuggestionStyle,
125 /// Whether or not the suggestion is approximate
127 /// Sometimes we may show suggestions with placeholders,
128 /// which are useful for users but not useful for
129 /// tools like rustfix
130 pub applicability: Applicability,
133 #[derive(Clone, Debug, PartialEq, Hash, Encodable, Decodable)]
134 /// See the docs on `CodeSuggestion::substitutions`
135 pub struct Substitution {
136 pub parts: Vec<SubstitutionPart>,
139 #[derive(Clone, Debug, PartialEq, Hash, Encodable, Decodable)]
140 pub struct SubstitutionPart {
145 /// Used to translate between `Span`s and byte positions within a single output line in highlighted
146 /// code of structured suggestions.
147 #[derive(Debug, Clone, Copy)]
148 pub struct SubstitutionHighlight {
153 impl SubstitutionPart {
154 pub fn is_addition(&self, sm: &SourceMap) -> bool {
155 !self.snippet.is_empty() && !self.replaces_meaningful_content(sm)
158 pub fn is_deletion(&self, sm: &SourceMap) -> bool {
159 self.snippet.trim().is_empty() && self.replaces_meaningful_content(sm)
162 pub fn is_replacement(&self, sm: &SourceMap) -> bool {
163 !self.snippet.is_empty() && self.replaces_meaningful_content(sm)
166 fn replaces_meaningful_content(&self, sm: &SourceMap) -> bool {
167 sm.span_to_snippet(self.span)
168 .map_or(!self.span.is_empty(), |snippet| !snippet.trim().is_empty())
172 impl CodeSuggestion {
173 /// Returns the assembled code suggestions, whether they should be shown with an underline
174 /// and whether the substitution only differs in capitalization.
178 ) -> Vec<(String, Vec<SubstitutionPart>, Vec<Vec<SubstitutionHighlight>>, bool)> {
179 // For the `Vec<Vec<SubstitutionHighlight>>` value, the first level of the vector
180 // corresponds to the output snippet's lines, while the second level corresponds to the
181 // substrings within that line that should be highlighted.
183 use rustc_span::{CharPos, Pos};
185 /// Append to a buffer the remainder of the line of existing source code, and return the
186 /// count of lines that have been added for accurate highlighting.
189 line_opt: Option<&Cow<'_, str>>,
191 hi_opt: Option<&Loc>,
193 let mut line_count = 0;
194 let (lo, hi_opt) = (lo.col.to_usize(), hi_opt.map(|hi| hi.col.to_usize()));
195 if let Some(line) = line_opt {
196 if let Some(lo) = line.char_indices().map(|(i, _)| i).nth(lo) {
197 let hi_opt = hi_opt.and_then(|hi| line.char_indices().map(|(i, _)| i).nth(hi));
199 Some(hi) if hi > lo => {
200 line_count = line[lo..hi].matches('\n').count();
201 buf.push_str(&line[lo..hi])
205 line_count = line[lo..].matches('\n').count();
206 buf.push_str(&line[lo..])
210 if hi_opt.is_none() {
217 assert!(!self.substitutions.is_empty());
222 // Suggestions coming from macros can have malformed spans. This is a heavy
223 // handed approach to avoid ICEs by ignoring the suggestion outright.
224 let invalid = subst.parts.iter().any(|item| sm.is_valid_span(item.span).is_err());
226 debug!("splice_lines: suggestion contains an invalid span: {:?}", subst);
231 .filter_map(|mut substitution| {
232 // Assumption: all spans are in the same file, and all spans
233 // are disjoint. Sort in ascending order.
234 substitution.parts.sort_by_key(|part| part.span.lo());
236 // Find the bounding span.
237 let lo = substitution.parts.iter().map(|part| part.span.lo()).min()?;
238 let hi = substitution.parts.iter().map(|part| part.span.hi()).max()?;
239 let bounding_span = Span::with_root_ctxt(lo, hi);
240 // The different spans might belong to different contexts, if so ignore suggestion.
241 let lines = sm.span_to_lines(bounding_span).ok()?;
242 assert!(!lines.lines.is_empty() || bounding_span.is_dummy());
244 // We can't splice anything if the source is unavailable.
245 if !sm.ensure_source_file_source_present(lines.file.clone()) {
249 let mut highlights = vec![];
250 // To build up the result, we do this for each span:
251 // - push the line segment trailing the previous span
252 // (at the beginning a "phantom" span pointing at the start of the line)
253 // - push lines between the previous and current span (if any)
254 // - if the previous and current span are not on the same line
255 // push the line segment leading up to the current span
256 // - splice in the span substitution
258 // Finally push the trailing line segment of the last span
259 let sf = &lines.file;
260 let mut prev_hi = sm.lookup_char_pos(bounding_span.lo());
261 prev_hi.col = CharPos::from_usize(0);
263 lines.lines.get(0).and_then(|line0| sf.get_line(line0.line_index));
264 let mut buf = String::new();
266 let mut line_highlight = vec![];
267 // We need to keep track of the difference between the existing code and the added
268 // or deleted code in order to point at the correct column *after* substitution.
270 for part in &substitution.parts {
271 let cur_lo = sm.lookup_char_pos(part.span.lo());
272 if prev_hi.line == cur_lo.line {
274 push_trailing(&mut buf, prev_line.as_ref(), &prev_hi, Some(&cur_lo));
276 highlights.push(std::mem::take(&mut line_highlight));
282 highlights.push(std::mem::take(&mut line_highlight));
283 let mut count = push_trailing(&mut buf, prev_line.as_ref(), &prev_hi, None);
285 highlights.push(std::mem::take(&mut line_highlight));
288 // push lines between the previous and current span (if any)
289 for idx in prev_hi.line..(cur_lo.line - 1) {
290 if let Some(line) = sf.get_line(idx) {
291 buf.push_str(line.as_ref());
293 highlights.push(std::mem::take(&mut line_highlight));
296 if let Some(cur_line) = sf.get_line(cur_lo.line - 1) {
297 let end = match cur_line.char_indices().nth(cur_lo.col.to_usize()) {
299 None => cur_line.len(),
301 buf.push_str(&cur_line[..end]);
304 // Add a whole line highlight per line in the snippet.
305 let len: isize = part
309 .unwrap_or(&part.snippet)
316 line_highlight.push(SubstitutionHighlight {
317 start: (cur_lo.col.0 as isize + acc) as usize,
318 end: (cur_lo.col.0 as isize + acc + len) as usize,
320 buf.push_str(&part.snippet);
321 let cur_hi = sm.lookup_char_pos(part.span.hi());
322 if prev_hi.line == cur_lo.line && cur_hi.line == cur_lo.line {
323 // Account for the difference between the width of the current code and the
324 // snippet being suggested, so that the *later* suggestions are correctly
325 // aligned on the screen.
326 acc += len as isize - (cur_hi.col.0 - cur_lo.col.0) as isize;
329 prev_line = sf.get_line(prev_hi.line - 1);
330 for line in part.snippet.split('\n').skip(1) {
332 highlights.push(std::mem::take(&mut line_highlight));
333 let end: usize = line
340 line_highlight.push(SubstitutionHighlight { start: 0, end });
343 highlights.push(std::mem::take(&mut line_highlight));
344 let only_capitalization = is_case_difference(sm, &buf, bounding_span);
345 // if the replacement already ends with a newline, don't print the next line
346 if !buf.ends_with('\n') {
347 push_trailing(&mut buf, prev_line.as_ref(), &prev_hi, None);
349 // remove trailing newlines
350 while buf.ends_with('\n') {
353 Some((buf, substitution.parts, highlights, only_capitalization))
359 pub use rustc_span::fatal_error::{FatalError, FatalErrorMarker};
361 /// Signifies that the compiler died with an explicit call to `.bug`
362 /// or `.span_bug` rather than a failed assertion, etc.
363 #[derive(Copy, Clone, Debug)]
364 pub struct ExplicitBug;
366 impl fmt::Display for ExplicitBug {
367 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
368 write!(f, "parser internal bug")
372 impl error::Error for ExplicitBug {}
374 pub use diagnostic::{
375 AddToDiagnostic, DecorateLint, Diagnostic, DiagnosticArg, DiagnosticArgValue, DiagnosticId,
376 DiagnosticStyledString, IntoDiagnosticArg, SubDiagnostic,
378 pub use diagnostic_builder::{DiagnosticBuilder, EmissionGuarantee, Noted};
379 pub use diagnostic_impls::DiagnosticArgFromDisplay;
380 use std::backtrace::Backtrace;
382 /// A handler deals with errors and other compiler output.
383 /// Certain errors (fatal, bug, unimpl) may cause immediate exit,
384 /// others log errors for later reporting.
387 inner: Lock<HandlerInner>,
390 /// This inner struct exists to keep it all behind a single lock;
391 /// this is done to prevent possible deadlocks in a multi-threaded compiler,
392 /// as well as inconsistent state observation.
393 struct HandlerInner {
395 /// The number of lint errors that have been emitted.
396 lint_err_count: usize,
397 /// The number of errors that have been emitted, including duplicates.
399 /// This is not necessarily the count that's reported to the user once
400 /// compilation ends.
403 deduplicated_err_count: usize,
404 emitter: Box<dyn Emitter + sync::Send>,
405 delayed_span_bugs: Vec<Diagnostic>,
406 delayed_good_path_bugs: Vec<DelayedDiagnostic>,
407 /// This flag indicates that an expected diagnostic was emitted and suppressed.
408 /// This is used for the `delayed_good_path_bugs` check.
409 suppressed_expected_diag: bool,
411 /// This set contains the `DiagnosticId` of all emitted diagnostics to avoid
412 /// emitting the same diagnostic with extended help (`--teach`) twice, which
413 /// would be unnecessary repetition.
414 taught_diagnostics: FxHashSet<DiagnosticId>,
416 /// Used to suggest rustc --explain `<error code>`
417 emitted_diagnostic_codes: FxIndexSet<DiagnosticId>,
419 /// This set contains a hash of every diagnostic that has been emitted by
420 /// this handler. These hashes is used to avoid emitting the same error
422 emitted_diagnostics: FxHashSet<u128>,
424 /// Stashed diagnostics emitted in one stage of the compiler that may be
425 /// stolen by other stages (e.g. to improve them and add more information).
426 /// The stashed diagnostics count towards the total error count.
427 /// When `.abort_if_errors()` is called, these are also emitted.
428 stashed_diagnostics: FxIndexMap<(Span, StashKey), Diagnostic>,
430 /// The warning count, used for a recap upon finishing
431 deduplicated_warn_count: usize,
433 future_breakage_diagnostics: Vec<Diagnostic>,
435 /// The [`Self::unstable_expect_diagnostics`] should be empty when this struct is
436 /// dropped. However, it can have values if the compilation is stopped early
437 /// or is only partially executed. To avoid ICEs, like in rust#94953 we only
438 /// check if [`Self::unstable_expect_diagnostics`] is empty, if the expectation ids
439 /// have been converted.
440 check_unstable_expect_diagnostics: bool,
442 /// Expected [`Diagnostic`][diagnostic::Diagnostic]s store a [`LintExpectationId`] as part of
443 /// the lint level. [`LintExpectationId`]s created early during the compilation
444 /// (before `HirId`s have been defined) are not stable and can therefore not be
445 /// stored on disk. This buffer stores these diagnostics until the ID has been
446 /// replaced by a stable [`LintExpectationId`]. The [`Diagnostic`][diagnostic::Diagnostic]s are the
447 /// submitted for storage and added to the list of fulfilled expectations.
448 unstable_expect_diagnostics: Vec<Diagnostic>,
450 /// expected diagnostic will have the level `Expect` which additionally
451 /// carries the [`LintExpectationId`] of the expectation that can be
452 /// marked as fulfilled. This is a collection of all [`LintExpectationId`]s
453 /// that have been marked as fulfilled this way.
455 /// [RFC-2383]: https://rust-lang.github.io/rfcs/2383-lint-reasons.html
456 fulfilled_expectations: FxHashSet<LintExpectationId>,
459 /// A key denoting where from a diagnostic was stashed.
460 #[derive(Copy, Clone, PartialEq, Eq, Hash)]
463 UnderscoreForArrayLengths,
468 fn default_track_diagnostic(_: &Diagnostic) {}
470 pub static TRACK_DIAGNOSTICS: AtomicRef<fn(&Diagnostic)> =
471 AtomicRef::new(&(default_track_diagnostic as fn(&_)));
473 #[derive(Copy, Clone, Default)]
474 pub struct HandlerFlags {
475 /// If false, warning-level lints are suppressed.
476 /// (rustc: see `--allow warnings` and `--cap-lints`)
477 pub can_emit_warnings: bool,
478 /// If true, error-level diagnostics are upgraded to bug-level.
479 /// (rustc: see `-Z treat-err-as-bug`)
480 pub treat_err_as_bug: Option<NonZeroUsize>,
481 /// If true, immediately emit diagnostics that would otherwise be buffered.
482 /// (rustc: see `-Z dont-buffer-diagnostics` and `-Z treat-err-as-bug`)
483 pub dont_buffer_diagnostics: bool,
484 /// If true, immediately print bugs registered with `delay_span_bug`.
485 /// (rustc: see `-Z report-delayed-bugs`)
486 pub report_delayed_bugs: bool,
487 /// Show macro backtraces.
488 /// (rustc: see `-Z macro-backtrace`)
489 pub macro_backtrace: bool,
490 /// If true, identical diagnostics are reported only once.
491 pub deduplicate_diagnostics: bool,
494 impl Drop for HandlerInner {
496 self.emit_stashed_diagnostics();
498 if !self.has_errors() {
499 let bugs = std::mem::replace(&mut self.delayed_span_bugs, Vec::new());
500 self.flush_delayed(bugs, "no errors encountered even though `delay_span_bug` issued");
503 // FIXME(eddyb) this explains what `delayed_good_path_bugs` are!
504 // They're `delayed_span_bugs` but for "require some diagnostic happened"
505 // instead of "require some error happened". Sadly that isn't ideal, as
506 // lints can be `#[allow]`'d, potentially leading to this triggering.
507 // Also, "good path" should be replaced with a better naming.
508 if !self.has_any_message() && !self.suppressed_expected_diag {
509 let bugs = std::mem::replace(&mut self.delayed_good_path_bugs, Vec::new());
511 bugs.into_iter().map(DelayedDiagnostic::decorate),
512 "no warnings or errors encountered even though `delayed_good_path_bugs` issued",
516 if self.check_unstable_expect_diagnostics {
518 self.unstable_expect_diagnostics.is_empty(),
519 "all diagnostics with unstable expectations should have been converted",
526 pub fn with_tty_emitter(
527 color_config: ColorConfig,
528 can_emit_warnings: bool,
529 treat_err_as_bug: Option<NonZeroUsize>,
530 sm: Option<Lrc<SourceMap>>,
531 fluent_bundle: Option<Lrc<FluentBundle>>,
532 fallback_bundle: LazyFallbackBundle,
534 Self::with_tty_emitter_and_flags(
539 HandlerFlags { can_emit_warnings, treat_err_as_bug, ..Default::default() },
543 pub fn with_tty_emitter_and_flags(
544 color_config: ColorConfig,
545 sm: Option<Lrc<SourceMap>>,
546 fluent_bundle: Option<Lrc<FluentBundle>>,
547 fallback_bundle: LazyFallbackBundle,
550 let emitter = Box::new(EmitterWriter::stderr(
558 flags.macro_backtrace,
560 Self::with_emitter_and_flags(emitter, flags)
564 can_emit_warnings: bool,
565 treat_err_as_bug: Option<NonZeroUsize>,
566 emitter: Box<dyn Emitter + sync::Send>,
568 Handler::with_emitter_and_flags(
570 HandlerFlags { can_emit_warnings, treat_err_as_bug, ..Default::default() },
574 pub fn with_emitter_and_flags(
575 emitter: Box<dyn Emitter + sync::Send>,
580 inner: Lock::new(HandlerInner {
585 deduplicated_err_count: 0,
586 deduplicated_warn_count: 0,
588 delayed_span_bugs: Vec::new(),
589 delayed_good_path_bugs: Vec::new(),
590 suppressed_expected_diag: false,
591 taught_diagnostics: Default::default(),
592 emitted_diagnostic_codes: Default::default(),
593 emitted_diagnostics: Default::default(),
594 stashed_diagnostics: Default::default(),
595 future_breakage_diagnostics: Vec::new(),
596 check_unstable_expect_diagnostics: false,
597 unstable_expect_diagnostics: Vec::new(),
598 fulfilled_expectations: Default::default(),
603 /// Translate `message` eagerly with `args`.
604 pub fn eagerly_translate<'a>(
606 message: DiagnosticMessage,
607 args: impl Iterator<Item = DiagnosticArg<'a, 'static>>,
608 ) -> SubdiagnosticMessage {
609 let inner = self.inner.borrow();
610 let args = crate::translation::to_fluent_args(args);
611 SubdiagnosticMessage::Eager(inner.emitter.translate_message(&message, &args).to_string())
614 // This is here to not allow mutation of flags;
615 // as of this writing it's only used in tests in librustc_middle.
616 pub fn can_emit_warnings(&self) -> bool {
617 self.flags.can_emit_warnings
620 /// Resets the diagnostic error count as well as the cached emitted diagnostics.
622 /// NOTE: *do not* call this function from rustc. It is only meant to be called from external
623 /// tools that want to reuse a `Parser` cleaning the previously emitted diagnostics as well as
624 /// the overall count of emitted error diagnostics.
625 pub fn reset_err_count(&self) {
626 let mut inner = self.inner.borrow_mut();
628 inner.warn_count = 0;
629 inner.deduplicated_err_count = 0;
630 inner.deduplicated_warn_count = 0;
632 // actually free the underlying memory (which `clear` would not do)
633 inner.delayed_span_bugs = Default::default();
634 inner.delayed_good_path_bugs = Default::default();
635 inner.taught_diagnostics = Default::default();
636 inner.emitted_diagnostic_codes = Default::default();
637 inner.emitted_diagnostics = Default::default();
638 inner.stashed_diagnostics = Default::default();
641 /// Stash a given diagnostic with the given `Span` and `StashKey` as the key for later stealing.
642 pub fn stash_diagnostic(&self, span: Span, key: StashKey, diag: Diagnostic) {
643 let mut inner = self.inner.borrow_mut();
644 inner.stash((span, key), diag);
647 /// Steal a previously stashed diagnostic with the given `Span` and `StashKey` as the key.
648 pub fn steal_diagnostic(&self, span: Span, key: StashKey) -> Option<DiagnosticBuilder<'_, ()>> {
649 let mut inner = self.inner.borrow_mut();
650 inner.steal((span, key)).map(|diag| DiagnosticBuilder::new_diagnostic(self, diag))
653 pub fn has_stashed_diagnostic(&self, span: Span, key: StashKey) -> bool {
654 self.inner.borrow().stashed_diagnostics.get(&(span, key)).is_some()
657 /// Emit all stashed diagnostics.
658 pub fn emit_stashed_diagnostics(&self) -> Option<ErrorGuaranteed> {
659 self.inner.borrow_mut().emit_stashed_diagnostics()
662 /// Construct a builder with the `msg` at the level appropriate for the specific `EmissionGuarantee`.
663 #[rustc_lint_diagnostics]
664 pub fn struct_diagnostic<G: EmissionGuarantee>(
666 msg: impl Into<DiagnosticMessage>,
667 ) -> DiagnosticBuilder<'_, G> {
668 G::make_diagnostic_builder(self, msg)
671 /// Construct a builder at the `Warning` level at the given `span` and with the `msg`.
673 /// Attempting to `.emit()` the builder will only emit if either:
674 /// * `can_emit_warnings` is `true`
675 /// * `is_force_warn` was set in `DiagnosticId::Lint`
676 #[rustc_lint_diagnostics]
677 pub fn struct_span_warn(
679 span: impl Into<MultiSpan>,
680 msg: impl Into<DiagnosticMessage>,
681 ) -> DiagnosticBuilder<'_, ()> {
682 let mut result = self.struct_warn(msg);
683 result.set_span(span);
687 /// Construct a builder at the `Warning` level at the given `span` and with the `msg`.
688 /// The `id` is used for lint emissions which should also fulfill a lint expectation.
690 /// Attempting to `.emit()` the builder will only emit if either:
691 /// * `can_emit_warnings` is `true`
692 /// * `is_force_warn` was set in `DiagnosticId::Lint`
693 pub fn struct_span_warn_with_expectation(
695 span: impl Into<MultiSpan>,
696 msg: impl Into<DiagnosticMessage>,
697 id: LintExpectationId,
698 ) -> DiagnosticBuilder<'_, ()> {
699 let mut result = self.struct_warn_with_expectation(msg, id);
700 result.set_span(span);
704 /// Construct a builder at the `Allow` level at the given `span` and with the `msg`.
705 #[rustc_lint_diagnostics]
706 pub fn struct_span_allow(
708 span: impl Into<MultiSpan>,
709 msg: impl Into<DiagnosticMessage>,
710 ) -> DiagnosticBuilder<'_, ()> {
711 let mut result = self.struct_allow(msg);
712 result.set_span(span);
716 /// Construct a builder at the `Warning` level at the given `span` and with the `msg`.
717 /// Also include a code.
718 #[rustc_lint_diagnostics]
719 pub fn struct_span_warn_with_code(
721 span: impl Into<MultiSpan>,
722 msg: impl Into<DiagnosticMessage>,
724 ) -> DiagnosticBuilder<'_, ()> {
725 let mut result = self.struct_span_warn(span, msg);
730 /// Construct a builder at the `Warning` level with the `msg`.
732 /// Attempting to `.emit()` the builder will only emit if either:
733 /// * `can_emit_warnings` is `true`
734 /// * `is_force_warn` was set in `DiagnosticId::Lint`
735 #[rustc_lint_diagnostics]
736 pub fn struct_warn(&self, msg: impl Into<DiagnosticMessage>) -> DiagnosticBuilder<'_, ()> {
737 DiagnosticBuilder::new(self, Level::Warning(None), msg)
740 /// Construct a builder at the `Warning` level with the `msg`. The `id` is used for
741 /// lint emissions which should also fulfill a lint expectation.
743 /// Attempting to `.emit()` the builder will only emit if either:
744 /// * `can_emit_warnings` is `true`
745 /// * `is_force_warn` was set in `DiagnosticId::Lint`
746 pub fn struct_warn_with_expectation(
748 msg: impl Into<DiagnosticMessage>,
749 id: LintExpectationId,
750 ) -> DiagnosticBuilder<'_, ()> {
751 DiagnosticBuilder::new(self, Level::Warning(Some(id)), msg)
754 /// Construct a builder at the `Allow` level with the `msg`.
755 #[rustc_lint_diagnostics]
756 pub fn struct_allow(&self, msg: impl Into<DiagnosticMessage>) -> DiagnosticBuilder<'_, ()> {
757 DiagnosticBuilder::new(self, Level::Allow, msg)
760 /// Construct a builder at the `Expect` level with the `msg`.
761 #[rustc_lint_diagnostics]
762 pub fn struct_expect(
764 msg: impl Into<DiagnosticMessage>,
765 id: LintExpectationId,
766 ) -> DiagnosticBuilder<'_, ()> {
767 DiagnosticBuilder::new(self, Level::Expect(id), msg)
770 /// Construct a builder at the `Error` level at the given `span` and with the `msg`.
771 #[rustc_lint_diagnostics]
772 pub fn struct_span_err(
774 span: impl Into<MultiSpan>,
775 msg: impl Into<DiagnosticMessage>,
776 ) -> DiagnosticBuilder<'_, ErrorGuaranteed> {
777 let mut result = self.struct_err(msg);
778 result.set_span(span);
782 /// Construct a builder at the `Error` level at the given `span`, with the `msg`, and `code`.
783 #[rustc_lint_diagnostics]
784 pub fn struct_span_err_with_code(
786 span: impl Into<MultiSpan>,
787 msg: impl Into<DiagnosticMessage>,
789 ) -> DiagnosticBuilder<'_, ErrorGuaranteed> {
790 let mut result = self.struct_span_err(span, msg);
795 /// Construct a builder at the `Error` level with the `msg`.
796 // FIXME: This method should be removed (every error should have an associated error code).
797 #[rustc_lint_diagnostics]
800 msg: impl Into<DiagnosticMessage>,
801 ) -> DiagnosticBuilder<'_, ErrorGuaranteed> {
802 DiagnosticBuilder::new_guaranteeing_error::<_, { Level::Error { lint: false } }>(self, msg)
805 /// This should only be used by `rustc_middle::lint::struct_lint_level`. Do not use it for hard errors.
807 pub fn struct_err_lint(&self, msg: impl Into<DiagnosticMessage>) -> DiagnosticBuilder<'_, ()> {
808 DiagnosticBuilder::new(self, Level::Error { lint: true }, msg)
811 /// Construct a builder at the `Error` level with the `msg` and the `code`.
812 #[rustc_lint_diagnostics]
813 pub fn struct_err_with_code(
815 msg: impl Into<DiagnosticMessage>,
817 ) -> DiagnosticBuilder<'_, ErrorGuaranteed> {
818 let mut result = self.struct_err(msg);
823 /// Construct a builder at the `Warn` level with the `msg` and the `code`.
824 #[rustc_lint_diagnostics]
825 pub fn struct_warn_with_code(
827 msg: impl Into<DiagnosticMessage>,
829 ) -> DiagnosticBuilder<'_, ()> {
830 let mut result = self.struct_warn(msg);
835 /// Construct a builder at the `Fatal` level at the given `span` and with the `msg`.
836 #[rustc_lint_diagnostics]
837 pub fn struct_span_fatal(
839 span: impl Into<MultiSpan>,
840 msg: impl Into<DiagnosticMessage>,
841 ) -> DiagnosticBuilder<'_, !> {
842 let mut result = self.struct_fatal(msg);
843 result.set_span(span);
847 /// Construct a builder at the `Fatal` level at the given `span`, with the `msg`, and `code`.
848 #[rustc_lint_diagnostics]
849 pub fn struct_span_fatal_with_code(
851 span: impl Into<MultiSpan>,
852 msg: impl Into<DiagnosticMessage>,
854 ) -> DiagnosticBuilder<'_, !> {
855 let mut result = self.struct_span_fatal(span, msg);
860 /// Construct a builder at the `Error` level with the `msg`.
861 #[rustc_lint_diagnostics]
862 pub fn struct_fatal(&self, msg: impl Into<DiagnosticMessage>) -> DiagnosticBuilder<'_, !> {
863 DiagnosticBuilder::new_fatal(self, msg)
866 /// Construct a builder at the `Help` level with the `msg`.
867 #[rustc_lint_diagnostics]
868 pub fn struct_help(&self, msg: impl Into<DiagnosticMessage>) -> DiagnosticBuilder<'_, ()> {
869 DiagnosticBuilder::new(self, Level::Help, msg)
872 /// Construct a builder at the `Note` level with the `msg`.
873 #[rustc_lint_diagnostics]
874 pub fn struct_note_without_error(
876 msg: impl Into<DiagnosticMessage>,
877 ) -> DiagnosticBuilder<'_, ()> {
878 DiagnosticBuilder::new(self, Level::Note, msg)
881 #[rustc_lint_diagnostics]
882 pub fn span_fatal(&self, span: impl Into<MultiSpan>, msg: impl Into<DiagnosticMessage>) -> ! {
883 self.emit_diag_at_span(Diagnostic::new(Fatal, msg), span);
887 #[rustc_lint_diagnostics]
888 pub fn span_fatal_with_code(
890 span: impl Into<MultiSpan>,
891 msg: impl Into<DiagnosticMessage>,
894 self.emit_diag_at_span(Diagnostic::new_with_code(Fatal, Some(code), msg), span);
898 #[rustc_lint_diagnostics]
901 span: impl Into<MultiSpan>,
902 msg: impl Into<DiagnosticMessage>,
903 ) -> ErrorGuaranteed {
904 self.emit_diag_at_span(Diagnostic::new(Error { lint: false }, msg), span).unwrap()
907 #[rustc_lint_diagnostics]
908 pub fn span_err_with_code(
910 span: impl Into<MultiSpan>,
911 msg: impl Into<DiagnosticMessage>,
914 self.emit_diag_at_span(
915 Diagnostic::new_with_code(Error { lint: false }, Some(code), msg),
920 #[rustc_lint_diagnostics]
921 pub fn span_warn(&self, span: impl Into<MultiSpan>, msg: impl Into<DiagnosticMessage>) {
922 self.emit_diag_at_span(Diagnostic::new(Warning(None), msg), span);
925 #[rustc_lint_diagnostics]
926 pub fn span_warn_with_code(
928 span: impl Into<MultiSpan>,
929 msg: impl Into<DiagnosticMessage>,
932 self.emit_diag_at_span(Diagnostic::new_with_code(Warning(None), Some(code), msg), span);
935 pub fn span_bug(&self, span: impl Into<MultiSpan>, msg: impl Into<DiagnosticMessage>) -> ! {
936 self.inner.borrow_mut().span_bug(span, msg)
940 pub fn delay_span_bug(
942 span: impl Into<MultiSpan>,
943 msg: impl Into<DiagnosticMessage>,
944 ) -> ErrorGuaranteed {
945 self.inner.borrow_mut().delay_span_bug(span, msg)
948 // FIXME(eddyb) note the comment inside `impl Drop for HandlerInner`, that's
949 // where the explanation of what "good path" is (also, it should be renamed).
950 pub fn delay_good_path_bug(&self, msg: impl Into<DiagnosticMessage>) {
951 self.inner.borrow_mut().delay_good_path_bug(msg)
954 pub fn span_bug_no_panic(&self, span: impl Into<MultiSpan>, msg: impl Into<DiagnosticMessage>) {
955 self.emit_diag_at_span(Diagnostic::new(Bug, msg), span);
958 pub fn span_note_without_error(
960 span: impl Into<MultiSpan>,
961 msg: impl Into<DiagnosticMessage>,
963 self.emit_diag_at_span(Diagnostic::new(Note, msg), span);
966 pub fn span_note_diag(
969 msg: impl Into<DiagnosticMessage>,
970 ) -> DiagnosticBuilder<'_, ()> {
971 let mut db = DiagnosticBuilder::new(self, Note, msg);
976 // NOTE: intentionally doesn't raise an error so rustc_codegen_ssa only reports fatal errors in the main thread
977 pub fn fatal(&self, msg: impl Into<DiagnosticMessage>) -> FatalError {
978 self.inner.borrow_mut().fatal(msg)
981 pub fn err(&self, msg: impl Into<DiagnosticMessage>) -> ErrorGuaranteed {
982 self.inner.borrow_mut().err(msg)
985 pub fn warn(&self, msg: impl Into<DiagnosticMessage>) {
986 let mut db = DiagnosticBuilder::new(self, Warning(None), msg);
990 pub fn note_without_error(&self, msg: impl Into<DiagnosticMessage>) {
991 DiagnosticBuilder::new(self, Note, msg).emit();
994 pub fn bug(&self, msg: impl Into<DiagnosticMessage>) -> ! {
995 self.inner.borrow_mut().bug(msg)
999 pub fn err_count(&self) -> usize {
1000 self.inner.borrow().err_count()
1003 pub fn has_errors(&self) -> Option<ErrorGuaranteed> {
1004 if self.inner.borrow().has_errors() { Some(ErrorGuaranteed(())) } else { None }
1006 pub fn has_errors_or_lint_errors(&self) -> Option<ErrorGuaranteed> {
1007 if self.inner.borrow().has_errors_or_lint_errors() {
1008 Some(ErrorGuaranteed(()))
1013 pub fn has_errors_or_delayed_span_bugs(&self) -> bool {
1014 self.inner.borrow().has_errors_or_delayed_span_bugs()
1017 pub fn print_error_count(&self, registry: &Registry) {
1018 self.inner.borrow_mut().print_error_count(registry)
1021 pub fn take_future_breakage_diagnostics(&self) -> Vec<Diagnostic> {
1022 std::mem::take(&mut self.inner.borrow_mut().future_breakage_diagnostics)
1025 pub fn abort_if_errors(&self) {
1026 self.inner.borrow_mut().abort_if_errors()
1029 /// `true` if we haven't taught a diagnostic with this code already.
1030 /// The caller must then teach the user about such a diagnostic.
1032 /// Used to suppress emitting the same error multiple times with extended explanation when
1033 /// calling `-Zteach`.
1034 pub fn must_teach(&self, code: &DiagnosticId) -> bool {
1035 self.inner.borrow_mut().must_teach(code)
1038 pub fn force_print_diagnostic(&self, db: Diagnostic) {
1039 self.inner.borrow_mut().force_print_diagnostic(db)
1042 pub fn emit_diagnostic(&self, diagnostic: &mut Diagnostic) -> Option<ErrorGuaranteed> {
1043 self.inner.borrow_mut().emit_diagnostic(diagnostic)
1046 pub fn emit_err<'a>(&'a self, err: impl IntoDiagnostic<'a>) -> ErrorGuaranteed {
1047 self.create_err(err).emit()
1050 pub fn create_err<'a>(
1052 err: impl IntoDiagnostic<'a>,
1053 ) -> DiagnosticBuilder<'a, ErrorGuaranteed> {
1054 err.into_diagnostic(self)
1057 pub fn create_warning<'a>(
1059 warning: impl IntoDiagnostic<'a, ()>,
1060 ) -> DiagnosticBuilder<'a, ()> {
1061 warning.into_diagnostic(self)
1064 pub fn emit_warning<'a>(&'a self, warning: impl IntoDiagnostic<'a, ()>) {
1065 self.create_warning(warning).emit()
1068 pub fn create_fatal<'a>(
1070 fatal: impl IntoDiagnostic<'a, !>,
1071 ) -> DiagnosticBuilder<'a, !> {
1072 fatal.into_diagnostic(self)
1075 pub fn emit_fatal<'a>(&'a self, fatal: impl IntoDiagnostic<'a, !>) -> ! {
1076 self.create_fatal(fatal).emit()
1079 fn emit_diag_at_span(
1081 mut diag: Diagnostic,
1082 sp: impl Into<MultiSpan>,
1083 ) -> Option<ErrorGuaranteed> {
1084 let mut inner = self.inner.borrow_mut();
1085 inner.emit_diagnostic(diag.set_span(sp))
1088 pub fn emit_artifact_notification(&self, path: &Path, artifact_type: &str) {
1089 self.inner.borrow_mut().emit_artifact_notification(path, artifact_type)
1092 pub fn emit_future_breakage_report(&self, diags: Vec<Diagnostic>) {
1093 self.inner.borrow_mut().emitter.emit_future_breakage_report(diags)
1096 pub fn emit_unused_externs(
1098 lint_level: rustc_lint_defs::Level,
1100 unused_externs: &[&str],
1102 let mut inner = self.inner.borrow_mut();
1104 if loud && lint_level.is_error() {
1105 inner.bump_err_count();
1108 inner.emit_unused_externs(lint_level, unused_externs)
1111 pub fn update_unstable_expectation_id(
1113 unstable_to_stable: &FxHashMap<LintExpectationId, LintExpectationId>,
1115 let mut inner = self.inner.borrow_mut();
1116 let diags = std::mem::take(&mut inner.unstable_expect_diagnostics);
1117 inner.check_unstable_expect_diagnostics = true;
1119 if !diags.is_empty() {
1120 inner.suppressed_expected_diag = true;
1121 for mut diag in diags.into_iter() {
1122 diag.update_unstable_expectation_id(unstable_to_stable);
1124 // Here the diagnostic is given back to `emit_diagnostic` where it was first
1125 // intercepted. Now it should be processed as usual, since the unstable expectation
1126 // id is now stable.
1127 inner.emit_diagnostic(&mut diag);
1132 .stashed_diagnostics
1134 .for_each(|diag| diag.update_unstable_expectation_id(unstable_to_stable));
1136 .future_breakage_diagnostics
1138 .for_each(|diag| diag.update_unstable_expectation_id(unstable_to_stable));
1141 /// This methods steals all [`LintExpectationId`]s that are stored inside
1142 /// [`HandlerInner`] and indicate that the linked expectation has been fulfilled.
1144 pub fn steal_fulfilled_expectation_ids(&self) -> FxHashSet<LintExpectationId> {
1146 self.inner.borrow().unstable_expect_diagnostics.is_empty(),
1147 "`HandlerInner::unstable_expect_diagnostics` should be empty at this point",
1149 std::mem::take(&mut self.inner.borrow_mut().fulfilled_expectations)
1152 pub fn flush_delayed(&self) {
1153 let mut inner = self.inner.lock();
1154 let bugs = std::mem::replace(&mut inner.delayed_span_bugs, Vec::new());
1155 inner.flush_delayed(bugs, "no errors encountered even though `delay_span_bug` issued");
1160 fn must_teach(&mut self, code: &DiagnosticId) -> bool {
1161 self.taught_diagnostics.insert(code.clone())
1164 fn force_print_diagnostic(&mut self, mut db: Diagnostic) {
1165 self.emitter.emit_diagnostic(&mut db);
1168 /// Emit all stashed diagnostics.
1169 fn emit_stashed_diagnostics(&mut self) -> Option<ErrorGuaranteed> {
1170 let has_errors = self.has_errors();
1171 let diags = self.stashed_diagnostics.drain(..).map(|x| x.1).collect::<Vec<_>>();
1172 let mut reported = None;
1173 for mut diag in diags {
1174 // Decrement the count tracking the stash; emitting will increment it.
1175 if diag.is_error() {
1176 if matches!(diag.level, Level::Error { lint: true }) {
1177 self.lint_err_count -= 1;
1179 self.err_count -= 1;
1182 if diag.is_force_warn() {
1183 self.warn_count -= 1;
1185 // Unless they're forced, don't flush stashed warnings when
1186 // there are errors, to avoid causing warning overload. The
1187 // stash would've been stolen already if it were important.
1193 let reported_this = self.emit_diagnostic(&mut diag);
1194 reported = reported.or(reported_this);
1199 // FIXME(eddyb) this should ideally take `diagnostic` by value.
1200 fn emit_diagnostic(&mut self, diagnostic: &mut Diagnostic) -> Option<ErrorGuaranteed> {
1201 // The `LintExpectationId` can be stable or unstable depending on when it was created.
1202 // Diagnostics created before the definition of `HirId`s are unstable and can not yet
1203 // be stored. Instead, they are buffered until the `LintExpectationId` is replaced by
1204 // a stable one by the `LintLevelsBuilder`.
1205 if let Some(LintExpectationId::Unstable { .. }) = diagnostic.level.get_expectation_id() {
1206 self.unstable_expect_diagnostics.push(diagnostic.clone());
1210 if diagnostic.level == Level::DelayedBug {
1211 // FIXME(eddyb) this should check for `has_errors` and stop pushing
1212 // once *any* errors were emitted (and truncate `delayed_span_bugs`
1213 // when an error is first emitted, also), but maybe there's a case
1214 // in which that's not sound? otherwise this is really inefficient.
1215 self.delayed_span_bugs.push(diagnostic.clone());
1217 if !self.flags.report_delayed_bugs {
1218 return Some(ErrorGuaranteed::unchecked_claim_error_was_emitted());
1222 if diagnostic.has_future_breakage() {
1223 self.future_breakage_diagnostics.push(diagnostic.clone());
1226 if let Some(expectation_id) = diagnostic.level.get_expectation_id() {
1227 self.suppressed_expected_diag = true;
1228 self.fulfilled_expectations.insert(expectation_id.normalize());
1231 if matches!(diagnostic.level, Warning(_))
1232 && !self.flags.can_emit_warnings
1233 && !diagnostic.is_force_warn()
1235 if diagnostic.has_future_breakage() {
1236 (*TRACK_DIAGNOSTICS)(diagnostic);
1241 (*TRACK_DIAGNOSTICS)(diagnostic);
1243 if matches!(diagnostic.level, Level::Expect(_) | Level::Allow) {
1247 if let Some(ref code) = diagnostic.code {
1248 self.emitted_diagnostic_codes.insert(code.clone());
1251 let already_emitted = |this: &mut Self| {
1252 let mut hasher = StableHasher::new();
1253 diagnostic.hash(&mut hasher);
1254 let diagnostic_hash = hasher.finish();
1255 !this.emitted_diagnostics.insert(diagnostic_hash)
1258 // Only emit the diagnostic if we've been asked to deduplicate or
1259 // haven't already emitted an equivalent diagnostic.
1260 if !(self.flags.deduplicate_diagnostics && already_emitted(self)) {
1261 debug!(?diagnostic);
1262 debug!(?self.emitted_diagnostics);
1263 let already_emitted_sub = |sub: &mut SubDiagnostic| {
1265 if sub.level != Level::OnceNote {
1268 let mut hasher = StableHasher::new();
1269 sub.hash(&mut hasher);
1270 let diagnostic_hash = hasher.finish();
1271 debug!(?diagnostic_hash);
1272 !self.emitted_diagnostics.insert(diagnostic_hash)
1275 diagnostic.children.drain_filter(already_emitted_sub).for_each(|_| {});
1277 self.emitter.emit_diagnostic(&diagnostic);
1278 if diagnostic.is_error() {
1279 self.deduplicated_err_count += 1;
1280 } else if let Warning(_) = diagnostic.level {
1281 self.deduplicated_warn_count += 1;
1284 if diagnostic.is_error() {
1285 if matches!(diagnostic.level, Level::Error { lint: true }) {
1286 self.bump_lint_err_count();
1288 self.bump_err_count();
1291 Some(ErrorGuaranteed::unchecked_claim_error_was_emitted())
1293 self.bump_warn_count();
1299 fn emit_artifact_notification(&mut self, path: &Path, artifact_type: &str) {
1300 self.emitter.emit_artifact_notification(path, artifact_type);
1303 fn emit_unused_externs(&mut self, lint_level: rustc_lint_defs::Level, unused_externs: &[&str]) {
1304 self.emitter.emit_unused_externs(lint_level, unused_externs);
1307 fn treat_err_as_bug(&self) -> bool {
1308 self.flags.treat_err_as_bug.map_or(false, |c| {
1309 self.err_count() + self.lint_err_count + self.delayed_bug_count() >= c.get()
1313 fn delayed_bug_count(&self) -> usize {
1314 self.delayed_span_bugs.len() + self.delayed_good_path_bugs.len()
1317 fn print_error_count(&mut self, registry: &Registry) {
1318 self.emit_stashed_diagnostics();
1320 let warnings = match self.deduplicated_warn_count {
1322 1 => "1 warning emitted".to_string(),
1323 count => format!("{count} warnings emitted"),
1325 let errors = match self.deduplicated_err_count {
1327 1 => "aborting due to previous error".to_string(),
1328 count => format!("aborting due to {count} previous errors"),
1330 if self.treat_err_as_bug() {
1334 match (errors.len(), warnings.len()) {
1336 (0, _) => self.emitter.emit_diagnostic(&Diagnostic::new(
1337 Level::Warning(None),
1338 DiagnosticMessage::Str(warnings),
1341 let _ = self.fatal(&errors);
1344 let _ = self.fatal(&format!("{}; {}", &errors, &warnings));
1348 let can_show_explain = self.emitter.should_show_explain();
1349 let are_there_diagnostics = !self.emitted_diagnostic_codes.is_empty();
1350 if can_show_explain && are_there_diagnostics {
1351 let mut error_codes = self
1352 .emitted_diagnostic_codes
1354 .filter_map(|x| match &x {
1355 DiagnosticId::Error(s)
1356 if registry.try_find_description(s).map_or(false, |o| o.is_some()) =>
1362 .collect::<Vec<_>>();
1363 if !error_codes.is_empty() {
1365 if error_codes.len() > 1 {
1366 let limit = if error_codes.len() > 9 { 9 } else { error_codes.len() };
1367 self.failure(&format!(
1368 "Some errors have detailed explanations: {}{}",
1369 error_codes[..limit].join(", "),
1370 if error_codes.len() > 9 { "..." } else { "." }
1372 self.failure(&format!(
1373 "For more information about an error, try \
1374 `rustc --explain {}`.",
1378 self.failure(&format!(
1379 "For more information about this error, try \
1380 `rustc --explain {}`.",
1388 fn stash(&mut self, key: (Span, StashKey), diagnostic: Diagnostic) {
1389 // Track the diagnostic for counts, but don't panic-if-treat-err-as-bug
1390 // yet; that happens when we actually emit the diagnostic.
1391 if diagnostic.is_error() {
1392 if matches!(diagnostic.level, Level::Error { lint: true }) {
1393 self.lint_err_count += 1;
1395 self.err_count += 1;
1398 // Warnings are only automatically flushed if they're forced.
1399 if diagnostic.is_force_warn() {
1400 self.warn_count += 1;
1404 // FIXME(Centril, #69537): Consider reintroducing panic on overwriting a stashed diagnostic
1405 // if/when we have a more robust macro-friendly replacement for `(span, key)` as a key.
1406 // See the PR for a discussion.
1407 self.stashed_diagnostics.insert(key, diagnostic);
1410 fn steal(&mut self, key: (Span, StashKey)) -> Option<Diagnostic> {
1411 let diagnostic = self.stashed_diagnostics.remove(&key)?;
1412 if diagnostic.is_error() {
1413 if matches!(diagnostic.level, Level::Error { lint: true }) {
1414 self.lint_err_count -= 1;
1416 self.err_count -= 1;
1419 if diagnostic.is_force_warn() {
1420 self.warn_count -= 1;
1427 fn err_count(&self) -> usize {
1431 fn has_errors(&self) -> bool {
1432 self.err_count() > 0
1434 fn has_errors_or_lint_errors(&self) -> bool {
1435 self.has_errors() || self.lint_err_count > 0
1437 fn has_errors_or_delayed_span_bugs(&self) -> bool {
1438 self.has_errors() || !self.delayed_span_bugs.is_empty()
1440 fn has_any_message(&self) -> bool {
1441 self.err_count() > 0 || self.lint_err_count > 0 || self.warn_count > 0
1444 fn abort_if_errors(&mut self) {
1445 self.emit_stashed_diagnostics();
1447 if self.has_errors() {
1452 fn span_bug(&mut self, sp: impl Into<MultiSpan>, msg: impl Into<DiagnosticMessage>) -> ! {
1453 self.emit_diag_at_span(Diagnostic::new(Bug, msg), sp);
1454 panic::panic_any(ExplicitBug);
1457 fn emit_diag_at_span(&mut self, mut diag: Diagnostic, sp: impl Into<MultiSpan>) {
1458 self.emit_diagnostic(diag.set_span(sp));
1464 sp: impl Into<MultiSpan>,
1465 msg: impl Into<DiagnosticMessage>,
1466 ) -> ErrorGuaranteed {
1467 // This is technically `self.treat_err_as_bug()` but `delay_span_bug` is called before
1468 // incrementing `err_count` by one, so we need to +1 the comparing.
1469 // FIXME: Would be nice to increment err_count in a more coherent way.
1470 if self.flags.treat_err_as_bug.map_or(false, |c| {
1471 self.err_count() + self.lint_err_count + self.delayed_bug_count() + 1 >= c.get()
1473 // FIXME: don't abort here if report_delayed_bugs is off
1474 self.span_bug(sp, msg);
1476 let mut diagnostic = Diagnostic::new(Level::DelayedBug, msg);
1477 diagnostic.set_span(sp.into());
1478 diagnostic.note(&format!("delayed at {}", std::panic::Location::caller()));
1479 self.emit_diagnostic(&mut diagnostic).unwrap()
1482 // FIXME(eddyb) note the comment inside `impl Drop for HandlerInner`, that's
1483 // where the explanation of what "good path" is (also, it should be renamed).
1484 fn delay_good_path_bug(&mut self, msg: impl Into<DiagnosticMessage>) {
1485 let mut diagnostic = Diagnostic::new(Level::DelayedBug, msg);
1486 if self.flags.report_delayed_bugs {
1487 self.emit_diagnostic(&mut diagnostic);
1489 let backtrace = std::backtrace::Backtrace::force_capture();
1490 self.delayed_good_path_bugs.push(DelayedDiagnostic::with_backtrace(diagnostic, backtrace));
1493 fn failure(&mut self, msg: impl Into<DiagnosticMessage>) {
1494 self.emit_diagnostic(&mut Diagnostic::new(FailureNote, msg));
1497 fn fatal(&mut self, msg: impl Into<DiagnosticMessage>) -> FatalError {
1498 self.emit(Fatal, msg);
1502 fn err(&mut self, msg: impl Into<DiagnosticMessage>) -> ErrorGuaranteed {
1503 self.emit(Error { lint: false }, msg)
1506 /// Emit an error; level should be `Error` or `Fatal`.
1507 fn emit(&mut self, level: Level, msg: impl Into<DiagnosticMessage>) -> ErrorGuaranteed {
1508 if self.treat_err_as_bug() {
1511 self.emit_diagnostic(&mut Diagnostic::new(level, msg)).unwrap()
1514 fn bug(&mut self, msg: impl Into<DiagnosticMessage>) -> ! {
1515 self.emit_diagnostic(&mut Diagnostic::new(Bug, msg));
1516 panic::panic_any(ExplicitBug);
1521 bugs: impl IntoIterator<Item = Diagnostic>,
1522 explanation: impl Into<DiagnosticMessage> + Copy,
1524 let mut no_bugs = true;
1525 for mut bug in bugs {
1527 // Put the overall explanation before the `DelayedBug`s, to
1528 // frame them better (e.g. separate warnings from them).
1529 self.emit_diagnostic(&mut Diagnostic::new(Bug, explanation));
1533 // "Undelay" the `DelayedBug`s (into plain `Bug`s).
1534 if bug.level != Level::DelayedBug {
1535 // NOTE(eddyb) not panicking here because we're already producing
1536 // an ICE, and the more information the merrier.
1538 "`flushed_delayed` got diagnostic with level {:?}, \
1539 instead of the expected `DelayedBug`",
1543 bug.level = Level::Bug;
1545 self.emit_diagnostic(&mut bug);
1548 // Panic with `ExplicitBug` to avoid "unexpected panic" messages.
1550 panic::panic_any(ExplicitBug);
1554 fn bump_lint_err_count(&mut self) {
1555 self.lint_err_count += 1;
1556 self.panic_if_treat_err_as_bug();
1559 fn bump_err_count(&mut self) {
1560 self.err_count += 1;
1561 self.panic_if_treat_err_as_bug();
1564 fn bump_warn_count(&mut self) {
1565 self.warn_count += 1;
1568 fn panic_if_treat_err_as_bug(&self) {
1569 if self.treat_err_as_bug() {
1571 self.err_count() + self.lint_err_count,
1572 self.delayed_bug_count(),
1573 self.flags.treat_err_as_bug.map(|c| c.get()).unwrap_or(0),
1575 (1, 0, 1) => panic!("aborting due to `-Z treat-err-as-bug=1`"),
1576 (0, 1, 1) => panic!("aborting due delayed bug with `-Z treat-err-as-bug=1`"),
1577 (count, delayed_count, as_bug) => {
1578 if delayed_count > 0 {
1580 "aborting after {} errors and {} delayed bugs due to `-Z treat-err-as-bug={}`",
1581 count, delayed_count, as_bug,
1585 "aborting after {} errors due to `-Z treat-err-as-bug={}`",
1595 struct DelayedDiagnostic {
1600 impl DelayedDiagnostic {
1601 fn with_backtrace(diagnostic: Diagnostic, backtrace: Backtrace) -> Self {
1602 DelayedDiagnostic { inner: diagnostic, note: backtrace }
1605 fn decorate(mut self) -> Diagnostic {
1606 self.inner.note(&format!("delayed at {}", self.note));
1611 #[derive(Copy, PartialEq, Eq, Clone, Hash, Debug, Encodable, Decodable)]
1617 /// If this error comes from a lint, don't abort compilation even when abort_if_errors() is called.
1620 /// This [`LintExpectationId`] is used for expected lint diagnostics, which should
1621 /// also emit a warning due to the `force-warn` flag. In all other cases this should
1623 Warning(Option<LintExpectationId>),
1625 /// A note that is only emitted once.
1630 Expect(LintExpectationId),
1633 impl fmt::Display for Level {
1634 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1635 self.to_str().fmt(f)
1640 fn color(self) -> ColorSpec {
1641 let mut spec = ColorSpec::new();
1643 Bug | DelayedBug | Fatal | Error { .. } => {
1644 spec.set_fg(Some(Color::Red)).set_intense(true);
1647 spec.set_fg(Some(Color::Yellow)).set_intense(cfg!(windows));
1649 Note | OnceNote => {
1650 spec.set_fg(Some(Color::Green)).set_intense(true);
1653 spec.set_fg(Some(Color::Cyan)).set_intense(true);
1656 Allow | Expect(_) => unreachable!(),
1661 pub fn to_str(self) -> &'static str {
1663 Bug | DelayedBug => "error: internal compiler error",
1664 Fatal | Error { .. } => "error",
1665 Warning(_) => "warning",
1666 Note | OnceNote => "note",
1668 FailureNote => "failure-note",
1669 Allow => panic!("Shouldn't call on allowed error"),
1670 Expect(_) => panic!("Shouldn't call on expected error"),
1674 pub fn is_failure_note(&self) -> bool {
1675 matches!(*self, FailureNote)
1678 pub fn get_expectation_id(&self) -> Option<LintExpectationId> {
1680 Level::Expect(id) | Level::Warning(Some(id)) => Some(*id),
1686 // FIXME(eddyb) this doesn't belong here AFAICT, should be moved to callsite.
1687 pub fn add_elided_lifetime_in_path_suggestion(
1688 source_map: &SourceMap,
1689 diag: &mut Diagnostic,
1692 incl_angl_brckt: bool,
1693 insertion_span: Span,
1695 diag.span_label(path_span, format!("expected lifetime parameter{}", pluralize!(n)));
1696 if !source_map.is_span_accessible(insertion_span) {
1697 // Do not try to suggest anything if generated by a proc-macro.
1700 let anon_lts = vec!["'_"; n].join(", ");
1702 if incl_angl_brckt { format!("<{}>", anon_lts) } else { format!("{}, ", anon_lts) };
1703 diag.span_suggestion_verbose(
1704 insertion_span.shrink_to_hi(),
1705 &format!("indicate the anonymous lifetime{}", pluralize!(n)),
1707 Applicability::MachineApplicable,
1711 /// Useful type to use with `Result<>` indicate that an error has already
1712 /// been reported to the user, so no need to continue checking.
1713 #[derive(Clone, Copy, Debug, Encodable, Decodable, Hash, PartialEq, Eq, PartialOrd, Ord)]
1714 #[derive(HashStable_Generic)]
1715 pub struct ErrorGuaranteed(());
1717 impl ErrorGuaranteed {
1718 /// To be used only if you really know what you are doing... ideally, we would find a way to
1719 /// eliminate all calls to this method.
1720 pub fn unchecked_claim_error_was_emitted() -> Self {