clippy_lints/src/copies.rs

   1 use crate::utils::{get_parent_expr, higher, if_sequence, same_tys, snippet, span_lint_and_then, span_note_and_lint};
   2 use crate::utils::{SpanlessEq, SpanlessHash};
   3 use rustc::declare_lint_pass;
   4 use rustc::hir::*;
   5 use rustc::lint::{LateContext, LateLintPass, LintArray, LintPass};
   6 use rustc::ty::Ty;
   7 use rustc_data_structures::fx::FxHashMap;
   8 use rustc_session::declare_tool_lint;
   9 use std::collections::hash_map::Entry;
  10 use std::hash::BuildHasherDefault;
  11 use syntax::symbol::Symbol;
  12
  13 declare_clippy_lint! {
  14     /// **What it does:** Checks for consecutive `if`s with the same condition.
  15     ///
  16     /// **Why is this bad?** This is probably a copy & paste error.
  17     ///
  18     /// **Known problems:** Hopefully none.
  19     ///
  20     /// **Example:**
  21     /// ```ignore
  22     /// if a == b {
  23     ///     …
  24     /// } else if a == b {
  25     ///     …
  26     /// }
  27     /// ```
  28     ///
  29     /// Note that this lint ignores all conditions with a function call as it could
  30     /// have side effects:
  31     ///
  32     /// ```ignore
  33     /// if foo() {
  34     ///     …
  35     /// } else if foo() { // not linted
  36     ///     …
  37     /// }
  38     /// ```
  39     pub IFS_SAME_COND,
  40     correctness,
  41     "consecutive `ifs` with the same condition"
  42 }
  43
  44 declare_clippy_lint! {
  45     /// **What it does:** Checks for consecutive `if`s with the same function call.
  46     ///
  47     /// **Why is this bad?** This is probably a copy & paste error.
  48     /// Despite the fact that function can have side effects and `if` works as
  49     /// intended, such an approach is implicit and can be considered a "code smell".
  50     ///
  51     /// **Known problems:** Hopefully none.
  52     ///
  53     /// **Example:**
  54     /// ```ignore
  55     /// if foo() == bar {
  56     ///     …
  57     /// } else if foo() == bar {
  58     ///     …
  59     /// }
  60     /// ```
  61     ///
  62     /// This probably should be:
  63     /// ```ignore
  64     /// if foo() == bar {
  65     ///     …
  66     /// } else if foo() == baz {
  67     ///     …
  68     /// }
  69     /// ```
  70     ///
  71     /// or if the original code was not a typo and called function mutates a state,
  72     /// consider move the mutation out of the `if` condition to avoid similarity to
  73     /// a copy & paste error:
  74     ///
  75     /// ```ignore
  76     /// let first = foo();
  77     /// if first == bar {
  78     ///     …
  79     /// } else {
  80     ///     let second = foo();
  81     ///     if second == bar {
  82     ///     …
  83     ///     }
  84     /// }
  85     /// ```
  86     pub SAME_FUNCTIONS_IN_IF_CONDITION,
  87     pedantic,
  88     "consecutive `ifs` with the same function call"
  89 }
  90
  91 declare_clippy_lint! {
  92     /// **What it does:** Checks for `if/else` with the same body as the *then* part
  93     /// and the *else* part.
  94     ///
  95     /// **Why is this bad?** This is probably a copy & paste error.
  96     ///
  97     /// **Known problems:** Hopefully none.
  98     ///
  99     /// **Example:**
 100     /// ```ignore
 101     /// let foo = if … {
 102     ///     42
 103     /// } else {
 104     ///     42
 105     /// };
 106     /// ```
 107     pub IF_SAME_THEN_ELSE,
 108     correctness,
 109     "if with the same *then* and *else* blocks"
 110 }
 111
 112 declare_clippy_lint! {
 113     /// **What it does:** Checks for `match` with identical arm bodies.
 114     ///
 115     /// **Why is this bad?** This is probably a copy & paste error. If arm bodies
 116     /// are the same on purpose, you can factor them
 117     /// [using `|`](https://doc.rust-lang.org/book/patterns.html#multiple-patterns).
 118     ///
 119     /// **Known problems:** False positive possible with order dependent `match`
 120     /// (see issue
 121     /// [#860](https://github.com/rust-lang/rust-clippy/issues/860)).
 122     ///
 123     /// **Example:**
 124     /// ```rust,ignore
 125     /// match foo {
 126     ///     Bar => bar(),
 127     ///     Quz => quz(),
 128     ///     Baz => bar(), // <= oops
 129     /// }
 130     /// ```
 131     ///
 132     /// This should probably be
 133     /// ```rust,ignore
 134     /// match foo {
 135     ///     Bar => bar(),
 136     ///     Quz => quz(),
 137     ///     Baz => baz(), // <= fixed
 138     /// }
 139     /// ```
 140     ///
 141     /// or if the original code was not a typo:
 142     /// ```rust,ignore
 143     /// match foo {
 144     ///     Bar | Baz => bar(), // <= shows the intent better
 145     ///     Quz => quz(),
 146     /// }
 147     /// ```
 148     pub MATCH_SAME_ARMS,
 149     pedantic,
 150     "`match` with identical arm bodies"
 151 }
 152
 153 declare_lint_pass!(CopyAndPaste => [IFS_SAME_COND, SAME_FUNCTIONS_IN_IF_CONDITION, IF_SAME_THEN_ELSE, MATCH_SAME_ARMS]);
 154
 155 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for CopyAndPaste {
 156     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
 157         if !expr.span.from_expansion() {
 158             // skip ifs directly in else, it will be checked in the parent if
 159             if let Some(expr) = get_parent_expr(cx, expr) {
 160                 if let Some((_, _, Some(ref else_expr))) = higher::if_block(&expr) {
 161                     if else_expr.hir_id == expr.hir_id {
 162                         return;
 163                     }
 164                 }
 165             }
 166
 167             let (conds, blocks) = if_sequence(expr);
 168             lint_same_then_else(cx, &blocks);
 169             lint_same_cond(cx, &conds);
 170             lint_same_fns_in_if_cond(cx, &conds);
 171             lint_match_arms(cx, expr);
 172         }
 173     }
 174 }
 175
 176 /// Implementation of `IF_SAME_THEN_ELSE`.
 177 fn lint_same_then_else(cx: &LateContext<'_, '_>, blocks: &[&Block]) {
 178     let eq: &dyn Fn(&&Block, &&Block) -> bool = &|&lhs, &rhs| -> bool { SpanlessEq::new(cx).eq_block(lhs, rhs) };
 179
 180     if let Some((i, j)) = search_same_sequenced(blocks, eq) {
 181         span_note_and_lint(
 182             cx,
 183             IF_SAME_THEN_ELSE,
 184             j.span,
 185             "this `if` has identical blocks",
 186             i.span,
 187             "same as this",
 188         );
 189     }
 190 }
 191
 192 /// Implementation of `IFS_SAME_COND`.
 193 fn lint_same_cond(cx: &LateContext<'_, '_>, conds: &[&Expr]) {
 194     let hash: &dyn Fn(&&Expr) -> u64 = &|expr| -> u64 {
 195         let mut h = SpanlessHash::new(cx, cx.tables);
 196         h.hash_expr(expr);
 197         h.finish()
 198     };
 199
 200     let eq: &dyn Fn(&&Expr, &&Expr) -> bool =
 201         &|&lhs, &rhs| -> bool { SpanlessEq::new(cx).ignore_fn().eq_expr(lhs, rhs) };
 202
 203     for (i, j) in search_same(conds, hash, eq) {
 204         span_note_and_lint(
 205             cx,
 206             IFS_SAME_COND,
 207             j.span,
 208             "this `if` has the same condition as a previous if",
 209             i.span,
 210             "same as this",
 211         );
 212     }
 213 }
 214
 215 /// Implementation of `SAME_FUNCTIONS_IN_IF_CONDITION`.
 216 fn lint_same_fns_in_if_cond(cx: &LateContext<'_, '_>, conds: &[&Expr]) {
 217     let hash: &dyn Fn(&&Expr) -> u64 = &|expr| -> u64 {
 218         let mut h = SpanlessHash::new(cx, cx.tables);
 219         h.hash_expr(expr);
 220         h.finish()
 221     };
 222
 223     let eq: &dyn Fn(&&Expr, &&Expr) -> bool = &|&lhs, &rhs| -> bool {
 224         // Do not spawn warning if `IFS_SAME_COND` already produced it.
 225         if SpanlessEq::new(cx).ignore_fn().eq_expr(lhs, rhs) {
 226             return false;
 227         }
 228         SpanlessEq::new(cx).eq_expr(lhs, rhs)
 229     };
 230
 231     for (i, j) in search_same(conds, hash, eq) {
 232         span_note_and_lint(
 233             cx,
 234             SAME_FUNCTIONS_IN_IF_CONDITION,
 235             j.span,
 236             "this `if` has the same function call as a previous if",
 237             i.span,
 238             "same as this",
 239         );
 240     }
 241 }
 242
 243 /// Implementation of `MATCH_SAME_ARMS`.
 244 fn lint_match_arms<'tcx>(cx: &LateContext<'_, 'tcx>, expr: &Expr) {
 245     fn same_bindings<'tcx>(
 246         cx: &LateContext<'_, 'tcx>,
 247         lhs: &FxHashMap<Symbol, Ty<'tcx>>,
 248         rhs: &FxHashMap<Symbol, Ty<'tcx>>,
 249     ) -> bool {
 250         lhs.len() == rhs.len()
 251             && lhs
 252                 .iter()
 253                 .all(|(name, l_ty)| rhs.get(name).map_or(false, |r_ty| same_tys(cx, l_ty, r_ty)))
 254     }
 255
 256     if let ExprKind::Match(_, ref arms, MatchSource::Normal) = expr.kind {
 257         let hash = |&(_, arm): &(usize, &Arm)| -> u64 {
 258             let mut h = SpanlessHash::new(cx, cx.tables);
 259             h.hash_expr(&arm.body);
 260             h.finish()
 261         };
 262
 263         let eq = |&(lindex, lhs): &(usize, &Arm), &(rindex, rhs): &(usize, &Arm)| -> bool {
 264             let min_index = usize::min(lindex, rindex);
 265             let max_index = usize::max(lindex, rindex);
 266
 267             // Arms with a guard are ignored, those can’t always be merged together
 268             // This is also the case for arms in-between each there is an arm with a guard
 269             (min_index..=max_index).all(|index| arms[index].guard.is_none()) &&
 270                 SpanlessEq::new(cx).eq_expr(&lhs.body, &rhs.body) &&
 271                 // all patterns should have the same bindings
 272                 same_bindings(cx, &bindings(cx, &lhs.pat), &bindings(cx, &rhs.pat))
 273         };
 274
 275         let indexed_arms: Vec<(usize, &Arm)> = arms.iter().enumerate().collect();
 276         for (&(_, i), &(_, j)) in search_same(&indexed_arms, hash, eq) {
 277             span_lint_and_then(
 278                 cx,
 279                 MATCH_SAME_ARMS,
 280                 j.body.span,
 281                 "this `match` has identical arm bodies",
 282                 |db| {
 283                     db.span_note(i.body.span, "same as this");
 284
 285                     // Note: this does not use `span_suggestion` on purpose:
 286                     // there is no clean way
 287                     // to remove the other arm. Building a span and suggest to replace it to ""
 288                     // makes an even more confusing error message. Also in order not to make up a
 289                     // span for the whole pattern, the suggestion is only shown when there is only
 290                     // one pattern. The user should know about `|` if they are already using it…
 291
 292                     let lhs = snippet(cx, i.pat.span, "<pat1>");
 293                     let rhs = snippet(cx, j.pat.span, "<pat2>");
 294
 295                     if let PatKind::Wild = j.pat.kind {
 296                         // if the last arm is _, then i could be integrated into _
 297                         // note that i.pat cannot be _, because that would mean that we're
 298                         // hiding all the subsequent arms, and rust won't compile
 299                         db.span_note(
 300                             i.body.span,
 301                             &format!(
 302                                 "`{}` has the same arm body as the `_` wildcard, consider removing it`",
 303                                 lhs
 304                             ),
 305                         );
 306                     } else {
 307                         db.span_help(i.pat.span, &format!("consider refactoring into `{} | {}`", lhs, rhs));
 308                     }
 309                 },
 310             );
 311         }
 312     }
 313 }
 314
 315 /// Returns the list of bindings in a pattern.
 316 fn bindings<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, pat: &Pat) -> FxHashMap<Symbol, Ty<'tcx>> {
 317     fn bindings_impl<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, pat: &Pat, map: &mut FxHashMap<Symbol, Ty<'tcx>>) {
 318         match pat.kind {
 319             PatKind::Box(ref pat) | PatKind::Ref(ref pat, _) => bindings_impl(cx, pat, map),
 320             PatKind::TupleStruct(_, ref pats, _) => {
 321                 for pat in pats {
 322                     bindings_impl(cx, pat, map);
 323                 }
 324             },
 325             PatKind::Binding(.., ident, ref as_pat) => {
 326                 if let Entry::Vacant(v) = map.entry(ident.name) {
 327                     v.insert(cx.tables.pat_ty(pat));
 328                 }
 329                 if let Some(ref as_pat) = *as_pat {
 330                     bindings_impl(cx, as_pat, map);
 331                 }
 332             },
 333             PatKind::Or(ref fields) | PatKind::Tuple(ref fields, _) => {
 334                 for pat in fields {
 335                     bindings_impl(cx, pat, map);
 336                 }
 337             },
 338             PatKind::Struct(_, ref fields, _) => {
 339                 for pat in fields {
 340                     bindings_impl(cx, &pat.pat, map);
 341                 }
 342             },
 343             PatKind::Slice(ref lhs, ref mid, ref rhs) => {
 344                 for pat in lhs {
 345                     bindings_impl(cx, pat, map);
 346                 }
 347                 if let Some(ref mid) = *mid {
 348                     bindings_impl(cx, mid, map);
 349                 }
 350                 for pat in rhs {
 351                     bindings_impl(cx, pat, map);
 352                 }
 353             },
 354             PatKind::Lit(..) | PatKind::Range(..) | PatKind::Wild | PatKind::Path(..) => (),
 355         }
 356     }
 357
 358     let mut result = FxHashMap::default();
 359     bindings_impl(cx, pat, &mut result);
 360     result
 361 }
 362
 363 fn search_same_sequenced<T, Eq>(exprs: &[T], eq: Eq) -> Option<(&T, &T)>
 364 where
 365     Eq: Fn(&T, &T) -> bool,
 366 {
 367     for win in exprs.windows(2) {
 368         if eq(&win[0], &win[1]) {
 369             return Some((&win[0], &win[1]));
 370         }
 371     }
 372     None
 373 }
 374
 375 fn search_common_cases<'a, T, Eq>(exprs: &'a [T], eq: &Eq) -> Option<(&'a T, &'a T)>
 376 where
 377     Eq: Fn(&T, &T) -> bool,
 378 {
 379     if exprs.len() == 2 && eq(&exprs[0], &exprs[1]) {
 380         Some((&exprs[0], &exprs[1]))
 381     } else {
 382         None
 383     }
 384 }
 385
 386 fn search_same<T, Hash, Eq>(exprs: &[T], hash: Hash, eq: Eq) -> Vec<(&T, &T)>
 387 where
 388     Hash: Fn(&T) -> u64,
 389     Eq: Fn(&T, &T) -> bool,
 390 {
 391     if let Some(expr) = search_common_cases(&exprs, &eq) {
 392         return vec![expr];
 393     }
 394
 395     let mut match_expr_list: Vec<(&T, &T)> = Vec::new();
 396
 397     let mut map: FxHashMap<_, Vec<&_>> =
 398         FxHashMap::with_capacity_and_hasher(exprs.len(), BuildHasherDefault::default());
 399
 400     for expr in exprs {
 401         match map.entry(hash(expr)) {
 402             Entry::Occupied(mut o) => {
 403                 for o in o.get() {
 404                     if eq(o, expr) {
 405                         match_expr_list.push((o, expr));
 406                     }
 407                 }
 408                 o.get_mut().push(expr);
 409             },
 410             Entry::Vacant(v) => {
 411                 v.insert(vec![expr]);
 412             },
 413         }
 414     }
 415
 416     match_expr_list
 417 }