use crate::utils::{match_qpath, match_trait_method, paths, snippet, span_lint_and_then}; use if_chain::if_chain; use rustc_ast::ast::LitKind; use rustc_errors::Applicability; use rustc_hir::{Arm, Expr, ExprKind, MatchSource, PatKind, QPath}; use rustc_lint::{LateContext, LateLintPass}; use rustc_session::{declare_lint_pass, declare_tool_lint}; declare_clippy_lint! { /// **What it does:** Lint for redundant pattern matching over `Result` or /// `Option` /// /// **Why is this bad?** It's more concise and clear to just use the proper /// utility function /// /// **Known problems:** None. /// /// **Example:** /// /// ```rust /// if let Ok(_) = Ok::(42) {} /// if let Err(_) = Err::(42) {} /// if let None = None::<()> {} /// if let Some(_) = Some(42) {} /// match Ok::(42) { /// Ok(_) => true, /// Err(_) => false, /// }; /// ``` /// /// The more idiomatic use would be: /// /// ```rust /// if Ok::(42).is_ok() {} /// if Err::(42).is_err() {} /// if None::<()>.is_none() {} /// if Some(42).is_some() {} /// Ok::(42).is_ok(); /// ``` pub REDUNDANT_PATTERN_MATCHING, style, "use the proper utility function avoiding an `if let`" } declare_lint_pass!(RedundantPatternMatching => [REDUNDANT_PATTERN_MATCHING]); impl<'a, 'tcx> LateLintPass<'a, 'tcx> for RedundantPatternMatching { fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr<'_>) { if let ExprKind::Match(op, arms, ref match_source) = &expr.kind { match match_source { MatchSource::Normal => find_sugg_for_match(cx, expr, op, arms), MatchSource::IfLetDesugar { .. } => find_sugg_for_if_let(cx, expr, op, arms, "if"), MatchSource::WhileLetDesugar => find_sugg_for_if_let(cx, expr, op, arms, "while"), _ => return, } } } } fn find_sugg_for_if_let<'a, 'tcx>( cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr<'_>, op: &Expr<'_>, arms: &[Arm<'_>], keyword: &'static str, ) { let good_method = match arms[0].pat.kind { PatKind::TupleStruct(ref path, ref patterns, _) if patterns.len() == 1 => { if let PatKind::Wild = patterns[0].kind { if match_qpath(path, &paths::RESULT_OK) { "is_ok()" } else if match_qpath(path, &paths::RESULT_ERR) { "is_err()" } else if match_qpath(path, &paths::OPTION_SOME) { "is_some()" } else { return; } } else { return; } }, PatKind::Path(ref path) if match_qpath(path, &paths::OPTION_NONE) => "is_none()", _ => return, }; // check that `while_let_on_iterator` lint does not trigger if_chain! { if keyword == "while"; if let ExprKind::MethodCall(method_path, _, _) = op.kind; if method_path.ident.name == sym!(next); if match_trait_method(cx, op, &paths::ITERATOR); then { return; } } span_lint_and_then( cx, REDUNDANT_PATTERN_MATCHING, arms[0].pat.span, &format!("redundant pattern matching, consider using `{}`", good_method), |diag| { // while let ... = ... { ... } // ^^^^^^^^^^^^^^^^^^^^^^^^^^^ let expr_span = expr.span; // while let ... = ... { ... } // ^^^ let op_span = op.span.source_callsite(); // while let ... = ... { ... } // ^^^^^^^^^^^^^^^^^^^ let span = expr_span.until(op_span.shrink_to_hi()); diag.span_suggestion( span, "try this", format!("{} {}.{}", keyword, snippet(cx, op_span, "_"), good_method), Applicability::MachineApplicable, // snippet ); }, ); } fn find_sugg_for_match<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr<'_>, op: &Expr<'_>, arms: &[Arm<'_>]) { if arms.len() == 2 { let node_pair = (&arms[0].pat.kind, &arms[1].pat.kind); let found_good_method = match node_pair { ( PatKind::TupleStruct(ref path_left, ref patterns_left, _), PatKind::TupleStruct(ref path_right, ref patterns_right, _), ) if patterns_left.len() == 1 && patterns_right.len() == 1 => { if let (PatKind::Wild, PatKind::Wild) = (&patterns_left[0].kind, &patterns_right[0].kind) { find_good_method_for_match( arms, path_left, path_right, &paths::RESULT_OK, &paths::RESULT_ERR, "is_ok()", "is_err()", ) } else { None } }, (PatKind::TupleStruct(ref path_left, ref patterns, _), PatKind::Path(ref path_right)) | (PatKind::Path(ref path_left), PatKind::TupleStruct(ref path_right, ref patterns, _)) if patterns.len() == 1 => { if let PatKind::Wild = patterns[0].kind { find_good_method_for_match( arms, path_left, path_right, &paths::OPTION_SOME, &paths::OPTION_NONE, "is_some()", "is_none()", ) } else { None } }, _ => None, }; if let Some(good_method) = found_good_method { span_lint_and_then( cx, REDUNDANT_PATTERN_MATCHING, expr.span, &format!("redundant pattern matching, consider using `{}`", good_method), |diag| { let span = expr.span.to(op.span); diag.span_suggestion( span, "try this", format!("{}.{}", snippet(cx, op.span, "_"), good_method), Applicability::MaybeIncorrect, // snippet ); }, ); } } } fn find_good_method_for_match<'a>( arms: &[Arm<'_>], path_left: &QPath<'_>, path_right: &QPath<'_>, expected_left: &[&str], expected_right: &[&str], should_be_left: &'a str, should_be_right: &'a str, ) -> Option<&'a str> { let body_node_pair = if match_qpath(path_left, expected_left) && match_qpath(path_right, expected_right) { (&(*arms[0].body).kind, &(*arms[1].body).kind) } else if match_qpath(path_right, expected_left) && match_qpath(path_left, expected_right) { (&(*arms[1].body).kind, &(*arms[0].body).kind) } else { return None; }; match body_node_pair { (ExprKind::Lit(ref lit_left), ExprKind::Lit(ref lit_right)) => match (&lit_left.node, &lit_right.node) { (LitKind::Bool(true), LitKind::Bool(false)) => Some(should_be_left), (LitKind::Bool(false), LitKind::Bool(true)) => Some(should_be_right), _ => None, }, _ => None, } }