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, get_enclosing_block, 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     ///
  33     /// ```rust
  34     /// # let optional: Option<u32> = Some(0);
  35     /// # fn do_complicated_function() -> u32 { 5 };
  36     /// let _ = if let Some(foo) = optional {
  37     ///     foo
  38     /// } else {
  39     ///     5
  40     /// };
  41     /// let _ = if let Some(foo) = optional {
  42     ///     foo
  43     /// } else {
  44     ///     let y = do_complicated_function();
  45     ///     y*y
  46     /// };
  47     /// ```
  48     ///
  49     /// should be
  50     ///
  51     /// ```rust
  52     /// # let optional: Option<u32> = Some(0);
  53     /// # fn do_complicated_function() -> u32 { 5 };
  54     /// let _ = optional.map_or(5, |foo| foo);
  55     /// let _ = optional.map_or_else(||{
  56     ///     let y = do_complicated_function();
  57     ///     y*y
  58     /// }, |foo| foo);
  59     /// ```
  60     pub OPTION_IF_LET_ELSE,
  61     pedantic,
  62     "reimplementation of Option::map_or"
  63 }
  64
  65 declare_lint_pass!(OptionIfLetElse => [OPTION_IF_LET_ELSE]);
  66
  67 /// Returns true iff the given expression is the result of calling `Result::ok`
  68 fn is_result_ok(cx: &LateContext<'_>, expr: &'_ Expr<'_>) -> bool {
  69     if let ExprKind::MethodCall(path, _, &[ref receiver], _) = &expr.kind {
  70         path.ident.name.as_str() == "ok"
  71             && is_type_diagnostic_item(cx, cx.typeck_results().expr_ty(receiver), sym::result_type)
  72     } else {
  73         false
  74     }
  75 }
  76
  77 /// A struct containing information about occurrences of the
  78 /// `if let Some(..) = .. else` construct that this lint detects.
  79 struct OptionIfLetElseOccurence {
  80     option: String,
  81     method_sugg: String,
  82     some_expr: String,
  83     none_expr: String,
  84     wrap_braces: bool,
  85 }
  86
  87 /// Extracts the body of a given arm. If the arm contains only an expression,
  88 /// then it returns the expression. Otherwise, it returns the entire block
  89 fn extract_body_from_arm<'a>(arm: &'a Arm<'a>) -> Option<&'a Expr<'a>> {
  90     if let ExprKind::Block(
  91         Block {
  92             stmts: statements,
  93             expr: Some(expr),
  94             ..
  95         },
  96         _,
  97     ) = &arm.body.kind
  98     {
  99         if let [] = statements {
 100             Some(expr)
 101         } else {
 102             Some(arm.body)
 103         }
 104     } else {
 105         None
 106     }
 107 }
 108
 109 /// If this is the else body of an if/else expression, then we need to wrap
 110 /// it in curly braces. Otherwise, we don't.
 111 fn should_wrap_in_braces(cx: &LateContext<'_>, expr: &Expr<'_>) -> bool {
 112     get_enclosing_block(cx, expr.hir_id).map_or(false, |parent| {
 113         let mut should_wrap = false;
 114
 115         if let Some(Expr {
 116             kind:
 117                 ExprKind::Match(
 118                     _,
 119                     arms,
 120                     MatchSource::IfLetDesugar {
 121                         contains_else_clause: true,
 122                     },
 123                 ),
 124             ..
 125         }) = parent.expr
 126         {
 127             should_wrap = expr.hir_id == arms[1].body.hir_id;
 128         } else if let Some(Expr {
 129             kind: ExprKind::If(_, _, Some(else_clause)),
 130             ..
 131         }) = parent.expr
 132         {
 133             should_wrap = expr.hir_id == else_clause.hir_id;
 134         }
 135
 136         should_wrap
 137     })
 138 }
 139
 140 fn format_option_in_sugg(cx: &LateContext<'_>, cond_expr: &Expr<'_>, as_ref: bool, as_mut: bool) -> String {
 141     format!(
 142         "{}{}",
 143         Sugg::hir(cx, cond_expr, "..").maybe_par(),
 144         if as_mut {
 145             ".as_mut()"
 146         } else if as_ref {
 147             ".as_ref()"
 148         } else {
 149             ""
 150         }
 151     )
 152 }
 153
 154 /// If this expression is the option if let/else construct we're detecting, then
 155 /// this function returns an `OptionIfLetElseOccurence` struct with details if
 156 /// this construct is found, or None if this construct is not found.
 157 fn detect_option_if_let_else<'tcx>(
 158     cx: &'_ LateContext<'tcx>,
 159     expr: &'_ Expr<'tcx>,
 160 ) -> Option<OptionIfLetElseOccurence> {
 161     if_chain! {
 162         if !in_macro(expr.span); // Don't lint macros, because it behaves weirdly
 163         if let ExprKind::Match(cond_expr, arms, MatchSource::IfLetDesugar{contains_else_clause: true}) = &expr.kind;
 164         if !is_else_clause(cx.tcx, expr);
 165         if arms.len() == 2;
 166         if !is_result_ok(cx, cond_expr); // Don't lint on Result::ok because a different lint does it already
 167         if let PatKind::TupleStruct(struct_qpath, &[inner_pat], _) = &arms[0].pat.kind;
 168         if is_lang_ctor(cx, struct_qpath, OptionSome);
 169         if let PatKind::Binding(bind_annotation, _, id, _) = &inner_pat.kind;
 170         if !contains_return_break_continue_macro(arms[0].body);
 171         if !contains_return_break_continue_macro(arms[1].body);
 172
 173         then {
 174             let capture_mut = if bind_annotation == &BindingAnnotation::Mutable { "mut " } else { "" };
 175             let some_body = extract_body_from_arm(&arms[0])?;
 176             let none_body = extract_body_from_arm(&arms[1])?;
 177             let method_sugg = if eager_or_lazy::is_eagerness_candidate(cx, none_body) { "map_or" } else { "map_or_else" };
 178             let capture_name = id.name.to_ident_string();
 179             let wrap_braces = should_wrap_in_braces(cx, expr);
 180             let (as_ref, as_mut) = match &cond_expr.kind {
 181                 ExprKind::AddrOf(_, Mutability::Not, _) => (true, false),
 182                 ExprKind::AddrOf(_, Mutability::Mut, _) => (false, true),
 183                 _ => (bind_annotation == &BindingAnnotation::Ref, bind_annotation == &BindingAnnotation::RefMut),
 184             };
 185             let cond_expr = match &cond_expr.kind {
 186                 // Pointer dereferencing happens automatically, so we can omit it in the suggestion
 187                 ExprKind::Unary(UnOp::Deref, expr) | ExprKind::AddrOf(_, _, expr) => expr,
 188                 _ => cond_expr,
 189             };
 190             Some(OptionIfLetElseOccurence {
 191                 option: format_option_in_sugg(cx, cond_expr, as_ref, as_mut),
 192                 method_sugg: method_sugg.to_string(),
 193                 some_expr: format!("|{}{}| {}", capture_mut, capture_name, Sugg::hir(cx, some_body, "..")),
 194                 none_expr: format!("{}{}", if method_sugg == "map_or" { "" } else { "|| " }, Sugg::hir(cx, none_body, "..")),
 195                 wrap_braces,
 196             })
 197         } else {
 198             None
 199         }
 200     }
 201 }
 202
 203 impl<'tcx> LateLintPass<'tcx> for OptionIfLetElse {
 204     fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &Expr<'tcx>) {
 205         if let Some(detection) = detect_option_if_let_else(cx, expr) {
 206             span_lint_and_sugg(
 207                 cx,
 208                 OPTION_IF_LET_ELSE,
 209                 expr.span,
 210                 format!("use Option::{} instead of an if let/else", detection.method_sugg).as_str(),
 211                 "try",
 212                 format!(
 213                     "{}{}.{}({}, {}){}",
 214                     if detection.wrap_braces { "{ " } else { "" },
 215                     detection.option,
 216                     detection.method_sugg,
 217                     detection.none_expr,
 218                     detection.some_expr,
 219                     if detection.wrap_braces { " }" } else { "" },
 220                 ),
 221                 Applicability::MaybeIncorrect,
 222             );
 223         }
 224     }
 225 }