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, higher, 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;
270 if !higher::is_from_for_desugar(local);
272 if an == BindingAnnotation::Ref || an == BindingAnnotation::RefMut {
273 let sugg_init = if init.span.from_expansion() {
274 Sugg::hir_with_macro_callsite(cx, init, "..")
276 Sugg::hir(cx, init, "..")
278 let (mutopt, initref) = if an == BindingAnnotation::RefMut {
279 ("mut ", sugg_init.mut_addr())
281 ("", sugg_init.addr())
283 let tyopt = if let Some(ref ty) = local.ty {
284 format!(": &{mutopt}{ty}", mutopt=mutopt, ty=snippet(cx, ty.span, "_"))
288 span_lint_hir_and_then(
293 "`ref` on an entire `let` pattern is discouraged, take a reference with `&` instead",
295 diag.span_suggestion(
299 "let {name}{tyopt} = {initref};",
300 name=snippet(cx, name.span, "_"),
304 Applicability::MachineApplicable,
312 if let StmtKind::Semi(ref expr) = stmt.kind;
313 if let ExprKind::Binary(ref binop, ref a, ref b) = expr.kind;
314 if binop.node == BinOpKind::And || binop.node == BinOpKind::Or;
315 if let Some(sugg) = Sugg::hir_opt(cx, a);
317 span_lint_and_then(cx,
318 SHORT_CIRCUIT_STATEMENT,
320 "boolean short circuit operator in statement may be clearer using an explicit test",
322 let sugg = if binop.node == BinOpKind::Or { !sugg } else { sugg };
323 diag.span_suggestion(
329 &snippet(cx, b.span, ".."),
331 Applicability::MachineApplicable, // snippet
338 fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr<'_>) {
340 ExprKind::Cast(ref e, ref ty) => {
341 check_cast(cx, expr.span, e, ty);
344 ExprKind::Binary(ref cmp, ref left, ref right) => {
346 if op.is_comparison() {
347 check_nan(cx, left, expr);
348 check_nan(cx, right, expr);
349 check_to_owned(cx, left, right);
350 check_to_owned(cx, right, left);
352 if (op == BinOpKind::Eq || op == BinOpKind::Ne) && (is_float(cx, left) || is_float(cx, right)) {
353 if is_allowed(cx, left) || is_allowed(cx, right) {
357 // Allow comparing the results of signum()
358 if is_signum(cx, left) && is_signum(cx, right) {
362 if let Some(name) = get_item_name(cx, expr) {
363 let name = name.as_str();
367 || name.starts_with("eq_")
368 || name.ends_with("_eq")
373 let is_comparing_arrays = is_array(cx, left) || is_array(cx, right);
374 let (lint, msg) = get_lint_and_message(
375 is_named_constant(cx, left) || is_named_constant(cx, right),
378 span_lint_and_then(cx, lint, expr.span, msg, |diag| {
379 let lhs = Sugg::hir(cx, left, "..");
380 let rhs = Sugg::hir(cx, right, "..");
382 if !is_comparing_arrays {
383 diag.span_suggestion(
385 "consider comparing them within some error",
387 "({}).abs() {} error",
389 if op == BinOpKind::Eq { '<' } else { '>' }
391 Applicability::HasPlaceholders, // snippet
394 diag.note("`f32::EPSILON` and `f64::EPSILON` are available for the `error`");
396 } else if op == BinOpKind::Rem && is_integer_const(cx, right, 1) {
397 span_lint(cx, MODULO_ONE, expr.span, "any number modulo 1 will be 0");
402 if in_attributes_expansion(expr) {
403 // Don't lint things expanded by #[derive(...)], etc
406 let binding = match expr.kind {
407 ExprKind::Path(ref qpath) => {
408 let binding = last_path_segment(qpath).ident.as_str();
409 if binding.starts_with('_') &&
410 !binding.starts_with("__") &&
411 binding != "_result" && // FIXME: #944
413 // don't lint if the declaration is in a macro
414 non_macro_local(cx, cx.tables.qpath_res(qpath, expr.hir_id))
421 ExprKind::Field(_, ident) => {
422 let name = ident.as_str();
423 if name.starts_with('_') && !name.starts_with("__") {
431 if let Some(binding) = binding {
434 USED_UNDERSCORE_BINDING,
437 "used binding `{}` which is prefixed with an underscore. A leading \
438 underscore signals that a binding will not be used.",
446 fn get_lint_and_message(
447 is_comparing_constants: bool,
448 is_comparing_arrays: bool,
449 ) -> (&'static rustc_lint::Lint, &'static str) {
450 if is_comparing_constants {
453 if is_comparing_arrays {
454 "strict comparison of `f32` or `f64` constant arrays"
456 "strict comparison of `f32` or `f64` constant"
462 if is_comparing_arrays {
463 "strict comparison of `f32` or `f64` arrays"
465 "strict comparison of `f32` or `f64`"
471 fn check_nan(cx: &LateContext<'_, '_>, expr: &Expr<'_>, cmp_expr: &Expr<'_>) {
473 if !in_constant(cx, cmp_expr.hir_id);
474 if let Some((value, _)) = constant(cx, cx.tables, expr);
476 let needs_lint = match value {
477 Constant::F32(num) => num.is_nan(),
478 Constant::F64(num) => num.is_nan(),
487 "doomed comparison with `NAN`, use `{f32,f64}::is_nan()` instead",
494 fn is_named_constant<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr<'_>) -> bool {
495 if let Some((_, res)) = constant(cx, cx.tables, expr) {
502 fn is_allowed<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr<'_>) -> bool {
503 match constant(cx, cx.tables, expr) {
504 Some((Constant::F32(f), _)) => f == 0.0 || f.is_infinite(),
505 Some((Constant::F64(f), _)) => f == 0.0 || f.is_infinite(),
506 Some((Constant::Vec(vec), _)) => vec.iter().all(|f| match f {
507 Constant::F32(f) => *f == 0.0 || (*f).is_infinite(),
508 Constant::F64(f) => *f == 0.0 || (*f).is_infinite(),
515 // Return true if `expr` is the result of `signum()` invoked on a float value.
516 fn is_signum(cx: &LateContext<'_, '_>, expr: &Expr<'_>) -> bool {
517 // The negation of a signum is still a signum
518 if let ExprKind::Unary(UnOp::UnNeg, ref child_expr) = expr.kind {
519 return is_signum(cx, &child_expr);
523 if let ExprKind::MethodCall(ref method_name, _, ref expressions) = expr.kind;
524 if sym!(signum) == method_name.ident.name;
525 // Check that the receiver of the signum() is a float (expressions[0] is the receiver of
528 return is_float(cx, &expressions[0]);
534 fn is_float(cx: &LateContext<'_, '_>, expr: &Expr<'_>) -> bool {
535 let value = &walk_ptrs_ty(cx.tables.expr_ty(expr)).kind;
537 if let ty::Array(arr_ty, _) = value {
538 return matches!(arr_ty.kind, ty::Float(_));
541 matches!(value, ty::Float(_))
544 fn is_array(cx: &LateContext<'_, '_>, expr: &Expr<'_>) -> bool {
545 matches!(&walk_ptrs_ty(cx.tables.expr_ty(expr)).kind, ty::Array(_, _))
548 fn check_to_owned(cx: &LateContext<'_, '_>, expr: &Expr<'_>, other: &Expr<'_>) {
549 let (arg_ty, snip) = match expr.kind {
550 ExprKind::MethodCall(.., ref args) if args.len() == 1 => {
551 if match_trait_method(cx, expr, &paths::TO_STRING) || match_trait_method(cx, expr, &paths::TO_OWNED) {
552 (cx.tables.expr_ty_adjusted(&args[0]), snippet(cx, args[0].span, ".."))
557 ExprKind::Call(ref path, ref v) if v.len() == 1 => {
558 if let ExprKind::Path(ref path) = path.kind {
559 if match_qpath(path, &["String", "from_str"]) || match_qpath(path, &["String", "from"]) {
560 (cx.tables.expr_ty_adjusted(&v[0]), snippet(cx, v[0].span, ".."))
571 let other_ty = cx.tables.expr_ty_adjusted(other);
572 let partial_eq_trait_id = match cx.tcx.lang_items().eq_trait() {
577 let deref_arg_impl_partial_eq_other = arg_ty.builtin_deref(true).map_or(false, |tam| {
578 implements_trait(cx, tam.ty, partial_eq_trait_id, &[other_ty.into()])
580 let arg_impl_partial_eq_deref_other = other_ty.builtin_deref(true).map_or(false, |tam| {
581 implements_trait(cx, arg_ty, partial_eq_trait_id, &[tam.ty.into()])
583 let arg_impl_partial_eq_other = implements_trait(cx, arg_ty, partial_eq_trait_id, &[other_ty.into()]);
585 if !deref_arg_impl_partial_eq_other && !arg_impl_partial_eq_deref_other && !arg_impl_partial_eq_other {
589 let other_gets_derefed = match other.kind {
590 ExprKind::Unary(UnOp::UnDeref, _) => true,
594 let lint_span = if other_gets_derefed {
595 expr.span.to(other.span)
604 "this creates an owned instance just for comparison",
606 // This also catches `PartialEq` implementations that call `to_owned`.
607 if other_gets_derefed {
608 diag.span_label(lint_span, "try implementing the comparison without allocating");
612 let try_hint = if deref_arg_impl_partial_eq_other {
613 // suggest deref on the left
616 // suggest dropping the to_owned on the left
620 diag.span_suggestion(
624 Applicability::MachineApplicable, // snippet
630 /// Heuristic to see if an expression is used. Should be compatible with
631 /// `unused_variables`'s idea
632 /// of what it means for an expression to be "used".
633 fn is_used(cx: &LateContext<'_, '_>, expr: &Expr<'_>) -> bool {
634 if let Some(parent) = get_parent_expr(cx, expr) {
636 ExprKind::Assign(_, ref rhs, _) | ExprKind::AssignOp(_, _, ref rhs) => {
637 SpanlessEq::new(cx).eq_expr(rhs, expr)
639 _ => is_used(cx, parent),
646 /// Tests whether an expression is in a macro expansion (e.g., something
647 /// generated by `#[derive(...)]` or the like).
648 fn in_attributes_expansion(expr: &Expr<'_>) -> bool {
649 use rustc_span::hygiene::MacroKind;
650 if expr.span.from_expansion() {
651 let data = expr.span.ctxt().outer_expn_data();
653 if let ExpnKind::Macro(MacroKind::Attr, _) = data.kind {
663 /// Tests whether `res` is a variable defined outside a macro.
664 fn non_macro_local(cx: &LateContext<'_, '_>, res: def::Res) -> bool {
665 if let def::Res::Local(id) = res {
666 !cx.tcx.hir().span(id).from_expansion()
672 fn check_cast(cx: &LateContext<'_, '_>, span: Span, e: &Expr<'_>, ty: &Ty<'_>) {
674 if let TyKind::Ptr(ref mut_ty) = ty.kind;
675 if let ExprKind::Lit(ref lit) = e.kind;
676 if let LitKind::Int(0, _) = lit.node;
677 if !in_constant(cx, e.hir_id);
679 let (msg, sugg_fn) = match mut_ty.mutbl {
680 Mutability::Mut => ("`0 as *mut _` detected", "std::ptr::null_mut"),
681 Mutability::Not => ("`0 as *const _` detected", "std::ptr::null"),
684 let (sugg, appl) = if let TyKind::Infer = mut_ty.ty.kind {
685 (format!("{}()", sugg_fn), Applicability::MachineApplicable)
686 } else if let Some(mut_ty_snip) = snippet_opt(cx, mut_ty.ty.span) {
687 (format!("{}::<{}>()", sugg_fn, mut_ty_snip), Applicability::MachineApplicable)
689 // `MaybeIncorrect` as type inference may not work with the suggested code
690 (format!("{}()", sugg_fn), Applicability::MaybeIncorrect)
692 span_lint_and_sugg(cx, ZERO_PTR, span, msg, "try", sugg, appl);