1 // Copyright 2014-2018 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution.
4 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
5 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
7 // option. This file may not be copied, modified, or distributed
8 // except according to those terms.
11 use crate::rustc::hir::*;
12 use crate::rustc::lint::{LateContext, LateLintPass, LintArray, LintPass, in_external_macro, LintContext};
13 use crate::rustc::{declare_tool_lint, lint_array};
14 use if_chain::if_chain;
15 use crate::rustc::ty::{self, Ty};
16 use std::cmp::Ordering;
17 use std::collections::Bound;
18 use crate::syntax::ast::LitKind;
19 use crate::syntax::source_map::Span;
20 use crate::utils::paths;
21 use crate::utils::{expr_block, is_allowed, is_expn_of, match_qpath, match_type, multispan_sugg,
22 remove_blocks, snippet, span_lint_and_sugg, span_lint_and_then,
23 span_note_and_lint, walk_ptrs_ty};
24 use crate::utils::sugg::Sugg;
25 use crate::consts::{constant, Constant};
26 use crate::rustc_errors::Applicability;
28 /// **What it does:** Checks for matches with a single arm where an `if let`
29 /// will usually suffice.
31 /// **Why is this bad?** Just readability – `if let` nests less than a `match`.
33 /// **Known problems:** None.
38 /// Some(ref foo) => bar(foo),
42 declare_clippy_lint! {
45 "a match statement with a single nontrivial arm (i.e. where the other arm \
46 is `_ => {}`) instead of `if let`"
49 /// **What it does:** Checks for matches with a two arms where an `if let` will
52 /// **Why is this bad?** Just readability – `if let` nests less than a `match`.
54 /// **Known problems:** Personal style preferences may differ.
59 /// Some(ref foo) => bar(foo),
60 /// _ => bar(other_ref),
63 declare_clippy_lint! {
64 pub SINGLE_MATCH_ELSE,
66 "a match statement with a two arms where the second arm's pattern is a wildcard \
70 /// **What it does:** Checks for matches where all arms match a reference,
71 /// suggesting to remove the reference and deref the matched expression
72 /// instead. It also checks for `if let &foo = bar` blocks.
74 /// **Why is this bad?** It just makes the code less readable. That reference
75 /// destructuring adds nothing to the code.
77 /// **Known problems:** None.
82 /// &A(ref y) => foo(y),
87 declare_clippy_lint! {
90 "a match or `if let` with all arms prefixed with `&` instead of deref-ing the match expression"
93 /// **What it does:** Checks for matches where match expression is a `bool`. It
94 /// suggests to replace the expression with an `if...else` block.
96 /// **Why is this bad?** It makes the code less readable.
98 /// **Known problems:** None.
102 /// let condition: bool = true;
103 /// match condition {
108 /// Use if/else instead:
110 /// let condition: bool = true;
117 declare_clippy_lint! {
120 "a match on a boolean expression instead of an `if..else` block"
123 /// **What it does:** Checks for overlapping match arms.
125 /// **Why is this bad?** It is likely to be an error and if not, makes the code
128 /// **Known problems:** None.
134 /// 1 ... 10 => println!("1 ... 10"),
135 /// 5 ... 15 => println!("5 ... 15"),
139 declare_clippy_lint! {
140 pub MATCH_OVERLAPPING_ARM,
142 "a match with overlapping arms"
145 /// **What it does:** Checks for arm which matches all errors with `Err(_)`
146 /// and take drastic actions like `panic!`.
148 /// **Why is this bad?** It is generally a bad practice, just like
149 /// catching all exceptions in java with `catch(Exception)`
151 /// **Known problems:** None.
155 /// let x : Result(i32, &str) = Ok(3);
157 /// Ok(_) => println!("ok"),
158 /// Err(_) => panic!("err"),
161 declare_clippy_lint! {
162 pub MATCH_WILD_ERR_ARM,
164 "a match with `Err(_)` arm and take drastic actions"
167 /// **What it does:** Checks for match which is used to add a reference to an
170 /// **Why is this bad?** Using `as_ref()` or `as_mut()` instead is shorter.
172 /// **Known problems:** None.
176 /// let x: Option<()> = None;
177 /// let r: Option<&()> = match x {
179 /// Some(ref v) => Some(v),
182 declare_clippy_lint! {
185 "a match on an Option value instead of using `as_ref()` or `as_mut`"
188 #[allow(missing_copy_implementations)]
189 pub struct MatchPass;
191 impl LintPass for MatchPass {
192 fn get_lints(&self) -> LintArray {
198 MATCH_OVERLAPPING_ARM,
205 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for MatchPass {
206 fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
207 if in_external_macro(cx.sess(), expr.span) {
210 if let ExprKind::Match(ref ex, ref arms, MatchSource::Normal) = expr.node {
211 check_single_match(cx, ex, arms, expr);
212 check_match_bool(cx, ex, arms, expr);
213 check_overlapping_arms(cx, ex, arms);
214 check_wild_err_arm(cx, ex, arms);
215 check_match_as_ref(cx, ex, arms, expr);
217 if let ExprKind::Match(ref ex, ref arms, _) = expr.node {
218 check_match_ref_pats(cx, ex, arms, expr);
224 fn check_single_match(cx: &LateContext<'_, '_>, ex: &Expr, arms: &[Arm], expr: &Expr) {
225 if arms.len() == 2 &&
226 arms[0].pats.len() == 1 && arms[0].guard.is_none() &&
227 arms[1].pats.len() == 1 && arms[1].guard.is_none() {
228 let els = remove_blocks(&arms[1].body);
229 let els = if is_unit_expr(els) {
231 } else if let ExprKind::Block(_, _) = els.node {
232 // matches with blocks that contain statements are prettier as `if let + else`
235 // allow match arms with just expressions
238 let ty = cx.tables.expr_ty(ex);
239 if ty.sty != ty::Bool || is_allowed(cx, MATCH_BOOL, ex.id) {
240 check_single_match_single_pattern(cx, ex, arms, expr, els);
241 check_single_match_opt_like(cx, ex, arms, expr, ty, els);
246 fn check_single_match_single_pattern(cx: &LateContext<'_, '_>, ex: &Expr, arms: &[Arm], expr: &Expr, els: Option<&Expr>) {
247 if is_wild(&arms[1].pats[0]) {
248 report_single_match_single_pattern(cx, ex, arms, expr, els);
252 fn report_single_match_single_pattern(cx: &LateContext<'_, '_>, ex: &Expr, arms: &[Arm], expr: &Expr, els: Option<&Expr>) {
253 let lint = if els.is_some() {
258 let els_str = els.map_or(String::new(), |els| format!(" else {}", expr_block(cx, els, None, "..")));
263 "you seem to be trying to use match for destructuring a single pattern. Consider using `if \
267 "if let {} = {} {}{}",
268 snippet(cx, arms[0].pats[0].span, ".."),
269 snippet(cx, ex.span, ".."),
270 expr_block(cx, &arms[0].body, None, ".."),
276 fn check_single_match_opt_like(cx: &LateContext<'_, '_>, ex: &Expr, arms: &[Arm], expr: &Expr, ty: Ty<'_>, els: Option<&Expr>) {
277 // list of candidate Enums we know will never get any more members
279 (&paths::COW, "Borrowed"),
280 (&paths::COW, "Cow::Borrowed"),
281 (&paths::COW, "Cow::Owned"),
282 (&paths::COW, "Owned"),
283 (&paths::OPTION, "None"),
284 (&paths::RESULT, "Err"),
285 (&paths::RESULT, "Ok"),
288 let path = match arms[1].pats[0].node {
289 PatKind::TupleStruct(ref path, ref inner, _) => {
290 // contains any non wildcard patterns? e.g. Err(err)
291 if !inner.iter().all(is_wild) {
294 print::to_string(print::NO_ANN, |s| s.print_qpath(path, false))
296 PatKind::Binding(BindingAnnotation::Unannotated, _, ident, None) => ident.to_string(),
297 PatKind::Path(ref path) => print::to_string(print::NO_ANN, |s| s.print_qpath(path, false)),
301 for &(ty_path, pat_path) in candidates {
302 if path == *pat_path && match_type(cx, ty, ty_path) {
303 report_single_match_single_pattern(cx, ex, arms, expr, els);
308 fn check_match_bool(cx: &LateContext<'_, '_>, ex: &Expr, arms: &[Arm], expr: &Expr) {
309 // type of expression == bool
310 if cx.tables.expr_ty(ex).sty == ty::Bool {
315 "you seem to be trying to match on a boolean expression",
317 if arms.len() == 2 && arms[0].pats.len() == 1 {
319 let exprs = if let PatKind::Lit(ref arm_bool) = arms[0].pats[0].node {
320 if let ExprKind::Lit(ref lit) = arm_bool.node {
322 LitKind::Bool(true) => Some((&*arms[0].body, &*arms[1].body)),
323 LitKind::Bool(false) => Some((&*arms[1].body, &*arms[0].body)),
333 if let Some((true_expr, false_expr)) = exprs {
334 let sugg = match (is_unit_expr(true_expr), is_unit_expr(false_expr)) {
335 (false, false) => Some(format!(
337 snippet(cx, ex.span, "b"),
338 expr_block(cx, true_expr, None, ".."),
339 expr_block(cx, false_expr, None, "..")
341 (false, true) => Some(format!(
343 snippet(cx, ex.span, "b"),
344 expr_block(cx, true_expr, None, "..")
347 let test = Sugg::hir(cx, ex, "..");
348 Some(format!("if {} {}", !test, expr_block(cx, false_expr, None, "..")))
350 (true, true) => None,
353 if let Some(sugg) = sugg {
354 db.span_suggestion_with_applicability(
356 "consider using an if/else expression",
358 Applicability::HasPlaceholders,
368 fn check_overlapping_arms<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, ex: &'tcx Expr, arms: &'tcx [Arm]) {
369 if arms.len() >= 2 && cx.tables.expr_ty(ex).is_integral() {
370 let ranges = all_ranges(cx, arms);
371 let type_ranges = type_ranges(&ranges);
372 if !type_ranges.is_empty() {
373 if let Some((start, end)) = overlapping(&type_ranges) {
376 MATCH_OVERLAPPING_ARM,
378 "some ranges overlap",
380 "overlaps with this",
387 fn is_wild(pat: &impl std::ops::Deref<Target = Pat>) -> bool {
389 PatKind::Wild => true,
394 fn check_wild_err_arm(cx: &LateContext<'_, '_>, ex: &Expr, arms: &[Arm]) {
395 let ex_ty = walk_ptrs_ty(cx.tables.expr_ty(ex));
396 if match_type(cx, ex_ty, &paths::RESULT) {
398 if let PatKind::TupleStruct(ref path, ref inner, _) = arm.pats[0].node {
399 let path_str = print::to_string(print::NO_ANN, |s| s.print_qpath(path, false));
401 if path_str == "Err";
402 if inner.iter().any(is_wild);
403 if let ExprKind::Block(ref block, _) = arm.body.node;
404 if is_panic_block(block);
406 // `Err(_)` arm with `panic!` found
407 span_note_and_lint(cx,
410 "Err(_) will match all errors, maybe not a good idea",
412 "to remove this warning, match each error separately \
413 or use unreachable macro");
421 // If the block contains only a `panic!` macro (as expression or statement)
422 fn is_panic_block(block: &Block) -> bool {
423 match (&block.expr, block.stmts.len(), block.stmts.first()) {
424 (&Some(ref exp), 0, _) => {
425 is_expn_of(exp.span, "panic").is_some() && is_expn_of(exp.span, "unreachable").is_none()
427 (&None, 1, Some(stmt)) => {
428 is_expn_of(stmt.span, "panic").is_some() && is_expn_of(stmt.span, "unreachable").is_none()
434 fn check_match_ref_pats(cx: &LateContext<'_, '_>, ex: &Expr, arms: &[Arm], expr: &Expr) {
435 if has_only_ref_pats(arms) {
436 let mut suggs = Vec::new();
437 let (title, msg) = if let ExprKind::AddrOf(Mutability::MutImmutable, ref inner) = ex.node {
438 suggs.push((ex.span, Sugg::hir(cx, inner, "..").to_string()));
440 "you don't need to add `&` to both the expression and the patterns",
444 suggs.push((ex.span, Sugg::hir(cx, ex, "..").deref().to_string()));
446 "you don't need to add `&` to all patterns",
447 "instead of prefixing all patterns with `&`, you can dereference the expression",
451 suggs.extend(arms.iter().flat_map(|a| &a.pats).filter_map(|p| {
452 if let PatKind::Ref(ref refp, _) = p.node {
453 Some((p.span, snippet(cx, refp.span, "..").to_string()))
459 span_lint_and_then(cx, MATCH_REF_PATS, expr.span, title, |db| {
460 multispan_sugg(db, msg.to_owned(), suggs);
465 fn check_match_as_ref(cx: &LateContext<'_, '_>, ex: &Expr, arms: &[Arm], expr: &Expr) {
466 if arms.len() == 2 &&
467 arms[0].pats.len() == 1 && arms[0].guard.is_none() &&
468 arms[1].pats.len() == 1 && arms[1].guard.is_none() {
469 let arm_ref: Option<BindingAnnotation> = if is_none_arm(&arms[0]) {
470 is_ref_some_arm(&arms[1])
471 } else if is_none_arm(&arms[1]) {
472 is_ref_some_arm(&arms[0])
476 if let Some(rb) = arm_ref {
477 let suggestion = if rb == BindingAnnotation::Ref { "as_ref" } else { "as_mut" };
482 &format!("use {}() instead", suggestion),
484 format!("{}.{}()", snippet(cx, ex.span, "_"), suggestion)
490 /// Get all arms that are unbounded `PatRange`s.
491 fn all_ranges<'a, 'tcx>(
492 cx: &LateContext<'a, 'tcx>,
494 ) -> Vec<SpannedRange<Constant>> {
507 if let PatKind::Range(ref lhs, ref rhs, ref range_end) = pat.node {
508 let lhs = constant(cx, cx.tables, lhs)?.0;
509 let rhs = constant(cx, cx.tables, rhs)?.0;
510 let rhs = match *range_end {
511 RangeEnd::Included => Bound::Included(rhs),
512 RangeEnd::Excluded => Bound::Excluded(rhs),
514 return Some(SpannedRange { span: pat.span, node: (lhs, rhs) });
517 if let PatKind::Lit(ref value) = pat.node {
518 let value = constant(cx, cx.tables, value)?.0;
519 return Some(SpannedRange { span: pat.span, node: (value.clone(), Bound::Included(value)) });
528 #[derive(Debug, Eq, PartialEq)]
529 pub struct SpannedRange<T> {
531 pub node: (T, Bound<T>),
534 type TypedRanges = Vec<SpannedRange<u128>>;
536 /// Get all `Int` ranges or all `Uint` ranges. Mixed types are an error anyway
537 /// and other types than
538 /// `Uint` and `Int` probably don't make sense.
539 fn type_ranges(ranges: &[SpannedRange<Constant>]) -> TypedRanges {
542 .filter_map(|range| match range.node {
544 Constant::Int(start),
545 Bound::Included(Constant::Int(end)),
546 ) => Some(SpannedRange {
548 node: (start, Bound::Included(end)),
551 Constant::Int(start),
552 Bound::Excluded(Constant::Int(end)),
553 ) => Some(SpannedRange {
555 node: (start, Bound::Excluded(end)),
558 Constant::Int(start),
560 ) => Some(SpannedRange {
562 node: (start, Bound::Unbounded),
569 fn is_unit_expr(expr: &Expr) -> bool {
571 ExprKind::Tup(ref v) if v.is_empty() => true,
572 ExprKind::Block(ref b, _) if b.stmts.is_empty() && b.expr.is_none() => true,
577 // Checks if arm has the form `None => None`
578 fn is_none_arm(arm: &Arm) -> bool {
579 match arm.pats[0].node {
580 PatKind::Path(ref path) if match_qpath(path, &paths::OPTION_NONE) => true,
585 // Checks if arm has the form `Some(ref v) => Some(v)` (checks for `ref` and `ref mut`)
586 fn is_ref_some_arm(arm: &Arm) -> Option<BindingAnnotation> {
588 if let PatKind::TupleStruct(ref path, ref pats, _) = arm.pats[0].node;
589 if pats.len() == 1 && match_qpath(path, &paths::OPTION_SOME);
590 if let PatKind::Binding(rb, _, ident, _) = pats[0].node;
591 if rb == BindingAnnotation::Ref || rb == BindingAnnotation::RefMut;
592 if let ExprKind::Call(ref e, ref args) = remove_blocks(&arm.body).node;
593 if let ExprKind::Path(ref some_path) = e.node;
594 if match_qpath(some_path, &paths::OPTION_SOME) && args.len() == 1;
595 if let ExprKind::Path(ref qpath) = args[0].node;
596 if let &QPath::Resolved(_, ref path2) = qpath;
597 if path2.segments.len() == 1 && ident.name == path2.segments[0].ident.name;
605 fn has_only_ref_pats(arms: &[Arm]) -> bool {
606 let mapped = arms.iter()
607 .flat_map(|a| &a.pats)
610 PatKind::Ref(..) => Some(true), // &-patterns
611 PatKind::Wild => Some(false), // an "anything" wildcard is also fine
612 _ => None, // any other pattern is not fine
615 .collect::<Option<Vec<bool>>>();
616 // look for Some(v) where there's at least one true element
617 mapped.map_or(false, |v| v.iter().any(|el| *el))
620 pub fn overlapping<T>(ranges: &[SpannedRange<T>]) -> Option<(&SpannedRange<T>, &SpannedRange<T>)>
624 #[derive(Copy, Clone, Debug, Eq, PartialEq)]
625 enum Kind<'a, T: 'a> {
626 Start(T, &'a SpannedRange<T>),
627 End(Bound<T>, &'a SpannedRange<T>),
630 impl<'a, T: Copy> Kind<'a, T> {
631 fn range(&self) -> &'a SpannedRange<T> {
633 Kind::Start(_, r) | Kind::End(_, r) => r,
637 fn value(self) -> Bound<T> {
639 Kind::Start(t, _) => Bound::Included(t),
640 Kind::End(t, _) => t,
645 impl<'a, T: Copy + Ord> PartialOrd for Kind<'a, T> {
646 fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
647 Some(self.cmp(other))
651 impl<'a, T: Copy + Ord> Ord for Kind<'a, T> {
652 fn cmp(&self, other: &Self) -> Ordering {
653 match (self.value(), other.value()) {
654 (Bound::Included(a), Bound::Included(b)) | (Bound::Excluded(a), Bound::Excluded(b)) => a.cmp(&b),
655 // Range patterns cannot be unbounded (yet)
656 (Bound::Unbounded, _) | (_, Bound::Unbounded) => unimplemented!(),
657 (Bound::Included(a), Bound::Excluded(b)) => match a.cmp(&b) {
658 Ordering::Equal => Ordering::Greater,
661 (Bound::Excluded(a), Bound::Included(b)) => match a.cmp(&b) {
662 Ordering::Equal => Ordering::Less,
669 let mut values = Vec::with_capacity(2 * ranges.len());
672 values.push(Kind::Start(r.node.0, r));
673 values.push(Kind::End(r.node.1, r));
678 for (a, b) in values.iter().zip(values.iter().skip(1)) {
680 (&Kind::Start(_, ra), &Kind::End(_, rb)) => if ra.node != rb.node {
681 return Some((ra, rb));
683 (&Kind::End(a, _), &Kind::Start(b, _)) if a != Bound::Included(b) => (),
684 _ => return Some((a.range(), b.range())),