clippy_lints/src/matches.rs

   1 use crate::consts::{constant, miri_to_const, Constant};
   2 use crate::utils::paths;
   3 use crate::utils::sugg::Sugg;
   4 use crate::utils::usage::is_unused;
   5 use crate::utils::{
   6     expr_block, get_arg_name, get_parent_expr, in_macro, indent_of, is_allowed, is_expn_of, is_refutable,
   7     is_type_diagnostic_item, is_wild, match_qpath, match_type, match_var, multispan_sugg, remove_blocks, snippet,
   8     snippet_block, snippet_with_applicability, span_lint_and_help, span_lint_and_note, span_lint_and_sugg,
   9     span_lint_and_then, walk_ptrs_ty,
  10 };
  11 use if_chain::if_chain;
  12 use rustc_ast::ast::LitKind;
  13 use rustc_errors::Applicability;
  14 use rustc_hir::def::CtorKind;
  15 use rustc_hir::{
  16     Arm, BindingAnnotation, Block, BorrowKind, Expr, ExprKind, Local, MatchSource, Mutability, Node, Pat, PatKind,
  17     QPath, RangeEnd,
  18 };
  19 use rustc_lint::{LateContext, LateLintPass, LintContext};
  20 use rustc_middle::lint::in_external_macro;
  21 use rustc_middle::ty::{self, Ty};
  22 use rustc_session::{declare_tool_lint, impl_lint_pass};
  23 use rustc_span::source_map::Span;
  24 use std::cmp::Ordering;
  25 use std::collections::Bound;
  26
  27 declare_clippy_lint! {
  28     /// **What it does:** Checks for matches with a single arm where an `if let`
  29     /// will usually suffice.
  30     ///
  31     /// **Why is this bad?** Just readability – `if let` nests less than a `match`.
  32     ///
  33     /// **Known problems:** None.
  34     ///
  35     /// **Example:**
  36     /// ```rust
  37     /// # fn bar(stool: &str) {}
  38     /// # let x = Some("abc");
  39     /// match x {
  40     ///     Some(ref foo) => bar(foo),
  41     ///     _ => (),
  42     /// }
  43     /// ```
  44     pub SINGLE_MATCH,
  45     style,
  46     "a `match` statement with a single nontrivial arm (i.e., where the other arm is `_ => {}`) instead of `if let`"
  47 }
  48
  49 declare_clippy_lint! {
  50     /// **What it does:** Checks for matches with two arms where an `if let else` will
  51     /// usually suffice.
  52     ///
  53     /// **Why is this bad?** Just readability – `if let` nests less than a `match`.
  54     ///
  55     /// **Known problems:** Personal style preferences may differ.
  56     ///
  57     /// **Example:**
  58     ///
  59     /// Using `match`:
  60     ///
  61     /// ```rust
  62     /// # fn bar(foo: &usize) {}
  63     /// # let other_ref: usize = 1;
  64     /// # let x: Option<&usize> = Some(&1);
  65     /// match x {
  66     ///     Some(ref foo) => bar(foo),
  67     ///     _ => bar(&other_ref),
  68     /// }
  69     /// ```
  70     ///
  71     /// Using `if let` with `else`:
  72     ///
  73     /// ```rust
  74     /// # fn bar(foo: &usize) {}
  75     /// # let other_ref: usize = 1;
  76     /// # let x: Option<&usize> = Some(&1);
  77     /// if let Some(ref foo) = x {
  78     ///     bar(foo);
  79     /// } else {
  80     ///     bar(&other_ref);
  81     /// }
  82     /// ```
  83     pub SINGLE_MATCH_ELSE,
  84     pedantic,
  85     "a `match` statement with two arms where the second arm's pattern is a placeholder instead of a specific match pattern"
  86 }
  87
  88 declare_clippy_lint! {
  89     /// **What it does:** Checks for matches where all arms match a reference,
  90     /// suggesting to remove the reference and deref the matched expression
  91     /// instead. It also checks for `if let &foo = bar` blocks.
  92     ///
  93     /// **Why is this bad?** It just makes the code less readable. That reference
  94     /// destructuring adds nothing to the code.
  95     ///
  96     /// **Known problems:** None.
  97     ///
  98     /// **Example:**
  99     /// ```rust,ignore
 100     /// match x {
 101     ///     &A(ref y) => foo(y),
 102     ///     &B => bar(),
 103     ///     _ => frob(&x),
 104     /// }
 105     /// ```
 106     pub MATCH_REF_PATS,
 107     style,
 108     "a `match` or `if let` with all arms prefixed with `&` instead of deref-ing the match expression"
 109 }
 110
 111 declare_clippy_lint! {
 112     /// **What it does:** Checks for matches where match expression is a `bool`. It
 113     /// suggests to replace the expression with an `if...else` block.
 114     ///
 115     /// **Why is this bad?** It makes the code less readable.
 116     ///
 117     /// **Known problems:** None.
 118     ///
 119     /// **Example:**
 120     /// ```rust
 121     /// # fn foo() {}
 122     /// # fn bar() {}
 123     /// let condition: bool = true;
 124     /// match condition {
 125     ///     true => foo(),
 126     ///     false => bar(),
 127     /// }
 128     /// ```
 129     /// Use if/else instead:
 130     /// ```rust
 131     /// # fn foo() {}
 132     /// # fn bar() {}
 133     /// let condition: bool = true;
 134     /// if condition {
 135     ///     foo();
 136     /// } else {
 137     ///     bar();
 138     /// }
 139     /// ```
 140     pub MATCH_BOOL,
 141     style,
 142     "a `match` on a boolean expression instead of an `if..else` block"
 143 }
 144
 145 declare_clippy_lint! {
 146     /// **What it does:** Checks for overlapping match arms.
 147     ///
 148     /// **Why is this bad?** It is likely to be an error and if not, makes the code
 149     /// less obvious.
 150     ///
 151     /// **Known problems:** None.
 152     ///
 153     /// **Example:**
 154     /// ```rust
 155     /// let x = 5;
 156     /// match x {
 157     ///     1...10 => println!("1 ... 10"),
 158     ///     5...15 => println!("5 ... 15"),
 159     ///     _ => (),
 160     /// }
 161     /// ```
 162     pub MATCH_OVERLAPPING_ARM,
 163     style,
 164     "a `match` with overlapping arms"
 165 }
 166
 167 declare_clippy_lint! {
 168     /// **What it does:** Checks for arm which matches all errors with `Err(_)`
 169     /// and take drastic actions like `panic!`.
 170     ///
 171     /// **Why is this bad?** It is generally a bad practice, just like
 172     /// catching all exceptions in java with `catch(Exception)`
 173     ///
 174     /// **Known problems:** None.
 175     ///
 176     /// **Example:**
 177     /// ```rust
 178     /// let x: Result<i32, &str> = Ok(3);
 179     /// match x {
 180     ///     Ok(_) => println!("ok"),
 181     ///     Err(_) => panic!("err"),
 182     /// }
 183     /// ```
 184     pub MATCH_WILD_ERR_ARM,
 185     style,
 186     "a `match` with `Err(_)` arm and take drastic actions"
 187 }
 188
 189 declare_clippy_lint! {
 190     /// **What it does:** Checks for match which is used to add a reference to an
 191     /// `Option` value.
 192     ///
 193     /// **Why is this bad?** Using `as_ref()` or `as_mut()` instead is shorter.
 194     ///
 195     /// **Known problems:** None.
 196     ///
 197     /// **Example:**
 198     /// ```rust
 199     /// let x: Option<()> = None;
 200     /// let r: Option<&()> = match x {
 201     ///     None => None,
 202     ///     Some(ref v) => Some(v),
 203     /// };
 204     /// ```
 205     pub MATCH_AS_REF,
 206     complexity,
 207     "a `match` on an Option value instead of using `as_ref()` or `as_mut`"
 208 }
 209
 210 declare_clippy_lint! {
 211     /// **What it does:** Checks for wildcard enum matches using `_`.
 212     ///
 213     /// **Why is this bad?** New enum variants added by library updates can be missed.
 214     ///
 215     /// **Known problems:** Suggested replacements may be incorrect if guards exhaustively cover some
 216     /// variants, and also may not use correct path to enum if it's not present in the current scope.
 217     ///
 218     /// **Example:**
 219     /// ```rust
 220     /// # enum Foo { A(usize), B(usize) }
 221     /// # let x = Foo::B(1);
 222     /// match x {
 223     ///     A => {},
 224     ///     _ => {},
 225     /// }
 226     /// ```
 227     pub WILDCARD_ENUM_MATCH_ARM,
 228     restriction,
 229     "a wildcard enum match arm using `_`"
 230 }
 231
 232 declare_clippy_lint! {
 233     /// **What it does:** Checks for wildcard pattern used with others patterns in same match arm.
 234     ///
 235     /// **Why is this bad?** Wildcard pattern already covers any other pattern as it will match anyway.
 236     /// It makes the code less readable, especially to spot wildcard pattern use in match arm.
 237     ///
 238     /// **Known problems:** None.
 239     ///
 240     /// **Example:**
 241     /// ```rust
 242     /// match "foo" {
 243     ///     "a" => {},
 244     ///     "bar" | _ => {},
 245     /// }
 246     /// ```
 247     pub WILDCARD_IN_OR_PATTERNS,
 248     complexity,
 249     "a wildcard pattern used with others patterns in same match arm"
 250 }
 251
 252 declare_clippy_lint! {
 253     /// **What it does:** Checks for matches being used to destructure a single-variant enum
 254     /// or tuple struct where a `let` will suffice.
 255     ///
 256     /// **Why is this bad?** Just readability – `let` doesn't nest, whereas a `match` does.
 257     ///
 258     /// **Known problems:** None.
 259     ///
 260     /// **Example:**
 261     /// ```rust
 262     /// enum Wrapper {
 263     ///     Data(i32),
 264     /// }
 265     ///
 266     /// let wrapper = Wrapper::Data(42);
 267     ///
 268     /// let data = match wrapper {
 269     ///     Wrapper::Data(i) => i,
 270     /// };
 271     /// ```
 272     ///
 273     /// The correct use would be:
 274     /// ```rust
 275     /// enum Wrapper {
 276     ///     Data(i32),
 277     /// }
 278     ///
 279     /// let wrapper = Wrapper::Data(42);
 280     /// let Wrapper::Data(data) = wrapper;
 281     /// ```
 282     pub INFALLIBLE_DESTRUCTURING_MATCH,
 283     style,
 284     "a `match` statement with a single infallible arm instead of a `let`"
 285 }
 286
 287 declare_clippy_lint! {
 288     /// **What it does:** Checks for useless match that binds to only one value.
 289     ///
 290     /// **Why is this bad?** Readability and needless complexity.
 291     ///
 292     /// **Known problems:**  Suggested replacements may be incorrect when `match`
 293     /// is actually binding temporary value, bringing a 'dropped while borrowed' error.
 294     ///
 295     /// **Example:**
 296     /// ```rust
 297     /// # let a = 1;
 298     /// # let b = 2;
 299     ///
 300     /// // Bad
 301     /// match (a, b) {
 302     ///     (c, d) => {
 303     ///         // useless match
 304     ///     }
 305     /// }
 306     ///
 307     /// // Good
 308     /// let (c, d) = (a, b);
 309     /// ```
 310     pub MATCH_SINGLE_BINDING,
 311     complexity,
 312     "a match with a single binding instead of using `let` statement"
 313 }
 314
 315 declare_clippy_lint! {
 316     /// **What it does:** Checks for unnecessary '..' pattern binding on struct when all fields are explicitly matched.
 317     ///
 318     /// **Why is this bad?** Correctness and readability. It's like having a wildcard pattern after
 319     /// matching all enum variants explicitly.
 320     ///
 321     /// **Known problems:** None.
 322     ///
 323     /// **Example:**
 324     /// ```rust
 325     /// # struct A { a: i32 }
 326     /// let a = A { a: 5 };
 327     ///
 328     /// // Bad
 329     /// match a {
 330     ///     A { a: 5, .. } => {},
 331     ///     _ => {},
 332     /// }
 333     ///
 334     /// // Good
 335     /// match a {
 336     ///     A { a: 5 } => {},
 337     ///     _ => {},
 338     /// }
 339     /// ```
 340     pub REST_PAT_IN_FULLY_BOUND_STRUCTS,
 341     restriction,
 342     "a match on a struct that binds all fields but still uses the wildcard pattern"
 343 }
 344
 345 #[derive(Default)]
 346 pub struct Matches {
 347     infallible_destructuring_match_linted: bool,
 348 }
 349
 350 impl_lint_pass!(Matches => [
 351     SINGLE_MATCH,
 352     MATCH_REF_PATS,
 353     MATCH_BOOL,
 354     SINGLE_MATCH_ELSE,
 355     MATCH_OVERLAPPING_ARM,
 356     MATCH_WILD_ERR_ARM,
 357     MATCH_AS_REF,
 358     WILDCARD_ENUM_MATCH_ARM,
 359     WILDCARD_IN_OR_PATTERNS,
 360     MATCH_SINGLE_BINDING,
 361     INFALLIBLE_DESTRUCTURING_MATCH,
 362     REST_PAT_IN_FULLY_BOUND_STRUCTS
 363 ]);
 364
 365 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for Matches {
 366     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr<'_>) {
 367         if in_external_macro(cx.sess(), expr.span) {
 368             return;
 369         }
 370         if let ExprKind::Match(ref ex, ref arms, MatchSource::Normal) = expr.kind {
 371             check_single_match(cx, ex, arms, expr);
 372             check_match_bool(cx, ex, arms, expr);
 373             check_overlapping_arms(cx, ex, arms);
 374             check_wild_err_arm(cx, ex, arms);
 375             check_wild_enum_match(cx, ex, arms);
 376             check_match_as_ref(cx, ex, arms, expr);
 377             check_wild_in_or_pats(cx, arms);
 378
 379             if self.infallible_destructuring_match_linted {
 380                 self.infallible_destructuring_match_linted = false;
 381             } else {
 382                 check_match_single_binding(cx, ex, arms, expr);
 383             }
 384         }
 385         if let ExprKind::Match(ref ex, ref arms, _) = expr.kind {
 386             check_match_ref_pats(cx, ex, arms, expr);
 387         }
 388     }
 389
 390     fn check_local(&mut self, cx: &LateContext<'a, 'tcx>, local: &'tcx Local<'_>) {
 391         if_chain! {
 392             if !in_external_macro(cx.sess(), local.span);
 393             if !in_macro(local.span);
 394             if let Some(ref expr) = local.init;
 395             if let ExprKind::Match(ref target, ref arms, MatchSource::Normal) = expr.kind;
 396             if arms.len() == 1 && arms[0].guard.is_none();
 397             if let PatKind::TupleStruct(
 398                 QPath::Resolved(None, ref variant_name), ref args, _) = arms[0].pat.kind;
 399             if args.len() == 1;
 400             if let Some(arg) = get_arg_name(&args[0]);
 401             let body = remove_blocks(&arms[0].body);
 402             if match_var(body, arg);
 403
 404             then {
 405                 let mut applicability = Applicability::MachineApplicable;
 406                 self.infallible_destructuring_match_linted = true;
 407                 span_lint_and_sugg(
 408                     cx,
 409                     INFALLIBLE_DESTRUCTURING_MATCH,
 410                     local.span,
 411                     "you seem to be trying to use `match` to destructure a single infallible pattern. \
 412                     Consider using `let`",
 413                     "try this",
 414                     format!(
 415                         "let {}({}) = {};",
 416                         snippet_with_applicability(cx, variant_name.span, "..", &mut applicability),
 417                         snippet_with_applicability(cx, local.pat.span, "..", &mut applicability),
 418                         snippet_with_applicability(cx, target.span, "..", &mut applicability),
 419                     ),
 420                     applicability,
 421                 );
 422             }
 423         }
 424     }
 425
 426     fn check_pat(&mut self, cx: &LateContext<'a, 'tcx>, pat: &'tcx Pat<'_>) {
 427         if_chain! {
 428             if !in_external_macro(cx.sess(), pat.span);
 429             if !in_macro(pat.span);
 430             if let PatKind::Struct(ref qpath, fields, true) = pat.kind;
 431             if let QPath::Resolved(_, ref path) = qpath;
 432             if let Some(def_id) = path.res.opt_def_id();
 433             let ty = cx.tcx.type_of(def_id);
 434             if let ty::Adt(def, _) = ty.kind;
 435             if def.is_struct() || def.is_union();
 436             if fields.len() == def.non_enum_variant().fields.len();
 437
 438             then {
 439                 span_lint_and_help(
 440                     cx,
 441                     REST_PAT_IN_FULLY_BOUND_STRUCTS,
 442                     pat.span,
 443                     "unnecessary use of `..` pattern in struct binding. All fields were already bound",
 444                     "consider removing `..` from this binding",
 445                 );
 446             }
 447         }
 448     }
 449 }
 450
 451 #[rustfmt::skip]
 452 fn check_single_match(cx: &LateContext<'_, '_>, ex: &Expr<'_>, arms: &[Arm<'_>], expr: &Expr<'_>) {
 453     if arms.len() == 2 && arms[0].guard.is_none() && arms[1].guard.is_none() {
 454         if in_macro(expr.span) {
 455             // Don't lint match expressions present in
 456             // macro_rules! block
 457             return;
 458         }
 459         if let PatKind::Or(..) = arms[0].pat.kind {
 460             // don't lint for or patterns for now, this makes
 461             // the lint noisy in unnecessary situations
 462             return;
 463         }
 464         let els = remove_blocks(&arms[1].body);
 465         let els = if is_unit_expr(els) {
 466             None
 467         } else if let ExprKind::Block(_, _) = els.kind {
 468             // matches with blocks that contain statements are prettier as `if let + else`
 469             Some(els)
 470         } else {
 471             // allow match arms with just expressions
 472             return;
 473         };
 474         let ty = cx.tables.expr_ty(ex);
 475         if ty.kind != ty::Bool || is_allowed(cx, MATCH_BOOL, ex.hir_id) {
 476             check_single_match_single_pattern(cx, ex, arms, expr, els);
 477             check_single_match_opt_like(cx, ex, arms, expr, ty, els);
 478         }
 479     }
 480 }
 481
 482 fn check_single_match_single_pattern(
 483     cx: &LateContext<'_, '_>,
 484     ex: &Expr<'_>,
 485     arms: &[Arm<'_>],
 486     expr: &Expr<'_>,
 487     els: Option<&Expr<'_>>,
 488 ) {
 489     if is_wild(&arms[1].pat) {
 490         report_single_match_single_pattern(cx, ex, arms, expr, els);
 491     }
 492 }
 493
 494 fn report_single_match_single_pattern(
 495     cx: &LateContext<'_, '_>,
 496     ex: &Expr<'_>,
 497     arms: &[Arm<'_>],
 498     expr: &Expr<'_>,
 499     els: Option<&Expr<'_>>,
 500 ) {
 501     let lint = if els.is_some() { SINGLE_MATCH_ELSE } else { SINGLE_MATCH };
 502     let els_str = els.map_or(String::new(), |els| {
 503         format!(" else {}", expr_block(cx, els, None, "..", Some(expr.span)))
 504     });
 505     span_lint_and_sugg(
 506         cx,
 507         lint,
 508         expr.span,
 509         "you seem to be trying to use match for destructuring a single pattern. Consider using `if \
 510          let`",
 511         "try this",
 512         format!(
 513             "if let {} = {} {}{}",
 514             snippet(cx, arms[0].pat.span, ".."),
 515             snippet(cx, ex.span, ".."),
 516             expr_block(cx, &arms[0].body, None, "..", Some(expr.span)),
 517             els_str,
 518         ),
 519         Applicability::HasPlaceholders,
 520     );
 521 }
 522
 523 fn check_single_match_opt_like(
 524     cx: &LateContext<'_, '_>,
 525     ex: &Expr<'_>,
 526     arms: &[Arm<'_>],
 527     expr: &Expr<'_>,
 528     ty: Ty<'_>,
 529     els: Option<&Expr<'_>>,
 530 ) {
 531     // list of candidate `Enum`s we know will never get any more members
 532     let candidates = &[
 533         (&paths::COW, "Borrowed"),
 534         (&paths::COW, "Cow::Borrowed"),
 535         (&paths::COW, "Cow::Owned"),
 536         (&paths::COW, "Owned"),
 537         (&paths::OPTION, "None"),
 538         (&paths::RESULT, "Err"),
 539         (&paths::RESULT, "Ok"),
 540     ];
 541
 542     let path = match arms[1].pat.kind {
 543         PatKind::TupleStruct(ref path, ref inner, _) => {
 544             // Contains any non wildcard patterns (e.g., `Err(err)`)?
 545             if !inner.iter().all(is_wild) {
 546                 return;
 547             }
 548             rustc_hir_pretty::to_string(rustc_hir_pretty::NO_ANN, |s| s.print_qpath(path, false))
 549         },
 550         PatKind::Binding(BindingAnnotation::Unannotated, .., ident, None) => ident.to_string(),
 551         PatKind::Path(ref path) => {
 552             rustc_hir_pretty::to_string(rustc_hir_pretty::NO_ANN, |s| s.print_qpath(path, false))
 553         },
 554         _ => return,
 555     };
 556
 557     for &(ty_path, pat_path) in candidates {
 558         if path == *pat_path && match_type(cx, ty, ty_path) {
 559             report_single_match_single_pattern(cx, ex, arms, expr, els);
 560         }
 561     }
 562 }
 563
 564 fn check_match_bool(cx: &LateContext<'_, '_>, ex: &Expr<'_>, arms: &[Arm<'_>], expr: &Expr<'_>) {
 565     // Type of expression is `bool`.
 566     if cx.tables.expr_ty(ex).kind == ty::Bool {
 567         span_lint_and_then(
 568             cx,
 569             MATCH_BOOL,
 570             expr.span,
 571             "you seem to be trying to match on a boolean expression",
 572             move |db| {
 573                 if arms.len() == 2 {
 574                     // no guards
 575                     let exprs = if let PatKind::Lit(ref arm_bool) = arms[0].pat.kind {
 576                         if let ExprKind::Lit(ref lit) = arm_bool.kind {
 577                             match lit.node {
 578                                 LitKind::Bool(true) => Some((&*arms[0].body, &*arms[1].body)),
 579                                 LitKind::Bool(false) => Some((&*arms[1].body, &*arms[0].body)),
 580                                 _ => None,
 581                             }
 582                         } else {
 583                             None
 584                         }
 585                     } else {
 586                         None
 587                     };
 588
 589                     if let Some((true_expr, false_expr)) = exprs {
 590                         let sugg = match (is_unit_expr(true_expr), is_unit_expr(false_expr)) {
 591                             (false, false) => Some(format!(
 592                                 "if {} {} else {}",
 593                                 snippet(cx, ex.span, "b"),
 594                                 expr_block(cx, true_expr, None, "..", Some(expr.span)),
 595                                 expr_block(cx, false_expr, None, "..", Some(expr.span))
 596                             )),
 597                             (false, true) => Some(format!(
 598                                 "if {} {}",
 599                                 snippet(cx, ex.span, "b"),
 600                                 expr_block(cx, true_expr, None, "..", Some(expr.span))
 601                             )),
 602                             (true, false) => {
 603                                 let test = Sugg::hir(cx, ex, "..");
 604                                 Some(format!(
 605                                     "if {} {}",
 606                                     !test,
 607                                     expr_block(cx, false_expr, None, "..", Some(expr.span))
 608                                 ))
 609                             },
 610                             (true, true) => None,
 611                         };
 612
 613                         if let Some(sugg) = sugg {
 614                             db.span_suggestion(
 615                                 expr.span,
 616                                 "consider using an `if`/`else` expression",
 617                                 sugg,
 618                                 Applicability::HasPlaceholders,
 619                             );
 620                         }
 621                     }
 622                 }
 623             },
 624         );
 625     }
 626 }
 627
 628 fn check_overlapping_arms<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, ex: &'tcx Expr<'_>, arms: &'tcx [Arm<'_>]) {
 629     if arms.len() >= 2 && cx.tables.expr_ty(ex).is_integral() {
 630         let ranges = all_ranges(cx, arms, cx.tables.expr_ty(ex));
 631         let type_ranges = type_ranges(&ranges);
 632         if !type_ranges.is_empty() {
 633             if let Some((start, end)) = overlapping(&type_ranges) {
 634                 span_lint_and_note(
 635                     cx,
 636                     MATCH_OVERLAPPING_ARM,
 637                     start.span,
 638                     "some ranges overlap",
 639                     end.span,
 640                     "overlaps with this",
 641                 );
 642             }
 643         }
 644     }
 645 }
 646
 647 fn check_wild_err_arm(cx: &LateContext<'_, '_>, ex: &Expr<'_>, arms: &[Arm<'_>]) {
 648     let ex_ty = walk_ptrs_ty(cx.tables.expr_ty(ex));
 649     if is_type_diagnostic_item(cx, ex_ty, sym!(result_type)) {
 650         for arm in arms {
 651             if let PatKind::TupleStruct(ref path, ref inner, _) = arm.pat.kind {
 652                 let path_str = rustc_hir_pretty::to_string(rustc_hir_pretty::NO_ANN, |s| s.print_qpath(path, false));
 653                 if path_str == "Err" {
 654                     let mut matching_wild = inner.iter().any(is_wild);
 655                     let mut ident_bind_name = String::from("_");
 656                     if !matching_wild {
 657                         // Looking for unused bindings (i.e.: `_e`)
 658                         inner.iter().for_each(|pat| {
 659                             if let PatKind::Binding(.., ident, None) = &pat.kind {
 660                                 if ident.as_str().starts_with('_') && is_unused(ident, arm.body) {
 661                                     ident_bind_name = (&ident.name.as_str()).to_string();
 662                                     matching_wild = true;
 663                                 }
 664                             }
 665                         });
 666                     }
 667                     if_chain! {
 668                         if matching_wild;
 669                         if let ExprKind::Block(ref block, _) = arm.body.kind;
 670                         if is_panic_block(block);
 671                         then {
 672                             // `Err(_)` or `Err(_e)` arm with `panic!` found
 673                             span_lint_and_note(cx,
 674                                 MATCH_WILD_ERR_ARM,
 675                                 arm.pat.span,
 676                                 &format!("`Err({})` matches all errors", &ident_bind_name),
 677                                 arm.pat.span,
 678                                 "match each error separately or use the error output",
 679                             );
 680                         }
 681                     }
 682                 }
 683             }
 684         }
 685     }
 686 }
 687
 688 fn check_wild_enum_match(cx: &LateContext<'_, '_>, ex: &Expr<'_>, arms: &[Arm<'_>]) {
 689     let ty = cx.tables.expr_ty(ex);
 690     if !ty.is_enum() {
 691         // If there isn't a nice closed set of possible values that can be conveniently enumerated,
 692         // don't complain about not enumerating the mall.
 693         return;
 694     }
 695
 696     // First pass - check for violation, but don't do much book-keeping because this is hopefully
 697     // the uncommon case, and the book-keeping is slightly expensive.
 698     let mut wildcard_span = None;
 699     let mut wildcard_ident = None;
 700     for arm in arms {
 701         if let PatKind::Wild = arm.pat.kind {
 702             wildcard_span = Some(arm.pat.span);
 703         } else if let PatKind::Binding(_, _, ident, None) = arm.pat.kind {
 704             wildcard_span = Some(arm.pat.span);
 705             wildcard_ident = Some(ident);
 706         }
 707     }
 708
 709     if let Some(wildcard_span) = wildcard_span {
 710         // Accumulate the variants which should be put in place of the wildcard because they're not
 711         // already covered.
 712
 713         let mut missing_variants = vec![];
 714         if let ty::Adt(def, _) = ty.kind {
 715             for variant in &def.variants {
 716                 missing_variants.push(variant);
 717             }
 718         }
 719
 720         for arm in arms {
 721             if arm.guard.is_some() {
 722                 // Guards mean that this case probably isn't exhaustively covered. Technically
 723                 // this is incorrect, as we should really check whether each variant is exhaustively
 724                 // covered by the set of guards that cover it, but that's really hard to do.
 725                 continue;
 726             }
 727             if let PatKind::Path(ref path) = arm.pat.kind {
 728                 if let QPath::Resolved(_, p) = path {
 729                     missing_variants.retain(|e| e.ctor_def_id != Some(p.res.def_id()));
 730                 }
 731             } else if let PatKind::TupleStruct(ref path, ..) = arm.pat.kind {
 732                 if let QPath::Resolved(_, p) = path {
 733                     missing_variants.retain(|e| e.ctor_def_id != Some(p.res.def_id()));
 734                 }
 735             }
 736         }
 737
 738         let mut suggestion: Vec<String> = missing_variants
 739             .iter()
 740             .map(|v| {
 741                 let suffix = match v.ctor_kind {
 742                     CtorKind::Fn => "(..)",
 743                     CtorKind::Const | CtorKind::Fictive => "",
 744                 };
 745                 let ident_str = if let Some(ident) = wildcard_ident {
 746                     format!("{} @ ", ident.name)
 747                 } else {
 748                     String::new()
 749                 };
 750                 // This path assumes that the enum type is imported into scope.
 751                 format!("{}{}{}", ident_str, cx.tcx.def_path_str(v.def_id), suffix)
 752             })
 753             .collect();
 754
 755         if suggestion.is_empty() {
 756             return;
 757         }
 758
 759         let mut message = "wildcard match will miss any future added variants";
 760
 761         if let ty::Adt(def, _) = ty.kind {
 762             if def.is_variant_list_non_exhaustive() {
 763                 message = "match on non-exhaustive enum doesn't explicitly match all known variants";
 764                 suggestion.push(String::from("_"));
 765             }
 766         }
 767
 768         span_lint_and_sugg(
 769             cx,
 770             WILDCARD_ENUM_MATCH_ARM,
 771             wildcard_span,
 772             message,
 773             "try this",
 774             suggestion.join(" | "),
 775             Applicability::MachineApplicable,
 776         )
 777     }
 778 }
 779
 780 // If the block contains only a `panic!` macro (as expression or statement)
 781 fn is_panic_block(block: &Block<'_>) -> bool {
 782     match (&block.expr, block.stmts.len(), block.stmts.first()) {
 783         (&Some(ref exp), 0, _) => {
 784             is_expn_of(exp.span, "panic").is_some() && is_expn_of(exp.span, "unreachable").is_none()
 785         },
 786         (&None, 1, Some(stmt)) => {
 787             is_expn_of(stmt.span, "panic").is_some() && is_expn_of(stmt.span, "unreachable").is_none()
 788         },
 789         _ => false,
 790     }
 791 }
 792
 793 fn check_match_ref_pats(cx: &LateContext<'_, '_>, ex: &Expr<'_>, arms: &[Arm<'_>], expr: &Expr<'_>) {
 794     if has_only_ref_pats(arms) {
 795         let mut suggs = Vec::with_capacity(arms.len() + 1);
 796         let (title, msg) = if let ExprKind::AddrOf(BorrowKind::Ref, Mutability::Not, ref inner) = ex.kind {
 797             let span = ex.span.source_callsite();
 798             suggs.push((span, Sugg::hir_with_macro_callsite(cx, inner, "..").to_string()));
 799             (
 800                 "you don't need to add `&` to both the expression and the patterns",
 801                 "try",
 802             )
 803         } else {
 804             let span = ex.span.source_callsite();
 805             suggs.push((span, Sugg::hir_with_macro_callsite(cx, ex, "..").deref().to_string()));
 806             (
 807                 "you don't need to add `&` to all patterns",
 808                 "instead of prefixing all patterns with `&`, you can dereference the expression",
 809             )
 810         };
 811
 812         suggs.extend(arms.iter().filter_map(|a| {
 813             if let PatKind::Ref(ref refp, _) = a.pat.kind {
 814                 Some((a.pat.span, snippet(cx, refp.span, "..").to_string()))
 815             } else {
 816                 None
 817             }
 818         }));
 819
 820         span_lint_and_then(cx, MATCH_REF_PATS, expr.span, title, |db| {
 821             if !expr.span.from_expansion() {
 822                 multispan_sugg(db, msg.to_owned(), suggs);
 823             }
 824         });
 825     }
 826 }
 827
 828 fn check_match_as_ref(cx: &LateContext<'_, '_>, ex: &Expr<'_>, arms: &[Arm<'_>], expr: &Expr<'_>) {
 829     if arms.len() == 2 && arms[0].guard.is_none() && arms[1].guard.is_none() {
 830         let arm_ref: Option<BindingAnnotation> = if is_none_arm(&arms[0]) {
 831             is_ref_some_arm(&arms[1])
 832         } else if is_none_arm(&arms[1]) {
 833             is_ref_some_arm(&arms[0])
 834         } else {
 835             None
 836         };
 837         if let Some(rb) = arm_ref {
 838             let suggestion = if rb == BindingAnnotation::Ref {
 839                 "as_ref"
 840             } else {
 841                 "as_mut"
 842             };
 843
 844             let output_ty = cx.tables.expr_ty(expr);
 845             let input_ty = cx.tables.expr_ty(ex);
 846
 847             let cast = if_chain! {
 848                 if let ty::Adt(_, substs) = input_ty.kind;
 849                 let input_ty = substs.type_at(0);
 850                 if let ty::Adt(_, substs) = output_ty.kind;
 851                 let output_ty = substs.type_at(0);
 852                 if let ty::Ref(_, output_ty, _) = output_ty.kind;
 853                 if input_ty != output_ty;
 854                 then {
 855                     ".map(|x| x as _)"
 856                 } else {
 857                     ""
 858                 }
 859             };
 860
 861             let mut applicability = Applicability::MachineApplicable;
 862             span_lint_and_sugg(
 863                 cx,
 864                 MATCH_AS_REF,
 865                 expr.span,
 866                 &format!("use `{}()` instead", suggestion),
 867                 "try this",
 868                 format!(
 869                     "{}.{}(){}",
 870                     snippet_with_applicability(cx, ex.span, "_", &mut applicability),
 871                     suggestion,
 872                     cast,
 873                 ),
 874                 applicability,
 875             )
 876         }
 877     }
 878 }
 879
 880 fn check_wild_in_or_pats(cx: &LateContext<'_, '_>, arms: &[Arm<'_>]) {
 881     for arm in arms {
 882         if let PatKind::Or(ref fields) = arm.pat.kind {
 883             // look for multiple fields in this arm that contains at least one Wild pattern
 884             if fields.len() > 1 && fields.iter().any(is_wild) {
 885                 span_lint_and_help(
 886                     cx,
 887                     WILDCARD_IN_OR_PATTERNS,
 888                     arm.pat.span,
 889                     "wildcard pattern covers any other pattern as it will match anyway.",
 890                     "Consider handling `_` separately.",
 891                 );
 892             }
 893         }
 894     }
 895 }
 896
 897 fn check_match_single_binding<'a>(cx: &LateContext<'_, 'a>, ex: &Expr<'a>, arms: &[Arm<'_>], expr: &Expr<'_>) {
 898     if in_macro(expr.span) || arms.len() != 1 || is_refutable(cx, arms[0].pat) {
 899         return;
 900     }
 901     let matched_vars = ex.span;
 902     let bind_names = arms[0].pat.span;
 903     let match_body = remove_blocks(&arms[0].body);
 904     let mut snippet_body = if match_body.span.from_expansion() {
 905         Sugg::hir_with_macro_callsite(cx, match_body, "..").to_string()
 906     } else {
 907         snippet_block(cx, match_body.span, "..", Some(expr.span)).to_string()
 908     };
 909
 910     // Do we need to add ';' to suggestion ?
 911     match match_body.kind {
 912         ExprKind::Block(block, _) => {
 913             // macro + expr_ty(body) == ()
 914             if block.span.from_expansion() && cx.tables.expr_ty(&match_body).is_unit() {
 915                 snippet_body.push(';');
 916             }
 917         },
 918         _ => {
 919             // expr_ty(body) == ()
 920             if cx.tables.expr_ty(&match_body).is_unit() {
 921                 snippet_body.push(';');
 922             }
 923         },
 924     }
 925
 926     let mut applicability = Applicability::MaybeIncorrect;
 927     match arms[0].pat.kind {
 928         PatKind::Binding(..) | PatKind::Tuple(_, _) | PatKind::Struct(..) => {
 929             // If this match is in a local (`let`) stmt
 930             let (target_span, sugg) = if let Some(parent_let_node) = opt_parent_let(cx, ex) {
 931                 (
 932                     parent_let_node.span,
 933                     format!(
 934                         "let {} = {};\n{}let {} = {};",
 935                         snippet_with_applicability(cx, bind_names, "..", &mut applicability),
 936                         snippet_with_applicability(cx, matched_vars, "..", &mut applicability),
 937                         " ".repeat(indent_of(cx, expr.span).unwrap_or(0)),
 938                         snippet_with_applicability(cx, parent_let_node.pat.span, "..", &mut applicability),
 939                         snippet_body
 940                     ),
 941                 )
 942             } else {
 943                 // If we are in closure, we need curly braces around suggestion
 944                 let mut indent = " ".repeat(indent_of(cx, ex.span).unwrap_or(0));
 945                 let (mut cbrace_start, mut cbrace_end) = ("".to_string(), "".to_string());
 946                 if let Some(parent_expr) = get_parent_expr(cx, expr) {
 947                     if let ExprKind::Closure(..) = parent_expr.kind {
 948                         cbrace_end = format!("\n{}}}", indent);
 949                         // Fix body indent due to the closure
 950                         indent = " ".repeat(indent_of(cx, bind_names).unwrap_or(0));
 951                         cbrace_start = format!("{{\n{}", indent);
 952                     }
 953                 };
 954                 (
 955                     expr.span,
 956                     format!(
 957                         "{}let {} = {};\n{}{}{}",
 958                         cbrace_start,
 959                         snippet_with_applicability(cx, bind_names, "..", &mut applicability),
 960                         snippet_with_applicability(cx, matched_vars, "..", &mut applicability),
 961                         indent,
 962                         snippet_body,
 963                         cbrace_end
 964                     ),
 965                 )
 966             };
 967             span_lint_and_sugg(
 968                 cx,
 969                 MATCH_SINGLE_BINDING,
 970                 target_span,
 971                 "this match could be written as a `let` statement",
 972                 "consider using `let` statement",
 973                 sugg,
 974                 applicability,
 975             );
 976         },
 977         PatKind::Wild => {
 978             span_lint_and_sugg(
 979                 cx,
 980                 MATCH_SINGLE_BINDING,
 981                 expr.span,
 982                 "this match could be replaced by its body itself",
 983                 "consider using the match body instead",
 984                 snippet_body,
 985                 Applicability::MachineApplicable,
 986             );
 987         },
 988         _ => (),
 989     }
 990 }
 991
 992 /// Returns true if the `ex` match expression is in a local (`let`) statement
 993 fn opt_parent_let<'a>(cx: &LateContext<'_, 'a>, ex: &Expr<'a>) -> Option<&'a Local<'a>> {
 994     if_chain! {
 995         let map = &cx.tcx.hir();
 996         if let Some(Node::Expr(parent_arm_expr)) = map.find(map.get_parent_node(ex.hir_id));
 997         if let Some(Node::Local(parent_let_expr)) = map.find(map.get_parent_node(parent_arm_expr.hir_id));
 998         then {
 999             return Some(parent_let_expr);
1000         }
1001     }
1002     None
1003 }
1004
1005 /// Gets all arms that are unbounded `PatRange`s.
1006 fn all_ranges<'a, 'tcx>(
1007     cx: &LateContext<'a, 'tcx>,
1008     arms: &'tcx [Arm<'_>],
1009     ty: Ty<'tcx>,
1010 ) -> Vec<SpannedRange<Constant>> {
1011     arms.iter()
1012         .flat_map(|arm| {
1013             if let Arm {
1014                 ref pat, guard: None, ..
1015             } = *arm
1016             {
1017                 if let PatKind::Range(ref lhs, ref rhs, range_end) = pat.kind {
1018                     let lhs = match lhs {
1019                         Some(lhs) => constant(cx, cx.tables, lhs)?.0,
1020                         None => miri_to_const(ty.numeric_min_val(cx.tcx)?)?,
1021                     };
1022                     let rhs = match rhs {
1023                         Some(rhs) => constant(cx, cx.tables, rhs)?.0,
1024                         None => miri_to_const(ty.numeric_max_val(cx.tcx)?)?,
1025                     };
1026                     let rhs = match range_end {
1027                         RangeEnd::Included => Bound::Included(rhs),
1028                         RangeEnd::Excluded => Bound::Excluded(rhs),
1029                     };
1030                     return Some(SpannedRange {
1031                         span: pat.span,
1032                         node: (lhs, rhs),
1033                     });
1034                 }
1035
1036                 if let PatKind::Lit(ref value) = pat.kind {
1037                     let value = constant(cx, cx.tables, value)?.0;
1038                     return Some(SpannedRange {
1039                         span: pat.span,
1040                         node: (value.clone(), Bound::Included(value)),
1041                     });
1042                 }
1043             }
1044             None
1045         })
1046         .collect()
1047 }
1048
1049 #[derive(Debug, Eq, PartialEq)]
1050 pub struct SpannedRange<T> {
1051     pub span: Span,
1052     pub node: (T, Bound<T>),
1053 }
1054
1055 type TypedRanges = Vec<SpannedRange<u128>>;
1056
1057 /// Gets all `Int` ranges or all `Uint` ranges. Mixed types are an error anyway
1058 /// and other types than
1059 /// `Uint` and `Int` probably don't make sense.
1060 fn type_ranges(ranges: &[SpannedRange<Constant>]) -> TypedRanges {
1061     ranges
1062         .iter()
1063         .filter_map(|range| match range.node {
1064             (Constant::Int(start), Bound::Included(Constant::Int(end))) => Some(SpannedRange {
1065                 span: range.span,
1066                 node: (start, Bound::Included(end)),
1067             }),
1068             (Constant::Int(start), Bound::Excluded(Constant::Int(end))) => Some(SpannedRange {
1069                 span: range.span,
1070                 node: (start, Bound::Excluded(end)),
1071             }),
1072             (Constant::Int(start), Bound::Unbounded) => Some(SpannedRange {
1073                 span: range.span,
1074                 node: (start, Bound::Unbounded),
1075             }),
1076             _ => None,
1077         })
1078         .collect()
1079 }
1080
1081 fn is_unit_expr(expr: &Expr<'_>) -> bool {
1082     match expr.kind {
1083         ExprKind::Tup(ref v) if v.is_empty() => true,
1084         ExprKind::Block(ref b, _) if b.stmts.is_empty() && b.expr.is_none() => true,
1085         _ => false,
1086     }
1087 }
1088
1089 // Checks if arm has the form `None => None`
1090 fn is_none_arm(arm: &Arm<'_>) -> bool {
1091     match arm.pat.kind {
1092         PatKind::Path(ref path) if match_qpath(path, &paths::OPTION_NONE) => true,
1093         _ => false,
1094     }
1095 }
1096
1097 // Checks if arm has the form `Some(ref v) => Some(v)` (checks for `ref` and `ref mut`)
1098 fn is_ref_some_arm(arm: &Arm<'_>) -> Option<BindingAnnotation> {
1099     if_chain! {
1100         if let PatKind::TupleStruct(ref path, ref pats, _) = arm.pat.kind;
1101         if pats.len() == 1 && match_qpath(path, &paths::OPTION_SOME);
1102         if let PatKind::Binding(rb, .., ident, _) = pats[0].kind;
1103         if rb == BindingAnnotation::Ref || rb == BindingAnnotation::RefMut;
1104         if let ExprKind::Call(ref e, ref args) = remove_blocks(&arm.body).kind;
1105         if let ExprKind::Path(ref some_path) = e.kind;
1106         if match_qpath(some_path, &paths::OPTION_SOME) && args.len() == 1;
1107         if let ExprKind::Path(ref qpath) = args[0].kind;
1108         if let &QPath::Resolved(_, ref path2) = qpath;
1109         if path2.segments.len() == 1 && ident.name == path2.segments[0].ident.name;
1110         then {
1111             return Some(rb)
1112         }
1113     }
1114     None
1115 }
1116
1117 fn has_only_ref_pats(arms: &[Arm<'_>]) -> bool {
1118     let mapped = arms
1119         .iter()
1120         .map(|a| {
1121             match a.pat.kind {
1122                 PatKind::Ref(..) => Some(true), // &-patterns
1123                 PatKind::Wild => Some(false),   // an "anything" wildcard is also fine
1124                 _ => None,                      // any other pattern is not fine
1125             }
1126         })
1127         .collect::<Option<Vec<bool>>>();
1128     // look for Some(v) where there's at least one true element
1129     mapped.map_or(false, |v| v.iter().any(|el| *el))
1130 }
1131
1132 pub fn overlapping<T>(ranges: &[SpannedRange<T>]) -> Option<(&SpannedRange<T>, &SpannedRange<T>)>
1133 where
1134     T: Copy + Ord,
1135 {
1136     #[derive(Copy, Clone, Debug, Eq, PartialEq)]
1137     enum Kind<'a, T> {
1138         Start(T, &'a SpannedRange<T>),
1139         End(Bound<T>, &'a SpannedRange<T>),
1140     }
1141
1142     impl<'a, T: Copy> Kind<'a, T> {
1143         fn range(&self) -> &'a SpannedRange<T> {
1144             match *self {
1145                 Kind::Start(_, r) | Kind::End(_, r) => r,
1146             }
1147         }
1148
1149         fn value(self) -> Bound<T> {
1150             match self {
1151                 Kind::Start(t, _) => Bound::Included(t),
1152                 Kind::End(t, _) => t,
1153             }
1154         }
1155     }
1156
1157     impl<'a, T: Copy + Ord> PartialOrd for Kind<'a, T> {
1158         fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
1159             Some(self.cmp(other))
1160         }
1161     }
1162
1163     impl<'a, T: Copy + Ord> Ord for Kind<'a, T> {
1164         fn cmp(&self, other: &Self) -> Ordering {
1165             match (self.value(), other.value()) {
1166                 (Bound::Included(a), Bound::Included(b)) | (Bound::Excluded(a), Bound::Excluded(b)) => a.cmp(&b),
1167                 // Range patterns cannot be unbounded (yet)
1168                 (Bound::Unbounded, _) | (_, Bound::Unbounded) => unimplemented!(),
1169                 (Bound::Included(a), Bound::Excluded(b)) => match a.cmp(&b) {
1170                     Ordering::Equal => Ordering::Greater,
1171                     other => other,
1172                 },
1173                 (Bound::Excluded(a), Bound::Included(b)) => match a.cmp(&b) {
1174                     Ordering::Equal => Ordering::Less,
1175                     other => other,
1176                 },
1177             }
1178         }
1179     }
1180
1181     let mut values = Vec::with_capacity(2 * ranges.len());
1182
1183     for r in ranges {
1184         values.push(Kind::Start(r.node.0, r));
1185         values.push(Kind::End(r.node.1, r));
1186     }
1187
1188     values.sort();
1189
1190     for (a, b) in values.iter().zip(values.iter().skip(1)) {
1191         match (a, b) {
1192             (&Kind::Start(_, ra), &Kind::End(_, rb)) => {
1193                 if ra.node != rb.node {
1194                     return Some((ra, rb));
1195                 }
1196             },
1197             (&Kind::End(a, _), &Kind::Start(b, _)) if a != Bound::Included(b) => (),
1198             _ => return Some((a.range(), b.range())),
1199         }
1200     }
1201
1202     None
1203 }
1204
1205 #[test]
1206 fn test_overlapping() {
1207     use rustc_span::source_map::DUMMY_SP;
1208
1209     let sp = |s, e| SpannedRange {
1210         span: DUMMY_SP,
1211         node: (s, e),
1212     };
1213
1214     assert_eq!(None, overlapping::<u8>(&[]));
1215     assert_eq!(None, overlapping(&[sp(1, Bound::Included(4))]));
1216     assert_eq!(
1217         None,
1218         overlapping(&[sp(1, Bound::Included(4)), sp(5, Bound::Included(6))])
1219     );
1220     assert_eq!(
1221         None,
1222         overlapping(&[
1223             sp(1, Bound::Included(4)),
1224             sp(5, Bound::Included(6)),
1225             sp(10, Bound::Included(11))
1226         ],)
1227     );
1228     assert_eq!(
1229         Some((&sp(1, Bound::Included(4)), &sp(3, Bound::Included(6)))),
1230         overlapping(&[sp(1, Bound::Included(4)), sp(3, Bound::Included(6))])
1231     );
1232     assert_eq!(
1233         Some((&sp(5, Bound::Included(6)), &sp(6, Bound::Included(11)))),
1234         overlapping(&[
1235             sp(1, Bound::Included(4)),
1236             sp(5, Bound::Included(6)),
1237             sp(6, Bound::Included(11))
1238         ],)
1239     );
1240 }