rust/clippy_lints/src/minmax.rs

126 lines
4.3 KiB
Rust
Raw Normal View History

use clippy_utils::consts::{constant_simple, Constant};
use clippy_utils::diagnostics::span_lint;
use clippy_utils::is_trait_method;
2020-02-21 02:39:38 -06:00
use rustc_hir::{Expr, ExprKind};
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};
use rustc_span::sym;
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.
///
/// ### Example
/// ```rust,ignore
/// min(0, max(100, x))
///
/// // or
///
/// x.max(100).min(0)
/// ```
/// 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`.
#[clippy::version = "pre 1.29.0"]
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<'tcx> LateLintPass<'tcx> for MinMaxPass {
fn check_expr(&mut self, cx: &LateContext<'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,
2020-07-17 03:47:04 -05:00
Constant::partial_cmp(cx.tcx, cx.typeck_results().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, Clone, Copy)]
2015-09-05 05:46:34 -05:00
enum MinMax {
Min,
Max,
}
2023-06-17 15:03:31 -05:00
fn min_max<'a, 'tcx>(cx: &LateContext<'tcx>, expr: &'a Expr<'a>) -> Option<(MinMax, Constant<'tcx>, &'a Expr<'a>)> {
match expr.kind {
ExprKind::Call(path, args) => {
if let ExprKind::Path(ref qpath) = path.kind {
cx.typeck_results()
.qpath_res(qpath, path.hir_id)
.opt_def_id()
.and_then(|def_id| match cx.tcx.get_diagnostic_name(def_id) {
Some(sym::cmp_min) => fetch_const(cx, None, args, MinMax::Min),
Some(sym::cmp_max) => fetch_const(cx, None, args, MinMax::Max),
_ => None,
})
} else {
None
}
},
ExprKind::MethodCall(path, receiver, args @ [_], _) => {
if cx.typeck_results().expr_ty(receiver).is_floating_point() || is_trait_method(cx, expr, sym::Ord) {
if path.ident.name == sym!(max) {
fetch_const(cx, Some(receiver), args, MinMax::Max)
} else if path.ident.name == sym!(min) {
fetch_const(cx, Some(receiver), args, MinMax::Min)
} else {
None
}
} else {
None
}
},
_ => None,
2016-01-03 22:26:12 -06:00
}
}
2015-09-05 05:46:34 -05:00
2023-06-17 15:03:31 -05:00
fn fetch_const<'a, 'tcx>(
cx: &LateContext<'tcx>,
receiver: Option<&'a Expr<'a>>,
args: &'a [Expr<'a>],
m: MinMax,
2023-06-17 15:03:31 -05:00
) -> Option<(MinMax, Constant<'tcx>, &'a Expr<'a>)> {
let mut args = receiver.into_iter().chain(args);
let first_arg = args.next()?;
let second_arg = args.next()?;
2022-09-02 08:48:14 -05:00
if args.next().is_some() {
2016-01-03 22:26:12 -06:00
return None;
}
constant_simple(cx, cx.typeck_results(), first_arg).map_or_else(
|| constant_simple(cx, cx.typeck_results(), second_arg).map(|c| (m, c, first_arg)),
|c| {
if constant_simple(cx, cx.typeck_results(), second_arg).is_none() {
// otherwise ignore
Some((m, c, second_arg))
} else {
None
}
},
)
2015-09-05 05:46:34 -05:00
}