src/tools/clippy/clippy_lints/src/matches.rs

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