2021-06-03 06:41:37 +00:00
|
|
|
use clippy_utils::consts::{constant_simple, Constant};
|
2021-03-25 18:29:11 +00:00
|
|
|
use clippy_utils::diagnostics::span_lint;
|
2022-02-12 11:44:28 +00:00
|
|
|
use clippy_utils::{match_trait_method, paths};
|
2020-08-11 13:43:21 +00:00
|
|
|
use if_chain::if_chain;
|
2020-02-21 08:39:38 +00:00
|
|
|
use rustc_hir::{Expr, ExprKind};
|
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};
|
2022-02-12 11:44:28 +00:00
|
|
|
use rustc_span::sym;
|
2018-06-19 05:37:09 +00:00
|
|
|
use std::cmp::Ordering;
|
2015-09-05 10:46:34 +00:00
|
|
|
|
2018-03-28 13:24:26 +00:00
|
|
|
declare_clippy_lint! {
|
2021-07-29 10:16:06 +00:00
|
|
|
/// ### What it does
|
|
|
|
/// Checks for expressions where `std::cmp::min` and `max` are
|
2019-03-05 16:50:33 +00:00
|
|
|
/// used to clamp values, but switched so that the result is constant.
|
|
|
|
///
|
2021-07-29 10:16:06 +00:00
|
|
|
/// ### Why is this bad?
|
|
|
|
/// This is in all probability not the intended outcome. At
|
2019-03-05 16:50:33 +00:00
|
|
|
/// the least it hurts readability of the code.
|
|
|
|
///
|
2021-07-29 10:16:06 +00:00
|
|
|
/// ### Example
|
2019-03-05 22:23:50 +00:00
|
|
|
/// ```ignore
|
2019-03-05 16:50:33 +00:00
|
|
|
/// min(0, max(100, x))
|
|
|
|
/// ```
|
2020-08-11 13:43:21 +00:00
|
|
|
/// or
|
|
|
|
/// ```ignore
|
|
|
|
/// x.max(100).min(0)
|
|
|
|
/// ```
|
2019-03-05 16:50:33 +00: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 11:33:31 +00:00
|
|
|
#[clippy::version = "pre 1.29.0"]
|
2016-08-06 08:18:36 +00:00
|
|
|
pub MIN_MAX,
|
2018-03-28 13:24:26 +00:00
|
|
|
correctness,
|
2016-02-05 23:13:29 +00:00
|
|
|
"`min(_, max(_, _))` (or vice versa) with bounds clamping the result to a constant"
|
|
|
|
}
|
2015-09-05 10:46:34 +00:00
|
|
|
|
2019-04-08 20:43:55 +00:00
|
|
|
declare_lint_pass!(MinMaxPass => [MIN_MAX]);
|
2015-09-05 10:46:34 +00:00
|
|
|
|
2020-06-25 20:41:36 +00:00
|
|
|
impl<'tcx> LateLintPass<'tcx> for MinMaxPass {
|
|
|
|
fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) {
|
2015-11-11 16:08:33 +00:00
|
|
|
if let Some((outer_max, outer_c, oe)) = min_max(cx, expr) {
|
2018-06-16 16:33:11 +00:00
|
|
|
if let Some((inner_max, inner_c, ie)) = min_max(cx, oe) {
|
2016-01-04 04:26:12 +00:00
|
|
|
if outer_max == inner_max {
|
|
|
|
return;
|
|
|
|
}
|
2018-06-16 16:33:11 +00:00
|
|
|
match (
|
|
|
|
outer_max,
|
2020-07-17 08:47:04 +00:00
|
|
|
Constant::partial_cmp(cx.tcx, cx.typeck_results().expr_ty(ie), &outer_c, &inner_c),
|
2018-06-16 16:33:11 +00:00
|
|
|
) {
|
2017-09-05 09:33:04 +00:00
|
|
|
(_, None) | (MinMax::Max, Some(Ordering::Less)) | (MinMax::Min, Some(Ordering::Greater)) => (),
|
2015-09-05 10:46:34 +00:00
|
|
|
_ => {
|
2018-06-16 16:33:11 +00:00
|
|
|
span_lint(
|
|
|
|
cx,
|
|
|
|
MIN_MAX,
|
|
|
|
expr.span,
|
2020-01-06 06:30:43 +00:00
|
|
|
"this `min`/`max` combination leads to constant result",
|
2018-06-16 16:33:11 +00:00
|
|
|
);
|
2016-12-20 17:21:30 +00:00
|
|
|
},
|
2015-09-05 10:46:34 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-07-14 12:59:59 +00:00
|
|
|
#[derive(PartialEq, Eq, Debug, Clone, Copy)]
|
2015-09-05 10:46:34 +00:00
|
|
|
enum MinMax {
|
|
|
|
Min,
|
|
|
|
Max,
|
|
|
|
}
|
|
|
|
|
2020-06-25 20:41:36 +00:00
|
|
|
fn min_max<'a>(cx: &LateContext<'_>, expr: &'a Expr<'a>) -> Option<(MinMax, Constant, &'a Expr<'a>)> {
|
2020-08-11 13:43:21 +00:00
|
|
|
match expr.kind {
|
2021-04-08 15:50:13 +00:00
|
|
|
ExprKind::Call(path, args) => {
|
2020-08-11 13:43:21 +00:00
|
|
|
if let ExprKind::Path(ref qpath) = path.kind {
|
|
|
|
cx.typeck_results()
|
|
|
|
.qpath_res(qpath, path.hir_id)
|
|
|
|
.opt_def_id()
|
2022-02-12 11:44:28 +00:00
|
|
|
.and_then(|def_id| match cx.tcx.get_diagnostic_name(def_id) {
|
|
|
|
Some(sym::cmp_min) => fetch_const(cx, args, MinMax::Min),
|
|
|
|
Some(sym::cmp_max) => fetch_const(cx, args, MinMax::Max),
|
|
|
|
_ => None,
|
2020-08-11 13:43:21 +00:00
|
|
|
})
|
|
|
|
} else {
|
|
|
|
None
|
|
|
|
}
|
|
|
|
},
|
2021-12-01 17:17:50 +00:00
|
|
|
ExprKind::MethodCall(path, args, _) => {
|
2020-08-11 13:43:21 +00:00
|
|
|
if_chain! {
|
|
|
|
if let [obj, _] = args;
|
|
|
|
if cx.typeck_results().expr_ty(obj).is_floating_point() || match_trait_method(cx, expr, &paths::ORD);
|
|
|
|
then {
|
2021-01-15 09:56:44 +00:00
|
|
|
if path.ident.name == sym!(max) {
|
2020-06-25 23:56:23 +00:00
|
|
|
fetch_const(cx, args, MinMax::Max)
|
2021-01-15 09:56:44 +00:00
|
|
|
} else if path.ident.name == sym!(min) {
|
2020-08-11 13:43:21 +00:00
|
|
|
fetch_const(cx, args, MinMax::Min)
|
2020-06-25 23:56:23 +00:00
|
|
|
} else {
|
|
|
|
None
|
|
|
|
}
|
2020-08-11 13:43:21 +00:00
|
|
|
} else {
|
|
|
|
None
|
|
|
|
}
|
|
|
|
}
|
|
|
|
},
|
|
|
|
_ => None,
|
2016-01-04 04:26:12 +00:00
|
|
|
}
|
|
|
|
}
|
2015-09-05 10:46:34 +00:00
|
|
|
|
2020-06-25 20:41:36 +00:00
|
|
|
fn fetch_const<'a>(cx: &LateContext<'_>, args: &'a [Expr<'a>], m: MinMax) -> Option<(MinMax, Constant, &'a Expr<'a>)> {
|
2016-01-04 04:26:12 +00:00
|
|
|
if args.len() != 2 {
|
|
|
|
return None;
|
|
|
|
}
|
2020-07-17 08:47:04 +00:00
|
|
|
constant_simple(cx, cx.typeck_results(), &args[0]).map_or_else(
|
|
|
|
|| constant_simple(cx, cx.typeck_results(), &args[1]).map(|c| (m, c, &args[0])),
|
2020-07-14 12:59:59 +00:00
|
|
|
|c| {
|
2020-07-17 08:47:04 +00:00
|
|
|
if constant_simple(cx, cx.typeck_results(), &args[1]).is_none() {
|
2020-07-14 12:59:59 +00:00
|
|
|
// otherwise ignore
|
|
|
|
Some((m, c, &args[1]))
|
|
|
|
} else {
|
|
|
|
None
|
|
|
|
}
|
|
|
|
},
|
|
|
|
)
|
2015-09-05 10:46:34 +00:00
|
|
|
}
|