clippy_lints/src/option_if_let_else.rs

   1 use clippy_utils::diagnostics::span_lint_and_sugg;
   2 use clippy_utils::sugg::Sugg;
   3 use clippy_utils::ty::is_type_diagnostic_item;
   4 use clippy_utils::usage::contains_return_break_continue_macro;
   5 use clippy_utils::{eager_or_lazy, in_macro, is_else_clause, is_lang_ctor};
   6 use if_chain::if_chain;
   7 use rustc_errors::Applicability;
   8 use rustc_hir::LangItem::OptionSome;
   9 use rustc_hir::{Arm, BindingAnnotation, Block, Expr, ExprKind, MatchSource, Mutability, PatKind, UnOp};
  10 use rustc_lint::{LateContext, LateLintPass};
  11 use rustc_session::{declare_lint_pass, declare_tool_lint};
  12 use rustc_span::sym;
  13
  14 declare_clippy_lint! {
  15     /// ### What it does
  16     /// Lints usage of `if let Some(v) = ... { y } else { x }` which is more
  17     /// idiomatically done with `Option::map_or` (if the else bit is a pure
  18     /// expression) or `Option::map_or_else` (if the else bit is an impure
  19     /// expression).
  20     ///
  21     /// ### Why is this bad?
  22     /// Using the dedicated functions of the Option type is clearer and
  23     /// more concise than an `if let` expression.
  24     ///
  25     /// ### Known problems
  26     /// This lint uses a deliberately conservative metric for checking
  27     /// if the inside of either body contains breaks or continues which will
  28     /// cause it to not suggest a fix if either block contains a loop with
  29     /// continues or breaks contained within the loop.
  30     ///
  31     /// ### Example
  32     /// ```rust
  33     /// # let optional: Option<u32> = Some(0);
  34     /// # fn do_complicated_function() -> u32 { 5 };
  35     /// let _ = if let Some(foo) = optional {
  36     ///     foo
  37     /// } else {
  38     ///     5
  39     /// };
  40     /// let _ = if let Some(foo) = optional {
  41     ///     foo
  42     /// } else {
  43     ///     let y = do_complicated_function();
  44     ///     y*y
  45     /// };
  46     /// ```
  47     ///
  48     /// should be
  49     ///
  50     /// ```rust
  51     /// # let optional: Option<u32> = Some(0);
  52     /// # fn do_complicated_function() -> u32 { 5 };
  53     /// let _ = optional.map_or(5, |foo| foo);
  54     /// let _ = optional.map_or_else(||{
  55     ///     let y = do_complicated_function();
  56     ///     y*y
  57     /// }, |foo| foo);
  58     /// ```
  59     pub OPTION_IF_LET_ELSE,
  60     pedantic,
  61     "reimplementation of Option::map_or"
  62 }
  63
  64 declare_lint_pass!(OptionIfLetElse => [OPTION_IF_LET_ELSE]);
  65
  66 /// Returns true iff the given expression is the result of calling `Result::ok`
  67 fn is_result_ok(cx: &LateContext<'_>, expr: &'_ Expr<'_>) -> bool {
  68     if let ExprKind::MethodCall(path, _, &[ref receiver], _) = &expr.kind {
  69         path.ident.name.as_str() == "ok"
  70             && is_type_diagnostic_item(cx, cx.typeck_results().expr_ty(receiver), sym::result_type)
  71     } else {
  72         false
  73     }
  74 }
  75
  76 /// A struct containing information about occurrences of the
  77 /// `if let Some(..) = .. else` construct that this lint detects.
  78 struct OptionIfLetElseOccurence {
  79     option: String,
  80     method_sugg: String,
  81     some_expr: String,
  82     none_expr: String,
  83 }
  84
  85 /// Extracts the body of a given arm. If the arm contains only an expression,
  86 /// then it returns the expression. Otherwise, it returns the entire block
  87 fn extract_body_from_arm<'a>(arm: &'a Arm<'a>) -> Option<&'a Expr<'a>> {
  88     if let ExprKind::Block(
  89         Block {
  90             stmts: statements,
  91             expr: Some(expr),
  92             ..
  93         },
  94         _,
  95     ) = &arm.body.kind
  96     {
  97         if let [] = statements {
  98             Some(expr)
  99         } else {
 100             Some(arm.body)
 101         }
 102     } else {
 103         None
 104     }
 105 }
 106
 107 fn format_option_in_sugg(cx: &LateContext<'_>, cond_expr: &Expr<'_>, as_ref: bool, as_mut: bool) -> String {
 108     format!(
 109         "{}{}",
 110         Sugg::hir(cx, cond_expr, "..").maybe_par(),
 111         if as_mut {
 112             ".as_mut()"
 113         } else if as_ref {
 114             ".as_ref()"
 115         } else {
 116             ""
 117         }
 118     )
 119 }
 120
 121 /// If this expression is the option if let/else construct we're detecting, then
 122 /// this function returns an `OptionIfLetElseOccurence` struct with details if
 123 /// this construct is found, or None if this construct is not found.
 124 fn detect_option_if_let_else<'tcx>(
 125     cx: &'_ LateContext<'tcx>,
 126     expr: &'_ Expr<'tcx>,
 127 ) -> Option<OptionIfLetElseOccurence> {
 128     if_chain! {
 129         if !in_macro(expr.span); // Don't lint macros, because it behaves weirdly
 130         if let ExprKind::Match(cond_expr, arms, MatchSource::IfLetDesugar{contains_else_clause: true}) = &expr.kind;
 131         if !is_else_clause(cx.tcx, expr);
 132         if arms.len() == 2;
 133         if !is_result_ok(cx, cond_expr); // Don't lint on Result::ok because a different lint does it already
 134         if let PatKind::TupleStruct(struct_qpath, [inner_pat], _) = &arms[0].pat.kind;
 135         if is_lang_ctor(cx, struct_qpath, OptionSome);
 136         if let PatKind::Binding(bind_annotation, _, id, _) = &inner_pat.kind;
 137         if !contains_return_break_continue_macro(arms[0].body);
 138         if !contains_return_break_continue_macro(arms[1].body);
 139
 140         then {
 141             let capture_mut = if bind_annotation == &BindingAnnotation::Mutable { "mut " } else { "" };
 142             let some_body = extract_body_from_arm(&arms[0])?;
 143             let none_body = extract_body_from_arm(&arms[1])?;
 144             let method_sugg = if eager_or_lazy::is_eagerness_candidate(cx, none_body) { "map_or" } else { "map_or_else" };
 145             let capture_name = id.name.to_ident_string();
 146             let (as_ref, as_mut) = match &cond_expr.kind {
 147                 ExprKind::AddrOf(_, Mutability::Not, _) => (true, false),
 148                 ExprKind::AddrOf(_, Mutability::Mut, _) => (false, true),
 149                 _ => (bind_annotation == &BindingAnnotation::Ref, bind_annotation == &BindingAnnotation::RefMut),
 150             };
 151             let cond_expr = match &cond_expr.kind {
 152                 // Pointer dereferencing happens automatically, so we can omit it in the suggestion
 153                 ExprKind::Unary(UnOp::Deref, expr) | ExprKind::AddrOf(_, _, expr) => expr,
 154                 _ => cond_expr,
 155             };
 156             Some(OptionIfLetElseOccurence {
 157                 option: format_option_in_sugg(cx, cond_expr, as_ref, as_mut),
 158                 method_sugg: method_sugg.to_string(),
 159                 some_expr: format!("|{}{}| {}", capture_mut, capture_name, Sugg::hir(cx, some_body, "..")),
 160                 none_expr: format!("{}{}", if method_sugg == "map_or" { "" } else { "|| " }, Sugg::hir(cx, none_body, "..")),
 161             })
 162         } else {
 163             None
 164         }
 165     }
 166 }
 167
 168 impl<'tcx> LateLintPass<'tcx> for OptionIfLetElse {
 169     fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &Expr<'tcx>) {
 170         if let Some(detection) = detect_option_if_let_else(cx, expr) {
 171             span_lint_and_sugg(
 172                 cx,
 173                 OPTION_IF_LET_ELSE,
 174                 expr.span,
 175                 format!("use Option::{} instead of an if let/else", detection.method_sugg).as_str(),
 176                 "try",
 177                 format!(
 178                     "{}.{}({}, {})",
 179                     detection.option, detection.method_sugg, detection.none_expr, detection.some_expr,
 180                 ),
 181                 Applicability::MaybeIncorrect,
 182             );
 183         }
 184     }
 185 }