3 use syntax::codemap::{Span, Spanned};
4 use syntax::visit::FnKind;
6 use utils::{span_note_and_lint, span_lint_and_then, snippet_opt, match_path_ast, in_external_macro};
8 /// **What it does:** Checks for return statements at the end of a block.
10 /// **Why is this bad?** Removing the `return` and semicolon will make the code
13 /// **Known problems:** None.
17 /// fn foo(x: usize) { return x; }
22 "using a return statement like `return expr;` where an expression would suffice"
25 /// **What it does:** Checks for `let`-bindings, which are subsequently returned.
27 /// **Why is this bad?** It is just extraneous code. Remove it to make your code
30 /// **Known problems:** None.
39 "creating a let-binding and then immediately returning it like `let x = expr; x` at \
43 #[derive(Copy, Clone)]
44 pub struct 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() {
51 ast::StmtKind::Expr(ref expr) |
52 ast::StmtKind::Semi(ref expr) => {
53 self.check_final_expr(cx, expr, Some(stmt.span));
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>) {
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);
70 // a whole block? check it!
71 ast::ExprKind::Block(ref block) => {
72 self.check_block_return(cx, block);
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);
81 // a match expr, check all arms
82 ast::ExprKind::Match(_, ref arms) => {
84 self.check_final_expr(cx, &arm.body, Some(arm.body.span));
91 fn emit_return_lint(&mut self, cx: &EarlyContext, ret_span: Span, inner_span: Span) {
92 if in_external_macro(cx, inner_span) {
95 span_lint_and_then(cx, NEEDLESS_RETURN, ret_span, "unneeded return statement", |db| {
96 if let Some(snippet) = snippet_opt(cx, inner_span) {
97 db.span_suggestion(ret_span, "remove `return` as shown:", snippet);
102 // Check for "let x = EXPR; x"
103 fn check_let_return(&mut self, cx: &EarlyContext, block: &ast::Block) {
104 let mut it = block.stmts.iter();
106 // we need both a let-binding stmt and an expr
108 let Some(ref retexpr) = it.next_back(),
109 let ast::StmtKind::Expr(ref retexpr) = retexpr.node,
110 let Some(stmt) = it.next_back(),
111 let ast::StmtKind::Local(ref local) = stmt.node,
112 !local.attrs.iter().any(attr_is_cfg),
113 let Some(ref initexpr) = local.init,
114 let ast::PatKind::Ident(_, Spanned { node: id, .. }, _) = local.pat.node,
115 let ast::ExprKind::Path(_, ref path) = retexpr.node,
116 match_path_ast(path, &[&id.name.as_str()]),
117 !in_external_macro(cx, initexpr.span),
119 span_note_and_lint(cx,
122 "returning the result of a let binding from a block. \
123 Consider returning the expression directly.",
125 "this expression can be directly returned");
130 impl LintPass for ReturnPass {
131 fn get_lints(&self) -> LintArray {
132 lint_array!(NEEDLESS_RETURN, LET_AND_RETURN)
136 impl EarlyLintPass for ReturnPass {
137 fn check_fn(&mut self, cx: &EarlyContext, kind: FnKind, _: &ast::FnDecl, _: Span, _: ast::NodeId) {
139 FnKind::ItemFn(.., block) |
140 FnKind::Method(.., block) => self.check_block_return(cx, block),
141 FnKind::Closure(body) => self.check_final_expr(cx, body, None),
145 fn check_block(&mut self, cx: &EarlyContext, block: &ast::Block) {
146 self.check_let_return(cx, block);
150 fn attr_is_cfg(attr: &ast::Attribute) -> bool {
151 if let ast::MetaItemKind::List(_) = attr.value.node {