about summary refs log tree commit diff
path: root/clippy_lints/src/integer_division.rs
blob: 053d66e6af74eb32548fa95b930ac9ae9478518f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
use crate::utils::span_lint_and_help;
use if_chain::if_chain;
use rustc_hir as hir;
use rustc_lint::{LateContext, LateLintPass};
use rustc_session::{declare_lint_pass, declare_tool_lint};

declare_clippy_lint! {
    /// **What it does:** Checks for division of integers
    ///
    /// **Why is this bad?** When outside of some very specific algorithms,
    /// integer division is very often a mistake because it discards the
    /// remainder.
    ///
    /// **Known problems:** None.
    ///
    /// **Example:**
    /// ```rust
    /// fn main() {
    ///     let x = 3 / 2;
    ///     println!("{}", x);
    /// }
    /// ```
    pub INTEGER_DIVISION,
    restriction,
    "integer division may cause loss of precision"
}

declare_lint_pass!(IntegerDivision => [INTEGER_DIVISION]);

impl<'a, 'tcx> LateLintPass<'a, 'tcx> for IntegerDivision {
    fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx hir::Expr<'_>) {
        if is_integer_division(cx, expr) {
            span_lint_and_help(
                cx,
                INTEGER_DIVISION,
                expr.span,
                "integer division",
                "division of integers may cause loss of precision. consider using floats.",
            );
        }
    }
}

fn is_integer_division<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'tcx hir::Expr<'_>) -> bool {
    if_chain! {
        if let hir::ExprKind::Binary(binop, left, right) = &expr.kind;
        if let hir::BinOpKind::Div = &binop.node;
        then {
            let (left_ty, right_ty) = (cx.tables.expr_ty(left), cx.tables.expr_ty(right));
            return left_ty.is_integral() && right_ty.is_integral();
        }
    }

    false
}