]> git.lizzy.rs Git - rust.git/blob - clippy_lints/src/misc.rs
Auto merge of #4744 - phansch:split_up_some_derive_test, r=flip1995
[rust.git] / 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, snippet_opt, span_lint, span_lint_and_sugg,
17     span_lint_and_then, 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.kind {
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>, stmt: &'tcx Stmt) {
265         if_chain! {
266             if let StmtKind::Local(ref local) = stmt.kind;
267             if let PatKind::Binding(an, .., name, None) = local.pat.kind;
268             if let Some(ref init) = local.init;
269             then {
270                 if an == BindingAnnotation::Ref || an == BindingAnnotation::RefMut {
271                     let sugg_init = if init.span.from_expansion() {
272                         Sugg::hir_with_macro_callsite(cx, init, "..")
273                     } else {
274                         Sugg::hir(cx, init, "..")
275                     };
276                     let (mutopt, initref) = if an == BindingAnnotation::RefMut {
277                         ("mut ", sugg_init.mut_addr())
278                     } else {
279                         ("", sugg_init.addr())
280                     };
281                     let tyopt = if let Some(ref ty) = local.ty {
282                         format!(": &{mutopt}{ty}", mutopt=mutopt, ty=snippet(cx, ty.span, "_"))
283                     } else {
284                         String::new()
285                     };
286                     span_lint_hir_and_then(
287                         cx,
288                         TOPLEVEL_REF_ARG,
289                         init.hir_id,
290                         local.pat.span,
291                         "`ref` on an entire `let` pattern is discouraged, take a reference with `&` instead",
292                         |db| {
293                             db.span_suggestion(
294                                 stmt.span,
295                                 "try",
296                                 format!(
297                                     "let {name}{tyopt} = {initref};",
298                                     name=snippet(cx, name.span, "_"),
299                                     tyopt=tyopt,
300                                     initref=initref,
301                                 ),
302                                 Applicability::MachineApplicable,
303                             );
304                         }
305                     );
306                 }
307             }
308         };
309         if_chain! {
310             if let StmtKind::Semi(ref expr) = stmt.kind;
311             if let ExprKind::Binary(ref binop, ref a, ref b) = expr.kind;
312             if binop.node == BinOpKind::And || binop.node == BinOpKind::Or;
313             if let Some(sugg) = Sugg::hir_opt(cx, a);
314             then {
315                 span_lint_and_then(cx,
316                     SHORT_CIRCUIT_STATEMENT,
317                     stmt.span,
318                     "boolean short circuit operator in statement may be clearer using an explicit test",
319                     |db| {
320                         let sugg = if binop.node == BinOpKind::Or { !sugg } else { sugg };
321                         db.span_suggestion(
322                             stmt.span,
323                             "replace it with",
324                             format!(
325                                 "if {} {{ {}; }}",
326                                 sugg,
327                                 &snippet(cx, b.span, ".."),
328                             ),
329                             Applicability::MachineApplicable, // snippet
330                         );
331                     });
332             }
333         };
334     }
335
336     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
337         match expr.kind {
338             ExprKind::Cast(ref e, ref ty) => {
339                 check_cast(cx, expr.span, e, ty);
340                 return;
341             },
342             ExprKind::Binary(ref cmp, ref left, ref right) => {
343                 let op = cmp.node;
344                 if op.is_comparison() {
345                     if let ExprKind::Path(QPath::Resolved(_, ref path)) = left.kind {
346                         check_nan(cx, path, expr);
347                     }
348                     if let ExprKind::Path(QPath::Resolved(_, ref path)) = right.kind {
349                         check_nan(cx, path, expr);
350                     }
351                     check_to_owned(cx, left, right);
352                     check_to_owned(cx, right, left);
353                 }
354                 if (op == BinOpKind::Eq || op == BinOpKind::Ne) && (is_float(cx, left) || is_float(cx, right)) {
355                     if is_allowed(cx, left) || is_allowed(cx, right) {
356                         return;
357                     }
358
359                     // Allow comparing the results of signum()
360                     if is_signum(cx, left) && is_signum(cx, right) {
361                         return;
362                     }
363
364                     if let Some(name) = get_item_name(cx, expr) {
365                         let name = name.as_str();
366                         if name == "eq"
367                             || name == "ne"
368                             || name == "is_nan"
369                             || name.starts_with("eq_")
370                             || name.ends_with("_eq")
371                         {
372                             return;
373                         }
374                     }
375                     let (lint, msg) = if is_named_constant(cx, left) || is_named_constant(cx, right) {
376                         (FLOAT_CMP_CONST, "strict comparison of f32 or f64 constant")
377                     } else {
378                         (FLOAT_CMP, "strict comparison of f32 or f64")
379                     };
380                     span_lint_and_then(cx, lint, expr.span, msg, |db| {
381                         let lhs = Sugg::hir(cx, left, "..");
382                         let rhs = Sugg::hir(cx, right, "..");
383
384                         db.span_suggestion(
385                             expr.span,
386                             "consider comparing them within some error",
387                             format!(
388                                 "({}).abs() {} error",
389                                 lhs - rhs,
390                                 if op == BinOpKind::Eq { '<' } else { '>' }
391                             ),
392                             Applicability::HasPlaceholders, // snippet
393                         );
394                         db.span_note(expr.span, "std::f32::EPSILON and std::f64::EPSILON are available.");
395                     });
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");
398                 }
399             },
400             _ => {},
401         }
402         if in_attributes_expansion(expr) {
403             // Don't lint things expanded by #[derive(...)], etc
404             return;
405         }
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
412                     is_used(cx, expr) &&
413                     // don't lint if the declaration is in a macro
414                     non_macro_local(cx, cx.tables.qpath_res(qpath, expr.hir_id))
415                 {
416                     Some(binding)
417                 } else {
418                     None
419                 }
420             },
421             ExprKind::Field(_, ident) => {
422                 let name = ident.as_str();
423                 if name.starts_with('_') && !name.starts_with("__") {
424                     Some(name)
425                 } else {
426                     None
427                 }
428             },
429             _ => None,
430         };
431         if let Some(binding) = binding {
432             span_lint(
433                 cx,
434                 USED_UNDERSCORE_BINDING,
435                 expr.span,
436                 &format!(
437                     "used binding `{}` which is prefixed with an underscore. A leading \
438                      underscore signals that a binding will not be used.",
439                     binding
440                 ),
441             );
442         }
443     }
444 }
445
446 fn check_nan(cx: &LateContext<'_, '_>, path: &Path, expr: &Expr) {
447     if !in_constant(cx, expr.hir_id) {
448         if let Some(seg) = path.segments.last() {
449             if seg.ident.name == sym!(NAN) {
450                 span_lint(
451                     cx,
452                     CMP_NAN,
453                     expr.span,
454                     "doomed comparison with NAN, use `std::{f32,f64}::is_nan()` instead",
455                 );
456             }
457         }
458     }
459 }
460
461 fn is_named_constant<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) -> bool {
462     if let Some((_, res)) = constant(cx, cx.tables, expr) {
463         res
464     } else {
465         false
466     }
467 }
468
469 fn is_allowed<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) -> bool {
470     match constant(cx, cx.tables, expr) {
471         Some((Constant::F32(f), _)) => f == 0.0 || f.is_infinite(),
472         Some((Constant::F64(f), _)) => f == 0.0 || f.is_infinite(),
473         _ => false,
474     }
475 }
476
477 // Return true if `expr` is the result of `signum()` invoked on a float value.
478 fn is_signum(cx: &LateContext<'_, '_>, expr: &Expr) -> bool {
479     // The negation of a signum is still a signum
480     if let ExprKind::Unary(UnNeg, ref child_expr) = expr.kind {
481         return is_signum(cx, &child_expr);
482     }
483
484     if_chain! {
485         if let ExprKind::MethodCall(ref method_name, _, ref expressions) = expr.kind;
486         if sym!(signum) == method_name.ident.name;
487         // Check that the receiver of the signum() is a float (expressions[0] is the receiver of
488         // the method call)
489         then {
490             return is_float(cx, &expressions[0]);
491         }
492     }
493     false
494 }
495
496 fn is_float(cx: &LateContext<'_, '_>, expr: &Expr) -> bool {
497     matches!(walk_ptrs_ty(cx.tables.expr_ty(expr)).kind, ty::Float(_))
498 }
499
500 fn check_to_owned(cx: &LateContext<'_, '_>, expr: &Expr, other: &Expr) {
501     let (arg_ty, snip) = match expr.kind {
502         ExprKind::MethodCall(.., ref args) if args.len() == 1 => {
503             if match_trait_method(cx, expr, &paths::TO_STRING) || match_trait_method(cx, expr, &paths::TO_OWNED) {
504                 (cx.tables.expr_ty_adjusted(&args[0]), snippet(cx, args[0].span, ".."))
505             } else {
506                 return;
507             }
508         },
509         ExprKind::Call(ref path, ref v) if v.len() == 1 => {
510             if let ExprKind::Path(ref path) = path.kind {
511                 if match_qpath(path, &["String", "from_str"]) || match_qpath(path, &["String", "from"]) {
512                     (cx.tables.expr_ty_adjusted(&v[0]), snippet(cx, v[0].span, ".."))
513                 } else {
514                     return;
515                 }
516             } else {
517                 return;
518             }
519         },
520         _ => return,
521     };
522
523     let other_ty = cx.tables.expr_ty_adjusted(other);
524     let partial_eq_trait_id = match cx.tcx.lang_items().eq_trait() {
525         Some(id) => id,
526         None => return,
527     };
528
529     let deref_arg_impl_partial_eq_other = arg_ty.builtin_deref(true).map_or(false, |tam| {
530         implements_trait(cx, tam.ty, partial_eq_trait_id, &[other_ty.into()])
531     });
532     let arg_impl_partial_eq_deref_other = other_ty.builtin_deref(true).map_or(false, |tam| {
533         implements_trait(cx, arg_ty, partial_eq_trait_id, &[tam.ty.into()])
534     });
535     let arg_impl_partial_eq_other = implements_trait(cx, arg_ty, partial_eq_trait_id, &[other_ty.into()]);
536
537     if !deref_arg_impl_partial_eq_other && !arg_impl_partial_eq_deref_other && !arg_impl_partial_eq_other {
538         return;
539     }
540
541     let other_gets_derefed = match other.kind {
542         ExprKind::Unary(UnDeref, _) => true,
543         _ => false,
544     };
545
546     let lint_span = if other_gets_derefed {
547         expr.span.to(other.span)
548     } else {
549         expr.span
550     };
551
552     span_lint_and_then(
553         cx,
554         CMP_OWNED,
555         lint_span,
556         "this creates an owned instance just for comparison",
557         |db| {
558             // This also catches `PartialEq` implementations that call `to_owned`.
559             if other_gets_derefed {
560                 db.span_label(lint_span, "try implementing the comparison without allocating");
561                 return;
562             }
563
564             let try_hint = if deref_arg_impl_partial_eq_other {
565                 // suggest deref on the left
566                 format!("*{}", snip)
567             } else {
568                 // suggest dropping the to_owned on the left
569                 snip.to_string()
570             };
571
572             db.span_suggestion(
573                 lint_span,
574                 "try",
575                 try_hint,
576                 Applicability::MachineApplicable, // snippet
577             );
578         },
579     );
580 }
581
582 /// Heuristic to see if an expression is used. Should be compatible with
583 /// `unused_variables`'s idea
584 /// of what it means for an expression to be "used".
585 fn is_used(cx: &LateContext<'_, '_>, expr: &Expr) -> bool {
586     if let Some(parent) = get_parent_expr(cx, expr) {
587         match parent.kind {
588             ExprKind::Assign(_, ref rhs) | ExprKind::AssignOp(_, _, ref rhs) => SpanlessEq::new(cx).eq_expr(rhs, expr),
589             _ => is_used(cx, parent),
590         }
591     } else {
592         true
593     }
594 }
595
596 /// Tests whether an expression is in a macro expansion (e.g., something
597 /// generated by `#[derive(...)]` or the like).
598 fn in_attributes_expansion(expr: &Expr) -> bool {
599     use syntax_pos::hygiene::MacroKind;
600     if expr.span.from_expansion() {
601         let data = expr.span.ctxt().outer_expn_data();
602
603         if let ExpnKind::Macro(MacroKind::Attr, _) = data.kind {
604             true
605         } else {
606             false
607         }
608     } else {
609         false
610     }
611 }
612
613 /// Tests whether `res` is a variable defined outside a macro.
614 fn non_macro_local(cx: &LateContext<'_, '_>, res: def::Res) -> bool {
615     if let def::Res::Local(id) = res {
616         !cx.tcx.hir().span(id).from_expansion()
617     } else {
618         false
619     }
620 }
621
622 fn check_cast(cx: &LateContext<'_, '_>, span: Span, e: &Expr, ty: &Ty) {
623     if_chain! {
624         if let TyKind::Ptr(ref mut_ty) = ty.kind;
625         if let ExprKind::Lit(ref lit) = e.kind;
626         if let LitKind::Int(0, _) = lit.node;
627         if !in_constant(cx, e.hir_id);
628         then {
629             let (msg, sugg_fn) = match mut_ty.mutbl {
630                 Mutability::MutMutable => ("`0 as *mut _` detected", "std::ptr::null_mut"),
631                 Mutability::MutImmutable => ("`0 as *const _` detected", "std::ptr::null"),
632             };
633
634             let (sugg, appl) = if let TyKind::Infer = mut_ty.ty.kind {
635                 (format!("{}()", sugg_fn), Applicability::MachineApplicable)
636             } else if let Some(mut_ty_snip) = snippet_opt(cx, mut_ty.ty.span) {
637                 (format!("{}::<{}>()", sugg_fn, mut_ty_snip), Applicability::MachineApplicable)
638             } else {
639                 // `MaybeIncorrect` as type inference may not work with the suggested code
640                 (format!("{}()", sugg_fn), Applicability::MaybeIncorrect)
641             };
642             span_lint_and_sugg(cx, ZERO_PTR, span, msg, "try", sugg, appl);
643         }
644     }
645 }