rust/clippy_lints/src/minmax.rs

103 lines
3.3 KiB
Rust
Raw Normal View History

2018-05-30 03:15:50 -05:00
use crate::consts::{constant_simple, Constant};
2019-05-14 03:06:21 -05:00
use crate::utils::{match_def_path, paths, span_lint};
2020-01-06 10:39:50 -06:00
use rustc_hir::*;
2020-01-12 00:08:41 -06:00
use rustc_lint::{LateContext, LateLintPass};
2020-01-11 05:37:08 -06:00
use rustc_session::{declare_lint_pass, declare_tool_lint};
2018-06-19 00:37:09 -05:00
use std::cmp::Ordering;
2015-09-05 05:46:34 -05:00
2018-03-28 08:24:26 -05:00
declare_clippy_lint! {
/// **What it does:** Checks for expressions where `std::cmp::min` and `max` are
/// used to clamp values, but switched so that the result is constant.
///
/// **Why is this bad?** This is in all probability not the intended outcome. At
/// the least it hurts readability of the code.
///
/// **Known problems:** None
///
/// **Example:**
2019-03-05 16:23:50 -06:00
/// ```ignore
/// min(0, max(100, x))
/// ```
/// It will always be equal to `0`. Probably the author meant to clamp the value
/// between 0 and 100, but has erroneously swapped `min` and `max`.
pub MIN_MAX,
2018-03-28 08:24:26 -05:00
correctness,
"`min(_, max(_, _))` (or vice versa) with bounds clamping the result to a constant"
}
2015-09-05 05:46:34 -05:00
2019-04-08 15:43:55 -05:00
declare_lint_pass!(MinMaxPass => [MIN_MAX]);
2015-09-05 05:46:34 -05:00
impl<'a, 'tcx> LateLintPass<'a, 'tcx> for MinMaxPass {
2019-12-27 01:12:26 -06:00
fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr<'_>) {
if let Some((outer_max, outer_c, oe)) = min_max(cx, expr) {
2018-06-16 11:33:11 -05:00
if let Some((inner_max, inner_c, ie)) = min_max(cx, oe) {
2016-01-03 22:26:12 -06:00
if outer_max == inner_max {
return;
}
2018-06-16 11:33:11 -05:00
match (
outer_max,
2018-12-04 17:14:44 -06:00
Constant::partial_cmp(cx.tcx, cx.tables.expr_ty(ie), &outer_c, &inner_c),
2018-06-16 11:33:11 -05:00
) {
2017-09-05 04:33:04 -05:00
(_, None) | (MinMax::Max, Some(Ordering::Less)) | (MinMax::Min, Some(Ordering::Greater)) => (),
2015-09-05 05:46:34 -05:00
_ => {
2018-06-16 11:33:11 -05:00
span_lint(
cx,
MIN_MAX,
expr.span,
2020-01-06 00:30:43 -06:00
"this `min`/`max` combination leads to constant result",
2018-06-16 11:33:11 -05:00
);
2016-12-20 11:21:30 -06:00
},
2015-09-05 05:46:34 -05:00
}
}
}
}
}
#[derive(PartialEq, Eq, Debug)]
enum MinMax {
Min,
Max,
}
2019-12-27 01:12:26 -06:00
fn min_max<'a>(cx: &LateContext<'_, '_>, expr: &'a Expr<'a>) -> Option<(MinMax, Constant, &'a Expr<'a>)> {
2019-09-27 10:16:06 -05:00
if let ExprKind::Call(ref path, ref args) = expr.kind {
if let ExprKind::Path(ref qpath) = path.kind {
cx.tables.qpath_res(qpath, path.hir_id).opt_def_id().and_then(|def_id| {
2019-05-17 16:53:54 -05:00
if match_def_path(cx, def_id, &paths::CMP_MIN) {
2017-09-12 07:26:40 -05:00
fetch_const(cx, args, MinMax::Min)
2019-05-17 16:53:54 -05:00
} else if match_def_path(cx, def_id, &paths::CMP_MAX) {
2017-09-12 07:26:40 -05:00
fetch_const(cx, args, MinMax::Max)
} else {
None
}
})
2016-01-03 22:26:12 -06:00
} else {
None
}
} else {
None
}
}
2015-09-05 05:46:34 -05:00
2019-12-27 01:12:26 -06:00
fn fetch_const<'a>(
cx: &LateContext<'_, '_>,
args: &'a [Expr<'a>],
m: MinMax,
) -> Option<(MinMax, Constant, &'a Expr<'a>)> {
2016-01-03 22:26:12 -06:00
if args.len() != 2 {
return None;
}
2018-05-13 06:16:31 -05:00
if let Some(c) = constant_simple(cx, cx.tables, &args[0]) {
if constant_simple(cx, cx.tables, &args[1]).is_none() {
2016-01-03 22:26:12 -06:00
// otherwise ignore
2015-09-05 05:46:34 -05:00
Some((m, c, &args[1]))
2016-01-03 22:26:12 -06:00
} else {
None
}
2018-05-13 06:16:31 -05:00
} else if let Some(c) = constant_simple(cx, cx.tables, &args[1]) {
2016-06-21 16:53:24 -05:00
Some((m, c, &args[0]))
2015-09-05 05:46:34 -05:00
} else {
2016-06-21 16:53:24 -05:00
None
2015-09-05 05:46:34 -05:00
}
}