clippy_lints/src/replace_consts.rs

   1 use crate::utils::{match_def_path, span_lint_and_sugg};
   2 use if_chain::if_chain;
   3 use rustc::declare_lint_pass;
   4 use rustc::hir;
   5 use rustc::hir::def::{DefKind, Res};
   6 use rustc::lint::{LateContext, LateLintPass, LintArray, LintPass};
   7 use rustc_errors::Applicability;
   8 use rustc_session::declare_tool_lint;
   9
  10 declare_clippy_lint! {
  11     /// **What it does:** Checks for usage of `ATOMIC_X_INIT`, `ONCE_INIT`, and
  12     /// `uX/iX::MIN/MAX`.
  13     ///
  14     /// **Why is this bad?** `const fn`s exist
  15     ///
  16     /// **Known problems:** None.
  17     ///
  18     /// **Example:**
  19     /// ```rust
  20     /// # use core::sync::atomic::{ATOMIC_ISIZE_INIT, AtomicIsize};
  21     /// static FOO: AtomicIsize = ATOMIC_ISIZE_INIT;
  22     /// ```
  23     ///
  24     /// Could be written:
  25     ///
  26     /// ```rust
  27     /// # use core::sync::atomic::AtomicIsize;
  28     /// static FOO: AtomicIsize = AtomicIsize::new(0);
  29     /// ```
  30     pub REPLACE_CONSTS,
  31     pedantic,
  32     "Lint usages of standard library `const`s that could be replaced by `const fn`s"
  33 }
  34
  35 declare_lint_pass!(ReplaceConsts => [REPLACE_CONSTS]);
  36
  37 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for ReplaceConsts {
  38     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx hir::Expr<'_>) {
  39         if_chain! {
  40             if let hir::ExprKind::Path(ref qp) = expr.kind;
  41             if let Res::Def(DefKind::Const, def_id) = cx.tables.qpath_res(qp, expr.hir_id);
  42             then {
  43                 for &(ref const_path, repl_snip) in &REPLACEMENTS {
  44                     if match_def_path(cx, def_id, const_path) {
  45                         span_lint_and_sugg(
  46                             cx,
  47                             REPLACE_CONSTS,
  48                             expr.span,
  49                             &format!("using `{}`", const_path.last().expect("empty path")),
  50                             "try this",
  51                             repl_snip.to_string(),
  52                             Applicability::MachineApplicable,
  53                         );
  54                         return;
  55                     }
  56                 }
  57             }
  58         }
  59     }
  60 }
  61
  62 const REPLACEMENTS: [([&str; 3], &str); 24] = [
  63     // Min
  64     (["core", "isize", "MIN"], "isize::min_value()"),
  65     (["core", "i8", "MIN"], "i8::min_value()"),
  66     (["core", "i16", "MIN"], "i16::min_value()"),
  67     (["core", "i32", "MIN"], "i32::min_value()"),
  68     (["core", "i64", "MIN"], "i64::min_value()"),
  69     (["core", "i128", "MIN"], "i128::min_value()"),
  70     (["core", "usize", "MIN"], "usize::min_value()"),
  71     (["core", "u8", "MIN"], "u8::min_value()"),
  72     (["core", "u16", "MIN"], "u16::min_value()"),
  73     (["core", "u32", "MIN"], "u32::min_value()"),
  74     (["core", "u64", "MIN"], "u64::min_value()"),
  75     (["core", "u128", "MIN"], "u128::min_value()"),
  76     // Max
  77     (["core", "isize", "MAX"], "isize::max_value()"),
  78     (["core", "i8", "MAX"], "i8::max_value()"),
  79     (["core", "i16", "MAX"], "i16::max_value()"),
  80     (["core", "i32", "MAX"], "i32::max_value()"),
  81     (["core", "i64", "MAX"], "i64::max_value()"),
  82     (["core", "i128", "MAX"], "i128::max_value()"),
  83     (["core", "usize", "MAX"], "usize::max_value()"),
  84     (["core", "u8", "MAX"], "u8::max_value()"),
  85     (["core", "u16", "MAX"], "u16::max_value()"),
  86     (["core", "u32", "MAX"], "u32::max_value()"),
  87     (["core", "u64", "MAX"], "u64::max_value()"),
  88     (["core", "u128", "MAX"], "u128::max_value()"),
  89 ];