clippy_lints/src/approx_const.rs

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