clippy_lints/src/copies.rs

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