]> git.lizzy.rs Git - rust.git/blobdiff - clippy_lints/src/returns.rs
Merge branch 'macro-use' into HEAD
[rust.git] / clippy_lints / src / returns.rs
index 16f582c77c97fe7a880b546e327868513d067630..2bfc1e7d107121e0e1e2642d531fe3a3e185e34f 100644 (file)
@@ -1,28 +1,32 @@
 use rustc::lint::*;
+use rustc::{declare_lint, lint_array};
+use if_chain::if_chain;
 use syntax::ast;
-use syntax::codemap::{Span, Spanned};
+use syntax::codemap::Span;
 use syntax::visit::FnKind;
 
-use utils::{span_note_and_lint, span_lint_and_then, snippet_opt, match_path_ast, in_external_macro};
+use crate::utils::{in_external_macro, in_macro, match_path_ast, snippet_opt, span_lint_and_then, span_note_and_lint};
 
 /// **What it does:** Checks for return statements at the end of a block.
 ///
 /// **Why is this bad?** Removing the `return` and semicolon will make the code
 /// more rusty.
 ///
-/// **Known problems:** None.
+/// **Known problems:** If the computation returning the value borrows a local
+/// variable, removing the `return` may run afoul of the borrow checker.
 ///
 /// **Example:**
 /// ```rust
 /// fn foo(x: usize) { return x; }
 /// ```
-declare_lint! {
+declare_clippy_lint! {
     pub NEEDLESS_RETURN,
-    Warn,
+    style,
     "using a return statement like `return expr;` where an expression would suffice"
 }
 
-/// **What it does:** Checks for `let`-bindings, which are subsequently returned.
+/// **What it does:** Checks for `let`-bindings, which are subsequently
+/// returned.
 ///
 /// **Why is this bad?** It is just extraneous code. Remove it to make your code
 /// more rusty.
@@ -33,9 +37,9 @@
 /// ```rust
 /// { let x = ..; x }
 /// ```
-declare_lint! {
+declare_clippy_lint! {
     pub LET_AND_RETURN,
-    Warn,
+    style,
     "creating a let-binding and then immediately returning it like `let x = expr; x` at \
      the end of a block"
 }
@@ -48,8 +52,7 @@ impl ReturnPass {
     fn check_block_return(&mut self, cx: &EarlyContext, block: &ast::Block) {
         if let Some(stmt) = block.stmts.last() {
             match stmt.node {
-                ast::StmtKind::Expr(ref expr) |
-                ast::StmtKind::Semi(ref expr) => {
+                ast::StmtKind::Expr(ref expr) | ast::StmtKind::Semi(ref expr) => {
                     self.check_final_expr(cx, expr, Some(stmt.span));
                 },
                 _ => (),
@@ -68,7 +71,7 @@ fn check_final_expr(&mut self, cx: &EarlyContext, expr: &ast::Expr, span: Option
                 }
             },
             // a whole block? check it!
-            ast::ExprKind::Block(ref block) => {
+            ast::ExprKind::Block(ref block, _) => {
                 self.check_block_return(cx, block);
             },
             // an if/if let expr, check both exprs
@@ -79,26 +82,22 @@ fn check_final_expr(&mut self, cx: &EarlyContext, expr: &ast::Expr, span: Option
                 self.check_final_expr(cx, elsexpr, None);
             },
             // a match expr, check all arms
-            ast::ExprKind::Match(_, ref arms) => {
-                for arm in arms {
-                    self.check_final_expr(cx, &arm.body, Some(arm.body.span));
-                }
+            ast::ExprKind::Match(_, ref arms) => for arm in arms {
+                self.check_final_expr(cx, &arm.body, Some(arm.body.span));
             },
             _ => (),
         }
     }
 
     fn emit_return_lint(&mut self, cx: &EarlyContext, ret_span: Span, inner_span: Span) {
-        if in_external_macro(cx, inner_span) {
+        if in_external_macro(cx, inner_span) || in_macro(inner_span) {
             return;
         }
-        span_lint_and_then(cx,
-                           NEEDLESS_RETURN,
-                           ret_span,
-                           "unneeded return statement",
-                           |db| if let Some(snippet) = snippet_opt(cx, inner_span) {
-                               db.span_suggestion(ret_span, "remove `return` as shown:", snippet);
-                           });
+        span_lint_and_then(cx, NEEDLESS_RETURN, ret_span, "unneeded return statement", |db| {
+            if let Some(snippet) = snippet_opt(cx, inner_span) {
+                db.span_suggestion(ret_span, "remove `return` as shown", snippet);
+            }
+        });
     }
 
     // Check for "let x = EXPR; x"
@@ -106,26 +105,29 @@ fn check_let_return(&mut self, cx: &EarlyContext, block: &ast::Block) {
         let mut it = block.stmts.iter();
 
         // we need both a let-binding stmt and an expr
-        if_let_chain! {[
-            let Some(retexpr) = it.next_back(),
-            let ast::StmtKind::Expr(ref retexpr) = retexpr.node,
-            let Some(stmt) = it.next_back(),
-            let ast::StmtKind::Local(ref local) = stmt.node,
-            !local.attrs.iter().any(attr_is_cfg),
-            let Some(ref initexpr) = local.init,
-            let ast::PatKind::Ident(_, Spanned { node: id, .. }, _) = local.pat.node,
-            let ast::ExprKind::Path(_, ref path) = retexpr.node,
-            match_path_ast(path, &[&id.name.as_str()]),
-            !in_external_macro(cx, initexpr.span),
-        ], {
-                span_note_and_lint(cx,
-                                   LET_AND_RETURN,
-                                   retexpr.span,
-                                   "returning the result of a let binding from a block. \
-                                   Consider returning the expression directly.",
-                                   initexpr.span,
-                                   "this expression can be directly returned");
-        }}
+        if_chain! {
+            if let Some(retexpr) = it.next_back();
+            if let ast::StmtKind::Expr(ref retexpr) = retexpr.node;
+            if let Some(stmt) = it.next_back();
+            if let ast::StmtKind::Local(ref local) = stmt.node;
+            // don't lint in the presence of type inference
+            if local.ty.is_none();
+            if !local.attrs.iter().any(attr_is_cfg);
+            if let Some(ref initexpr) = local.init;
+            if let ast::PatKind::Ident(_, ident, _) = local.pat.node;
+            if let ast::ExprKind::Path(_, ref path) = retexpr.node;
+            if match_path_ast(path, &[&ident.as_str()]);
+            if !in_external_macro(cx, initexpr.span);
+            then {
+                    span_note_and_lint(cx,
+                                       LET_AND_RETURN,
+                                       retexpr.span,
+                                       "returning the result of a let binding from a block. \
+                                       Consider returning the expression directly.",
+                                       initexpr.span,
+                                       "this expression can be directly returned");
+            }
+        }
     }
 }
 
@@ -138,8 +140,7 @@ fn get_lints(&self) -> LintArray {
 impl EarlyLintPass for ReturnPass {
     fn check_fn(&mut self, cx: &EarlyContext, kind: FnKind, _: &ast::FnDecl, _: Span, _: ast::NodeId) {
         match kind {
-            FnKind::ItemFn(.., block) |
-            FnKind::Method(.., block) => self.check_block_return(cx, block),
+            FnKind::ItemFn(.., block) | FnKind::Method(.., block) => self.check_block_return(cx, block),
             FnKind::Closure(body) => self.check_final_expr(cx, body, Some(body.span)),
         }
     }
@@ -150,5 +151,5 @@ fn check_block(&mut self, cx: &EarlyContext, block: &ast::Block) {
 }
 
 fn attr_is_cfg(attr: &ast::Attribute) -> bool {
-    attr.meta_item_list().is_some() && attr.name().map_or(false, |n| n == "cfg")
+    attr.meta_item_list().is_some() && attr.name() == "cfg"
 }