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