clippy_lints/src/matches.rs

   1 use rustc::hir::*;
   2 use rustc::lint::*;
   3 use rustc::middle::const_val::ConstVal;
   4 use rustc::ty::{self, Ty};
   5 use rustc_const_eval::ConstContext;
   6 use rustc_const_math::ConstInt;
   7 use std::cmp::Ordering;
   8 use std::collections::Bound;
   9 use syntax::ast::LitKind;
  10 use syntax::codemap::Span;
  11 use utils::paths;
  12 use utils::{match_type, snippet, span_note_and_lint, span_lint_and_then, in_external_macro, expr_block, walk_ptrs_ty,
  13             is_expn_of, remove_blocks};
  14 use utils::sugg::Sugg;
  15
  16 /// **What it does:** Checks for matches with a single arm where an `if let`
  17 /// will usually suffice.
  18 ///
  19 /// **Why is this bad?** Just readability – `if let` nests less than a `match`.
  20 ///
  21 /// **Known problems:** None.
  22 ///
  23 /// **Example:**
  24 /// ```rust
  25 /// match x {
  26 ///     Some(ref foo) => bar(foo),
  27 ///     _ => ()
  28 /// }
  29 /// ```
  30 declare_lint! {
  31     pub SINGLE_MATCH,
  32     Warn,
  33     "a match statement with a single nontrivial arm (i.e. where the other arm \
  34      is `_ => {}`) instead of `if let`"
  35 }
  36
  37 /// **What it does:** Checks for matches with a two arms where an `if let` will
  38 /// usually suffice.
  39 ///
  40 /// **Why is this bad?** Just readability – `if let` nests less than a `match`.
  41 ///
  42 /// **Known problems:** Personal style preferences may differ.
  43 ///
  44 /// **Example:**
  45 /// ```rust
  46 /// match x {
  47 ///     Some(ref foo) => bar(foo),
  48 ///     _ => bar(other_ref),
  49 /// }
  50 /// ```
  51 declare_lint! {
  52     pub SINGLE_MATCH_ELSE,
  53     Allow,
  54     "a match statement with a two arms where the second arm's pattern is a wildcard \
  55      instead of `if let`"
  56 }
  57
  58 /// **What it does:** Checks for matches where all arms match a reference,
  59 /// suggesting to remove the reference and deref the matched expression
  60 /// instead. It also checks for `if let &foo = bar` blocks.
  61 ///
  62 /// **Why is this bad?** It just makes the code less readable. That reference
  63 /// destructuring adds nothing to the code.
  64 ///
  65 /// **Known problems:** None.
  66 ///
  67 /// **Example:**
  68 /// ```rust
  69 /// match x {
  70 ///     &A(ref y) => foo(y),
  71 ///     &B => bar(),
  72 ///     _ => frob(&x),
  73 /// }
  74 /// ```
  75 declare_lint! {
  76     pub MATCH_REF_PATS,
  77     Warn,
  78     "a match or `if let` with all arms prefixed with `&` instead of deref-ing the match expression"
  79 }
  80
  81 /// **What it does:** Checks for matches where match expression is a `bool`. It
  82 /// suggests to replace the expression with an `if...else` block.
  83 ///
  84 /// **Why is this bad?** It makes the code less readable.
  85 ///
  86 /// **Known problems:** None.
  87 ///
  88 /// **Example:**
  89 /// ```rust
  90 /// let condition: bool = true;
  91 /// match condition {
  92 ///     true => foo(),
  93 ///     false => bar(),
  94 /// }
  95 /// ```
  96 declare_lint! {
  97     pub MATCH_BOOL,
  98     Warn,
  99     "a match on a boolean expression instead of an `if..else` block"
 100 }
 101
 102 /// **What it does:** Checks for overlapping match arms.
 103 ///
 104 /// **Why is this bad?** It is likely to be an error and if not, makes the code
 105 /// less obvious.
 106 ///
 107 /// **Known problems:** None.
 108 ///
 109 /// **Example:**
 110 /// ```rust
 111 /// let x = 5;
 112 /// match x {
 113 ///     1 ... 10 => println!("1 ... 10"),
 114 ///     5 ... 15 => println!("5 ... 15"),
 115 ///     _ => (),
 116 /// }
 117 /// ```
 118 declare_lint! {
 119     pub MATCH_OVERLAPPING_ARM,
 120     Warn,
 121     "a match with overlapping arms"
 122 }
 123
 124 /// **What it does:** Checks for arm which matches all errors with `Err(_)`
 125 /// and take drastic actions like `panic!`.
 126 ///
 127 /// **Why is this bad?** It is generally a bad practice, just like
 128 /// catching all exceptions in java with `catch(Exception)`
 129 ///
 130 /// **Known problems:** None.
 131 ///
 132 /// **Example:**
 133 /// ```rust
 134 /// let x : Result(i32, &str) = Ok(3);
 135 /// match x {
 136 ///     Ok(_) => println!("ok"),
 137 ///     Err(_) => panic!("err"),
 138 /// }
 139 /// ```
 140 declare_lint! {
 141     pub MATCH_WILD_ERR_ARM,
 142     Warn,
 143     "a match with `Err(_)` arm and take drastic actions"
 144 }
 145
 146 #[allow(missing_copy_implementations)]
 147 pub struct MatchPass;
 148
 149 impl LintPass for MatchPass {
 150     fn get_lints(&self) -> LintArray {
 151         lint_array!(SINGLE_MATCH,
 152                     MATCH_REF_PATS,
 153                     MATCH_BOOL,
 154                     SINGLE_MATCH_ELSE,
 155                     MATCH_OVERLAPPING_ARM,
 156                     MATCH_WILD_ERR_ARM)
 157     }
 158 }
 159
 160 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for MatchPass {
 161     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
 162         if in_external_macro(cx, expr.span) {
 163             return;
 164         }
 165         if let ExprMatch(ref ex, ref arms, MatchSource::Normal) = expr.node {
 166             check_single_match(cx, ex, arms, expr);
 167             check_match_bool(cx, ex, arms, expr);
 168             check_overlapping_arms(cx, ex, arms);
 169             check_wild_err_arm(cx, ex, arms);
 170         }
 171         if let ExprMatch(ref ex, ref arms, source) = expr.node {
 172             check_match_ref_pats(cx, ex, arms, source, expr);
 173         }
 174     }
 175 }
 176
 177 #[cfg_attr(rustfmt, rustfmt_skip)]
 178 fn check_single_match(cx: &LateContext, ex: &Expr, arms: &[Arm], expr: &Expr) {
 179     if arms.len() == 2 &&
 180       arms[0].pats.len() == 1 && arms[0].guard.is_none() &&
 181       arms[1].pats.len() == 1 && arms[1].guard.is_none() {
 182         let els = remove_blocks(&arms[1].body);
 183         let els = if is_unit_expr(els) {
 184             None
 185         } else if let ExprBlock(_) = els.node {
 186             // matches with blocks that contain statements are prettier as `if let + else`
 187             Some(els)
 188         } else {
 189             // allow match arms with just expressions
 190             return;
 191         };
 192         let ty = cx.tables.expr_ty(ex);
 193         if ty.sty != ty::TyBool || cx.current_level(MATCH_BOOL) == Allow {
 194             check_single_match_single_pattern(cx, ex, arms, expr, els);
 195             check_single_match_opt_like(cx, ex, arms, expr, ty, els);
 196         }
 197     }
 198 }
 199
 200 fn check_single_match_single_pattern(cx: &LateContext, ex: &Expr, arms: &[Arm], expr: &Expr, els: Option<&Expr>) {
 201     if arms[1].pats[0].node == PatKind::Wild {
 202         report_single_match_single_pattern(cx, ex, arms, expr, els);
 203     }
 204 }
 205
 206 fn report_single_match_single_pattern(cx: &LateContext, ex: &Expr, arms: &[Arm], expr: &Expr, els: Option<&Expr>) {
 207     let lint = if els.is_some() {
 208         SINGLE_MATCH_ELSE
 209     } else {
 210         SINGLE_MATCH
 211     };
 212     let els_str = els.map_or(String::new(), |els| format!(" else {}", expr_block(cx, els, None, "..")));
 213     span_lint_and_then(cx,
 214                        lint,
 215                        expr.span,
 216                        "you seem to be trying to use match for destructuring a single pattern. Consider using `if \
 217                         let`",
 218                        |db| {
 219         db.span_suggestion(expr.span,
 220                            "try this",
 221                            format!("if let {} = {} {}{}",
 222                                    snippet(cx, arms[0].pats[0].span, ".."),
 223                                    snippet(cx, ex.span, ".."),
 224                                    expr_block(cx, &arms[0].body, None, ".."),
 225                                    els_str));
 226     });
 227 }
 228
 229 fn check_single_match_opt_like(cx: &LateContext, ex: &Expr, arms: &[Arm], expr: &Expr, ty: Ty, els: Option<&Expr>) {
 230     // list of candidate Enums we know will never get any more members
 231     let candidates = &[(&paths::COW, "Borrowed"),
 232                        (&paths::COW, "Cow::Borrowed"),
 233                        (&paths::COW, "Cow::Owned"),
 234                        (&paths::COW, "Owned"),
 235                        (&paths::OPTION, "None"),
 236                        (&paths::RESULT, "Err"),
 237                        (&paths::RESULT, "Ok")];
 238
 239     let path = match arms[1].pats[0].node {
 240         PatKind::TupleStruct(ref path, ref inner, _) => {
 241             // contains any non wildcard patterns? e.g. Err(err)
 242             if inner.iter().any(|pat| pat.node != PatKind::Wild) {
 243                 return;
 244             }
 245             print::to_string(print::NO_ANN, |s| s.print_qpath(path, false))
 246         },
 247         PatKind::Binding(BindByValue(MutImmutable), _, ident, None) => ident.node.to_string(),
 248         PatKind::Path(ref path) => print::to_string(print::NO_ANN, |s| s.print_qpath(path, false)),
 249         _ => return,
 250     };
 251
 252     for &(ty_path, pat_path) in candidates {
 253         if path == *pat_path && match_type(cx, ty, ty_path) {
 254             report_single_match_single_pattern(cx, ex, arms, expr, els);
 255         }
 256     }
 257 }
 258
 259 fn check_match_bool(cx: &LateContext, ex: &Expr, arms: &[Arm], expr: &Expr) {
 260     // type of expression == bool
 261     if cx.tables.expr_ty(ex).sty == ty::TyBool {
 262         span_lint_and_then(cx,
 263                            MATCH_BOOL,
 264                            expr.span,
 265                            "you seem to be trying to match on a boolean expression",
 266                            move |db| {
 267             if arms.len() == 2 && arms[0].pats.len() == 1 {
 268                 // no guards
 269                 let exprs = if let PatKind::Lit(ref arm_bool) = arms[0].pats[0].node {
 270                     if let ExprLit(ref lit) = arm_bool.node {
 271                         match lit.node {
 272                             LitKind::Bool(true) => Some((&*arms[0].body, &*arms[1].body)),
 273                             LitKind::Bool(false) => Some((&*arms[1].body, &*arms[0].body)),
 274                             _ => None,
 275                         }
 276                     } else {
 277                         None
 278                     }
 279                 } else {
 280                     None
 281                 };
 282
 283                 if let Some((true_expr, false_expr)) = exprs {
 284                     let sugg = match (is_unit_expr(true_expr), is_unit_expr(false_expr)) {
 285                         (false, false) => {
 286                             Some(format!("if {} {} else {}",
 287                                          snippet(cx, ex.span, "b"),
 288                                          expr_block(cx, true_expr, None, ".."),
 289                                          expr_block(cx, false_expr, None, "..")))
 290                         },
 291                         (false, true) => {
 292                             Some(format!("if {} {}", snippet(cx, ex.span, "b"), expr_block(cx, true_expr, None, "..")))
 293                         },
 294                         (true, false) => {
 295                             let test = Sugg::hir(cx, ex, "..");
 296                             Some(format!("if {} {}", !test, expr_block(cx, false_expr, None, "..")))
 297                         },
 298                         (true, true) => None,
 299                     };
 300
 301                     if let Some(sugg) = sugg {
 302                         db.span_suggestion(expr.span, "consider using an if/else expression", sugg);
 303                     }
 304                 }
 305             }
 306
 307         });
 308     }
 309 }
 310
 311 fn check_overlapping_arms(cx: &LateContext, ex: &Expr, arms: &[Arm]) {
 312     if arms.len() >= 2 && cx.tables.expr_ty(ex).is_integral() {
 313         let ranges = all_ranges(cx, arms);
 314         let type_ranges = type_ranges(&ranges);
 315         if !type_ranges.is_empty() {
 316             if let Some((start, end)) = overlapping(&type_ranges) {
 317                 span_note_and_lint(cx,
 318                                    MATCH_OVERLAPPING_ARM,
 319                                    start.span,
 320                                    "some ranges overlap",
 321                                    end.span,
 322                                    "overlaps with this");
 323             }
 324         }
 325     }
 326 }
 327
 328 fn check_wild_err_arm(cx: &LateContext, ex: &Expr, arms: &[Arm]) {
 329     let ex_ty = walk_ptrs_ty(cx.tables.expr_ty(ex));
 330     if match_type(cx, ex_ty, &paths::RESULT) {
 331         for arm in arms {
 332             if let PatKind::TupleStruct(ref path, ref inner, _) = arm.pats[0].node {
 333                 let path_str = print::to_string(print::NO_ANN, |s| s.print_qpath(path, false));
 334                 if_let_chain! {[
 335                     path_str == "Err",
 336                     inner.iter().any(|pat| pat.node == PatKind::Wild),
 337                     let ExprBlock(ref block) = arm.body.node,
 338                     is_panic_block(block)
 339                 ], {
 340                     // `Err(_)` arm with `panic!` found
 341                     span_note_and_lint(cx,
 342                                        MATCH_WILD_ERR_ARM,
 343                                        arm.pats[0].span,
 344                                        "Err(_) will match all errors, maybe not a good idea",
 345                                        arm.pats[0].span,
 346                                        "to remove this warning, match each error seperately \
 347                                         or use unreachable macro");
 348                 }}
 349             }
 350         }
 351     }
 352 }
 353
 354 // If the block contains only a `panic!` macro (as expression or statement)
 355 fn is_panic_block(block: &Block) -> bool {
 356     match (&block.expr, block.stmts.len(), block.stmts.first()) {
 357         (&Some(ref exp), 0, _) => {
 358             is_expn_of(exp.span, "panic").is_some() && is_expn_of(exp.span, "unreachable").is_none()
 359         },
 360         (&None, 1, Some(stmt)) => {
 361             is_expn_of(stmt.span, "panic").is_some() && is_expn_of(stmt.span, "unreachable").is_none()
 362         },
 363         _ => false,
 364     }
 365 }
 366
 367 fn check_match_ref_pats(cx: &LateContext, ex: &Expr, arms: &[Arm], source: MatchSource, expr: &Expr) {
 368     if has_only_ref_pats(arms) {
 369         if let ExprAddrOf(Mutability::MutImmutable, ref inner) = ex.node {
 370             span_lint_and_then(cx,
 371                                MATCH_REF_PATS,
 372                                expr.span,
 373                                "you don't need to add `&` to both the expression and the patterns",
 374                                |db| {
 375                 let inner = Sugg::hir(cx, inner, "..");
 376                 let template = match_template(expr.span, source, &inner);
 377                 db.span_suggestion(expr.span, "try", template);
 378             });
 379         } else {
 380             span_lint_and_then(cx,
 381                                MATCH_REF_PATS,
 382                                expr.span,
 383                                "you don't need to add `&` to all patterns",
 384                                |db| {
 385                 let ex = Sugg::hir(cx, ex, "..");
 386                 let template = match_template(expr.span, source, &ex.deref());
 387                 db.span_suggestion(expr.span,
 388                                    "instead of prefixing all patterns with `&`, you can dereference the expression",
 389                                    template);
 390             });
 391         }
 392     }
 393 }
 394
 395 /// Get all arms that are unbounded `PatRange`s.
 396 fn all_ranges<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, arms: &[Arm]) -> Vec<SpannedRange<ConstVal<'tcx>>> {
 397     let constcx = ConstContext::with_tables(cx.tcx, cx.tables);
 398     arms.iter()
 399         .flat_map(|arm| {
 400             if let Arm { ref pats, guard: None, .. } = *arm {
 401                     pats.iter()
 402                 } else {
 403                     [].iter()
 404                 }
 405                 .filter_map(|pat| {
 406                     if_let_chain! {[
 407                     let PatKind::Range(ref lhs, ref rhs, ref range_end) = pat.node,
 408                     let Ok(lhs) = constcx.eval(lhs),
 409                     let Ok(rhs) = constcx.eval(rhs)
 410                 ], {
 411                     let rhs = match *range_end {
 412                         RangeEnd::Included => Bound::Included(rhs),
 413                         RangeEnd::Excluded => Bound::Excluded(rhs),
 414                     };
 415                     return Some(SpannedRange { span: pat.span, node: (lhs, rhs) });
 416                 }}
 417
 418                     if_let_chain! {[
 419                     let PatKind::Lit(ref value) = pat.node,
 420                     let Ok(value) = constcx.eval(value)
 421                 ], {
 422                     return Some(SpannedRange { span: pat.span, node: (value.clone(), Bound::Included(value)) });
 423                 }}
 424
 425                     None
 426                 })
 427         })
 428         .collect()
 429 }
 430
 431 #[derive(Debug, Eq, PartialEq)]
 432 pub struct SpannedRange<T> {
 433     pub span: Span,
 434     pub node: (T, Bound<T>),
 435 }
 436
 437 type TypedRanges = Vec<SpannedRange<ConstInt>>;
 438
 439 /// Get all `Int` ranges or all `Uint` ranges. Mixed types are an error anyway and other types than
 440 /// `Uint` and `Int` probably don't make sense.
 441 fn type_ranges(ranges: &[SpannedRange<ConstVal>]) -> TypedRanges {
 442     ranges.iter()
 443         .filter_map(|range| match range.node {
 444             (ConstVal::Integral(start), Bound::Included(ConstVal::Integral(end))) => {
 445                 Some(SpannedRange {
 446                     span: range.span,
 447                     node: (start, Bound::Included(end)),
 448                 })
 449             },
 450             (ConstVal::Integral(start), Bound::Excluded(ConstVal::Integral(end))) => {
 451                 Some(SpannedRange {
 452                     span: range.span,
 453                     node: (start, Bound::Excluded(end)),
 454                 })
 455             },
 456             (ConstVal::Integral(start), Bound::Unbounded) => {
 457                 Some(SpannedRange {
 458                     span: range.span,
 459                     node: (start, Bound::Unbounded),
 460                 })
 461             },
 462             _ => None,
 463         })
 464         .collect()
 465 }
 466
 467 fn is_unit_expr(expr: &Expr) -> bool {
 468     match expr.node {
 469         ExprTup(ref v) if v.is_empty() => true,
 470         ExprBlock(ref b) if b.stmts.is_empty() && b.expr.is_none() => true,
 471         _ => false,
 472     }
 473 }
 474
 475 fn has_only_ref_pats(arms: &[Arm]) -> bool {
 476     let mapped = arms.iter()
 477         .flat_map(|a| &a.pats)
 478         .map(|p| {
 479             match p.node {
 480                 PatKind::Ref(..) => Some(true),  // &-patterns
 481                 PatKind::Wild => Some(false),   // an "anything" wildcard is also fine
 482                 _ => None,                    // any other pattern is not fine
 483             }
 484         })
 485         .collect::<Option<Vec<bool>>>();
 486     // look for Some(v) where there's at least one true element
 487     mapped.map_or(false, |v| v.iter().any(|el| *el))
 488 }
 489
 490 fn match_template(span: Span, source: MatchSource, expr: &Sugg) -> String {
 491     match source {
 492         MatchSource::Normal => format!("match {} {{ .. }}", expr),
 493         MatchSource::IfLetDesugar { .. } => format!("if let .. = {} {{ .. }}", expr),
 494         MatchSource::WhileLetDesugar => format!("while let .. = {} {{ .. }}", expr),
 495         MatchSource::ForLoopDesugar => span_bug!(span, "for loop desugared to match with &-patterns!"),
 496         MatchSource::TryDesugar => span_bug!(span, "`?` operator desugared to match with &-patterns!"),
 497     }
 498 }
 499
 500 pub fn overlapping<T>(ranges: &[SpannedRange<T>]) -> Option<(&SpannedRange<T>, &SpannedRange<T>)>
 501     where T: Copy + Ord
 502 {
 503     #[derive(Copy, Clone, Debug, Eq, PartialEq)]
 504     enum Kind<'a, T: 'a> {
 505         Start(T, &'a SpannedRange<T>),
 506         End(Bound<T>, &'a SpannedRange<T>),
 507     }
 508
 509     impl<'a, T: Copy> Kind<'a, T> {
 510         fn range(&self) -> &'a SpannedRange<T> {
 511             match *self {
 512                 Kind::Start(_, r) |
 513                 Kind::End(_, r) => r,
 514             }
 515         }
 516
 517         fn value(self) -> Bound<T> {
 518             match self {
 519                 Kind::Start(t, _) => Bound::Included(t),
 520                 Kind::End(t, _) => t,
 521             }
 522         }
 523     }
 524
 525     impl<'a, T: Copy + Ord> PartialOrd for Kind<'a, T> {
 526         fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
 527             Some(self.cmp(other))
 528         }
 529     }
 530
 531     impl<'a, T: Copy + Ord> Ord for Kind<'a, T> {
 532         fn cmp(&self, other: &Self) -> Ordering {
 533             match (self.value(), other.value()) {
 534                 (Bound::Included(a), Bound::Included(b)) |
 535                 (Bound::Excluded(a), Bound::Excluded(b)) => a.cmp(&b),
 536                 // Range patterns cannot be unbounded (yet)
 537                 (Bound::Unbounded, _) |
 538                 (_, Bound::Unbounded) => unimplemented!(),
 539                 (Bound::Included(a), Bound::Excluded(b)) => {
 540                     match a.cmp(&b) {
 541                         Ordering::Equal => Ordering::Greater,
 542                         other => other,
 543                     }
 544                 },
 545                 (Bound::Excluded(a), Bound::Included(b)) => {
 546                     match a.cmp(&b) {
 547                         Ordering::Equal => Ordering::Less,
 548                         other => other,
 549                     }
 550                 },
 551             }
 552         }
 553     }
 554
 555     let mut values = Vec::with_capacity(2 * ranges.len());
 556
 557     for r in ranges {
 558         values.push(Kind::Start(r.node.0, r));
 559         values.push(Kind::End(r.node.1, r));
 560     }
 561
 562     values.sort();
 563
 564     for (a, b) in values.iter().zip(values.iter().skip(1)) {
 565         match (a, b) {
 566             (&Kind::Start(_, ra), &Kind::End(_, rb)) => {
 567                 if ra.node != rb.node {
 568                     return Some((ra, rb));
 569                 }
 570             },
 571             (&Kind::End(a, _), &Kind::Start(b, _)) if a != Bound::Included(b) => (),
 572             _ => return Some((a.range(), b.range())),
 573         }
 574     }
 575
 576     None
 577 }