clippy_lints/src/erasing_op.rs

   1 use rustc::hir::*;
   2 use rustc::lint::{LateContext, LateLintPass, LintArray, LintPass};
   3 use rustc::{declare_tool_lint, lint_array};
   4 use syntax::source_map::Span;
   5
   6 use crate::consts::{constant_simple, Constant};
   7 use crate::utils::{in_macro, span_lint};
   8
   9 declare_clippy_lint! {
  10     /// **What it does:** Checks for erasing operations, e.g., `x * 0`.
  11     ///
  12     /// **Why is this bad?** The whole expression can be replaced by zero.
  13     /// This is most likely not the intended outcome and should probably be
  14     /// corrected
  15     ///
  16     /// **Known problems:** None.
  17     ///
  18     /// **Example:**
  19     /// ```rust
  20     /// let x = 1;
  21     /// 0 / x;
  22     /// 0 * x;
  23     /// x & 0;
  24     /// ```
  25     pub ERASING_OP,
  26     correctness,
  27     "using erasing operations, e.g., `x * 0` or `y & 0`"
  28 }
  29
  30 #[derive(Copy, Clone)]
  31 pub struct ErasingOp;
  32
  33 impl LintPass for ErasingOp {
  34     fn get_lints(&self) -> LintArray {
  35         lint_array!(ERASING_OP)
  36     }
  37
  38     fn name(&self) -> &'static str {
  39         "ErasingOp"
  40     }
  41 }
  42
  43 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for ErasingOp {
  44     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, e: &'tcx Expr) {
  45         if in_macro(e.span) {
  46             return;
  47         }
  48         if let ExprKind::Binary(ref cmp, ref left, ref right) = e.node {
  49             match cmp.node {
  50                 BinOpKind::Mul | BinOpKind::BitAnd => {
  51                     check(cx, left, e.span);
  52                     check(cx, right, e.span);
  53                 },
  54                 BinOpKind::Div => check(cx, left, e.span),
  55                 _ => (),
  56             }
  57         }
  58     }
  59 }
  60
  61 fn check(cx: &LateContext<'_, '_>, e: &Expr, span: Span) {
  62     if let Some(Constant::Int(v)) = constant_simple(cx, cx.tables, e) {
  63         if v == 0 {
  64             span_lint(
  65                 cx,
  66                 ERASING_OP,
  67                 span,
  68                 "this operation will always return zero. This is likely not the intended outcome",
  69             );
  70         }
  71     }
  72 }