clippy_lints/src/approx_const.rs

   1 use crate::utils::span_lint;
   2 use rustc::hir::*;
   3 use rustc::lint::{LateContext, LateLintPass, LintArray, LintPass};
   4 use rustc::{declare_tool_lint, lint_array};
   5 use std::f64::consts as f64;
   6 use syntax::ast::{FloatTy, Lit, LitKind};
   7 use syntax::symbol;
   8
   9 declare_clippy_lint! {
  10     /// **What it does:** Checks for floating point literals that approximate
  11     /// constants which are defined in
  12     /// [`std::f32::consts`](https://doc.rust-lang.org/stable/std/f32/consts/#constants)
  13     /// or
  14     /// [`std::f64::consts`](https://doc.rust-lang.org/stable/std/f64/consts/#constants),
  15     /// respectively, suggesting to use the predefined constant.
  16     ///
  17     /// **Why is this bad?** Usually, the definition in the standard library is more
  18     /// precise than what people come up with. If you find that your definition is
  19     /// actually more precise, please [file a Rust
  20     /// issue](https://github.com/rust-lang/rust/issues).
  21     ///
  22     /// **Known problems:** If you happen to have a value that is within 1/8192 of a
  23     /// known constant, but is not *and should not* be the same, this lint will
  24     /// report your value anyway. We have not yet noticed any false positives in
  25     /// code we tested clippy with (this includes servo), but YMMV.
  26     ///
  27     /// **Example:**
  28     /// ```rust
  29     /// let x = 3.14;
  30     /// ```
  31     pub APPROX_CONSTANT,
  32     correctness,
  33     "the approximate of a known float constant (in `std::fXX::consts`)"
  34 }
  35
  36 // Tuples are of the form (constant, name, min_digits)
  37 const KNOWN_CONSTS: &[(f64, &str, usize)] = &[
  38     (f64::E, "E", 4),
  39     (f64::FRAC_1_PI, "FRAC_1_PI", 4),
  40     (f64::FRAC_1_SQRT_2, "FRAC_1_SQRT_2", 5),
  41     (f64::FRAC_2_PI, "FRAC_2_PI", 5),
  42     (f64::FRAC_2_SQRT_PI, "FRAC_2_SQRT_PI", 5),
  43     (f64::FRAC_PI_2, "FRAC_PI_2", 5),
  44     (f64::FRAC_PI_3, "FRAC_PI_3", 5),
  45     (f64::FRAC_PI_4, "FRAC_PI_4", 5),
  46     (f64::FRAC_PI_6, "FRAC_PI_6", 5),
  47     (f64::FRAC_PI_8, "FRAC_PI_8", 5),
  48     (f64::LN_10, "LN_10", 5),
  49     (f64::LN_2, "LN_2", 5),
  50     (f64::LOG10_E, "LOG10_E", 5),
  51     (f64::LOG2_E, "LOG2_E", 5),
  52     (f64::PI, "PI", 3),
  53     (f64::SQRT_2, "SQRT_2", 5),
  54 ];
  55
  56 #[derive(Copy, Clone)]
  57 pub struct Pass;
  58
  59 impl LintPass for Pass {
  60     fn get_lints(&self) -> LintArray {
  61         lint_array!(APPROX_CONSTANT)
  62     }
  63
  64     fn name(&self) -> &'static str {
  65         "ApproxConstant"
  66     }
  67 }
  68
  69 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for Pass {
  70     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, e: &'tcx Expr) {
  71         if let ExprKind::Lit(lit) = &e.node {
  72             check_lit(cx, lit, e);
  73         }
  74     }
  75 }
  76
  77 fn check_lit(cx: &LateContext<'_, '_>, lit: &Lit, e: &Expr) {
  78     match lit.node {
  79         LitKind::Float(s, FloatTy::F32) => check_known_consts(cx, e, s, "f32"),
  80         LitKind::Float(s, FloatTy::F64) => check_known_consts(cx, e, s, "f64"),
  81         LitKind::FloatUnsuffixed(s) => check_known_consts(cx, e, s, "f{32, 64}"),
  82         _ => (),
  83     }
  84 }
  85
  86 fn check_known_consts(cx: &LateContext<'_, '_>, e: &Expr, s: symbol::Symbol, module: &str) {
  87     let s = s.as_str();
  88     if s.parse::<f64>().is_ok() {
  89         for &(constant, name, min_digits) in KNOWN_CONSTS {
  90             if is_approx_const(constant, &s, min_digits) {
  91                 span_lint(
  92                     cx,
  93                     APPROX_CONSTANT,
  94                     e.span,
  95                     &format!(
  96                         "approximate value of `{}::consts::{}` found. \
  97                          Consider using it directly",
  98                         module, &name
  99                     ),
 100                 );
 101                 return;
 102             }
 103         }
 104     }
 105 }
 106
 107 /// Returns `false` if the number of significant figures in `value` are
 108 /// less than `min_digits`; otherwise, returns true if `value` is equal
 109 /// to `constant`, rounded to the number of digits present in `value`.
 110 fn is_approx_const(constant: f64, value: &str, min_digits: usize) -> bool {
 111     if value.len() <= min_digits {
 112         false
 113     } else {
 114         let round_const = format!("{:.*}", value.len() - 2, constant);
 115
 116         let mut trunc_const = constant.to_string();
 117         if trunc_const.len() > value.len() {
 118             trunc_const.truncate(value.len());
 119         }
 120
 121         (value == round_const) || (value == trunc_const)
 122     }
 123 }