clippy_lints/src/minmax.rs

   1 use crate::consts::{constant_simple, Constant};
   2 use crate::utils::{match_def_path, opt_def_id, paths, span_lint};
   3 use rustc::hir::*;
   4 use rustc::lint::{LateContext, LateLintPass, LintArray, LintPass};
   5 use rustc::{declare_tool_lint, lint_array};
   6 use std::cmp::Ordering;
   7
   8 /// **What it does:** Checks for expressions where `std::cmp::min` and `max` are
   9 /// used to clamp values, but switched so that the result is constant.
  10 ///
  11 /// **Why is this bad?** This is in all probability not the intended outcome. At
  12 /// the least it hurts readability of the code.
  13 ///
  14 /// **Known problems:** None
  15 ///
  16 /// **Example:**
  17 /// ```rust
  18 /// min(0, max(100, x))
  19 /// ```
  20 /// It will always be equal to `0`. Probably the author meant to clamp the value
  21 /// between 0 and 100, but has erroneously swapped `min` and `max`.
  22 declare_clippy_lint! {
  23     pub MIN_MAX,
  24     correctness,
  25     "`min(_, max(_, _))` (or vice versa) with bounds clamping the result to a constant"
  26 }
  27
  28 #[allow(missing_copy_implementations)]
  29 pub struct MinMaxPass;
  30
  31 impl LintPass for MinMaxPass {
  32     fn get_lints(&self) -> LintArray {
  33         lint_array!(MIN_MAX)
  34     }
  35 }
  36
  37 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for MinMaxPass {
  38     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
  39         if let Some((outer_max, outer_c, oe)) = min_max(cx, expr) {
  40             if let Some((inner_max, inner_c, ie)) = min_max(cx, oe) {
  41                 if outer_max == inner_max {
  42                     return;
  43                 }
  44                 match (
  45                     outer_max,
  46                     Constant::partial_cmp(cx.tcx, &cx.tables.expr_ty(ie).sty, &outer_c, &inner_c),
  47                 ) {
  48                     (_, None) | (MinMax::Max, Some(Ordering::Less)) | (MinMax::Min, Some(Ordering::Greater)) => (),
  49                     _ => {
  50                         span_lint(
  51                             cx,
  52                             MIN_MAX,
  53                             expr.span,
  54                             "this min/max combination leads to constant result",
  55                         );
  56                     },
  57                 }
  58             }
  59         }
  60     }
  61 }
  62
  63 #[derive(PartialEq, Eq, Debug)]
  64 enum MinMax {
  65     Min,
  66     Max,
  67 }
  68
  69 fn min_max<'a>(cx: &LateContext<'_, '_>, expr: &'a Expr) -> Option<(MinMax, Constant, &'a Expr)> {
  70     if let ExprKind::Call(ref path, ref args) = expr.node {
  71         if let ExprKind::Path(ref qpath) = path.node {
  72             opt_def_id(cx.tables.qpath_def(qpath, path.hir_id)).and_then(|def_id| {
  73                 if match_def_path(cx.tcx, def_id, &paths::CMP_MIN) {
  74                     fetch_const(cx, args, MinMax::Min)
  75                 } else if match_def_path(cx.tcx, def_id, &paths::CMP_MAX) {
  76                     fetch_const(cx, args, MinMax::Max)
  77                 } else {
  78                     None
  79                 }
  80             })
  81         } else {
  82             None
  83         }
  84     } else {
  85         None
  86     }
  87 }
  88
  89 fn fetch_const<'a>(cx: &LateContext<'_, '_>, args: &'a [Expr], m: MinMax) -> Option<(MinMax, Constant, &'a Expr)> {
  90     if args.len() != 2 {
  91         return None;
  92     }
  93     if let Some(c) = constant_simple(cx, cx.tables, &args[0]) {
  94         if constant_simple(cx, cx.tables, &args[1]).is_none() {
  95             // otherwise ignore
  96             Some((m, c, &args[1]))
  97         } else {
  98             None
  99         }
 100     } else if let Some(c) = constant_simple(cx, cx.tables, &args[1]) {
 101         Some((m, c, &args[0]))
 102     } else {
 103         None
 104     }
 105 }