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, is_wild,
   7     match_qpath, match_type, match_var, multispan_sugg, remove_blocks, snippet, snippet_block,
   8     snippet_with_applicability, span_lint_and_help, span_lint_and_note, span_lint_and_sugg, span_lint_and_then,
   9     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 let Some(ref expr) = local.init;
 393             if let ExprKind::Match(ref target, ref arms, MatchSource::Normal) = expr.kind;
 394             if arms.len() == 1 && arms[0].guard.is_none();
 395             if let PatKind::TupleStruct(
 396                 QPath::Resolved(None, ref variant_name), ref args, _) = arms[0].pat.kind;
 397             if args.len() == 1;
 398             if let Some(arg) = get_arg_name(&args[0]);
 399             let body = remove_blocks(&arms[0].body);
 400             if match_var(body, arg);
 401
 402             then {
 403                 let mut applicability = Applicability::MachineApplicable;
 404                 self.infallible_destructuring_match_linted = true;
 405                 span_lint_and_sugg(
 406                     cx,
 407                     INFALLIBLE_DESTRUCTURING_MATCH,
 408                     local.span,
 409                     "you seem to be trying to use `match` to destructure a single infallible pattern. \
 410                     Consider using `let`",
 411                     "try this",
 412                     format!(
 413                         "let {}({}) = {};",
 414                         snippet_with_applicability(cx, variant_name.span, "..", &mut applicability),
 415                         snippet_with_applicability(cx, local.pat.span, "..", &mut applicability),
 416                         snippet_with_applicability(cx, target.span, "..", &mut applicability),
 417                     ),
 418                     applicability,
 419                 );
 420             }
 421         }
 422     }
 423
 424     fn check_pat(&mut self, cx: &LateContext<'a, 'tcx>, pat: &'tcx Pat<'_>) {
 425         if_chain! {
 426             if let PatKind::Struct(ref qpath, fields, true) = pat.kind;
 427             if let QPath::Resolved(_, ref path) = qpath;
 428             if let Some(def_id) = path.res.opt_def_id();
 429             let ty = cx.tcx.type_of(def_id);
 430             if let ty::Adt(def, _) = ty.kind;
 431             if def.is_struct() || def.is_union();
 432             if fields.len() == def.non_enum_variant().fields.len();
 433
 434             then {
 435                 span_lint_and_help(
 436                     cx,
 437                     REST_PAT_IN_FULLY_BOUND_STRUCTS,
 438                     pat.span,
 439                     "unnecessary use of `..` pattern in struct binding. All fields were already bound",
 440                     "consider removing `..` from this binding",
 441                 );
 442             }
 443         }
 444     }
 445 }
 446
 447 #[rustfmt::skip]
 448 fn check_single_match(cx: &LateContext<'_, '_>, ex: &Expr<'_>, arms: &[Arm<'_>], expr: &Expr<'_>) {
 449     if arms.len() == 2 && arms[0].guard.is_none() && arms[1].guard.is_none() {
 450         if let PatKind::Or(..) = arms[0].pat.kind {
 451             // don't lint for or patterns for now, this makes
 452             // the lint noisy in unnecessary situations
 453             return;
 454         }
 455         let els = remove_blocks(&arms[1].body);
 456         let els = if is_unit_expr(els) {
 457             None
 458         } else if let ExprKind::Block(_, _) = els.kind {
 459             // matches with blocks that contain statements are prettier as `if let + else`
 460             Some(els)
 461         } else {
 462             // allow match arms with just expressions
 463             return;
 464         };
 465         let ty = cx.tables.expr_ty(ex);
 466         if ty.kind != ty::Bool || is_allowed(cx, MATCH_BOOL, ex.hir_id) {
 467             check_single_match_single_pattern(cx, ex, arms, expr, els);
 468             check_single_match_opt_like(cx, ex, arms, expr, ty, els);
 469         }
 470     }
 471 }
 472
 473 fn check_single_match_single_pattern(
 474     cx: &LateContext<'_, '_>,
 475     ex: &Expr<'_>,
 476     arms: &[Arm<'_>],
 477     expr: &Expr<'_>,
 478     els: Option<&Expr<'_>>,
 479 ) {
 480     if is_wild(&arms[1].pat) {
 481         report_single_match_single_pattern(cx, ex, arms, expr, els);
 482     }
 483 }
 484
 485 fn report_single_match_single_pattern(
 486     cx: &LateContext<'_, '_>,
 487     ex: &Expr<'_>,
 488     arms: &[Arm<'_>],
 489     expr: &Expr<'_>,
 490     els: Option<&Expr<'_>>,
 491 ) {
 492     let lint = if els.is_some() { SINGLE_MATCH_ELSE } else { SINGLE_MATCH };
 493     let els_str = els.map_or(String::new(), |els| {
 494         format!(" else {}", expr_block(cx, els, None, "..", Some(expr.span)))
 495     });
 496     span_lint_and_sugg(
 497         cx,
 498         lint,
 499         expr.span,
 500         "you seem to be trying to use match for destructuring a single pattern. Consider using `if \
 501          let`",
 502         "try this",
 503         format!(
 504             "if let {} = {} {}{}",
 505             snippet(cx, arms[0].pat.span, ".."),
 506             snippet(cx, ex.span, ".."),
 507             expr_block(cx, &arms[0].body, None, "..", Some(expr.span)),
 508             els_str,
 509         ),
 510         Applicability::HasPlaceholders,
 511     );
 512 }
 513
 514 fn check_single_match_opt_like(
 515     cx: &LateContext<'_, '_>,
 516     ex: &Expr<'_>,
 517     arms: &[Arm<'_>],
 518     expr: &Expr<'_>,
 519     ty: Ty<'_>,
 520     els: Option<&Expr<'_>>,
 521 ) {
 522     // list of candidate `Enum`s we know will never get any more members
 523     let candidates = &[
 524         (&paths::COW, "Borrowed"),
 525         (&paths::COW, "Cow::Borrowed"),
 526         (&paths::COW, "Cow::Owned"),
 527         (&paths::COW, "Owned"),
 528         (&paths::OPTION, "None"),
 529         (&paths::RESULT, "Err"),
 530         (&paths::RESULT, "Ok"),
 531     ];
 532
 533     let path = match arms[1].pat.kind {
 534         PatKind::TupleStruct(ref path, ref inner, _) => {
 535             // Contains any non wildcard patterns (e.g., `Err(err)`)?
 536             if !inner.iter().all(is_wild) {
 537                 return;
 538             }
 539             rustc_hir_pretty::to_string(rustc_hir_pretty::NO_ANN, |s| s.print_qpath(path, false))
 540         },
 541         PatKind::Binding(BindingAnnotation::Unannotated, .., ident, None) => ident.to_string(),
 542         PatKind::Path(ref path) => {
 543             rustc_hir_pretty::to_string(rustc_hir_pretty::NO_ANN, |s| s.print_qpath(path, false))
 544         },
 545         _ => return,
 546     };
 547
 548     for &(ty_path, pat_path) in candidates {
 549         if path == *pat_path && match_type(cx, ty, ty_path) {
 550             report_single_match_single_pattern(cx, ex, arms, expr, els);
 551         }
 552     }
 553 }
 554
 555 fn check_match_bool(cx: &LateContext<'_, '_>, ex: &Expr<'_>, arms: &[Arm<'_>], expr: &Expr<'_>) {
 556     // Type of expression is `bool`.
 557     if cx.tables.expr_ty(ex).kind == ty::Bool {
 558         span_lint_and_then(
 559             cx,
 560             MATCH_BOOL,
 561             expr.span,
 562             "you seem to be trying to match on a boolean expression",
 563             move |db| {
 564                 if arms.len() == 2 {
 565                     // no guards
 566                     let exprs = if let PatKind::Lit(ref arm_bool) = arms[0].pat.kind {
 567                         if let ExprKind::Lit(ref lit) = arm_bool.kind {
 568                             match lit.node {
 569                                 LitKind::Bool(true) => Some((&*arms[0].body, &*arms[1].body)),
 570                                 LitKind::Bool(false) => Some((&*arms[1].body, &*arms[0].body)),
 571                                 _ => None,
 572                             }
 573                         } else {
 574                             None
 575                         }
 576                     } else {
 577                         None
 578                     };
 579
 580                     if let Some((true_expr, false_expr)) = exprs {
 581                         let sugg = match (is_unit_expr(true_expr), is_unit_expr(false_expr)) {
 582                             (false, false) => Some(format!(
 583                                 "if {} {} else {}",
 584                                 snippet(cx, ex.span, "b"),
 585                                 expr_block(cx, true_expr, None, "..", Some(expr.span)),
 586                                 expr_block(cx, false_expr, None, "..", Some(expr.span))
 587                             )),
 588                             (false, true) => Some(format!(
 589                                 "if {} {}",
 590                                 snippet(cx, ex.span, "b"),
 591                                 expr_block(cx, true_expr, None, "..", Some(expr.span))
 592                             )),
 593                             (true, false) => {
 594                                 let test = Sugg::hir(cx, ex, "..");
 595                                 Some(format!(
 596                                     "if {} {}",
 597                                     !test,
 598                                     expr_block(cx, false_expr, None, "..", Some(expr.span))
 599                                 ))
 600                             },
 601                             (true, true) => None,
 602                         };
 603
 604                         if let Some(sugg) = sugg {
 605                             db.span_suggestion(
 606                                 expr.span,
 607                                 "consider using an `if`/`else` expression",
 608                                 sugg,
 609                                 Applicability::HasPlaceholders,
 610                             );
 611                         }
 612                     }
 613                 }
 614             },
 615         );
 616     }
 617 }
 618
 619 fn check_overlapping_arms<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, ex: &'tcx Expr<'_>, arms: &'tcx [Arm<'_>]) {
 620     if arms.len() >= 2 && cx.tables.expr_ty(ex).is_integral() {
 621         let ranges = all_ranges(cx, arms, cx.tables.expr_ty(ex));
 622         let type_ranges = type_ranges(&ranges);
 623         if !type_ranges.is_empty() {
 624             if let Some((start, end)) = overlapping(&type_ranges) {
 625                 span_lint_and_note(
 626                     cx,
 627                     MATCH_OVERLAPPING_ARM,
 628                     start.span,
 629                     "some ranges overlap",
 630                     end.span,
 631                     "overlaps with this",
 632                 );
 633             }
 634         }
 635     }
 636 }
 637
 638 fn check_wild_err_arm(cx: &LateContext<'_, '_>, ex: &Expr<'_>, arms: &[Arm<'_>]) {
 639     let ex_ty = walk_ptrs_ty(cx.tables.expr_ty(ex));
 640     if match_type(cx, ex_ty, &paths::RESULT) {
 641         for arm in arms {
 642             if let PatKind::TupleStruct(ref path, ref inner, _) = arm.pat.kind {
 643                 let path_str = rustc_hir_pretty::to_string(rustc_hir_pretty::NO_ANN, |s| s.print_qpath(path, false));
 644                 if path_str == "Err" {
 645                     let mut matching_wild = inner.iter().any(is_wild);
 646                     let mut ident_bind_name = String::from("_");
 647                     if !matching_wild {
 648                         // Looking for unused bindings (i.e.: `_e`)
 649                         inner.iter().for_each(|pat| {
 650                             if let PatKind::Binding(.., ident, None) = &pat.kind {
 651                                 if ident.as_str().starts_with('_') && is_unused(ident, arm.body) {
 652                                     ident_bind_name = (&ident.name.as_str()).to_string();
 653                                     matching_wild = true;
 654                                 }
 655                             }
 656                         });
 657                     }
 658                     if_chain! {
 659                         if matching_wild;
 660                         if let ExprKind::Block(ref block, _) = arm.body.kind;
 661                         if is_panic_block(block);
 662                         then {
 663                             // `Err(_)` or `Err(_e)` arm with `panic!` found
 664                             span_lint_and_note(cx,
 665                                 MATCH_WILD_ERR_ARM,
 666                                 arm.pat.span,
 667                                 &format!("`Err({})` matches all errors", &ident_bind_name),
 668                                 arm.pat.span,
 669                                 "match each error separately or use the error output",
 670                             );
 671                         }
 672                     }
 673                 }
 674             }
 675         }
 676     }
 677 }
 678
 679 fn check_wild_enum_match(cx: &LateContext<'_, '_>, ex: &Expr<'_>, arms: &[Arm<'_>]) {
 680     let ty = cx.tables.expr_ty(ex);
 681     if !ty.is_enum() {
 682         // If there isn't a nice closed set of possible values that can be conveniently enumerated,
 683         // don't complain about not enumerating the mall.
 684         return;
 685     }
 686
 687     // First pass - check for violation, but don't do much book-keeping because this is hopefully
 688     // the uncommon case, and the book-keeping is slightly expensive.
 689     let mut wildcard_span = None;
 690     let mut wildcard_ident = None;
 691     for arm in arms {
 692         if let PatKind::Wild = arm.pat.kind {
 693             wildcard_span = Some(arm.pat.span);
 694         } else if let PatKind::Binding(_, _, ident, None) = arm.pat.kind {
 695             wildcard_span = Some(arm.pat.span);
 696             wildcard_ident = Some(ident);
 697         }
 698     }
 699
 700     if let Some(wildcard_span) = wildcard_span {
 701         // Accumulate the variants which should be put in place of the wildcard because they're not
 702         // already covered.
 703
 704         let mut missing_variants = vec![];
 705         if let ty::Adt(def, _) = ty.kind {
 706             for variant in &def.variants {
 707                 missing_variants.push(variant);
 708             }
 709         }
 710
 711         for arm in arms {
 712             if arm.guard.is_some() {
 713                 // Guards mean that this case probably isn't exhaustively covered. Technically
 714                 // this is incorrect, as we should really check whether each variant is exhaustively
 715                 // covered by the set of guards that cover it, but that's really hard to do.
 716                 continue;
 717             }
 718             if let PatKind::Path(ref path) = arm.pat.kind {
 719                 if let QPath::Resolved(_, p) = path {
 720                     missing_variants.retain(|e| e.ctor_def_id != Some(p.res.def_id()));
 721                 }
 722             } else if let PatKind::TupleStruct(ref path, ..) = arm.pat.kind {
 723                 if let QPath::Resolved(_, p) = path {
 724                     missing_variants.retain(|e| e.ctor_def_id != Some(p.res.def_id()));
 725                 }
 726             }
 727         }
 728
 729         let mut suggestion: Vec<String> = missing_variants
 730             .iter()
 731             .map(|v| {
 732                 let suffix = match v.ctor_kind {
 733                     CtorKind::Fn => "(..)",
 734                     CtorKind::Const | CtorKind::Fictive => "",
 735                 };
 736                 let ident_str = if let Some(ident) = wildcard_ident {
 737                     format!("{} @ ", ident.name)
 738                 } else {
 739                     String::new()
 740                 };
 741                 // This path assumes that the enum type is imported into scope.
 742                 format!("{}{}{}", ident_str, cx.tcx.def_path_str(v.def_id), suffix)
 743             })
 744             .collect();
 745
 746         if suggestion.is_empty() {
 747             return;
 748         }
 749
 750         let mut message = "wildcard match will miss any future added variants";
 751
 752         if let ty::Adt(def, _) = ty.kind {
 753             if def.is_variant_list_non_exhaustive() {
 754                 message = "match on non-exhaustive enum doesn't explicitly match all known variants";
 755                 suggestion.push(String::from("_"));
 756             }
 757         }
 758
 759         span_lint_and_sugg(
 760             cx,
 761             WILDCARD_ENUM_MATCH_ARM,
 762             wildcard_span,
 763             message,
 764             "try this",
 765             suggestion.join(" | "),
 766             Applicability::MachineApplicable,
 767         )
 768     }
 769 }
 770
 771 // If the block contains only a `panic!` macro (as expression or statement)
 772 fn is_panic_block(block: &Block<'_>) -> bool {
 773     match (&block.expr, block.stmts.len(), block.stmts.first()) {
 774         (&Some(ref exp), 0, _) => {
 775             is_expn_of(exp.span, "panic").is_some() && is_expn_of(exp.span, "unreachable").is_none()
 776         },
 777         (&None, 1, Some(stmt)) => {
 778             is_expn_of(stmt.span, "panic").is_some() && is_expn_of(stmt.span, "unreachable").is_none()
 779         },
 780         _ => false,
 781     }
 782 }
 783
 784 fn check_match_ref_pats(cx: &LateContext<'_, '_>, ex: &Expr<'_>, arms: &[Arm<'_>], expr: &Expr<'_>) {
 785     if has_only_ref_pats(arms) {
 786         let mut suggs = Vec::with_capacity(arms.len() + 1);
 787         let (title, msg) = if let ExprKind::AddrOf(BorrowKind::Ref, Mutability::Not, ref inner) = ex.kind {
 788             let span = ex.span.source_callsite();
 789             suggs.push((span, Sugg::hir_with_macro_callsite(cx, inner, "..").to_string()));
 790             (
 791                 "you don't need to add `&` to both the expression and the patterns",
 792                 "try",
 793             )
 794         } else {
 795             let span = ex.span.source_callsite();
 796             suggs.push((span, Sugg::hir_with_macro_callsite(cx, ex, "..").deref().to_string()));
 797             (
 798                 "you don't need to add `&` to all patterns",
 799                 "instead of prefixing all patterns with `&`, you can dereference the expression",
 800             )
 801         };
 802
 803         suggs.extend(arms.iter().filter_map(|a| {
 804             if let PatKind::Ref(ref refp, _) = a.pat.kind {
 805                 Some((a.pat.span, snippet(cx, refp.span, "..").to_string()))
 806             } else {
 807                 None
 808             }
 809         }));
 810
 811         span_lint_and_then(cx, MATCH_REF_PATS, expr.span, title, |db| {
 812             if !expr.span.from_expansion() {
 813                 multispan_sugg(db, msg.to_owned(), suggs);
 814             }
 815         });
 816     }
 817 }
 818
 819 fn check_match_as_ref(cx: &LateContext<'_, '_>, ex: &Expr<'_>, arms: &[Arm<'_>], expr: &Expr<'_>) {
 820     if arms.len() == 2 && arms[0].guard.is_none() && arms[1].guard.is_none() {
 821         let arm_ref: Option<BindingAnnotation> = if is_none_arm(&arms[0]) {
 822             is_ref_some_arm(&arms[1])
 823         } else if is_none_arm(&arms[1]) {
 824             is_ref_some_arm(&arms[0])
 825         } else {
 826             None
 827         };
 828         if let Some(rb) = arm_ref {
 829             let suggestion = if rb == BindingAnnotation::Ref {
 830                 "as_ref"
 831             } else {
 832                 "as_mut"
 833             };
 834
 835             let output_ty = cx.tables.expr_ty(expr);
 836             let input_ty = cx.tables.expr_ty(ex);
 837
 838             let cast = if_chain! {
 839                 if let ty::Adt(_, substs) = input_ty.kind;
 840                 let input_ty = substs.type_at(0);
 841                 if let ty::Adt(_, substs) = output_ty.kind;
 842                 let output_ty = substs.type_at(0);
 843                 if let ty::Ref(_, output_ty, _) = output_ty.kind;
 844                 if input_ty != output_ty;
 845                 then {
 846                     ".map(|x| x as _)"
 847                 } else {
 848                     ""
 849                 }
 850             };
 851
 852             let mut applicability = Applicability::MachineApplicable;
 853             span_lint_and_sugg(
 854                 cx,
 855                 MATCH_AS_REF,
 856                 expr.span,
 857                 &format!("use `{}()` instead", suggestion),
 858                 "try this",
 859                 format!(
 860                     "{}.{}(){}",
 861                     snippet_with_applicability(cx, ex.span, "_", &mut applicability),
 862                     suggestion,
 863                     cast,
 864                 ),
 865                 applicability,
 866             )
 867         }
 868     }
 869 }
 870
 871 fn check_wild_in_or_pats(cx: &LateContext<'_, '_>, arms: &[Arm<'_>]) {
 872     for arm in arms {
 873         if let PatKind::Or(ref fields) = arm.pat.kind {
 874             // look for multiple fields in this arm that contains at least one Wild pattern
 875             if fields.len() > 1 && fields.iter().any(is_wild) {
 876                 span_lint_and_help(
 877                     cx,
 878                     WILDCARD_IN_OR_PATTERNS,
 879                     arm.pat.span,
 880                     "wildcard pattern covers any other pattern as it will match anyway.",
 881                     "Consider handling `_` separately.",
 882                 );
 883             }
 884         }
 885     }
 886 }
 887
 888 fn check_match_single_binding<'a>(cx: &LateContext<'_, 'a>, ex: &Expr<'a>, arms: &[Arm<'_>], expr: &Expr<'_>) {
 889     if in_macro(expr.span) || arms.len() != 1 || is_refutable(cx, arms[0].pat) {
 890         return;
 891     }
 892     let matched_vars = ex.span;
 893     let bind_names = arms[0].pat.span;
 894     let match_body = remove_blocks(&arms[0].body);
 895     let mut snippet_body = if match_body.span.from_expansion() {
 896         Sugg::hir_with_macro_callsite(cx, match_body, "..").to_string()
 897     } else {
 898         snippet_block(cx, match_body.span, "..", Some(expr.span)).to_string()
 899     };
 900
 901     // Do we need to add ';' to suggestion ?
 902     match match_body.kind {
 903         ExprKind::Block(block, _) => {
 904             // macro + expr_ty(body) == ()
 905             if block.span.from_expansion() && cx.tables.expr_ty(&match_body).is_unit() {
 906                 snippet_body.push(';');
 907             }
 908         },
 909         _ => {
 910             // expr_ty(body) == ()
 911             if cx.tables.expr_ty(&match_body).is_unit() {
 912                 snippet_body.push(';');
 913             }
 914         },
 915     }
 916
 917     let mut applicability = Applicability::MaybeIncorrect;
 918     match arms[0].pat.kind {
 919         PatKind::Binding(..) | PatKind::Tuple(_, _) | PatKind::Struct(..) => {
 920             // If this match is in a local (`let`) stmt
 921             let (target_span, sugg) = if let Some(parent_let_node) = opt_parent_let(cx, ex) {
 922                 (
 923                     parent_let_node.span,
 924                     format!(
 925                         "let {} = {};\n{}let {} = {};",
 926                         snippet_with_applicability(cx, bind_names, "..", &mut applicability),
 927                         snippet_with_applicability(cx, matched_vars, "..", &mut applicability),
 928                         " ".repeat(indent_of(cx, expr.span).unwrap_or(0)),
 929                         snippet_with_applicability(cx, parent_let_node.pat.span, "..", &mut applicability),
 930                         snippet_body
 931                     ),
 932                 )
 933             } else {
 934                 // If we are in closure, we need curly braces around suggestion
 935                 let mut indent = " ".repeat(indent_of(cx, ex.span).unwrap_or(0));
 936                 let (mut cbrace_start, mut cbrace_end) = ("".to_string(), "".to_string());
 937                 if let Some(parent_expr) = get_parent_expr(cx, expr) {
 938                     if let ExprKind::Closure(..) = parent_expr.kind {
 939                         cbrace_end = format!("\n{}}}", indent);
 940                         // Fix body indent due to the closure
 941                         indent = " ".repeat(indent_of(cx, bind_names).unwrap_or(0));
 942                         cbrace_start = format!("{{\n{}", indent);
 943                     }
 944                 };
 945                 (
 946                     expr.span,
 947                     format!(
 948                         "{}let {} = {};\n{}{}{}",
 949                         cbrace_start,
 950                         snippet_with_applicability(cx, bind_names, "..", &mut applicability),
 951                         snippet_with_applicability(cx, matched_vars, "..", &mut applicability),
 952                         indent,
 953                         snippet_body,
 954                         cbrace_end
 955                     ),
 956                 )
 957             };
 958             span_lint_and_sugg(
 959                 cx,
 960                 MATCH_SINGLE_BINDING,
 961                 target_span,
 962                 "this match could be written as a `let` statement",
 963                 "consider using `let` statement",
 964                 sugg,
 965                 applicability,
 966             );
 967         },
 968         PatKind::Wild => {
 969             span_lint_and_sugg(
 970                 cx,
 971                 MATCH_SINGLE_BINDING,
 972                 expr.span,
 973                 "this match could be replaced by its body itself",
 974                 "consider using the match body instead",
 975                 snippet_body,
 976                 Applicability::MachineApplicable,
 977             );
 978         },
 979         _ => (),
 980     }
 981 }
 982
 983 /// Returns true if the `ex` match expression is in a local (`let`) statement
 984 fn opt_parent_let<'a>(cx: &LateContext<'_, 'a>, ex: &Expr<'a>) -> Option<&'a Local<'a>> {
 985     if_chain! {
 986         let map = &cx.tcx.hir();
 987         if let Some(Node::Expr(parent_arm_expr)) = map.find(map.get_parent_node(ex.hir_id));
 988         if let Some(Node::Local(parent_let_expr)) = map.find(map.get_parent_node(parent_arm_expr.hir_id));
 989         then {
 990             return Some(parent_let_expr);
 991         }
 992     }
 993     None
 994 }
 995
 996 /// Gets all arms that are unbounded `PatRange`s.
 997 fn all_ranges<'a, 'tcx>(
 998     cx: &LateContext<'a, 'tcx>,
 999     arms: &'tcx [Arm<'_>],
1000     ty: Ty<'tcx>,
1001 ) -> Vec<SpannedRange<Constant>> {
1002     arms.iter()
1003         .flat_map(|arm| {
1004             if let Arm {
1005                 ref pat, guard: None, ..
1006             } = *arm
1007             {
1008                 if let PatKind::Range(ref lhs, ref rhs, range_end) = pat.kind {
1009                     let lhs = match lhs {
1010                         Some(lhs) => constant(cx, cx.tables, lhs)?.0,
1011                         None => miri_to_const(ty.numeric_min_val(cx.tcx)?)?,
1012                     };
1013                     let rhs = match rhs {
1014                         Some(rhs) => constant(cx, cx.tables, rhs)?.0,
1015                         None => miri_to_const(ty.numeric_max_val(cx.tcx)?)?,
1016                     };
1017                     let rhs = match range_end {
1018                         RangeEnd::Included => Bound::Included(rhs),
1019                         RangeEnd::Excluded => Bound::Excluded(rhs),
1020                     };
1021                     return Some(SpannedRange {
1022                         span: pat.span,
1023                         node: (lhs, rhs),
1024                     });
1025                 }
1026
1027                 if let PatKind::Lit(ref value) = pat.kind {
1028                     let value = constant(cx, cx.tables, value)?.0;
1029                     return Some(SpannedRange {
1030                         span: pat.span,
1031                         node: (value.clone(), Bound::Included(value)),
1032                     });
1033                 }
1034             }
1035             None
1036         })
1037         .collect()
1038 }
1039
1040 #[derive(Debug, Eq, PartialEq)]
1041 pub struct SpannedRange<T> {
1042     pub span: Span,
1043     pub node: (T, Bound<T>),
1044 }
1045
1046 type TypedRanges = Vec<SpannedRange<u128>>;
1047
1048 /// Gets all `Int` ranges or all `Uint` ranges. Mixed types are an error anyway
1049 /// and other types than
1050 /// `Uint` and `Int` probably don't make sense.
1051 fn type_ranges(ranges: &[SpannedRange<Constant>]) -> TypedRanges {
1052     ranges
1053         .iter()
1054         .filter_map(|range| match range.node {
1055             (Constant::Int(start), Bound::Included(Constant::Int(end))) => Some(SpannedRange {
1056                 span: range.span,
1057                 node: (start, Bound::Included(end)),
1058             }),
1059             (Constant::Int(start), Bound::Excluded(Constant::Int(end))) => Some(SpannedRange {
1060                 span: range.span,
1061                 node: (start, Bound::Excluded(end)),
1062             }),
1063             (Constant::Int(start), Bound::Unbounded) => Some(SpannedRange {
1064                 span: range.span,
1065                 node: (start, Bound::Unbounded),
1066             }),
1067             _ => None,
1068         })
1069         .collect()
1070 }
1071
1072 fn is_unit_expr(expr: &Expr<'_>) -> bool {
1073     match expr.kind {
1074         ExprKind::Tup(ref v) if v.is_empty() => true,
1075         ExprKind::Block(ref b, _) if b.stmts.is_empty() && b.expr.is_none() => true,
1076         _ => false,
1077     }
1078 }
1079
1080 // Checks if arm has the form `None => None`
1081 fn is_none_arm(arm: &Arm<'_>) -> bool {
1082     match arm.pat.kind {
1083         PatKind::Path(ref path) if match_qpath(path, &paths::OPTION_NONE) => true,
1084         _ => false,
1085     }
1086 }
1087
1088 // Checks if arm has the form `Some(ref v) => Some(v)` (checks for `ref` and `ref mut`)
1089 fn is_ref_some_arm(arm: &Arm<'_>) -> Option<BindingAnnotation> {
1090     if_chain! {
1091         if let PatKind::TupleStruct(ref path, ref pats, _) = arm.pat.kind;
1092         if pats.len() == 1 && match_qpath(path, &paths::OPTION_SOME);
1093         if let PatKind::Binding(rb, .., ident, _) = pats[0].kind;
1094         if rb == BindingAnnotation::Ref || rb == BindingAnnotation::RefMut;
1095         if let ExprKind::Call(ref e, ref args) = remove_blocks(&arm.body).kind;
1096         if let ExprKind::Path(ref some_path) = e.kind;
1097         if match_qpath(some_path, &paths::OPTION_SOME) && args.len() == 1;
1098         if let ExprKind::Path(ref qpath) = args[0].kind;
1099         if let &QPath::Resolved(_, ref path2) = qpath;
1100         if path2.segments.len() == 1 && ident.name == path2.segments[0].ident.name;
1101         then {
1102             return Some(rb)
1103         }
1104     }
1105     None
1106 }
1107
1108 fn has_only_ref_pats(arms: &[Arm<'_>]) -> bool {
1109     let mapped = arms
1110         .iter()
1111         .map(|a| {
1112             match a.pat.kind {
1113                 PatKind::Ref(..) => Some(true), // &-patterns
1114                 PatKind::Wild => Some(false),   // an "anything" wildcard is also fine
1115                 _ => None,                      // any other pattern is not fine
1116             }
1117         })
1118         .collect::<Option<Vec<bool>>>();
1119     // look for Some(v) where there's at least one true element
1120     mapped.map_or(false, |v| v.iter().any(|el| *el))
1121 }
1122
1123 pub fn overlapping<T>(ranges: &[SpannedRange<T>]) -> Option<(&SpannedRange<T>, &SpannedRange<T>)>
1124 where
1125     T: Copy + Ord,
1126 {
1127     #[derive(Copy, Clone, Debug, Eq, PartialEq)]
1128     enum Kind<'a, T> {
1129         Start(T, &'a SpannedRange<T>),
1130         End(Bound<T>, &'a SpannedRange<T>),
1131     }
1132
1133     impl<'a, T: Copy> Kind<'a, T> {
1134         fn range(&self) -> &'a SpannedRange<T> {
1135             match *self {
1136                 Kind::Start(_, r) | Kind::End(_, r) => r,
1137             }
1138         }
1139
1140         fn value(self) -> Bound<T> {
1141             match self {
1142                 Kind::Start(t, _) => Bound::Included(t),
1143                 Kind::End(t, _) => t,
1144             }
1145         }
1146     }
1147
1148     impl<'a, T: Copy + Ord> PartialOrd for Kind<'a, T> {
1149         fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
1150             Some(self.cmp(other))
1151         }
1152     }
1153
1154     impl<'a, T: Copy + Ord> Ord for Kind<'a, T> {
1155         fn cmp(&self, other: &Self) -> Ordering {
1156             match (self.value(), other.value()) {
1157                 (Bound::Included(a), Bound::Included(b)) | (Bound::Excluded(a), Bound::Excluded(b)) => a.cmp(&b),
1158                 // Range patterns cannot be unbounded (yet)
1159                 (Bound::Unbounded, _) | (_, Bound::Unbounded) => unimplemented!(),
1160                 (Bound::Included(a), Bound::Excluded(b)) => match a.cmp(&b) {
1161                     Ordering::Equal => Ordering::Greater,
1162                     other => other,
1163                 },
1164                 (Bound::Excluded(a), Bound::Included(b)) => match a.cmp(&b) {
1165                     Ordering::Equal => Ordering::Less,
1166                     other => other,
1167                 },
1168             }
1169         }
1170     }
1171
1172     let mut values = Vec::with_capacity(2 * ranges.len());
1173
1174     for r in ranges {
1175         values.push(Kind::Start(r.node.0, r));
1176         values.push(Kind::End(r.node.1, r));
1177     }
1178
1179     values.sort();
1180
1181     for (a, b) in values.iter().zip(values.iter().skip(1)) {
1182         match (a, b) {
1183             (&Kind::Start(_, ra), &Kind::End(_, rb)) => {
1184                 if ra.node != rb.node {
1185                     return Some((ra, rb));
1186                 }
1187             },
1188             (&Kind::End(a, _), &Kind::Start(b, _)) if a != Bound::Included(b) => (),
1189             _ => return Some((a.range(), b.range())),
1190         }
1191     }
1192
1193     None
1194 }