1 //! Implementation of lint checking.
3 //! The lint checking is mostly consolidated into one pass which runs
4 //! after all other analyses. Throughout compilation, lint warnings
5 //! can be added via the `add_lint` method on the Session structure. This
6 //! requires a span and an ID of the node that the lint is being added to. The
7 //! lint isn't actually emitted at that time because it is unknown what the
8 //! actual lint level at that location is.
10 //! To actually emit lint warnings/errors, a separate pass is used.
11 //! A context keeps track of the current state of all lint levels.
12 //! Upon entering a node of the ast which can modify the lint settings, the
13 //! previous lint state is pushed onto a stack and the ast is then recursed
14 //! upon. As the ast is traversed, this keeps track of the current lint level
15 //! for all lint attributes.
17 use self::TargetLint::*;
20 CheckNameDeprecated, CheckNameUnknown, CheckNameUnknownTool, CheckNameWarning, RequestedLevel,
23 use crate::levels::LintLevelsBuilder;
24 use crate::passes::{EarlyLintPassObject, LateLintPassObject};
25 use rustc_ast::util::unicode::TEXT_FLOW_CONTROL_CHARS;
26 use rustc_data_structures::fx::FxHashMap;
27 use rustc_data_structures::sync;
28 use rustc_errors::{add_elided_lifetime_in_path_suggestion, DiagnosticBuilder, DiagnosticMessage};
29 use rustc_errors::{Applicability, DecorateLint, MultiSpan, SuggestionStyle};
31 use rustc_hir::def::Res;
32 use rustc_hir::def_id::{CrateNum, DefId};
33 use rustc_hir::definitions::{DefPathData, DisambiguatedDefPathData};
34 use rustc_middle::middle::privacy::EffectiveVisibilities;
35 use rustc_middle::middle::stability;
36 use rustc_middle::ty::layout::{LayoutError, LayoutOfHelpers, TyAndLayout};
37 use rustc_middle::ty::print::with_no_trimmed_paths;
38 use rustc_middle::ty::{self, print::Printer, subst::GenericArg, RegisteredTools, Ty, TyCtxt};
39 use rustc_session::lint::{BuiltinLintDiagnostics, LintExpectationId};
40 use rustc_session::lint::{FutureIncompatibleInfo, Level, Lint, LintBuffer, LintId};
41 use rustc_session::Session;
42 use rustc_span::lev_distance::find_best_match_for_name;
43 use rustc_span::symbol::{sym, Ident, Symbol};
44 use rustc_span::{BytePos, Span};
45 use rustc_target::abi;
51 type EarlyLintPassFactory = dyn Fn() -> EarlyLintPassObject + sync::Send + sync::Sync;
52 type LateLintPassFactory =
53 dyn for<'tcx> Fn(TyCtxt<'tcx>) -> LateLintPassObject<'tcx> + sync::Send + sync::Sync;
55 /// Information about the registered lints.
57 /// This is basically the subset of `Context` that we can
58 /// build early in the compile pipeline.
59 pub struct LintStore {
61 lints: Vec<&'static Lint>,
63 /// Constructor functions for each variety of lint pass.
65 /// These should only be called once, but since we want to avoid locks or
66 /// interior mutability, we don't enforce this (and lints should, in theory,
67 /// be compatible with being constructed more than once, though not
68 /// necessarily in a sane manner. This is safe though.)
69 pub pre_expansion_passes: Vec<Box<EarlyLintPassFactory>>,
70 pub early_passes: Vec<Box<EarlyLintPassFactory>>,
71 pub late_passes: Vec<Box<LateLintPassFactory>>,
72 /// This is unique in that we construct them per-module, so not once.
73 pub late_module_passes: Vec<Box<LateLintPassFactory>>,
75 /// Lints indexed by name.
76 by_name: FxHashMap<String, TargetLint>,
78 /// Map of registered lint groups to what lints they expand to.
79 lint_groups: FxHashMap<&'static str, LintGroup>,
82 /// The target of the `by_name` map, which accounts for renaming/deprecation.
85 /// A direct lint target
88 /// Temporary renaming, used for easing migration pain; see #16545
89 Renamed(String, LintId),
91 /// Lint with this name existed previously, but has been removed/deprecated.
92 /// The string argument is the reason for removal.
95 /// A lint name that should give no warnings and have no effect.
97 /// This is used by rustc to avoid warning about old rustdoc lints before rustdoc registers them as tool lints.
101 pub enum FindLintError {
108 /// Whether deprecation warnings should be suppressed for this alias.
113 lint_ids: Vec<LintId>,
115 depr: Option<LintAlias>,
119 pub enum CheckLintNameResult<'a> {
121 /// Lint doesn't exist. Potentially contains a suggestion for a correct lint name.
122 NoLint(Option<Symbol>),
123 /// The lint refers to a tool that has not been registered.
125 /// The lint is either renamed or removed. This is the warning
126 /// message, and an optional new name (`None` if removed).
127 Warning(String, Option<String>),
128 /// The lint is from a tool. If the Option is None, then either
129 /// the lint does not exist in the tool or the code was not
130 /// compiled with the tool and therefore the lint was never
131 /// added to the `LintStore`. Otherwise the `LintId` will be
132 /// returned as if it where a rustc lint.
133 Tool(Result<&'a [LintId], (Option<&'a [LintId]>, String)>),
137 pub fn new() -> LintStore {
140 pre_expansion_passes: vec![],
141 early_passes: vec![],
143 late_module_passes: vec![],
144 by_name: Default::default(),
145 lint_groups: Default::default(),
149 pub fn get_lints<'t>(&'t self) -> &'t [&'static Lint] {
153 pub fn get_lint_groups<'t>(
155 ) -> impl Iterator<Item = (&'static str, Vec<LintId>, bool)> + 't {
156 // This function is not used in a way which observes the order of lints.
157 #[allow(rustc::potential_query_instability)]
160 .filter(|(_, LintGroup { depr, .. })| {
161 // Don't display deprecated lint groups.
164 .map(|(k, LintGroup { lint_ids, from_plugin, .. })| {
165 (*k, lint_ids.clone(), *from_plugin)
169 pub fn register_early_pass(
171 pass: impl Fn() -> EarlyLintPassObject + 'static + sync::Send + sync::Sync,
173 self.early_passes.push(Box::new(pass));
176 /// This lint pass is softly deprecated. It misses expanded code and has caused a few
177 /// errors in the past. Currently, it is only used in Clippy. New implementations
178 /// should avoid using this interface, as it might be removed in the future.
180 /// * See [rust#69838](https://github.com/rust-lang/rust/pull/69838)
181 /// * See [rust-clippy#5518](https://github.com/rust-lang/rust-clippy/pull/5518)
182 pub fn register_pre_expansion_pass(
184 pass: impl Fn() -> EarlyLintPassObject + 'static + sync::Send + sync::Sync,
186 self.pre_expansion_passes.push(Box::new(pass));
189 pub fn register_late_pass(
191 pass: impl for<'tcx> Fn(TyCtxt<'tcx>) -> LateLintPassObject<'tcx>
196 self.late_passes.push(Box::new(pass));
199 pub fn register_late_mod_pass(
201 pass: impl for<'tcx> Fn(TyCtxt<'tcx>) -> LateLintPassObject<'tcx>
206 self.late_module_passes.push(Box::new(pass));
209 /// Helper method for register_early/late_pass
210 pub fn register_lints(&mut self, lints: &[&'static Lint]) {
212 self.lints.push(lint);
214 let id = LintId::of(lint);
215 if self.by_name.insert(lint.name_lower(), Id(id)).is_some() {
216 bug!("duplicate specification of lint {}", lint.name_lower())
219 if let Some(FutureIncompatibleInfo { reason, .. }) = lint.future_incompatible {
220 if let Some(edition) = reason.edition() {
222 .entry(edition.lint_name())
223 .or_insert(LintGroup {
225 from_plugin: lint.is_plugin,
231 // Lints belonging to the `future_incompatible` lint group are lints where a
232 // future version of rustc will cause existing code to stop compiling.
233 // Lints tied to an edition don't count because they are opt-in.
235 .entry("future_incompatible")
236 .or_insert(LintGroup {
238 from_plugin: lint.is_plugin,
248 pub fn register_group_alias(&mut self, lint_name: &'static str, alias: &'static str) {
249 self.lint_groups.insert(
254 depr: Some(LintAlias { name: lint_name, silent: true }),
259 pub fn register_group(
263 deprecated_name: Option<&'static str>,
268 .insert(name, LintGroup { lint_ids: to, from_plugin, depr: None })
270 if let Some(deprecated) = deprecated_name {
271 self.lint_groups.insert(
276 depr: Some(LintAlias { name, silent: false }),
282 bug!("duplicate specification of lint group {}", name);
286 /// This lint should give no warning and have no effect.
288 /// This is used by rustc to avoid warning about old rustdoc lints before rustdoc registers them as tool lints.
290 pub fn register_ignored(&mut self, name: &str) {
291 if self.by_name.insert(name.to_string(), Ignored).is_some() {
292 bug!("duplicate specification of lint {}", name);
296 /// This lint has been renamed; warn about using the new name and apply the lint.
298 pub fn register_renamed(&mut self, old_name: &str, new_name: &str) {
299 let Some(&Id(target)) = self.by_name.get(new_name) else {
300 bug!("invalid lint renaming of {} to {}", old_name, new_name);
302 self.by_name.insert(old_name.to_string(), Renamed(new_name.to_string(), target));
305 pub fn register_removed(&mut self, name: &str, reason: &str) {
306 self.by_name.insert(name.into(), Removed(reason.into()));
309 pub fn find_lints(&self, mut lint_name: &str) -> Result<Vec<LintId>, FindLintError> {
310 match self.by_name.get(lint_name) {
311 Some(&Id(lint_id)) => Ok(vec![lint_id]),
312 Some(&Renamed(_, lint_id)) => Ok(vec![lint_id]),
313 Some(&Removed(_)) => Err(FindLintError::Removed),
314 Some(&Ignored) => Ok(vec![]),
316 return match self.lint_groups.get(lint_name) {
317 Some(LintGroup { lint_ids, depr, .. }) => {
318 if let Some(LintAlias { name, .. }) = depr {
324 None => Err(FindLintError::Removed),
330 /// Checks the validity of lint names derived from the command line.
331 pub fn check_lint_name_cmdline(
336 registered_tools: &RegisteredTools,
338 let (tool_name, lint_name_only) = parse_lint_and_tool_name(lint_name);
339 if lint_name_only == crate::WARNINGS.name_lower() && matches!(level, Level::ForceWarn(_)) {
340 sess.emit_err(UnsupportedGroup { lint_group: crate::WARNINGS.name_lower() });
343 let lint_name = lint_name.to_string();
344 match self.check_lint_name(lint_name_only, tool_name, registered_tools) {
345 CheckLintNameResult::Warning(msg, _) => {
346 sess.emit_warning(CheckNameWarning {
348 sub: RequestedLevel { level, lint_name },
351 CheckLintNameResult::NoLint(suggestion) => {
352 sess.emit_err(CheckNameUnknown {
353 lint_name: lint_name.clone(),
355 sub: RequestedLevel { level, lint_name },
358 CheckLintNameResult::Tool(Err((Some(_), new_name))) => {
359 sess.emit_warning(CheckNameDeprecated {
360 lint_name: lint_name.clone(),
362 sub: RequestedLevel { level, lint_name },
365 CheckLintNameResult::NoTool => {
366 sess.emit_err(CheckNameUnknownTool {
367 tool_name: tool_name.unwrap(),
368 sub: RequestedLevel { level, lint_name },
375 /// True if this symbol represents a lint group name.
376 pub fn is_lint_group(&self, lint_name: Symbol) -> bool {
378 "is_lint_group(lint_name={:?}, lint_groups={:?})",
380 self.lint_groups.keys().collect::<Vec<_>>()
382 let lint_name_str = lint_name.as_str();
383 self.lint_groups.contains_key(lint_name_str) || {
384 let warnings_name_str = crate::WARNINGS.name_lower();
385 lint_name_str == warnings_name_str
389 /// Checks the name of a lint for its existence, and whether it was
390 /// renamed or removed. Generates a DiagnosticBuilder containing a
391 /// warning for renamed and removed lints. This is over both lint
392 /// names from attributes and those passed on the command line. Since
393 /// it emits non-fatal warnings and there are *two* lint passes that
394 /// inspect attributes, this is only run from the late pass to avoid
395 /// printing duplicate warnings.
396 pub fn check_lint_name(
399 tool_name: Option<Symbol>,
400 registered_tools: &RegisteredTools,
401 ) -> CheckLintNameResult<'_> {
402 if let Some(tool_name) = tool_name {
403 // FIXME: rustc and rustdoc are considered tools for lints, but not for attributes.
404 if tool_name != sym::rustc
405 && tool_name != sym::rustdoc
406 && !registered_tools.contains(&Ident::with_dummy_span(tool_name))
408 return CheckLintNameResult::NoTool;
412 let complete_name = if let Some(tool_name) = tool_name {
413 format!("{}::{}", tool_name, lint_name)
415 lint_name.to_string()
417 // If the lint was scoped with `tool::` check if the tool lint exists
418 if let Some(tool_name) = tool_name {
419 match self.by_name.get(&complete_name) {
420 None => match self.lint_groups.get(&*complete_name) {
421 // If the lint isn't registered, there are two possibilities:
423 // 1. The tool is currently running, so this lint really doesn't exist.
424 // FIXME: should this handle tools that never register a lint, like rustfmt?
425 debug!("lints={:?}", self.by_name.keys().collect::<Vec<_>>());
426 let tool_prefix = format!("{}::", tool_name);
427 return if self.by_name.keys().any(|lint| lint.starts_with(&tool_prefix)) {
428 self.no_lint_suggestion(&complete_name)
430 // 2. The tool isn't currently running, so no lints will be registered.
431 // To avoid giving a false positive, ignore all unknown lints.
432 CheckLintNameResult::Tool(Err((None, String::new())))
435 Some(LintGroup { lint_ids, .. }) => {
436 return CheckLintNameResult::Tool(Ok(&lint_ids));
439 Some(Id(id)) => return CheckLintNameResult::Tool(Ok(slice::from_ref(id))),
440 // If the lint was registered as removed or renamed by the lint tool, we don't need
441 // to treat tool_lints and rustc lints different and can use the code below.
445 match self.by_name.get(&complete_name) {
446 Some(Renamed(new_name, _)) => CheckLintNameResult::Warning(
447 format!("lint `{}` has been renamed to `{}`", complete_name, new_name),
448 Some(new_name.to_owned()),
450 Some(Removed(reason)) => CheckLintNameResult::Warning(
451 format!("lint `{}` has been removed: {}", complete_name, reason),
454 None => match self.lint_groups.get(&*complete_name) {
455 // If neither the lint, nor the lint group exists check if there is a `clippy::`
456 // variant of this lint
457 None => self.check_tool_name_for_backwards_compat(&complete_name, "clippy"),
458 Some(LintGroup { lint_ids, depr, .. }) => {
459 // Check if the lint group name is deprecated
460 if let Some(LintAlias { name, silent }) = depr {
461 let LintGroup { lint_ids, .. } = self.lint_groups.get(name).unwrap();
463 CheckLintNameResult::Ok(&lint_ids)
465 CheckLintNameResult::Tool(Err((Some(&lint_ids), (*name).to_string())))
468 CheckLintNameResult::Ok(&lint_ids)
471 Some(Id(id)) => CheckLintNameResult::Ok(slice::from_ref(id)),
472 Some(&Ignored) => CheckLintNameResult::Ok(&[]),
476 fn no_lint_suggestion(&self, lint_name: &str) -> CheckLintNameResult<'_> {
477 let name_lower = lint_name.to_lowercase();
479 if lint_name.chars().any(char::is_uppercase) && self.find_lints(&name_lower).is_ok() {
480 // First check if the lint name is (partly) in upper case instead of lower case...
481 return CheckLintNameResult::NoLint(Some(Symbol::intern(&name_lower)));
483 // ...if not, search for lints with a similar name
484 // Note: find_best_match_for_name depends on the sort order of its input vector.
485 // To ensure deterministic output, sort elements of the lint_groups hash map.
486 // Also, never suggest deprecated lint groups.
487 let mut groups: Vec<_> = self
490 .filter_map(|(k, LintGroup { depr, .. })| if depr.is_none() { Some(k) } else { None })
493 let groups = groups.iter().map(|k| Symbol::intern(k));
494 let lints = self.lints.iter().map(|l| Symbol::intern(&l.name_lower()));
495 let names: Vec<Symbol> = groups.chain(lints).collect();
496 let suggestion = find_best_match_for_name(&names, Symbol::intern(&name_lower), None);
497 CheckLintNameResult::NoLint(suggestion)
500 fn check_tool_name_for_backwards_compat(
504 ) -> CheckLintNameResult<'_> {
505 let complete_name = format!("{}::{}", tool_name, lint_name);
506 match self.by_name.get(&complete_name) {
507 None => match self.lint_groups.get(&*complete_name) {
508 // Now we are sure, that this lint exists nowhere
509 None => self.no_lint_suggestion(lint_name),
510 Some(LintGroup { lint_ids, depr, .. }) => {
511 // Reaching this would be weird, but let's cover this case anyway
512 if let Some(LintAlias { name, silent }) = depr {
513 let LintGroup { lint_ids, .. } = self.lint_groups.get(name).unwrap();
515 CheckLintNameResult::Tool(Err((Some(&lint_ids), complete_name)))
517 CheckLintNameResult::Tool(Err((Some(&lint_ids), (*name).to_string())))
520 CheckLintNameResult::Tool(Err((Some(&lint_ids), complete_name)))
524 CheckLintNameResult::Tool(Err((Some(slice::from_ref(id)), complete_name)))
527 debug!("got renamed lint {:?}", other);
528 CheckLintNameResult::NoLint(None)
534 /// Context for lint checking outside of type inference.
535 pub struct LateContext<'tcx> {
536 /// Type context we're checking in.
537 pub tcx: TyCtxt<'tcx>,
539 /// Current body, or `None` if outside a body.
540 pub enclosing_body: Option<hir::BodyId>,
542 /// Type-checking results for the current body. Access using the `typeck_results`
543 /// and `maybe_typeck_results` methods, which handle querying the typeck results on demand.
544 // FIXME(eddyb) move all the code accessing internal fields like this,
545 // to this module, to avoid exposing it to lint logic.
546 pub(super) cached_typeck_results: Cell<Option<&'tcx ty::TypeckResults<'tcx>>>,
548 /// Parameter environment for the item we are in.
549 pub param_env: ty::ParamEnv<'tcx>,
551 /// Items accessible from the crate being checked.
552 pub effective_visibilities: &'tcx EffectiveVisibilities,
554 /// The store of registered lints and the lint levels.
555 pub lint_store: &'tcx LintStore,
557 pub last_node_with_lint_attrs: hir::HirId,
559 /// Generic type parameters in scope for the item we are in.
560 pub generics: Option<&'tcx hir::Generics<'tcx>>,
562 /// We are only looking at one module
563 pub only_module: bool,
566 /// Context for lint checking of the AST, after expansion, before lowering to HIR.
567 pub struct EarlyContext<'a> {
568 pub builder: LintLevelsBuilder<'a, crate::levels::TopDown>,
569 pub buffered: LintBuffer,
572 pub trait LintPassObject: Sized {}
574 impl LintPassObject for EarlyLintPassObject {}
576 impl LintPassObject for LateLintPassObject<'_> {}
578 pub trait LintContext: Sized {
579 type PassObject: LintPassObject;
581 fn sess(&self) -> &Session;
582 fn lints(&self) -> &LintStore;
584 /// Emit a lint at the appropriate level, with an optional associated span and an existing diagnostic.
586 /// Return value of the `decorate` closure is ignored, see [`struct_lint_level`] for a detailed explanation.
588 /// [`struct_lint_level`]: rustc_middle::lint::struct_lint_level#decorate-signature
589 #[rustc_lint_diagnostics]
590 fn lookup_with_diagnostics(
593 span: Option<impl Into<MultiSpan>>,
594 msg: impl Into<DiagnosticMessage>,
595 decorate: impl for<'a, 'b> FnOnce(
596 &'b mut DiagnosticBuilder<'a, ()>,
597 ) -> &'b mut DiagnosticBuilder<'a, ()>,
598 diagnostic: BuiltinLintDiagnostics,
600 // We first generate a blank diagnostic.
601 self.lookup(lint, span, msg,|db| {
602 // Now, set up surrounding context.
603 let sess = self.sess();
605 BuiltinLintDiagnostics::UnicodeTextFlow(span, content) => {
606 let spans: Vec<_> = content
608 .filter_map(|(i, c)| {
609 TEXT_FLOW_CONTROL_CHARS.contains(&c).then(|| {
610 let lo = span.lo() + BytePos(2 + i as u32);
611 (c, span.with_lo(lo).with_hi(lo + BytePos(c.len_utf8() as u32)))
615 let (an, s) = match spans.len() {
619 db.span_label(span, &format!(
620 "this comment contains {}invisible unicode text flow control codepoint{}",
624 for (c, span) in &spans {
625 db.span_label(*span, format!("{:?}", c));
628 "these kind of unicode codepoints change the way text flows on \
629 applications that support them, but can cause confusion because they \
630 change the order of characters on the screen",
632 if !spans.is_empty() {
633 db.multipart_suggestion_with_style(
634 "if their presence wasn't intentional, you can remove them",
635 spans.into_iter().map(|(_, span)| (span, "".to_string())).collect(),
636 Applicability::MachineApplicable,
637 SuggestionStyle::HideCodeAlways,
641 BuiltinLintDiagnostics::Normal => (),
642 BuiltinLintDiagnostics::AbsPathWithModule(span) => {
643 let (sugg, app) = match sess.source_map().span_to_snippet(span) {
645 // FIXME(Manishearth) ideally the emitting code
646 // can tell us whether or not this is global
648 if s.trim_start().starts_with("::") { "" } else { "::" };
650 (format!("crate{}{}", opt_colon, s), Applicability::MachineApplicable)
652 Err(_) => ("crate::<path>".to_string(), Applicability::HasPlaceholders),
654 db.span_suggestion(span, "use `crate`", sugg, app);
656 BuiltinLintDiagnostics::ProcMacroDeriveResolutionFallback(span) => {
659 "names from parent modules are not accessible without an explicit import",
662 BuiltinLintDiagnostics::MacroExpandedMacroExportsAccessedByAbsolutePaths(
665 db.span_note(span_def, "the macro is defined here");
667 BuiltinLintDiagnostics::ElidedLifetimesInPaths(
673 add_elided_lifetime_in_path_suggestion(
682 BuiltinLintDiagnostics::UnknownCrateTypes(span, note, sugg) => {
683 db.span_suggestion(span, ¬e, sugg, Applicability::MaybeIncorrect);
685 BuiltinLintDiagnostics::UnusedImports(message, replaces, in_test_module) => {
686 if !replaces.is_empty() {
687 db.tool_only_multipart_suggestion(
690 Applicability::MachineApplicable,
694 if let Some(span) = in_test_module {
696 self.sess().source_map().guess_head_span(span),
697 "consider adding a `#[cfg(test)]` to the containing module",
701 BuiltinLintDiagnostics::RedundantImport(spans, ident) => {
702 for (span, is_imported) in spans {
703 let introduced = if is_imported { "imported" } else { "defined" };
706 format!("the item `{}` is already {} here", ident, introduced),
710 BuiltinLintDiagnostics::DeprecatedMacro(suggestion, span) => {
711 stability::deprecation_suggestion(db, "macro", suggestion, span)
713 BuiltinLintDiagnostics::UnusedDocComment(span) => {
714 db.span_label(span, "rustdoc does not generate documentation for macro invocations");
715 db.help("to document an item produced by a macro, \
716 the macro must produce the documentation as part of its expansion");
718 BuiltinLintDiagnostics::PatternsInFnsWithoutBody(span, ident) => {
719 db.span_suggestion(span, "remove `mut` from the parameter", ident, Applicability::MachineApplicable);
721 BuiltinLintDiagnostics::MissingAbi(span, default_abi) => {
722 db.span_label(span, "ABI should be specified here");
723 db.help(&format!("the default ABI is {}", default_abi.name()));
725 BuiltinLintDiagnostics::LegacyDeriveHelpers(span) => {
726 db.span_label(span, "the attribute is introduced here");
728 BuiltinLintDiagnostics::ProcMacroBackCompat(note) => {
731 BuiltinLintDiagnostics::OrPatternsBackCompat(span,suggestion) => {
732 db.span_suggestion(span, "use pat_param to preserve semantics", suggestion, Applicability::MachineApplicable);
734 BuiltinLintDiagnostics::ReservedPrefix(span) => {
735 db.span_label(span, "unknown prefix");
736 db.span_suggestion_verbose(
738 "insert whitespace here to avoid this being parsed as a prefix in Rust 2021",
740 Applicability::MachineApplicable,
743 BuiltinLintDiagnostics::UnusedBuiltinAttribute {
750 &format!("the built-in attribute `{attr_name}` will be ignored, since it's applied to the macro invocation `{macro_name}`")
753 BuiltinLintDiagnostics::TrailingMacro(is_trailing, name) => {
755 db.note("macro invocations at the end of a block are treated as expressions");
756 db.note(&format!("to ignore the value produced by the macro, add a semicolon after the invocation of `{name}`"));
759 BuiltinLintDiagnostics::BreakWithLabelAndLoop(span) => {
760 db.multipart_suggestion(
761 "wrap this expression in parentheses",
762 vec![(span.shrink_to_lo(), "(".to_string()),
763 (span.shrink_to_hi(), ")".to_string())],
764 Applicability::MachineApplicable
767 BuiltinLintDiagnostics::NamedAsmLabel(help) => {
769 db.note("see the asm section of Rust By Example <https://doc.rust-lang.org/nightly/rust-by-example/unsafe/asm.html#labels> for more information");
771 BuiltinLintDiagnostics::UnexpectedCfg((name, name_span), None) => {
772 let Some(names_valid) = &sess.parse_sess.check_config.names_valid else {
773 bug!("it shouldn't be possible to have a diagnostic on a name if name checking is not enabled");
775 let possibilities: Vec<Symbol> = names_valid.iter().map(|s| *s).collect();
777 // Suggest the most probable if we found one
778 if let Some(best_match) = find_best_match_for_name(&possibilities, name, None) {
779 db.span_suggestion(name_span, "did you mean", best_match, Applicability::MaybeIncorrect);
782 BuiltinLintDiagnostics::UnexpectedCfg((name, name_span), Some((value, value_span))) => {
783 let Some(values) = &sess.parse_sess.check_config.values_valid.get(&name) else {
784 bug!("it shouldn't be possible to have a diagnostic on a value whose name is not in values");
786 let possibilities: Vec<Symbol> = values.iter().map(|&s| s).collect();
788 // Show the full list if all possible values for a given name, but don't do it
789 // for names as the possibilities could be very long
790 if !possibilities.is_empty() {
792 let mut possibilities = possibilities.iter().map(Symbol::as_str).collect::<Vec<_>>();
793 possibilities.sort();
795 let possibilities = possibilities.join(", ");
796 db.note(&format!("expected values for `{name}` are: {possibilities}"));
799 // Suggest the most probable if we found one
800 if let Some(best_match) = find_best_match_for_name(&possibilities, value, None) {
801 db.span_suggestion(value_span, "did you mean", format!("\"{best_match}\""), Applicability::MaybeIncorrect);
804 db.note(&format!("no expected value for `{name}`"));
805 if name != sym::feature {
806 db.span_suggestion(name_span.shrink_to_hi().to(value_span), "remove the value", "", Applicability::MaybeIncorrect);
810 BuiltinLintDiagnostics::DeprecatedWhereclauseLocation(new_span, suggestion) => {
811 db.multipart_suggestion(
812 "move it to the end of the type declaration",
813 vec![(db.span.primary_span().unwrap(), "".to_string()), (new_span, suggestion)],
814 Applicability::MachineApplicable,
817 "see issue #89122 <https://github.com/rust-lang/rust/issues/89122> for more information",
820 BuiltinLintDiagnostics::SingleUseLifetime {
822 use_span: Some((use_span, elide)),
825 debug!(?param_span, ?use_span, ?deletion_span);
826 db.span_label(param_span, "this lifetime...");
827 db.span_label(use_span, "...is used only here");
828 let msg = "elide the single-use lifetime";
829 let (use_span, replace_lt) = if elide {
830 let use_span = sess.source_map().span_extend_while(
833 ).unwrap_or(use_span);
834 (use_span, String::new())
836 (use_span, "'_".to_owned())
838 db.multipart_suggestion(
840 vec![(deletion_span, String::new()), (use_span, replace_lt)],
841 Applicability::MachineApplicable,
844 BuiltinLintDiagnostics::SingleUseLifetime {
849 debug!(?deletion_span);
852 "elide the unused lifetime",
854 Applicability::MachineApplicable,
857 BuiltinLintDiagnostics::NamedArgumentUsedPositionally{ position_sp_to_replace, position_sp_for_msg, named_arg_sp, named_arg_name, is_formatting_arg} => {
858 db.span_label(named_arg_sp, "this named argument is referred to by position in formatting string");
859 if let Some(positional_arg_for_msg) = position_sp_for_msg {
860 let msg = format!("this formatting argument uses named argument `{}` by position", named_arg_name);
861 db.span_label(positional_arg_for_msg, msg);
864 if let Some(positional_arg_to_replace) = position_sp_to_replace {
865 let name = if is_formatting_arg { named_arg_name + "$" } else { named_arg_name };
866 let span_to_replace = if let Ok(positional_arg_content) =
867 self.sess().source_map().span_to_snippet(positional_arg_to_replace) && positional_arg_content.starts_with(':') {
868 positional_arg_to_replace.shrink_to_lo()
870 positional_arg_to_replace
872 db.span_suggestion_verbose(
874 "use the named argument by name to avoid ambiguity",
876 Applicability::MaybeIncorrect,
881 // Rewrap `db`, and pass control to the user.
886 // FIXME: These methods should not take an Into<MultiSpan> -- instead, callers should need to
887 // set the span in their `decorate` function (preferably using set_span).
888 /// Emit a lint at the appropriate level, with an optional associated span.
890 /// Return value of the `decorate` closure is ignored, see [`struct_lint_level`] for a detailed explanation.
892 /// [`struct_lint_level`]: rustc_middle::lint::struct_lint_level#decorate-signature
893 #[rustc_lint_diagnostics]
894 fn lookup<S: Into<MultiSpan>>(
898 msg: impl Into<DiagnosticMessage>,
899 decorate: impl for<'a, 'b> FnOnce(
900 &'b mut DiagnosticBuilder<'a, ()>,
901 ) -> &'b mut DiagnosticBuilder<'a, ()>,
904 /// Emit a lint at `span` from a lint struct (some type that implements `DecorateLint`,
905 /// typically generated by `#[derive(LintDiagnostic)]`).
906 fn emit_spanned_lint<S: Into<MultiSpan>>(
910 decorator: impl for<'a> DecorateLint<'a, ()>,
912 self.lookup(lint, Some(span), decorator.msg(), |diag| decorator.decorate_lint(diag));
915 /// Emit a lint at the appropriate level, with an associated span.
917 /// Return value of the `decorate` closure is ignored, see [`struct_lint_level`] for a detailed explanation.
919 /// [`struct_lint_level`]: rustc_middle::lint::struct_lint_level#decorate-signature
920 #[rustc_lint_diagnostics]
921 fn struct_span_lint<S: Into<MultiSpan>>(
925 msg: impl Into<DiagnosticMessage>,
926 decorate: impl for<'a, 'b> FnOnce(
927 &'b mut DiagnosticBuilder<'a, ()>,
928 ) -> &'b mut DiagnosticBuilder<'a, ()>,
930 self.lookup(lint, Some(span), msg, decorate);
933 /// Emit a lint from a lint struct (some type that implements `DecorateLint`, typically
934 /// generated by `#[derive(LintDiagnostic)]`).
935 fn emit_lint(&self, lint: &'static Lint, decorator: impl for<'a> DecorateLint<'a, ()>) {
936 self.lookup(lint, None as Option<Span>, decorator.msg(), |diag| {
937 decorator.decorate_lint(diag)
941 /// Emit a lint at the appropriate level, with no associated span.
943 /// Return value of the `decorate` closure is ignored, see [`struct_lint_level`] for a detailed explanation.
945 /// [`struct_lint_level`]: rustc_middle::lint::struct_lint_level#decorate-signature
946 #[rustc_lint_diagnostics]
950 msg: impl Into<DiagnosticMessage>,
951 decorate: impl for<'a, 'b> FnOnce(
952 &'b mut DiagnosticBuilder<'a, ()>,
953 ) -> &'b mut DiagnosticBuilder<'a, ()>,
955 self.lookup(lint, None as Option<Span>, msg, decorate);
958 /// This returns the lint level for the given lint at the current location.
959 fn get_lint_level(&self, lint: &'static Lint) -> Level;
961 /// This function can be used to manually fulfill an expectation. This can
962 /// be used for lints which contain several spans, and should be suppressed,
963 /// if either location was marked with an expectation.
965 /// Note that this function should only be called for [`LintExpectationId`]s
966 /// retrieved from the current lint pass. Buffered or manually created ids can
968 #[rustc_lint_diagnostics]
969 fn fulfill_expectation(&self, expectation: LintExpectationId) {
970 // We need to make sure that submitted expectation ids are correctly fulfilled suppressed
971 // and stored between compilation sessions. To not manually do these steps, we simply create
972 // a dummy diagnostic and emit is as usual, which will be suppressed and stored like a normal
973 // expected lint diagnostic.
976 "this is a dummy diagnostic, to submit and store an expectation",
983 impl<'a> EarlyContext<'a> {
986 warn_about_weird_lints: bool,
987 lint_store: &'a LintStore,
988 registered_tools: &'a RegisteredTools,
989 buffered: LintBuffer,
990 ) -> EarlyContext<'a> {
992 builder: LintLevelsBuilder::new(
994 warn_about_weird_lints,
1003 impl<'tcx> LintContext for LateContext<'tcx> {
1004 type PassObject = LateLintPassObject<'tcx>;
1006 /// Gets the overall compiler `Session` object.
1007 fn sess(&self) -> &Session {
1011 fn lints(&self) -> &LintStore {
1015 #[rustc_lint_diagnostics]
1016 fn lookup<S: Into<MultiSpan>>(
1018 lint: &'static Lint,
1020 msg: impl Into<DiagnosticMessage>,
1021 decorate: impl for<'a, 'b> FnOnce(
1022 &'b mut DiagnosticBuilder<'a, ()>,
1023 ) -> &'b mut DiagnosticBuilder<'a, ()>,
1025 let hir_id = self.last_node_with_lint_attrs;
1028 Some(s) => self.tcx.struct_span_lint_hir(lint, hir_id, s, msg, decorate),
1029 None => self.tcx.struct_lint_node(lint, hir_id, msg, decorate),
1033 fn get_lint_level(&self, lint: &'static Lint) -> Level {
1034 self.tcx.lint_level_at_node(lint, self.last_node_with_lint_attrs).0
1038 impl LintContext for EarlyContext<'_> {
1039 type PassObject = EarlyLintPassObject;
1041 /// Gets the overall compiler `Session` object.
1042 fn sess(&self) -> &Session {
1043 &self.builder.sess()
1046 fn lints(&self) -> &LintStore {
1047 self.builder.lint_store()
1050 #[rustc_lint_diagnostics]
1051 fn lookup<S: Into<MultiSpan>>(
1053 lint: &'static Lint,
1055 msg: impl Into<DiagnosticMessage>,
1056 decorate: impl for<'a, 'b> FnOnce(
1057 &'b mut DiagnosticBuilder<'a, ()>,
1058 ) -> &'b mut DiagnosticBuilder<'a, ()>,
1060 self.builder.struct_lint(lint, span.map(|s| s.into()), msg, decorate)
1063 fn get_lint_level(&self, lint: &'static Lint) -> Level {
1064 self.builder.lint_level(lint).0
1068 impl<'tcx> LateContext<'tcx> {
1069 /// Gets the type-checking results for the current body,
1070 /// or `None` if outside a body.
1071 pub fn maybe_typeck_results(&self) -> Option<&'tcx ty::TypeckResults<'tcx>> {
1072 self.cached_typeck_results.get().or_else(|| {
1073 self.enclosing_body.map(|body| {
1074 let typeck_results = self.tcx.typeck_body(body);
1075 self.cached_typeck_results.set(Some(typeck_results));
1081 /// Gets the type-checking results for the current body.
1082 /// As this will ICE if called outside bodies, only call when working with
1083 /// `Expr` or `Pat` nodes (they are guaranteed to be found only in bodies).
1085 pub fn typeck_results(&self) -> &'tcx ty::TypeckResults<'tcx> {
1086 self.maybe_typeck_results().expect("`LateContext::typeck_results` called outside of body")
1089 /// Returns the final resolution of a `QPath`, or `Res::Err` if unavailable.
1090 /// Unlike `.typeck_results().qpath_res(qpath, id)`, this can be used even outside
1091 /// bodies (e.g. for paths in `hir::Ty`), without any risk of ICE-ing.
1092 pub fn qpath_res(&self, qpath: &hir::QPath<'_>, id: hir::HirId) -> Res {
1094 hir::QPath::Resolved(_, ref path) => path.res,
1095 hir::QPath::TypeRelative(..) | hir::QPath::LangItem(..) => self
1096 .maybe_typeck_results()
1097 .filter(|typeck_results| typeck_results.hir_owner == id.owner)
1099 if self.tcx.has_typeck_results(id.owner.to_def_id()) {
1100 Some(self.tcx.typeck(id.owner.def_id))
1105 .and_then(|typeck_results| typeck_results.type_dependent_def(id))
1106 .map_or(Res::Err, |(kind, def_id)| Res::Def(kind, def_id)),
1110 /// Check if a `DefId`'s path matches the given absolute type path usage.
1112 /// Anonymous scopes such as `extern` imports are matched with `kw::Empty`;
1113 /// inherent `impl` blocks are matched with the name of the type.
1115 /// Instead of using this method, it is often preferable to instead use
1116 /// `rustc_diagnostic_item` or a `lang_item`. This is less prone to errors
1117 /// as paths get invalidated if the target definition moves.
1121 /// ```rust,ignore (no context or def id available)
1122 /// if cx.match_def_path(def_id, &[sym::core, sym::option, sym::Option]) {
1123 /// // The given `def_id` is that of an `Option` type
1127 /// Used by clippy, but should be replaced by diagnostic items eventually.
1128 pub fn match_def_path(&self, def_id: DefId, path: &[Symbol]) -> bool {
1129 let names = self.get_def_path(def_id);
1131 names.len() == path.len() && iter::zip(names, path).all(|(a, &b)| a == b)
1134 /// Gets the absolute path of `def_id` as a vector of `Symbol`.
1138 /// ```rust,ignore (no context or def id available)
1139 /// let def_path = cx.get_def_path(def_id);
1140 /// if let &[sym::core, sym::option, sym::Option] = &def_path[..] {
1141 /// // The given `def_id` is that of an `Option` type
1144 pub fn get_def_path(&self, def_id: DefId) -> Vec<Symbol> {
1145 pub struct AbsolutePathPrinter<'tcx> {
1146 pub tcx: TyCtxt<'tcx>,
1149 impl<'tcx> Printer<'tcx> for AbsolutePathPrinter<'tcx> {
1152 type Path = Vec<Symbol>;
1155 type DynExistential = ();
1158 fn tcx(&self) -> TyCtxt<'tcx> {
1162 fn print_region(self, _region: ty::Region<'_>) -> Result<Self::Region, Self::Error> {
1166 fn print_type(self, _ty: Ty<'tcx>) -> Result<Self::Type, Self::Error> {
1170 fn print_dyn_existential(
1172 _predicates: &'tcx ty::List<ty::PolyExistentialPredicate<'tcx>>,
1173 ) -> Result<Self::DynExistential, Self::Error> {
1177 fn print_const(self, _ct: ty::Const<'tcx>) -> Result<Self::Const, Self::Error> {
1181 fn path_crate(self, cnum: CrateNum) -> Result<Self::Path, Self::Error> {
1182 Ok(vec![self.tcx.crate_name(cnum)])
1188 trait_ref: Option<ty::TraitRef<'tcx>>,
1189 ) -> Result<Self::Path, Self::Error> {
1190 if trait_ref.is_none() {
1191 if let ty::Adt(def, substs) = self_ty.kind() {
1192 return self.print_def_path(def.did(), substs);
1196 // This shouldn't ever be needed, but just in case:
1197 with_no_trimmed_paths!({
1198 Ok(vec![match trait_ref {
1199 Some(trait_ref) => Symbol::intern(&format!("{:?}", trait_ref)),
1200 None => Symbol::intern(&format!("<{}>", self_ty)),
1205 fn path_append_impl(
1207 print_prefix: impl FnOnce(Self) -> Result<Self::Path, Self::Error>,
1208 _disambiguated_data: &DisambiguatedDefPathData,
1210 trait_ref: Option<ty::TraitRef<'tcx>>,
1211 ) -> Result<Self::Path, Self::Error> {
1212 let mut path = print_prefix(self)?;
1214 // This shouldn't ever be needed, but just in case:
1215 path.push(match trait_ref {
1216 Some(trait_ref) => {
1217 with_no_trimmed_paths!(Symbol::intern(&format!(
1219 trait_ref.print_only_trait_path(),
1224 with_no_trimmed_paths!(Symbol::intern(&format!("<impl {}>", self_ty)))
1233 print_prefix: impl FnOnce(Self) -> Result<Self::Path, Self::Error>,
1234 disambiguated_data: &DisambiguatedDefPathData,
1235 ) -> Result<Self::Path, Self::Error> {
1236 let mut path = print_prefix(self)?;
1238 // Skip `::{{extern}}` blocks and `::{{constructor}}` on tuple/unit structs.
1239 if let DefPathData::ForeignMod | DefPathData::Ctor = disambiguated_data.data {
1243 path.push(Symbol::intern(&disambiguated_data.data.to_string()));
1247 fn path_generic_args(
1249 print_prefix: impl FnOnce(Self) -> Result<Self::Path, Self::Error>,
1250 _args: &[GenericArg<'tcx>],
1251 ) -> Result<Self::Path, Self::Error> {
1256 AbsolutePathPrinter { tcx: self.tcx }.print_def_path(def_id, &[]).unwrap()
1259 /// Returns the associated type `name` for `self_ty` as an implementation of `trait_id`.
1260 /// Do not invoke without first verifying that the type implements the trait.
1261 pub fn get_associated_type(
1266 ) -> Option<Ty<'tcx>> {
1268 tcx.associated_items(trait_id)
1269 .find_by_name_and_kind(tcx, Ident::from_str(name), ty::AssocKind::Type, trait_id)
1271 let proj = tcx.mk_projection(assoc.def_id, [self_ty]);
1272 tcx.try_normalize_erasing_regions(self.param_env, proj).ok()
1277 impl<'tcx> abi::HasDataLayout for LateContext<'tcx> {
1279 fn data_layout(&self) -> &abi::TargetDataLayout {
1280 &self.tcx.data_layout
1284 impl<'tcx> ty::layout::HasTyCtxt<'tcx> for LateContext<'tcx> {
1286 fn tcx(&self) -> TyCtxt<'tcx> {
1291 impl<'tcx> ty::layout::HasParamEnv<'tcx> for LateContext<'tcx> {
1293 fn param_env(&self) -> ty::ParamEnv<'tcx> {
1298 impl<'tcx> LayoutOfHelpers<'tcx> for LateContext<'tcx> {
1299 type LayoutOfResult = Result<TyAndLayout<'tcx>, LayoutError<'tcx>>;
1302 fn handle_layout_err(&self, err: LayoutError<'tcx>, _: Span, _: Ty<'tcx>) -> LayoutError<'tcx> {
1307 pub fn parse_lint_and_tool_name(lint_name: &str) -> (Option<Symbol>, &str) {
1308 match lint_name.split_once("::") {
1309 Some((tool_name, lint_name)) => {
1310 let tool_name = Symbol::intern(tool_name);
1312 (Some(tool_name), lint_name)
1314 None => (None, lint_name),