2021-03-16 00:55:45 +00:00
|
|
|
use clippy_utils::diagnostics::span_lint_and_help;
|
2019-06-11 16:53:12 +00:00
|
|
|
use if_chain::if_chain;
|
2020-01-06 16:39:50 +00:00
|
|
|
use rustc_hir as hir;
|
2020-01-12 06:08:41 +00:00
|
|
|
use rustc_lint::{LateContext, LateLintPass};
|
2020-01-11 11:37:08 +00:00
|
|
|
use rustc_session::{declare_lint_pass, declare_tool_lint};
|
2019-06-11 16:53:12 +00:00
|
|
|
|
|
|
|
declare_clippy_lint! {
|
2021-07-02 18:37:11 +00:00
|
|
|
/// ### What it does
|
|
|
|
/// Checks for division of integers
|
2019-06-11 16:53:12 +00:00
|
|
|
///
|
2021-07-02 18:37:11 +00:00
|
|
|
/// ### Why is this bad?
|
|
|
|
/// When outside of some very specific algorithms,
|
2019-06-11 16:53:12 +00:00
|
|
|
/// integer division is very often a mistake because it discards the
|
|
|
|
/// remainder.
|
|
|
|
///
|
2021-07-02 18:37:11 +00:00
|
|
|
/// ### Example
|
2019-06-11 16:53:12 +00:00
|
|
|
/// ```rust
|
2020-06-09 14:36:01 +00:00
|
|
|
/// // Bad
|
|
|
|
/// let x = 3 / 2;
|
|
|
|
/// println!("{}", x);
|
|
|
|
///
|
|
|
|
/// // Good
|
|
|
|
/// let x = 3f32 / 2f32;
|
|
|
|
/// println!("{}", x);
|
2019-06-11 16:53:12 +00:00
|
|
|
/// ```
|
|
|
|
pub INTEGER_DIVISION,
|
2019-06-15 07:11:53 +00:00
|
|
|
restriction,
|
2019-06-11 16:53:12 +00:00
|
|
|
"integer division may cause loss of precision"
|
|
|
|
}
|
|
|
|
|
|
|
|
declare_lint_pass!(IntegerDivision => [INTEGER_DIVISION]);
|
|
|
|
|
2020-06-25 20:41:36 +00:00
|
|
|
impl<'tcx> LateLintPass<'tcx> for IntegerDivision {
|
|
|
|
fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx hir::Expr<'_>) {
|
2019-06-11 16:53:12 +00:00
|
|
|
if is_integer_division(cx, expr) {
|
2020-01-27 01:56:22 +00:00
|
|
|
span_lint_and_help(
|
2019-06-11 16:53:12 +00:00
|
|
|
cx,
|
|
|
|
INTEGER_DIVISION,
|
|
|
|
expr.span,
|
|
|
|
"integer division",
|
2020-04-18 10:28:29 +00:00
|
|
|
None,
|
2021-02-24 13:02:51 +00:00
|
|
|
"division of integers may cause loss of precision. consider using floats",
|
2019-06-11 16:53:12 +00:00
|
|
|
);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-06-25 20:41:36 +00:00
|
|
|
fn is_integer_division<'tcx>(cx: &LateContext<'tcx>, expr: &'tcx hir::Expr<'_>) -> bool {
|
2019-06-11 16:53:12 +00:00
|
|
|
if_chain! {
|
2019-09-27 15:16:06 +00:00
|
|
|
if let hir::ExprKind::Binary(binop, left, right) = &expr.kind;
|
2021-10-04 06:33:40 +00:00
|
|
|
if binop.node == hir::BinOpKind::Div;
|
2019-06-11 16:53:12 +00:00
|
|
|
then {
|
2020-07-17 08:47:04 +00:00
|
|
|
let (left_ty, right_ty) = (cx.typeck_results().expr_ty(left), cx.typeck_results().expr_ty(right));
|
2019-06-11 16:53:12 +00:00
|
|
|
return left_ty.is_integral() && right_ty.is_integral();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
false
|
|
|
|
}
|