clippy_lints/src/copies.rs

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