1 use clippy_utils::diagnostics::span_lint_and_sugg;
2 use clippy_utils::higher;
3 use clippy_utils::sugg::Sugg;
4 use clippy_utils::ty::is_type_diagnostic_item;
5 use clippy_utils::usage::contains_return_break_continue_macro;
6 use clippy_utils::{eager_or_lazy, in_macro, is_else_clause, is_lang_ctor};
7 use if_chain::if_chain;
8 use rustc_errors::Applicability;
9 use rustc_hir::LangItem::OptionSome;
10 use rustc_hir::{BindingAnnotation, Block, Expr, ExprKind, Mutability, PatKind, UnOp};
11 use rustc_lint::{LateContext, LateLintPass};
12 use rustc_session::{declare_lint_pass, declare_tool_lint};
15 declare_clippy_lint! {
17 /// Lints usage of `if let Some(v) = ... { y } else { x }` which is more
18 /// idiomatically done with `Option::map_or` (if the else bit is a pure
19 /// expression) or `Option::map_or_else` (if the else bit is an impure
22 /// ### Why is this bad?
23 /// Using the dedicated functions of the Option type is clearer and
24 /// more concise than an `if let` expression.
26 /// ### Known problems
27 /// This lint uses a deliberately conservative metric for checking
28 /// if the inside of either body contains breaks or continues which will
29 /// cause it to not suggest a fix if either block contains a loop with
30 /// continues or breaks contained within the loop.
34 /// # let optional: Option<u32> = Some(0);
35 /// # fn do_complicated_function() -> u32 { 5 };
36 /// let _ = if let Some(foo) = optional {
41 /// let _ = if let Some(foo) = optional {
44 /// let y = do_complicated_function();
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();
60 pub OPTION_IF_LET_ELSE,
62 "reimplementation of Option::map_or"
65 declare_lint_pass!(OptionIfLetElse => [OPTION_IF_LET_ELSE]);
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)
77 /// A struct containing information about occurrences of the
78 /// `if let Some(..) = .. else` construct that this lint detects.
79 struct OptionIfLetElseOccurence {
86 /// Extracts the body of a given arm. If the arm contains only an expression,
87 /// then it returns the expression. Otherwise, it returns the entire block
88 fn extract_body_from_expr<'a>(expr: &'a Expr<'a>) -> Option<&'a Expr<'a>> {
89 if let ExprKind::Block(
92 expr: Some(block_expr),
98 if let [] = block_stmts {
108 fn format_option_in_sugg(cx: &LateContext<'_>, cond_expr: &Expr<'_>, as_ref: bool, as_mut: bool) -> String {
111 Sugg::hir(cx, cond_expr, "..").maybe_par(),
122 /// If this expression is the option if let/else construct we're detecting, then
123 /// this function returns an `OptionIfLetElseOccurence` struct with details if
124 /// this construct is found, or None if this construct is not found.
125 fn detect_option_if_let_else<'tcx>(cx: &LateContext<'tcx>, expr: &Expr<'tcx>) -> Option<OptionIfLetElseOccurence> {
127 if !in_macro(expr.span); // Don't lint macros, because it behaves weirdly
128 if let Some(higher::IfLet { let_pat, let_expr, if_then, if_else: Some(if_else) }) = higher::IfLet::hir(expr);
129 if !is_else_clause(cx.tcx, expr);
130 if !is_result_ok(cx, let_expr); // Don't lint on Result::ok because a different lint does it already
131 if let PatKind::TupleStruct(struct_qpath, [inner_pat], _) = &let_pat.kind;
132 if is_lang_ctor(cx, struct_qpath, OptionSome);
133 if let PatKind::Binding(bind_annotation, _, id, _) = &inner_pat.kind;
134 if !contains_return_break_continue_macro(if_then);
135 if !contains_return_break_continue_macro(if_else);
138 let capture_mut = if bind_annotation == &BindingAnnotation::Mutable { "mut " } else { "" };
139 let some_body = extract_body_from_expr(if_then)?;
140 let none_body = extract_body_from_expr(if_else)?;
141 let method_sugg = if eager_or_lazy::is_eagerness_candidate(cx, none_body) { "map_or" } else { "map_or_else" };
142 let capture_name = id.name.to_ident_string();
143 let (as_ref, as_mut) = match &let_expr.kind {
144 ExprKind::AddrOf(_, Mutability::Not, _) => (true, false),
145 ExprKind::AddrOf(_, Mutability::Mut, _) => (false, true),
146 _ => (bind_annotation == &BindingAnnotation::Ref, bind_annotation == &BindingAnnotation::RefMut),
148 let cond_expr = match let_expr.kind {
149 // Pointer dereferencing happens automatically, so we can omit it in the suggestion
150 ExprKind::Unary(UnOp::Deref, expr) | ExprKind::AddrOf(_, _, expr) => expr,
153 Some(OptionIfLetElseOccurence {
154 option: format_option_in_sugg(cx, cond_expr, as_ref, as_mut),
155 method_sugg: method_sugg.to_string(),
156 some_expr: format!("|{}{}| {}", capture_mut, capture_name, Sugg::hir(cx, some_body, "..")),
157 none_expr: format!("{}{}", if method_sugg == "map_or" { "" } else { "|| " }, Sugg::hir(cx, none_body, "..")),
165 impl<'tcx> LateLintPass<'tcx> for OptionIfLetElse {
166 fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &Expr<'tcx>) {
167 if let Some(detection) = detect_option_if_let_else(cx, expr) {
172 format!("use Option::{} instead of an if let/else", detection.method_sugg).as_str(),
176 detection.option, detection.method_sugg, detection.none_expr, detection.some_expr,
178 Applicability::MaybeIncorrect,