clippy_lints/src/returns.rs

   1 use rustc::lint::*;
   2 use syntax::ast;
   3 use syntax::codemap::{Span, Spanned};
   4 use syntax::visit::FnKind;
   5
   6 use utils::{span_note_and_lint, span_lint_and_then, snippet_opt, match_path_ast, in_external_macro};
   7
   8 /// **What it does:** Checks for return statements at the end of a block.
   9 ///
  10 /// **Why is this bad?** Removing the `return` and semicolon will make the code
  11 /// more rusty.
  12 ///
  13 /// **Known problems:** None.
  14 ///
  15 /// **Example:**
  16 /// ```rust
  17 /// fn foo(x: usize) { return x; }
  18 /// ```
  19 declare_lint! {
  20     pub NEEDLESS_RETURN,
  21     Warn,
  22     "using a return statement like `return expr;` where an expression would suffice"
  23 }
  24
  25 /// **What it does:** Checks for `let`-bindings, which are subsequently returned.
  26 ///
  27 /// **Why is this bad?** It is just extraneous code. Remove it to make your code
  28 /// more rusty.
  29 ///
  30 /// **Known problems:** None.
  31 ///
  32 /// **Example:**
  33 /// ```rust
  34 /// { let x = ..; x }
  35 /// ```
  36 declare_lint! {
  37     pub LET_AND_RETURN,
  38     Warn,
  39     "creating a let-binding and then immediately returning it like `let x = expr; x` at \
  40      the end of a block"
  41 }
  42
  43 #[derive(Copy, Clone)]
  44 pub struct ReturnPass;
  45
  46 impl ReturnPass {
  47     // Check the final stmt or expr in a block for unnecessary return.
  48     fn check_block_return(&mut self, cx: &EarlyContext, block: &ast::Block) {
  49         if let Some(stmt) = block.stmts.last() {
  50             match stmt.node {
  51                 ast::StmtKind::Expr(ref expr) |
  52                 ast::StmtKind::Semi(ref expr) => {
  53                     self.check_final_expr(cx, expr, Some(stmt.span));
  54                 },
  55                 _ => (),
  56             }
  57         }
  58     }
  59
  60     // Check a the final expression in a block if it's a return.
  61     fn check_final_expr(&mut self, cx: &EarlyContext, expr: &ast::Expr, span: Option<Span>) {
  62         match expr.node {
  63             // simple return is always "bad"
  64             ast::ExprKind::Ret(Some(ref inner)) => {
  65                 // allow `#[cfg(a)] return a; #[cfg(b)] return b;`
  66                 if !expr.attrs.iter().any(attr_is_cfg) {
  67                     self.emit_return_lint(cx, span.expect("`else return` is not possible"), inner.span);
  68                 }
  69             },
  70             // a whole block? check it!
  71             ast::ExprKind::Block(ref block) => {
  72                 self.check_block_return(cx, block);
  73             },
  74             // an if/if let expr, check both exprs
  75             // note, if without else is going to be a type checking error anyways
  76             // (except for unit type functions) so we don't match it
  77             ast::ExprKind::If(_, ref ifblock, Some(ref elsexpr)) => {
  78                 self.check_block_return(cx, ifblock);
  79                 self.check_final_expr(cx, elsexpr, None);
  80             },
  81             // a match expr, check all arms
  82             ast::ExprKind::Match(_, ref arms) => {
  83                 for arm in arms {
  84                     self.check_final_expr(cx, &arm.body, Some(arm.body.span));
  85                 }
  86             },
  87             _ => (),
  88         }
  89     }
  90
  91     fn emit_return_lint(&mut self, cx: &EarlyContext, ret_span: Span, inner_span: Span) {
  92         if in_external_macro(cx, inner_span) {
  93             return;
  94         }
  95         span_lint_and_then(cx,
  96                            NEEDLESS_RETURN,
  97                            ret_span,
  98                            "unneeded return statement",
  99                            |db| if let Some(snippet) = snippet_opt(cx, inner_span) {
 100                                db.span_suggestion(ret_span, "remove `return` as shown:", snippet);
 101                            });
 102     }
 103
 104     // Check for "let x = EXPR; x"
 105     fn check_let_return(&mut self, cx: &EarlyContext, block: &ast::Block) {
 106         let mut it = block.stmts.iter();
 107
 108         // we need both a let-binding stmt and an expr
 109         if_let_chain! {[
 110             let Some(retexpr) = it.next_back(),
 111             let ast::StmtKind::Expr(ref retexpr) = retexpr.node,
 112             let Some(stmt) = it.next_back(),
 113             let ast::StmtKind::Local(ref local) = stmt.node,
 114             !local.attrs.iter().any(attr_is_cfg),
 115             let Some(ref initexpr) = local.init,
 116             let ast::PatKind::Ident(_, Spanned { node: id, .. }, _) = local.pat.node,
 117             let ast::ExprKind::Path(_, ref path) = retexpr.node,
 118             match_path_ast(path, &[&id.name.as_str()]),
 119             !in_external_macro(cx, initexpr.span),
 120         ], {
 121                 span_note_and_lint(cx,
 122                                    LET_AND_RETURN,
 123                                    retexpr.span,
 124                                    "returning the result of a let binding from a block. \
 125                                    Consider returning the expression directly.",
 126                                    initexpr.span,
 127                                    "this expression can be directly returned");
 128         }}
 129     }
 130 }
 131
 132 impl LintPass for ReturnPass {
 133     fn get_lints(&self) -> LintArray {
 134         lint_array!(NEEDLESS_RETURN, LET_AND_RETURN)
 135     }
 136 }
 137
 138 impl EarlyLintPass for ReturnPass {
 139     fn check_fn(&mut self, cx: &EarlyContext, kind: FnKind, _: &ast::FnDecl, _: Span, _: ast::NodeId) {
 140         match kind {
 141             FnKind::ItemFn(.., block) |
 142             FnKind::Method(.., block) => self.check_block_return(cx, block),
 143             FnKind::Closure(body) => self.check_final_expr(cx, body, Some(body.span)),
 144         }
 145     }
 146
 147     fn check_block(&mut self, cx: &EarlyContext, block: &ast::Block) {
 148         self.check_let_return(cx, block);
 149     }
 150 }
 151
 152 fn attr_is_cfg(attr: &ast::Attribute) -> bool {
 153     attr.meta_item_list().is_some() && attr.name().map_or(false, |n| n == "cfg")
 154 }