clippy_lints/src/matches.rs

   1 use crate::consts::{constant, miri_to_const, Constant};
   2 use crate::utils::sugg::Sugg;
   3 use crate::utils::usage::is_unused;
   4 use crate::utils::{
   5     expr_block, get_arg_name, get_parent_expr, implements_trait, in_macro, indent_of, is_allowed, is_expn_of,
   6     is_refutable, is_type_diagnostic_item, is_wild, match_qpath, match_type, match_var, meets_msrv, multispan_sugg,
   7     remove_blocks, snippet, snippet_block, snippet_opt, snippet_with_applicability, span_lint_and_help,
   8     span_lint_and_note, span_lint_and_sugg, span_lint_and_then,
   9 };
  10 use crate::utils::{paths, search_same, SpanlessEq, SpanlessHash};
  11 use if_chain::if_chain;
  12 use rustc_ast::ast::LitKind;
  13 use rustc_data_structures::fx::FxHashMap;
  14 use rustc_errors::Applicability;
  15 use rustc_hir::def::CtorKind;
  16 use rustc_hir::{
  17     Arm, BindingAnnotation, Block, BorrowKind, Expr, ExprKind, Guard, Local, MatchSource, Mutability, Node, Pat,
  18     PatKind, QPath, RangeEnd,
  19 };
  20 use rustc_lint::{LateContext, LateLintPass, LintContext};
  21 use rustc_middle::lint::in_external_macro;
  22 use rustc_middle::ty::{self, Ty, TyS};
  23 use rustc_semver::RustcVersion;
  24 use rustc_session::{declare_tool_lint, impl_lint_pass};
  25 use rustc_span::source_map::{Span, Spanned};
  26 use rustc_span::{sym, Symbol};
  27 use std::cmp::Ordering;
  28 use std::collections::hash_map::Entry;
  29 use std::collections::Bound;
  30
  31 declare_clippy_lint! {
  32     /// **What it does:** Checks for matches with a single arm where an `if let`
  33     /// will usually suffice.
  34     ///
  35     /// **Why is this bad?** Just readability – `if let` nests less than a `match`.
  36     ///
  37     /// **Known problems:** None.
  38     ///
  39     /// **Example:**
  40     /// ```rust
  41     /// # fn bar(stool: &str) {}
  42     /// # let x = Some("abc");
  43     /// // Bad
  44     /// match x {
  45     ///     Some(ref foo) => bar(foo),
  46     ///     _ => (),
  47     /// }
  48     ///
  49     /// // Good
  50     /// if let Some(ref foo) = x {
  51     ///     bar(foo);
  52     /// }
  53     /// ```
  54     pub SINGLE_MATCH,
  55     style,
  56     "a `match` statement with a single nontrivial arm (i.e., where the other arm is `_ => {}`) instead of `if let`"
  57 }
  58
  59 declare_clippy_lint! {
  60     /// **What it does:** Checks for matches with two arms where an `if let else` will
  61     /// usually suffice.
  62     ///
  63     /// **Why is this bad?** Just readability – `if let` nests less than a `match`.
  64     ///
  65     /// **Known problems:** Personal style preferences may differ.
  66     ///
  67     /// **Example:**
  68     ///
  69     /// Using `match`:
  70     ///
  71     /// ```rust
  72     /// # fn bar(foo: &usize) {}
  73     /// # let other_ref: usize = 1;
  74     /// # let x: Option<&usize> = Some(&1);
  75     /// match x {
  76     ///     Some(ref foo) => bar(foo),
  77     ///     _ => bar(&other_ref),
  78     /// }
  79     /// ```
  80     ///
  81     /// Using `if let` with `else`:
  82     ///
  83     /// ```rust
  84     /// # fn bar(foo: &usize) {}
  85     /// # let other_ref: usize = 1;
  86     /// # let x: Option<&usize> = Some(&1);
  87     /// if let Some(ref foo) = x {
  88     ///     bar(foo);
  89     /// } else {
  90     ///     bar(&other_ref);
  91     /// }
  92     /// ```
  93     pub SINGLE_MATCH_ELSE,
  94     pedantic,
  95     "a `match` statement with two arms where the second arm's pattern is a placeholder instead of a specific match pattern"
  96 }
  97
  98 declare_clippy_lint! {
  99     /// **What it does:** Checks for matches where all arms match a reference,
 100     /// suggesting to remove the reference and deref the matched expression
 101     /// instead. It also checks for `if let &foo = bar` blocks.
 102     ///
 103     /// **Why is this bad?** It just makes the code less readable. That reference
 104     /// destructuring adds nothing to the code.
 105     ///
 106     /// **Known problems:** None.
 107     ///
 108     /// **Example:**
 109     /// ```rust,ignore
 110     /// // Bad
 111     /// match x {
 112     ///     &A(ref y) => foo(y),
 113     ///     &B => bar(),
 114     ///     _ => frob(&x),
 115     /// }
 116     ///
 117     /// // Good
 118     /// match *x {
 119     ///     A(ref y) => foo(y),
 120     ///     B => bar(),
 121     ///     _ => frob(x),
 122     /// }
 123     /// ```
 124     pub MATCH_REF_PATS,
 125     style,
 126     "a `match` or `if let` with all arms prefixed with `&` instead of deref-ing the match expression"
 127 }
 128
 129 declare_clippy_lint! {
 130     /// **What it does:** Checks for matches where match expression is a `bool`. It
 131     /// suggests to replace the expression with an `if...else` block.
 132     ///
 133     /// **Why is this bad?** It makes the code less readable.
 134     ///
 135     /// **Known problems:** None.
 136     ///
 137     /// **Example:**
 138     /// ```rust
 139     /// # fn foo() {}
 140     /// # fn bar() {}
 141     /// let condition: bool = true;
 142     /// match condition {
 143     ///     true => foo(),
 144     ///     false => bar(),
 145     /// }
 146     /// ```
 147     /// Use if/else instead:
 148     /// ```rust
 149     /// # fn foo() {}
 150     /// # fn bar() {}
 151     /// let condition: bool = true;
 152     /// if condition {
 153     ///     foo();
 154     /// } else {
 155     ///     bar();
 156     /// }
 157     /// ```
 158     pub MATCH_BOOL,
 159     pedantic,
 160     "a `match` on a boolean expression instead of an `if..else` block"
 161 }
 162
 163 declare_clippy_lint! {
 164     /// **What it does:** Checks for overlapping match arms.
 165     ///
 166     /// **Why is this bad?** It is likely to be an error and if not, makes the code
 167     /// less obvious.
 168     ///
 169     /// **Known problems:** None.
 170     ///
 171     /// **Example:**
 172     /// ```rust
 173     /// let x = 5;
 174     /// match x {
 175     ///     1...10 => println!("1 ... 10"),
 176     ///     5...15 => println!("5 ... 15"),
 177     ///     _ => (),
 178     /// }
 179     /// ```
 180     pub MATCH_OVERLAPPING_ARM,
 181     style,
 182     "a `match` with overlapping arms"
 183 }
 184
 185 declare_clippy_lint! {
 186     /// **What it does:** Checks for arm which matches all errors with `Err(_)`
 187     /// and take drastic actions like `panic!`.
 188     ///
 189     /// **Why is this bad?** It is generally a bad practice, similar to
 190     /// catching all exceptions in java with `catch(Exception)`
 191     ///
 192     /// **Known problems:** None.
 193     ///
 194     /// **Example:**
 195     /// ```rust
 196     /// let x: Result<i32, &str> = Ok(3);
 197     /// match x {
 198     ///     Ok(_) => println!("ok"),
 199     ///     Err(_) => panic!("err"),
 200     /// }
 201     /// ```
 202     pub MATCH_WILD_ERR_ARM,
 203     pedantic,
 204     "a `match` with `Err(_)` arm and take drastic actions"
 205 }
 206
 207 declare_clippy_lint! {
 208     /// **What it does:** Checks for match which is used to add a reference to an
 209     /// `Option` value.
 210     ///
 211     /// **Why is this bad?** Using `as_ref()` or `as_mut()` instead is shorter.
 212     ///
 213     /// **Known problems:** None.
 214     ///
 215     /// **Example:**
 216     /// ```rust
 217     /// let x: Option<()> = None;
 218     ///
 219     /// // Bad
 220     /// let r: Option<&()> = match x {
 221     ///     None => None,
 222     ///     Some(ref v) => Some(v),
 223     /// };
 224     ///
 225     /// // Good
 226     /// let r: Option<&()> = x.as_ref();
 227     /// ```
 228     pub MATCH_AS_REF,
 229     complexity,
 230     "a `match` on an Option value instead of using `as_ref()` or `as_mut`"
 231 }
 232
 233 declare_clippy_lint! {
 234     /// **What it does:** Checks for wildcard enum matches using `_`.
 235     ///
 236     /// **Why is this bad?** New enum variants added by library updates can be missed.
 237     ///
 238     /// **Known problems:** Suggested replacements may be incorrect if guards exhaustively cover some
 239     /// variants, and also may not use correct path to enum if it's not present in the current scope.
 240     ///
 241     /// **Example:**
 242     /// ```rust
 243     /// # enum Foo { A(usize), B(usize) }
 244     /// # let x = Foo::B(1);
 245     /// // Bad
 246     /// match x {
 247     ///     Foo::A(_) => {},
 248     ///     _ => {},
 249     /// }
 250     ///
 251     /// // Good
 252     /// match x {
 253     ///     Foo::A(_) => {},
 254     ///     Foo::B(_) => {},
 255     /// }
 256     /// ```
 257     pub WILDCARD_ENUM_MATCH_ARM,
 258     restriction,
 259     "a wildcard enum match arm using `_`"
 260 }
 261
 262 declare_clippy_lint! {
 263     /// **What it does:** Checks for wildcard enum matches for a single variant.
 264     ///
 265     /// **Why is this bad?** New enum variants added by library updates can be missed.
 266     ///
 267     /// **Known problems:** Suggested replacements may not use correct path to enum
 268     /// if it's not present in the current scope.
 269     ///
 270     /// **Example:**
 271     ///
 272     /// ```rust
 273     /// # enum Foo { A, B, C }
 274     /// # let x = Foo::B;
 275     /// // Bad
 276     /// match x {
 277     ///     Foo::A => {},
 278     ///     Foo::B => {},
 279     ///     _ => {},
 280     /// }
 281     ///
 282     /// // Good
 283     /// match x {
 284     ///     Foo::A => {},
 285     ///     Foo::B => {},
 286     ///     Foo::C => {},
 287     /// }
 288     /// ```
 289     pub MATCH_WILDCARD_FOR_SINGLE_VARIANTS,
 290     pedantic,
 291     "a wildcard enum match for a single variant"
 292 }
 293
 294 declare_clippy_lint! {
 295     /// **What it does:** Checks for wildcard pattern used with others patterns in same match arm.
 296     ///
 297     /// **Why is this bad?** Wildcard pattern already covers any other pattern as it will match anyway.
 298     /// It makes the code less readable, especially to spot wildcard pattern use in match arm.
 299     ///
 300     /// **Known problems:** None.
 301     ///
 302     /// **Example:**
 303     /// ```rust
 304     /// // Bad
 305     /// match "foo" {
 306     ///     "a" => {},
 307     ///     "bar" | _ => {},
 308     /// }
 309     ///
 310     /// // Good
 311     /// match "foo" {
 312     ///     "a" => {},
 313     ///     _ => {},
 314     /// }
 315     /// ```
 316     pub WILDCARD_IN_OR_PATTERNS,
 317     complexity,
 318     "a wildcard pattern used with others patterns in same match arm"
 319 }
 320
 321 declare_clippy_lint! {
 322     /// **What it does:** Checks for matches being used to destructure a single-variant enum
 323     /// or tuple struct where a `let` will suffice.
 324     ///
 325     /// **Why is this bad?** Just readability – `let` doesn't nest, whereas a `match` does.
 326     ///
 327     /// **Known problems:** None.
 328     ///
 329     /// **Example:**
 330     /// ```rust
 331     /// enum Wrapper {
 332     ///     Data(i32),
 333     /// }
 334     ///
 335     /// let wrapper = Wrapper::Data(42);
 336     ///
 337     /// let data = match wrapper {
 338     ///     Wrapper::Data(i) => i,
 339     /// };
 340     /// ```
 341     ///
 342     /// The correct use would be:
 343     /// ```rust
 344     /// enum Wrapper {
 345     ///     Data(i32),
 346     /// }
 347     ///
 348     /// let wrapper = Wrapper::Data(42);
 349     /// let Wrapper::Data(data) = wrapper;
 350     /// ```
 351     pub INFALLIBLE_DESTRUCTURING_MATCH,
 352     style,
 353     "a `match` statement with a single infallible arm instead of a `let`"
 354 }
 355
 356 declare_clippy_lint! {
 357     /// **What it does:** Checks for useless match that binds to only one value.
 358     ///
 359     /// **Why is this bad?** Readability and needless complexity.
 360     ///
 361     /// **Known problems:**  Suggested replacements may be incorrect when `match`
 362     /// is actually binding temporary value, bringing a 'dropped while borrowed' error.
 363     ///
 364     /// **Example:**
 365     /// ```rust
 366     /// # let a = 1;
 367     /// # let b = 2;
 368     ///
 369     /// // Bad
 370     /// match (a, b) {
 371     ///     (c, d) => {
 372     ///         // useless match
 373     ///     }
 374     /// }
 375     ///
 376     /// // Good
 377     /// let (c, d) = (a, b);
 378     /// ```
 379     pub MATCH_SINGLE_BINDING,
 380     complexity,
 381     "a match with a single binding instead of using `let` statement"
 382 }
 383
 384 declare_clippy_lint! {
 385     /// **What it does:** Checks for unnecessary '..' pattern binding on struct when all fields are explicitly matched.
 386     ///
 387     /// **Why is this bad?** Correctness and readability. It's like having a wildcard pattern after
 388     /// matching all enum variants explicitly.
 389     ///
 390     /// **Known problems:** None.
 391     ///
 392     /// **Example:**
 393     /// ```rust
 394     /// # struct A { a: i32 }
 395     /// let a = A { a: 5 };
 396     ///
 397     /// // Bad
 398     /// match a {
 399     ///     A { a: 5, .. } => {},
 400     ///     _ => {},
 401     /// }
 402     ///
 403     /// // Good
 404     /// match a {
 405     ///     A { a: 5 } => {},
 406     ///     _ => {},
 407     /// }
 408     /// ```
 409     pub REST_PAT_IN_FULLY_BOUND_STRUCTS,
 410     restriction,
 411     "a match on a struct that binds all fields but still uses the wildcard pattern"
 412 }
 413
 414 declare_clippy_lint! {
 415     /// **What it does:** Lint for redundant pattern matching over `Result`, `Option`,
 416     /// `std::task::Poll` or `std::net::IpAddr`
 417     ///
 418     /// **Why is this bad?** It's more concise and clear to just use the proper
 419     /// utility function
 420     ///
 421     /// **Known problems:** None.
 422     ///
 423     /// **Example:**
 424     ///
 425     /// ```rust
 426     /// # use std::task::Poll;
 427     /// # use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};
 428     /// if let Ok(_) = Ok::<i32, i32>(42) {}
 429     /// if let Err(_) = Err::<i32, i32>(42) {}
 430     /// if let None = None::<()> {}
 431     /// if let Some(_) = Some(42) {}
 432     /// if let Poll::Pending = Poll::Pending::<()> {}
 433     /// if let Poll::Ready(_) = Poll::Ready(42) {}
 434     /// if let IpAddr::V4(_) = IpAddr::V4(Ipv4Addr::LOCALHOST) {}
 435     /// if let IpAddr::V6(_) = IpAddr::V6(Ipv6Addr::LOCALHOST) {}
 436     /// match Ok::<i32, i32>(42) {
 437     ///     Ok(_) => true,
 438     ///     Err(_) => false,
 439     /// };
 440     /// ```
 441     ///
 442     /// The more idiomatic use would be:
 443     ///
 444     /// ```rust
 445     /// # use std::task::Poll;
 446     /// # use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};
 447     /// if Ok::<i32, i32>(42).is_ok() {}
 448     /// if Err::<i32, i32>(42).is_err() {}
 449     /// if None::<()>.is_none() {}
 450     /// if Some(42).is_some() {}
 451     /// if Poll::Pending::<()>.is_pending() {}
 452     /// if Poll::Ready(42).is_ready() {}
 453     /// if IpAddr::V4(Ipv4Addr::LOCALHOST).is_ipv4() {}
 454     /// if IpAddr::V6(Ipv6Addr::LOCALHOST).is_ipv6() {}
 455     /// Ok::<i32, i32>(42).is_ok();
 456     /// ```
 457     pub REDUNDANT_PATTERN_MATCHING,
 458     style,
 459     "use the proper utility function avoiding an `if let`"
 460 }
 461
 462 declare_clippy_lint! {
 463     /// **What it does:** Checks for `match`  or `if let` expressions producing a
 464     /// `bool` that could be written using `matches!`
 465     ///
 466     /// **Why is this bad?** Readability and needless complexity.
 467     ///
 468     /// **Known problems:** This lint falsely triggers, if there are arms with
 469     /// `cfg` attributes that remove an arm evaluating to `false`.
 470     ///
 471     /// **Example:**
 472     /// ```rust
 473     /// let x = Some(5);
 474     ///
 475     /// // Bad
 476     /// let a = match x {
 477     ///     Some(0) => true,
 478     ///     _ => false,
 479     /// };
 480     ///
 481     /// let a = if let Some(0) = x {
 482     ///     true
 483     /// } else {
 484     ///     false
 485     /// };
 486     ///
 487     /// // Good
 488     /// let a = matches!(x, Some(0));
 489     /// ```
 490     pub MATCH_LIKE_MATCHES_MACRO,
 491     style,
 492     "a match that could be written with the matches! macro"
 493 }
 494
 495 declare_clippy_lint! {
 496     /// **What it does:** Checks for `match` with identical arm bodies.
 497     ///
 498     /// **Why is this bad?** This is probably a copy & paste error. If arm bodies
 499     /// are the same on purpose, you can factor them
 500     /// [using `|`](https://doc.rust-lang.org/book/patterns.html#multiple-patterns).
 501     ///
 502     /// **Known problems:** False positive possible with order dependent `match`
 503     /// (see issue
 504     /// [#860](https://github.com/rust-lang/rust-clippy/issues/860)).
 505     ///
 506     /// **Example:**
 507     /// ```rust,ignore
 508     /// match foo {
 509     ///     Bar => bar(),
 510     ///     Quz => quz(),
 511     ///     Baz => bar(), // <= oops
 512     /// }
 513     /// ```
 514     ///
 515     /// This should probably be
 516     /// ```rust,ignore
 517     /// match foo {
 518     ///     Bar => bar(),
 519     ///     Quz => quz(),
 520     ///     Baz => baz(), // <= fixed
 521     /// }
 522     /// ```
 523     ///
 524     /// or if the original code was not a typo:
 525     /// ```rust,ignore
 526     /// match foo {
 527     ///     Bar | Baz => bar(), // <= shows the intent better
 528     ///     Quz => quz(),
 529     /// }
 530     /// ```
 531     pub MATCH_SAME_ARMS,
 532     pedantic,
 533     "`match` with identical arm bodies"
 534 }
 535
 536 #[derive(Default)]
 537 pub struct Matches {
 538     msrv: Option<RustcVersion>,
 539     infallible_destructuring_match_linted: bool,
 540 }
 541
 542 impl Matches {
 543     #[must_use]
 544     pub fn new(msrv: Option<RustcVersion>) -> Self {
 545         Self {
 546             msrv,
 547             ..Matches::default()
 548         }
 549     }
 550 }
 551
 552 impl_lint_pass!(Matches => [
 553     SINGLE_MATCH,
 554     MATCH_REF_PATS,
 555     MATCH_BOOL,
 556     SINGLE_MATCH_ELSE,
 557     MATCH_OVERLAPPING_ARM,
 558     MATCH_WILD_ERR_ARM,
 559     MATCH_AS_REF,
 560     WILDCARD_ENUM_MATCH_ARM,
 561     MATCH_WILDCARD_FOR_SINGLE_VARIANTS,
 562     WILDCARD_IN_OR_PATTERNS,
 563     MATCH_SINGLE_BINDING,
 564     INFALLIBLE_DESTRUCTURING_MATCH,
 565     REST_PAT_IN_FULLY_BOUND_STRUCTS,
 566     REDUNDANT_PATTERN_MATCHING,
 567     MATCH_LIKE_MATCHES_MACRO,
 568     MATCH_SAME_ARMS,
 569 ]);
 570
 571 const MATCH_LIKE_MATCHES_MACRO_MSRV: RustcVersion = RustcVersion::new(1, 42, 0);
 572
 573 impl<'tcx> LateLintPass<'tcx> for Matches {
 574     fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) {
 575         if in_external_macro(cx.sess(), expr.span) || in_macro(expr.span) {
 576             return;
 577         }
 578
 579         redundant_pattern_match::check(cx, expr);
 580
 581         if meets_msrv(self.msrv.as_ref(), &MATCH_LIKE_MATCHES_MACRO_MSRV) {
 582             if !check_match_like_matches(cx, expr) {
 583                 lint_match_arms(cx, expr);
 584             }
 585         } else {
 586             lint_match_arms(cx, expr);
 587         }
 588
 589         if let ExprKind::Match(ref ex, ref arms, MatchSource::Normal) = expr.kind {
 590             check_single_match(cx, ex, arms, expr);
 591             check_match_bool(cx, ex, arms, expr);
 592             check_overlapping_arms(cx, ex, arms);
 593             check_wild_err_arm(cx, ex, arms);
 594             check_wild_enum_match(cx, ex, arms);
 595             check_match_as_ref(cx, ex, arms, expr);
 596             check_wild_in_or_pats(cx, arms);
 597
 598             if self.infallible_destructuring_match_linted {
 599                 self.infallible_destructuring_match_linted = false;
 600             } else {
 601                 check_match_single_binding(cx, ex, arms, expr);
 602             }
 603         }
 604         if let ExprKind::Match(ref ex, ref arms, _) = expr.kind {
 605             check_match_ref_pats(cx, ex, arms, expr);
 606         }
 607     }
 608
 609     fn check_local(&mut self, cx: &LateContext<'tcx>, local: &'tcx Local<'_>) {
 610         if_chain! {
 611             if !in_external_macro(cx.sess(), local.span);
 612             if !in_macro(local.span);
 613             if let Some(ref expr) = local.init;
 614             if let ExprKind::Match(ref target, ref arms, MatchSource::Normal) = expr.kind;
 615             if arms.len() == 1 && arms[0].guard.is_none();
 616             if let PatKind::TupleStruct(
 617                 QPath::Resolved(None, ref variant_name), ref args, _) = arms[0].pat.kind;
 618             if args.len() == 1;
 619             if let Some(arg) = get_arg_name(&args[0]);
 620             let body = remove_blocks(&arms[0].body);
 621             if match_var(body, arg);
 622
 623             then {
 624                 let mut applicability = Applicability::MachineApplicable;
 625                 self.infallible_destructuring_match_linted = true;
 626                 span_lint_and_sugg(
 627                     cx,
 628                     INFALLIBLE_DESTRUCTURING_MATCH,
 629                     local.span,
 630                     "you seem to be trying to use `match` to destructure a single infallible pattern. \
 631                     Consider using `let`",
 632                     "try this",
 633                     format!(
 634                         "let {}({}) = {};",
 635                         snippet_with_applicability(cx, variant_name.span, "..", &mut applicability),
 636                         snippet_with_applicability(cx, local.pat.span, "..", &mut applicability),
 637                         snippet_with_applicability(cx, target.span, "..", &mut applicability),
 638                     ),
 639                     applicability,
 640                 );
 641             }
 642         }
 643     }
 644
 645     fn check_pat(&mut self, cx: &LateContext<'tcx>, pat: &'tcx Pat<'_>) {
 646         if_chain! {
 647             if !in_external_macro(cx.sess(), pat.span);
 648             if !in_macro(pat.span);
 649             if let PatKind::Struct(QPath::Resolved(_, ref path), fields, true) = pat.kind;
 650             if let Some(def_id) = path.res.opt_def_id();
 651             let ty = cx.tcx.type_of(def_id);
 652             if let ty::Adt(def, _) = ty.kind();
 653             if def.is_struct() || def.is_union();
 654             if fields.len() == def.non_enum_variant().fields.len();
 655
 656             then {
 657                 span_lint_and_help(
 658                     cx,
 659                     REST_PAT_IN_FULLY_BOUND_STRUCTS,
 660                     pat.span,
 661                     "unnecessary use of `..` pattern in struct binding. All fields were already bound",
 662                     None,
 663                     "consider removing `..` from this binding",
 664                 );
 665             }
 666         }
 667     }
 668
 669     extract_msrv_attr!(LateContext);
 670 }
 671
 672 #[rustfmt::skip]
 673 fn check_single_match(cx: &LateContext<'_>, ex: &Expr<'_>, arms: &[Arm<'_>], expr: &Expr<'_>) {
 674     if arms.len() == 2 && arms[0].guard.is_none() && arms[1].guard.is_none() {
 675         if in_macro(expr.span) {
 676             // Don't lint match expressions present in
 677             // macro_rules! block
 678             return;
 679         }
 680         if let PatKind::Or(..) = arms[0].pat.kind {
 681             // don't lint for or patterns for now, this makes
 682             // the lint noisy in unnecessary situations
 683             return;
 684         }
 685         let els = arms[1].body;
 686         let els = if is_unit_expr(remove_blocks(els)) {
 687             None
 688         } else if let ExprKind::Block(Block { stmts, expr: block_expr, .. }, _) = els.kind {
 689             if stmts.len() == 1 && block_expr.is_none() || stmts.is_empty() && block_expr.is_some() {
 690                 // single statement/expr "else" block, don't lint
 691                 return;
 692             }
 693             // block with 2+ statements or 1 expr and 1+ statement
 694             Some(els)
 695         } else {
 696             // not a block, don't lint
 697             return;
 698         };
 699
 700         let ty = cx.typeck_results().expr_ty(ex);
 701         if *ty.kind() != ty::Bool || is_allowed(cx, MATCH_BOOL, ex.hir_id) {
 702             check_single_match_single_pattern(cx, ex, arms, expr, els);
 703             check_single_match_opt_like(cx, ex, arms, expr, ty, els);
 704         }
 705     }
 706 }
 707
 708 fn check_single_match_single_pattern(
 709     cx: &LateContext<'_>,
 710     ex: &Expr<'_>,
 711     arms: &[Arm<'_>],
 712     expr: &Expr<'_>,
 713     els: Option<&Expr<'_>>,
 714 ) {
 715     if is_wild(&arms[1].pat) {
 716         report_single_match_single_pattern(cx, ex, arms, expr, els);
 717     }
 718 }
 719
 720 fn peel_pat_refs(pat: &'a Pat<'a>) -> (&'a Pat<'a>, usize) {
 721     fn peel(pat: &'a Pat<'a>, count: usize) -> (&'a Pat<'a>, usize) {
 722         if let PatKind::Ref(pat, _) = pat.kind {
 723             peel(pat, count + 1)
 724         } else {
 725             (pat, count)
 726         }
 727     }
 728     peel(pat, 0)
 729 }
 730
 731 fn peel_ty_refs(ty: Ty<'_>) -> (Ty<'_>, usize) {
 732     fn peel(ty: Ty<'_>, count: usize) -> (Ty<'_>, usize) {
 733         if let ty::Ref(_, ty, _) = ty.kind() {
 734             peel(ty, count + 1)
 735         } else {
 736             (ty, count)
 737         }
 738     }
 739     peel(ty, 0)
 740 }
 741
 742 fn report_single_match_single_pattern(
 743     cx: &LateContext<'_>,
 744     ex: &Expr<'_>,
 745     arms: &[Arm<'_>],
 746     expr: &Expr<'_>,
 747     els: Option<&Expr<'_>>,
 748 ) {
 749     let lint = if els.is_some() { SINGLE_MATCH_ELSE } else { SINGLE_MATCH };
 750     let els_str = els.map_or(String::new(), |els| {
 751         format!(" else {}", expr_block(cx, els, None, "..", Some(expr.span)))
 752     });
 753
 754     let (msg, sugg) = if_chain! {
 755         let (pat, pat_ref_count) = peel_pat_refs(arms[0].pat);
 756         if let PatKind::Path(_) | PatKind::Lit(_) = pat.kind;
 757         let (ty, ty_ref_count) = peel_ty_refs(cx.typeck_results().expr_ty(ex));
 758         if let Some(trait_id) = cx.tcx.lang_items().structural_peq_trait();
 759         if ty.is_integral() || ty.is_char() || ty.is_str() || implements_trait(cx, ty, trait_id, &[]);
 760         then {
 761             // scrutinee derives PartialEq and the pattern is a constant.
 762             let pat_ref_count = match pat.kind {
 763                 // string literals are already a reference.
 764                 PatKind::Lit(Expr { kind: ExprKind::Lit(lit), .. }) if lit.node.is_str() => pat_ref_count + 1,
 765                 _ => pat_ref_count,
 766             };
 767             let msg = "you seem to be trying to use match for an equality check. Consider using `if`";
 768             let sugg = format!(
 769                 "if {} == {}{} {}{}",
 770                 snippet(cx, ex.span, ".."),
 771                 // PartialEq for different reference counts may not exist.
 772                 "&".repeat(ty_ref_count - pat_ref_count),
 773                 snippet(cx, arms[0].pat.span, ".."),
 774                 expr_block(cx, &arms[0].body, None, "..", Some(expr.span)),
 775                 els_str,
 776             );
 777             (msg, sugg)
 778         } else {
 779             let msg = "you seem to be trying to use match for destructuring a single pattern. Consider using `if let`";
 780             let sugg = format!(
 781                 "if let {} = {} {}{}",
 782                 snippet(cx, arms[0].pat.span, ".."),
 783                 snippet(cx, ex.span, ".."),
 784                 expr_block(cx, &arms[0].body, None, "..", Some(expr.span)),
 785                 els_str,
 786             );
 787             (msg, sugg)
 788         }
 789     };
 790
 791     span_lint_and_sugg(
 792         cx,
 793         lint,
 794         expr.span,
 795         msg,
 796         "try this",
 797         sugg,
 798         Applicability::HasPlaceholders,
 799     );
 800 }
 801
 802 fn check_single_match_opt_like(
 803     cx: &LateContext<'_>,
 804     ex: &Expr<'_>,
 805     arms: &[Arm<'_>],
 806     expr: &Expr<'_>,
 807     ty: Ty<'_>,
 808     els: Option<&Expr<'_>>,
 809 ) {
 810     // list of candidate `Enum`s we know will never get any more members
 811     let candidates = &[
 812         (&paths::COW, "Borrowed"),
 813         (&paths::COW, "Cow::Borrowed"),
 814         (&paths::COW, "Cow::Owned"),
 815         (&paths::COW, "Owned"),
 816         (&paths::OPTION, "None"),
 817         (&paths::RESULT, "Err"),
 818         (&paths::RESULT, "Ok"),
 819     ];
 820
 821     let path = match arms[1].pat.kind {
 822         PatKind::TupleStruct(ref path, ref inner, _) => {
 823             // Contains any non wildcard patterns (e.g., `Err(err)`)?
 824             if !inner.iter().all(is_wild) {
 825                 return;
 826             }
 827             rustc_hir_pretty::to_string(rustc_hir_pretty::NO_ANN, |s| s.print_qpath(path, false))
 828         },
 829         PatKind::Binding(BindingAnnotation::Unannotated, .., ident, None) => ident.to_string(),
 830         PatKind::Path(ref path) => {
 831             rustc_hir_pretty::to_string(rustc_hir_pretty::NO_ANN, |s| s.print_qpath(path, false))
 832         },
 833         _ => return,
 834     };
 835
 836     for &(ty_path, pat_path) in candidates {
 837         if path == *pat_path && match_type(cx, ty, ty_path) {
 838             report_single_match_single_pattern(cx, ex, arms, expr, els);
 839         }
 840     }
 841 }
 842
 843 fn check_match_bool(cx: &LateContext<'_>, ex: &Expr<'_>, arms: &[Arm<'_>], expr: &Expr<'_>) {
 844     // Type of expression is `bool`.
 845     if *cx.typeck_results().expr_ty(ex).kind() == ty::Bool {
 846         span_lint_and_then(
 847             cx,
 848             MATCH_BOOL,
 849             expr.span,
 850             "you seem to be trying to match on a boolean expression",
 851             move |diag| {
 852                 if arms.len() == 2 {
 853                     // no guards
 854                     let exprs = if let PatKind::Lit(ref arm_bool) = arms[0].pat.kind {
 855                         if let ExprKind::Lit(ref lit) = arm_bool.kind {
 856                             match lit.node {
 857                                 LitKind::Bool(true) => Some((&*arms[0].body, &*arms[1].body)),
 858                                 LitKind::Bool(false) => Some((&*arms[1].body, &*arms[0].body)),
 859                                 _ => None,
 860                             }
 861                         } else {
 862                             None
 863                         }
 864                     } else {
 865                         None
 866                     };
 867
 868                     if let Some((true_expr, false_expr)) = exprs {
 869                         let sugg = match (is_unit_expr(true_expr), is_unit_expr(false_expr)) {
 870                             (false, false) => Some(format!(
 871                                 "if {} {} else {}",
 872                                 snippet(cx, ex.span, "b"),
 873                                 expr_block(cx, true_expr, None, "..", Some(expr.span)),
 874                                 expr_block(cx, false_expr, None, "..", Some(expr.span))
 875                             )),
 876                             (false, true) => Some(format!(
 877                                 "if {} {}",
 878                                 snippet(cx, ex.span, "b"),
 879                                 expr_block(cx, true_expr, None, "..", Some(expr.span))
 880                             )),
 881                             (true, false) => {
 882                                 let test = Sugg::hir(cx, ex, "..");
 883                                 Some(format!(
 884                                     "if {} {}",
 885                                     !test,
 886                                     expr_block(cx, false_expr, None, "..", Some(expr.span))
 887                                 ))
 888                             },
 889                             (true, true) => None,
 890                         };
 891
 892                         if let Some(sugg) = sugg {
 893                             diag.span_suggestion(
 894                                 expr.span,
 895                                 "consider using an `if`/`else` expression",
 896                                 sugg,
 897                                 Applicability::HasPlaceholders,
 898                             );
 899                         }
 900                     }
 901                 }
 902             },
 903         );
 904     }
 905 }
 906
 907 fn check_overlapping_arms<'tcx>(cx: &LateContext<'tcx>, ex: &'tcx Expr<'_>, arms: &'tcx [Arm<'_>]) {
 908     if arms.len() >= 2 && cx.typeck_results().expr_ty(ex).is_integral() {
 909         let ranges = all_ranges(cx, arms, cx.typeck_results().expr_ty(ex));
 910         let type_ranges = type_ranges(&ranges);
 911         if !type_ranges.is_empty() {
 912             if let Some((start, end)) = overlapping(&type_ranges) {
 913                 span_lint_and_note(
 914                     cx,
 915                     MATCH_OVERLAPPING_ARM,
 916                     start.span,
 917                     "some ranges overlap",
 918                     Some(end.span),
 919                     "overlaps with this",
 920                 );
 921             }
 922         }
 923     }
 924 }
 925
 926 fn check_wild_err_arm(cx: &LateContext<'_>, ex: &Expr<'_>, arms: &[Arm<'_>]) {
 927     let ex_ty = cx.typeck_results().expr_ty(ex).peel_refs();
 928     if is_type_diagnostic_item(cx, ex_ty, sym::result_type) {
 929         for arm in arms {
 930             if let PatKind::TupleStruct(ref path, ref inner, _) = arm.pat.kind {
 931                 let path_str = rustc_hir_pretty::to_string(rustc_hir_pretty::NO_ANN, |s| s.print_qpath(path, false));
 932                 if path_str == "Err" {
 933                     let mut matching_wild = inner.iter().any(is_wild);
 934                     let mut ident_bind_name = String::from("_");
 935                     if !matching_wild {
 936                         // Looking for unused bindings (i.e.: `_e`)
 937                         inner.iter().for_each(|pat| {
 938                             if let PatKind::Binding(.., ident, None) = &pat.kind {
 939                                 if ident.as_str().starts_with('_') && is_unused(ident, arm.body) {
 940                                     ident_bind_name = (&ident.name.as_str()).to_string();
 941                                     matching_wild = true;
 942                                 }
 943                             }
 944                         });
 945                     }
 946                     if_chain! {
 947                         if matching_wild;
 948                         if let ExprKind::Block(ref block, _) = arm.body.kind;
 949                         if is_panic_block(block);
 950                         then {
 951                             // `Err(_)` or `Err(_e)` arm with `panic!` found
 952                             span_lint_and_note(cx,
 953                                 MATCH_WILD_ERR_ARM,
 954                                 arm.pat.span,
 955                                 &format!("`Err({})` matches all errors", &ident_bind_name),
 956                                 None,
 957                                 "match each error separately or use the error output, or use `.except(msg)` if the error case is unreachable",
 958                             );
 959                         }
 960                     }
 961                 }
 962             }
 963         }
 964     }
 965 }
 966
 967 fn check_wild_enum_match(cx: &LateContext<'_>, ex: &Expr<'_>, arms: &[Arm<'_>]) {
 968     let ty = cx.typeck_results().expr_ty(ex);
 969     if !ty.is_enum() {
 970         // If there isn't a nice closed set of possible values that can be conveniently enumerated,
 971         // don't complain about not enumerating the mall.
 972         return;
 973     }
 974
 975     // First pass - check for violation, but don't do much book-keeping because this is hopefully
 976     // the uncommon case, and the book-keeping is slightly expensive.
 977     let mut wildcard_span = None;
 978     let mut wildcard_ident = None;
 979     for arm in arms {
 980         if let PatKind::Wild = arm.pat.kind {
 981             wildcard_span = Some(arm.pat.span);
 982         } else if let PatKind::Binding(_, _, ident, None) = arm.pat.kind {
 983             wildcard_span = Some(arm.pat.span);
 984             wildcard_ident = Some(ident);
 985         }
 986     }
 987
 988     if let Some(wildcard_span) = wildcard_span {
 989         // Accumulate the variants which should be put in place of the wildcard because they're not
 990         // already covered.
 991
 992         let mut missing_variants = vec![];
 993         if let ty::Adt(def, _) = ty.kind() {
 994             for variant in &def.variants {
 995                 missing_variants.push(variant);
 996             }
 997         }
 998
 999         for arm in arms {
1000             if arm.guard.is_some() {
1001                 // Guards mean that this case probably isn't exhaustively covered. Technically
1002                 // this is incorrect, as we should really check whether each variant is exhaustively
1003                 // covered by the set of guards that cover it, but that's really hard to do.
1004                 continue;
1005             }
1006             if let PatKind::Path(ref path) = arm.pat.kind {
1007                 if let QPath::Resolved(_, p) = path {
1008                     missing_variants.retain(|e| e.ctor_def_id != Some(p.res.def_id()));
1009                 }
1010             } else if let PatKind::TupleStruct(QPath::Resolved(_, p), ref patterns, ..) = arm.pat.kind {
1011                 // Some simple checks for exhaustive patterns.
1012                 // There is a room for improvements to detect more cases,
1013                 // but it can be more expensive to do so.
1014                 let is_pattern_exhaustive =
1015                     |pat: &&Pat<'_>| matches!(pat.kind, PatKind::Wild | PatKind::Binding(.., None));
1016                 if patterns.iter().all(is_pattern_exhaustive) {
1017                     missing_variants.retain(|e| e.ctor_def_id != Some(p.res.def_id()));
1018                 }
1019             }
1020         }
1021
1022         let mut suggestion: Vec<String> = missing_variants
1023             .iter()
1024             .map(|v| {
1025                 let suffix = match v.ctor_kind {
1026                     CtorKind::Fn => "(..)",
1027                     CtorKind::Const | CtorKind::Fictive => "",
1028                 };
1029                 let ident_str = if let Some(ident) = wildcard_ident {
1030                     format!("{} @ ", ident.name)
1031                 } else {
1032                     String::new()
1033                 };
1034                 // This path assumes that the enum type is imported into scope.
1035                 format!("{}{}{}", ident_str, cx.tcx.def_path_str(v.def_id), suffix)
1036             })
1037             .collect();
1038
1039         if suggestion.is_empty() {
1040             return;
1041         }
1042
1043         let mut message = "wildcard match will miss any future added variants";
1044
1045         if let ty::Adt(def, _) = ty.kind() {
1046             if def.is_variant_list_non_exhaustive() {
1047                 message = "match on non-exhaustive enum doesn't explicitly match all known variants";
1048                 suggestion.push(String::from("_"));
1049             }
1050         }
1051
1052         if suggestion.len() == 1 {
1053             // No need to check for non-exhaustive enum as in that case len would be greater than 1
1054             span_lint_and_sugg(
1055                 cx,
1056                 MATCH_WILDCARD_FOR_SINGLE_VARIANTS,
1057                 wildcard_span,
1058                 message,
1059                 "try this",
1060                 suggestion[0].clone(),
1061                 Applicability::MaybeIncorrect,
1062             )
1063         };
1064
1065         span_lint_and_sugg(
1066             cx,
1067             WILDCARD_ENUM_MATCH_ARM,
1068             wildcard_span,
1069             message,
1070             "try this",
1071             suggestion.join(" | "),
1072             Applicability::MaybeIncorrect,
1073         )
1074     }
1075 }
1076
1077 // If the block contains only a `panic!` macro (as expression or statement)
1078 fn is_panic_block(block: &Block<'_>) -> bool {
1079     match (&block.expr, block.stmts.len(), block.stmts.first()) {
1080         (&Some(ref exp), 0, _) => {
1081             is_expn_of(exp.span, "panic").is_some() && is_expn_of(exp.span, "unreachable").is_none()
1082         },
1083         (&None, 1, Some(stmt)) => {
1084             is_expn_of(stmt.span, "panic").is_some() && is_expn_of(stmt.span, "unreachable").is_none()
1085         },
1086         _ => false,
1087     }
1088 }
1089
1090 fn check_match_ref_pats(cx: &LateContext<'_>, ex: &Expr<'_>, arms: &[Arm<'_>], expr: &Expr<'_>) {
1091     if has_only_ref_pats(arms) {
1092         let mut suggs = Vec::with_capacity(arms.len() + 1);
1093         let (title, msg) = if let ExprKind::AddrOf(BorrowKind::Ref, Mutability::Not, ref inner) = ex.kind {
1094             let span = ex.span.source_callsite();
1095             suggs.push((span, Sugg::hir_with_macro_callsite(cx, inner, "..").to_string()));
1096             (
1097                 "you don't need to add `&` to both the expression and the patterns",
1098                 "try",
1099             )
1100         } else {
1101             let span = ex.span.source_callsite();
1102             suggs.push((span, Sugg::hir_with_macro_callsite(cx, ex, "..").deref().to_string()));
1103             (
1104                 "you don't need to add `&` to all patterns",
1105                 "instead of prefixing all patterns with `&`, you can dereference the expression",
1106             )
1107         };
1108
1109         suggs.extend(arms.iter().filter_map(|a| {
1110             if let PatKind::Ref(ref refp, _) = a.pat.kind {
1111                 Some((a.pat.span, snippet(cx, refp.span, "..").to_string()))
1112             } else {
1113                 None
1114             }
1115         }));
1116
1117         span_lint_and_then(cx, MATCH_REF_PATS, expr.span, title, |diag| {
1118             if !expr.span.from_expansion() {
1119                 multispan_sugg(diag, msg, suggs);
1120             }
1121         });
1122     }
1123 }
1124
1125 fn check_match_as_ref(cx: &LateContext<'_>, ex: &Expr<'_>, arms: &[Arm<'_>], expr: &Expr<'_>) {
1126     if arms.len() == 2 && arms[0].guard.is_none() && arms[1].guard.is_none() {
1127         let arm_ref: Option<BindingAnnotation> = if is_none_arm(&arms[0]) {
1128             is_ref_some_arm(&arms[1])
1129         } else if is_none_arm(&arms[1]) {
1130             is_ref_some_arm(&arms[0])
1131         } else {
1132             None
1133         };
1134         if let Some(rb) = arm_ref {
1135             let suggestion = if rb == BindingAnnotation::Ref {
1136                 "as_ref"
1137             } else {
1138                 "as_mut"
1139             };
1140
1141             let output_ty = cx.typeck_results().expr_ty(expr);
1142             let input_ty = cx.typeck_results().expr_ty(ex);
1143
1144             let cast = if_chain! {
1145                 if let ty::Adt(_, substs) = input_ty.kind();
1146                 let input_ty = substs.type_at(0);
1147                 if let ty::Adt(_, substs) = output_ty.kind();
1148                 let output_ty = substs.type_at(0);
1149                 if let ty::Ref(_, output_ty, _) = *output_ty.kind();
1150                 if input_ty != output_ty;
1151                 then {
1152                     ".map(|x| x as _)"
1153                 } else {
1154                     ""
1155                 }
1156             };
1157
1158             let mut applicability = Applicability::MachineApplicable;
1159             span_lint_and_sugg(
1160                 cx,
1161                 MATCH_AS_REF,
1162                 expr.span,
1163                 &format!("use `{}()` instead", suggestion),
1164                 "try this",
1165                 format!(
1166                     "{}.{}(){}",
1167                     snippet_with_applicability(cx, ex.span, "_", &mut applicability),
1168                     suggestion,
1169                     cast,
1170                 ),
1171                 applicability,
1172             )
1173         }
1174     }
1175 }
1176
1177 fn check_wild_in_or_pats(cx: &LateContext<'_>, arms: &[Arm<'_>]) {
1178     for arm in arms {
1179         if let PatKind::Or(ref fields) = arm.pat.kind {
1180             // look for multiple fields in this arm that contains at least one Wild pattern
1181             if fields.len() > 1 && fields.iter().any(is_wild) {
1182                 span_lint_and_help(
1183                     cx,
1184                     WILDCARD_IN_OR_PATTERNS,
1185                     arm.pat.span,
1186                     "wildcard pattern covers any other pattern as it will match anyway.",
1187                     None,
1188                     "Consider handling `_` separately.",
1189                 );
1190             }
1191         }
1192     }
1193 }
1194
1195 /// Lint a `match` or `if let .. { .. } else { .. }` expr that could be replaced by `matches!`
1196 fn check_match_like_matches<'tcx>(cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) -> bool {
1197     if let ExprKind::Match(ex, arms, ref match_source) = &expr.kind {
1198         match match_source {
1199             MatchSource::Normal => find_matches_sugg(cx, ex, arms, expr, false),
1200             MatchSource::IfLetDesugar { .. } => find_matches_sugg(cx, ex, arms, expr, true),
1201             _ => false,
1202         }
1203     } else {
1204         false
1205     }
1206 }
1207
1208 /// Lint a `match` or desugared `if let` for replacement by `matches!`
1209 fn find_matches_sugg(cx: &LateContext<'_>, ex: &Expr<'_>, arms: &[Arm<'_>], expr: &Expr<'_>, desugared: bool) -> bool {
1210     if_chain! {
1211         if arms.len() >= 2;
1212         if cx.typeck_results().expr_ty(expr).is_bool();
1213         if let Some((b1_arm, b0_arms)) = arms.split_last();
1214         if let Some(b0) = find_bool_lit(&b0_arms[0].body.kind, desugared);
1215         if let Some(b1) = find_bool_lit(&b1_arm.body.kind, desugared);
1216         if is_wild(&b1_arm.pat);
1217         if b0 != b1;
1218         let if_guard = &b0_arms[0].guard;
1219         if if_guard.is_none() || b0_arms.len() == 1;
1220         if b0_arms[0].attrs.is_empty();
1221         if b0_arms[1..].iter()
1222             .all(|arm| {
1223                 find_bool_lit(&arm.body.kind, desugared).map_or(false, |b| b == b0) &&
1224                 arm.guard.is_none() && arm.attrs.is_empty()
1225             });
1226         then {
1227             // The suggestion may be incorrect, because some arms can have `cfg` attributes
1228             // evaluated into `false` and so such arms will be stripped before.
1229             let mut applicability = Applicability::MaybeIncorrect;
1230             let pat = {
1231                 use itertools::Itertools as _;
1232                 b0_arms.iter()
1233                     .map(|arm| snippet_with_applicability(cx, arm.pat.span, "..", &mut applicability))
1234                     .join(" | ")
1235             };
1236             let pat_and_guard = if let Some(Guard::If(g)) = if_guard {
1237                 format!("{} if {}", pat, snippet_with_applicability(cx, g.span, "..", &mut applicability))
1238             } else {
1239                 pat
1240             };
1241             span_lint_and_sugg(
1242                 cx,
1243                 MATCH_LIKE_MATCHES_MACRO,
1244                 expr.span,
1245                 &format!("{} expression looks like `matches!` macro", if desugared { "if let .. else" } else { "match" }),
1246                 "try this",
1247                 format!(
1248                     "{}matches!({}, {})",
1249                     if b0 { "" } else { "!" },
1250                     snippet_with_applicability(cx, ex.span, "..", &mut applicability),
1251                     pat_and_guard,
1252                 ),
1253                 applicability,
1254             );
1255             true
1256         } else {
1257             false
1258         }
1259     }
1260 }
1261
1262 /// Extract a `bool` or `{ bool }`
1263 fn find_bool_lit(ex: &ExprKind<'_>, desugared: bool) -> Option<bool> {
1264     match ex {
1265         ExprKind::Lit(Spanned {
1266             node: LitKind::Bool(b), ..
1267         }) => Some(*b),
1268         ExprKind::Block(
1269             rustc_hir::Block {
1270                 stmts: &[],
1271                 expr: Some(exp),
1272                 ..
1273             },
1274             _,
1275         ) if desugared => {
1276             if let ExprKind::Lit(Spanned {
1277                 node: LitKind::Bool(b), ..
1278             }) = exp.kind
1279             {
1280                 Some(b)
1281             } else {
1282                 None
1283             }
1284         },
1285         _ => None,
1286     }
1287 }
1288
1289 fn check_match_single_binding<'a>(cx: &LateContext<'a>, ex: &Expr<'a>, arms: &[Arm<'_>], expr: &Expr<'_>) {
1290     if in_macro(expr.span) || arms.len() != 1 || is_refutable(cx, arms[0].pat) {
1291         return;
1292     }
1293
1294     // HACK:
1295     // This is a hack to deal with arms that are excluded by macros like `#[cfg]`. It is only used here
1296     // to prevent false positives as there is currently no better way to detect if code was excluded by
1297     // a macro. See PR #6435
1298     if_chain! {
1299         if let Some(match_snippet) = snippet_opt(cx, expr.span);
1300         if let Some(arm_snippet) = snippet_opt(cx, arms[0].span);
1301         if let Some(ex_snippet) = snippet_opt(cx, ex.span);
1302         let rest_snippet = match_snippet.replace(&arm_snippet, "").replace(&ex_snippet, "");
1303         if rest_snippet.contains("=>");
1304         then {
1305             // The code it self contains another thick arrow "=>"
1306             // -> Either another arm or a comment
1307             return;
1308         }
1309     }
1310
1311     let matched_vars = ex.span;
1312     let bind_names = arms[0].pat.span;
1313     let match_body = remove_blocks(&arms[0].body);
1314     let mut snippet_body = if match_body.span.from_expansion() {
1315         Sugg::hir_with_macro_callsite(cx, match_body, "..").to_string()
1316     } else {
1317         snippet_block(cx, match_body.span, "..", Some(expr.span)).to_string()
1318     };
1319
1320     // Do we need to add ';' to suggestion ?
1321     match match_body.kind {
1322         ExprKind::Block(block, _) => {
1323             // macro + expr_ty(body) == ()
1324             if block.span.from_expansion() && cx.typeck_results().expr_ty(&match_body).is_unit() {
1325                 snippet_body.push(';');
1326             }
1327         },
1328         _ => {
1329             // expr_ty(body) == ()
1330             if cx.typeck_results().expr_ty(&match_body).is_unit() {
1331                 snippet_body.push(';');
1332             }
1333         },
1334     }
1335
1336     let mut applicability = Applicability::MaybeIncorrect;
1337     match arms[0].pat.kind {
1338         PatKind::Binding(..) | PatKind::Tuple(_, _) | PatKind::Struct(..) => {
1339             // If this match is in a local (`let`) stmt
1340             let (target_span, sugg) = if let Some(parent_let_node) = opt_parent_let(cx, ex) {
1341                 (
1342                     parent_let_node.span,
1343                     format!(
1344                         "let {} = {};\n{}let {} = {};",
1345                         snippet_with_applicability(cx, bind_names, "..", &mut applicability),
1346                         snippet_with_applicability(cx, matched_vars, "..", &mut applicability),
1347                         " ".repeat(indent_of(cx, expr.span).unwrap_or(0)),
1348                         snippet_with_applicability(cx, parent_let_node.pat.span, "..", &mut applicability),
1349                         snippet_body
1350                     ),
1351                 )
1352             } else {
1353                 // If we are in closure, we need curly braces around suggestion
1354                 let mut indent = " ".repeat(indent_of(cx, ex.span).unwrap_or(0));
1355                 let (mut cbrace_start, mut cbrace_end) = ("".to_string(), "".to_string());
1356                 if let Some(parent_expr) = get_parent_expr(cx, expr) {
1357                     if let ExprKind::Closure(..) = parent_expr.kind {
1358                         cbrace_end = format!("\n{}}}", indent);
1359                         // Fix body indent due to the closure
1360                         indent = " ".repeat(indent_of(cx, bind_names).unwrap_or(0));
1361                         cbrace_start = format!("{{\n{}", indent);
1362                     }
1363                 };
1364                 (
1365                     expr.span,
1366                     format!(
1367                         "{}let {} = {};\n{}{}{}",
1368                         cbrace_start,
1369                         snippet_with_applicability(cx, bind_names, "..", &mut applicability),
1370                         snippet_with_applicability(cx, matched_vars, "..", &mut applicability),
1371                         indent,
1372                         snippet_body,
1373                         cbrace_end
1374                     ),
1375                 )
1376             };
1377             span_lint_and_sugg(
1378                 cx,
1379                 MATCH_SINGLE_BINDING,
1380                 target_span,
1381                 "this match could be written as a `let` statement",
1382                 "consider using `let` statement",
1383                 sugg,
1384                 applicability,
1385             );
1386         },
1387         PatKind::Wild => {
1388             span_lint_and_sugg(
1389                 cx,
1390                 MATCH_SINGLE_BINDING,
1391                 expr.span,
1392                 "this match could be replaced by its body itself",
1393                 "consider using the match body instead",
1394                 snippet_body,
1395                 Applicability::MachineApplicable,
1396             );
1397         },
1398         _ => (),
1399     }
1400 }
1401
1402 /// Returns true if the `ex` match expression is in a local (`let`) statement
1403 fn opt_parent_let<'a>(cx: &LateContext<'a>, ex: &Expr<'a>) -> Option<&'a Local<'a>> {
1404     if_chain! {
1405         let map = &cx.tcx.hir();
1406         if let Some(Node::Expr(parent_arm_expr)) = map.find(map.get_parent_node(ex.hir_id));
1407         if let Some(Node::Local(parent_let_expr)) = map.find(map.get_parent_node(parent_arm_expr.hir_id));
1408         then {
1409             return Some(parent_let_expr);
1410         }
1411     }
1412     None
1413 }
1414
1415 /// Gets all arms that are unbounded `PatRange`s.
1416 fn all_ranges<'tcx>(cx: &LateContext<'tcx>, arms: &'tcx [Arm<'_>], ty: Ty<'tcx>) -> Vec<SpannedRange<Constant>> {
1417     arms.iter()
1418         .flat_map(|arm| {
1419             if let Arm {
1420                 ref pat, guard: None, ..
1421             } = *arm
1422             {
1423                 if let PatKind::Range(ref lhs, ref rhs, range_end) = pat.kind {
1424                     let lhs = match lhs {
1425                         Some(lhs) => constant(cx, cx.typeck_results(), lhs)?.0,
1426                         None => miri_to_const(ty.numeric_min_val(cx.tcx)?)?,
1427                     };
1428                     let rhs = match rhs {
1429                         Some(rhs) => constant(cx, cx.typeck_results(), rhs)?.0,
1430                         None => miri_to_const(ty.numeric_max_val(cx.tcx)?)?,
1431                     };
1432                     let rhs = match range_end {
1433                         RangeEnd::Included => Bound::Included(rhs),
1434                         RangeEnd::Excluded => Bound::Excluded(rhs),
1435                     };
1436                     return Some(SpannedRange {
1437                         span: pat.span,
1438                         node: (lhs, rhs),
1439                     });
1440                 }
1441
1442                 if let PatKind::Lit(ref value) = pat.kind {
1443                     let value = constant(cx, cx.typeck_results(), value)?.0;
1444                     return Some(SpannedRange {
1445                         span: pat.span,
1446                         node: (value.clone(), Bound::Included(value)),
1447                     });
1448                 }
1449             }
1450             None
1451         })
1452         .collect()
1453 }
1454
1455 #[derive(Debug, Eq, PartialEq)]
1456 pub struct SpannedRange<T> {
1457     pub span: Span,
1458     pub node: (T, Bound<T>),
1459 }
1460
1461 type TypedRanges = Vec<SpannedRange<u128>>;
1462
1463 /// Gets all `Int` ranges or all `Uint` ranges. Mixed types are an error anyway
1464 /// and other types than
1465 /// `Uint` and `Int` probably don't make sense.
1466 fn type_ranges(ranges: &[SpannedRange<Constant>]) -> TypedRanges {
1467     ranges
1468         .iter()
1469         .filter_map(|range| match range.node {
1470             (Constant::Int(start), Bound::Included(Constant::Int(end))) => Some(SpannedRange {
1471                 span: range.span,
1472                 node: (start, Bound::Included(end)),
1473             }),
1474             (Constant::Int(start), Bound::Excluded(Constant::Int(end))) => Some(SpannedRange {
1475                 span: range.span,
1476                 node: (start, Bound::Excluded(end)),
1477             }),
1478             (Constant::Int(start), Bound::Unbounded) => Some(SpannedRange {
1479                 span: range.span,
1480                 node: (start, Bound::Unbounded),
1481             }),
1482             _ => None,
1483         })
1484         .collect()
1485 }
1486
1487 fn is_unit_expr(expr: &Expr<'_>) -> bool {
1488     match expr.kind {
1489         ExprKind::Tup(ref v) if v.is_empty() => true,
1490         ExprKind::Block(ref b, _) if b.stmts.is_empty() && b.expr.is_none() => true,
1491         _ => false,
1492     }
1493 }
1494
1495 // Checks if arm has the form `None => None`
1496 fn is_none_arm(arm: &Arm<'_>) -> bool {
1497     matches!(arm.pat.kind, PatKind::Path(ref path) if match_qpath(path, &paths::OPTION_NONE))
1498 }
1499
1500 // Checks if arm has the form `Some(ref v) => Some(v)` (checks for `ref` and `ref mut`)
1501 fn is_ref_some_arm(arm: &Arm<'_>) -> Option<BindingAnnotation> {
1502     if_chain! {
1503         if let PatKind::TupleStruct(ref path, ref pats, _) = arm.pat.kind;
1504         if pats.len() == 1 && match_qpath(path, &paths::OPTION_SOME);
1505         if let PatKind::Binding(rb, .., ident, _) = pats[0].kind;
1506         if rb == BindingAnnotation::Ref || rb == BindingAnnotation::RefMut;
1507         if let ExprKind::Call(ref e, ref args) = remove_blocks(&arm.body).kind;
1508         if let ExprKind::Path(ref some_path) = e.kind;
1509         if match_qpath(some_path, &paths::OPTION_SOME) && args.len() == 1;
1510         if let ExprKind::Path(QPath::Resolved(_, ref path2)) = args[0].kind;
1511         if path2.segments.len() == 1 && ident.name == path2.segments[0].ident.name;
1512         then {
1513             return Some(rb)
1514         }
1515     }
1516     None
1517 }
1518
1519 fn has_only_ref_pats(arms: &[Arm<'_>]) -> bool {
1520     let mapped = arms
1521         .iter()
1522         .map(|a| {
1523             match a.pat.kind {
1524                 PatKind::Ref(..) => Some(true), // &-patterns
1525                 PatKind::Wild => Some(false),   // an "anything" wildcard is also fine
1526                 _ => None,                      // any other pattern is not fine
1527             }
1528         })
1529         .collect::<Option<Vec<bool>>>();
1530     // look for Some(v) where there's at least one true element
1531     mapped.map_or(false, |v| v.iter().any(|el| *el))
1532 }
1533
1534 pub fn overlapping<T>(ranges: &[SpannedRange<T>]) -> Option<(&SpannedRange<T>, &SpannedRange<T>)>
1535 where
1536     T: Copy + Ord,
1537 {
1538     #[derive(Copy, Clone, Debug, Eq, PartialEq)]
1539     enum Kind<'a, T> {
1540         Start(T, &'a SpannedRange<T>),
1541         End(Bound<T>, &'a SpannedRange<T>),
1542     }
1543
1544     impl<'a, T: Copy> Kind<'a, T> {
1545         fn range(&self) -> &'a SpannedRange<T> {
1546             match *self {
1547                 Kind::Start(_, r) | Kind::End(_, r) => r,
1548             }
1549         }
1550
1551         fn value(self) -> Bound<T> {
1552             match self {
1553                 Kind::Start(t, _) => Bound::Included(t),
1554                 Kind::End(t, _) => t,
1555             }
1556         }
1557     }
1558
1559     impl<'a, T: Copy + Ord> PartialOrd for Kind<'a, T> {
1560         fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
1561             Some(self.cmp(other))
1562         }
1563     }
1564
1565     impl<'a, T: Copy + Ord> Ord for Kind<'a, T> {
1566         fn cmp(&self, other: &Self) -> Ordering {
1567             match (self.value(), other.value()) {
1568                 (Bound::Included(a), Bound::Included(b)) | (Bound::Excluded(a), Bound::Excluded(b)) => a.cmp(&b),
1569                 // Range patterns cannot be unbounded (yet)
1570                 (Bound::Unbounded, _) | (_, Bound::Unbounded) => unimplemented!(),
1571                 (Bound::Included(a), Bound::Excluded(b)) => match a.cmp(&b) {
1572                     Ordering::Equal => Ordering::Greater,
1573                     other => other,
1574                 },
1575                 (Bound::Excluded(a), Bound::Included(b)) => match a.cmp(&b) {
1576                     Ordering::Equal => Ordering::Less,
1577                     other => other,
1578                 },
1579             }
1580         }
1581     }
1582
1583     let mut values = Vec::with_capacity(2 * ranges.len());
1584
1585     for r in ranges {
1586         values.push(Kind::Start(r.node.0, r));
1587         values.push(Kind::End(r.node.1, r));
1588     }
1589
1590     values.sort();
1591
1592     for (a, b) in values.iter().zip(values.iter().skip(1)) {
1593         match (a, b) {
1594             (&Kind::Start(_, ra), &Kind::End(_, rb)) => {
1595                 if ra.node != rb.node {
1596                     return Some((ra, rb));
1597                 }
1598             },
1599             (&Kind::End(a, _), &Kind::Start(b, _)) if a != Bound::Included(b) => (),
1600             _ => return Some((a.range(), b.range())),
1601         }
1602     }
1603
1604     None
1605 }
1606
1607 mod redundant_pattern_match {
1608     use super::REDUNDANT_PATTERN_MATCHING;
1609     use crate::utils::{match_qpath, match_trait_method, paths, snippet, span_lint_and_then};
1610     use if_chain::if_chain;
1611     use rustc_ast::ast::LitKind;
1612     use rustc_errors::Applicability;
1613     use rustc_hir::{Arm, Expr, ExprKind, MatchSource, PatKind, QPath};
1614     use rustc_lint::LateContext;
1615     use rustc_span::sym;
1616
1617     pub fn check<'tcx>(cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) {
1618         if let ExprKind::Match(op, arms, ref match_source) = &expr.kind {
1619             match match_source {
1620                 MatchSource::Normal => find_sugg_for_match(cx, expr, op, arms),
1621                 MatchSource::IfLetDesugar { .. } => find_sugg_for_if_let(cx, expr, op, arms, "if"),
1622                 MatchSource::WhileLetDesugar => find_sugg_for_if_let(cx, expr, op, arms, "while"),
1623                 _ => {},
1624             }
1625         }
1626     }
1627
1628     fn find_sugg_for_if_let<'tcx>(
1629         cx: &LateContext<'tcx>,
1630         expr: &'tcx Expr<'_>,
1631         op: &Expr<'_>,
1632         arms: &[Arm<'_>],
1633         keyword: &'static str,
1634     ) {
1635         let good_method = match arms[0].pat.kind {
1636             PatKind::TupleStruct(ref path, ref patterns, _) if patterns.len() == 1 => {
1637                 if let PatKind::Wild = patterns[0].kind {
1638                     if match_qpath(path, &paths::RESULT_OK) {
1639                         "is_ok()"
1640                     } else if match_qpath(path, &paths::RESULT_ERR) {
1641                         "is_err()"
1642                     } else if match_qpath(path, &paths::OPTION_SOME) {
1643                         "is_some()"
1644                     } else if match_qpath(path, &paths::POLL_READY) {
1645                         "is_ready()"
1646                     } else if match_qpath(path, &paths::IPADDR_V4) {
1647                         "is_ipv4()"
1648                     } else if match_qpath(path, &paths::IPADDR_V6) {
1649                         "is_ipv6()"
1650                     } else {
1651                         return;
1652                     }
1653                 } else {
1654                     return;
1655                 }
1656             },
1657             PatKind::Path(ref path) => {
1658                 if match_qpath(path, &paths::OPTION_NONE) {
1659                     "is_none()"
1660                 } else if match_qpath(path, &paths::POLL_PENDING) {
1661                     "is_pending()"
1662                 } else {
1663                     return;
1664                 }
1665             },
1666             _ => return,
1667         };
1668
1669         // check that `while_let_on_iterator` lint does not trigger
1670         if_chain! {
1671             if keyword == "while";
1672             if let ExprKind::MethodCall(method_path, _, _, _) = op.kind;
1673             if method_path.ident.name == sym::next;
1674             if match_trait_method(cx, op, &paths::ITERATOR);
1675             then {
1676                 return;
1677             }
1678         }
1679
1680         let result_expr = match &op.kind {
1681             ExprKind::AddrOf(_, _, borrowed) => borrowed,
1682             _ => op,
1683         };
1684         span_lint_and_then(
1685             cx,
1686             REDUNDANT_PATTERN_MATCHING,
1687             arms[0].pat.span,
1688             &format!("redundant pattern matching, consider using `{}`", good_method),
1689             |diag| {
1690                 // while let ... = ... { ... }
1691                 // ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1692                 let expr_span = expr.span;
1693
1694                 // while let ... = ... { ... }
1695                 //                 ^^^
1696                 let op_span = result_expr.span.source_callsite();
1697
1698                 // while let ... = ... { ... }
1699                 // ^^^^^^^^^^^^^^^^^^^
1700                 let span = expr_span.until(op_span.shrink_to_hi());
1701                 diag.span_suggestion(
1702                     span,
1703                     "try this",
1704                     format!("{} {}.{}", keyword, snippet(cx, op_span, "_"), good_method),
1705                     Applicability::MachineApplicable, // snippet
1706                 );
1707             },
1708         );
1709     }
1710
1711     fn find_sugg_for_match<'tcx>(cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>, op: &Expr<'_>, arms: &[Arm<'_>]) {
1712         if arms.len() == 2 {
1713             let node_pair = (&arms[0].pat.kind, &arms[1].pat.kind);
1714
1715             let found_good_method = match node_pair {
1716                 (
1717                     PatKind::TupleStruct(ref path_left, ref patterns_left, _),
1718                     PatKind::TupleStruct(ref path_right, ref patterns_right, _),
1719                 ) if patterns_left.len() == 1 && patterns_right.len() == 1 => {
1720                     if let (PatKind::Wild, PatKind::Wild) = (&patterns_left[0].kind, &patterns_right[0].kind) {
1721                         find_good_method_for_match(
1722                             arms,
1723                             path_left,
1724                             path_right,
1725                             &paths::RESULT_OK,
1726                             &paths::RESULT_ERR,
1727                             "is_ok()",
1728                             "is_err()",
1729                         )
1730                         .or_else(|| {
1731                             find_good_method_for_match(
1732                                 arms,
1733                                 path_left,
1734                                 path_right,
1735                                 &paths::IPADDR_V4,
1736                                 &paths::IPADDR_V6,
1737                                 "is_ipv4()",
1738                                 "is_ipv6()",
1739                             )
1740                         })
1741                     } else {
1742                         None
1743                     }
1744                 },
1745                 (PatKind::TupleStruct(ref path_left, ref patterns, _), PatKind::Path(ref path_right))
1746                 | (PatKind::Path(ref path_left), PatKind::TupleStruct(ref path_right, ref patterns, _))
1747                     if patterns.len() == 1 =>
1748                 {
1749                     if let PatKind::Wild = patterns[0].kind {
1750                         find_good_method_for_match(
1751                             arms,
1752                             path_left,
1753                             path_right,
1754                             &paths::OPTION_SOME,
1755                             &paths::OPTION_NONE,
1756                             "is_some()",
1757                             "is_none()",
1758                         )
1759                         .or_else(|| {
1760                             find_good_method_for_match(
1761                                 arms,
1762                                 path_left,
1763                                 path_right,
1764                                 &paths::POLL_READY,
1765                                 &paths::POLL_PENDING,
1766                                 "is_ready()",
1767                                 "is_pending()",
1768                             )
1769                         })
1770                     } else {
1771                         None
1772                     }
1773                 },
1774                 _ => None,
1775             };
1776
1777             if let Some(good_method) = found_good_method {
1778                 let span = expr.span.to(op.span);
1779                 let result_expr = match &op.kind {
1780                     ExprKind::AddrOf(_, _, borrowed) => borrowed,
1781                     _ => op,
1782                 };
1783                 span_lint_and_then(
1784                     cx,
1785                     REDUNDANT_PATTERN_MATCHING,
1786                     expr.span,
1787                     &format!("redundant pattern matching, consider using `{}`", good_method),
1788                     |diag| {
1789                         diag.span_suggestion(
1790                             span,
1791                             "try this",
1792                             format!("{}.{}", snippet(cx, result_expr.span, "_"), good_method),
1793                             Applicability::MaybeIncorrect, // snippet
1794                         );
1795                     },
1796                 );
1797             }
1798         }
1799     }
1800
1801     fn find_good_method_for_match<'a>(
1802         arms: &[Arm<'_>],
1803         path_left: &QPath<'_>,
1804         path_right: &QPath<'_>,
1805         expected_left: &[&str],
1806         expected_right: &[&str],
1807         should_be_left: &'a str,
1808         should_be_right: &'a str,
1809     ) -> Option<&'a str> {
1810         let body_node_pair = if match_qpath(path_left, expected_left) && match_qpath(path_right, expected_right) {
1811             (&(*arms[0].body).kind, &(*arms[1].body).kind)
1812         } else if match_qpath(path_right, expected_left) && match_qpath(path_left, expected_right) {
1813             (&(*arms[1].body).kind, &(*arms[0].body).kind)
1814         } else {
1815             return None;
1816         };
1817
1818         match body_node_pair {
1819             (ExprKind::Lit(ref lit_left), ExprKind::Lit(ref lit_right)) => match (&lit_left.node, &lit_right.node) {
1820                 (LitKind::Bool(true), LitKind::Bool(false)) => Some(should_be_left),
1821                 (LitKind::Bool(false), LitKind::Bool(true)) => Some(should_be_right),
1822                 _ => None,
1823             },
1824             _ => None,
1825         }
1826     }
1827 }
1828
1829 #[test]
1830 fn test_overlapping() {
1831     use rustc_span::source_map::DUMMY_SP;
1832
1833     let sp = |s, e| SpannedRange {
1834         span: DUMMY_SP,
1835         node: (s, e),
1836     };
1837
1838     assert_eq!(None, overlapping::<u8>(&[]));
1839     assert_eq!(None, overlapping(&[sp(1, Bound::Included(4))]));
1840     assert_eq!(
1841         None,
1842         overlapping(&[sp(1, Bound::Included(4)), sp(5, Bound::Included(6))])
1843     );
1844     assert_eq!(
1845         None,
1846         overlapping(&[
1847             sp(1, Bound::Included(4)),
1848             sp(5, Bound::Included(6)),
1849             sp(10, Bound::Included(11))
1850         ],)
1851     );
1852     assert_eq!(
1853         Some((&sp(1, Bound::Included(4)), &sp(3, Bound::Included(6)))),
1854         overlapping(&[sp(1, Bound::Included(4)), sp(3, Bound::Included(6))])
1855     );
1856     assert_eq!(
1857         Some((&sp(5, Bound::Included(6)), &sp(6, Bound::Included(11)))),
1858         overlapping(&[
1859             sp(1, Bound::Included(4)),
1860             sp(5, Bound::Included(6)),
1861             sp(6, Bound::Included(11))
1862         ],)
1863     );
1864 }
1865
1866 /// Implementation of `MATCH_SAME_ARMS`.
1867 fn lint_match_arms<'tcx>(cx: &LateContext<'tcx>, expr: &Expr<'_>) {
1868     fn same_bindings<'tcx>(lhs: &FxHashMap<Symbol, Ty<'tcx>>, rhs: &FxHashMap<Symbol, Ty<'tcx>>) -> bool {
1869         lhs.len() == rhs.len()
1870             && lhs
1871                 .iter()
1872                 .all(|(name, l_ty)| rhs.get(name).map_or(false, |r_ty| TyS::same_type(l_ty, r_ty)))
1873     }
1874
1875     if let ExprKind::Match(_, ref arms, MatchSource::Normal) = expr.kind {
1876         let hash = |&(_, arm): &(usize, &Arm<'_>)| -> u64 {
1877             let mut h = SpanlessHash::new(cx);
1878             h.hash_expr(&arm.body);
1879             h.finish()
1880         };
1881
1882         let eq = |&(lindex, lhs): &(usize, &Arm<'_>), &(rindex, rhs): &(usize, &Arm<'_>)| -> bool {
1883             let min_index = usize::min(lindex, rindex);
1884             let max_index = usize::max(lindex, rindex);
1885
1886             // Arms with a guard are ignored, those can’t always be merged together
1887             // This is also the case for arms in-between each there is an arm with a guard
1888             (min_index..=max_index).all(|index| arms[index].guard.is_none()) &&
1889                 SpanlessEq::new(cx).eq_expr(&lhs.body, &rhs.body) &&
1890                 // all patterns should have the same bindings
1891                 same_bindings(&bindings(cx, &lhs.pat), &bindings(cx, &rhs.pat))
1892         };
1893
1894         let indexed_arms: Vec<(usize, &Arm<'_>)> = arms.iter().enumerate().collect();
1895         for (&(_, i), &(_, j)) in search_same(&indexed_arms, hash, eq) {
1896             span_lint_and_then(
1897                 cx,
1898                 MATCH_SAME_ARMS,
1899                 j.body.span,
1900                 "this `match` has identical arm bodies",
1901                 |diag| {
1902                     diag.span_note(i.body.span, "same as this");
1903
1904                     // Note: this does not use `span_suggestion` on purpose:
1905                     // there is no clean way
1906                     // to remove the other arm. Building a span and suggest to replace it to ""
1907                     // makes an even more confusing error message. Also in order not to make up a
1908                     // span for the whole pattern, the suggestion is only shown when there is only
1909                     // one pattern. The user should know about `|` if they are already using it…
1910
1911                     let lhs = snippet(cx, i.pat.span, "<pat1>");
1912                     let rhs = snippet(cx, j.pat.span, "<pat2>");
1913
1914                     if let PatKind::Wild = j.pat.kind {
1915                         // if the last arm is _, then i could be integrated into _
1916                         // note that i.pat cannot be _, because that would mean that we're
1917                         // hiding all the subsequent arms, and rust won't compile
1918                         diag.span_note(
1919                             i.body.span,
1920                             &format!(
1921                                 "`{}` has the same arm body as the `_` wildcard, consider removing it",
1922                                 lhs
1923                             ),
1924                         );
1925                     } else {
1926                         diag.span_help(i.pat.span, &format!("consider refactoring into `{} | {}`", lhs, rhs));
1927                     }
1928                 },
1929             );
1930         }
1931     }
1932 }
1933
1934 /// Returns the list of bindings in a pattern.
1935 fn bindings<'tcx>(cx: &LateContext<'tcx>, pat: &Pat<'_>) -> FxHashMap<Symbol, Ty<'tcx>> {
1936     fn bindings_impl<'tcx>(cx: &LateContext<'tcx>, pat: &Pat<'_>, map: &mut FxHashMap<Symbol, Ty<'tcx>>) {
1937         match pat.kind {
1938             PatKind::Box(ref pat) | PatKind::Ref(ref pat, _) => bindings_impl(cx, pat, map),
1939             PatKind::TupleStruct(_, pats, _) => {
1940                 for pat in pats {
1941                     bindings_impl(cx, pat, map);
1942                 }
1943             },
1944             PatKind::Binding(.., ident, ref as_pat) => {
1945                 if let Entry::Vacant(v) = map.entry(ident.name) {
1946                     v.insert(cx.typeck_results().pat_ty(pat));
1947                 }
1948                 if let Some(ref as_pat) = *as_pat {
1949                     bindings_impl(cx, as_pat, map);
1950                 }
1951             },
1952             PatKind::Or(fields) | PatKind::Tuple(fields, _) => {
1953                 for pat in fields {
1954                     bindings_impl(cx, pat, map);
1955                 }
1956             },
1957             PatKind::Struct(_, fields, _) => {
1958                 for pat in fields {
1959                     bindings_impl(cx, &pat.pat, map);
1960                 }
1961             },
1962             PatKind::Slice(lhs, ref mid, rhs) => {
1963                 for pat in lhs {
1964                     bindings_impl(cx, pat, map);
1965                 }
1966                 if let Some(ref mid) = *mid {
1967                     bindings_impl(cx, mid, map);
1968                 }
1969                 for pat in rhs {
1970                     bindings_impl(cx, pat, map);
1971                 }
1972             },
1973             PatKind::Lit(..) | PatKind::Range(..) | PatKind::Wild | PatKind::Path(..) => (),
1974         }
1975     }
1976
1977     let mut result = FxHashMap::default();
1978     bindings_impl(cx, pat, &mut result);
1979     result
1980 }