clippy_lints/src/shadow.rs

   1 use crate::reexport::*;
   2 use crate::utils::{contains_name, higher, iter_input_pats, snippet, span_lint_and_then};
   3 use rustc::hir::intravisit::FnKind;
   4 use rustc::hir::*;
   5 use rustc::lint::{in_external_macro, LateContext, LateLintPass, LintArray, LintContext, LintPass};
   6 use rustc::ty;
   7 use rustc::{declare_tool_lint, lint_array};
   8 use syntax::source_map::Span;
   9
  10 /// **What it does:** Checks for bindings that shadow other bindings already in
  11 /// scope, while just changing reference level or mutability.
  12 ///
  13 /// **Why is this bad?** Not much, in fact it's a very common pattern in Rust
  14 /// code. Still, some may opt to avoid it in their code base, they can set this
  15 /// lint to `Warn`.
  16 ///
  17 /// **Known problems:** This lint, as the other shadowing related lints,
  18 /// currently only catches very simple patterns.
  19 ///
  20 /// **Example:**
  21 /// ```rust
  22 /// let x = &x;
  23 /// ```
  24 declare_clippy_lint! {
  25     pub SHADOW_SAME,
  26     restriction,
  27     "rebinding a name to itself, e.g. `let mut x = &mut x`"
  28 }
  29
  30 /// **What it does:** Checks for bindings that shadow other bindings already in
  31 /// scope, while reusing the original value.
  32 ///
  33 /// **Why is this bad?** Not too much, in fact it's a common pattern in Rust
  34 /// code. Still, some argue that name shadowing like this hurts readability,
  35 /// because a value may be bound to different things depending on position in
  36 /// the code.
  37 ///
  38 /// **Known problems:** This lint, as the other shadowing related lints,
  39 /// currently only catches very simple patterns.
  40 ///
  41 /// **Example:**
  42 /// ```rust
  43 /// let x = x + 1;
  44 /// ```
  45 /// use different variable name:
  46 /// ```rust
  47 /// let y = x + 1;
  48 /// ```
  49 declare_clippy_lint! {
  50     pub SHADOW_REUSE,
  51     restriction,
  52     "rebinding a name to an expression that re-uses the original value, e.g. `let x = x + 1`"
  53 }
  54
  55 /// **What it does:** Checks for bindings that shadow other bindings already in
  56 /// scope, either without a initialization or with one that does not even use
  57 /// the original value.
  58 ///
  59 /// **Why is this bad?** Name shadowing can hurt readability, especially in
  60 /// large code bases, because it is easy to lose track of the active binding at
  61 /// any place in the code. This can be alleviated by either giving more specific
  62 /// names to bindings or introducing more scopes to contain the bindings.
  63 ///
  64 /// **Known problems:** This lint, as the other shadowing related lints,
  65 /// currently only catches very simple patterns.
  66 ///
  67 /// **Example:**
  68 /// ```rust
  69 /// let x = y;
  70 /// let x = z; // shadows the earlier binding
  71 /// ```
  72 declare_clippy_lint! {
  73     pub SHADOW_UNRELATED,
  74     pedantic,
  75     "rebinding a name without even using the original value"
  76 }
  77
  78 #[derive(Copy, Clone)]
  79 pub struct Pass;
  80
  81 impl LintPass for Pass {
  82     fn get_lints(&self) -> LintArray {
  83         lint_array!(SHADOW_SAME, SHADOW_REUSE, SHADOW_UNRELATED)
  84     }
  85 }
  86
  87 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for Pass {
  88     fn check_fn(
  89         &mut self,
  90         cx: &LateContext<'a, 'tcx>,
  91         _: FnKind<'tcx>,
  92         decl: &'tcx FnDecl,
  93         body: &'tcx Body,
  94         _: Span,
  95         _: NodeId,
  96     ) {
  97         if in_external_macro(cx.sess(), body.value.span) {
  98             return;
  99         }
 100         check_fn(cx, decl, body);
 101     }
 102 }
 103
 104 fn check_fn<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, decl: &'tcx FnDecl, body: &'tcx Body) {
 105     let mut bindings = Vec::new();
 106     for arg in iter_input_pats(decl, body) {
 107         if let PatKind::Binding(_, _, ident, _) = arg.pat.node {
 108             bindings.push((ident.name, ident.span))
 109         }
 110     }
 111     check_expr(cx, &body.value, &mut bindings);
 112 }
 113
 114 fn check_block<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, block: &'tcx Block, bindings: &mut Vec<(Name, Span)>) {
 115     let len = bindings.len();
 116     for stmt in &block.stmts {
 117         match stmt.node {
 118             StmtKind::Local(ref local) => check_local(cx, local, bindings),
 119             StmtKind::Expr(ref e) | StmtKind::Semi(ref e) => check_expr(cx, e, bindings),
 120             StmtKind::Item(..) => {},
 121         }
 122     }
 123     if let Some(ref o) = block.expr {
 124         check_expr(cx, o, bindings);
 125     }
 126     bindings.truncate(len);
 127 }
 128
 129 fn check_local<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, local: &'tcx Local, bindings: &mut Vec<(Name, Span)>) {
 130     if in_external_macro(cx.sess(), local.span) {
 131         return;
 132     }
 133     if higher::is_from_for_desugar(local) {
 134         return;
 135     }
 136         let Local {
 137             ref pat,
 138             ref ty,
 139             ref init,
 140             span,
 141             ..
 142         } = *local;
 143         if let Some(ref t) = *ty {
 144             check_ty(cx, t, bindings)
 145         }
 146         if let Some(ref o) = *init {
 147             check_expr(cx, o, bindings);
 148             check_pat(cx, pat, Some(o), span, bindings);
 149         } else {
 150             check_pat(cx, pat, None, span, bindings);
 151         }
 152 }
 153
 154 fn is_binding(cx: &LateContext<'_, '_>, pat_id: HirId) -> bool {
 155     let var_ty = cx.tables.node_id_to_type(pat_id);
 156     match var_ty.sty {
 157         ty::Adt(..) => false,
 158         _ => true,
 159     }
 160 }
 161
 162 fn check_pat<'a, 'tcx>(
 163     cx: &LateContext<'a, 'tcx>,
 164     pat: &'tcx Pat,
 165     init: Option<&'tcx Expr>,
 166     span: Span,
 167     bindings: &mut Vec<(Name, Span)>,
 168 ) {
 169     // TODO: match more stuff / destructuring
 170     match pat.node {
 171         PatKind::Binding(_, _, ident, ref inner) => {
 172             let name = ident.name;
 173             if is_binding(cx, pat.hir_id) {
 174                 let mut new_binding = true;
 175                 for tup in bindings.iter_mut() {
 176                     if tup.0 == name {
 177                         lint_shadow(cx, name, span, pat.span, init, tup.1);
 178                         tup.1 = ident.span;
 179                         new_binding = false;
 180                         break;
 181                     }
 182                 }
 183                 if new_binding {
 184                     bindings.push((name, ident.span));
 185                 }
 186             }
 187             if let Some(ref p) = *inner {
 188                 check_pat(cx, p, init, span, bindings);
 189             }
 190         },
 191         PatKind::Struct(_, ref pfields, _) => {
 192             if let Some(init_struct) = init {
 193                 if let ExprKind::Struct(_, ref efields, _) = init_struct.node {
 194                     for field in pfields {
 195                         let name = field.node.ident.name;
 196                         let efield = efields.iter().find(|f| f.ident.name == name).map(|f| &*f.expr);
 197                         check_pat(cx, &field.node.pat, efield, span, bindings);
 198                     }
 199                 } else {
 200                     for field in pfields {
 201                         check_pat(cx, &field.node.pat, init, span, bindings);
 202                     }
 203                 }
 204             } else {
 205                 for field in pfields {
 206                     check_pat(cx, &field.node.pat, None, span, bindings);
 207                 }
 208             }
 209         },
 210         PatKind::Tuple(ref inner, _) => {
 211             if let Some(init_tup) = init {
 212                 if let ExprKind::Tup(ref tup) = init_tup.node {
 213                     for (i, p) in inner.iter().enumerate() {
 214                         check_pat(cx, p, Some(&tup[i]), p.span, bindings);
 215                     }
 216                 } else {
 217                     for p in inner {
 218                         check_pat(cx, p, init, span, bindings);
 219                     }
 220                 }
 221             } else {
 222                 for p in inner {
 223                     check_pat(cx, p, None, span, bindings);
 224                 }
 225             }
 226         },
 227         PatKind::Box(ref inner) => {
 228             if let Some(initp) = init {
 229                 if let ExprKind::Box(ref inner_init) = initp.node {
 230                     check_pat(cx, inner, Some(&**inner_init), span, bindings);
 231                 } else {
 232                     check_pat(cx, inner, init, span, bindings);
 233                 }
 234             } else {
 235                 check_pat(cx, inner, init, span, bindings);
 236             }
 237         },
 238         PatKind::Ref(ref inner, _) => check_pat(cx, inner, init, span, bindings),
 239         // PatVec(Vec<P<Pat>>, Option<P<Pat>>, Vec<P<Pat>>),
 240         _ => (),
 241     }
 242 }
 243
 244 fn lint_shadow<'a, 'tcx: 'a>(
 245     cx: &LateContext<'a, 'tcx>,
 246     name: Name,
 247     span: Span,
 248     pattern_span: Span,
 249     init: Option<&'tcx Expr>,
 250     prev_span: Span,
 251 ) {
 252     if let Some(expr) = init {
 253         if is_self_shadow(name, expr) {
 254             span_lint_and_then(
 255                 cx,
 256                 SHADOW_SAME,
 257                 span,
 258                 &format!(
 259                     "`{}` is shadowed by itself in `{}`",
 260                     snippet(cx, pattern_span, "_"),
 261                     snippet(cx, expr.span, "..")
 262                 ),
 263                 |db| {
 264                     db.span_note(prev_span, "previous binding is here");
 265                 },
 266             );
 267         } else if contains_name(name, expr) {
 268             span_lint_and_then(
 269                 cx,
 270                 SHADOW_REUSE,
 271                 pattern_span,
 272                 &format!(
 273                     "`{}` is shadowed by `{}` which reuses the original value",
 274                     snippet(cx, pattern_span, "_"),
 275                     snippet(cx, expr.span, "..")
 276                 ),
 277                 |db| {
 278                     db.span_note(expr.span, "initialization happens here");
 279                     db.span_note(prev_span, "previous binding is here");
 280                 },
 281             );
 282         } else {
 283             span_lint_and_then(
 284                 cx,
 285                 SHADOW_UNRELATED,
 286                 pattern_span,
 287                 &format!(
 288                     "`{}` is shadowed by `{}`",
 289                     snippet(cx, pattern_span, "_"),
 290                     snippet(cx, expr.span, "..")
 291                 ),
 292                 |db| {
 293                     db.span_note(expr.span, "initialization happens here");
 294                     db.span_note(prev_span, "previous binding is here");
 295                 },
 296             );
 297         }
 298     } else {
 299         span_lint_and_then(
 300             cx,
 301             SHADOW_UNRELATED,
 302             span,
 303             &format!("`{}` shadows a previous declaration", snippet(cx, pattern_span, "_")),
 304             |db| {
 305                 db.span_note(prev_span, "previous binding is here");
 306             },
 307         );
 308     }
 309 }
 310
 311 fn check_expr<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr, bindings: &mut Vec<(Name, Span)>) {
 312     if in_external_macro(cx.sess(), expr.span) {
 313         return;
 314     }
 315     match expr.node {
 316         ExprKind::Unary(_, ref e) | ExprKind::Field(ref e, _) | ExprKind::AddrOf(_, ref e) | ExprKind::Box(ref e) => {
 317             check_expr(cx, e, bindings)
 318         },
 319         ExprKind::Block(ref block, _) | ExprKind::Loop(ref block, _, _) => check_block(cx, block, bindings),
 320         // ExprKind::Call
 321         // ExprKind::MethodCall
 322         ExprKind::Array(ref v) | ExprKind::Tup(ref v) => {
 323             for e in v {
 324                 check_expr(cx, e, bindings)
 325             }
 326         },
 327         ExprKind::If(ref cond, ref then, ref otherwise) => {
 328             check_expr(cx, cond, bindings);
 329             check_expr(cx, &**then, bindings);
 330             if let Some(ref o) = *otherwise {
 331                 check_expr(cx, o, bindings);
 332             }
 333         },
 334         ExprKind::While(ref cond, ref block, _) => {
 335             check_expr(cx, cond, bindings);
 336             check_block(cx, block, bindings);
 337         },
 338         ExprKind::Match(ref init, ref arms, _) => {
 339             check_expr(cx, init, bindings);
 340             let len = bindings.len();
 341             for arm in arms {
 342                 for pat in &arm.pats {
 343                     check_pat(cx, pat, Some(&**init), pat.span, bindings);
 344                     // This is ugly, but needed to get the right type
 345                     if let Some(ref guard) = arm.guard {
 346                         match guard {
 347                             Guard::If(if_expr) => check_expr(cx, if_expr, bindings),
 348                         }
 349                     }
 350                     check_expr(cx, &arm.body, bindings);
 351                     bindings.truncate(len);
 352                 }
 353             }
 354         },
 355         _ => (),
 356     }
 357 }
 358
 359 fn check_ty<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, ty: &'tcx Ty, bindings: &mut Vec<(Name, Span)>) {
 360     match ty.node {
 361         TyKind::Slice(ref sty) => check_ty(cx, sty, bindings),
 362         TyKind::Array(ref fty, ref anon_const) => {
 363             check_ty(cx, fty, bindings);
 364             check_expr(cx, &cx.tcx.hir().body(anon_const.body).value, bindings);
 365         },
 366         TyKind::Ptr(MutTy { ty: ref mty, .. }) | TyKind::Rptr(_, MutTy { ty: ref mty, .. }) => {
 367             check_ty(cx, mty, bindings)
 368         },
 369         TyKind::Tup(ref tup) => {
 370             for t in tup {
 371                 check_ty(cx, t, bindings)
 372             }
 373         },
 374         TyKind::Typeof(ref anon_const) => check_expr(cx, &cx.tcx.hir().body(anon_const.body).value, bindings),
 375         _ => (),
 376     }
 377 }
 378
 379 fn is_self_shadow(name: Name, expr: &Expr) -> bool {
 380     match expr.node {
 381         ExprKind::Box(ref inner) | ExprKind::AddrOf(_, ref inner) => is_self_shadow(name, inner),
 382         ExprKind::Block(ref block, _) => {
 383             block.stmts.is_empty() && block.expr.as_ref().map_or(false, |e| is_self_shadow(name, e))
 384         },
 385         ExprKind::Unary(op, ref inner) => (UnDeref == op) && is_self_shadow(name, inner),
 386         ExprKind::Path(QPath::Resolved(_, ref path)) => path_eq_name(name, path),
 387         _ => false,
 388     }
 389 }
 390
 391 fn path_eq_name(name: Name, path: &Path) -> bool {
 392     !path.is_global() && path.segments.len() == 1 && path.segments[0].ident.as_str() == name.as_str()
 393 }