src/tools/clippy/clippy_lints/src/option_if_let_else.rs

   1 use crate::utils;
   2 use crate::utils::sugg::Sugg;
   3 use crate::utils::{match_type, paths, span_lint_and_sugg};
   4 use if_chain::if_chain;
   5
   6 use rustc_errors::Applicability;
   7 use rustc_hir::intravisit::{NestedVisitorMap, Visitor};
   8 use rustc_hir::{Arm, BindingAnnotation, Block, Expr, ExprKind, MatchSource, Mutability, PatKind, UnOp};
   9 use rustc_lint::{LateContext, LateLintPass};
  10 use rustc_middle::hir::map::Map;
  11 use rustc_session::{declare_lint_pass, declare_tool_lint};
  12
  13 declare_clippy_lint! {
  14     /// **What it does:**
  15     /// Lints usage of  `if let Some(v) = ... { y } else { x }` which is more
  16     /// idiomatically done with `Option::map_or` (if the else bit is a simple
  17     /// expression) or `Option::map_or_else` (if the else bit is a longer
  18     /// block).
  19     ///
  20     /// **Why is this bad?**
  21     /// Using the dedicated functions of the Option type is clearer and
  22     /// more concise than an if let expression.
  23     ///
  24     /// **Known problems:**
  25     /// This lint uses whether the block is just an expression or if it has
  26     /// more statements to decide whether to use `Option::map_or` or
  27     /// `Option::map_or_else`. If you have a single expression which calls
  28     /// an expensive function, then it would be more efficient to use
  29     /// `Option::map_or_else`, but this lint would suggest `Option::map_or`.
  30     ///
  31     /// Also, this lint uses a deliberately conservative metric for checking
  32     /// if the inside of either body contains breaks or continues which will
  33     /// cause it to not suggest a fix if either block contains a loop with
  34     /// continues or breaks contained within the loop.
  35     ///
  36     /// **Example:**
  37     ///
  38     /// ```rust
  39     /// # let optional: Option<u32> = Some(0);
  40     /// # fn do_complicated_function() -> u32 { 5 };
  41     /// let _ = if let Some(foo) = optional {
  42     ///     foo
  43     /// } else {
  44     ///     5
  45     /// };
  46     /// let _ = if let Some(foo) = optional {
  47     ///     foo
  48     /// } else {
  49     ///     let y = do_complicated_function();
  50     ///     y*y
  51     /// };
  52     /// ```
  53     ///
  54     /// should be
  55     ///
  56     /// ```rust
  57     /// # let optional: Option<u32> = Some(0);
  58     /// # fn do_complicated_function() -> u32 { 5 };
  59     /// let _ = optional.map_or(5, |foo| foo);
  60     /// let _ = optional.map_or_else(||{
  61     ///     let y = do_complicated_function();
  62     ///     y*y
  63     /// }, |foo| foo);
  64     /// ```
  65     pub OPTION_IF_LET_ELSE,
  66     pedantic,
  67     "reimplementation of Option::map_or"
  68 }
  69
  70 declare_lint_pass!(OptionIfLetElse => [OPTION_IF_LET_ELSE]);
  71
  72 /// Returns true iff the given expression is the result of calling `Result::ok`
  73 fn is_result_ok(cx: &LateContext<'_>, expr: &'_ Expr<'_>) -> bool {
  74     if let ExprKind::MethodCall(ref path, _, &[ref receiver], _) = &expr.kind {
  75         path.ident.name.to_ident_string() == "ok"
  76             && match_type(cx, &cx.typeck_results().expr_ty(&receiver), &paths::RESULT)
  77     } else {
  78         false
  79     }
  80 }
  81
  82 /// A struct containing information about occurences of the
  83 /// `if let Some(..) = .. else` construct that this lint detects.
  84 struct OptionIfLetElseOccurence {
  85     option: String,
  86     method_sugg: String,
  87     some_expr: String,
  88     none_expr: String,
  89     wrap_braces: bool,
  90 }
  91
  92 struct ReturnBreakContinueMacroVisitor {
  93     seen_return_break_continue: bool,
  94 }
  95 impl ReturnBreakContinueMacroVisitor {
  96     fn new() -> ReturnBreakContinueMacroVisitor {
  97         ReturnBreakContinueMacroVisitor {
  98             seen_return_break_continue: false,
  99         }
 100     }
 101 }
 102 impl<'tcx> Visitor<'tcx> for ReturnBreakContinueMacroVisitor {
 103     type Map = Map<'tcx>;
 104     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
 105         NestedVisitorMap::None
 106     }
 107
 108     fn visit_expr(&mut self, ex: &'tcx Expr<'tcx>) {
 109         if self.seen_return_break_continue {
 110             // No need to look farther if we've already seen one of them
 111             return;
 112         }
 113         match &ex.kind {
 114             ExprKind::Ret(..) | ExprKind::Break(..) | ExprKind::Continue(..) => {
 115                 self.seen_return_break_continue = true;
 116             },
 117             // Something special could be done here to handle while or for loop
 118             // desugaring, as this will detect a break if there's a while loop
 119             // or a for loop inside the expression.
 120             _ => {
 121                 if utils::in_macro(ex.span) {
 122                     self.seen_return_break_continue = true;
 123                 } else {
 124                     rustc_hir::intravisit::walk_expr(self, ex);
 125                 }
 126             },
 127         }
 128     }
 129 }
 130
 131 fn contains_return_break_continue_macro(expression: &Expr<'_>) -> bool {
 132     let mut recursive_visitor = ReturnBreakContinueMacroVisitor::new();
 133     recursive_visitor.visit_expr(expression);
 134     recursive_visitor.seen_return_break_continue
 135 }
 136
 137 /// Extracts the body of a given arm. If the arm contains only an expression,
 138 /// then it returns the expression. Otherwise, it returns the entire block
 139 fn extract_body_from_arm<'a>(arm: &'a Arm<'a>) -> Option<&'a Expr<'a>> {
 140     if let ExprKind::Block(
 141         Block {
 142             stmts: statements,
 143             expr: Some(expr),
 144             ..
 145         },
 146         _,
 147     ) = &arm.body.kind
 148     {
 149         if let [] = statements {
 150             Some(&expr)
 151         } else {
 152             Some(&arm.body)
 153         }
 154     } else {
 155         None
 156     }
 157 }
 158
 159 /// If this is the else body of an if/else expression, then we need to wrap
 160 /// it in curcly braces. Otherwise, we don't.
 161 fn should_wrap_in_braces(cx: &LateContext<'_>, expr: &Expr<'_>) -> bool {
 162     utils::get_enclosing_block(cx, expr.hir_id).map_or(false, |parent| {
 163         if let Some(Expr {
 164             kind:
 165                 ExprKind::Match(
 166                     _,
 167                     arms,
 168                     MatchSource::IfDesugar {
 169                         contains_else_clause: true,
 170                     }
 171                     | MatchSource::IfLetDesugar {
 172                         contains_else_clause: true,
 173                     },
 174                 ),
 175             ..
 176         }) = parent.expr
 177         {
 178             expr.hir_id == arms[1].body.hir_id
 179         } else {
 180             false
 181         }
 182     })
 183 }
 184
 185 fn format_option_in_sugg(cx: &LateContext<'_>, cond_expr: &Expr<'_>, as_ref: bool, as_mut: bool) -> String {
 186     format!(
 187         "{}{}",
 188         Sugg::hir(cx, cond_expr, "..").maybe_par(),
 189         if as_mut {
 190             ".as_mut()"
 191         } else if as_ref {
 192             ".as_ref()"
 193         } else {
 194             ""
 195         }
 196     )
 197 }
 198
 199 /// If this expression is the option if let/else construct we're detecting, then
 200 /// this function returns an `OptionIfLetElseOccurence` struct with details if
 201 /// this construct is found, or None if this construct is not found.
 202 fn detect_option_if_let_else(cx: &LateContext<'_>, expr: &Expr<'_>) -> Option<OptionIfLetElseOccurence> {
 203     if_chain! {
 204         if !utils::in_macro(expr.span); // Don't lint macros, because it behaves weirdly
 205         if let ExprKind::Match(cond_expr, arms, MatchSource::IfLetDesugar{contains_else_clause: true}) = &expr.kind;
 206         if arms.len() == 2;
 207         if !is_result_ok(cx, cond_expr); // Don't lint on Result::ok because a different lint does it already
 208         if let PatKind::TupleStruct(struct_qpath, &[inner_pat], _) = &arms[0].pat.kind;
 209         if utils::match_qpath(struct_qpath, &paths::OPTION_SOME);
 210         if let PatKind::Binding(bind_annotation, _, id, _) = &inner_pat.kind;
 211         if !contains_return_break_continue_macro(arms[0].body);
 212         if !contains_return_break_continue_macro(arms[1].body);
 213         then {
 214             let capture_mut = if bind_annotation == &BindingAnnotation::Mutable { "mut " } else { "" };
 215             let some_body = extract_body_from_arm(&arms[0])?;
 216             let none_body = extract_body_from_arm(&arms[1])?;
 217             let method_sugg = match &none_body.kind {
 218                 ExprKind::Block(..) => "map_or_else",
 219                 _ => "map_or",
 220             };
 221             let capture_name = id.name.to_ident_string();
 222             let wrap_braces = should_wrap_in_braces(cx, expr);
 223             let (as_ref, as_mut) = match &cond_expr.kind {
 224                 ExprKind::AddrOf(_, Mutability::Not, _) => (true, false),
 225                 ExprKind::AddrOf(_, Mutability::Mut, _) => (false, true),
 226                 _ => (bind_annotation == &BindingAnnotation::Ref, bind_annotation == &BindingAnnotation::RefMut),
 227             };
 228             let cond_expr = match &cond_expr.kind {
 229                 // Pointer dereferencing happens automatically, so we can omit it in the suggestion
 230                 ExprKind::Unary(UnOp::UnDeref, expr) | ExprKind::AddrOf(_, _, expr) => expr,
 231                 _ => cond_expr,
 232             };
 233             Some(OptionIfLetElseOccurence {
 234                 option: format_option_in_sugg(cx, cond_expr, as_ref, as_mut),
 235                 method_sugg: method_sugg.to_string(),
 236                 some_expr: format!("|{}{}| {}", capture_mut, capture_name, Sugg::hir(cx, some_body, "..")),
 237                 none_expr: format!("{}{}", if method_sugg == "map_or" { "" } else { "|| " }, Sugg::hir(cx, none_body, "..")),
 238                 wrap_braces,
 239             })
 240         } else {
 241             None
 242         }
 243     }
 244 }
 245
 246 impl<'a> LateLintPass<'a> for OptionIfLetElse {
 247     fn check_expr(&mut self, cx: &LateContext<'a>, expr: &Expr<'_>) {
 248         if let Some(detection) = detect_option_if_let_else(cx, expr) {
 249             span_lint_and_sugg(
 250                 cx,
 251                 OPTION_IF_LET_ELSE,
 252                 expr.span,
 253                 format!("use Option::{} instead of an if let/else", detection.method_sugg).as_str(),
 254                 "try",
 255                 format!(
 256                     "{}{}.{}({}, {}){}",
 257                     if detection.wrap_braces { "{ " } else { "" },
 258                     detection.option,
 259                     detection.method_sugg,
 260                     detection.none_expr,
 261                     detection.some_expr,
 262                     if detection.wrap_braces { " }" } else { "" },
 263                 ),
 264                 Applicability::MaybeIncorrect,
 265             );
 266         }
 267     }
 268 }