clippy_lints/src/returns.rs

   1 use if_chain::if_chain;
   2 use rustc::lint::{in_external_macro, EarlyContext, EarlyLintPass, LintArray, LintContext, LintPass};
   3 use rustc::{declare_lint_pass, declare_tool_lint};
   4 use rustc_errors::Applicability;
   5 use syntax::ast;
   6 use syntax::source_map::Span;
   7 use syntax::visit::FnKind;
   8 use syntax_pos::BytePos;
   9
  10 use crate::utils::{in_macro_or_desugar, match_path_ast, snippet_opt, span_lint_and_then};
  11
  12 declare_clippy_lint! {
  13     /// **What it does:** Checks for return statements at the end of a block.
  14     ///
  15     /// **Why is this bad?** Removing the `return` and semicolon will make the code
  16     /// more rusty.
  17     ///
  18     /// **Known problems:** If the computation returning the value borrows a local
  19     /// variable, removing the `return` may run afoul of the borrow checker.
  20     ///
  21     /// **Example:**
  22     /// ```rust
  23     /// fn foo(x: usize) -> usize {
  24     ///     return x;
  25     /// }
  26     /// ```
  27     /// simplify to
  28     /// ```rust
  29     /// fn foo(x: usize) -> usize {
  30     ///     x
  31     /// }
  32     /// ```
  33     pub NEEDLESS_RETURN,
  34     style,
  35     "using a return statement like `return expr;` where an expression would suffice"
  36 }
  37
  38 declare_clippy_lint! {
  39     /// **What it does:** Checks for `let`-bindings, which are subsequently
  40     /// returned.
  41     ///
  42     /// **Why is this bad?** It is just extraneous code. Remove it to make your code
  43     /// more rusty.
  44     ///
  45     /// **Known problems:** None.
  46     ///
  47     /// **Example:**
  48     /// ```rust
  49     /// fn foo() -> String {
  50     ///     let x = String::new();
  51     ///     x
  52     /// }
  53     /// ```
  54     /// instead, use
  55     /// ```
  56     /// fn foo() -> String {
  57     ///     String::new()
  58     /// }
  59     /// ```
  60     pub LET_AND_RETURN,
  61     style,
  62     "creating a let-binding and then immediately returning it like `let x = expr; x` at the end of a block"
  63 }
  64
  65 declare_clippy_lint! {
  66     /// **What it does:** Checks for unit (`()`) expressions that can be removed.
  67     ///
  68     /// **Why is this bad?** Such expressions add no value, but can make the code
  69     /// less readable. Depending on formatting they can make a `break` or `return`
  70     /// statement look like a function call.
  71     ///
  72     /// **Known problems:** The lint currently misses unit return types in types,
  73     /// e.g., the `F` in `fn generic_unit<F: Fn() -> ()>(f: F) { .. }`.
  74     ///
  75     /// **Example:**
  76     /// ```rust
  77     /// fn return_unit() -> () {
  78     ///     ()
  79     /// }
  80     /// ```
  81     pub UNUSED_UNIT,
  82     style,
  83     "needless unit expression"
  84 }
  85
  86 declare_lint_pass!(Return => [NEEDLESS_RETURN, LET_AND_RETURN, UNUSED_UNIT]);
  87
  88 impl Return {
  89     // Check the final stmt or expr in a block for unnecessary return.
  90     fn check_block_return(&mut self, cx: &EarlyContext<'_>, block: &ast::Block) {
  91         if let Some(stmt) = block.stmts.last() {
  92             match stmt.node {
  93                 ast::StmtKind::Expr(ref expr) | ast::StmtKind::Semi(ref expr) => {
  94                     self.check_final_expr(cx, expr, Some(stmt.span));
  95                 },
  96                 _ => (),
  97             }
  98         }
  99     }
 100
 101     // Check a the final expression in a block if it's a return.
 102     fn check_final_expr(&mut self, cx: &EarlyContext<'_>, expr: &ast::Expr, span: Option<Span>) {
 103         match expr.node {
 104             // simple return is always "bad"
 105             ast::ExprKind::Ret(Some(ref inner)) => {
 106                 // allow `#[cfg(a)] return a; #[cfg(b)] return b;`
 107                 if !expr.attrs.iter().any(attr_is_cfg) {
 108                     self.emit_return_lint(cx, span.expect("`else return` is not possible"), inner.span);
 109                 }
 110             },
 111             // a whole block? check it!
 112             ast::ExprKind::Block(ref block, _) => {
 113                 self.check_block_return(cx, block);
 114             },
 115             // an if/if let expr, check both exprs
 116             // note, if without else is going to be a type checking error anyways
 117             // (except for unit type functions) so we don't match it
 118             ast::ExprKind::If(_, ref ifblock, Some(ref elsexpr)) => {
 119                 self.check_block_return(cx, ifblock);
 120                 self.check_final_expr(cx, elsexpr, None);
 121             },
 122             // a match expr, check all arms
 123             ast::ExprKind::Match(_, ref arms) => {
 124                 for arm in arms {
 125                     self.check_final_expr(cx, &arm.body, Some(arm.body.span));
 126                 }
 127             },
 128             _ => (),
 129         }
 130     }
 131
 132     fn emit_return_lint(&mut self, cx: &EarlyContext<'_>, ret_span: Span, inner_span: Span) {
 133         if in_external_macro(cx.sess(), inner_span) || in_macro_or_desugar(inner_span) {
 134             return;
 135         }
 136         span_lint_and_then(cx, NEEDLESS_RETURN, ret_span, "unneeded return statement", |db| {
 137             if let Some(snippet) = snippet_opt(cx, inner_span) {
 138                 db.span_suggestion(
 139                     ret_span,
 140                     "remove `return` as shown",
 141                     snippet,
 142                     Applicability::MachineApplicable,
 143                 );
 144             }
 145         });
 146     }
 147
 148     // Check for "let x = EXPR; x"
 149     fn check_let_return(&mut self, cx: &EarlyContext<'_>, block: &ast::Block) {
 150         let mut it = block.stmts.iter();
 151
 152         // we need both a let-binding stmt and an expr
 153         if_chain! {
 154             if let Some(retexpr) = it.next_back();
 155             if let ast::StmtKind::Expr(ref retexpr) = retexpr.node;
 156             if let Some(stmt) = it.next_back();
 157             if let ast::StmtKind::Local(ref local) = stmt.node;
 158             // don't lint in the presence of type inference
 159             if local.ty.is_none();
 160             if local.attrs.is_empty();
 161             if let Some(ref initexpr) = local.init;
 162             if let ast::PatKind::Ident(_, ident, _) = local.pat.node;
 163             if let ast::ExprKind::Path(_, ref path) = retexpr.node;
 164             if match_path_ast(path, &[&*ident.name.as_str()]);
 165             if !in_external_macro(cx.sess(), initexpr.span);
 166             then {
 167                 span_lint_and_then(
 168                     cx,
 169                     LET_AND_RETURN,
 170                     retexpr.span,
 171                     "returning the result of a let binding from a block",
 172                     |err| {
 173                         err.span_label(local.span, "unnecessary let binding");
 174
 175                         if let Some(snippet) = snippet_opt(cx, initexpr.span) {
 176                             err.multipart_suggestion(
 177                                 "return the expression directly",
 178                                 vec![
 179                                     (local.span, String::new()),
 180                                     (retexpr.span, snippet),
 181                                 ],
 182                                 Applicability::MachineApplicable,
 183                             );
 184                         } else {
 185                             err.span_help(initexpr.span, "this expression can be directly returned");
 186                         }
 187                     },
 188                 );
 189             }
 190         }
 191     }
 192 }
 193
 194 impl EarlyLintPass for Return {
 195     fn check_fn(&mut self, cx: &EarlyContext<'_>, kind: FnKind<'_>, decl: &ast::FnDecl, span: Span, _: ast::NodeId) {
 196         match kind {
 197             FnKind::ItemFn(.., block) | FnKind::Method(.., block) => self.check_block_return(cx, block),
 198             FnKind::Closure(body) => self.check_final_expr(cx, body, Some(body.span)),
 199         }
 200         if_chain! {
 201             if let ast::FunctionRetTy::Ty(ref ty) = decl.output;
 202             if let ast::TyKind::Tup(ref vals) = ty.node;
 203             if vals.is_empty() && !in_macro_or_desugar(ty.span) && get_def(span) == get_def(ty.span);
 204             then {
 205                 let (rspan, appl) = if let Ok(fn_source) =
 206                         cx.sess().source_map()
 207                                  .span_to_snippet(span.with_hi(ty.span.hi())) {
 208                     if let Some(rpos) = fn_source.rfind("->") {
 209                         #[allow(clippy::cast_possible_truncation)]
 210                         (ty.span.with_lo(BytePos(span.lo().0 + rpos as u32)),
 211                             Applicability::MachineApplicable)
 212                     } else {
 213                         (ty.span, Applicability::MaybeIncorrect)
 214                     }
 215                 } else {
 216                     (ty.span, Applicability::MaybeIncorrect)
 217                 };
 218                 span_lint_and_then(cx, UNUSED_UNIT, rspan, "unneeded unit return type", |db| {
 219                     db.span_suggestion(
 220                         rspan,
 221                         "remove the `-> ()`",
 222                         String::new(),
 223                         appl,
 224                     );
 225                 });
 226             }
 227         }
 228     }
 229
 230     fn check_block(&mut self, cx: &EarlyContext<'_>, block: &ast::Block) {
 231         self.check_let_return(cx, block);
 232         if_chain! {
 233             if let Some(ref stmt) = block.stmts.last();
 234             if let ast::StmtKind::Expr(ref expr) = stmt.node;
 235             if is_unit_expr(expr) && !in_macro_or_desugar(expr.span);
 236             then {
 237                 let sp = expr.span;
 238                 span_lint_and_then(cx, UNUSED_UNIT, sp, "unneeded unit expression", |db| {
 239                     db.span_suggestion(
 240                         sp,
 241                         "remove the final `()`",
 242                         String::new(),
 243                         Applicability::MachineApplicable,
 244                     );
 245                 });
 246             }
 247         }
 248     }
 249
 250     fn check_expr(&mut self, cx: &EarlyContext<'_>, e: &ast::Expr) {
 251         match e.node {
 252             ast::ExprKind::Ret(Some(ref expr)) | ast::ExprKind::Break(_, Some(ref expr)) => {
 253                 if is_unit_expr(expr) && !in_macro_or_desugar(expr.span) {
 254                     span_lint_and_then(cx, UNUSED_UNIT, expr.span, "unneeded `()`", |db| {
 255                         db.span_suggestion(
 256                             expr.span,
 257                             "remove the `()`",
 258                             String::new(),
 259                             Applicability::MachineApplicable,
 260                         );
 261                     });
 262                 }
 263             },
 264             _ => (),
 265         }
 266     }
 267 }
 268
 269 fn attr_is_cfg(attr: &ast::Attribute) -> bool {
 270     attr.meta_item_list().is_some() && attr.check_name(sym!(cfg))
 271 }
 272
 273 // get the def site
 274 fn get_def(span: Span) -> Option<Span> {
 275     span.ctxt().outer().expn_info().and_then(|info| info.def_site)
 276 }
 277
 278 // is this expr a `()` unit?
 279 fn is_unit_expr(expr: &ast::Expr) -> bool {
 280     if let ast::ExprKind::Tup(ref vals) = expr.node {
 281         vals.is_empty()
 282     } else {
 283         false
 284     }
 285 }