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 /// **What it does:** Checks for the use of short circuit boolean conditions as a
 158 /// statement.
 159 ///
 160 /// **Why is this bad?** Using a short circuit boolean condition as a statement may
 161 /// hide the fact that the second part is executed or not depending on the outcome of
 162 /// the first part.
 163 ///
 164 /// **Known problems:** None.
 165 ///
 166 /// **Example:**
 167 /// ```rust
 168 /// f() && g();  // We should write `if f() { g(); }`.
 169 /// ```
 170 declare_lint! {
 171     pub SHORT_CIRCUIT_STATEMENT,
 172     Warn,
 173     "using a short circuit boolean condition as a statement"
 174 }
 175
 176 #[derive(Copy, Clone)]
 177 pub struct Pass;
 178
 179 impl LintPass for Pass {
 180     fn get_lints(&self) -> LintArray {
 181         lint_array!(TOPLEVEL_REF_ARG,
 182                     CMP_NAN,
 183                     FLOAT_CMP,
 184                     CMP_OWNED,
 185                     MODULO_ONE,
 186                     REDUNDANT_PATTERN,
 187                     USED_UNDERSCORE_BINDING,
 188                     SHORT_CIRCUIT_STATEMENT)
 189     }
 190 }
 191
 192 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for Pass {
 193     fn check_fn(
 194         &mut self,
 195         cx: &LateContext<'a, 'tcx>,
 196         k: FnKind<'tcx>,
 197         decl: &'tcx FnDecl,
 198         _: &'tcx Expr,
 199         _: Span,
 200         _: NodeId
 201     ) {
 202         if let FnKind::Closure(_) = k {
 203             // Does not apply to closures
 204             return;
 205         }
 206         for arg in &decl.inputs {
 207             if let PatKind::Binding(BindByRef(_), _, _, _) = arg.pat.node {
 208                 span_lint(cx,
 209                           TOPLEVEL_REF_ARG,
 210                           arg.pat.span,
 211                           "`ref` directly on a function argument is ignored. Consider using a reference type instead.");
 212             }
 213         }
 214     }
 215
 216     fn check_stmt(&mut self, cx: &LateContext<'a, 'tcx>, s: &'tcx Stmt) {
 217         if_let_chain! {[
 218             let StmtDecl(ref d, _) = s.node,
 219             let DeclLocal(ref l) = d.node,
 220             let PatKind::Binding(BindByRef(mt), _, i, None) = l.pat.node,
 221             let Some(ref init) = l.init
 222         ], {
 223             let init = Sugg::hir(cx, init, "..");
 224             let (mutopt,initref) = if mt == Mutability::MutMutable {
 225                 ("mut ", init.mut_addr())
 226             } else {
 227                 ("", init.addr())
 228             };
 229             let tyopt = if let Some(ref ty) = l.ty {
 230                 format!(": &{mutopt}{ty}", mutopt=mutopt, ty=snippet(cx, ty.span, "_"))
 231             } else {
 232                 "".to_owned()
 233             };
 234             span_lint_and_then(cx,
 235                 TOPLEVEL_REF_ARG,
 236                 l.pat.span,
 237                 "`ref` on an entire `let` pattern is discouraged, take a reference with `&` instead",
 238                 |db| {
 239                     db.span_suggestion(s.span,
 240                                        "try",
 241                                        format!("let {name}{tyopt} = {initref};",
 242                                                name=snippet(cx, i.span, "_"),
 243                                                tyopt=tyopt,
 244                                                initref=initref));
 245                 }
 246             );
 247         }};
 248         if_let_chain! {[
 249             let StmtSemi(ref expr, _) = s.node,
 250             let Expr_::ExprBinary(ref binop, ref a, ref b) = expr.node,
 251             binop.node == BiAnd || binop.node == BiOr,
 252             let Some(sugg) = Sugg::hir_opt(cx, a),
 253         ], {
 254             span_lint_and_then(cx,
 255                 SHORT_CIRCUIT_STATEMENT,
 256                 s.span,
 257                 "boolean short circuit operator in statement may be clearer using an explicit test",
 258                 |db| {
 259                     let sugg = if binop.node == BiOr { !sugg } else { sugg };
 260                     db.span_suggestion(s.span, "replace it with",
 261                                        format!("if {} {{ {}; }}", sugg, &snippet(cx, b.span, "..")));
 262                 });
 263         }};
 264     }
 265
 266     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
 267         if let ExprBinary(ref cmp, ref left, ref right) = expr.node {
 268             let op = cmp.node;
 269             if op.is_comparison() {
 270                 if let ExprPath(QPath::Resolved(_, ref path)) = left.node {
 271                     check_nan(cx, path, expr.span);
 272                 }
 273                 if let ExprPath(QPath::Resolved(_, ref path)) = right.node {
 274                     check_nan(cx, path, expr.span);
 275                 }
 276                 check_to_owned(cx, left, right, true, cmp.span);
 277                 check_to_owned(cx, right, left, false, cmp.span)
 278             }
 279             if (op == BiEq || op == BiNe) && (is_float(cx, left) || is_float(cx, right)) {
 280                 if is_allowed(cx, left) || is_allowed(cx, right) {
 281                     return;
 282                 }
 283                 if let Some(name) = get_item_name(cx, expr) {
 284                     let name = &*name.as_str();
 285                     if name == "eq" || name == "ne" || name == "is_nan" || name.starts_with("eq_") ||
 286                        name.ends_with("_eq") {
 287                         return;
 288                     }
 289                 }
 290                 span_lint_and_then(cx, FLOAT_CMP, expr.span, "strict comparison of f32 or f64", |db| {
 291                     let lhs = Sugg::hir(cx, left, "..");
 292                     let rhs = Sugg::hir(cx, right, "..");
 293
 294                     db.span_suggestion(expr.span,
 295                                        "consider comparing them within some error",
 296                                        format!("({}).abs() < error", lhs - rhs));
 297                     db.span_note(expr.span, "std::f32::EPSILON and std::f64::EPSILON are available.");
 298                 });
 299             } else if op == BiRem && is_integer_literal(right, 1) {
 300                 span_lint(cx, MODULO_ONE, expr.span, "any number modulo 1 will be 0");
 301             }
 302         }
 303         if in_attributes_expansion(cx, expr) {
 304             // Don't lint things expanded by #[derive(...)], etc
 305             return;
 306         }
 307         let binding = match expr.node {
 308             ExprPath(ref qpath) => {
 309                 let binding = last_path_segment(qpath).name.as_str();
 310                 if binding.starts_with('_') &&
 311                     !binding.starts_with("__") &&
 312                     &*binding != "_result" && // FIXME: #944
 313                     is_used(cx, expr) &&
 314                     // don't lint if the declaration is in a macro
 315                     non_macro_local(cx, &cx.tcx.tables().qpath_def(qpath, expr.id)) {
 316                     Some(binding)
 317                 } else {
 318                     None
 319                 }
 320             },
 321             ExprField(_, spanned) => {
 322                 let name = spanned.node.as_str();
 323                 if name.starts_with('_') && !name.starts_with("__") {
 324                     Some(name)
 325                 } else {
 326                     None
 327                 }
 328             },
 329             _ => None,
 330         };
 331         if let Some(binding) = binding {
 332             span_lint(cx,
 333                       USED_UNDERSCORE_BINDING,
 334                       expr.span,
 335                       &format!("used binding `{}` which is prefixed with an underscore. A leading \
 336                                 underscore signals that a binding will not be used.",
 337                                binding));
 338         }
 339     }
 340
 341     fn check_pat(&mut self, cx: &LateContext<'a, 'tcx>, pat: &'tcx Pat) {
 342         if let PatKind::Binding(_, _, ref ident, Some(ref right)) = pat.node {
 343             if right.node == PatKind::Wild {
 344                 span_lint(cx,
 345                           REDUNDANT_PATTERN,
 346                           pat.span,
 347                           &format!("the `{} @ _` pattern can be written as just `{}`", ident.node, ident.node));
 348             }
 349         }
 350     }
 351 }
 352
 353 fn check_nan(cx: &LateContext, path: &Path, span: Span) {
 354     path.segments.last().map(|seg| {
 355         if &*seg.name.as_str() == "NAN" {
 356             span_lint(cx,
 357                       CMP_NAN,
 358                       span,
 359                       "doomed comparison with NAN, use `std::{f32,f64}::is_nan()` instead");
 360         }
 361     });
 362 }
 363
 364 fn is_allowed(cx: &LateContext, expr: &Expr) -> bool {
 365     let res = eval_const_expr_partial(cx.tcx, expr, ExprTypeChecked, None);
 366     if let Ok(ConstVal::Float(val)) = res {
 367         use std::cmp::Ordering;
 368
 369         let zero = ConstFloat::FInfer {
 370             f32: 0.0,
 371             f64: 0.0,
 372         };
 373
 374         let infinity = ConstFloat::FInfer {
 375             f32: ::std::f32::INFINITY,
 376             f64: ::std::f64::INFINITY,
 377         };
 378
 379         let neg_infinity = ConstFloat::FInfer {
 380             f32: ::std::f32::NEG_INFINITY,
 381             f64: ::std::f64::NEG_INFINITY,
 382         };
 383
 384         val.try_cmp(zero) == Ok(Ordering::Equal) || val.try_cmp(infinity) == Ok(Ordering::Equal) ||
 385         val.try_cmp(neg_infinity) == Ok(Ordering::Equal)
 386     } else {
 387         false
 388     }
 389 }
 390
 391 fn is_float(cx: &LateContext, expr: &Expr) -> bool {
 392     matches!(walk_ptrs_ty(cx.tcx.tables().expr_ty(expr)).sty, ty::TyFloat(_))
 393 }
 394
 395 fn check_to_owned(cx: &LateContext, expr: &Expr, other: &Expr, left: bool, op: Span) {
 396     let (arg_ty, snip) = match expr.node {
 397         ExprMethodCall(Spanned { node: ref name, .. }, _, ref args) if args.len() == 1 => {
 398             let name = &*name.as_str();
 399             if name == "to_string" || name == "to_owned" && is_str_arg(cx, args) {
 400                 (cx.tcx.tables().expr_ty(&args[0]), snippet(cx, args[0].span, ".."))
 401             } else {
 402                 return;
 403             }
 404         },
 405         ExprCall(ref path, ref v) if v.len() == 1 => {
 406             if let ExprPath(ref path) = path.node {
 407                 if match_path(path, &["String", "from_str"]) || match_path(path, &["String", "from"]) {
 408                     (cx.tcx.tables().expr_ty(&v[0]), snippet(cx, v[0].span, ".."))
 409                 } else {
 410                     return;
 411                 }
 412             } else {
 413                 return;
 414             }
 415         },
 416         _ => return,
 417     };
 418
 419     let other_ty = cx.tcx.tables().expr_ty(other);
 420     let partial_eq_trait_id = match cx.tcx.lang_items.eq_trait() {
 421         Some(id) => id,
 422         None => return,
 423     };
 424
 425     if !implements_trait(cx, arg_ty, partial_eq_trait_id, vec![other_ty]) {
 426         return;
 427     }
 428
 429     if left {
 430         span_lint(cx,
 431                   CMP_OWNED,
 432                   expr.span,
 433                   &format!("this creates an owned instance just for comparison. Consider using `{} {} {}` to \
 434                             compare without allocation",
 435                            snip,
 436                            snippet(cx, op, "=="),
 437                            snippet(cx, other.span, "..")));
 438     } else {
 439         span_lint(cx,
 440                   CMP_OWNED,
 441                   expr.span,
 442                   &format!("this creates an owned instance just for comparison. Consider using `{} {} {}` to \
 443                             compare without allocation",
 444                            snippet(cx, other.span, ".."),
 445                            snippet(cx, op, "=="),
 446                            snip));
 447     }
 448
 449 }
 450
 451 fn is_str_arg(cx: &LateContext, args: &[Expr]) -> bool {
 452     args.len() == 1 && matches!(walk_ptrs_ty(cx.tcx.tables().expr_ty(&args[0])).sty, ty::TyStr)
 453 }
 454
 455 /// Heuristic to see if an expression is used. Should be compatible with `unused_variables`'s idea
 456 /// of what it means for an expression to be "used".
 457 fn is_used(cx: &LateContext, expr: &Expr) -> bool {
 458     if let Some(parent) = get_parent_expr(cx, expr) {
 459         match parent.node {
 460             ExprAssign(_, ref rhs) |
 461             ExprAssignOp(_, _, ref rhs) => **rhs == *expr,
 462             _ => is_used(cx, parent),
 463         }
 464     } else {
 465         true
 466     }
 467 }
 468
 469 /// Test whether an expression is in a macro expansion (e.g. something generated by
 470 /// `#[derive(...)`] or the like).
 471 fn in_attributes_expansion(cx: &LateContext, expr: &Expr) -> bool {
 472     cx.sess().codemap().with_expn_info(expr.span.expn_id, |info_opt| {
 473         info_opt.map_or(false, |info| matches!(info.callee.format, ExpnFormat::MacroAttribute(_)))
 474     })
 475 }
 476
 477 /// Test whether `def` is a variable defined outside a macro.
 478 fn non_macro_local(cx: &LateContext, def: &def::Def) -> bool {
 479     match *def {
 480         def::Def::Local(id) |
 481         def::Def::Upvar(id, _, _) => {
 482             if let Some(span) = cx.tcx.map.span_if_local(id) {
 483                 !in_macro(cx, span)
 484             } else {
 485                 true
 486             }
 487         },
 488         _ => false,
 489     }
 490 }