clippy_lints/src/matches.rs

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