clippy_lints/src/misc.rs

   1 use reexport::*;
   2 use rustc::hir::*;
   3 use rustc::hir::intravisit::FnKind;
   4 use rustc::lint::*;
   5 use rustc::middle::const_val::ConstVal;
   6 use rustc::ty;
   7 use rustc_const_eval::EvalHint::ExprTypeChecked;
   8 use rustc_const_eval::eval_const_expr_partial;
   9 use rustc_const_math::ConstFloat;
  10 use syntax::codemap::{Span, Spanned, ExpnFormat};
  11 use utils::{get_item_name, get_parent_expr, implements_trait, in_macro, is_integer_literal, match_path, snippet,
  12             span_lint, span_lint_and_then, walk_ptrs_ty, last_path_segment};
  13 use utils::sugg::Sugg;
  14
  15 /// **What it does:** Checks for function arguments and let bindings denoted as `ref`.
  16 ///
  17 /// **Why is this bad?** The `ref` declaration makes the function take an owned
  18 /// value, but turns the argument into a reference (which means that the value
  19 /// is destroyed when exiting the function). This adds not much value: either
  20 /// take a reference type, or take an owned value and create references in the
  21 /// body.
  22 ///
  23 /// For let bindings, `let x = &foo;` is preferred over `let ref x = foo`. The
  24 /// type of `x` is more obvious with the former.
  25 ///
  26 /// **Known problems:** If the argument is dereferenced within the function,
  27 /// removing the `ref` will lead to errors. This can be fixed by removing the
  28 /// dereferences, e.g. changing `*x` to `x` within the function.
  29 ///
  30 /// **Example:**
  31 /// ```rust
  32 /// fn foo(ref x: u8) -> bool { .. }
  33 /// ```
  34 declare_lint! {
  35     pub TOPLEVEL_REF_ARG,
  36     Warn,
  37     "an entire binding declared as `ref`, in a function argument or a `let` statement"
  38 }
  39
  40 /// **What it does:** Checks for comparisons to NaN.
  41 ///
  42 /// **Why is this bad?** NaN does not compare meaningfully to anything – not
  43 /// even itself – so those comparisons are simply wrong.
  44 ///
  45 /// **Known problems:** None.
  46 ///
  47 /// **Example:**
  48 /// ```rust
  49 /// x == NAN
  50 /// ```
  51 declare_lint! {
  52     pub CMP_NAN,
  53     Deny,
  54     "comparisons to NAN, which will always return false, probably not intended"
  55 }
  56
  57 /// **What it does:** Checks for (in-)equality comparisons on floating-point
  58 /// values (apart from zero), except in functions called `*eq*` (which probably
  59 /// implement equality for a type involving floats).
  60 ///
  61 /// **Why is this bad?** Floating point calculations are usually imprecise, so
  62 /// asking if two values are *exactly* equal is asking for trouble. For a good
  63 /// guide on what to do, see [the floating point
  64 /// guide](http://www.floating-point-gui.de/errors/comparison).
  65 ///
  66 /// **Known problems:** None.
  67 ///
  68 /// **Example:**
  69 /// ```rust
  70 /// y == 1.23f64
  71 /// y != x  // where both are floats
  72 /// ```
  73 declare_lint! {
  74     pub FLOAT_CMP,
  75     Warn,
  76     "using `==` or `!=` on float values instead of comparing difference with an epsilon"
  77 }
  78
  79 /// **What it does:** Checks for conversions to owned values just for the sake
  80 /// of a comparison.
  81 ///
  82 /// **Why is this bad?** The comparison can operate on a reference, so creating
  83 /// an owned value effectively throws it away directly afterwards, which is
  84 /// needlessly consuming code and heap space.
  85 ///
  86 /// **Known problems:** None.
  87 ///
  88 /// **Example:**
  89 /// ```rust
  90 /// x.to_owned() == y
  91 /// ```
  92 declare_lint! {
  93     pub CMP_OWNED,
  94     Warn,
  95     "creating owned instances for comparing with others, e.g. `x == \"foo\".to_string()`"
  96 }
  97
  98 /// **What it does:** Checks for getting the remainder of a division by one.
  99 ///
 100 /// **Why is this bad?** The result can only ever be zero. No one will write
 101 /// such code deliberately, unless trying to win an Underhanded Rust
 102 /// Contest. Even for that contest, it's probably a bad idea. Use something more
 103 /// underhanded.
 104 ///
 105 /// **Known problems:** None.
 106 ///
 107 /// **Example:**
 108 /// ```rust
 109 /// x % 1
 110 /// ```
 111 declare_lint! {
 112     pub MODULO_ONE,
 113     Warn,
 114     "taking a number modulo 1, which always returns 0"
 115 }
 116
 117 /// **What it does:** Checks for patterns in the form `name @ _`.
 118 ///
 119 /// **Why is this bad?** It's almost always more readable to just use direct bindings.
 120 ///
 121 /// **Known problems:** None.
 122 ///
 123 /// **Example:**
 124 /// ```rust
 125 /// match v {
 126 ///     Some(x) => (),
 127 ///     y @ _   => (), // easier written as `y`,
 128 /// }
 129 /// ```
 130 declare_lint! {
 131     pub REDUNDANT_PATTERN,
 132     Warn,
 133     "using `name @ _` in a pattern"
 134 }
 135
 136 /// **What it does:** Checks for the use of bindings with a single leading underscore.
 137 ///
 138 /// **Why is this bad?** A single leading underscore is usually used to indicate
 139 /// that a binding will not be used. Using such a binding breaks this
 140 /// expectation.
 141 ///
 142 /// **Known problems:** The lint does not work properly with desugaring and
 143 /// macro, it has been allowed in the mean time.
 144 ///
 145 /// **Example:**
 146 /// ```rust
 147 /// let _x = 0;
 148 /// let y = _x + 1; // Here we are using `_x`, even though it has a leading underscore.
 149 ///                 // We should rename `_x` to `x`
 150 /// ```
 151 declare_lint! {
 152     pub USED_UNDERSCORE_BINDING,
 153     Allow,
 154     "using a binding which is prefixed with an underscore"
 155 }
 156
 157 #[derive(Copy, Clone)]
 158 pub struct Pass;
 159
 160 impl LintPass for Pass {
 161     fn get_lints(&self) -> LintArray {
 162         lint_array!(TOPLEVEL_REF_ARG,
 163                     CMP_NAN,
 164                     FLOAT_CMP,
 165                     CMP_OWNED,
 166                     MODULO_ONE,
 167                     REDUNDANT_PATTERN,
 168                     USED_UNDERSCORE_BINDING)
 169     }
 170 }
 171
 172 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for Pass {
 173     fn check_fn(&mut self, cx: &LateContext<'a, 'tcx>, k: FnKind<'tcx>, decl: &'tcx FnDecl, _: &'tcx Expr, _: Span,
 174                 _: NodeId) {
 175         if let FnKind::Closure(_) = k {
 176             // Does not apply to closures
 177             return;
 178         }
 179         for arg in &decl.inputs {
 180             if let PatKind::Binding(BindByRef(_), _, _, _) = arg.pat.node {
 181                 span_lint(cx,
 182                           TOPLEVEL_REF_ARG,
 183                           arg.pat.span,
 184                           "`ref` directly on a function argument is ignored. Consider using a reference type instead.");
 185             }
 186         }
 187     }
 188
 189     fn check_stmt(&mut self, cx: &LateContext<'a, 'tcx>, s: &'tcx Stmt) {
 190         if_let_chain! {[
 191             let StmtDecl(ref d, _) = s.node,
 192             let DeclLocal(ref l) = d.node,
 193             let PatKind::Binding(BindByRef(mt), _, i, None) = l.pat.node,
 194             let Some(ref init) = l.init
 195         ], {
 196             let init = Sugg::hir(cx, init, "..");
 197             let (mutopt,initref) = if mt == Mutability::MutMutable {
 198                 ("mut ", init.mut_addr())
 199             } else {
 200                 ("", init.addr())
 201             };
 202             let tyopt = if let Some(ref ty) = l.ty {
 203                 format!(": &{mutopt}{ty}", mutopt=mutopt, ty=snippet(cx, ty.span, "_"))
 204             } else {
 205                 "".to_owned()
 206             };
 207             span_lint_and_then(cx,
 208                 TOPLEVEL_REF_ARG,
 209                 l.pat.span,
 210                 "`ref` on an entire `let` pattern is discouraged, take a reference with `&` instead",
 211                 |db| {
 212                     db.span_suggestion(s.span,
 213                                        "try",
 214                                        format!("let {name}{tyopt} = {initref};",
 215                                                name=snippet(cx, i.span, "_"),
 216                                                tyopt=tyopt,
 217                                                initref=initref));
 218                 }
 219             );
 220         }}
 221     }
 222
 223     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
 224         if let ExprBinary(ref cmp, ref left, ref right) = expr.node {
 225             let op = cmp.node;
 226             if op.is_comparison() {
 227                 if let ExprPath(QPath::Resolved(_, ref path)) = left.node {
 228                     check_nan(cx, path, expr.span);
 229                 }
 230                 if let ExprPath(QPath::Resolved(_, ref path)) = right.node {
 231                     check_nan(cx, path, expr.span);
 232                 }
 233                 check_to_owned(cx, left, right, true, cmp.span);
 234                 check_to_owned(cx, right, left, false, cmp.span)
 235             }
 236             if (op == BiEq || op == BiNe) && (is_float(cx, left) || is_float(cx, right)) {
 237                 if is_allowed(cx, left) || is_allowed(cx, right) {
 238                     return;
 239                 }
 240                 if let Some(name) = get_item_name(cx, expr) {
 241                     let name = &*name.as_str();
 242                     if name == "eq" || name == "ne" || name == "is_nan" || name.starts_with("eq_") ||
 243                        name.ends_with("_eq") {
 244                         return;
 245                     }
 246                 }
 247                 span_lint_and_then(cx, FLOAT_CMP, expr.span, "strict comparison of f32 or f64", |db| {
 248                     let lhs = Sugg::hir(cx, left, "..");
 249                     let rhs = Sugg::hir(cx, right, "..");
 250
 251                     db.span_suggestion(expr.span,
 252                                        "consider comparing them within some error",
 253                                        format!("({}).abs() < error", lhs - rhs));
 254                     db.span_note(expr.span, "std::f32::EPSILON and std::f64::EPSILON are available.");
 255                 });
 256             } else if op == BiRem && is_integer_literal(right, 1) {
 257                 span_lint(cx, MODULO_ONE, expr.span, "any number modulo 1 will be 0");
 258             }
 259         }
 260         if in_attributes_expansion(cx, expr) {
 261             // Don't lint things expanded by #[derive(...)], etc
 262             return;
 263         }
 264         let binding = match expr.node {
 265             ExprPath(ref qpath) => {
 266                 let binding = last_path_segment(qpath).name.as_str();
 267                 if binding.starts_with('_') &&
 268                     !binding.starts_with("__") &&
 269                     &*binding != "_result" && // FIXME: #944
 270                     is_used(cx, expr) &&
 271                     // don't lint if the declaration is in a macro
 272                     non_macro_local(cx, &cx.tcx.tables().qpath_def(qpath, expr.id)) {
 273                     Some(binding)
 274                 } else {
 275                     None
 276                 }
 277             },
 278             ExprField(_, spanned) => {
 279                 let name = spanned.node.as_str();
 280                 if name.starts_with('_') && !name.starts_with("__") {
 281                     Some(name)
 282                 } else {
 283                     None
 284                 }
 285             },
 286             _ => None,
 287         };
 288         if let Some(binding) = binding {
 289             span_lint(cx,
 290                       USED_UNDERSCORE_BINDING,
 291                       expr.span,
 292                       &format!("used binding `{}` which is prefixed with an underscore. A leading \
 293                                 underscore signals that a binding will not be used.",
 294                                binding));
 295         }
 296     }
 297
 298     fn check_pat(&mut self, cx: &LateContext<'a, 'tcx>, pat: &'tcx Pat) {
 299         if let PatKind::Binding(_, _, ref ident, Some(ref right)) = pat.node {
 300             if right.node == PatKind::Wild {
 301                 span_lint(cx,
 302                           REDUNDANT_PATTERN,
 303                           pat.span,
 304                           &format!("the `{} @ _` pattern can be written as just `{}`", ident.node, ident.node));
 305             }
 306         }
 307     }
 308 }
 309
 310 fn check_nan(cx: &LateContext, path: &Path, span: Span) {
 311     path.segments.last().map(|seg| {
 312         if &*seg.name.as_str() == "NAN" {
 313             span_lint(cx,
 314                       CMP_NAN,
 315                       span,
 316                       "doomed comparison with NAN, use `std::{f32,f64}::is_nan()` instead");
 317         }
 318     });
 319 }
 320
 321 fn is_allowed(cx: &LateContext, expr: &Expr) -> bool {
 322     let res = eval_const_expr_partial(cx.tcx, expr, ExprTypeChecked, None);
 323     if let Ok(ConstVal::Float(val)) = res {
 324         use std::cmp::Ordering;
 325
 326         let zero = ConstFloat::FInfer {
 327             f32: 0.0,
 328             f64: 0.0,
 329         };
 330
 331         let infinity = ConstFloat::FInfer {
 332             f32: ::std::f32::INFINITY,
 333             f64: ::std::f64::INFINITY,
 334         };
 335
 336         let neg_infinity = ConstFloat::FInfer {
 337             f32: ::std::f32::NEG_INFINITY,
 338             f64: ::std::f64::NEG_INFINITY,
 339         };
 340
 341         val.try_cmp(zero) == Ok(Ordering::Equal) || val.try_cmp(infinity) == Ok(Ordering::Equal) ||
 342         val.try_cmp(neg_infinity) == Ok(Ordering::Equal)
 343     } else {
 344         false
 345     }
 346 }
 347
 348 fn is_float(cx: &LateContext, expr: &Expr) -> bool {
 349     matches!(walk_ptrs_ty(cx.tcx.tables().expr_ty(expr)).sty, ty::TyFloat(_))
 350 }
 351
 352 fn check_to_owned(cx: &LateContext, expr: &Expr, other: &Expr, left: bool, op: Span) {
 353     let (arg_ty, snip) = match expr.node {
 354         ExprMethodCall(Spanned { node: ref name, .. }, _, ref args) if args.len() == 1 => {
 355             let name = &*name.as_str();
 356             if name == "to_string" || name == "to_owned" && is_str_arg(cx, args) {
 357                 (cx.tcx.tables().expr_ty(&args[0]), snippet(cx, args[0].span, ".."))
 358             } else {
 359                 return;
 360             }
 361         },
 362         ExprCall(ref path, ref v) if v.len() == 1 => {
 363             if let ExprPath(ref path) = path.node {
 364                 if match_path(path, &["String", "from_str"]) || match_path(path, &["String", "from"]) {
 365                     (cx.tcx.tables().expr_ty(&v[0]), snippet(cx, v[0].span, ".."))
 366                 } else {
 367                     return;
 368                 }
 369             } else {
 370                 return;
 371             }
 372         },
 373         _ => return,
 374     };
 375
 376     let other_ty = cx.tcx.tables().expr_ty(other);
 377     let partial_eq_trait_id = match cx.tcx.lang_items.eq_trait() {
 378         Some(id) => id,
 379         None => return,
 380     };
 381
 382     if !implements_trait(cx, arg_ty, partial_eq_trait_id, vec![other_ty]) {
 383         return;
 384     }
 385
 386     if left {
 387         span_lint(cx,
 388                   CMP_OWNED,
 389                   expr.span,
 390                   &format!("this creates an owned instance just for comparison. Consider using `{} {} {}` to \
 391                             compare without allocation",
 392                            snip,
 393                            snippet(cx, op, "=="),
 394                            snippet(cx, other.span, "..")));
 395     } else {
 396         span_lint(cx,
 397                   CMP_OWNED,
 398                   expr.span,
 399                   &format!("this creates an owned instance just for comparison. Consider using `{} {} {}` to \
 400                             compare without allocation",
 401                            snippet(cx, other.span, ".."),
 402                            snippet(cx, op, "=="),
 403                            snip));
 404     }
 405
 406 }
 407
 408 fn is_str_arg(cx: &LateContext, args: &[Expr]) -> bool {
 409     args.len() == 1 && matches!(walk_ptrs_ty(cx.tcx.tables().expr_ty(&args[0])).sty, ty::TyStr)
 410 }
 411
 412 /// Heuristic to see if an expression is used. Should be compatible with `unused_variables`'s idea
 413 /// of what it means for an expression to be "used".
 414 fn is_used(cx: &LateContext, expr: &Expr) -> bool {
 415     if let Some(parent) = get_parent_expr(cx, expr) {
 416         match parent.node {
 417             ExprAssign(_, ref rhs) |
 418             ExprAssignOp(_, _, ref rhs) => **rhs == *expr,
 419             _ => is_used(cx, parent),
 420         }
 421     } else {
 422         true
 423     }
 424 }
 425
 426 /// Test whether an expression is in a macro expansion (e.g. something generated by
 427 /// `#[derive(...)`] or the like).
 428 fn in_attributes_expansion(cx: &LateContext, expr: &Expr) -> bool {
 429     cx.sess().codemap().with_expn_info(expr.span.expn_id, |info_opt| {
 430         info_opt.map_or(false, |info| matches!(info.callee.format, ExpnFormat::MacroAttribute(_)))
 431     })
 432 }
 433
 434 /// Test whether `def` is a variable defined outside a macro.
 435 fn non_macro_local(cx: &LateContext, def: &def::Def) -> bool {
 436     match *def {
 437         def::Def::Local(id) |
 438         def::Def::Upvar(id, _, _) => {
 439             if let Some(span) = cx.tcx.map.span_if_local(id) {
 440                 !in_macro(cx, span)
 441             } else {
 442                 true
 443             }
 444         },
 445         _ => false,
 446     }
 447 }