clippy_lints/src/returns.rs

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