2021-06-03 01:41:37 -05:00
|
|
|
use clippy_utils::consts::{constant_simple, Constant};
|
2021-03-25 13:29:11 -05:00
|
|
|
use clippy_utils::diagnostics::span_lint;
|
2021-11-11 13:15:01 -06:00
|
|
|
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};
|
2022-02-26 07:26:21 -06:00
|
|
|
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! {
|
2021-07-29 05:16:06 -05:00
|
|
|
/// ### What it does
|
|
|
|
/// Checks for expressions where `std::cmp::min` and `max` are
|
2019-03-05 10:50:33 -06:00
|
|
|
/// used to clamp values, but switched so that the result is constant.
|
|
|
|
///
|
2021-07-29 05:16:06 -05:00
|
|
|
/// ### Why is this bad?
|
|
|
|
/// This is in all probability not the intended outcome. At
|
2019-03-05 10:50:33 -06:00
|
|
|
/// the least it hurts readability of the code.
|
|
|
|
///
|
2021-07-29 05:16:06 -05:00
|
|
|
/// ### Example
|
2022-06-04 06:34:07 -05:00
|
|
|
/// ```rust,ignore
|
2019-03-05 10:50:33 -06:00
|
|
|
/// min(0, max(100, x))
|
2022-06-04 06:34:07 -05:00
|
|
|
///
|
|
|
|
/// // or
|
|
|
|
///
|
2020-08-11 08:43:21 -05:00
|
|
|
/// x.max(100).min(0)
|
|
|
|
/// ```
|
2019-03-05 10:50:33 -06:00
|
|
|
/// 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`.
|
2021-12-06 05:33:31 -06:00
|
|
|
#[clippy::version = "pre 1.29.0"]
|
2016-08-06 03:18:36 -05:00
|
|
|
pub MIN_MAX,
|
2018-03-28 08:24:26 -05:00
|
|
|
correctness,
|
2016-02-05 17:13:29 -06:00
|
|
|
"`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
|
|
|
|
2020-06-25 15:41:36 -05:00
|
|
|
impl<'tcx> LateLintPass<'tcx> for MinMaxPass {
|
|
|
|
fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) {
|
2015-11-11 10:08:33 -06:00
|
|
|
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
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-07-14 07:59:59 -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>)> {
|
2020-08-11 08:43:21 -05:00
|
|
|
match expr.kind {
|
2021-04-08 10:50:13 -05:00
|
|
|
ExprKind::Call(path, args) => {
|
2020-08-11 08:43:21 -05:00
|
|
|
if let ExprKind::Path(ref qpath) = path.kind {
|
|
|
|
cx.typeck_results()
|
|
|
|
.qpath_res(qpath, path.hir_id)
|
|
|
|
.opt_def_id()
|
2022-02-26 07:26:21 -06:00
|
|
|
.and_then(|def_id| match cx.tcx.get_diagnostic_name(def_id) {
|
2022-09-01 04:43:35 -05:00
|
|
|
Some(sym::cmp_min) => fetch_const(cx, None, args, MinMax::Min),
|
|
|
|
Some(sym::cmp_max) => fetch_const(cx, None, args, MinMax::Max),
|
2022-02-26 07:26:21 -06:00
|
|
|
_ => None,
|
2020-08-11 08:43:21 -05:00
|
|
|
})
|
|
|
|
} else {
|
|
|
|
None
|
|
|
|
}
|
|
|
|
},
|
2022-09-01 04:43:35 -05:00
|
|
|
ExprKind::MethodCall(path, receiver, args @ [_], _) => {
|
2021-11-11 13:15:01 -06:00
|
|
|
if cx.typeck_results().expr_ty(receiver).is_floating_point() || is_trait_method(cx, expr, sym::Ord) {
|
2022-09-08 14:27:09 -05:00
|
|
|
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)
|
2020-08-11 08:43:21 -05:00
|
|
|
} else {
|
|
|
|
None
|
|
|
|
}
|
2022-09-08 14:27:09 -05:00
|
|
|
} else {
|
|
|
|
None
|
2020-08-11 08:43:21 -05:00
|
|
|
}
|
|
|
|
},
|
|
|
|
_ => 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>,
|
2022-09-01 04:43:35 -05:00
|
|
|
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>)> {
|
2022-09-08 14:27:09 -05:00
|
|
|
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;
|
|
|
|
}
|
2022-09-08 14:27:09 -05:00
|
|
|
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)),
|
2020-07-14 07:59:59 -05:00
|
|
|
|c| {
|
2022-09-08 14:27:09 -05:00
|
|
|
if constant_simple(cx, cx.typeck_results(), second_arg).is_none() {
|
2020-07-14 07:59:59 -05:00
|
|
|
// otherwise ignore
|
2022-09-08 14:27:09 -05:00
|
|
|
Some((m, c, second_arg))
|
2020-07-14 07:59:59 -05:00
|
|
|
} else {
|
|
|
|
None
|
|
|
|
}
|
|
|
|
},
|
|
|
|
)
|
2015-09-05 05:46:34 -05:00
|
|
|
}
|