clippy_lints/src/matches.rs

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