clippy_lints/src/matches.rs

   1 use crate::consts::{constant, Constant};
   2 use crate::utils::paths;
   3 use crate::utils::sugg::Sugg;
   4 use crate::utils::{
   5     expr_block, is_allowed, is_expn_of, match_qpath, match_type, multispan_sugg, remove_blocks, snippet,
   6     snippet_with_applicability, span_lint_and_sugg, span_lint_and_then, span_note_and_lint, walk_ptrs_ty,
   7 };
   8 use if_chain::if_chain;
   9 use rustc::declare_lint_pass;
  10 use rustc::hir::def::CtorKind;
  11 use rustc::hir::*;
  12 use rustc::lint::{in_external_macro, LateContext, LateLintPass, LintArray, LintContext, LintPass};
  13 use rustc::ty::{self, Ty};
  14 use rustc_errors::Applicability;
  15 use rustc_session::declare_tool_lint;
  16 use std::cmp::Ordering;
  17 use std::collections::Bound;
  18 use syntax::ast::LitKind;
  19 use syntax::source_map::Span;
  20
  21 declare_clippy_lint! {
  22     /// **What it does:** Checks for matches with a single arm where an `if let`
  23     /// will usually suffice.
  24     ///
  25     /// **Why is this bad?** Just readability – `if let` nests less than a `match`.
  26     ///
  27     /// **Known problems:** None.
  28     ///
  29     /// **Example:**
  30     /// ```rust
  31     /// # fn bar(stool: &str) {}
  32     /// # let x = Some("abc");
  33     /// match x {
  34     ///     Some(ref foo) => bar(foo),
  35     ///     _ => (),
  36     /// }
  37     /// ```
  38     pub SINGLE_MATCH,
  39     style,
  40     "a match statement with a single nontrivial arm (i.e., where the other arm is `_ => {}`) instead of `if let`"
  41 }
  42
  43 declare_clippy_lint! {
  44     /// **What it does:** Checks for matches with two arms where an `if let else` will
  45     /// usually suffice.
  46     ///
  47     /// **Why is this bad?** Just readability – `if let` nests less than a `match`.
  48     ///
  49     /// **Known problems:** Personal style preferences may differ.
  50     ///
  51     /// **Example:**
  52     ///
  53     /// Using `match`:
  54     ///
  55     /// ```rust
  56     /// # fn bar(foo: &usize) {}
  57     /// # let other_ref: usize = 1;
  58     /// # let x: Option<&usize> = Some(&1);
  59     /// match x {
  60     ///     Some(ref foo) => bar(foo),
  61     ///     _ => bar(&other_ref),
  62     /// }
  63     /// ```
  64     ///
  65     /// Using `if let` with `else`:
  66     ///
  67     /// ```rust
  68     /// # fn bar(foo: &usize) {}
  69     /// # let other_ref: usize = 1;
  70     /// # let x: Option<&usize> = Some(&1);
  71     /// if let Some(ref foo) = x {
  72     ///     bar(foo);
  73     /// } else {
  74     ///     bar(&other_ref);
  75     /// }
  76     /// ```
  77     pub SINGLE_MATCH_ELSE,
  78     pedantic,
  79     "a match statement with two arms where the second arm's pattern is a placeholder instead of a specific match pattern"
  80 }
  81
  82 declare_clippy_lint! {
  83     /// **What it does:** Checks for matches where all arms match a reference,
  84     /// suggesting to remove the reference and deref the matched expression
  85     /// instead. It also checks for `if let &foo = bar` blocks.
  86     ///
  87     /// **Why is this bad?** It just makes the code less readable. That reference
  88     /// destructuring adds nothing to the code.
  89     ///
  90     /// **Known problems:** None.
  91     ///
  92     /// **Example:**
  93     /// ```rust,ignore
  94     /// match x {
  95     ///     &A(ref y) => foo(y),
  96     ///     &B => bar(),
  97     ///     _ => frob(&x),
  98     /// }
  99     /// ```
 100     pub MATCH_REF_PATS,
 101     style,
 102     "a match or `if let` with all arms prefixed with `&` instead of deref-ing the match expression"
 103 }
 104
 105 declare_clippy_lint! {
 106     /// **What it does:** Checks for matches where match expression is a `bool`. It
 107     /// suggests to replace the expression with an `if...else` block.
 108     ///
 109     /// **Why is this bad?** It makes the code less readable.
 110     ///
 111     /// **Known problems:** None.
 112     ///
 113     /// **Example:**
 114     /// ```rust
 115     /// # fn foo() {}
 116     /// # fn bar() {}
 117     /// let condition: bool = true;
 118     /// match condition {
 119     ///     true => foo(),
 120     ///     false => bar(),
 121     /// }
 122     /// ```
 123     /// Use if/else instead:
 124     /// ```rust
 125     /// # fn foo() {}
 126     /// # fn bar() {}
 127     /// let condition: bool = true;
 128     /// if condition {
 129     ///     foo();
 130     /// } else {
 131     ///     bar();
 132     /// }
 133     /// ```
 134     pub MATCH_BOOL,
 135     style,
 136     "a match on a boolean expression instead of an `if..else` block"
 137 }
 138
 139 declare_clippy_lint! {
 140     /// **What it does:** Checks for overlapping match arms.
 141     ///
 142     /// **Why is this bad?** It is likely to be an error and if not, makes the code
 143     /// less obvious.
 144     ///
 145     /// **Known problems:** None.
 146     ///
 147     /// **Example:**
 148     /// ```rust
 149     /// let x = 5;
 150     /// match x {
 151     ///     1...10 => println!("1 ... 10"),
 152     ///     5...15 => println!("5 ... 15"),
 153     ///     _ => (),
 154     /// }
 155     /// ```
 156     pub MATCH_OVERLAPPING_ARM,
 157     style,
 158     "a match with overlapping arms"
 159 }
 160
 161 declare_clippy_lint! {
 162     /// **What it does:** Checks for arm which matches all errors with `Err(_)`
 163     /// and take drastic actions like `panic!`.
 164     ///
 165     /// **Why is this bad?** It is generally a bad practice, just like
 166     /// catching all exceptions in java with `catch(Exception)`
 167     ///
 168     /// **Known problems:** None.
 169     ///
 170     /// **Example:**
 171     /// ```rust
 172     /// let x: Result<i32, &str> = Ok(3);
 173     /// match x {
 174     ///     Ok(_) => println!("ok"),
 175     ///     Err(_) => panic!("err"),
 176     /// }
 177     /// ```
 178     pub MATCH_WILD_ERR_ARM,
 179     style,
 180     "a match with `Err(_)` arm and take drastic actions"
 181 }
 182
 183 declare_clippy_lint! {
 184     /// **What it does:** Checks for match which is used to add a reference to an
 185     /// `Option` value.
 186     ///
 187     /// **Why is this bad?** Using `as_ref()` or `as_mut()` instead is shorter.
 188     ///
 189     /// **Known problems:** None.
 190     ///
 191     /// **Example:**
 192     /// ```rust
 193     /// let x: Option<()> = None;
 194     /// let r: Option<&()> = match x {
 195     ///     None => None,
 196     ///     Some(ref v) => Some(v),
 197     /// };
 198     /// ```
 199     pub MATCH_AS_REF,
 200     complexity,
 201     "a match on an Option value instead of using `as_ref()` or `as_mut`"
 202 }
 203
 204 declare_clippy_lint! {
 205     /// **What it does:** Checks for wildcard enum matches using `_`.
 206     ///
 207     /// **Why is this bad?** New enum variants added by library updates can be missed.
 208     ///
 209     /// **Known problems:** Suggested replacements may be incorrect if guards exhaustively cover some
 210     /// variants, and also may not use correct path to enum if it's not present in the current scope.
 211     ///
 212     /// **Example:**
 213     /// ```rust
 214     /// # enum Foo { A(usize), B(usize) }
 215     /// # let x = Foo::B(1);
 216     /// match x {
 217     ///     A => {},
 218     ///     _ => {},
 219     /// }
 220     /// ```
 221     pub WILDCARD_ENUM_MATCH_ARM,
 222     restriction,
 223     "a wildcard enum match arm using `_`"
 224 }
 225
 226 declare_lint_pass!(Matches => [
 227     SINGLE_MATCH,
 228     MATCH_REF_PATS,
 229     MATCH_BOOL,
 230     SINGLE_MATCH_ELSE,
 231     MATCH_OVERLAPPING_ARM,
 232     MATCH_WILD_ERR_ARM,
 233     MATCH_AS_REF,
 234     WILDCARD_ENUM_MATCH_ARM
 235 ]);
 236
 237 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for Matches {
 238     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
 239         if in_external_macro(cx.sess(), expr.span) {
 240             return;
 241         }
 242         if let ExprKind::Match(ref ex, ref arms, MatchSource::Normal) = expr.kind {
 243             check_single_match(cx, ex, arms, expr);
 244             check_match_bool(cx, ex, arms, expr);
 245             check_overlapping_arms(cx, ex, arms);
 246             check_wild_err_arm(cx, ex, arms);
 247             check_wild_enum_match(cx, ex, arms);
 248             check_match_as_ref(cx, ex, arms, expr);
 249         }
 250         if let ExprKind::Match(ref ex, ref arms, _) = expr.kind {
 251             check_match_ref_pats(cx, ex, arms, expr);
 252         }
 253     }
 254 }
 255
 256 #[rustfmt::skip]
 257 fn check_single_match(cx: &LateContext<'_, '_>, ex: &Expr, arms: &[Arm], expr: &Expr) {
 258     if arms.len() == 2 && arms[0].guard.is_none() && arms[1].guard.is_none() {
 259         if let PatKind::Or(..) = arms[0].pat.kind {
 260             // don't lint for or patterns for now, this makes
 261             // the lint noisy in unnecessary situations
 262             return;
 263         }
 264         let els = remove_blocks(&arms[1].body);
 265         let els = if is_unit_expr(els) {
 266             None
 267         } else if let ExprKind::Block(_, _) = els.kind {
 268             // matches with blocks that contain statements are prettier as `if let + else`
 269             Some(els)
 270         } else {
 271             // allow match arms with just expressions
 272             return;
 273         };
 274         let ty = cx.tables.expr_ty(ex);
 275         if ty.kind != ty::Bool || is_allowed(cx, MATCH_BOOL, ex.hir_id) {
 276             check_single_match_single_pattern(cx, ex, arms, expr, els);
 277             check_single_match_opt_like(cx, ex, arms, expr, ty, els);
 278         }
 279     }
 280 }
 281
 282 fn check_single_match_single_pattern(
 283     cx: &LateContext<'_, '_>,
 284     ex: &Expr,
 285     arms: &[Arm],
 286     expr: &Expr,
 287     els: Option<&Expr>,
 288 ) {
 289     if is_wild(&arms[1].pat) {
 290         report_single_match_single_pattern(cx, ex, arms, expr, els);
 291     }
 292 }
 293
 294 fn report_single_match_single_pattern(
 295     cx: &LateContext<'_, '_>,
 296     ex: &Expr,
 297     arms: &[Arm],
 298     expr: &Expr,
 299     els: Option<&Expr>,
 300 ) {
 301     let lint = if els.is_some() { SINGLE_MATCH_ELSE } else { SINGLE_MATCH };
 302     let els_str = els.map_or(String::new(), |els| {
 303         format!(" else {}", expr_block(cx, els, None, ".."))
 304     });
 305     span_lint_and_sugg(
 306         cx,
 307         lint,
 308         expr.span,
 309         "you seem to be trying to use match for destructuring a single pattern. Consider using `if \
 310          let`",
 311         "try this",
 312         format!(
 313             "if let {} = {} {}{}",
 314             snippet(cx, arms[0].pat.span, ".."),
 315             snippet(cx, ex.span, ".."),
 316             expr_block(cx, &arms[0].body, None, ".."),
 317             els_str,
 318         ),
 319         Applicability::HasPlaceholders,
 320     );
 321 }
 322
 323 fn check_single_match_opt_like(
 324     cx: &LateContext<'_, '_>,
 325     ex: &Expr,
 326     arms: &[Arm],
 327     expr: &Expr,
 328     ty: Ty<'_>,
 329     els: Option<&Expr>,
 330 ) {
 331     // list of candidate `Enum`s we know will never get any more members
 332     let candidates = &[
 333         (&paths::COW, "Borrowed"),
 334         (&paths::COW, "Cow::Borrowed"),
 335         (&paths::COW, "Cow::Owned"),
 336         (&paths::COW, "Owned"),
 337         (&paths::OPTION, "None"),
 338         (&paths::RESULT, "Err"),
 339         (&paths::RESULT, "Ok"),
 340     ];
 341
 342     let path = match arms[1].pat.kind {
 343         PatKind::TupleStruct(ref path, ref inner, _) => {
 344             // Contains any non wildcard patterns (e.g., `Err(err)`)?
 345             if !inner.iter().all(is_wild) {
 346                 return;
 347             }
 348             print::to_string(print::NO_ANN, |s| s.print_qpath(path, false))
 349         },
 350         PatKind::Binding(BindingAnnotation::Unannotated, .., ident, None) => ident.to_string(),
 351         PatKind::Path(ref path) => print::to_string(print::NO_ANN, |s| s.print_qpath(path, false)),
 352         _ => return,
 353     };
 354
 355     for &(ty_path, pat_path) in candidates {
 356         if path == *pat_path && match_type(cx, ty, ty_path) {
 357             report_single_match_single_pattern(cx, ex, arms, expr, els);
 358         }
 359     }
 360 }
 361
 362 fn check_match_bool(cx: &LateContext<'_, '_>, ex: &Expr, arms: &[Arm], expr: &Expr) {
 363     // Type of expression is `bool`.
 364     if cx.tables.expr_ty(ex).kind == ty::Bool {
 365         span_lint_and_then(
 366             cx,
 367             MATCH_BOOL,
 368             expr.span,
 369             "you seem to be trying to match on a boolean expression",
 370             move |db| {
 371                 if arms.len() == 2 {
 372                     // no guards
 373                     let exprs = if let PatKind::Lit(ref arm_bool) = arms[0].pat.kind {
 374                         if let ExprKind::Lit(ref lit) = arm_bool.kind {
 375                             match lit.node {
 376                                 LitKind::Bool(true) => Some((&*arms[0].body, &*arms[1].body)),
 377                                 LitKind::Bool(false) => Some((&*arms[1].body, &*arms[0].body)),
 378                                 _ => None,
 379                             }
 380                         } else {
 381                             None
 382                         }
 383                     } else {
 384                         None
 385                     };
 386
 387                     if let Some((true_expr, false_expr)) = exprs {
 388                         let sugg = match (is_unit_expr(true_expr), is_unit_expr(false_expr)) {
 389                             (false, false) => Some(format!(
 390                                 "if {} {} else {}",
 391                                 snippet(cx, ex.span, "b"),
 392                                 expr_block(cx, true_expr, None, ".."),
 393                                 expr_block(cx, false_expr, None, "..")
 394                             )),
 395                             (false, true) => Some(format!(
 396                                 "if {} {}",
 397                                 snippet(cx, ex.span, "b"),
 398                                 expr_block(cx, true_expr, None, "..")
 399                             )),
 400                             (true, false) => {
 401                                 let test = Sugg::hir(cx, ex, "..");
 402                                 Some(format!("if {} {}", !test, expr_block(cx, false_expr, None, "..")))
 403                             },
 404                             (true, true) => None,
 405                         };
 406
 407                         if let Some(sugg) = sugg {
 408                             db.span_suggestion(
 409                                 expr.span,
 410                                 "consider using an if/else expression",
 411                                 sugg,
 412                                 Applicability::HasPlaceholders,
 413                             );
 414                         }
 415                     }
 416                 }
 417             },
 418         );
 419     }
 420 }
 421
 422 fn check_overlapping_arms<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, ex: &'tcx Expr, arms: &'tcx [Arm]) {
 423     if arms.len() >= 2 && cx.tables.expr_ty(ex).is_integral() {
 424         let ranges = all_ranges(cx, arms);
 425         let type_ranges = type_ranges(&ranges);
 426         if !type_ranges.is_empty() {
 427             if let Some((start, end)) = overlapping(&type_ranges) {
 428                 span_note_and_lint(
 429                     cx,
 430                     MATCH_OVERLAPPING_ARM,
 431                     start.span,
 432                     "some ranges overlap",
 433                     end.span,
 434                     "overlaps with this",
 435                 );
 436             }
 437         }
 438     }
 439 }
 440
 441 fn is_wild(pat: &impl std::ops::Deref<Target = Pat>) -> bool {
 442     match pat.kind {
 443         PatKind::Wild => true,
 444         _ => false,
 445     }
 446 }
 447
 448 fn check_wild_err_arm(cx: &LateContext<'_, '_>, ex: &Expr, arms: &[Arm]) {
 449     let ex_ty = walk_ptrs_ty(cx.tables.expr_ty(ex));
 450     if match_type(cx, ex_ty, &paths::RESULT) {
 451         for arm in arms {
 452             if let PatKind::TupleStruct(ref path, ref inner, _) = arm.pat.kind {
 453                 let path_str = print::to_string(print::NO_ANN, |s| s.print_qpath(path, false));
 454                 if_chain! {
 455                     if path_str == "Err";
 456                     if inner.iter().any(is_wild);
 457                     if let ExprKind::Block(ref block, _) = arm.body.kind;
 458                     if is_panic_block(block);
 459                     then {
 460                         // `Err(_)` arm with `panic!` found
 461                         span_note_and_lint(cx,
 462                                            MATCH_WILD_ERR_ARM,
 463                                            arm.pat.span,
 464                                            "Err(_) will match all errors, maybe not a good idea",
 465                                            arm.pat.span,
 466                                            "to remove this warning, match each error separately \
 467                                             or use unreachable macro");
 468                     }
 469                 }
 470             }
 471         }
 472     }
 473 }
 474
 475 fn check_wild_enum_match(cx: &LateContext<'_, '_>, ex: &Expr, arms: &[Arm]) {
 476     let ty = cx.tables.expr_ty(ex);
 477     if !ty.is_enum() {
 478         // If there isn't a nice closed set of possible values that can be conveniently enumerated,
 479         // don't complain about not enumerating the mall.
 480         return;
 481     }
 482
 483     // First pass - check for violation, but don't do much book-keeping because this is hopefully
 484     // the uncommon case, and the book-keeping is slightly expensive.
 485     let mut wildcard_span = None;
 486     let mut wildcard_ident = None;
 487     for arm in arms {
 488         if let PatKind::Wild = arm.pat.kind {
 489             wildcard_span = Some(arm.pat.span);
 490         } else if let PatKind::Binding(_, _, ident, None) = arm.pat.kind {
 491             wildcard_span = Some(arm.pat.span);
 492             wildcard_ident = Some(ident);
 493         }
 494     }
 495
 496     if let Some(wildcard_span) = wildcard_span {
 497         // Accumulate the variants which should be put in place of the wildcard because they're not
 498         // already covered.
 499
 500         let mut missing_variants = vec![];
 501         if let ty::Adt(def, _) = ty.kind {
 502             for variant in &def.variants {
 503                 missing_variants.push(variant);
 504             }
 505         }
 506
 507         for arm in arms {
 508             if arm.guard.is_some() {
 509                 // Guards mean that this case probably isn't exhaustively covered. Technically
 510                 // this is incorrect, as we should really check whether each variant is exhaustively
 511                 // covered by the set of guards that cover it, but that's really hard to do.
 512                 continue;
 513             }
 514             if let PatKind::Path(ref path) = arm.pat.kind {
 515                 if let QPath::Resolved(_, p) = path {
 516                     missing_variants.retain(|e| e.ctor_def_id != Some(p.res.def_id()));
 517                 }
 518             } else if let PatKind::TupleStruct(ref path, ..) = arm.pat.kind {
 519                 if let QPath::Resolved(_, p) = path {
 520                     missing_variants.retain(|e| e.ctor_def_id != Some(p.res.def_id()));
 521                 }
 522             }
 523         }
 524
 525         let suggestion: Vec<String> = missing_variants
 526             .iter()
 527             .map(|v| {
 528                 let suffix = match v.ctor_kind {
 529                     CtorKind::Fn => "(..)",
 530                     CtorKind::Const | CtorKind::Fictive => "",
 531                 };
 532                 let ident_str = if let Some(ident) = wildcard_ident {
 533                     format!("{} @ ", ident.name)
 534                 } else {
 535                     String::new()
 536                 };
 537                 // This path assumes that the enum type is imported into scope.
 538                 format!("{}{}{}", ident_str, cx.tcx.def_path_str(v.def_id), suffix)
 539             })
 540             .collect();
 541
 542         if suggestion.is_empty() {
 543             return;
 544         }
 545
 546         span_lint_and_sugg(
 547             cx,
 548             WILDCARD_ENUM_MATCH_ARM,
 549             wildcard_span,
 550             "wildcard match will miss any future added variants.",
 551             "try this",
 552             suggestion.join(" | "),
 553             Applicability::MachineApplicable,
 554         )
 555     }
 556 }
 557
 558 // If the block contains only a `panic!` macro (as expression or statement)
 559 fn is_panic_block(block: &Block) -> bool {
 560     match (&block.expr, block.stmts.len(), block.stmts.first()) {
 561         (&Some(ref exp), 0, _) => {
 562             is_expn_of(exp.span, "panic").is_some() && is_expn_of(exp.span, "unreachable").is_none()
 563         },
 564         (&None, 1, Some(stmt)) => {
 565             is_expn_of(stmt.span, "panic").is_some() && is_expn_of(stmt.span, "unreachable").is_none()
 566         },
 567         _ => false,
 568     }
 569 }
 570
 571 fn check_match_ref_pats(cx: &LateContext<'_, '_>, ex: &Expr, arms: &[Arm], expr: &Expr) {
 572     if has_only_ref_pats(arms) {
 573         let mut suggs = Vec::new();
 574         let (title, msg) = if let ExprKind::AddrOf(BorrowKind::Ref, Mutability::Immutable, ref inner) = ex.kind {
 575             let span = ex.span.source_callsite();
 576             suggs.push((span, Sugg::hir_with_macro_callsite(cx, inner, "..").to_string()));
 577             (
 578                 "you don't need to add `&` to both the expression and the patterns",
 579                 "try",
 580             )
 581         } else {
 582             let span = ex.span.source_callsite();
 583             suggs.push((span, Sugg::hir_with_macro_callsite(cx, ex, "..").deref().to_string()));
 584             (
 585                 "you don't need to add `&` to all patterns",
 586                 "instead of prefixing all patterns with `&`, you can dereference the expression",
 587             )
 588         };
 589
 590         suggs.extend(arms.iter().filter_map(|a| {
 591             if let PatKind::Ref(ref refp, _) = a.pat.kind {
 592                 Some((a.pat.span, snippet(cx, refp.span, "..").to_string()))
 593             } else {
 594                 None
 595             }
 596         }));
 597
 598         span_lint_and_then(cx, MATCH_REF_PATS, expr.span, title, |db| {
 599             if !expr.span.from_expansion() {
 600                 multispan_sugg(db, msg.to_owned(), suggs);
 601             }
 602         });
 603     }
 604 }
 605
 606 fn check_match_as_ref(cx: &LateContext<'_, '_>, ex: &Expr, arms: &[Arm], expr: &Expr) {
 607     if arms.len() == 2 && arms[0].guard.is_none() && arms[1].guard.is_none() {
 608         let arm_ref: Option<BindingAnnotation> = if is_none_arm(&arms[0]) {
 609             is_ref_some_arm(&arms[1])
 610         } else if is_none_arm(&arms[1]) {
 611             is_ref_some_arm(&arms[0])
 612         } else {
 613             None
 614         };
 615         if let Some(rb) = arm_ref {
 616             let suggestion = if rb == BindingAnnotation::Ref {
 617                 "as_ref"
 618             } else {
 619                 "as_mut"
 620             };
 621
 622             let output_ty = cx.tables.expr_ty(expr);
 623             let input_ty = cx.tables.expr_ty(ex);
 624
 625             let cast = if_chain! {
 626                 if let ty::Adt(_, substs) = input_ty.kind;
 627                 let input_ty = substs.type_at(0);
 628                 if let ty::Adt(_, substs) = output_ty.kind;
 629                 let output_ty = substs.type_at(0);
 630                 if let ty::Ref(_, output_ty, _) = output_ty.kind;
 631                 if input_ty != output_ty;
 632                 then {
 633                     ".map(|x| x as _)"
 634                 } else {
 635                     ""
 636                 }
 637             };
 638
 639             let mut applicability = Applicability::MachineApplicable;
 640             span_lint_and_sugg(
 641                 cx,
 642                 MATCH_AS_REF,
 643                 expr.span,
 644                 &format!("use {}() instead", suggestion),
 645                 "try this",
 646                 format!(
 647                     "{}.{}(){}",
 648                     snippet_with_applicability(cx, ex.span, "_", &mut applicability),
 649                     suggestion,
 650                     cast,
 651                 ),
 652                 applicability,
 653             )
 654         }
 655     }
 656 }
 657
 658 /// Gets all arms that are unbounded `PatRange`s.
 659 fn all_ranges<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, arms: &'tcx [Arm]) -> Vec<SpannedRange<Constant>> {
 660     arms.iter()
 661         .flat_map(|arm| {
 662             if let Arm {
 663                 ref pat, guard: None, ..
 664             } = *arm
 665             {
 666                 if let PatKind::Range(ref lhs, ref rhs, ref range_end) = pat.kind {
 667                     let lhs = constant(cx, cx.tables, lhs)?.0;
 668                     let rhs = constant(cx, cx.tables, rhs)?.0;
 669                     let rhs = match *range_end {
 670                         RangeEnd::Included => Bound::Included(rhs),
 671                         RangeEnd::Excluded => Bound::Excluded(rhs),
 672                     };
 673                     return Some(SpannedRange {
 674                         span: pat.span,
 675                         node: (lhs, rhs),
 676                     });
 677                 }
 678
 679                 if let PatKind::Lit(ref value) = pat.kind {
 680                     let value = constant(cx, cx.tables, value)?.0;
 681                     return Some(SpannedRange {
 682                         span: pat.span,
 683                         node: (value.clone(), Bound::Included(value)),
 684                     });
 685                 }
 686             }
 687             None
 688         })
 689         .collect()
 690 }
 691
 692 #[derive(Debug, Eq, PartialEq)]
 693 pub struct SpannedRange<T> {
 694     pub span: Span,
 695     pub node: (T, Bound<T>),
 696 }
 697
 698 type TypedRanges = Vec<SpannedRange<u128>>;
 699
 700 /// Gets all `Int` ranges or all `Uint` ranges. Mixed types are an error anyway
 701 /// and other types than
 702 /// `Uint` and `Int` probably don't make sense.
 703 fn type_ranges(ranges: &[SpannedRange<Constant>]) -> TypedRanges {
 704     ranges
 705         .iter()
 706         .filter_map(|range| match range.node {
 707             (Constant::Int(start), Bound::Included(Constant::Int(end))) => Some(SpannedRange {
 708                 span: range.span,
 709                 node: (start, Bound::Included(end)),
 710             }),
 711             (Constant::Int(start), Bound::Excluded(Constant::Int(end))) => Some(SpannedRange {
 712                 span: range.span,
 713                 node: (start, Bound::Excluded(end)),
 714             }),
 715             (Constant::Int(start), Bound::Unbounded) => Some(SpannedRange {
 716                 span: range.span,
 717                 node: (start, Bound::Unbounded),
 718             }),
 719             _ => None,
 720         })
 721         .collect()
 722 }
 723
 724 fn is_unit_expr(expr: &Expr) -> bool {
 725     match expr.kind {
 726         ExprKind::Tup(ref v) if v.is_empty() => true,
 727         ExprKind::Block(ref b, _) if b.stmts.is_empty() && b.expr.is_none() => true,
 728         _ => false,
 729     }
 730 }
 731
 732 // Checks if arm has the form `None => None`
 733 fn is_none_arm(arm: &Arm) -> bool {
 734     match arm.pat.kind {
 735         PatKind::Path(ref path) if match_qpath(path, &paths::OPTION_NONE) => true,
 736         _ => false,
 737     }
 738 }
 739
 740 // Checks if arm has the form `Some(ref v) => Some(v)` (checks for `ref` and `ref mut`)
 741 fn is_ref_some_arm(arm: &Arm) -> Option<BindingAnnotation> {
 742     if_chain! {
 743         if let PatKind::TupleStruct(ref path, ref pats, _) = arm.pat.kind;
 744         if pats.len() == 1 && match_qpath(path, &paths::OPTION_SOME);
 745         if let PatKind::Binding(rb, .., ident, _) = pats[0].kind;
 746         if rb == BindingAnnotation::Ref || rb == BindingAnnotation::RefMut;
 747         if let ExprKind::Call(ref e, ref args) = remove_blocks(&arm.body).kind;
 748         if let ExprKind::Path(ref some_path) = e.kind;
 749         if match_qpath(some_path, &paths::OPTION_SOME) && args.len() == 1;
 750         if let ExprKind::Path(ref qpath) = args[0].kind;
 751         if let &QPath::Resolved(_, ref path2) = qpath;
 752         if path2.segments.len() == 1 && ident.name == path2.segments[0].ident.name;
 753         then {
 754             return Some(rb)
 755         }
 756     }
 757     None
 758 }
 759
 760 fn has_only_ref_pats(arms: &[Arm]) -> bool {
 761     let mapped = arms
 762         .iter()
 763         .map(|a| {
 764             match a.pat.kind {
 765                 PatKind::Ref(..) => Some(true), // &-patterns
 766                 PatKind::Wild => Some(false),   // an "anything" wildcard is also fine
 767                 _ => None,                      // any other pattern is not fine
 768             }
 769         })
 770         .collect::<Option<Vec<bool>>>();
 771     // look for Some(v) where there's at least one true element
 772     mapped.map_or(false, |v| v.iter().any(|el| *el))
 773 }
 774
 775 pub fn overlapping<T>(ranges: &[SpannedRange<T>]) -> Option<(&SpannedRange<T>, &SpannedRange<T>)>
 776 where
 777     T: Copy + Ord,
 778 {
 779     #[derive(Copy, Clone, Debug, Eq, PartialEq)]
 780     enum Kind<'a, T> {
 781         Start(T, &'a SpannedRange<T>),
 782         End(Bound<T>, &'a SpannedRange<T>),
 783     }
 784
 785     impl<'a, T: Copy> Kind<'a, T> {
 786         fn range(&self) -> &'a SpannedRange<T> {
 787             match *self {
 788                 Kind::Start(_, r) | Kind::End(_, r) => r,
 789             }
 790         }
 791
 792         fn value(self) -> Bound<T> {
 793             match self {
 794                 Kind::Start(t, _) => Bound::Included(t),
 795                 Kind::End(t, _) => t,
 796             }
 797         }
 798     }
 799
 800     impl<'a, T: Copy + Ord> PartialOrd for Kind<'a, T> {
 801         fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
 802             Some(self.cmp(other))
 803         }
 804     }
 805
 806     impl<'a, T: Copy + Ord> Ord for Kind<'a, T> {
 807         fn cmp(&self, other: &Self) -> Ordering {
 808             match (self.value(), other.value()) {
 809                 (Bound::Included(a), Bound::Included(b)) | (Bound::Excluded(a), Bound::Excluded(b)) => a.cmp(&b),
 810                 // Range patterns cannot be unbounded (yet)
 811                 (Bound::Unbounded, _) | (_, Bound::Unbounded) => unimplemented!(),
 812                 (Bound::Included(a), Bound::Excluded(b)) => match a.cmp(&b) {
 813                     Ordering::Equal => Ordering::Greater,
 814                     other => other,
 815                 },
 816                 (Bound::Excluded(a), Bound::Included(b)) => match a.cmp(&b) {
 817                     Ordering::Equal => Ordering::Less,
 818                     other => other,
 819                 },
 820             }
 821         }
 822     }
 823
 824     let mut values = Vec::with_capacity(2 * ranges.len());
 825
 826     for r in ranges {
 827         values.push(Kind::Start(r.node.0, r));
 828         values.push(Kind::End(r.node.1, r));
 829     }
 830
 831     values.sort();
 832
 833     for (a, b) in values.iter().zip(values.iter().skip(1)) {
 834         match (a, b) {
 835             (&Kind::Start(_, ra), &Kind::End(_, rb)) => {
 836                 if ra.node != rb.node {
 837                     return Some((ra, rb));
 838                 }
 839             },
 840             (&Kind::End(a, _), &Kind::Start(b, _)) if a != Bound::Included(b) => (),
 841             _ => return Some((a.range(), b.range())),
 842         }
 843     }
 844
 845     None
 846 }