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