clippy_lints/src/misc.rs

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