clippy_lints/src/implicit_return.rs

   1 use clippy_utils::{
   2     diagnostics::span_lint_and_sugg,
   3     get_async_fn_body, is_async_fn,
   4     source::{snippet_with_applicability, snippet_with_context, walk_span_to_context},
   5     visitors::visit_break_exprs,
   6 };
   7 use rustc_errors::Applicability;
   8 use rustc_hir::intravisit::FnKind;
   9 use rustc_hir::{Block, Body, Expr, ExprKind, FnDecl, FnRetTy, HirId};
  10 use rustc_lint::{LateContext, LateLintPass, LintContext};
  11 use rustc_middle::lint::in_external_macro;
  12 use rustc_session::{declare_lint_pass, declare_tool_lint};
  13 use rustc_span::{Span, SyntaxContext};
  14
  15 declare_clippy_lint! {
  16     /// **What it does:** Checks for missing return statements at the end of a block.
  17     ///
  18     /// **Why is this bad?** Actually omitting the return keyword is idiomatic Rust code. Programmers
  19     /// coming from other languages might prefer the expressiveness of `return`. It's possible to miss
  20     /// the last returning statement because the only difference is a missing `;`. Especially in bigger
  21     /// code with multiple return paths having a `return` keyword makes it easier to find the
  22     /// corresponding statements.
  23     ///
  24     /// **Known problems:** None.
  25     ///
  26     /// **Example:**
  27     /// ```rust
  28     /// fn foo(x: usize) -> usize {
  29     ///     x
  30     /// }
  31     /// ```
  32     /// add return
  33     /// ```rust
  34     /// fn foo(x: usize) -> usize {
  35     ///     return x;
  36     /// }
  37     /// ```
  38     pub IMPLICIT_RETURN,
  39     restriction,
  40     "use a return statement like `return expr` instead of an expression"
  41 }
  42
  43 declare_lint_pass!(ImplicitReturn => [IMPLICIT_RETURN]);
  44
  45 fn lint_return(cx: &LateContext<'_>, span: Span) {
  46     let mut app = Applicability::MachineApplicable;
  47     let snip = snippet_with_applicability(cx, span, "..", &mut app);
  48     span_lint_and_sugg(
  49         cx,
  50         IMPLICIT_RETURN,
  51         span,
  52         "missing `return` statement",
  53         "add `return` as shown",
  54         format!("return {}", snip),
  55         app,
  56     );
  57 }
  58
  59 fn lint_break(cx: &LateContext<'_>, break_span: Span, expr_span: Span) {
  60     let mut app = Applicability::MachineApplicable;
  61     let snip = snippet_with_context(cx, expr_span, break_span.ctxt(), "..", &mut app).0;
  62     span_lint_and_sugg(
  63         cx,
  64         IMPLICIT_RETURN,
  65         break_span,
  66         "missing `return` statement",
  67         "change `break` to `return` as shown",
  68         format!("return {}", snip),
  69         app,
  70     )
  71 }
  72
  73 #[derive(Clone, Copy, PartialEq, Eq)]
  74 enum LintLocation {
  75     /// The lint was applied to a parent expression.
  76     Parent,
  77     /// The lint was applied to this expression, a child, or not applied.
  78     Inner,
  79 }
  80 impl LintLocation {
  81     fn still_parent(self, b: bool) -> Self {
  82         if b { self } else { Self::Inner }
  83     }
  84
  85     fn is_parent(self) -> bool {
  86         self == Self::Parent
  87     }
  88 }
  89
  90 // Gets the call site if the span is in a child context. Otherwise returns `None`.
  91 fn get_call_site(span: Span, ctxt: SyntaxContext) -> Option<Span> {
  92     (span.ctxt() != ctxt).then(|| walk_span_to_context(span, ctxt).unwrap_or(span))
  93 }
  94
  95 fn lint_implicit_returns(
  96     cx: &LateContext<'tcx>,
  97     expr: &'tcx Expr<'_>,
  98     // The context of the function body.
  99     ctxt: SyntaxContext,
 100     // Whether the expression is from a macro expansion.
 101     call_site_span: Option<Span>,
 102 ) -> LintLocation {
 103     match expr.kind {
 104         ExprKind::Block(
 105             Block {
 106                 expr: Some(block_expr), ..
 107             },
 108             _,
 109         ) => lint_implicit_returns(
 110             cx,
 111             block_expr,
 112             ctxt,
 113             call_site_span.or_else(|| get_call_site(block_expr.span, ctxt)),
 114         )
 115         .still_parent(call_site_span.is_some()),
 116
 117         ExprKind::If(_, then_expr, Some(else_expr)) => {
 118             // Both `then_expr` or `else_expr` are required to be blocks in the same context as the `if`. Don't
 119             // bother checking.
 120             let res = lint_implicit_returns(cx, then_expr, ctxt, call_site_span).still_parent(call_site_span.is_some());
 121             if res.is_parent() {
 122                 // The return was added as a parent of this if expression.
 123                 return res;
 124             }
 125             lint_implicit_returns(cx, else_expr, ctxt, call_site_span).still_parent(call_site_span.is_some())
 126         },
 127
 128         ExprKind::Match(_, arms, _) => {
 129             for arm in arms {
 130                 let res = lint_implicit_returns(
 131                     cx,
 132                     arm.body,
 133                     ctxt,
 134                     call_site_span.or_else(|| get_call_site(arm.body.span, ctxt)),
 135                 )
 136                 .still_parent(call_site_span.is_some());
 137                 if res.is_parent() {
 138                     // The return was added as a parent of this match expression.
 139                     return res;
 140                 }
 141             }
 142             LintLocation::Inner
 143         },
 144
 145         ExprKind::Loop(block, ..) => {
 146             let mut add_return = false;
 147             visit_break_exprs(block, |break_expr, dest, sub_expr| {
 148                 if dest.target_id.ok() == Some(expr.hir_id) {
 149                     if call_site_span.is_none() && break_expr.span.ctxt() == ctxt {
 150                         lint_break(cx, break_expr.span, sub_expr.unwrap().span);
 151                     } else {
 152                         // the break expression is from a macro call, add a return to the loop
 153                         add_return = true;
 154                     }
 155                 }
 156             });
 157             if add_return {
 158                 #[allow(clippy::option_if_let_else)]
 159                 if let Some(span) = call_site_span {
 160                     lint_return(cx, span);
 161                     LintLocation::Parent
 162                 } else {
 163                     lint_return(cx, expr.span);
 164                     LintLocation::Inner
 165                 }
 166             } else {
 167                 LintLocation::Inner
 168             }
 169         },
 170
 171         // If expressions without an else clause, and blocks without a final expression can only be the final expression
 172         // if they are divergent, or return the unit type.
 173         ExprKind::If(_, _, None) | ExprKind::Block(Block { expr: None, .. }, _) | ExprKind::Ret(_) => {
 174             LintLocation::Inner
 175         },
 176
 177         // Any divergent expression doesn't need a return statement.
 178         ExprKind::MethodCall(..)
 179         | ExprKind::Call(..)
 180         | ExprKind::Binary(..)
 181         | ExprKind::Unary(..)
 182         | ExprKind::Index(..)
 183             if cx.typeck_results().expr_ty(expr).is_never() =>
 184         {
 185             LintLocation::Inner
 186         },
 187
 188         _ =>
 189         {
 190             #[allow(clippy::option_if_let_else)]
 191             if let Some(span) = call_site_span {
 192                 lint_return(cx, span);
 193                 LintLocation::Parent
 194             } else {
 195                 lint_return(cx, expr.span);
 196                 LintLocation::Inner
 197             }
 198         },
 199     }
 200 }
 201
 202 impl<'tcx> LateLintPass<'tcx> for ImplicitReturn {
 203     fn check_fn(
 204         &mut self,
 205         cx: &LateContext<'tcx>,
 206         kind: FnKind<'tcx>,
 207         decl: &'tcx FnDecl<'_>,
 208         body: &'tcx Body<'_>,
 209         span: Span,
 210         _: HirId,
 211     ) {
 212         if (!matches!(kind, FnKind::Closure) && matches!(decl.output, FnRetTy::DefaultReturn(_)))
 213             || span.ctxt() != body.value.span.ctxt()
 214             || in_external_macro(cx.sess(), span)
 215         {
 216             return;
 217         }
 218
 219         let res_ty = cx.typeck_results().expr_ty(&body.value);
 220         if res_ty.is_unit() || res_ty.is_never() {
 221             return;
 222         }
 223
 224         let expr = if is_async_fn(kind) {
 225             match get_async_fn_body(cx.tcx, body) {
 226                 Some(e) => e,
 227                 None => return,
 228             }
 229         } else {
 230             &body.value
 231         };
 232         lint_implicit_returns(cx, expr, expr.span.ctxt(), None);
 233     }
 234 }