clippy_lints/src/int_plus_one.rs

   1 //! lint on blocks unnecessarily using >= with a + 1 or - 1
   2
   3 use rustc::lint::*;
   4 use syntax::ast::*;
   5
   6 use utils::{span_lint_and_then, snippet_opt};
   7
   8 /// **What it does:** Checks for usage of `x >= y + 1` or `x - 1 >= y` (and `<=`) in a block
   9 ///
  10 ///
  11 /// **Why is this bad?** Readability -- better to use `> y` instead of `>= y + 1`.
  12 ///
  13 /// **Known problems:** None.
  14 ///
  15 /// **Example:**
  16 /// ```rust
  17 /// x >= y + 1
  18 /// ```
  19 ///
  20 /// Could be written:
  21 ///
  22 /// ```rust
  23 /// x > y
  24 /// ```
  25 declare_lint! {
  26     pub INT_PLUS_ONE,
  27     Allow,
  28     "instead of using x >= y + 1, use x > y"
  29 }
  30
  31 pub struct IntPlusOne;
  32
  33 impl LintPass for IntPlusOne {
  34     fn get_lints(&self) -> LintArray {
  35         lint_array!(INT_PLUS_ONE)
  36     }
  37 }
  38
  39 // cases:
  40 // BinOpKind::Ge
  41 // x >= y + 1
  42 // x - 1 >= y
  43 //
  44 // BinOpKind::Le
  45 // x + 1 <= y
  46 // x <= y - 1
  47
  48 enum Side {
  49     LHS,
  50     RHS,
  51 }
  52
  53 impl IntPlusOne {
  54     #[allow(cast_sign_loss)]
  55     fn check_lit(&self, lit: &Lit, target_value: i128) -> bool {
  56         if let LitKind::Int(value, ..) = lit.node {
  57             return value == (target_value as u128)
  58         }
  59         false
  60     }
  61
  62     fn check_binop(&self, cx: &EarlyContext, binop: BinOpKind, lhs: &Expr, rhs: &Expr) -> Option<String> {
  63         match (binop, &lhs.node, &rhs.node) {
  64             // case where `x - 1 >= ...` or `-1 + x >= ...`
  65             (BinOpKind::Ge, &ExprKind::Binary(ref lhskind, ref lhslhs, ref lhsrhs), _) => {
  66                 match (lhskind.node, &lhslhs.node, &lhsrhs.node) {
  67                     // `-1 + x`
  68                     (BinOpKind::Add, &ExprKind::Lit(ref lit), _) if self.check_lit(lit, -1) => self.generate_recommendation(cx, binop, lhsrhs, rhs, Side::LHS),
  69                     // `x - 1`
  70                     (BinOpKind::Sub, _, &ExprKind::Lit(ref lit)) if self.check_lit(lit, 1) => self.generate_recommendation(cx, binop, lhslhs, rhs, Side::LHS),
  71                     _ => None
  72                 }
  73             },
  74             // case where `... >= y + 1` or `... >= 1 + y`
  75             (BinOpKind::Ge, _, &ExprKind::Binary(ref rhskind, ref rhslhs, ref rhsrhs)) if rhskind.node == BinOpKind::Add => {
  76                 match (&rhslhs.node, &rhsrhs.node) {
  77                     // `y + 1` and `1 + y`
  78                     (&ExprKind::Lit(ref lit), _) if self.check_lit(lit, 1) => self.generate_recommendation(cx, binop, rhsrhs, lhs, Side::RHS),
  79                     (_, &ExprKind::Lit(ref lit)) if self.check_lit(lit, 1) => self.generate_recommendation(cx, binop, rhslhs, lhs, Side::RHS),
  80                     _ => None
  81                 }
  82             },
  83             // case where `x + 1 <= ...` or `1 + x <= ...`
  84             (BinOpKind::Le, &ExprKind::Binary(ref lhskind, ref lhslhs, ref lhsrhs), _) if lhskind.node == BinOpKind::Add => {
  85                 match (&lhslhs.node, &lhsrhs.node) {
  86                     // `1 + x` and `x + 1`
  87                     (&ExprKind::Lit(ref lit), _) if self.check_lit(lit, 1) => self.generate_recommendation(cx, binop, lhsrhs, rhs, Side::LHS),
  88                     (_, &ExprKind::Lit(ref lit)) if self.check_lit(lit, 1) => self.generate_recommendation(cx, binop, lhslhs, rhs, Side::LHS),
  89                     _ => None
  90                 }
  91             },
  92             // case where `... >= y - 1` or `... >= -1 + y`
  93             (BinOpKind::Le, _, &ExprKind::Binary(ref rhskind, ref rhslhs, ref rhsrhs)) => {
  94                 match (rhskind.node, &rhslhs.node, &rhsrhs.node) {
  95                     // `-1 + y`
  96                     (BinOpKind::Add, &ExprKind::Lit(ref lit), _) if self.check_lit(lit, -1) => self.generate_recommendation(cx, binop, rhsrhs, lhs, Side::RHS),
  97                     // `y - 1`
  98                     (BinOpKind::Sub, _, &ExprKind::Lit(ref lit)) if self.check_lit(lit, 1) => self.generate_recommendation(cx, binop, rhslhs, lhs, Side::RHS),
  99                     _ => None
 100                 }
 101             },
 102             _ => None
 103         }
 104     }
 105
 106     fn generate_recommendation(&self, cx: &EarlyContext, binop: BinOpKind, node: &Expr, other_side: &Expr, side: Side) -> Option<String> {
 107         let binop_string = match binop {
 108             BinOpKind::Ge => ">",
 109             BinOpKind::Le => "<",
 110             _ => return None
 111         };
 112         if let Some(snippet) = snippet_opt(cx, node.span) {
 113             if let Some(other_side_snippet) = snippet_opt(cx, other_side.span) {
 114                 let rec = match side {
 115                     Side::LHS => Some(format!("{} {} {}", snippet, binop_string, other_side_snippet)),
 116                     Side::RHS => Some(format!("{} {} {}", other_side_snippet, binop_string, snippet)),
 117                 };
 118                 return rec;
 119             }
 120         }
 121         None
 122     }
 123
 124     fn emit_warning(&self, cx: &EarlyContext, block: &Expr, recommendation: String) {
 125         span_lint_and_then(cx,
 126                            INT_PLUS_ONE,
 127                            block.span,
 128                            "Unnecessary `>= y + 1` or `x - 1 >=`",
 129                            |db| {
 130             db.span_suggestion(block.span, "change `>= y + 1` to `> y` as shown", recommendation);
 131         });
 132     }
 133 }
 134
 135 impl EarlyLintPass for IntPlusOne {
 136     fn check_expr(&mut self, cx: &EarlyContext, item: &Expr) {
 137         if let ExprKind::Binary(ref kind, ref lhs, ref rhs) = item.node {
 138             if let Some(ref rec) = self.check_binop(cx, kind.node, lhs, rhs) {
 139                 self.emit_warning(cx, item, rec.clone());
 140             }
 141         }
 142     }
 143 }