clippy_lints/src/option_if_let_else.rs

   1 use crate::utils;
   2 use crate::utils::eager_or_lazy;
   3 use crate::utils::sugg::Sugg;
   4 use crate::utils::{is_type_diagnostic_item, paths, span_lint_and_sugg};
   5 use if_chain::if_chain;
   6
   7 use rustc_errors::Applicability;
   8 use rustc_hir::intravisit::{NestedVisitorMap, Visitor};
   9 use rustc_hir::{Arm, BindingAnnotation, Block, Expr, ExprKind, MatchSource, Mutability, PatKind, UnOp};
  10 use rustc_lint::{LateContext, LateLintPass};
  11 use rustc_middle::hir::map::Map;
  12 use rustc_session::{declare_lint_pass, declare_tool_lint};
  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     /// expresion).
  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(ref path, _, &[ref receiver], _) = &expr.kind {
  70         path.ident.name.to_ident_string() == "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 struct ReturnBreakContinueMacroVisitor {
  88     seen_return_break_continue: bool,
  89 }
  90
  91 impl ReturnBreakContinueMacroVisitor {
  92     fn new() -> ReturnBreakContinueMacroVisitor {
  93         ReturnBreakContinueMacroVisitor {
  94             seen_return_break_continue: false,
  95         }
  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 curly 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<'tcx>(
 200     cx: &'_ LateContext<'tcx>,
 201     expr: &'_ Expr<'tcx>,
 202 ) -> 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 = if eager_or_lazy::is_eagerness_candidate(cx, none_body) { "map_or" } else { "map_or_else" };
 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<'tcx> LateLintPass<'tcx> for OptionIfLetElse {
 244     fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &Expr<'tcx>) {
 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::MaybeIncorrect,
 262             );
 263         }
 264     }
 265 }