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_refutable, is_wild, match_qpath, 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_data_structures::fx::{FxHashMap, FxHashSet};
  17 use rustc_errors::Applicability;
  18 use rustc_hir::def::{CtorKind, DefKind, Res};
  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_lint::{LateContext, LateLintPass, LintContext};
  24 use rustc_middle::lint::in_external_macro;
  25 use rustc_middle::ty::{self, Ty, TyS, VariantDef};
  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 enum CommonPrefixSearcher<'a> {
 960     None,
 961     Path(&'a [PathSegment<'a>]),
 962     Mixed,
 963 }
 964 impl CommonPrefixSearcher<'a> {
 965     fn with_path(&mut self, path: &'a [PathSegment<'a>]) {
 966         match path {
 967             [path @ .., _] => self.with_prefix(path),
 968             [] => (),
 969         }
 970     }
 971
 972     fn with_prefix(&mut self, path: &'a [PathSegment<'a>]) {
 973         match self {
 974             Self::None => *self = Self::Path(path),
 975             Self::Path(self_path)
 976                 if path
 977                     .iter()
 978                     .map(|p| p.ident.name)
 979                     .eq(self_path.iter().map(|p| p.ident.name)) => {},
 980             Self::Path(_) => *self = Self::Mixed,
 981             Self::Mixed => (),
 982         }
 983     }
 984 }
 985
 986 #[allow(clippy::too_many_lines)]
 987 fn check_wild_enum_match(cx: &LateContext<'_>, ex: &Expr<'_>, arms: &[Arm<'_>]) {
 988     let ty = cx.typeck_results().expr_ty(ex).peel_refs();
 989     let adt_def = match ty.kind() {
 990         ty::Adt(adt_def, _)
 991             if adt_def.is_enum()
 992                 && !(is_type_diagnostic_item(cx, ty, sym::option_type)
 993                     || is_type_diagnostic_item(cx, ty, sym::result_type)) =>
 994         {
 995             adt_def
 996         },
 997         _ => return,
 998     };
 999
1000     // First pass - check for violation, but don't do much book-keeping because this is hopefully
1001     // the uncommon case, and the book-keeping is slightly expensive.
1002     let mut wildcard_span = None;
1003     let mut wildcard_ident = None;
1004     let mut has_non_wild = false;
1005     for arm in arms {
1006         match peel_hir_pat_refs(arm.pat).0.kind {
1007             PatKind::Wild => wildcard_span = Some(arm.pat.span),
1008             PatKind::Binding(_, _, ident, None) => {
1009                 wildcard_span = Some(arm.pat.span);
1010                 wildcard_ident = Some(ident);
1011             },
1012             _ => has_non_wild = true,
1013         }
1014     }
1015     let wildcard_span = match wildcard_span {
1016         Some(x) if has_non_wild => x,
1017         _ => return,
1018     };
1019
1020     // Accumulate the variants which should be put in place of the wildcard because they're not
1021     // already covered.
1022     let mut missing_variants: Vec<_> = adt_def.variants.iter().collect();
1023
1024     let mut path_prefix = CommonPrefixSearcher::None;
1025     for arm in arms {
1026         // Guards mean that this case probably isn't exhaustively covered. Technically
1027         // this is incorrect, as we should really check whether each variant is exhaustively
1028         // covered by the set of guards that cover it, but that's really hard to do.
1029         recurse_or_patterns(arm.pat, |pat| {
1030             let path = match &peel_hir_pat_refs(pat).0.kind {
1031                 PatKind::Path(path) => {
1032                     #[allow(clippy::match_same_arms)]
1033                     let id = match cx.qpath_res(path, pat.hir_id) {
1034                         Res::Def(DefKind::Const | DefKind::ConstParam | DefKind::AnonConst, _) => return,
1035                         Res::Def(_, id) => id,
1036                         _ => return,
1037                     };
1038                     if arm.guard.is_none() {
1039                         missing_variants.retain(|e| e.ctor_def_id != Some(id));
1040                     }
1041                     path
1042                 },
1043                 PatKind::TupleStruct(path, patterns, ..) => {
1044                     if arm.guard.is_none() && patterns.iter().all(|p| !is_refutable(cx, p)) {
1045                         let id = cx.qpath_res(path, pat.hir_id).def_id();
1046                         missing_variants.retain(|e| e.ctor_def_id != Some(id));
1047                     }
1048                     path
1049                 },
1050                 PatKind::Struct(path, patterns, ..) => {
1051                     if arm.guard.is_none() && patterns.iter().all(|p| !is_refutable(cx, p.pat)) {
1052                         let id = cx.qpath_res(path, pat.hir_id).def_id();
1053                         missing_variants.retain(|e| e.def_id != id);
1054                     }
1055                     path
1056                 },
1057                 _ => return,
1058             };
1059             match path {
1060                 QPath::Resolved(_, path) => path_prefix.with_path(path.segments),
1061                 QPath::TypeRelative(
1062                     hir::Ty {
1063                         kind: TyKind::Path(QPath::Resolved(_, path)),
1064                         ..
1065                     },
1066                     _,
1067                 ) => path_prefix.with_prefix(path.segments),
1068                 _ => (),
1069             }
1070         });
1071     }
1072
1073     let format_suggestion = |variant: &VariantDef| {
1074         format!(
1075             "{}{}{}{}",
1076             if let Some(ident) = wildcard_ident {
1077                 format!("{} @ ", ident.name)
1078             } else {
1079                 String::new()
1080             },
1081             if let CommonPrefixSearcher::Path(path_prefix) = path_prefix {
1082                 let mut s = String::new();
1083                 for seg in path_prefix {
1084                     s.push_str(&seg.ident.as_str());
1085                     s.push_str("::");
1086                 }
1087                 s
1088             } else {
1089                 let mut s = cx.tcx.def_path_str(adt_def.did);
1090                 s.push_str("::");
1091                 s
1092             },
1093             variant.ident.name,
1094             match variant.ctor_kind {
1095                 CtorKind::Fn if variant.fields.len() == 1 => "(_)",
1096                 CtorKind::Fn => "(..)",
1097                 CtorKind::Const => "",
1098                 CtorKind::Fictive => "{ .. }",
1099             }
1100         )
1101     };
1102
1103     match missing_variants.as_slice() {
1104         [] => (),
1105         [x] if !adt_def.is_variant_list_non_exhaustive() => span_lint_and_sugg(
1106             cx,
1107             MATCH_WILDCARD_FOR_SINGLE_VARIANTS,
1108             wildcard_span,
1109             "wildcard matches only a single variant and will also match any future added variants",
1110             "try this",
1111             format_suggestion(x),
1112             Applicability::MaybeIncorrect,
1113         ),
1114         variants => {
1115             let mut suggestions: Vec<_> = variants.iter().cloned().map(format_suggestion).collect();
1116             let message = if adt_def.is_variant_list_non_exhaustive() {
1117                 suggestions.push("_".into());
1118                 "wildcard matches known variants and will also match future added variants"
1119             } else {
1120                 "wildcard match will also match any future added variants"
1121             };
1122
1123             span_lint_and_sugg(
1124                 cx,
1125                 WILDCARD_ENUM_MATCH_ARM,
1126                 wildcard_span,
1127                 message,
1128                 "try this",
1129                 suggestions.join(" | "),
1130                 Applicability::MaybeIncorrect,
1131             )
1132         },
1133     };
1134 }
1135
1136 // If the block contains only a `panic!` macro (as expression or statement)
1137 fn is_panic_block(block: &Block<'_>) -> bool {
1138     match (&block.expr, block.stmts.len(), block.stmts.first()) {
1139         (&Some(ref exp), 0, _) => {
1140             is_expn_of(exp.span, "panic").is_some() && is_expn_of(exp.span, "unreachable").is_none()
1141         },
1142         (&None, 1, Some(stmt)) => {
1143             is_expn_of(stmt.span, "panic").is_some() && is_expn_of(stmt.span, "unreachable").is_none()
1144         },
1145         _ => false,
1146     }
1147 }
1148
1149 fn check_match_ref_pats(cx: &LateContext<'_>, ex: &Expr<'_>, arms: &[Arm<'_>], expr: &Expr<'_>) {
1150     if has_only_ref_pats(arms) {
1151         let mut suggs = Vec::with_capacity(arms.len() + 1);
1152         let (title, msg) = if let ExprKind::AddrOf(BorrowKind::Ref, Mutability::Not, ref inner) = ex.kind {
1153             let span = ex.span.source_callsite();
1154             suggs.push((span, Sugg::hir_with_macro_callsite(cx, inner, "..").to_string()));
1155             (
1156                 "you don't need to add `&` to both the expression and the patterns",
1157                 "try",
1158             )
1159         } else {
1160             let span = ex.span.source_callsite();
1161             suggs.push((span, Sugg::hir_with_macro_callsite(cx, ex, "..").deref().to_string()));
1162             (
1163                 "you don't need to add `&` to all patterns",
1164                 "instead of prefixing all patterns with `&`, you can dereference the expression",
1165             )
1166         };
1167
1168         suggs.extend(arms.iter().filter_map(|a| {
1169             if let PatKind::Ref(ref refp, _) = a.pat.kind {
1170                 Some((a.pat.span, snippet(cx, refp.span, "..").to_string()))
1171             } else {
1172                 None
1173             }
1174         }));
1175
1176         span_lint_and_then(cx, MATCH_REF_PATS, expr.span, title, |diag| {
1177             if !expr.span.from_expansion() {
1178                 multispan_sugg(diag, msg, suggs);
1179             }
1180         });
1181     }
1182 }
1183
1184 fn check_match_as_ref(cx: &LateContext<'_>, ex: &Expr<'_>, arms: &[Arm<'_>], expr: &Expr<'_>) {
1185     if arms.len() == 2 && arms[0].guard.is_none() && arms[1].guard.is_none() {
1186         let arm_ref: Option<BindingAnnotation> = if is_none_arm(&arms[0]) {
1187             is_ref_some_arm(&arms[1])
1188         } else if is_none_arm(&arms[1]) {
1189             is_ref_some_arm(&arms[0])
1190         } else {
1191             None
1192         };
1193         if let Some(rb) = arm_ref {
1194             let suggestion = if rb == BindingAnnotation::Ref {
1195                 "as_ref"
1196             } else {
1197                 "as_mut"
1198             };
1199
1200             let output_ty = cx.typeck_results().expr_ty(expr);
1201             let input_ty = cx.typeck_results().expr_ty(ex);
1202
1203             let cast = if_chain! {
1204                 if let ty::Adt(_, substs) = input_ty.kind();
1205                 let input_ty = substs.type_at(0);
1206                 if let ty::Adt(_, substs) = output_ty.kind();
1207                 let output_ty = substs.type_at(0);
1208                 if let ty::Ref(_, output_ty, _) = *output_ty.kind();
1209                 if input_ty != output_ty;
1210                 then {
1211                     ".map(|x| x as _)"
1212                 } else {
1213                     ""
1214                 }
1215             };
1216
1217             let mut applicability = Applicability::MachineApplicable;
1218             span_lint_and_sugg(
1219                 cx,
1220                 MATCH_AS_REF,
1221                 expr.span,
1222                 &format!("use `{}()` instead", suggestion),
1223                 "try this",
1224                 format!(
1225                     "{}.{}(){}",
1226                     snippet_with_applicability(cx, ex.span, "_", &mut applicability),
1227                     suggestion,
1228                     cast,
1229                 ),
1230                 applicability,
1231             )
1232         }
1233     }
1234 }
1235
1236 fn check_wild_in_or_pats(cx: &LateContext<'_>, arms: &[Arm<'_>]) {
1237     for arm in arms {
1238         if let PatKind::Or(ref fields) = arm.pat.kind {
1239             // look for multiple fields in this arm that contains at least one Wild pattern
1240             if fields.len() > 1 && fields.iter().any(is_wild) {
1241                 span_lint_and_help(
1242                     cx,
1243                     WILDCARD_IN_OR_PATTERNS,
1244                     arm.pat.span,
1245                     "wildcard pattern covers any other pattern as it will match anyway",
1246                     None,
1247                     "consider handling `_` separately",
1248                 );
1249             }
1250         }
1251     }
1252 }
1253
1254 /// Lint a `match` or `if let .. { .. } else { .. }` expr that could be replaced by `matches!`
1255 fn check_match_like_matches<'tcx>(cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) -> bool {
1256     if let ExprKind::Match(ex, arms, ref match_source) = &expr.kind {
1257         match match_source {
1258             MatchSource::Normal => find_matches_sugg(cx, ex, arms, expr, false),
1259             MatchSource::IfLetDesugar { .. } => find_matches_sugg(cx, ex, arms, expr, true),
1260             _ => false,
1261         }
1262     } else {
1263         false
1264     }
1265 }
1266
1267 /// Lint a `match` or desugared `if let` for replacement by `matches!`
1268 fn find_matches_sugg(cx: &LateContext<'_>, ex: &Expr<'_>, arms: &[Arm<'_>], expr: &Expr<'_>, desugared: bool) -> bool {
1269     if_chain! {
1270         if arms.len() >= 2;
1271         if cx.typeck_results().expr_ty(expr).is_bool();
1272         if let Some((b1_arm, b0_arms)) = arms.split_last();
1273         if let Some(b0) = find_bool_lit(&b0_arms[0].body.kind, desugared);
1274         if let Some(b1) = find_bool_lit(&b1_arm.body.kind, desugared);
1275         if is_wild(&b1_arm.pat);
1276         if b0 != b1;
1277         let if_guard = &b0_arms[0].guard;
1278         if if_guard.is_none() || b0_arms.len() == 1;
1279         if cx.tcx.hir().attrs(b0_arms[0].hir_id).is_empty();
1280         if b0_arms[1..].iter()
1281             .all(|arm| {
1282                 find_bool_lit(&arm.body.kind, desugared).map_or(false, |b| b == b0) &&
1283                 arm.guard.is_none() && cx.tcx.hir().attrs(arm.hir_id).is_empty()
1284             });
1285         then {
1286             // The suggestion may be incorrect, because some arms can have `cfg` attributes
1287             // evaluated into `false` and so such arms will be stripped before.
1288             let mut applicability = Applicability::MaybeIncorrect;
1289             let pat = {
1290                 use itertools::Itertools as _;
1291                 b0_arms.iter()
1292                     .map(|arm| snippet_with_applicability(cx, arm.pat.span, "..", &mut applicability))
1293                     .join(" | ")
1294             };
1295             let pat_and_guard = if let Some(Guard::If(g)) = if_guard {
1296                 format!("{} if {}", pat, snippet_with_applicability(cx, g.span, "..", &mut applicability))
1297             } else {
1298                 pat
1299             };
1300
1301             // strip potential borrows (#6503), but only if the type is a reference
1302             let mut ex_new = ex;
1303             if let ExprKind::AddrOf(BorrowKind::Ref, .., ex_inner) = ex.kind {
1304                 if let ty::Ref(..) = cx.typeck_results().expr_ty(&ex_inner).kind() {
1305                     ex_new = ex_inner;
1306                 }
1307             };
1308             span_lint_and_sugg(
1309                 cx,
1310                 MATCH_LIKE_MATCHES_MACRO,
1311                 expr.span,
1312                 &format!("{} expression looks like `matches!` macro", if desugared { "if let .. else" } else { "match" }),
1313                 "try this",
1314                 format!(
1315                     "{}matches!({}, {})",
1316                     if b0 { "" } else { "!" },
1317                     snippet_with_applicability(cx, ex_new.span, "..", &mut applicability),
1318                     pat_and_guard,
1319                 ),
1320                 applicability,
1321             );
1322             true
1323         } else {
1324             false
1325         }
1326     }
1327 }
1328
1329 /// Extract a `bool` or `{ bool }`
1330 fn find_bool_lit(ex: &ExprKind<'_>, desugared: bool) -> Option<bool> {
1331     match ex {
1332         ExprKind::Lit(Spanned {
1333             node: LitKind::Bool(b), ..
1334         }) => Some(*b),
1335         ExprKind::Block(
1336             rustc_hir::Block {
1337                 stmts: &[],
1338                 expr: Some(exp),
1339                 ..
1340             },
1341             _,
1342         ) if desugared => {
1343             if let ExprKind::Lit(Spanned {
1344                 node: LitKind::Bool(b), ..
1345             }) = exp.kind
1346             {
1347                 Some(b)
1348             } else {
1349                 None
1350             }
1351         },
1352         _ => None,
1353     }
1354 }
1355
1356 fn check_match_single_binding<'a>(cx: &LateContext<'a>, ex: &Expr<'a>, arms: &[Arm<'_>], expr: &Expr<'_>) {
1357     if in_macro(expr.span) || arms.len() != 1 || is_refutable(cx, arms[0].pat) {
1358         return;
1359     }
1360
1361     // HACK:
1362     // This is a hack to deal with arms that are excluded by macros like `#[cfg]`. It is only used here
1363     // to prevent false positives as there is currently no better way to detect if code was excluded by
1364     // a macro. See PR #6435
1365     if_chain! {
1366         if let Some(match_snippet) = snippet_opt(cx, expr.span);
1367         if let Some(arm_snippet) = snippet_opt(cx, arms[0].span);
1368         if let Some(ex_snippet) = snippet_opt(cx, ex.span);
1369         let rest_snippet = match_snippet.replace(&arm_snippet, "").replace(&ex_snippet, "");
1370         if rest_snippet.contains("=>");
1371         then {
1372             // The code it self contains another thick arrow "=>"
1373             // -> Either another arm or a comment
1374             return;
1375         }
1376     }
1377
1378     let matched_vars = ex.span;
1379     let bind_names = arms[0].pat.span;
1380     let match_body = remove_blocks(&arms[0].body);
1381     let mut snippet_body = if match_body.span.from_expansion() {
1382         Sugg::hir_with_macro_callsite(cx, match_body, "..").to_string()
1383     } else {
1384         snippet_block(cx, match_body.span, "..", Some(expr.span)).to_string()
1385     };
1386
1387     // Do we need to add ';' to suggestion ?
1388     match match_body.kind {
1389         ExprKind::Block(block, _) => {
1390             // macro + expr_ty(body) == ()
1391             if block.span.from_expansion() && cx.typeck_results().expr_ty(&match_body).is_unit() {
1392                 snippet_body.push(';');
1393             }
1394         },
1395         _ => {
1396             // expr_ty(body) == ()
1397             if cx.typeck_results().expr_ty(&match_body).is_unit() {
1398                 snippet_body.push(';');
1399             }
1400         },
1401     }
1402
1403     let mut applicability = Applicability::MaybeIncorrect;
1404     match arms[0].pat.kind {
1405         PatKind::Binding(..) | PatKind::Tuple(_, _) | PatKind::Struct(..) => {
1406             // If this match is in a local (`let`) stmt
1407             let (target_span, sugg) = if let Some(parent_let_node) = opt_parent_let(cx, ex) {
1408                 (
1409                     parent_let_node.span,
1410                     format!(
1411                         "let {} = {};\n{}let {} = {};",
1412                         snippet_with_applicability(cx, bind_names, "..", &mut applicability),
1413                         snippet_with_applicability(cx, matched_vars, "..", &mut applicability),
1414                         " ".repeat(indent_of(cx, expr.span).unwrap_or(0)),
1415                         snippet_with_applicability(cx, parent_let_node.pat.span, "..", &mut applicability),
1416                         snippet_body
1417                     ),
1418                 )
1419             } else {
1420                 // If we are in closure, we need curly braces around suggestion
1421                 let mut indent = " ".repeat(indent_of(cx, ex.span).unwrap_or(0));
1422                 let (mut cbrace_start, mut cbrace_end) = ("".to_string(), "".to_string());
1423                 if let Some(parent_expr) = get_parent_expr(cx, expr) {
1424                     if let ExprKind::Closure(..) = parent_expr.kind {
1425                         cbrace_end = format!("\n{}}}", indent);
1426                         // Fix body indent due to the closure
1427                         indent = " ".repeat(indent_of(cx, bind_names).unwrap_or(0));
1428                         cbrace_start = format!("{{\n{}", indent);
1429                     }
1430                 };
1431                 (
1432                     expr.span,
1433                     format!(
1434                         "{}let {} = {};\n{}{}{}",
1435                         cbrace_start,
1436                         snippet_with_applicability(cx, bind_names, "..", &mut applicability),
1437                         snippet_with_applicability(cx, matched_vars, "..", &mut applicability),
1438                         indent,
1439                         snippet_body,
1440                         cbrace_end
1441                     ),
1442                 )
1443             };
1444             span_lint_and_sugg(
1445                 cx,
1446                 MATCH_SINGLE_BINDING,
1447                 target_span,
1448                 "this match could be written as a `let` statement",
1449                 "consider using `let` statement",
1450                 sugg,
1451                 applicability,
1452             );
1453         },
1454         PatKind::Wild => {
1455             span_lint_and_sugg(
1456                 cx,
1457                 MATCH_SINGLE_BINDING,
1458                 expr.span,
1459                 "this match could be replaced by its body itself",
1460                 "consider using the match body instead",
1461                 snippet_body,
1462                 Applicability::MachineApplicable,
1463             );
1464         },
1465         _ => (),
1466     }
1467 }
1468
1469 /// Returns true if the `ex` match expression is in a local (`let`) statement
1470 fn opt_parent_let<'a>(cx: &LateContext<'a>, ex: &Expr<'a>) -> Option<&'a Local<'a>> {
1471     if_chain! {
1472         let map = &cx.tcx.hir();
1473         if let Some(Node::Expr(parent_arm_expr)) = map.find(map.get_parent_node(ex.hir_id));
1474         if let Some(Node::Local(parent_let_expr)) = map.find(map.get_parent_node(parent_arm_expr.hir_id));
1475         then {
1476             return Some(parent_let_expr);
1477         }
1478     }
1479     None
1480 }
1481
1482 /// Gets all arms that are unbounded `PatRange`s.
1483 fn all_ranges<'tcx>(cx: &LateContext<'tcx>, arms: &'tcx [Arm<'_>], ty: Ty<'tcx>) -> Vec<SpannedRange<Constant>> {
1484     arms.iter()
1485         .flat_map(|arm| {
1486             if let Arm {
1487                 ref pat, guard: None, ..
1488             } = *arm
1489             {
1490                 if let PatKind::Range(ref lhs, ref rhs, range_end) = pat.kind {
1491                     let lhs = match lhs {
1492                         Some(lhs) => constant(cx, cx.typeck_results(), lhs)?.0,
1493                         None => miri_to_const(ty.numeric_min_val(cx.tcx)?)?,
1494                     };
1495                     let rhs = match rhs {
1496                         Some(rhs) => constant(cx, cx.typeck_results(), rhs)?.0,
1497                         None => miri_to_const(ty.numeric_max_val(cx.tcx)?)?,
1498                     };
1499                     let rhs = match range_end {
1500                         RangeEnd::Included => Bound::Included(rhs),
1501                         RangeEnd::Excluded => Bound::Excluded(rhs),
1502                     };
1503                     return Some(SpannedRange {
1504                         span: pat.span,
1505                         node: (lhs, rhs),
1506                     });
1507                 }
1508
1509                 if let PatKind::Lit(ref value) = pat.kind {
1510                     let value = constant(cx, cx.typeck_results(), value)?.0;
1511                     return Some(SpannedRange {
1512                         span: pat.span,
1513                         node: (value.clone(), Bound::Included(value)),
1514                     });
1515                 }
1516             }
1517             None
1518         })
1519         .collect()
1520 }
1521
1522 #[derive(Debug, Eq, PartialEq)]
1523 pub struct SpannedRange<T> {
1524     pub span: Span,
1525     pub node: (T, Bound<T>),
1526 }
1527
1528 type TypedRanges = Vec<SpannedRange<u128>>;
1529
1530 /// Gets all `Int` ranges or all `Uint` ranges. Mixed types are an error anyway
1531 /// and other types than
1532 /// `Uint` and `Int` probably don't make sense.
1533 fn type_ranges(ranges: &[SpannedRange<Constant>]) -> TypedRanges {
1534     ranges
1535         .iter()
1536         .filter_map(|range| match range.node {
1537             (Constant::Int(start), Bound::Included(Constant::Int(end))) => Some(SpannedRange {
1538                 span: range.span,
1539                 node: (start, Bound::Included(end)),
1540             }),
1541             (Constant::Int(start), Bound::Excluded(Constant::Int(end))) => Some(SpannedRange {
1542                 span: range.span,
1543                 node: (start, Bound::Excluded(end)),
1544             }),
1545             (Constant::Int(start), Bound::Unbounded) => Some(SpannedRange {
1546                 span: range.span,
1547                 node: (start, Bound::Unbounded),
1548             }),
1549             _ => None,
1550         })
1551         .collect()
1552 }
1553
1554 fn is_unit_expr(expr: &Expr<'_>) -> bool {
1555     match expr.kind {
1556         ExprKind::Tup(ref v) if v.is_empty() => true,
1557         ExprKind::Block(ref b, _) if b.stmts.is_empty() && b.expr.is_none() => true,
1558         _ => false,
1559     }
1560 }
1561
1562 // Checks if arm has the form `None => None`
1563 fn is_none_arm(arm: &Arm<'_>) -> bool {
1564     matches!(arm.pat.kind, PatKind::Path(ref path) if match_qpath(path, &paths::OPTION_NONE))
1565 }
1566
1567 // Checks if arm has the form `Some(ref v) => Some(v)` (checks for `ref` and `ref mut`)
1568 fn is_ref_some_arm(arm: &Arm<'_>) -> Option<BindingAnnotation> {
1569     if_chain! {
1570         if let PatKind::TupleStruct(ref path, ref pats, _) = arm.pat.kind;
1571         if pats.len() == 1 && match_qpath(path, &paths::OPTION_SOME);
1572         if let PatKind::Binding(rb, .., ident, _) = pats[0].kind;
1573         if rb == BindingAnnotation::Ref || rb == BindingAnnotation::RefMut;
1574         if let ExprKind::Call(ref e, ref args) = remove_blocks(&arm.body).kind;
1575         if let ExprKind::Path(ref some_path) = e.kind;
1576         if match_qpath(some_path, &paths::OPTION_SOME) && args.len() == 1;
1577         if let ExprKind::Path(QPath::Resolved(_, ref path2)) = args[0].kind;
1578         if path2.segments.len() == 1 && ident.name == path2.segments[0].ident.name;
1579         then {
1580             return Some(rb)
1581         }
1582     }
1583     None
1584 }
1585
1586 fn has_only_ref_pats(arms: &[Arm<'_>]) -> bool {
1587     let mapped = arms
1588         .iter()
1589         .map(|a| {
1590             match a.pat.kind {
1591                 PatKind::Ref(..) => Some(true), // &-patterns
1592                 PatKind::Wild => Some(false),   // an "anything" wildcard is also fine
1593                 _ => None,                      // any other pattern is not fine
1594             }
1595         })
1596         .collect::<Option<Vec<bool>>>();
1597     // look for Some(v) where there's at least one true element
1598     mapped.map_or(false, |v| v.iter().any(|el| *el))
1599 }
1600
1601 pub fn overlapping<T>(ranges: &[SpannedRange<T>]) -> Option<(&SpannedRange<T>, &SpannedRange<T>)>
1602 where
1603     T: Copy + Ord,
1604 {
1605     #[derive(Copy, Clone, Debug, Eq, PartialEq)]
1606     enum Kind<'a, T> {
1607         Start(T, &'a SpannedRange<T>),
1608         End(Bound<T>, &'a SpannedRange<T>),
1609     }
1610
1611     impl<'a, T: Copy> Kind<'a, T> {
1612         fn range(&self) -> &'a SpannedRange<T> {
1613             match *self {
1614                 Kind::Start(_, r) | Kind::End(_, r) => r,
1615             }
1616         }
1617
1618         fn value(self) -> Bound<T> {
1619             match self {
1620                 Kind::Start(t, _) => Bound::Included(t),
1621                 Kind::End(t, _) => t,
1622             }
1623         }
1624     }
1625
1626     impl<'a, T: Copy + Ord> PartialOrd for Kind<'a, T> {
1627         fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
1628             Some(self.cmp(other))
1629         }
1630     }
1631
1632     impl<'a, T: Copy + Ord> Ord for Kind<'a, T> {
1633         fn cmp(&self, other: &Self) -> Ordering {
1634             match (self.value(), other.value()) {
1635                 (Bound::Included(a), Bound::Included(b)) | (Bound::Excluded(a), Bound::Excluded(b)) => a.cmp(&b),
1636                 // Range patterns cannot be unbounded (yet)
1637                 (Bound::Unbounded, _) | (_, Bound::Unbounded) => unimplemented!(),
1638                 (Bound::Included(a), Bound::Excluded(b)) => match a.cmp(&b) {
1639                     Ordering::Equal => Ordering::Greater,
1640                     other => other,
1641                 },
1642                 (Bound::Excluded(a), Bound::Included(b)) => match a.cmp(&b) {
1643                     Ordering::Equal => Ordering::Less,
1644                     other => other,
1645                 },
1646             }
1647         }
1648     }
1649
1650     let mut values = Vec::with_capacity(2 * ranges.len());
1651
1652     for r in ranges {
1653         values.push(Kind::Start(r.node.0, r));
1654         values.push(Kind::End(r.node.1, r));
1655     }
1656
1657     values.sort();
1658
1659     for (a, b) in values.iter().zip(values.iter().skip(1)) {
1660         match (a, b) {
1661             (&Kind::Start(_, ra), &Kind::End(_, rb)) => {
1662                 if ra.node != rb.node {
1663                     return Some((ra, rb));
1664                 }
1665             },
1666             (&Kind::End(a, _), &Kind::Start(b, _)) if a != Bound::Included(b) => (),
1667             _ => {
1668                 // skip if the range `a` is completely included into the range `b`
1669                 if let Ordering::Equal | Ordering::Less = a.cmp(&b) {
1670                     let kind_a = Kind::End(a.range().node.1, a.range());
1671                     let kind_b = Kind::End(b.range().node.1, b.range());
1672                     if let Ordering::Equal | Ordering::Greater = kind_a.cmp(&kind_b) {
1673                         return None;
1674                     }
1675                 }
1676                 return Some((a.range(), b.range()));
1677             },
1678         }
1679     }
1680
1681     None
1682 }
1683
1684 mod redundant_pattern_match {
1685     use super::REDUNDANT_PATTERN_MATCHING;
1686     use clippy_utils::diagnostics::span_lint_and_then;
1687     use clippy_utils::source::snippet;
1688     use clippy_utils::{is_trait_method, match_qpath, paths};
1689     use if_chain::if_chain;
1690     use rustc_ast::ast::LitKind;
1691     use rustc_errors::Applicability;
1692     use rustc_hir::{Arm, Expr, ExprKind, MatchSource, PatKind, QPath};
1693     use rustc_lint::LateContext;
1694     use rustc_span::sym;
1695
1696     pub fn check<'tcx>(cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) {
1697         if let ExprKind::Match(op, arms, ref match_source) = &expr.kind {
1698             match match_source {
1699                 MatchSource::Normal => find_sugg_for_match(cx, expr, op, arms),
1700                 MatchSource::IfLetDesugar { .. } => find_sugg_for_if_let(cx, expr, op, arms, "if"),
1701                 MatchSource::WhileLetDesugar => find_sugg_for_if_let(cx, expr, op, arms, "while"),
1702                 _ => {},
1703             }
1704         }
1705     }
1706
1707     fn find_sugg_for_if_let<'tcx>(
1708         cx: &LateContext<'tcx>,
1709         expr: &'tcx Expr<'_>,
1710         op: &Expr<'_>,
1711         arms: &[Arm<'_>],
1712         keyword: &'static str,
1713     ) {
1714         let good_method = match arms[0].pat.kind {
1715             PatKind::TupleStruct(ref path, ref patterns, _) if patterns.len() == 1 => {
1716                 if let PatKind::Wild = patterns[0].kind {
1717                     if match_qpath(path, &paths::RESULT_OK) {
1718                         "is_ok()"
1719                     } else if match_qpath(path, &paths::RESULT_ERR) {
1720                         "is_err()"
1721                     } else if match_qpath(path, &paths::OPTION_SOME) {
1722                         "is_some()"
1723                     } else if match_qpath(path, &paths::POLL_READY) {
1724                         "is_ready()"
1725                     } else if match_qpath(path, &paths::IPADDR_V4) {
1726                         "is_ipv4()"
1727                     } else if match_qpath(path, &paths::IPADDR_V6) {
1728                         "is_ipv6()"
1729                     } else {
1730                         return;
1731                     }
1732                 } else {
1733                     return;
1734                 }
1735             },
1736             PatKind::Path(ref path) => {
1737                 if match_qpath(path, &paths::OPTION_NONE) {
1738                     "is_none()"
1739                 } else if match_qpath(path, &paths::POLL_PENDING) {
1740                     "is_pending()"
1741                 } else {
1742                     return;
1743                 }
1744             },
1745             _ => return,
1746         };
1747
1748         // check that `while_let_on_iterator` lint does not trigger
1749         if_chain! {
1750             if keyword == "while";
1751             if let ExprKind::MethodCall(method_path, _, _, _) = op.kind;
1752             if method_path.ident.name == sym::next;
1753             if is_trait_method(cx, op, sym::Iterator);
1754             then {
1755                 return;
1756             }
1757         }
1758
1759         let result_expr = match &op.kind {
1760             ExprKind::AddrOf(_, _, borrowed) => borrowed,
1761             _ => op,
1762         };
1763         span_lint_and_then(
1764             cx,
1765             REDUNDANT_PATTERN_MATCHING,
1766             arms[0].pat.span,
1767             &format!("redundant pattern matching, consider using `{}`", good_method),
1768             |diag| {
1769                 // while let ... = ... { ... }
1770                 // ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1771                 let expr_span = expr.span;
1772
1773                 // while let ... = ... { ... }
1774                 //                 ^^^
1775                 let op_span = result_expr.span.source_callsite();
1776
1777                 // while let ... = ... { ... }
1778                 // ^^^^^^^^^^^^^^^^^^^
1779                 let span = expr_span.until(op_span.shrink_to_hi());
1780                 diag.span_suggestion(
1781                     span,
1782                     "try this",
1783                     format!("{} {}.{}", keyword, snippet(cx, op_span, "_"), good_method),
1784                     Applicability::MachineApplicable, // snippet
1785                 );
1786             },
1787         );
1788     }
1789
1790     fn find_sugg_for_match<'tcx>(cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>, op: &Expr<'_>, arms: &[Arm<'_>]) {
1791         if arms.len() == 2 {
1792             let node_pair = (&arms[0].pat.kind, &arms[1].pat.kind);
1793
1794             let found_good_method = match node_pair {
1795                 (
1796                     PatKind::TupleStruct(ref path_left, ref patterns_left, _),
1797                     PatKind::TupleStruct(ref path_right, ref patterns_right, _),
1798                 ) if patterns_left.len() == 1 && patterns_right.len() == 1 => {
1799                     if let (PatKind::Wild, PatKind::Wild) = (&patterns_left[0].kind, &patterns_right[0].kind) {
1800                         find_good_method_for_match(
1801                             arms,
1802                             path_left,
1803                             path_right,
1804                             &paths::RESULT_OK,
1805                             &paths::RESULT_ERR,
1806                             "is_ok()",
1807                             "is_err()",
1808                         )
1809                         .or_else(|| {
1810                             find_good_method_for_match(
1811                                 arms,
1812                                 path_left,
1813                                 path_right,
1814                                 &paths::IPADDR_V4,
1815                                 &paths::IPADDR_V6,
1816                                 "is_ipv4()",
1817                                 "is_ipv6()",
1818                             )
1819                         })
1820                     } else {
1821                         None
1822                     }
1823                 },
1824                 (PatKind::TupleStruct(ref path_left, ref patterns, _), PatKind::Path(ref path_right))
1825                 | (PatKind::Path(ref path_left), PatKind::TupleStruct(ref path_right, ref patterns, _))
1826                     if patterns.len() == 1 =>
1827                 {
1828                     if let PatKind::Wild = patterns[0].kind {
1829                         find_good_method_for_match(
1830                             arms,
1831                             path_left,
1832                             path_right,
1833                             &paths::OPTION_SOME,
1834                             &paths::OPTION_NONE,
1835                             "is_some()",
1836                             "is_none()",
1837                         )
1838                         .or_else(|| {
1839                             find_good_method_for_match(
1840                                 arms,
1841                                 path_left,
1842                                 path_right,
1843                                 &paths::POLL_READY,
1844                                 &paths::POLL_PENDING,
1845                                 "is_ready()",
1846                                 "is_pending()",
1847                             )
1848                         })
1849                     } else {
1850                         None
1851                     }
1852                 },
1853                 _ => None,
1854             };
1855
1856             if let Some(good_method) = found_good_method {
1857                 let span = expr.span.to(op.span);
1858                 let result_expr = match &op.kind {
1859                     ExprKind::AddrOf(_, _, borrowed) => borrowed,
1860                     _ => op,
1861                 };
1862                 span_lint_and_then(
1863                     cx,
1864                     REDUNDANT_PATTERN_MATCHING,
1865                     expr.span,
1866                     &format!("redundant pattern matching, consider using `{}`", good_method),
1867                     |diag| {
1868                         diag.span_suggestion(
1869                             span,
1870                             "try this",
1871                             format!("{}.{}", snippet(cx, result_expr.span, "_"), good_method),
1872                             Applicability::MaybeIncorrect, // snippet
1873                         );
1874                     },
1875                 );
1876             }
1877         }
1878     }
1879
1880     fn find_good_method_for_match<'a>(
1881         arms: &[Arm<'_>],
1882         path_left: &QPath<'_>,
1883         path_right: &QPath<'_>,
1884         expected_left: &[&str],
1885         expected_right: &[&str],
1886         should_be_left: &'a str,
1887         should_be_right: &'a str,
1888     ) -> Option<&'a str> {
1889         let body_node_pair = if match_qpath(path_left, expected_left) && match_qpath(path_right, expected_right) {
1890             (&(*arms[0].body).kind, &(*arms[1].body).kind)
1891         } else if match_qpath(path_right, expected_left) && match_qpath(path_left, expected_right) {
1892             (&(*arms[1].body).kind, &(*arms[0].body).kind)
1893         } else {
1894             return None;
1895         };
1896
1897         match body_node_pair {
1898             (ExprKind::Lit(ref lit_left), ExprKind::Lit(ref lit_right)) => match (&lit_left.node, &lit_right.node) {
1899                 (LitKind::Bool(true), LitKind::Bool(false)) => Some(should_be_left),
1900                 (LitKind::Bool(false), LitKind::Bool(true)) => Some(should_be_right),
1901                 _ => None,
1902             },
1903             _ => None,
1904         }
1905     }
1906 }
1907
1908 #[test]
1909 fn test_overlapping() {
1910     use rustc_span::source_map::DUMMY_SP;
1911
1912     let sp = |s, e| SpannedRange {
1913         span: DUMMY_SP,
1914         node: (s, e),
1915     };
1916
1917     assert_eq!(None, overlapping::<u8>(&[]));
1918     assert_eq!(None, overlapping(&[sp(1, Bound::Included(4))]));
1919     assert_eq!(
1920         None,
1921         overlapping(&[sp(1, Bound::Included(4)), sp(5, Bound::Included(6))])
1922     );
1923     assert_eq!(
1924         None,
1925         overlapping(&[
1926             sp(1, Bound::Included(4)),
1927             sp(5, Bound::Included(6)),
1928             sp(10, Bound::Included(11))
1929         ],)
1930     );
1931     assert_eq!(
1932         Some((&sp(1, Bound::Included(4)), &sp(3, Bound::Included(6)))),
1933         overlapping(&[sp(1, Bound::Included(4)), sp(3, Bound::Included(6))])
1934     );
1935     assert_eq!(
1936         Some((&sp(5, Bound::Included(6)), &sp(6, Bound::Included(11)))),
1937         overlapping(&[
1938             sp(1, Bound::Included(4)),
1939             sp(5, Bound::Included(6)),
1940             sp(6, Bound::Included(11))
1941         ],)
1942     );
1943 }
1944
1945 /// Implementation of `MATCH_SAME_ARMS`.
1946 fn lint_match_arms<'tcx>(cx: &LateContext<'tcx>, expr: &Expr<'_>) {
1947     if let ExprKind::Match(_, ref arms, MatchSource::Normal) = expr.kind {
1948         let hash = |&(_, arm): &(usize, &Arm<'_>)| -> u64 {
1949             let mut h = SpanlessHash::new(cx);
1950             h.hash_expr(&arm.body);
1951             h.finish()
1952         };
1953
1954         let eq = |&(lindex, lhs): &(usize, &Arm<'_>), &(rindex, rhs): &(usize, &Arm<'_>)| -> bool {
1955             let min_index = usize::min(lindex, rindex);
1956             let max_index = usize::max(lindex, rindex);
1957
1958             let mut local_map: FxHashMap<HirId, HirId> = FxHashMap::default();
1959             let eq_fallback = |a: &Expr<'_>, b: &Expr<'_>| {
1960                 if_chain! {
1961                     if let Some(a_id) = path_to_local(a);
1962                     if let Some(b_id) = path_to_local(b);
1963                     let entry = match local_map.entry(a_id) {
1964                         Entry::Vacant(entry) => entry,
1965                         // check if using the same bindings as before
1966                         Entry::Occupied(entry) => return *entry.get() == b_id,
1967                     };
1968                     // the names technically don't have to match; this makes the lint more conservative
1969                     if cx.tcx.hir().name(a_id) == cx.tcx.hir().name(b_id);
1970                     if TyS::same_type(cx.typeck_results().expr_ty(a), cx.typeck_results().expr_ty(b));
1971                     if pat_contains_local(lhs.pat, a_id);
1972                     if pat_contains_local(rhs.pat, b_id);
1973                     then {
1974                         entry.insert(b_id);
1975                         true
1976                     } else {
1977                         false
1978                     }
1979                 }
1980             };
1981             // Arms with a guard are ignored, those can’t always be merged together
1982             // This is also the case for arms in-between each there is an arm with a guard
1983             (min_index..=max_index).all(|index| arms[index].guard.is_none())
1984                 && SpanlessEq::new(cx)
1985                     .expr_fallback(eq_fallback)
1986                     .eq_expr(&lhs.body, &rhs.body)
1987                 // these checks could be removed to allow unused bindings
1988                 && bindings_eq(lhs.pat, local_map.keys().copied().collect())
1989                 && bindings_eq(rhs.pat, local_map.values().copied().collect())
1990         };
1991
1992         let indexed_arms: Vec<(usize, &Arm<'_>)> = arms.iter().enumerate().collect();
1993         for (&(_, i), &(_, j)) in search_same(&indexed_arms, hash, eq) {
1994             span_lint_and_then(
1995                 cx,
1996                 MATCH_SAME_ARMS,
1997                 j.body.span,
1998                 "this `match` has identical arm bodies",
1999                 |diag| {
2000                     diag.span_note(i.body.span, "same as this");
2001
2002                     // Note: this does not use `span_suggestion` on purpose:
2003                     // there is no clean way
2004                     // to remove the other arm. Building a span and suggest to replace it to ""
2005                     // makes an even more confusing error message. Also in order not to make up a
2006                     // span for the whole pattern, the suggestion is only shown when there is only
2007                     // one pattern. The user should know about `|` if they are already using it…
2008
2009                     let lhs = snippet(cx, i.pat.span, "<pat1>");
2010                     let rhs = snippet(cx, j.pat.span, "<pat2>");
2011
2012                     if let PatKind::Wild = j.pat.kind {
2013                         // if the last arm is _, then i could be integrated into _
2014                         // note that i.pat cannot be _, because that would mean that we're
2015                         // hiding all the subsequent arms, and rust won't compile
2016                         diag.span_note(
2017                             i.body.span,
2018                             &format!(
2019                                 "`{}` has the same arm body as the `_` wildcard, consider removing it",
2020                                 lhs
2021                             ),
2022                         );
2023                     } else {
2024                         diag.span_help(i.pat.span, &format!("consider refactoring into `{} | {}`", lhs, rhs));
2025                     }
2026                 },
2027             );
2028         }
2029     }
2030 }
2031
2032 fn pat_contains_local(pat: &Pat<'_>, id: HirId) -> bool {
2033     let mut result = false;
2034     pat.walk_short(|p| {
2035         result |= matches!(p.kind, PatKind::Binding(_, binding_id, ..) if binding_id == id);
2036         !result
2037     });
2038     result
2039 }
2040
2041 /// Returns true if all the bindings in the `Pat` are in `ids` and vice versa
2042 fn bindings_eq(pat: &Pat<'_>, mut ids: FxHashSet<HirId>) -> bool {
2043     let mut result = true;
2044     pat.each_binding_or_first(&mut |_, id, _, _| result &= ids.remove(&id));
2045     result && ids.is_empty()
2046 }