1 use if_chain::if_chain;
2 use rustc_ast::ast::LitKind;
3 use rustc_errors::Applicability;
4 use rustc_hir::intravisit::FnKind;
6 def, BinOpKind, BindingAnnotation, Body, Expr, ExprKind, FnDecl, HirId, Mutability, PatKind, Stmt, StmtKind, Ty,
9 use rustc_lint::{LateContext, LateLintPass};
11 use rustc_session::{declare_lint_pass, declare_tool_lint};
12 use rustc_span::source_map::{ExpnKind, Span};
14 use crate::consts::{constant, Constant};
15 use crate::utils::sugg::Sugg;
17 get_item_name, get_parent_expr, implements_trait, in_constant, is_integer_const, iter_input_pats,
18 last_path_segment, match_qpath, match_trait_method, paths, snippet, snippet_opt, span_lint, span_lint_and_sugg,
19 span_lint_and_then, span_lint_hir_and_then, walk_ptrs_ty, SpanlessEq,
22 declare_clippy_lint! {
23 /// **What it does:** Checks for function arguments and let bindings denoted as
26 /// **Why is this bad?** The `ref` declaration makes the function take an owned
27 /// value, but turns the argument into a reference (which means that the value
28 /// is destroyed when exiting the function). This adds not much value: either
29 /// take a reference type, or take an owned value and create references in the
32 /// For let bindings, `let x = &foo;` is preferred over `let ref x = foo`. The
33 /// type of `x` is more obvious with the former.
35 /// **Known problems:** If the argument is dereferenced within the function,
36 /// removing the `ref` will lead to errors. This can be fixed by removing the
37 /// dereferences, e.g., changing `*x` to `x` within the function.
41 /// fn foo(ref x: u8) -> bool {
47 "an entire binding declared as `ref`, in a function argument or a `let` statement"
50 declare_clippy_lint! {
51 /// **What it does:** Checks for comparisons to NaN.
53 /// **Why is this bad?** NaN does not compare meaningfully to anything – not
54 /// even itself – so those comparisons are simply wrong.
56 /// **Known problems:** None.
62 /// if x == f32::NAN { }
66 "comparisons to `NAN`, which will always return false, probably not intended"
69 declare_clippy_lint! {
70 /// **What it does:** Checks for (in-)equality comparisons on floating-point
71 /// values (apart from zero), except in functions called `*eq*` (which probably
72 /// implement equality for a type involving floats).
74 /// **Why is this bad?** Floating point calculations are usually imprecise, so
75 /// asking if two values are *exactly* equal is asking for trouble. For a good
76 /// guide on what to do, see [the floating point
77 /// guide](http://www.floating-point-gui.de/errors/comparison).
79 /// **Known problems:** None.
83 /// let x = 1.2331f64;
84 /// let y = 1.2332f64;
85 /// if y == 1.23f64 { }
86 /// if y != x {} // where both are floats
90 "using `==` or `!=` on float values instead of comparing difference with an epsilon"
93 declare_clippy_lint! {
94 /// **What it does:** Checks for conversions to owned values just for the sake
97 /// **Why is this bad?** The comparison can operate on a reference, so creating
98 /// an owned value effectively throws it away directly afterwards, which is
99 /// needlessly consuming code and heap space.
101 /// **Known problems:** None.
106 /// # let y = String::from("foo");
107 /// if x.to_owned() == y {}
109 /// Could be written as
112 /// # let y = String::from("foo");
117 "creating owned instances for comparing with others, e.g., `x == \"foo\".to_string()`"
120 declare_clippy_lint! {
121 /// **What it does:** Checks for getting the remainder of a division by one.
123 /// **Why is this bad?** The result can only ever be zero. No one will write
124 /// such code deliberately, unless trying to win an Underhanded Rust
125 /// Contest. Even for that contest, it's probably a bad idea. Use something more
128 /// **Known problems:** None.
137 "taking a number modulo 1, which always returns 0"
140 declare_clippy_lint! {
141 /// **What it does:** Checks for the use of bindings with a single leading
144 /// **Why is this bad?** A single leading underscore is usually used to indicate
145 /// that a binding will not be used. Using such a binding breaks this
148 /// **Known problems:** The lint does not work properly with desugaring and
149 /// macro, it has been allowed in the mean time.
154 /// let y = _x + 1; // Here we are using `_x`, even though it has a leading
155 /// // underscore. We should rename `_x` to `x`
157 pub USED_UNDERSCORE_BINDING,
159 "using a binding which is prefixed with an underscore"
162 declare_clippy_lint! {
163 /// **What it does:** Checks for the use of short circuit boolean conditions as
167 /// **Why is this bad?** Using a short circuit boolean condition as a statement
168 /// may hide the fact that the second part is executed or not depending on the
169 /// outcome of the first part.
171 /// **Known problems:** None.
175 /// f() && g(); // We should write `if f() { g(); }`.
177 pub SHORT_CIRCUIT_STATEMENT,
179 "using a short circuit boolean condition as a statement"
182 declare_clippy_lint! {
183 /// **What it does:** Catch casts from `0` to some pointer type
185 /// **Why is this bad?** This generally means `null` and is better expressed as
186 /// {`std`, `core`}`::ptr::`{`null`, `null_mut`}.
188 /// **Known problems:** None.
193 /// let a = 0 as *const u32;
197 "using `0 as *{const, mut} T`"
200 declare_clippy_lint! {
201 /// **What it does:** Checks for (in-)equality comparisons on floating-point
202 /// value and constant, except in functions called `*eq*` (which probably
203 /// implement equality for a type involving floats).
205 /// **Why is this bad?** Floating point calculations are usually imprecise, so
206 /// asking if two values are *exactly* equal is asking for trouble. For a good
207 /// guide on what to do, see [the floating point
208 /// guide](http://www.floating-point-gui.de/errors/comparison).
210 /// **Known problems:** None.
214 /// let x: f64 = 1.0;
215 /// const ONE: f64 = 1.00;
216 /// x == ONE; // where both are floats
220 "using `==` or `!=` on float constants instead of comparing difference with an epsilon"
223 declare_lint_pass!(MiscLints => [
229 USED_UNDERSCORE_BINDING,
230 SHORT_CIRCUIT_STATEMENT,
235 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for MiscLints {
238 cx: &LateContext<'a, 'tcx>,
240 decl: &'tcx FnDecl<'_>,
241 body: &'tcx Body<'_>,
245 if let FnKind::Closure(_) = k {
246 // Does not apply to closures
249 for arg in iter_input_pats(decl, body) {
251 PatKind::Binding(BindingAnnotation::Ref, ..) | PatKind::Binding(BindingAnnotation::RefMut, ..) => {
256 "`ref` directly on a function argument is ignored. Consider using a reference type \
265 fn check_stmt(&mut self, cx: &LateContext<'a, 'tcx>, stmt: &'tcx Stmt<'_>) {
267 if let StmtKind::Local(ref local) = stmt.kind;
268 if let PatKind::Binding(an, .., name, None) = local.pat.kind;
269 if let Some(ref init) = local.init;
271 if an == BindingAnnotation::Ref || an == BindingAnnotation::RefMut {
272 let sugg_init = if init.span.from_expansion() {
273 Sugg::hir_with_macro_callsite(cx, init, "..")
275 Sugg::hir(cx, init, "..")
277 let (mutopt, initref) = if an == BindingAnnotation::RefMut {
278 ("mut ", sugg_init.mut_addr())
280 ("", sugg_init.addr())
282 let tyopt = if let Some(ref ty) = local.ty {
283 format!(": &{mutopt}{ty}", mutopt=mutopt, ty=snippet(cx, ty.span, "_"))
287 span_lint_hir_and_then(
292 "`ref` on an entire `let` pattern is discouraged, take a reference with `&` instead",
298 "let {name}{tyopt} = {initref};",
299 name=snippet(cx, name.span, "_"),
303 Applicability::MachineApplicable,
311 if let StmtKind::Semi(ref expr) = stmt.kind;
312 if let ExprKind::Binary(ref binop, ref a, ref b) = expr.kind;
313 if binop.node == BinOpKind::And || binop.node == BinOpKind::Or;
314 if let Some(sugg) = Sugg::hir_opt(cx, a);
316 span_lint_and_then(cx,
317 SHORT_CIRCUIT_STATEMENT,
319 "boolean short circuit operator in statement may be clearer using an explicit test",
321 let sugg = if binop.node == BinOpKind::Or { !sugg } else { sugg };
328 &snippet(cx, b.span, ".."),
330 Applicability::MachineApplicable, // snippet
337 fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr<'_>) {
339 ExprKind::Cast(ref e, ref ty) => {
340 check_cast(cx, expr.span, e, ty);
343 ExprKind::Binary(ref cmp, ref left, ref right) => {
345 if op.is_comparison() {
346 check_nan(cx, left, expr);
347 check_nan(cx, right, expr);
348 check_to_owned(cx, left, right);
349 check_to_owned(cx, right, left);
351 if (op == BinOpKind::Eq || op == BinOpKind::Ne) && (is_float(cx, left) || is_float(cx, right)) {
352 if is_allowed(cx, left) || is_allowed(cx, right) {
356 // Allow comparing the results of signum()
357 if is_signum(cx, left) && is_signum(cx, right) {
361 if let Some(name) = get_item_name(cx, expr) {
362 let name = name.as_str();
366 || name.starts_with("eq_")
367 || name.ends_with("_eq")
372 let (lint, msg) = if is_named_constant(cx, left) || is_named_constant(cx, right) {
373 (FLOAT_CMP_CONST, "strict comparison of `f32` or `f64` constant")
375 (FLOAT_CMP, "strict comparison of `f32` or `f64`")
377 span_lint_and_then(cx, lint, expr.span, msg, |db| {
378 let lhs = Sugg::hir(cx, left, "..");
379 let rhs = Sugg::hir(cx, right, "..");
383 "consider comparing them within some error",
385 "({}).abs() {} error",
387 if op == BinOpKind::Eq { '<' } else { '>' }
389 Applicability::HasPlaceholders, // snippet
391 db.span_note(expr.span, "`f32::EPSILON` and `f64::EPSILON` are available.");
393 } else if op == BinOpKind::Rem && is_integer_const(cx, right, 1) {
394 span_lint(cx, MODULO_ONE, expr.span, "any number modulo 1 will be 0");
399 if in_attributes_expansion(expr) {
400 // Don't lint things expanded by #[derive(...)], etc
403 let binding = match expr.kind {
404 ExprKind::Path(ref qpath) => {
405 let binding = last_path_segment(qpath).ident.as_str();
406 if binding.starts_with('_') &&
407 !binding.starts_with("__") &&
408 binding != "_result" && // FIXME: #944
410 // don't lint if the declaration is in a macro
411 non_macro_local(cx, cx.tables.qpath_res(qpath, expr.hir_id))
418 ExprKind::Field(_, ident) => {
419 let name = ident.as_str();
420 if name.starts_with('_') && !name.starts_with("__") {
428 if let Some(binding) = binding {
431 USED_UNDERSCORE_BINDING,
434 "used binding `{}` which is prefixed with an underscore. A leading \
435 underscore signals that a binding will not be used.",
443 fn check_nan(cx: &LateContext<'_, '_>, expr: &Expr<'_>, cmp_expr: &Expr<'_>) {
445 if !in_constant(cx, cmp_expr.hir_id);
446 if let Some((value, _)) = constant(cx, cx.tables, expr);
448 let needs_lint = match value {
449 Constant::F32(num) => num.is_nan(),
450 Constant::F64(num) => num.is_nan(),
459 "doomed comparison with `NAN`, use `{f32,f64}::is_nan()` instead",
466 fn is_named_constant<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr<'_>) -> bool {
467 if let Some((_, res)) = constant(cx, cx.tables, expr) {
474 fn is_allowed<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr<'_>) -> bool {
475 match constant(cx, cx.tables, expr) {
476 Some((Constant::F32(f), _)) => f == 0.0 || f.is_infinite(),
477 Some((Constant::F64(f), _)) => f == 0.0 || f.is_infinite(),
482 // Return true if `expr` is the result of `signum()` invoked on a float value.
483 fn is_signum(cx: &LateContext<'_, '_>, expr: &Expr<'_>) -> bool {
484 // The negation of a signum is still a signum
485 if let ExprKind::Unary(UnOp::UnNeg, ref child_expr) = expr.kind {
486 return is_signum(cx, &child_expr);
490 if let ExprKind::MethodCall(ref method_name, _, ref expressions) = expr.kind;
491 if sym!(signum) == method_name.ident.name;
492 // Check that the receiver of the signum() is a float (expressions[0] is the receiver of
495 return is_float(cx, &expressions[0]);
501 fn is_float(cx: &LateContext<'_, '_>, expr: &Expr<'_>) -> bool {
502 matches!(walk_ptrs_ty(cx.tables.expr_ty(expr)).kind, ty::Float(_))
505 fn check_to_owned(cx: &LateContext<'_, '_>, expr: &Expr<'_>, other: &Expr<'_>) {
506 let (arg_ty, snip) = match expr.kind {
507 ExprKind::MethodCall(.., ref args) if args.len() == 1 => {
508 if match_trait_method(cx, expr, &paths::TO_STRING) || match_trait_method(cx, expr, &paths::TO_OWNED) {
509 (cx.tables.expr_ty_adjusted(&args[0]), snippet(cx, args[0].span, ".."))
514 ExprKind::Call(ref path, ref v) if v.len() == 1 => {
515 if let ExprKind::Path(ref path) = path.kind {
516 if match_qpath(path, &["String", "from_str"]) || match_qpath(path, &["String", "from"]) {
517 (cx.tables.expr_ty_adjusted(&v[0]), snippet(cx, v[0].span, ".."))
528 let other_ty = cx.tables.expr_ty_adjusted(other);
529 let partial_eq_trait_id = match cx.tcx.lang_items().eq_trait() {
534 let deref_arg_impl_partial_eq_other = arg_ty.builtin_deref(true).map_or(false, |tam| {
535 implements_trait(cx, tam.ty, partial_eq_trait_id, &[other_ty.into()])
537 let arg_impl_partial_eq_deref_other = other_ty.builtin_deref(true).map_or(false, |tam| {
538 implements_trait(cx, arg_ty, partial_eq_trait_id, &[tam.ty.into()])
540 let arg_impl_partial_eq_other = implements_trait(cx, arg_ty, partial_eq_trait_id, &[other_ty.into()]);
542 if !deref_arg_impl_partial_eq_other && !arg_impl_partial_eq_deref_other && !arg_impl_partial_eq_other {
546 let other_gets_derefed = match other.kind {
547 ExprKind::Unary(UnOp::UnDeref, _) => true,
551 let lint_span = if other_gets_derefed {
552 expr.span.to(other.span)
561 "this creates an owned instance just for comparison",
563 // This also catches `PartialEq` implementations that call `to_owned`.
564 if other_gets_derefed {
565 db.span_label(lint_span, "try implementing the comparison without allocating");
569 let try_hint = if deref_arg_impl_partial_eq_other {
570 // suggest deref on the left
573 // suggest dropping the to_owned on the left
581 Applicability::MachineApplicable, // snippet
587 /// Heuristic to see if an expression is used. Should be compatible with
588 /// `unused_variables`'s idea
589 /// of what it means for an expression to be "used".
590 fn is_used(cx: &LateContext<'_, '_>, expr: &Expr<'_>) -> bool {
591 if let Some(parent) = get_parent_expr(cx, expr) {
593 ExprKind::Assign(_, ref rhs, _) | ExprKind::AssignOp(_, _, ref rhs) => {
594 SpanlessEq::new(cx).eq_expr(rhs, expr)
596 _ => is_used(cx, parent),
603 /// Tests whether an expression is in a macro expansion (e.g., something
604 /// generated by `#[derive(...)]` or the like).
605 fn in_attributes_expansion(expr: &Expr<'_>) -> bool {
606 use rustc_span::hygiene::MacroKind;
607 if expr.span.from_expansion() {
608 let data = expr.span.ctxt().outer_expn_data();
610 if let ExpnKind::Macro(MacroKind::Attr, _) = data.kind {
620 /// Tests whether `res` is a variable defined outside a macro.
621 fn non_macro_local(cx: &LateContext<'_, '_>, res: def::Res) -> bool {
622 if let def::Res::Local(id) = res {
623 !cx.tcx.hir().span(id).from_expansion()
629 fn check_cast(cx: &LateContext<'_, '_>, span: Span, e: &Expr<'_>, ty: &Ty<'_>) {
631 if let TyKind::Ptr(ref mut_ty) = ty.kind;
632 if let ExprKind::Lit(ref lit) = e.kind;
633 if let LitKind::Int(0, _) = lit.node;
634 if !in_constant(cx, e.hir_id);
636 let (msg, sugg_fn) = match mut_ty.mutbl {
637 Mutability::Mut => ("`0 as *mut _` detected", "std::ptr::null_mut"),
638 Mutability::Not => ("`0 as *const _` detected", "std::ptr::null"),
641 let (sugg, appl) = if let TyKind::Infer = mut_ty.ty.kind {
642 (format!("{}()", sugg_fn), Applicability::MachineApplicable)
643 } else if let Some(mut_ty_snip) = snippet_opt(cx, mut_ty.ty.span) {
644 (format!("{}::<{}>()", sugg_fn, mut_ty_snip), Applicability::MachineApplicable)
646 // `MaybeIncorrect` as type inference may not work with the suggested code
647 (format!("{}()", sugg_fn), Applicability::MaybeIncorrect)
649 span_lint_and_sugg(cx, ZERO_PTR, span, msg, "try", sugg, appl);