clippy_lints/src/misc.rs

   1 use if_chain::if_chain;
   2 use matches::matches;
   3 use rustc::hir::intravisit::FnKind;
   4 use rustc::hir::*;
   5 use rustc::lint::{LateContext, LateLintPass, LintArray, LintPass};
   6 use rustc::ty;
   7 use rustc::{declare_lint_pass, declare_tool_lint};
   8 use rustc_errors::Applicability;
   9 use syntax::ast::LitKind;
  10 use syntax::source_map::{ExpnKind, Span};
  11
  12 use crate::consts::{constant, Constant};
  13 use crate::utils::sugg::Sugg;
  14 use crate::utils::{
  15     get_item_name, get_parent_expr, implements_trait, in_constant, is_integer_const, iter_input_pats,
  16     last_path_segment, match_qpath, match_trait_method, paths, snippet, span_lint, span_lint_and_then,
  17     span_lint_hir_and_then, walk_ptrs_ty, SpanlessEq,
  18 };
  19
  20 declare_clippy_lint! {
  21     /// **What it does:** Checks for function arguments and let bindings denoted as
  22     /// `ref`.
  23     ///
  24     /// **Why is this bad?** The `ref` declaration makes the function take an owned
  25     /// value, but turns the argument into a reference (which means that the value
  26     /// is destroyed when exiting the function). This adds not much value: either
  27     /// take a reference type, or take an owned value and create references in the
  28     /// body.
  29     ///
  30     /// For let bindings, `let x = &foo;` is preferred over `let ref x = foo`. The
  31     /// type of `x` is more obvious with the former.
  32     ///
  33     /// **Known problems:** If the argument is dereferenced within the function,
  34     /// removing the `ref` will lead to errors. This can be fixed by removing the
  35     /// dereferences, e.g., changing `*x` to `x` within the function.
  36     ///
  37     /// **Example:**
  38     /// ```rust
  39     /// fn foo(ref x: u8) -> bool {
  40     ///     true
  41     /// }
  42     /// ```
  43     pub TOPLEVEL_REF_ARG,
  44     style,
  45     "an entire binding declared as `ref`, in a function argument or a `let` statement"
  46 }
  47
  48 declare_clippy_lint! {
  49     /// **What it does:** Checks for comparisons to NaN.
  50     ///
  51     /// **Why is this bad?** NaN does not compare meaningfully to anything – not
  52     /// even itself – so those comparisons are simply wrong.
  53     ///
  54     /// **Known problems:** None.
  55     ///
  56     /// **Example:**
  57     /// ```rust
  58     /// # use core::f32::NAN;
  59     /// # let x = 1.0;
  60     ///
  61     /// if x == NAN { }
  62     /// ```
  63     pub CMP_NAN,
  64     correctness,
  65     "comparisons to NAN, which will always return false, probably not intended"
  66 }
  67
  68 declare_clippy_lint! {
  69     /// **What it does:** Checks for (in-)equality comparisons on floating-point
  70     /// values (apart from zero), except in functions called `*eq*` (which probably
  71     /// implement equality for a type involving floats).
  72     ///
  73     /// **Why is this bad?** Floating point calculations are usually imprecise, so
  74     /// asking if two values are *exactly* equal is asking for trouble. For a good
  75     /// guide on what to do, see [the floating point
  76     /// guide](http://www.floating-point-gui.de/errors/comparison).
  77     ///
  78     /// **Known problems:** None.
  79     ///
  80     /// **Example:**
  81     /// ```rust
  82     /// let x = 1.2331f64;
  83     /// let y = 1.2332f64;
  84     /// if y == 1.23f64 { }
  85     /// if y != x {} // where both are floats
  86     /// ```
  87     pub FLOAT_CMP,
  88     correctness,
  89     "using `==` or `!=` on float values instead of comparing difference with an epsilon"
  90 }
  91
  92 declare_clippy_lint! {
  93     /// **What it does:** Checks for conversions to owned values just for the sake
  94     /// of a comparison.
  95     ///
  96     /// **Why is this bad?** The comparison can operate on a reference, so creating
  97     /// an owned value effectively throws it away directly afterwards, which is
  98     /// needlessly consuming code and heap space.
  99     ///
 100     /// **Known problems:** None.
 101     ///
 102     /// **Example:**
 103     /// ```rust
 104     /// # let x = "foo";
 105     /// # let y = String::from("foo");
 106     /// if x.to_owned() == y {}
 107     /// ```
 108     /// Could be written as
 109     /// ```rust
 110     /// # let x = "foo";
 111     /// # let y = String::from("foo");
 112     /// if x == y {}
 113     /// ```
 114     pub CMP_OWNED,
 115     perf,
 116     "creating owned instances for comparing with others, e.g., `x == \"foo\".to_string()`"
 117 }
 118
 119 declare_clippy_lint! {
 120     /// **What it does:** Checks for getting the remainder of a division by one.
 121     ///
 122     /// **Why is this bad?** The result can only ever be zero. No one will write
 123     /// such code deliberately, unless trying to win an Underhanded Rust
 124     /// Contest. Even for that contest, it's probably a bad idea. Use something more
 125     /// underhanded.
 126     ///
 127     /// **Known problems:** None.
 128     ///
 129     /// **Example:**
 130     /// ```rust
 131     /// # let x = 1;
 132     /// let a = x % 1;
 133     /// ```
 134     pub MODULO_ONE,
 135     correctness,
 136     "taking a number modulo 1, which always returns 0"
 137 }
 138
 139 declare_clippy_lint! {
 140     /// **What it does:** Checks for the use of bindings with a single leading
 141     /// underscore.
 142     ///
 143     /// **Why is this bad?** A single leading underscore is usually used to indicate
 144     /// that a binding will not be used. Using such a binding breaks this
 145     /// expectation.
 146     ///
 147     /// **Known problems:** The lint does not work properly with desugaring and
 148     /// macro, it has been allowed in the mean time.
 149     ///
 150     /// **Example:**
 151     /// ```rust
 152     /// let _x = 0;
 153     /// let y = _x + 1; // Here we are using `_x`, even though it has a leading
 154     ///                 // underscore. We should rename `_x` to `x`
 155     /// ```
 156     pub USED_UNDERSCORE_BINDING,
 157     pedantic,
 158     "using a binding which is prefixed with an underscore"
 159 }
 160
 161 declare_clippy_lint! {
 162     /// **What it does:** Checks for the use of short circuit boolean conditions as
 163     /// a
 164     /// statement.
 165     ///
 166     /// **Why is this bad?** Using a short circuit boolean condition as a statement
 167     /// may hide the fact that the second part is executed or not depending on the
 168     /// outcome of the first part.
 169     ///
 170     /// **Known problems:** None.
 171     ///
 172     /// **Example:**
 173     /// ```rust,ignore
 174     /// f() && g(); // We should write `if f() { g(); }`.
 175     /// ```
 176     pub SHORT_CIRCUIT_STATEMENT,
 177     complexity,
 178     "using a short circuit boolean condition as a statement"
 179 }
 180
 181 declare_clippy_lint! {
 182     /// **What it does:** Catch casts from `0` to some pointer type
 183     ///
 184     /// **Why is this bad?** This generally means `null` and is better expressed as
 185     /// {`std`, `core`}`::ptr::`{`null`, `null_mut`}.
 186     ///
 187     /// **Known problems:** None.
 188     ///
 189     /// **Example:**
 190     ///
 191     /// ```rust
 192     /// let a = 0 as *const u32;
 193     /// ```
 194     pub ZERO_PTR,
 195     style,
 196     "using 0 as *{const, mut} T"
 197 }
 198
 199 declare_clippy_lint! {
 200     /// **What it does:** Checks for (in-)equality comparisons on floating-point
 201     /// value and constant, except in functions called `*eq*` (which probably
 202     /// implement equality for a type involving floats).
 203     ///
 204     /// **Why is this bad?** Floating point calculations are usually imprecise, so
 205     /// asking if two values are *exactly* equal is asking for trouble. For a good
 206     /// guide on what to do, see [the floating point
 207     /// guide](http://www.floating-point-gui.de/errors/comparison).
 208     ///
 209     /// **Known problems:** None.
 210     ///
 211     /// **Example:**
 212     /// ```rust
 213     /// let x: f64 = 1.0;
 214     /// const ONE: f64 = 1.00;
 215     /// x == ONE;  // where both are floats
 216     /// ```
 217     pub FLOAT_CMP_CONST,
 218     restriction,
 219     "using `==` or `!=` on float constants instead of comparing difference with an epsilon"
 220 }
 221
 222 declare_lint_pass!(MiscLints => [
 223     TOPLEVEL_REF_ARG,
 224     CMP_NAN,
 225     FLOAT_CMP,
 226     CMP_OWNED,
 227     MODULO_ONE,
 228     USED_UNDERSCORE_BINDING,
 229     SHORT_CIRCUIT_STATEMENT,
 230     ZERO_PTR,
 231     FLOAT_CMP_CONST
 232 ]);
 233
 234 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for MiscLints {
 235     fn check_fn(
 236         &mut self,
 237         cx: &LateContext<'a, 'tcx>,
 238         k: FnKind<'tcx>,
 239         decl: &'tcx FnDecl,
 240         body: &'tcx Body,
 241         _: Span,
 242         _: HirId,
 243     ) {
 244         if let FnKind::Closure(_) = k {
 245             // Does not apply to closures
 246             return;
 247         }
 248         for arg in iter_input_pats(decl, body) {
 249             match arg.pat.node {
 250                 PatKind::Binding(BindingAnnotation::Ref, ..) | PatKind::Binding(BindingAnnotation::RefMut, ..) => {
 251                     span_lint(
 252                         cx,
 253                         TOPLEVEL_REF_ARG,
 254                         arg.pat.span,
 255                         "`ref` directly on a function argument is ignored. Consider using a reference type \
 256                          instead.",
 257                     );
 258                 },
 259                 _ => {},
 260             }
 261         }
 262     }
 263
 264     fn check_stmt(&mut self, cx: &LateContext<'a, 'tcx>, s: &'tcx Stmt) {
 265         if_chain! {
 266             if let StmtKind::Local(ref l) = s.node;
 267             if let PatKind::Binding(an, .., i, None) = l.pat.node;
 268             if let Some(ref init) = l.init;
 269             then {
 270                 if an == BindingAnnotation::Ref || an == BindingAnnotation::RefMut {
 271                     let sugg_init = Sugg::hir(cx, init, "..");
 272                     let (mutopt,initref) = if an == BindingAnnotation::RefMut {
 273                         ("mut ", sugg_init.mut_addr())
 274                     } else {
 275                         ("", sugg_init.addr())
 276                     };
 277                     let tyopt = if let Some(ref ty) = l.ty {
 278                         format!(": &{mutopt}{ty}", mutopt=mutopt, ty=snippet(cx, ty.span, "_"))
 279                     } else {
 280                         String::new()
 281                     };
 282                     span_lint_hir_and_then(cx,
 283                         TOPLEVEL_REF_ARG,
 284                         init.hir_id,
 285                         l.pat.span,
 286                         "`ref` on an entire `let` pattern is discouraged, take a reference with `&` instead",
 287                         |db| {
 288                             db.span_suggestion(
 289                                 s.span,
 290                                 "try",
 291                                 format!(
 292                                     "let {name}{tyopt} = {initref};",
 293                                     name=snippet(cx, i.span, "_"),
 294                                     tyopt=tyopt,
 295                                     initref=initref,
 296                                 ),
 297                                 Applicability::MachineApplicable, // snippet
 298                             );
 299                         }
 300                     );
 301                 }
 302             }
 303         };
 304         if_chain! {
 305             if let StmtKind::Semi(ref expr) = s.node;
 306             if let ExprKind::Binary(ref binop, ref a, ref b) = expr.node;
 307             if binop.node == BinOpKind::And || binop.node == BinOpKind::Or;
 308             if let Some(sugg) = Sugg::hir_opt(cx, a);
 309             then {
 310                 span_lint_and_then(cx,
 311                     SHORT_CIRCUIT_STATEMENT,
 312                     s.span,
 313                     "boolean short circuit operator in statement may be clearer using an explicit test",
 314                     |db| {
 315                         let sugg = if binop.node == BinOpKind::Or { !sugg } else { sugg };
 316                         db.span_suggestion(
 317                             s.span,
 318                             "replace it with",
 319                             format!(
 320                                 "if {} {{ {}; }}",
 321                                 sugg,
 322                                 &snippet(cx, b.span, ".."),
 323                             ),
 324                             Applicability::MachineApplicable, // snippet
 325                         );
 326                     });
 327             }
 328         };
 329     }
 330
 331     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
 332         match expr.node {
 333             ExprKind::Cast(ref e, ref ty) => {
 334                 check_cast(cx, expr.span, e, ty);
 335                 return;
 336             },
 337             ExprKind::Binary(ref cmp, ref left, ref right) => {
 338                 let op = cmp.node;
 339                 if op.is_comparison() {
 340                     if let ExprKind::Path(QPath::Resolved(_, ref path)) = left.node {
 341                         check_nan(cx, path, expr);
 342                     }
 343                     if let ExprKind::Path(QPath::Resolved(_, ref path)) = right.node {
 344                         check_nan(cx, path, expr);
 345                     }
 346                     check_to_owned(cx, left, right);
 347                     check_to_owned(cx, right, left);
 348                 }
 349                 if (op == BinOpKind::Eq || op == BinOpKind::Ne) && (is_float(cx, left) || is_float(cx, right)) {
 350                     if is_allowed(cx, left) || is_allowed(cx, right) {
 351                         return;
 352                     }
 353
 354                     // Allow comparing the results of signum()
 355                     if is_signum(cx, left) && is_signum(cx, right) {
 356                         return;
 357                     }
 358
 359                     if let Some(name) = get_item_name(cx, expr) {
 360                         let name = name.as_str();
 361                         if name == "eq"
 362                             || name == "ne"
 363                             || name == "is_nan"
 364                             || name.starts_with("eq_")
 365                             || name.ends_with("_eq")
 366                         {
 367                             return;
 368                         }
 369                     }
 370                     let (lint, msg) = if is_named_constant(cx, left) || is_named_constant(cx, right) {
 371                         (FLOAT_CMP_CONST, "strict comparison of f32 or f64 constant")
 372                     } else {
 373                         (FLOAT_CMP, "strict comparison of f32 or f64")
 374                     };
 375                     span_lint_and_then(cx, lint, expr.span, msg, |db| {
 376                         let lhs = Sugg::hir(cx, left, "..");
 377                         let rhs = Sugg::hir(cx, right, "..");
 378
 379                         db.span_suggestion(
 380                             expr.span,
 381                             "consider comparing them within some error",
 382                             format!(
 383                                 "({}).abs() {} error",
 384                                 lhs - rhs,
 385                                 if op == BinOpKind::Eq { '<' } else { '>' }
 386                             ),
 387                             Applicability::HasPlaceholders, // snippet
 388                         );
 389                         db.span_note(expr.span, "std::f32::EPSILON and std::f64::EPSILON are available.");
 390                     });
 391                 } else if op == BinOpKind::Rem && is_integer_const(cx, right, 1) {
 392                     span_lint(cx, MODULO_ONE, expr.span, "any number modulo 1 will be 0");
 393                 }
 394             },
 395             _ => {},
 396         }
 397         if in_attributes_expansion(expr) {
 398             // Don't lint things expanded by #[derive(...)], etc
 399             return;
 400         }
 401         let binding = match expr.node {
 402             ExprKind::Path(ref qpath) => {
 403                 let binding = last_path_segment(qpath).ident.as_str();
 404                 if binding.starts_with('_') &&
 405                     !binding.starts_with("__") &&
 406                     binding != "_result" && // FIXME: #944
 407                     is_used(cx, expr) &&
 408                     // don't lint if the declaration is in a macro
 409                     non_macro_local(cx, cx.tables.qpath_res(qpath, expr.hir_id))
 410                 {
 411                     Some(binding)
 412                 } else {
 413                     None
 414                 }
 415             },
 416             ExprKind::Field(_, ident) => {
 417                 let name = ident.as_str();
 418                 if name.starts_with('_') && !name.starts_with("__") {
 419                     Some(name)
 420                 } else {
 421                     None
 422                 }
 423             },
 424             _ => None,
 425         };
 426         if let Some(binding) = binding {
 427             span_lint(
 428                 cx,
 429                 USED_UNDERSCORE_BINDING,
 430                 expr.span,
 431                 &format!(
 432                     "used binding `{}` which is prefixed with an underscore. A leading \
 433                      underscore signals that a binding will not be used.",
 434                     binding
 435                 ),
 436             );
 437         }
 438     }
 439 }
 440
 441 fn check_nan(cx: &LateContext<'_, '_>, path: &Path, expr: &Expr) {
 442     if !in_constant(cx, expr.hir_id) {
 443         if let Some(seg) = path.segments.last() {
 444             if seg.ident.name == sym!(NAN) {
 445                 span_lint(
 446                     cx,
 447                     CMP_NAN,
 448                     expr.span,
 449                     "doomed comparison with NAN, use `std::{f32,f64}::is_nan()` instead",
 450                 );
 451             }
 452         }
 453     }
 454 }
 455
 456 fn is_named_constant<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) -> bool {
 457     if let Some((_, res)) = constant(cx, cx.tables, expr) {
 458         res
 459     } else {
 460         false
 461     }
 462 }
 463
 464 fn is_allowed<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) -> bool {
 465     match constant(cx, cx.tables, expr) {
 466         Some((Constant::F32(f), _)) => f == 0.0 || f.is_infinite(),
 467         Some((Constant::F64(f), _)) => f == 0.0 || f.is_infinite(),
 468         _ => false,
 469     }
 470 }
 471
 472 // Return true if `expr` is the result of `signum()` invoked on a float value.
 473 fn is_signum(cx: &LateContext<'_, '_>, expr: &Expr) -> bool {
 474     // The negation of a signum is still a signum
 475     if let ExprKind::Unary(UnNeg, ref child_expr) = expr.node {
 476         return is_signum(cx, &child_expr);
 477     }
 478
 479     if_chain! {
 480         if let ExprKind::MethodCall(ref method_name, _, ref expressions) = expr.node;
 481         if sym!(signum) == method_name.ident.name;
 482         // Check that the receiver of the signum() is a float (expressions[0] is the receiver of
 483         // the method call)
 484         then {
 485             return is_float(cx, &expressions[0]);
 486         }
 487     }
 488     false
 489 }
 490
 491 fn is_float(cx: &LateContext<'_, '_>, expr: &Expr) -> bool {
 492     matches!(walk_ptrs_ty(cx.tables.expr_ty(expr)).sty, ty::Float(_))
 493 }
 494
 495 fn check_to_owned(cx: &LateContext<'_, '_>, expr: &Expr, other: &Expr) {
 496     let (arg_ty, snip) = match expr.node {
 497         ExprKind::MethodCall(.., ref args) if args.len() == 1 => {
 498             if match_trait_method(cx, expr, &paths::TO_STRING) || match_trait_method(cx, expr, &paths::TO_OWNED) {
 499                 (cx.tables.expr_ty_adjusted(&args[0]), snippet(cx, args[0].span, ".."))
 500             } else {
 501                 return;
 502             }
 503         },
 504         ExprKind::Call(ref path, ref v) if v.len() == 1 => {
 505             if let ExprKind::Path(ref path) = path.node {
 506                 if match_qpath(path, &["String", "from_str"]) || match_qpath(path, &["String", "from"]) {
 507                     (cx.tables.expr_ty_adjusted(&v[0]), snippet(cx, v[0].span, ".."))
 508                 } else {
 509                     return;
 510                 }
 511             } else {
 512                 return;
 513             }
 514         },
 515         _ => return,
 516     };
 517
 518     let other_ty = cx.tables.expr_ty_adjusted(other);
 519     let partial_eq_trait_id = match cx.tcx.lang_items().eq_trait() {
 520         Some(id) => id,
 521         None => return,
 522     };
 523
 524     let deref_arg_impl_partial_eq_other = arg_ty.builtin_deref(true).map_or(false, |tam| {
 525         implements_trait(cx, tam.ty, partial_eq_trait_id, &[other_ty.into()])
 526     });
 527     let arg_impl_partial_eq_deref_other = other_ty.builtin_deref(true).map_or(false, |tam| {
 528         implements_trait(cx, arg_ty, partial_eq_trait_id, &[tam.ty.into()])
 529     });
 530     let arg_impl_partial_eq_other = implements_trait(cx, arg_ty, partial_eq_trait_id, &[other_ty.into()]);
 531
 532     if !deref_arg_impl_partial_eq_other && !arg_impl_partial_eq_deref_other && !arg_impl_partial_eq_other {
 533         return;
 534     }
 535
 536     let other_gets_derefed = match other.node {
 537         ExprKind::Unary(UnDeref, _) => true,
 538         _ => false,
 539     };
 540
 541     let lint_span = if other_gets_derefed {
 542         expr.span.to(other.span)
 543     } else {
 544         expr.span
 545     };
 546
 547     span_lint_and_then(
 548         cx,
 549         CMP_OWNED,
 550         lint_span,
 551         "this creates an owned instance just for comparison",
 552         |db| {
 553             // This also catches `PartialEq` implementations that call `to_owned`.
 554             if other_gets_derefed {
 555                 db.span_label(lint_span, "try implementing the comparison without allocating");
 556                 return;
 557             }
 558
 559             let try_hint = if deref_arg_impl_partial_eq_other {
 560                 // suggest deref on the left
 561                 format!("*{}", snip)
 562             } else {
 563                 // suggest dropping the to_owned on the left
 564                 snip.to_string()
 565             };
 566
 567             db.span_suggestion(
 568                 lint_span,
 569                 "try",
 570                 try_hint,
 571                 Applicability::MachineApplicable, // snippet
 572             );
 573         },
 574     );
 575 }
 576
 577 /// Heuristic to see if an expression is used. Should be compatible with
 578 /// `unused_variables`'s idea
 579 /// of what it means for an expression to be "used".
 580 fn is_used(cx: &LateContext<'_, '_>, expr: &Expr) -> bool {
 581     if let Some(parent) = get_parent_expr(cx, expr) {
 582         match parent.node {
 583             ExprKind::Assign(_, ref rhs) | ExprKind::AssignOp(_, _, ref rhs) => SpanlessEq::new(cx).eq_expr(rhs, expr),
 584             _ => is_used(cx, parent),
 585         }
 586     } else {
 587         true
 588     }
 589 }
 590
 591 /// Tests whether an expression is in a macro expansion (e.g., something
 592 /// generated by `#[derive(...)]` or the like).
 593 fn in_attributes_expansion(expr: &Expr) -> bool {
 594     use syntax::ext::hygiene::MacroKind;
 595     if expr.span.from_expansion() {
 596         let data = expr.span.ctxt().outer_expn_data();
 597
 598         if let ExpnKind::Macro(MacroKind::Attr, _) = data.kind {
 599             true
 600         } else {
 601             false
 602         }
 603     } else {
 604         false
 605     }
 606 }
 607
 608 /// Tests whether `res` is a variable defined outside a macro.
 609 fn non_macro_local(cx: &LateContext<'_, '_>, res: def::Res) -> bool {
 610     if let def::Res::Local(id) = res {
 611         !cx.tcx.hir().span(id).from_expansion()
 612     } else {
 613         false
 614     }
 615 }
 616
 617 fn check_cast(cx: &LateContext<'_, '_>, span: Span, e: &Expr, ty: &Ty) {
 618     if_chain! {
 619         if let TyKind::Ptr(MutTy { mutbl, .. }) = ty.node;
 620         if let ExprKind::Lit(ref lit) = e.node;
 621         if let LitKind::Int(value, ..) = lit.node;
 622         if value == 0;
 623         if !in_constant(cx, e.hir_id);
 624         then {
 625             let msg = match mutbl {
 626                 Mutability::MutMutable => "`0 as *mut _` detected. Consider using `ptr::null_mut()`",
 627                 Mutability::MutImmutable => "`0 as *const _` detected. Consider using `ptr::null()`",
 628             };
 629             span_lint(cx, ZERO_PTR, span, msg);
 630         }
 631     }
 632 }