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 #![cfg_attr(bootstrap, feature(let_else))]
11 #![feature(never_type)]
12 #![feature(result_option_inspect)]
13 #![feature(rustc_attrs)]
14 #![allow(incomplete_features)]
17 extern crate rustc_macros
;
22 pub use emitter
::ColorConfig
;
24 use rustc_lint_defs
::LintExpectationId
;
27 use emitter
::{is_case_difference, Emitter, EmitterWriter}
;
28 use registry
::Registry
;
29 use rustc_data_structures
::fx
::{FxHashMap, FxHashSet, FxIndexMap, FxIndexSet}
;
30 use rustc_data_structures
::stable_hasher
::StableHasher
;
31 use rustc_data_structures
::sync
::{self, Lock, Lrc}
;
32 use rustc_data_structures
::AtomicRef
;
33 pub use rustc_error_messages
::{
34 fallback_fluent_bundle
, fluent
, fluent_bundle
, DiagnosticMessage
, FluentBundle
,
35 LanguageIdentifier
, LazyFallbackBundle
, MultiSpan
, SpanLabel
, SubdiagnosticMessage
,
36 DEFAULT_LOCALE_RESOURCES
,
38 pub use rustc_lint_defs
::{pluralize, Applicability}
;
39 use rustc_span
::source_map
::SourceMap
;
40 use rustc_span
::HashStableContext
;
41 use rustc_span
::{Loc, Span}
;
45 use std
::num
::NonZeroUsize
;
48 use std
::{error, fmt}
;
50 use termcolor
::{Color, ColorSpec}
;
52 pub mod annotate_snippet_emitter_writer
;
54 mod diagnostic_builder
;
63 pub use snippet
::Style
;
65 pub type PResult
<'a
, T
> = Result
<T
, DiagnosticBuilder
<'a
, ErrorGuaranteed
>>;
67 // `PResult` is used a lot. Make sure it doesn't unintentionally get bigger.
68 // (See also the comment on `DiagnosticBuilder`'s `diagnostic` field.)
69 #[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))]
70 rustc_data_structures
::static_assert_size
!(PResult
<'_
, ()>, 16);
71 #[cfg(all(target_arch = "x86_64", target_pointer_width = "64", not(bootstrap)))]
72 rustc_data_structures
::static_assert_size
!(PResult
<'_
, bool
>, 16);
74 #[derive(Debug, PartialEq, Eq, Clone, Copy, Hash, Encodable, Decodable)]
75 pub enum SuggestionStyle
{
76 /// Hide the suggested code when displaying this suggestion inline.
78 /// Always hide the suggested code but display the message.
80 /// Do not display this suggestion in the cli output, it is only meant for tools.
82 /// Always show the suggested code.
83 /// This will *not* show the code if the suggestion is inline *and* the suggested code is
86 /// Always show the suggested code independently.
90 impl SuggestionStyle
{
91 fn hide_inline(&self) -> bool
{
92 !matches
!(*self, SuggestionStyle
::ShowCode
)
96 #[derive(Clone, Debug, PartialEq, Hash, Encodable, Decodable)]
97 pub struct CodeSuggestion
{
98 /// Each substitute can have multiple variants due to multiple
99 /// applicable suggestions
101 /// `foo.bar` might be replaced with `a.b` or `x.y` by replacing
102 /// `foo` and `bar` on their own:
104 /// ```ignore (illustrative)
106 /// Substitution { parts: vec![(0..3, "a"), (4..7, "b")] },
107 /// Substitution { parts: vec![(0..3, "x"), (4..7, "y")] },
111 /// or by replacing the entire span:
113 /// ```ignore (illustrative)
115 /// Substitution { parts: vec![(0..7, "a.b")] },
116 /// Substitution { parts: vec![(0..7, "x.y")] },
119 pub substitutions
: Vec
<Substitution
>,
120 pub msg
: DiagnosticMessage
,
121 /// Visual representation of this suggestion.
122 pub style
: SuggestionStyle
,
123 /// Whether or not the suggestion is approximate
125 /// Sometimes we may show suggestions with placeholders,
126 /// which are useful for users but not useful for
127 /// tools like rustfix
128 pub applicability
: Applicability
,
131 #[derive(Clone, Debug, PartialEq, Hash, Encodable, Decodable)]
132 /// See the docs on `CodeSuggestion::substitutions`
133 pub struct Substitution
{
134 pub parts
: Vec
<SubstitutionPart
>,
137 #[derive(Clone, Debug, PartialEq, Hash, Encodable, Decodable)]
138 pub struct SubstitutionPart
{
143 /// Used to translate between `Span`s and byte positions within a single output line in highlighted
144 /// code of structured suggestions.
145 #[derive(Debug, Clone, Copy)]
146 pub struct SubstitutionHighlight
{
151 impl SubstitutionPart
{
152 pub fn is_addition(&self, sm
: &SourceMap
) -> bool
{
153 !self.snippet
.is_empty() && !self.replaces_meaningful_content(sm
)
156 pub fn is_deletion(&self, sm
: &SourceMap
) -> bool
{
157 self.snippet
.trim().is_empty() && self.replaces_meaningful_content(sm
)
160 pub fn is_replacement(&self, sm
: &SourceMap
) -> bool
{
161 !self.snippet
.is_empty() && self.replaces_meaningful_content(sm
)
164 fn replaces_meaningful_content(&self, sm
: &SourceMap
) -> bool
{
165 sm
.span_to_snippet(self.span
)
166 .map_or(!self.span
.is_empty(), |snippet
| !snippet
.trim().is_empty())
170 impl CodeSuggestion
{
171 /// Returns the assembled code suggestions, whether they should be shown with an underline
172 /// and whether the substitution only differs in capitalization.
176 ) -> Vec
<(String
, Vec
<SubstitutionPart
>, Vec
<Vec
<SubstitutionHighlight
>>, bool
)> {
177 // For the `Vec<Vec<SubstitutionHighlight>>` value, the first level of the vector
178 // corresponds to the output snippet's lines, while the second level corresponds to the
179 // substrings within that line that should be highlighted.
181 use rustc_span
::{CharPos, Pos}
;
183 /// Append to a buffer the remainder of the line of existing source code, and return the
184 /// count of lines that have been added for accurate highlighting.
187 line_opt
: Option
<&Cow
<'_
, str>>,
189 hi_opt
: Option
<&Loc
>,
191 let mut line_count
= 0;
192 let (lo
, hi_opt
) = (lo
.col
.to_usize(), hi_opt
.map(|hi
| hi
.col
.to_usize()));
193 if let Some(line
) = line_opt
{
194 if let Some(lo
) = line
.char_indices().map(|(i
, _
)| i
).nth(lo
) {
195 let hi_opt
= hi_opt
.and_then(|hi
| line
.char_indices().map(|(i
, _
)| i
).nth(hi
));
197 Some(hi
) if hi
> lo
=> {
198 line_count
= line
[lo
..hi
].matches('
\n'
).count();
199 buf
.push_str(&line
[lo
..hi
])
203 line_count
= line
[lo
..].matches('
\n'
).count();
204 buf
.push_str(&line
[lo
..])
208 if hi_opt
.is_none() {
215 assert
!(!self.substitutions
.is_empty());
220 // Suggestions coming from macros can have malformed spans. This is a heavy
221 // handed approach to avoid ICEs by ignoring the suggestion outright.
222 let invalid
= subst
.parts
.iter().any(|item
| sm
.is_valid_span(item
.span
).is_err());
224 debug
!("splice_lines: suggestion contains an invalid span: {:?}", subst
);
229 .filter_map(|mut substitution
| {
230 // Assumption: all spans are in the same file, and all spans
231 // are disjoint. Sort in ascending order.
232 substitution
.parts
.sort_by_key(|part
| part
.span
.lo());
234 // Find the bounding span.
235 let lo
= substitution
.parts
.iter().map(|part
| part
.span
.lo()).min()?
;
236 let hi
= substitution
.parts
.iter().map(|part
| part
.span
.hi()).max()?
;
237 let bounding_span
= Span
::with_root_ctxt(lo
, hi
);
238 // The different spans might belong to different contexts, if so ignore suggestion.
239 let lines
= sm
.span_to_lines(bounding_span
).ok()?
;
240 assert
!(!lines
.lines
.is_empty() || bounding_span
.is_dummy());
242 // We can't splice anything if the source is unavailable.
243 if !sm
.ensure_source_file_source_present(lines
.file
.clone()) {
247 let mut highlights
= vec
![];
248 // To build up the result, we do this for each span:
249 // - push the line segment trailing the previous span
250 // (at the beginning a "phantom" span pointing at the start of the line)
251 // - push lines between the previous and current span (if any)
252 // - if the previous and current span are not on the same line
253 // push the line segment leading up to the current span
254 // - splice in the span substitution
256 // Finally push the trailing line segment of the last span
257 let sf
= &lines
.file
;
258 let mut prev_hi
= sm
.lookup_char_pos(bounding_span
.lo());
259 prev_hi
.col
= CharPos
::from_usize(0);
261 lines
.lines
.get(0).and_then(|line0
| sf
.get_line(line0
.line_index
));
262 let mut buf
= String
::new();
264 let mut line_highlight
= vec
![];
265 // We need to keep track of the difference between the existing code and the added
266 // or deleted code in order to point at the correct column *after* substitution.
268 for part
in &substitution
.parts
{
269 let cur_lo
= sm
.lookup_char_pos(part
.span
.lo());
270 if prev_hi
.line
== cur_lo
.line
{
272 push_trailing(&mut buf
, prev_line
.as_ref(), &prev_hi
, Some(&cur_lo
));
274 highlights
.push(std
::mem
::take(&mut line_highlight
));
280 highlights
.push(std
::mem
::take(&mut line_highlight
));
281 let mut count
= push_trailing(&mut buf
, prev_line
.as_ref(), &prev_hi
, None
);
283 highlights
.push(std
::mem
::take(&mut line_highlight
));
286 // push lines between the previous and current span (if any)
287 for idx
in prev_hi
.line
..(cur_lo
.line
- 1) {
288 if let Some(line
) = sf
.get_line(idx
) {
289 buf
.push_str(line
.as_ref());
291 highlights
.push(std
::mem
::take(&mut line_highlight
));
294 if let Some(cur_line
) = sf
.get_line(cur_lo
.line
- 1) {
295 let end
= match cur_line
.char_indices().nth(cur_lo
.col
.to_usize()) {
297 None
=> cur_line
.len(),
299 buf
.push_str(&cur_line
[..end
]);
302 // Add a whole line highlight per line in the snippet.
303 let len
: isize = part
307 .unwrap_or(&part
.snippet
)
314 line_highlight
.push(SubstitutionHighlight
{
315 start
: (cur_lo
.col
.0 as isize + acc
) as usize,
316 end
: (cur_lo
.col
.0 as isize + acc
+ len
) as usize,
318 buf
.push_str(&part
.snippet
);
319 let cur_hi
= sm
.lookup_char_pos(part
.span
.hi());
320 if prev_hi
.line
== cur_lo
.line
&& cur_hi
.line
== cur_lo
.line
{
321 // Account for the difference between the width of the current code and the
322 // snippet being suggested, so that the *later* suggestions are correctly
323 // aligned on the screen.
324 acc
+= len
as isize - (cur_hi
.col
.0 - cur_lo
.col
.0) as isize;
327 prev_line
= sf
.get_line(prev_hi
.line
- 1);
328 for line
in part
.snippet
.split('
\n'
).skip(1) {
330 highlights
.push(std
::mem
::take(&mut line_highlight
));
331 let end
: usize = line
338 line_highlight
.push(SubstitutionHighlight { start: 0, end }
);
341 highlights
.push(std
::mem
::take(&mut line_highlight
));
342 let only_capitalization
= is_case_difference(sm
, &buf
, bounding_span
);
343 // if the replacement already ends with a newline, don't print the next line
344 if !buf
.ends_with('
\n'
) {
345 push_trailing(&mut buf
, prev_line
.as_ref(), &prev_hi
, None
);
347 // remove trailing newlines
348 while buf
.ends_with('
\n'
) {
351 Some((buf
, substitution
.parts
, highlights
, only_capitalization
))
357 pub use rustc_span
::fatal_error
::{FatalError, FatalErrorMarker}
;
359 /// Signifies that the compiler died with an explicit call to `.bug`
360 /// or `.span_bug` rather than a failed assertion, etc.
361 #[derive(Copy, Clone, Debug)]
362 pub struct ExplicitBug
;
364 impl fmt
::Display
for ExplicitBug
{
365 fn fmt(&self, f
: &mut fmt
::Formatter
<'_
>) -> fmt
::Result
{
366 write
!(f
, "parser internal bug")
370 impl error
::Error
for ExplicitBug {}
372 pub use diagnostic
::{
373 AddSubdiagnostic
, DecorateLint
, Diagnostic
, DiagnosticArg
, DiagnosticArgFromDisplay
,
374 DiagnosticArgValue
, DiagnosticId
, DiagnosticStyledString
, IntoDiagnosticArg
, SubDiagnostic
,
376 pub use diagnostic_builder
::{DiagnosticBuilder, EmissionGuarantee, LintDiagnosticBuilder}
;
377 use std
::backtrace
::Backtrace
;
379 /// A handler deals with errors and other compiler output.
380 /// Certain errors (fatal, bug, unimpl) may cause immediate exit,
381 /// others log errors for later reporting.
384 inner
: Lock
<HandlerInner
>,
387 /// This inner struct exists to keep it all behind a single lock;
388 /// this is done to prevent possible deadlocks in a multi-threaded compiler,
389 /// as well as inconsistent state observation.
390 struct HandlerInner
{
392 /// The number of lint errors that have been emitted.
393 lint_err_count
: usize,
394 /// The number of errors that have been emitted, including duplicates.
396 /// This is not necessarily the count that's reported to the user once
397 /// compilation ends.
400 deduplicated_err_count
: usize,
401 emitter
: Box
<dyn Emitter
+ sync
::Send
>,
402 delayed_span_bugs
: Vec
<Diagnostic
>,
403 delayed_good_path_bugs
: Vec
<DelayedDiagnostic
>,
404 /// This flag indicates that an expected diagnostic was emitted and suppressed.
405 /// This is used for the `delayed_good_path_bugs` check.
406 suppressed_expected_diag
: bool
,
408 /// This set contains the `DiagnosticId` of all emitted diagnostics to avoid
409 /// emitting the same diagnostic with extended help (`--teach`) twice, which
410 /// would be unnecessary repetition.
411 taught_diagnostics
: FxHashSet
<DiagnosticId
>,
413 /// Used to suggest rustc --explain <error code>
414 emitted_diagnostic_codes
: FxIndexSet
<DiagnosticId
>,
416 /// This set contains a hash of every diagnostic that has been emitted by
417 /// this handler. These hashes is used to avoid emitting the same error
419 emitted_diagnostics
: FxHashSet
<u128
>,
421 /// Stashed diagnostics emitted in one stage of the compiler that may be
422 /// stolen by other stages (e.g. to improve them and add more information).
423 /// The stashed diagnostics count towards the total error count.
424 /// When `.abort_if_errors()` is called, these are also emitted.
425 stashed_diagnostics
: FxIndexMap
<(Span
, StashKey
), Diagnostic
>,
427 /// The warning count, used for a recap upon finishing
428 deduplicated_warn_count
: usize,
430 future_breakage_diagnostics
: Vec
<Diagnostic
>,
432 /// The [`Self::unstable_expect_diagnostics`] should be empty when this struct is
433 /// dropped. However, it can have values if the compilation is stopped early
434 /// or is only partially executed. To avoid ICEs, like in rust#94953 we only
435 /// check if [`Self::unstable_expect_diagnostics`] is empty, if the expectation ids
436 /// have been converted.
437 check_unstable_expect_diagnostics
: bool
,
439 /// Expected [`Diagnostic`]s store a [`LintExpectationId`] as part of
440 /// the lint level. [`LintExpectationId`]s created early during the compilation
441 /// (before `HirId`s have been defined) are not stable and can therefore not be
442 /// stored on disk. This buffer stores these diagnostics until the ID has been
443 /// replaced by a stable [`LintExpectationId`]. The [`Diagnostic`]s are the
444 /// submitted for storage and added to the list of fulfilled expectations.
445 unstable_expect_diagnostics
: Vec
<Diagnostic
>,
447 /// expected diagnostic will have the level `Expect` which additionally
448 /// carries the [`LintExpectationId`] of the expectation that can be
449 /// marked as fulfilled. This is a collection of all [`LintExpectationId`]s
450 /// that have been marked as fulfilled this way.
452 /// [RFC-2383]: https://rust-lang.github.io/rfcs/2383-lint-reasons.html
453 fulfilled_expectations
: FxHashSet
<LintExpectationId
>,
456 /// A key denoting where from a diagnostic was stashed.
457 #[derive(Copy, Clone, PartialEq, Eq, Hash)]
460 UnderscoreForArrayLengths
,
464 fn default_track_diagnostic(_
: &Diagnostic
) {}
466 pub static TRACK_DIAGNOSTICS
: AtomicRef
<fn(&Diagnostic
)> =
467 AtomicRef
::new(&(default_track_diagnostic
as fn(&_
)));
469 #[derive(Copy, Clone, Default)]
470 pub struct HandlerFlags
{
471 /// If false, warning-level lints are suppressed.
472 /// (rustc: see `--allow warnings` and `--cap-lints`)
473 pub can_emit_warnings
: bool
,
474 /// If true, error-level diagnostics are upgraded to bug-level.
475 /// (rustc: see `-Z treat-err-as-bug`)
476 pub treat_err_as_bug
: Option
<NonZeroUsize
>,
477 /// If true, immediately emit diagnostics that would otherwise be buffered.
478 /// (rustc: see `-Z dont-buffer-diagnostics` and `-Z treat-err-as-bug`)
479 pub dont_buffer_diagnostics
: bool
,
480 /// If true, immediately print bugs registered with `delay_span_bug`.
481 /// (rustc: see `-Z report-delayed-bugs`)
482 pub report_delayed_bugs
: bool
,
483 /// Show macro backtraces.
484 /// (rustc: see `-Z macro-backtrace`)
485 pub macro_backtrace
: bool
,
486 /// If true, identical diagnostics are reported only once.
487 pub deduplicate_diagnostics
: bool
,
490 impl Drop
for HandlerInner
{
492 self.emit_stashed_diagnostics();
494 if !self.has_errors() {
495 let bugs
= std
::mem
::replace(&mut self.delayed_span_bugs
, Vec
::new());
496 self.flush_delayed(bugs
, "no errors encountered even though `delay_span_bug` issued");
499 // FIXME(eddyb) this explains what `delayed_good_path_bugs` are!
500 // They're `delayed_span_bugs` but for "require some diagnostic happened"
501 // instead of "require some error happened". Sadly that isn't ideal, as
502 // lints can be `#[allow]`'d, potentially leading to this triggering.
503 // Also, "good path" should be replaced with a better naming.
504 if !self.has_any_message() && !self.suppressed_expected_diag
{
505 let bugs
= std
::mem
::replace(&mut self.delayed_good_path_bugs
, Vec
::new());
507 bugs
.into_iter().map(DelayedDiagnostic
::decorate
),
508 "no warnings or errors encountered even though `delayed_good_path_bugs` issued",
512 if self.check_unstable_expect_diagnostics
{
514 self.unstable_expect_diagnostics
.is_empty(),
515 "all diagnostics with unstable expectations should have been converted",
522 pub fn with_tty_emitter(
523 color_config
: ColorConfig
,
524 can_emit_warnings
: bool
,
525 treat_err_as_bug
: Option
<NonZeroUsize
>,
526 sm
: Option
<Lrc
<SourceMap
>>,
527 fluent_bundle
: Option
<Lrc
<FluentBundle
>>,
528 fallback_bundle
: LazyFallbackBundle
,
530 Self::with_tty_emitter_and_flags(
535 HandlerFlags { can_emit_warnings, treat_err_as_bug, ..Default::default() }
,
539 pub fn with_tty_emitter_and_flags(
540 color_config
: ColorConfig
,
541 sm
: Option
<Lrc
<SourceMap
>>,
542 fluent_bundle
: Option
<Lrc
<FluentBundle
>>,
543 fallback_bundle
: LazyFallbackBundle
,
546 let emitter
= Box
::new(EmitterWriter
::stderr(
554 flags
.macro_backtrace
,
556 Self::with_emitter_and_flags(emitter
, flags
)
560 can_emit_warnings
: bool
,
561 treat_err_as_bug
: Option
<NonZeroUsize
>,
562 emitter
: Box
<dyn Emitter
+ sync
::Send
>,
564 Handler
::with_emitter_and_flags(
566 HandlerFlags { can_emit_warnings, treat_err_as_bug, ..Default::default() }
,
570 pub fn with_emitter_and_flags(
571 emitter
: Box
<dyn Emitter
+ sync
::Send
>,
576 inner
: Lock
::new(HandlerInner
{
581 deduplicated_err_count
: 0,
582 deduplicated_warn_count
: 0,
584 delayed_span_bugs
: Vec
::new(),
585 delayed_good_path_bugs
: Vec
::new(),
586 suppressed_expected_diag
: false,
587 taught_diagnostics
: Default
::default(),
588 emitted_diagnostic_codes
: Default
::default(),
589 emitted_diagnostics
: Default
::default(),
590 stashed_diagnostics
: Default
::default(),
591 future_breakage_diagnostics
: Vec
::new(),
592 check_unstable_expect_diagnostics
: false,
593 unstable_expect_diagnostics
: Vec
::new(),
594 fulfilled_expectations
: Default
::default(),
599 // This is here to not allow mutation of flags;
600 // as of this writing it's only used in tests in librustc_middle.
601 pub fn can_emit_warnings(&self) -> bool
{
602 self.flags
.can_emit_warnings
605 /// Resets the diagnostic error count as well as the cached emitted diagnostics.
607 /// NOTE: *do not* call this function from rustc. It is only meant to be called from external
608 /// tools that want to reuse a `Parser` cleaning the previously emitted diagnostics as well as
609 /// the overall count of emitted error diagnostics.
610 pub fn reset_err_count(&self) {
611 let mut inner
= self.inner
.borrow_mut();
613 inner
.warn_count
= 0;
614 inner
.deduplicated_err_count
= 0;
615 inner
.deduplicated_warn_count
= 0;
617 // actually free the underlying memory (which `clear` would not do)
618 inner
.delayed_span_bugs
= Default
::default();
619 inner
.delayed_good_path_bugs
= Default
::default();
620 inner
.taught_diagnostics
= Default
::default();
621 inner
.emitted_diagnostic_codes
= Default
::default();
622 inner
.emitted_diagnostics
= Default
::default();
623 inner
.stashed_diagnostics
= Default
::default();
626 /// Stash a given diagnostic with the given `Span` and `StashKey` as the key for later stealing.
627 pub fn stash_diagnostic(&self, span
: Span
, key
: StashKey
, diag
: Diagnostic
) {
628 let mut inner
= self.inner
.borrow_mut();
629 inner
.stash((span
, key
), diag
);
632 /// Steal a previously stashed diagnostic with the given `Span` and `StashKey` as the key.
633 pub fn steal_diagnostic(&self, span
: Span
, key
: StashKey
) -> Option
<DiagnosticBuilder
<'_
, ()>> {
634 let mut inner
= self.inner
.borrow_mut();
635 inner
.steal((span
, key
)).map(|diag
| DiagnosticBuilder
::new_diagnostic(self, diag
))
638 pub fn has_stashed_diagnostic(&self, span
: Span
, key
: StashKey
) -> bool
{
639 self.inner
.borrow().stashed_diagnostics
.get(&(span
, key
)).is_some()
642 /// Emit all stashed diagnostics.
643 pub fn emit_stashed_diagnostics(&self) -> Option
<ErrorGuaranteed
> {
644 self.inner
.borrow_mut().emit_stashed_diagnostics()
647 /// Construct a builder with the `msg` at the level appropriate for the specific `EmissionGuarantee`.
648 #[rustc_lint_diagnostics]
649 pub fn struct_diagnostic
<G
: EmissionGuarantee
>(
651 msg
: impl Into
<DiagnosticMessage
>,
652 ) -> DiagnosticBuilder
<'_
, G
> {
653 G
::make_diagnostic_builder(self, msg
)
656 /// Construct a builder at the `Warning` level at the given `span` and with the `msg`.
658 /// Attempting to `.emit()` the builder will only emit if either:
659 /// * `can_emit_warnings` is `true`
660 /// * `is_force_warn` was set in `DiagnosticId::Lint`
661 #[rustc_lint_diagnostics]
662 pub fn struct_span_warn(
664 span
: impl Into
<MultiSpan
>,
665 msg
: impl Into
<DiagnosticMessage
>,
666 ) -> DiagnosticBuilder
<'_
, ()> {
667 let mut result
= self.struct_warn(msg
);
668 result
.set_span(span
);
672 /// Construct a builder at the `Warning` level at the given `span` and with the `msg`.
673 /// The `id` is used for lint emissions which should also fulfill a lint expectation.
675 /// Attempting to `.emit()` the builder will only emit if either:
676 /// * `can_emit_warnings` is `true`
677 /// * `is_force_warn` was set in `DiagnosticId::Lint`
678 pub fn struct_span_warn_with_expectation(
680 span
: impl Into
<MultiSpan
>,
681 msg
: impl Into
<DiagnosticMessage
>,
682 id
: LintExpectationId
,
683 ) -> DiagnosticBuilder
<'_
, ()> {
684 let mut result
= self.struct_warn_with_expectation(msg
, id
);
685 result
.set_span(span
);
689 /// Construct a builder at the `Allow` level at the given `span` and with the `msg`.
690 #[rustc_lint_diagnostics]
691 pub fn struct_span_allow(
693 span
: impl Into
<MultiSpan
>,
694 msg
: impl Into
<DiagnosticMessage
>,
695 ) -> DiagnosticBuilder
<'_
, ()> {
696 let mut result
= self.struct_allow(msg
);
697 result
.set_span(span
);
701 /// Construct a builder at the `Warning` level at the given `span` and with the `msg`.
702 /// Also include a code.
703 #[rustc_lint_diagnostics]
704 pub fn struct_span_warn_with_code(
706 span
: impl Into
<MultiSpan
>,
707 msg
: impl Into
<DiagnosticMessage
>,
709 ) -> DiagnosticBuilder
<'_
, ()> {
710 let mut result
= self.struct_span_warn(span
, msg
);
715 /// Construct a builder at the `Warning` level with the `msg`.
717 /// Attempting to `.emit()` the builder will only emit if either:
718 /// * `can_emit_warnings` is `true`
719 /// * `is_force_warn` was set in `DiagnosticId::Lint`
720 #[rustc_lint_diagnostics]
721 pub fn struct_warn(&self, msg
: impl Into
<DiagnosticMessage
>) -> DiagnosticBuilder
<'_
, ()> {
722 DiagnosticBuilder
::new(self, Level
::Warning(None
), msg
)
725 /// Construct a builder at the `Warning` level with the `msg`. The `id` is used for
726 /// lint emissions which should also fulfill a lint expectation.
728 /// Attempting to `.emit()` the builder will only emit if either:
729 /// * `can_emit_warnings` is `true`
730 /// * `is_force_warn` was set in `DiagnosticId::Lint`
731 pub fn struct_warn_with_expectation(
733 msg
: impl Into
<DiagnosticMessage
>,
734 id
: LintExpectationId
,
735 ) -> DiagnosticBuilder
<'_
, ()> {
736 DiagnosticBuilder
::new(self, Level
::Warning(Some(id
)), msg
)
739 /// Construct a builder at the `Allow` level with the `msg`.
740 #[rustc_lint_diagnostics]
741 pub fn struct_allow(&self, msg
: impl Into
<DiagnosticMessage
>) -> DiagnosticBuilder
<'_
, ()> {
742 DiagnosticBuilder
::new(self, Level
::Allow
, msg
)
745 /// Construct a builder at the `Expect` level with the `msg`.
746 #[rustc_lint_diagnostics]
747 pub fn struct_expect(
749 msg
: impl Into
<DiagnosticMessage
>,
750 id
: LintExpectationId
,
751 ) -> DiagnosticBuilder
<'_
, ()> {
752 DiagnosticBuilder
::new(self, Level
::Expect(id
), msg
)
755 /// Construct a builder at the `Error` level at the given `span` and with the `msg`.
756 #[rustc_lint_diagnostics]
757 pub fn struct_span_err(
759 span
: impl Into
<MultiSpan
>,
760 msg
: impl Into
<DiagnosticMessage
>,
761 ) -> DiagnosticBuilder
<'_
, ErrorGuaranteed
> {
762 let mut result
= self.struct_err(msg
);
763 result
.set_span(span
);
767 /// Construct a builder at the `Error` level at the given `span`, with the `msg`, and `code`.
768 #[rustc_lint_diagnostics]
769 pub fn struct_span_err_with_code(
771 span
: impl Into
<MultiSpan
>,
772 msg
: impl Into
<DiagnosticMessage
>,
774 ) -> DiagnosticBuilder
<'_
, ErrorGuaranteed
> {
775 let mut result
= self.struct_span_err(span
, msg
);
780 /// Construct a builder at the `Error` level with the `msg`.
781 // FIXME: This method should be removed (every error should have an associated error code).
782 #[rustc_lint_diagnostics]
785 msg
: impl Into
<DiagnosticMessage
>,
786 ) -> DiagnosticBuilder
<'_
, ErrorGuaranteed
> {
787 DiagnosticBuilder
::new_guaranteeing_error
::<_
, { Level::Error { lint: false }
}>(self, msg
)
790 /// This should only be used by `rustc_middle::lint::struct_lint_level`. Do not use it for hard errors.
792 pub fn struct_err_lint(&self, msg
: impl Into
<DiagnosticMessage
>) -> DiagnosticBuilder
<'_
, ()> {
793 DiagnosticBuilder
::new(self, Level
::Error { lint: true }
, msg
)
796 /// Construct a builder at the `Error` level with the `msg` and the `code`.
797 #[rustc_lint_diagnostics]
798 pub fn struct_err_with_code(
800 msg
: impl Into
<DiagnosticMessage
>,
802 ) -> DiagnosticBuilder
<'_
, ErrorGuaranteed
> {
803 let mut result
= self.struct_err(msg
);
808 /// Construct a builder at the `Warn` level with the `msg` and the `code`.
809 #[rustc_lint_diagnostics]
810 pub fn struct_warn_with_code(
812 msg
: impl Into
<DiagnosticMessage
>,
814 ) -> DiagnosticBuilder
<'_
, ()> {
815 let mut result
= self.struct_warn(msg
);
820 /// Construct a builder at the `Fatal` level at the given `span` and with the `msg`.
821 #[rustc_lint_diagnostics]
822 pub fn struct_span_fatal(
824 span
: impl Into
<MultiSpan
>,
825 msg
: impl Into
<DiagnosticMessage
>,
826 ) -> DiagnosticBuilder
<'_
, !> {
827 let mut result
= self.struct_fatal(msg
);
828 result
.set_span(span
);
832 /// Construct a builder at the `Fatal` level at the given `span`, with the `msg`, and `code`.
833 #[rustc_lint_diagnostics]
834 pub fn struct_span_fatal_with_code(
836 span
: impl Into
<MultiSpan
>,
837 msg
: impl Into
<DiagnosticMessage
>,
839 ) -> DiagnosticBuilder
<'_
, !> {
840 let mut result
= self.struct_span_fatal(span
, msg
);
845 /// Construct a builder at the `Error` level with the `msg`.
846 #[rustc_lint_diagnostics]
847 pub fn struct_fatal(&self, msg
: impl Into
<DiagnosticMessage
>) -> DiagnosticBuilder
<'_
, !> {
848 DiagnosticBuilder
::new_fatal(self, msg
)
851 /// Construct a builder at the `Help` level with the `msg`.
852 #[rustc_lint_diagnostics]
853 pub fn struct_help(&self, msg
: impl Into
<DiagnosticMessage
>) -> DiagnosticBuilder
<'_
, ()> {
854 DiagnosticBuilder
::new(self, Level
::Help
, msg
)
857 /// Construct a builder at the `Note` level with the `msg`.
858 #[rustc_lint_diagnostics]
859 pub fn struct_note_without_error(
861 msg
: impl Into
<DiagnosticMessage
>,
862 ) -> DiagnosticBuilder
<'_
, ()> {
863 DiagnosticBuilder
::new(self, Level
::Note
, msg
)
866 #[rustc_lint_diagnostics]
867 pub fn span_fatal(&self, span
: impl Into
<MultiSpan
>, msg
: impl Into
<DiagnosticMessage
>) -> ! {
868 self.emit_diag_at_span(Diagnostic
::new(Fatal
, msg
), span
);
872 #[rustc_lint_diagnostics]
873 pub fn span_fatal_with_code(
875 span
: impl Into
<MultiSpan
>,
876 msg
: impl Into
<DiagnosticMessage
>,
879 self.emit_diag_at_span(Diagnostic
::new_with_code(Fatal
, Some(code
), msg
), span
);
883 #[rustc_lint_diagnostics]
886 span
: impl Into
<MultiSpan
>,
887 msg
: impl Into
<DiagnosticMessage
>,
888 ) -> ErrorGuaranteed
{
889 self.emit_diag_at_span(Diagnostic
::new(Error { lint: false }
, msg
), span
).unwrap()
892 #[rustc_lint_diagnostics]
893 pub fn span_err_with_code(
895 span
: impl Into
<MultiSpan
>,
896 msg
: impl Into
<DiagnosticMessage
>,
899 self.emit_diag_at_span(
900 Diagnostic
::new_with_code(Error { lint: false }
, Some(code
), msg
),
905 #[rustc_lint_diagnostics]
906 pub fn span_warn(&self, span
: impl Into
<MultiSpan
>, msg
: impl Into
<DiagnosticMessage
>) {
907 self.emit_diag_at_span(Diagnostic
::new(Warning(None
), msg
), span
);
910 #[rustc_lint_diagnostics]
911 pub fn span_warn_with_code(
913 span
: impl Into
<MultiSpan
>,
914 msg
: impl Into
<DiagnosticMessage
>,
917 self.emit_diag_at_span(Diagnostic
::new_with_code(Warning(None
), Some(code
), msg
), span
);
920 pub fn span_bug(&self, span
: impl Into
<MultiSpan
>, msg
: impl Into
<DiagnosticMessage
>) -> ! {
921 self.inner
.borrow_mut().span_bug(span
, msg
)
925 pub fn delay_span_bug(
927 span
: impl Into
<MultiSpan
>,
928 msg
: impl Into
<DiagnosticMessage
>,
929 ) -> ErrorGuaranteed
{
930 self.inner
.borrow_mut().delay_span_bug(span
, msg
)
933 // FIXME(eddyb) note the comment inside `impl Drop for HandlerInner`, that's
934 // where the explanation of what "good path" is (also, it should be renamed).
935 pub fn delay_good_path_bug(&self, msg
: impl Into
<DiagnosticMessage
>) {
936 self.inner
.borrow_mut().delay_good_path_bug(msg
)
939 pub fn span_bug_no_panic(&self, span
: impl Into
<MultiSpan
>, msg
: impl Into
<DiagnosticMessage
>) {
940 self.emit_diag_at_span(Diagnostic
::new(Bug
, msg
), span
);
943 pub fn span_note_without_error(
945 span
: impl Into
<MultiSpan
>,
946 msg
: impl Into
<DiagnosticMessage
>,
948 self.emit_diag_at_span(Diagnostic
::new(Note
, msg
), span
);
951 pub fn span_note_diag(
954 msg
: impl Into
<DiagnosticMessage
>,
955 ) -> DiagnosticBuilder
<'_
, ()> {
956 let mut db
= DiagnosticBuilder
::new(self, Note
, msg
);
961 // NOTE: intentionally doesn't raise an error so rustc_codegen_ssa only reports fatal errors in the main thread
962 pub fn fatal(&self, msg
: impl Into
<DiagnosticMessage
>) -> FatalError
{
963 self.inner
.borrow_mut().fatal(msg
)
966 pub fn err(&self, msg
: impl Into
<DiagnosticMessage
>) -> ErrorGuaranteed
{
967 self.inner
.borrow_mut().err(msg
)
970 pub fn warn(&self, msg
: impl Into
<DiagnosticMessage
>) {
971 let mut db
= DiagnosticBuilder
::new(self, Warning(None
), msg
);
975 pub fn note_without_error(&self, msg
: impl Into
<DiagnosticMessage
>) {
976 DiagnosticBuilder
::new(self, Note
, msg
).emit();
979 pub fn bug(&self, msg
: impl Into
<DiagnosticMessage
>) -> ! {
980 self.inner
.borrow_mut().bug(msg
)
984 pub fn err_count(&self) -> usize {
985 self.inner
.borrow().err_count()
988 pub fn has_errors(&self) -> Option
<ErrorGuaranteed
> {
989 if self.inner
.borrow().has_errors() { Some(ErrorGuaranteed(())) }
else { None }
991 pub fn has_errors_or_lint_errors(&self) -> Option
<ErrorGuaranteed
> {
992 if self.inner
.borrow().has_errors_or_lint_errors() {
993 Some(ErrorGuaranteed(()))
998 pub fn has_errors_or_delayed_span_bugs(&self) -> bool
{
999 self.inner
.borrow().has_errors_or_delayed_span_bugs()
1002 pub fn print_error_count(&self, registry
: &Registry
) {
1003 self.inner
.borrow_mut().print_error_count(registry
)
1006 pub fn take_future_breakage_diagnostics(&self) -> Vec
<Diagnostic
> {
1007 std
::mem
::take(&mut self.inner
.borrow_mut().future_breakage_diagnostics
)
1010 pub fn abort_if_errors(&self) {
1011 self.inner
.borrow_mut().abort_if_errors()
1014 /// `true` if we haven't taught a diagnostic with this code already.
1015 /// The caller must then teach the user about such a diagnostic.
1017 /// Used to suppress emitting the same error multiple times with extended explanation when
1018 /// calling `-Zteach`.
1019 pub fn must_teach(&self, code
: &DiagnosticId
) -> bool
{
1020 self.inner
.borrow_mut().must_teach(code
)
1023 pub fn force_print_diagnostic(&self, db
: Diagnostic
) {
1024 self.inner
.borrow_mut().force_print_diagnostic(db
)
1027 pub fn emit_diagnostic(&self, diagnostic
: &mut Diagnostic
) -> Option
<ErrorGuaranteed
> {
1028 self.inner
.borrow_mut().emit_diagnostic(diagnostic
)
1031 fn emit_diag_at_span(
1033 mut diag
: Diagnostic
,
1034 sp
: impl Into
<MultiSpan
>,
1035 ) -> Option
<ErrorGuaranteed
> {
1036 let mut inner
= self.inner
.borrow_mut();
1037 inner
.emit_diagnostic(diag
.set_span(sp
))
1040 pub fn emit_artifact_notification(&self, path
: &Path
, artifact_type
: &str) {
1041 self.inner
.borrow_mut().emit_artifact_notification(path
, artifact_type
)
1044 pub fn emit_future_breakage_report(&self, diags
: Vec
<Diagnostic
>) {
1045 self.inner
.borrow_mut().emitter
.emit_future_breakage_report(diags
)
1048 pub fn emit_unused_externs(
1050 lint_level
: rustc_lint_defs
::Level
,
1052 unused_externs
: &[&str],
1054 let mut inner
= self.inner
.borrow_mut();
1056 if loud
&& lint_level
.is_error() {
1057 inner
.bump_err_count();
1060 inner
.emit_unused_externs(lint_level
, unused_externs
)
1063 pub fn update_unstable_expectation_id(
1065 unstable_to_stable
: &FxHashMap
<LintExpectationId
, LintExpectationId
>,
1067 let mut inner
= self.inner
.borrow_mut();
1068 let diags
= std
::mem
::take(&mut inner
.unstable_expect_diagnostics
);
1069 inner
.check_unstable_expect_diagnostics
= true;
1071 if !diags
.is_empty() {
1072 inner
.suppressed_expected_diag
= true;
1073 for mut diag
in diags
.into_iter() {
1074 diag
.update_unstable_expectation_id(unstable_to_stable
);
1076 // Here the diagnostic is given back to `emit_diagnostic` where it was first
1077 // intercepted. Now it should be processed as usual, since the unstable expectation
1078 // id is now stable.
1079 inner
.emit_diagnostic(&mut diag
);
1084 .stashed_diagnostics
1086 .for_each(|diag
| diag
.update_unstable_expectation_id(unstable_to_stable
));
1088 .future_breakage_diagnostics
1090 .for_each(|diag
| diag
.update_unstable_expectation_id(unstable_to_stable
));
1093 /// This methods steals all [`LintExpectationId`]s that are stored inside
1094 /// [`HandlerInner`] and indicate that the linked expectation has been fulfilled.
1096 pub fn steal_fulfilled_expectation_ids(&self) -> FxHashSet
<LintExpectationId
> {
1098 self.inner
.borrow().unstable_expect_diagnostics
.is_empty(),
1099 "`HandlerInner::unstable_expect_diagnostics` should be empty at this point",
1101 std
::mem
::take(&mut self.inner
.borrow_mut().fulfilled_expectations
)
1106 fn must_teach(&mut self, code
: &DiagnosticId
) -> bool
{
1107 self.taught_diagnostics
.insert(code
.clone())
1110 fn force_print_diagnostic(&mut self, mut db
: Diagnostic
) {
1111 self.emitter
.emit_diagnostic(&mut db
);
1114 /// Emit all stashed diagnostics.
1115 fn emit_stashed_diagnostics(&mut self) -> Option
<ErrorGuaranteed
> {
1116 let has_errors
= self.has_errors();
1117 let diags
= self.stashed_diagnostics
.drain(..).map(|x
| x
.1).collect
::<Vec
<_
>>();
1118 let mut reported
= None
;
1119 for mut diag
in diags
{
1120 // Decrement the count tracking the stash; emitting will increment it.
1121 if diag
.is_error() {
1122 if matches
!(diag
.level
, Level
::Error { lint: true }
) {
1123 self.lint_err_count
-= 1;
1125 self.err_count
-= 1;
1128 if diag
.is_force_warn() {
1129 self.warn_count
-= 1;
1131 // Unless they're forced, don't flush stashed warnings when
1132 // there are errors, to avoid causing warning overload. The
1133 // stash would've been stolen already if it were important.
1139 let reported_this
= self.emit_diagnostic(&mut diag
);
1140 reported
= reported
.or(reported_this
);
1145 // FIXME(eddyb) this should ideally take `diagnostic` by value.
1146 fn emit_diagnostic(&mut self, diagnostic
: &mut Diagnostic
) -> Option
<ErrorGuaranteed
> {
1147 // The `LintExpectationId` can be stable or unstable depending on when it was created.
1148 // Diagnostics created before the definition of `HirId`s are unstable and can not yet
1149 // be stored. Instead, they are buffered until the `LintExpectationId` is replaced by
1150 // a stable one by the `LintLevelsBuilder`.
1151 if let Some(LintExpectationId
::Unstable { .. }
) = diagnostic
.level
.get_expectation_id() {
1152 self.unstable_expect_diagnostics
.push(diagnostic
.clone());
1156 if diagnostic
.level
== Level
::DelayedBug
{
1157 // FIXME(eddyb) this should check for `has_errors` and stop pushing
1158 // once *any* errors were emitted (and truncate `delayed_span_bugs`
1159 // when an error is first emitted, also), but maybe there's a case
1160 // in which that's not sound? otherwise this is really inefficient.
1161 self.delayed_span_bugs
.push(diagnostic
.clone());
1163 if !self.flags
.report_delayed_bugs
{
1164 return Some(ErrorGuaranteed
::unchecked_claim_error_was_emitted());
1168 if diagnostic
.has_future_breakage() {
1169 self.future_breakage_diagnostics
.push(diagnostic
.clone());
1172 if let Some(expectation_id
) = diagnostic
.level
.get_expectation_id() {
1173 self.suppressed_expected_diag
= true;
1174 self.fulfilled_expectations
.insert(expectation_id
);
1177 if matches
!(diagnostic
.level
, Warning(_
))
1178 && !self.flags
.can_emit_warnings
1179 && !diagnostic
.is_force_warn()
1181 if diagnostic
.has_future_breakage() {
1182 (*TRACK_DIAGNOSTICS
)(diagnostic
);
1187 (*TRACK_DIAGNOSTICS
)(diagnostic
);
1189 if matches
!(diagnostic
.level
, Level
::Expect(_
) | Level
::Allow
) {
1193 if let Some(ref code
) = diagnostic
.code
{
1194 self.emitted_diagnostic_codes
.insert(code
.clone());
1197 let already_emitted
= |this
: &mut Self| {
1198 let mut hasher
= StableHasher
::new();
1199 diagnostic
.hash(&mut hasher
);
1200 let diagnostic_hash
= hasher
.finish();
1201 !this
.emitted_diagnostics
.insert(diagnostic_hash
)
1204 // Only emit the diagnostic if we've been asked to deduplicate or
1205 // haven't already emitted an equivalent diagnostic.
1206 if !(self.flags
.deduplicate_diagnostics
&& already_emitted(self)) {
1207 debug
!(?diagnostic
);
1208 debug
!(?
self.emitted_diagnostics
);
1209 let already_emitted_sub
= |sub
: &mut SubDiagnostic
| {
1211 if sub
.level
!= Level
::OnceNote
{
1214 let mut hasher
= StableHasher
::new();
1215 sub
.hash(&mut hasher
);
1216 let diagnostic_hash
= hasher
.finish();
1217 debug
!(?diagnostic_hash
);
1218 !self.emitted_diagnostics
.insert(diagnostic_hash
)
1221 diagnostic
.children
.drain_filter(already_emitted_sub
).for_each(|_
| {}
);
1223 self.emitter
.emit_diagnostic(&diagnostic
);
1224 if diagnostic
.is_error() {
1225 self.deduplicated_err_count
+= 1;
1226 } else if let Warning(_
) = diagnostic
.level
{
1227 self.deduplicated_warn_count
+= 1;
1230 if diagnostic
.is_error() {
1231 if matches
!(diagnostic
.level
, Level
::Error { lint: true }
) {
1232 self.bump_lint_err_count();
1234 self.bump_err_count();
1237 Some(ErrorGuaranteed
::unchecked_claim_error_was_emitted())
1239 self.bump_warn_count();
1245 fn emit_artifact_notification(&mut self, path
: &Path
, artifact_type
: &str) {
1246 self.emitter
.emit_artifact_notification(path
, artifact_type
);
1249 fn emit_unused_externs(&mut self, lint_level
: rustc_lint_defs
::Level
, unused_externs
: &[&str]) {
1250 self.emitter
.emit_unused_externs(lint_level
, unused_externs
);
1253 fn treat_err_as_bug(&self) -> bool
{
1254 self.flags
.treat_err_as_bug
.map_or(false, |c
| {
1255 self.err_count() + self.lint_err_count
+ self.delayed_bug_count() >= c
.get()
1259 fn delayed_bug_count(&self) -> usize {
1260 self.delayed_span_bugs
.len() + self.delayed_good_path_bugs
.len()
1263 fn print_error_count(&mut self, registry
: &Registry
) {
1264 self.emit_stashed_diagnostics();
1266 let warnings
= match self.deduplicated_warn_count
{
1268 1 => "1 warning emitted".to_string(),
1269 count
=> format
!("{count} warnings emitted"),
1271 let errors
= match self.deduplicated_err_count
{
1273 1 => "aborting due to previous error".to_string(),
1274 count
=> format
!("aborting due to {count} previous errors"),
1276 if self.treat_err_as_bug() {
1280 match (errors
.len(), warnings
.len()) {
1282 (0, _
) => self.emitter
.emit_diagnostic(&Diagnostic
::new(
1283 Level
::Warning(None
),
1284 DiagnosticMessage
::Str(warnings
),
1287 let _
= self.fatal(&errors
);
1290 let _
= self.fatal(&format
!("{}; {}", &errors
, &warnings
));
1294 let can_show_explain
= self.emitter
.should_show_explain();
1295 let are_there_diagnostics
= !self.emitted_diagnostic_codes
.is_empty();
1296 if can_show_explain
&& are_there_diagnostics
{
1297 let mut error_codes
= self
1298 .emitted_diagnostic_codes
1300 .filter_map(|x
| match &x
{
1301 DiagnosticId
::Error(s
)
1302 if registry
.try_find_description(s
).map_or(false, |o
| o
.is_some()) =>
1308 .collect
::<Vec
<_
>>();
1309 if !error_codes
.is_empty() {
1311 if error_codes
.len() > 1 {
1312 let limit
= if error_codes
.len() > 9 { 9 }
else { error_codes.len() }
;
1313 self.failure(&format
!(
1314 "Some errors have detailed explanations: {}{}",
1315 error_codes
[..limit
].join(", "),
1316 if error_codes
.len() > 9 { "..." }
else { "." }
1318 self.failure(&format
!(
1319 "For more information about an error, try \
1320 `rustc --explain {}`.",
1324 self.failure(&format
!(
1325 "For more information about this error, try \
1326 `rustc --explain {}`.",
1334 fn stash(&mut self, key
: (Span
, StashKey
), diagnostic
: Diagnostic
) {
1335 // Track the diagnostic for counts, but don't panic-if-treat-err-as-bug
1336 // yet; that happens when we actually emit the diagnostic.
1337 if diagnostic
.is_error() {
1338 if matches
!(diagnostic
.level
, Level
::Error { lint: true }
) {
1339 self.lint_err_count
+= 1;
1341 self.err_count
+= 1;
1344 // Warnings are only automatically flushed if they're forced.
1345 if diagnostic
.is_force_warn() {
1346 self.warn_count
+= 1;
1350 // FIXME(Centril, #69537): Consider reintroducing panic on overwriting a stashed diagnostic
1351 // if/when we have a more robust macro-friendly replacement for `(span, key)` as a key.
1352 // See the PR for a discussion.
1353 self.stashed_diagnostics
.insert(key
, diagnostic
);
1356 fn steal(&mut self, key
: (Span
, StashKey
)) -> Option
<Diagnostic
> {
1357 let diagnostic
= self.stashed_diagnostics
.remove(&key
)?
;
1358 if diagnostic
.is_error() {
1359 if matches
!(diagnostic
.level
, Level
::Error { lint: true }
) {
1360 self.lint_err_count
-= 1;
1362 self.err_count
-= 1;
1365 if diagnostic
.is_force_warn() {
1366 self.warn_count
-= 1;
1373 fn err_count(&self) -> usize {
1377 fn has_errors(&self) -> bool
{
1378 self.err_count() > 0
1380 fn has_errors_or_lint_errors(&self) -> bool
{
1381 self.has_errors() || self.lint_err_count
> 0
1383 fn has_errors_or_delayed_span_bugs(&self) -> bool
{
1384 self.has_errors() || !self.delayed_span_bugs
.is_empty()
1386 fn has_any_message(&self) -> bool
{
1387 self.err_count() > 0 || self.lint_err_count
> 0 || self.warn_count
> 0
1390 fn abort_if_errors(&mut self) {
1391 self.emit_stashed_diagnostics();
1393 if self.has_errors() {
1398 fn span_bug(&mut self, sp
: impl Into
<MultiSpan
>, msg
: impl Into
<DiagnosticMessage
>) -> ! {
1399 self.emit_diag_at_span(Diagnostic
::new(Bug
, msg
), sp
);
1400 panic
::panic_any(ExplicitBug
);
1403 fn emit_diag_at_span(&mut self, mut diag
: Diagnostic
, sp
: impl Into
<MultiSpan
>) {
1404 self.emit_diagnostic(diag
.set_span(sp
));
1410 sp
: impl Into
<MultiSpan
>,
1411 msg
: impl Into
<DiagnosticMessage
>,
1412 ) -> ErrorGuaranteed
{
1413 // This is technically `self.treat_err_as_bug()` but `delay_span_bug` is called before
1414 // incrementing `err_count` by one, so we need to +1 the comparing.
1415 // FIXME: Would be nice to increment err_count in a more coherent way.
1416 if self.flags
.treat_err_as_bug
.map_or(false, |c
| {
1417 self.err_count() + self.lint_err_count
+ self.delayed_bug_count() + 1 >= c
.get()
1419 // FIXME: don't abort here if report_delayed_bugs is off
1420 self.span_bug(sp
, msg
);
1422 let mut diagnostic
= Diagnostic
::new(Level
::DelayedBug
, msg
);
1423 diagnostic
.set_span(sp
.into());
1424 diagnostic
.note(&format
!("delayed at {}", std
::panic
::Location
::caller()));
1425 self.emit_diagnostic(&mut diagnostic
).unwrap()
1428 // FIXME(eddyb) note the comment inside `impl Drop for HandlerInner`, that's
1429 // where the explanation of what "good path" is (also, it should be renamed).
1430 fn delay_good_path_bug(&mut self, msg
: impl Into
<DiagnosticMessage
>) {
1431 let mut diagnostic
= Diagnostic
::new(Level
::DelayedBug
, msg
);
1432 if self.flags
.report_delayed_bugs
{
1433 self.emit_diagnostic(&mut diagnostic
);
1435 let backtrace
= std
::backtrace
::Backtrace
::force_capture();
1436 self.delayed_good_path_bugs
.push(DelayedDiagnostic
::with_backtrace(diagnostic
, backtrace
));
1439 fn failure(&mut self, msg
: impl Into
<DiagnosticMessage
>) {
1440 self.emit_diagnostic(&mut Diagnostic
::new(FailureNote
, msg
));
1443 fn fatal(&mut self, msg
: impl Into
<DiagnosticMessage
>) -> FatalError
{
1444 self.emit(Fatal
, msg
);
1448 fn err(&mut self, msg
: impl Into
<DiagnosticMessage
>) -> ErrorGuaranteed
{
1449 self.emit(Error { lint: false }
, msg
)
1452 /// Emit an error; level should be `Error` or `Fatal`.
1453 fn emit(&mut self, level
: Level
, msg
: impl Into
<DiagnosticMessage
>) -> ErrorGuaranteed
{
1454 if self.treat_err_as_bug() {
1457 self.emit_diagnostic(&mut Diagnostic
::new(level
, msg
)).unwrap()
1460 fn bug(&mut self, msg
: impl Into
<DiagnosticMessage
>) -> ! {
1461 self.emit_diagnostic(&mut Diagnostic
::new(Bug
, msg
));
1462 panic
::panic_any(ExplicitBug
);
1467 bugs
: impl IntoIterator
<Item
= Diagnostic
>,
1468 explanation
: impl Into
<DiagnosticMessage
> + Copy
,
1470 let mut no_bugs
= true;
1471 for mut bug
in bugs
{
1473 // Put the overall explanation before the `DelayedBug`s, to
1474 // frame them better (e.g. separate warnings from them).
1475 self.emit_diagnostic(&mut Diagnostic
::new(Bug
, explanation
));
1479 // "Undelay" the `DelayedBug`s (into plain `Bug`s).
1480 if bug
.level
!= Level
::DelayedBug
{
1481 // NOTE(eddyb) not panicking here because we're already producing
1482 // an ICE, and the more information the merrier.
1484 "`flushed_delayed` got diagnostic with level {:?}, \
1485 instead of the expected `DelayedBug`",
1489 bug
.level
= Level
::Bug
;
1491 self.emit_diagnostic(&mut bug
);
1494 // Panic with `ExplicitBug` to avoid "unexpected panic" messages.
1496 panic
::panic_any(ExplicitBug
);
1500 fn bump_lint_err_count(&mut self) {
1501 self.lint_err_count
+= 1;
1502 self.panic_if_treat_err_as_bug();
1505 fn bump_err_count(&mut self) {
1506 self.err_count
+= 1;
1507 self.panic_if_treat_err_as_bug();
1510 fn bump_warn_count(&mut self) {
1511 self.warn_count
+= 1;
1514 fn panic_if_treat_err_as_bug(&self) {
1515 if self.treat_err_as_bug() {
1517 self.err_count() + self.lint_err_count
,
1518 self.delayed_bug_count(),
1519 self.flags
.treat_err_as_bug
.map(|c
| c
.get()).unwrap_or(0),
1521 (1, 0, 1) => panic
!("aborting due to `-Z treat-err-as-bug=1`"),
1522 (0, 1, 1) => panic
!("aborting due delayed bug with `-Z treat-err-as-bug=1`"),
1523 (count
, delayed_count
, as_bug
) => {
1524 if delayed_count
> 0 {
1526 "aborting after {} errors and {} delayed bugs due to `-Z treat-err-as-bug={}`",
1527 count
, delayed_count
, as_bug
,
1531 "aborting after {} errors due to `-Z treat-err-as-bug={}`",
1541 struct DelayedDiagnostic
{
1546 impl DelayedDiagnostic
{
1547 fn with_backtrace(diagnostic
: Diagnostic
, backtrace
: Backtrace
) -> Self {
1548 DelayedDiagnostic { inner: diagnostic, note: backtrace }
1551 fn decorate(mut self) -> Diagnostic
{
1552 self.inner
.note(&format
!("delayed at {}", self.note
));
1557 #[derive(Copy, PartialEq, Eq, Clone, Hash, Debug, Encodable, Decodable)]
1563 /// If this error comes from a lint, don't abort compilation even when abort_if_errors() is called.
1566 /// This [`LintExpectationId`] is used for expected lint diagnostics, which should
1567 /// also emit a warning due to the `force-warn` flag. In all other cases this should
1569 Warning(Option
<LintExpectationId
>),
1571 /// A note that is only emitted once.
1576 Expect(LintExpectationId
),
1579 impl fmt
::Display
for Level
{
1580 fn fmt(&self, f
: &mut fmt
::Formatter
<'_
>) -> fmt
::Result
{
1581 self.to_str().fmt(f
)
1586 fn color(self) -> ColorSpec
{
1587 let mut spec
= ColorSpec
::new();
1589 Bug
| DelayedBug
| Fatal
| Error { .. }
=> {
1590 spec
.set_fg(Some(Color
::Red
)).set_intense(true);
1593 spec
.set_fg(Some(Color
::Yellow
)).set_intense(cfg
!(windows
));
1595 Note
| OnceNote
=> {
1596 spec
.set_fg(Some(Color
::Green
)).set_intense(true);
1599 spec
.set_fg(Some(Color
::Cyan
)).set_intense(true);
1602 Allow
| Expect(_
) => unreachable
!(),
1607 pub fn to_str(self) -> &'
static str {
1609 Bug
| DelayedBug
=> "error: internal compiler error",
1610 Fatal
| Error { .. }
=> "error",
1611 Warning(_
) => "warning",
1612 Note
| OnceNote
=> "note",
1614 FailureNote
=> "failure-note",
1615 Allow
=> panic
!("Shouldn't call on allowed error"),
1616 Expect(_
) => panic
!("Shouldn't call on expected error"),
1620 pub fn is_failure_note(&self) -> bool
{
1621 matches
!(*self, FailureNote
)
1624 pub fn get_expectation_id(&self) -> Option
<LintExpectationId
> {
1626 Level
::Expect(id
) | Level
::Warning(Some(id
)) => Some(*id
),
1632 // FIXME(eddyb) this doesn't belong here AFAICT, should be moved to callsite.
1633 pub fn add_elided_lifetime_in_path_suggestion(
1634 source_map
: &SourceMap
,
1635 diag
: &mut Diagnostic
,
1638 incl_angl_brckt
: bool
,
1639 insertion_span
: Span
,
1641 diag
.span_label(path_span
, format
!("expected lifetime parameter{}", pluralize
!(n
)));
1642 if !source_map
.is_span_accessible(insertion_span
) {
1643 // Do not try to suggest anything if generated by a proc-macro.
1646 let anon_lts
= vec
!["'_"; n
].join(", ");
1648 if incl_angl_brckt { format!("<{}
>", anon_lts) } else { format!("{}, ", anon_lts
) };
1649 diag
.span_suggestion_verbose(
1650 insertion_span
.shrink_to_hi(),
1651 &format
!("indicate the anonymous lifetime{}", pluralize
!(n
)),
1653 Applicability
::MachineApplicable
,
1657 /// Useful type to use with `Result<>` indicate that an error has already
1658 /// been reported to the user, so no need to continue checking.
1659 #[derive(Clone, Copy, Debug, Encodable, Decodable, Hash, PartialEq, Eq, PartialOrd, Ord)]
1660 #[derive(HashStable_Generic)]
1661 pub struct ErrorGuaranteed(());
1663 impl ErrorGuaranteed
{
1664 /// To be used only if you really know what you are doing... ideally, we would find a way to
1665 /// eliminate all calls to this method.
1666 pub fn unchecked_claim_error_was_emitted() -> Self {