clippy_lints/src/shadow.rs

   1 use clippy_utils::diagnostics::span_lint_and_note;
   2 use clippy_utils::source::snippet;
   3 use clippy_utils::visitors::is_local_used;
   4 use rustc_data_structures::fx::FxHashMap;
   5 use rustc_hir::def::Res;
   6 use rustc_hir::def_id::LocalDefId;
   7 use rustc_hir::hir_id::ItemLocalId;
   8 use rustc_hir::{Block, Body, BodyOwnerKind, Expr, ExprKind, HirId, Let, Node, Pat, PatKind, QPath, UnOp};
   9 use rustc_lint::{LateContext, LateLintPass};
  10 use rustc_session::{declare_tool_lint, impl_lint_pass};
  11 use rustc_span::{Span, Symbol};
  12
  13 declare_clippy_lint! {
  14     /// ### What it does
  15     /// Checks for bindings that shadow other bindings already in
  16     /// scope, while just changing reference level or mutability.
  17     ///
  18     /// ### Why is this bad?
  19     /// Not much, in fact it's a very common pattern in Rust
  20     /// code. Still, some may opt to avoid it in their code base, they can set this
  21     /// lint to `Warn`.
  22     ///
  23     /// ### Example
  24     /// ```rust
  25     /// # let x = 1;
  26     /// // Bad
  27     /// let x = &x;
  28     ///
  29     /// // Good
  30     /// let y = &x; // use different variable name
  31     /// ```
  32     #[clippy::version = "pre 1.29.0"]
  33     pub SHADOW_SAME,
  34     restriction,
  35     "rebinding a name to itself, e.g., `let mut x = &mut x`"
  36 }
  37
  38 declare_clippy_lint! {
  39     /// ### What it does
  40     /// Checks for bindings that shadow other bindings already in
  41     /// scope, while reusing the original value.
  42     ///
  43     /// ### Why is this bad?
  44     /// Not too much, in fact it's a common pattern in Rust
  45     /// code. Still, some argue that name shadowing like this hurts readability,
  46     /// because a value may be bound to different things depending on position in
  47     /// the code.
  48     ///
  49     /// ### Example
  50     /// ```rust
  51     /// let x = 2;
  52     /// let x = x + 1;
  53     /// ```
  54     /// use different variable name:
  55     /// ```rust
  56     /// let x = 2;
  57     /// let y = x + 1;
  58     /// ```
  59     #[clippy::version = "pre 1.29.0"]
  60     pub SHADOW_REUSE,
  61     restriction,
  62     "rebinding a name to an expression that re-uses the original value, e.g., `let x = x + 1`"
  63 }
  64
  65 declare_clippy_lint! {
  66     /// ### What it does
  67     /// Checks for bindings that shadow other bindings already in
  68     /// scope, either without an initialization or with one that does not even use
  69     /// the original value.
  70     ///
  71     /// ### Why is this bad?
  72     /// Name shadowing can hurt readability, especially in
  73     /// large code bases, because it is easy to lose track of the active binding at
  74     /// any place in the code. This can be alleviated by either giving more specific
  75     /// names to bindings or introducing more scopes to contain the bindings.
  76     ///
  77     /// ### Example
  78     /// ```rust
  79     /// # let y = 1;
  80     /// # let z = 2;
  81     /// let x = y;
  82     ///
  83     /// // Bad
  84     /// let x = z; // shadows the earlier binding
  85     ///
  86     /// // Good
  87     /// let w = z; // use different variable name
  88     /// ```
  89     #[clippy::version = "pre 1.29.0"]
  90     pub SHADOW_UNRELATED,
  91     restriction,
  92     "rebinding a name without even using the original value"
  93 }
  94
  95 #[derive(Default)]
  96 pub(crate) struct Shadow {
  97     bindings: Vec<FxHashMap<Symbol, Vec<ItemLocalId>>>,
  98 }
  99
 100 impl_lint_pass!(Shadow => [SHADOW_SAME, SHADOW_REUSE, SHADOW_UNRELATED]);
 101
 102 impl<'tcx> LateLintPass<'tcx> for Shadow {
 103     fn check_pat(&mut self, cx: &LateContext<'tcx>, pat: &'tcx Pat<'_>) {
 104         let (id, ident) = match pat.kind {
 105             PatKind::Binding(_, hir_id, ident, _) => (hir_id, ident),
 106             _ => return,
 107         };
 108
 109         if pat.span.desugaring_kind().is_some() {
 110             return;
 111         }
 112
 113         if ident.span.from_expansion() || ident.span.is_dummy() {
 114             return;
 115         }
 116
 117         let HirId { owner, local_id } = id;
 118         // get (or insert) the list of items for this owner and symbol
 119         let data = self.bindings.last_mut().unwrap();
 120         let items_with_name = data.entry(ident.name).or_default();
 121
 122         // check other bindings with the same name, most recently seen first
 123         for &prev in items_with_name.iter().rev() {
 124             if prev == local_id {
 125                 // repeated binding in an `Or` pattern
 126                 return;
 127             }
 128
 129             if is_shadow(cx, owner, prev, local_id) {
 130                 let prev_hir_id = HirId { owner, local_id: prev };
 131                 lint_shadow(cx, pat, prev_hir_id, ident.span);
 132                 // only lint against the "nearest" shadowed binding
 133                 break;
 134             }
 135         }
 136         // store the binding
 137         items_with_name.push(local_id);
 138     }
 139
 140     fn check_body(&mut self, cx: &LateContext<'_>, body: &Body<'_>) {
 141         let hir = cx.tcx.hir();
 142         if !matches!(
 143             hir.body_owner_kind(hir.body_owner_def_id(body.id())),
 144             BodyOwnerKind::Closure
 145         ) {
 146             self.bindings.push(FxHashMap::default());
 147         }
 148     }
 149
 150     fn check_body_post(&mut self, cx: &LateContext<'_>, body: &Body<'_>) {
 151         let hir = cx.tcx.hir();
 152         if !matches!(
 153             hir.body_owner_kind(hir.body_owner_def_id(body.id())),
 154             BodyOwnerKind::Closure
 155         ) {
 156             self.bindings.pop();
 157         }
 158     }
 159 }
 160
 161 fn is_shadow(cx: &LateContext<'_>, owner: LocalDefId, first: ItemLocalId, second: ItemLocalId) -> bool {
 162     let scope_tree = cx.tcx.region_scope_tree(owner.to_def_id());
 163     if let Some(first_scope) = scope_tree.var_scope(first) {
 164         if let Some(second_scope) = scope_tree.var_scope(second) {
 165             return scope_tree.is_subscope_of(second_scope, first_scope);
 166         }
 167     }
 168
 169     false
 170 }
 171
 172 fn lint_shadow(cx: &LateContext<'_>, pat: &Pat<'_>, shadowed: HirId, span: Span) {
 173     let (lint, msg) = match find_init(cx, pat.hir_id) {
 174         Some(expr) if is_self_shadow(cx, pat, expr, shadowed) => {
 175             let msg = format!(
 176                 "`{}` is shadowed by itself in `{}`",
 177                 snippet(cx, pat.span, "_"),
 178                 snippet(cx, expr.span, "..")
 179             );
 180             (SHADOW_SAME, msg)
 181         },
 182         Some(expr) if is_local_used(cx, expr, shadowed) => {
 183             let msg = format!("`{}` is shadowed", snippet(cx, pat.span, "_"));
 184             (SHADOW_REUSE, msg)
 185         },
 186         _ => {
 187             let msg = format!("`{}` shadows a previous, unrelated binding", snippet(cx, pat.span, "_"));
 188             (SHADOW_UNRELATED, msg)
 189         },
 190     };
 191     span_lint_and_note(
 192         cx,
 193         lint,
 194         span,
 195         &msg,
 196         Some(cx.tcx.hir().span(shadowed)),
 197         "previous binding is here",
 198     );
 199 }
 200
 201 /// Returns true if the expression is a simple transformation of a local binding such as `&x`
 202 fn is_self_shadow(cx: &LateContext<'_>, pat: &Pat<'_>, mut expr: &Expr<'_>, hir_id: HirId) -> bool {
 203     let hir = cx.tcx.hir();
 204     let is_direct_binding = hir
 205         .parent_iter(pat.hir_id)
 206         .map_while(|(_id, node)| match node {
 207             Node::Pat(pat) => Some(pat),
 208             _ => None,
 209         })
 210         .all(|pat| matches!(pat.kind, PatKind::Ref(..) | PatKind::Or(_)));
 211     if !is_direct_binding {
 212         return false;
 213     }
 214     loop {
 215         expr = match expr.kind {
 216             ExprKind::Box(e)
 217             | ExprKind::AddrOf(_, _, e)
 218             | ExprKind::Block(
 219                 &Block {
 220                     stmts: [],
 221                     expr: Some(e),
 222                     ..
 223                 },
 224                 _,
 225             )
 226             | ExprKind::Unary(UnOp::Deref, e) => e,
 227             ExprKind::Path(QPath::Resolved(None, path)) => break path.res == Res::Local(hir_id),
 228             _ => break false,
 229         }
 230     }
 231 }
 232
 233 /// Finds the "init" expression for a pattern: `let <pat> = <init>;` (or `if let`) or
 234 /// `match <init> { .., <pat> => .., .. }`
 235 fn find_init<'tcx>(cx: &LateContext<'tcx>, hir_id: HirId) -> Option<&'tcx Expr<'tcx>> {
 236     for (_, node) in cx.tcx.hir().parent_iter(hir_id) {
 237         let init = match node {
 238             Node::Arm(_) | Node::Pat(_) => continue,
 239             Node::Expr(expr) => match expr.kind {
 240                 ExprKind::Match(e, _, _) | ExprKind::Let(&Let { init: e, .. }) => Some(e),
 241                 _ => None,
 242             },
 243             Node::Local(local) => local.init,
 244             _ => None,
 245         };
 246         return init;
 247     }
 248     None
 249 }