clippy_lints/src/matches.rs

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