clippy_lints/src/no_effect.rs

   1 use rustc::lint::{LateContext, LateLintPass, LintArray, LintPass};
   2 use rustc::hir::def::Def;
   3 use rustc::hir::{Expr, Expr_, Stmt, StmtSemi, BlockCheckMode, UnsafeSource, BiAnd, BiOr};
   4 use utils::{in_macro, span_lint, snippet_opt, span_lint_and_sugg};
   5 use std::ops::Deref;
   6
   7 /// **What it does:** Checks for statements which have no effect.
   8 ///
   9 /// **Why is this bad?** Similar to dead code, these statements are actually
  10 /// executed. However, as they have no effect, all they do is make the code less
  11 /// readable.
  12 ///
  13 /// **Known problems:** None.
  14 ///
  15 /// **Example:**
  16 /// ```rust
  17 /// 0;
  18 /// ```
  19 declare_lint! {
  20     pub NO_EFFECT,
  21     Warn,
  22     "statements with no effect"
  23 }
  24
  25 /// **What it does:** Checks for expression statements that can be reduced to a
  26 /// sub-expression.
  27 ///
  28 /// **Why is this bad?** Expressions by themselves often have no side-effects.
  29 /// Having such expressions reduces readability.
  30 ///
  31 /// **Known problems:** None.
  32 ///
  33 /// **Example:**
  34 /// ```rust
  35 /// compute_array()[0];
  36 /// ```
  37 declare_lint! {
  38     pub UNNECESSARY_OPERATION,
  39     Warn,
  40     "outer expressions with no effect"
  41 }
  42
  43 fn has_no_effect(cx: &LateContext, expr: &Expr) -> bool {
  44     if in_macro(expr.span) {
  45         return false;
  46     }
  47     match expr.node {
  48         Expr_::ExprLit(..) |
  49         Expr_::ExprClosure(..) |
  50         Expr_::ExprPath(..) => true,
  51         Expr_::ExprIndex(ref a, ref b) |
  52         Expr_::ExprBinary(_, ref a, ref b) => has_no_effect(cx, a) && has_no_effect(cx, b),
  53         Expr_::ExprArray(ref v) |
  54         Expr_::ExprTup(ref v) => v.iter().all(|val| has_no_effect(cx, val)),
  55         Expr_::ExprRepeat(ref inner, _) |
  56         Expr_::ExprCast(ref inner, _) |
  57         Expr_::ExprType(ref inner, _) |
  58         Expr_::ExprUnary(_, ref inner) |
  59         Expr_::ExprField(ref inner, _) |
  60         Expr_::ExprTupField(ref inner, _) |
  61         Expr_::ExprAddrOf(_, ref inner) |
  62         Expr_::ExprBox(ref inner) => has_no_effect(cx, inner),
  63         Expr_::ExprStruct(_, ref fields, ref base) => {
  64             fields.iter().all(|field| has_no_effect(cx, &field.expr)) &&
  65             match *base {
  66                 Some(ref base) => has_no_effect(cx, base),
  67                 None => true,
  68             }
  69         },
  70         Expr_::ExprCall(ref callee, ref args) => {
  71             if let Expr_::ExprPath(ref qpath) = callee.node {
  72                 let def = cx.tables.qpath_def(qpath, callee.id);
  73                 match def {
  74                     Def::Struct(..) |
  75                     Def::Variant(..) |
  76                     Def::StructCtor(..) |
  77                     Def::VariantCtor(..) => args.iter().all(|arg| has_no_effect(cx, arg)),
  78                     _ => false,
  79                 }
  80             } else {
  81                 false
  82             }
  83         },
  84         Expr_::ExprBlock(ref block) => {
  85             block.stmts.is_empty() &&
  86             if let Some(ref expr) = block.expr {
  87                 has_no_effect(cx, expr)
  88             } else {
  89                 false
  90             }
  91         },
  92         _ => false,
  93     }
  94 }
  95
  96 #[derive(Copy, Clone)]
  97 pub struct Pass;
  98
  99 impl LintPass for Pass {
 100     fn get_lints(&self) -> LintArray {
 101         lint_array!(NO_EFFECT, UNNECESSARY_OPERATION)
 102     }
 103 }
 104
 105 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for Pass {
 106     fn check_stmt(&mut self, cx: &LateContext<'a, 'tcx>, stmt: &'tcx Stmt) {
 107         if let StmtSemi(ref expr, _) = stmt.node {
 108             if has_no_effect(cx, expr) {
 109                 span_lint(cx, NO_EFFECT, stmt.span, "statement with no effect");
 110             } else if let Some(reduced) = reduce_expression(cx, expr) {
 111                 let mut snippet = String::new();
 112                 for e in reduced {
 113                     if in_macro(e.span) {
 114                         return;
 115                     }
 116                     if let Some(snip) = snippet_opt(cx, e.span) {
 117                         snippet.push_str(&snip);
 118                         snippet.push(';');
 119                     } else {
 120                         return;
 121                     }
 122                 }
 123                 span_lint_and_sugg(cx,
 124                                    UNNECESSARY_OPERATION,
 125                                    stmt.span,
 126                                    "statement can be reduced",
 127                                    "replace it with",
 128                                    snippet);
 129             }
 130         }
 131     }
 132 }
 133
 134
 135 fn reduce_expression<'a>(cx: &LateContext, expr: &'a Expr) -> Option<Vec<&'a Expr>> {
 136     if in_macro(expr.span) {
 137         return None;
 138     }
 139     match expr.node {
 140         Expr_::ExprIndex(ref a, ref b) => Some(vec![&**a, &**b]),
 141         Expr_::ExprBinary(ref binop, ref a, ref b) if binop.node != BiAnd && binop.node != BiOr => {
 142             Some(vec![&**a, &**b])
 143         },
 144         Expr_::ExprArray(ref v) |
 145         Expr_::ExprTup(ref v) => Some(v.iter().collect()),
 146         Expr_::ExprRepeat(ref inner, _) |
 147         Expr_::ExprCast(ref inner, _) |
 148         Expr_::ExprType(ref inner, _) |
 149         Expr_::ExprUnary(_, ref inner) |
 150         Expr_::ExprField(ref inner, _) |
 151         Expr_::ExprTupField(ref inner, _) |
 152         Expr_::ExprAddrOf(_, ref inner) |
 153         Expr_::ExprBox(ref inner) => reduce_expression(cx, inner).or_else(|| Some(vec![inner])),
 154         Expr_::ExprStruct(_, ref fields, ref base) => {
 155             Some(fields.iter().map(|f| &f.expr).chain(base).map(Deref::deref).collect())
 156         },
 157         Expr_::ExprCall(ref callee, ref args) => {
 158             if let Expr_::ExprPath(ref qpath) = callee.node {
 159                 let def = cx.tables.qpath_def(qpath, callee.id);
 160                 match def {
 161                     Def::Struct(..) |
 162                     Def::Variant(..) |
 163                     Def::StructCtor(..) |
 164                     Def::VariantCtor(..) => Some(args.iter().collect()),
 165                     _ => None,
 166                 }
 167             } else {
 168                 None
 169             }
 170         },
 171         Expr_::ExprBlock(ref block) => {
 172             if block.stmts.is_empty() {
 173                 block.expr.as_ref().and_then(|e| {
 174                     match block.rules {
 175                         BlockCheckMode::UnsafeBlock(UnsafeSource::UserProvided) => None,
 176                         BlockCheckMode::DefaultBlock => Some(vec![&**e]),
 177                         // in case of compiler-inserted signaling blocks
 178                         _ => reduce_expression(cx, e),
 179                     }
 180                 })
 181             } else {
 182                 None
 183             }
 184         },
 185         _ => None,
 186     }
 187 }