]> git.lizzy.rs Git - rust.git/blob - clippy_lints/src/types.rs
Merge pull request #3251 from rust-lang-nursery/relicense-rewrite
[rust.git] / clippy_lints / src / types.rs
1 #![allow(clippy::default_hash_types)]
2
3 use crate::reexport::*;
4 use crate::rustc::hir;
5 use crate::rustc::hir::*;
6 use crate::rustc::hir::intravisit::{walk_body, walk_expr, walk_ty, FnKind, NestedVisitorMap, Visitor};
7 use crate::rustc::lint::{LateContext, LateLintPass, LintArray, LintPass, in_external_macro, LintContext};
8 use crate::rustc::{declare_tool_lint, lint_array};
9 use if_chain::if_chain;
10 use crate::rustc::ty::{self, Ty, TyCtxt, TypeckTables};
11 use crate::rustc::ty::layout::LayoutOf;
12 use crate::rustc_typeck::hir_ty_to_ty;
13 use std::cmp::Ordering;
14 use std::collections::BTreeMap;
15 use std::borrow::Cow;
16 use crate::syntax::ast::{FloatTy, IntTy, UintTy};
17 use crate::syntax::source_map::Span;
18 use crate::syntax::errors::DiagnosticBuilder;
19 use crate::rustc_target::spec::abi::Abi;
20 use crate::utils::{comparisons, differing_macro_contexts, higher, in_constant, in_macro, last_path_segment, match_def_path, match_path,
21             match_type, multispan_sugg, opt_def_id, same_tys, snippet, snippet_opt, span_help_and_lint, span_lint,
22             span_lint_and_sugg, span_lint_and_then, clip, unsext, sext, int_bits};
23 use crate::utils::paths;
24 use crate::consts::{constant, Constant};
25
26 /// Handles all the linting of funky types
27 #[allow(missing_copy_implementations)]
28 pub struct TypePass;
29
30 /// **What it does:** Checks for use of `Box<Vec<_>>` anywhere in the code.
31 ///
32 /// **Why is this bad?** `Vec` already keeps its contents in a separate area on
33 /// the heap. So if you `Box` it, you just add another level of indirection
34 /// without any benefit whatsoever.
35 ///
36 /// **Known problems:** None.
37 ///
38 /// **Example:**
39 /// ```rust
40 /// struct X {
41 ///     values: Box<Vec<Foo>>,
42 /// }
43 /// ```
44 ///
45 /// Better:
46 ///
47 /// ```rust
48 /// struct X {
49 ///     values: Vec<Foo>,
50 /// }
51 /// ```
52 declare_clippy_lint! {
53     pub BOX_VEC,
54     perf,
55     "usage of `Box<Vec<T>>`, vector elements are already on the heap"
56 }
57
58 /// **What it does:** Checks for use of `Option<Option<_>>` in function signatures and type
59 /// definitions
60 ///
61 /// **Why is this bad?** `Option<_>` represents an optional value. `Option<Option<_>>`
62 /// represents an optional optional value which is logically the same thing as an optional
63 /// value but has an unneeded extra level of wrapping.
64 ///
65 /// **Known problems:** None.
66 ///
67 /// **Example**
68 /// ```rust
69 /// fn x() -> Option<Option<u32>> {
70 ///     None
71 /// }
72 declare_clippy_lint! {
73     pub OPTION_OPTION,
74     complexity,
75     "usage of `Option<Option<T>>`"
76 }
77
78 /// **What it does:** Checks for usage of any `LinkedList`, suggesting to use a
79 /// `Vec` or a `VecDeque` (formerly called `RingBuf`).
80 ///
81 /// **Why is this bad?** Gankro says:
82 ///
83 /// > The TL;DR of `LinkedList` is that it's built on a massive amount of
84 /// pointers and indirection.
85 /// > It wastes memory, it has terrible cache locality, and is all-around slow.
86 /// `RingBuf`, while
87 /// > "only" amortized for push/pop, should be faster in the general case for
88 /// almost every possible
89 /// > workload, and isn't even amortized at all if you can predict the capacity
90 /// you need.
91 /// >
92 /// > `LinkedList`s are only really good if you're doing a lot of merging or
93 /// splitting of lists.
94 /// > This is because they can just mangle some pointers instead of actually
95 /// copying the data. Even
96 /// > if you're doing a lot of insertion in the middle of the list, `RingBuf`
97 /// can still be better
98 /// > because of how expensive it is to seek to the middle of a `LinkedList`.
99 ///
100 /// **Known problems:** False positives – the instances where using a
101 /// `LinkedList` makes sense are few and far between, but they can still happen.
102 ///
103 /// **Example:**
104 /// ```rust
105 /// let x = LinkedList::new();
106 /// ```
107 declare_clippy_lint! {
108     pub LINKEDLIST,
109     pedantic,
110     "usage of LinkedList, usually a vector is faster, or a more specialized data \
111      structure like a VecDeque"
112 }
113
114 /// **What it does:** Checks for use of `&Box<T>` anywhere in the code.
115 ///
116 /// **Why is this bad?** Any `&Box<T>` can also be a `&T`, which is more
117 /// general.
118 ///
119 /// **Known problems:** None.
120 ///
121 /// **Example:**
122 /// ```rust
123 /// fn foo(bar: &Box<T>) { ... }
124 /// ```
125 ///
126 /// Better:
127 ///
128 /// ```rust
129 /// fn foo(bar: &T) { ... }
130 /// ```
131 declare_clippy_lint! {
132     pub BORROWED_BOX,
133     complexity,
134     "a borrow of a boxed type"
135 }
136
137 impl LintPass for TypePass {
138     fn get_lints(&self) -> LintArray {
139         lint_array!(BOX_VEC, OPTION_OPTION, LINKEDLIST, BORROWED_BOX)
140     }
141 }
142
143 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for TypePass {
144     fn check_fn(&mut self, cx: &LateContext<'_, '_>, _: FnKind<'_>, decl: &FnDecl, _: &Body, _: Span, id: NodeId) {
145         // skip trait implementations, see #605
146         if let Some(hir::Node::Item(item)) = cx.tcx.hir.find(cx.tcx.hir.get_parent(id)) {
147             if let ItemKind::Impl(_, _, _, _, Some(..), _, _) = item.node {
148                 return;
149             }
150         }
151
152         check_fn_decl(cx, decl);
153     }
154
155     fn check_struct_field(&mut self, cx: &LateContext<'_, '_>, field: &StructField) {
156         check_ty(cx, &field.ty, false);
157     }
158
159     fn check_trait_item(&mut self, cx: &LateContext<'_, '_>, item: &TraitItem) {
160         match item.node {
161             TraitItemKind::Const(ref ty, _) | TraitItemKind::Type(_, Some(ref ty)) => check_ty(cx, ty, false),
162             TraitItemKind::Method(ref sig, _) => check_fn_decl(cx, &sig.decl),
163             _ => (),
164         }
165     }
166
167     fn check_local(&mut self, cx: &LateContext<'_, '_>, local: &Local) {
168         if let Some(ref ty) = local.ty {
169             check_ty(cx, ty, true);
170         }
171     }
172 }
173
174 fn check_fn_decl(cx: &LateContext<'_, '_>, decl: &FnDecl) {
175     for input in &decl.inputs {
176         check_ty(cx, input, false);
177     }
178
179     if let FunctionRetTy::Return(ref ty) = decl.output {
180         check_ty(cx, ty, false);
181     }
182 }
183
184 /// Check if `qpath` has last segment with type parameter matching `path`
185 fn match_type_parameter(cx: &LateContext<'_, '_>, qpath: &QPath, path: &[&str]) -> bool {
186     let last = last_path_segment(qpath);
187     if_chain! {
188         if let Some(ref params) = last.args;
189         if !params.parenthesized;
190         if let Some(ty) = params.args.iter().find_map(|arg| match arg {
191             GenericArg::Type(ty) => Some(ty),
192             GenericArg::Lifetime(_) => None,
193         });
194         if let TyKind::Path(ref qpath) = ty.node;
195         if let Some(did) = opt_def_id(cx.tables.qpath_def(qpath, cx.tcx.hir.node_to_hir_id(ty.id)));
196         if match_def_path(cx.tcx, did, path);
197         then {
198             return true;
199         }
200     }
201     false
202 }
203
204 /// Recursively check for `TypePass` lints in the given type. Stop at the first
205 /// lint found.
206 ///
207 /// The parameter `is_local` distinguishes the context of the type; types from
208 /// local bindings should only be checked for the `BORROWED_BOX` lint.
209 fn check_ty(cx: &LateContext<'_, '_>, ast_ty: &hir::Ty, is_local: bool) {
210     if in_macro(ast_ty.span) {
211         return;
212     }
213     match ast_ty.node {
214         TyKind::Path(ref qpath) if !is_local => {
215             let hir_id = cx.tcx.hir.node_to_hir_id(ast_ty.id);
216             let def = cx.tables.qpath_def(qpath, hir_id);
217             if let Some(def_id) = opt_def_id(def) {
218                 if Some(def_id) == cx.tcx.lang_items().owned_box() {
219                     if match_type_parameter(cx, qpath, &paths::VEC) {
220                         span_help_and_lint(
221                             cx,
222                             BOX_VEC,
223                             ast_ty.span,
224                             "you seem to be trying to use `Box<Vec<T>>`. Consider using just `Vec<T>`",
225                             "`Vec<T>` is already on the heap, `Box<Vec<T>>` makes an extra allocation.",
226                         );
227                         return; // don't recurse into the type
228                     }
229                 } else if match_def_path(cx.tcx, def_id, &paths::OPTION) {
230                     if match_type_parameter(cx, qpath, &paths::OPTION) {
231                         span_lint(
232                             cx,
233                             OPTION_OPTION,
234                             ast_ty.span,
235                             "consider using `Option<T>` instead of `Option<Option<T>>` or a custom \
236                             enum if you need to distinguish all 3 cases",
237                         );
238                         return; // don't recurse into the type
239                     }
240                 } else if match_def_path(cx.tcx, def_id, &paths::LINKED_LIST) {
241                     span_help_and_lint(
242                         cx,
243                         LINKEDLIST,
244                         ast_ty.span,
245                         "I see you're using a LinkedList! Perhaps you meant some other data structure?",
246                         "a VecDeque might work",
247                     );
248                     return; // don't recurse into the type
249                 }
250             }
251             match *qpath {
252                 QPath::Resolved(Some(ref ty), ref p) => {
253                     check_ty(cx, ty, is_local);
254                     for ty in p.segments.iter().flat_map(|seg| {
255                         seg.args
256                             .as_ref()
257                             .map_or_else(|| [].iter(), |params| params.args.iter())
258                             .filter_map(|arg| match arg {
259                                 GenericArg::Type(ty) => Some(ty),
260                                 GenericArg::Lifetime(_) => None,
261                             })
262                     }) {
263                         check_ty(cx, ty, is_local);
264                     }
265                 },
266                 QPath::Resolved(None, ref p) => for ty in p.segments.iter().flat_map(|seg| {
267                     seg.args
268                         .as_ref()
269                         .map_or_else(|| [].iter(), |params| params.args.iter())
270                         .filter_map(|arg| match arg {
271                             GenericArg::Type(ty) => Some(ty),
272                             GenericArg::Lifetime(_) => None,
273                         })
274                 }) {
275                     check_ty(cx, ty, is_local);
276                 },
277                 QPath::TypeRelative(ref ty, ref seg) => {
278                     check_ty(cx, ty, is_local);
279                     if let Some(ref params) = seg.args {
280                         for ty in params.args.iter().filter_map(|arg| match arg {
281                             GenericArg::Type(ty) => Some(ty),
282                             GenericArg::Lifetime(_) => None,
283                         }) {
284                             check_ty(cx, ty, is_local);
285                         }
286                     }
287                 },
288             }
289         },
290         TyKind::Rptr(ref lt, ref mut_ty) => check_ty_rptr(cx, ast_ty, is_local, lt, mut_ty),
291         // recurse
292         TyKind::Slice(ref ty) | TyKind::Array(ref ty, _) | TyKind::Ptr(MutTy { ref ty, .. }) => check_ty(cx, ty, is_local),
293         TyKind::Tup(ref tys) => for ty in tys {
294             check_ty(cx, ty, is_local);
295         },
296         _ => {},
297     }
298 }
299
300 fn check_ty_rptr(cx: &LateContext<'_, '_>, ast_ty: &hir::Ty, is_local: bool, lt: &Lifetime, mut_ty: &MutTy) {
301     match mut_ty.ty.node {
302         TyKind::Path(ref qpath) => {
303             let hir_id = cx.tcx.hir.node_to_hir_id(mut_ty.ty.id);
304             let def = cx.tables.qpath_def(qpath, hir_id);
305             if_chain! {
306                 if let Some(def_id) = opt_def_id(def);
307                 if Some(def_id) == cx.tcx.lang_items().owned_box();
308                 if let QPath::Resolved(None, ref path) = *qpath;
309                 if let [ref bx] = *path.segments;
310                 if let Some(ref params) = bx.args;
311                 if !params.parenthesized;
312                 if let Some(inner) = params.args.iter().find_map(|arg| match arg {
313                     GenericArg::Type(ty) => Some(ty),
314                     GenericArg::Lifetime(_) => None,
315                 });
316                 then {
317                     if is_any_trait(inner) {
318                         // Ignore `Box<Any>` types, see #1884 for details.
319                         return;
320                     }
321
322                     let ltopt = if lt.is_elided() {
323                         String::new()
324                     } else {
325                         format!("{} ", lt.name.ident().name.as_str())
326                     };
327                     let mutopt = if mut_ty.mutbl == Mutability::MutMutable {
328                         "mut "
329                     } else {
330                         ""
331                     };
332                     span_lint_and_sugg(cx,
333                         BORROWED_BOX,
334                         ast_ty.span,
335                         "you seem to be trying to use `&Box<T>`. Consider using just `&T`",
336                         "try",
337                         format!("&{}{}{}", ltopt, mutopt, &snippet(cx, inner.span, ".."))
338                     );
339                     return; // don't recurse into the type
340                 }
341             };
342             check_ty(cx, &mut_ty.ty, is_local);
343         },
344         _ => check_ty(cx, &mut_ty.ty, is_local),
345     }
346 }
347
348 // Returns true if given type is `Any` trait.
349 fn is_any_trait(t: &hir::Ty) -> bool {
350     if_chain! {
351         if let TyKind::TraitObject(ref traits, _) = t.node;
352         if traits.len() >= 1;
353         // Only Send/Sync can be used as additional traits, so it is enough to
354         // check only the first trait.
355         if match_path(&traits[0].trait_ref.path, &paths::ANY_TRAIT);
356         then {
357             return true;
358         }
359     }
360
361     false
362 }
363
364 #[allow(missing_copy_implementations)]
365 pub struct LetPass;
366
367 /// **What it does:** Checks for binding a unit value.
368 ///
369 /// **Why is this bad?** A unit value cannot usefully be used anywhere. So
370 /// binding one is kind of pointless.
371 ///
372 /// **Known problems:** None.
373 ///
374 /// **Example:**
375 /// ```rust
376 /// let x = { 1; };
377 /// ```
378 declare_clippy_lint! {
379     pub LET_UNIT_VALUE,
380     style,
381     "creating a let binding to a value of unit type, which usually can't be used afterwards"
382 }
383
384 fn check_let_unit(cx: &LateContext<'_, '_>, decl: &Decl) {
385     if let DeclKind::Local(ref local) = decl.node {
386         if is_unit(cx.tables.pat_ty(&local.pat)) {
387             if in_external_macro(cx.sess(), decl.span) || in_macro(local.pat.span) {
388                 return;
389             }
390             if higher::is_from_for_desugar(decl) {
391                 return;
392             }
393             span_lint(
394                 cx,
395                 LET_UNIT_VALUE,
396                 decl.span,
397                 &format!(
398                     "this let-binding has unit value. Consider omitting `let {} =`",
399                     snippet(cx, local.pat.span, "..")
400                 ),
401             );
402         }
403     }
404 }
405
406 impl LintPass for LetPass {
407     fn get_lints(&self) -> LintArray {
408         lint_array!(LET_UNIT_VALUE)
409     }
410 }
411
412 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for LetPass {
413     fn check_decl(&mut self, cx: &LateContext<'a, 'tcx>, decl: &'tcx Decl) {
414         check_let_unit(cx, decl)
415     }
416 }
417
418 /// **What it does:** Checks for comparisons to unit.
419 ///
420 /// **Why is this bad?** Unit is always equal to itself, and thus is just a
421 /// clumsily written constant. Mostly this happens when someone accidentally
422 /// adds semicolons at the end of the operands.
423 ///
424 /// **Known problems:** None.
425 ///
426 /// **Example:**
427 /// ```rust
428 /// if { foo(); } == { bar(); } { baz(); }
429 /// ```
430 /// is equal to
431 /// ```rust
432 /// { foo(); bar(); baz(); }
433 /// ```
434 declare_clippy_lint! {
435     pub UNIT_CMP,
436     correctness,
437     "comparing unit values"
438 }
439
440 #[allow(missing_copy_implementations)]
441 pub struct UnitCmp;
442
443 impl LintPass for UnitCmp {
444     fn get_lints(&self) -> LintArray {
445         lint_array!(UNIT_CMP)
446     }
447 }
448
449 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for UnitCmp {
450     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
451         if in_macro(expr.span) {
452             return;
453         }
454         if let ExprKind::Binary(ref cmp, ref left, _) = expr.node {
455             let op = cmp.node;
456             if op.is_comparison() && is_unit(cx.tables.expr_ty(left)) {
457                 let result = match op {
458                     BinOpKind::Eq | BinOpKind::Le | BinOpKind::Ge => "true",
459                     _ => "false",
460                 };
461                 span_lint(
462                     cx,
463                     UNIT_CMP,
464                     expr.span,
465                     &format!(
466                         "{}-comparison of unit values detected. This will always be {}",
467                         op.as_str(),
468                         result
469                     ),
470                 );
471             }
472         }
473     }
474 }
475
476 /// **What it does:** Checks for passing a unit value as an argument to a function without using a unit literal (`()`).
477 ///
478 /// **Why is this bad?** This is likely the result of an accidental semicolon.
479 ///
480 /// **Known problems:** None.
481 ///
482 /// **Example:**
483 /// ```rust
484 /// foo({
485 ///   let a = bar();
486 ///   baz(a);
487 /// })
488 /// ```
489 declare_clippy_lint! {
490     pub UNIT_ARG,
491     complexity,
492     "passing unit to a function"
493 }
494
495 pub struct UnitArg;
496
497 impl LintPass for UnitArg {
498     fn get_lints(&self) -> LintArray {
499         lint_array!(UNIT_ARG)
500     }
501 }
502
503 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for UnitArg {
504     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
505         if in_macro(expr.span) {
506             return;
507         }
508         match expr.node {
509             ExprKind::Call(_, ref args) | ExprKind::MethodCall(_, _, ref args) => {
510                 for arg in args {
511                     if is_unit(cx.tables.expr_ty(arg)) && !is_unit_literal(arg) {
512                         let map = &cx.tcx.hir;
513                         // apparently stuff in the desugaring of `?` can trigger this
514                         // so check for that here
515                         // only the calls to `Try::from_error` is marked as desugared,
516                         // so we need to check both the current Expr and its parent.
517                         if !is_questionmark_desugar_marked_call(expr) {
518                             if_chain!{
519                                 let opt_parent_node = map.find(map.get_parent_node(expr.id));
520                                 if let Some(hir::Node::Expr(parent_expr)) = opt_parent_node;
521                                 if is_questionmark_desugar_marked_call(parent_expr);
522                                 then {}
523                                 else {
524                                     // `expr` and `parent_expr` where _both_ not from
525                                     // desugaring `?`, so lint
526                                     span_lint_and_sugg(
527                                         cx,
528                                         UNIT_ARG,
529                                         arg.span,
530                                         "passing a unit value to a function",
531                                         "if you intended to pass a unit value, use a unit literal instead",
532                                         "()".to_string(),
533                                     );
534                                 }
535                             }
536                         }
537                     }
538                 }
539             },
540             _ => (),
541         }
542     }
543 }
544
545 fn is_questionmark_desugar_marked_call(expr: &Expr) -> bool {
546     use crate::syntax_pos::hygiene::CompilerDesugaringKind;
547     if let ExprKind::Call(ref callee, _) = expr.node {
548         callee.span.is_compiler_desugaring(CompilerDesugaringKind::QuestionMark)
549     } else {
550         false
551     }
552 }
553
554 fn is_unit(ty: Ty<'_>) -> bool {
555     match ty.sty {
556         ty::Tuple(slice) if slice.is_empty() => true,
557         _ => false,
558     }
559 }
560
561 fn is_unit_literal(expr: &Expr) -> bool {
562     match expr.node {
563         ExprKind::Tup(ref slice) if slice.is_empty() => true,
564         _ => false,
565     }
566 }
567
568 pub struct CastPass;
569
570 /// **What it does:** Checks for casts from any numerical to a float type where
571 /// the receiving type cannot store all values from the original type without
572 /// rounding errors. This possible rounding is to be expected, so this lint is
573 /// `Allow` by default.
574 ///
575 /// Basically, this warns on casting any integer with 32 or more bits to `f32`
576 /// or any 64-bit integer to `f64`.
577 ///
578 /// **Why is this bad?** It's not bad at all. But in some applications it can be
579 /// helpful to know where precision loss can take place. This lint can help find
580 /// those places in the code.
581 ///
582 /// **Known problems:** None.
583 ///
584 /// **Example:**
585 /// ```rust
586 /// let x = u64::MAX; x as f64
587 /// ```
588 declare_clippy_lint! {
589     pub CAST_PRECISION_LOSS,
590     pedantic,
591     "casts that cause loss of precision, e.g. `x as f32` where `x: u64`"
592 }
593
594 /// **What it does:** Checks for casts from a signed to an unsigned numerical
595 /// type. In this case, negative values wrap around to large positive values,
596 /// which can be quite surprising in practice. However, as the cast works as
597 /// defined, this lint is `Allow` by default.
598 ///
599 /// **Why is this bad?** Possibly surprising results. You can activate this lint
600 /// as a one-time check to see where numerical wrapping can arise.
601 ///
602 /// **Known problems:** None.
603 ///
604 /// **Example:**
605 /// ```rust
606 /// let y: i8 = -1;
607 /// y as u128  // will return 18446744073709551615
608 /// ```
609 declare_clippy_lint! {
610     pub CAST_SIGN_LOSS,
611     pedantic,
612     "casts from signed types to unsigned types, e.g. `x as u32` where `x: i32`"
613 }
614
615 /// **What it does:** Checks for on casts between numerical types that may
616 /// truncate large values. This is expected behavior, so the cast is `Allow` by
617 /// default.
618 ///
619 /// **Why is this bad?** In some problem domains, it is good practice to avoid
620 /// truncation. This lint can be activated to help assess where additional
621 /// checks could be beneficial.
622 ///
623 /// **Known problems:** None.
624 ///
625 /// **Example:**
626 /// ```rust
627 /// fn as_u8(x: u64) -> u8 { x as u8 }
628 /// ```
629 declare_clippy_lint! {
630     pub CAST_POSSIBLE_TRUNCATION,
631     pedantic,
632     "casts that may cause truncation of the value, e.g. `x as u8` where `x: u32`, \
633      or `x as i32` where `x: f32`"
634 }
635
636 /// **What it does:** Checks for casts from an unsigned type to a signed type of
637 /// the same size. Performing such a cast is a 'no-op' for the compiler,
638 /// i.e. nothing is changed at the bit level, and the binary representation of
639 /// the value is reinterpreted. This can cause wrapping if the value is too big
640 /// for the target signed type. However, the cast works as defined, so this lint
641 /// is `Allow` by default.
642 ///
643 /// **Why is this bad?** While such a cast is not bad in itself, the results can
644 /// be surprising when this is not the intended behavior, as demonstrated by the
645 /// example below.
646 ///
647 /// **Known problems:** None.
648 ///
649 /// **Example:**
650 /// ```rust
651 /// u32::MAX as i32  // will yield a value of `-1`
652 /// ```
653 declare_clippy_lint! {
654     pub CAST_POSSIBLE_WRAP,
655     pedantic,
656     "casts that may cause wrapping around the value, e.g. `x as i32` where `x: u32` \
657      and `x > i32::MAX`"
658 }
659
660 /// **What it does:** Checks for on casts between numerical types that may
661 /// be replaced by safe conversion functions.
662 ///
663 /// **Why is this bad?** Rust's `as` keyword will perform many kinds of
664 /// conversions, including silently lossy conversions. Conversion functions such
665 /// as `i32::from` will only perform lossless conversions. Using the conversion
666 /// functions prevents conversions from turning into silent lossy conversions if
667 /// the types of the input expressions ever change, and make it easier for
668 /// people reading the code to know that the conversion is lossless.
669 ///
670 /// **Known problems:** None.
671 ///
672 /// **Example:**
673 /// ```rust
674 /// fn as_u64(x: u8) -> u64 { x as u64 }
675 /// ```
676 ///
677 /// Using `::from` would look like this:
678 ///
679 /// ```rust
680 /// fn as_u64(x: u8) -> u64 { u64::from(x) }
681 /// ```
682 declare_clippy_lint! {
683     pub CAST_LOSSLESS,
684     complexity,
685     "casts using `as` that are known to be lossless, e.g. `x as u64` where `x: u8`"
686 }
687
688 /// **What it does:** Checks for casts to the same type.
689 ///
690 /// **Why is this bad?** It's just unnecessary.
691 ///
692 /// **Known problems:** None.
693 ///
694 /// **Example:**
695 /// ```rust
696 /// let _ = 2i32 as i32
697 /// ```
698 declare_clippy_lint! {
699     pub UNNECESSARY_CAST,
700     complexity,
701     "cast to the same type, e.g. `x as i32` where `x: i32`"
702 }
703
704 /// **What it does:** Checks for casts from a less-strictly-aligned pointer to a
705 /// more-strictly-aligned pointer
706 ///
707 /// **Why is this bad?** Dereferencing the resulting pointer may be undefined
708 /// behavior.
709 ///
710 /// **Known problems:** None.
711 ///
712 /// **Example:**
713 /// ```rust
714 /// let _ = (&1u8 as *const u8) as *const u16;
715 /// let _ = (&mut 1u8 as *mut u8) as *mut u16;
716 /// ```
717 declare_clippy_lint! {
718     pub CAST_PTR_ALIGNMENT,
719     correctness,
720     "cast from a pointer to a more-strictly-aligned pointer"
721 }
722
723 /// **What it does:** Checks for casts of function pointers to something other than usize
724 ///
725 /// **Why is this bad?**
726 /// Casting a function pointer to anything other than usize/isize is not portable across
727 /// architectures, because you end up losing bits if the target type is too small or end up with a
728 /// bunch of extra bits that waste space and add more instructions to the final binary than
729 /// strictly necessary for the problem
730 ///
731 /// Casting to isize also doesn't make sense since there are no signed addresses.
732 ///
733 /// **Example**
734 ///
735 /// ```rust
736 /// // Bad
737 /// fn fun() -> i32 {}
738 /// let a = fun as i64;
739 ///
740 /// // Good
741 /// fn fun2() -> i32 {}
742 /// let a = fun2 as usize;
743 /// ```
744 declare_clippy_lint! {
745     pub FN_TO_NUMERIC_CAST,
746     style,
747     "casting a function pointer to a numeric type other than usize"
748 }
749
750 /// **What it does:** Checks for casts of a function pointer to a numeric type not wide enough to
751 /// store address.
752 ///
753 /// **Why is this bad?**
754 /// Such a cast discards some bits of the function's address. If this is intended, it would be more
755 /// clearly expressed by casting to usize first, then casting the usize to the intended type (with
756 /// a comment) to perform the truncation.
757 ///
758 /// **Example**
759 ///
760 /// ```rust
761 /// // Bad
762 /// fn fn1() -> i16 { 1 };
763 /// let _ = fn1 as i32;
764 ///
765 /// // Better: Cast to usize first, then comment with the reason for the truncation
766 /// fn fn2() -> i16 { 1 };
767 /// let fn_ptr = fn2 as usize;
768 /// let fn_ptr_truncated = fn_ptr as i32;
769 /// ```
770 declare_clippy_lint! {
771     pub FN_TO_NUMERIC_CAST_WITH_TRUNCATION,
772     style,
773     "casting a function pointer to a numeric type not wide enough to store the address"
774 }
775
776 /// Returns the size in bits of an integral type.
777 /// Will return 0 if the type is not an int or uint variant
778 fn int_ty_to_nbits(typ: Ty<'_>, tcx: TyCtxt<'_, '_, '_>) -> u64 {
779     match typ.sty {
780         ty::Int(i) => match i {
781             IntTy::Isize => tcx.data_layout.pointer_size.bits(),
782             IntTy::I8 => 8,
783             IntTy::I16 => 16,
784             IntTy::I32 => 32,
785             IntTy::I64 => 64,
786             IntTy::I128 => 128,
787         },
788         ty::Uint(i) => match i {
789             UintTy::Usize => tcx.data_layout.pointer_size.bits(),
790             UintTy::U8 => 8,
791             UintTy::U16 => 16,
792             UintTy::U32 => 32,
793             UintTy::U64 => 64,
794             UintTy::U128 => 128,
795         },
796         _ => 0,
797     }
798 }
799
800 fn is_isize_or_usize(typ: Ty<'_>) -> bool {
801     match typ.sty {
802         ty::Int(IntTy::Isize) | ty::Uint(UintTy::Usize) => true,
803         _ => false,
804     }
805 }
806
807 fn span_precision_loss_lint(cx: &LateContext<'_, '_>, expr: &Expr, cast_from: Ty<'_>, cast_to_f64: bool) {
808     let mantissa_nbits = if cast_to_f64 { 52 } else { 23 };
809     let arch_dependent = is_isize_or_usize(cast_from) && cast_to_f64;
810     let arch_dependent_str = "on targets with 64-bit wide pointers ";
811     let from_nbits_str = if arch_dependent {
812         "64".to_owned()
813     } else if is_isize_or_usize(cast_from) {
814         "32 or 64".to_owned()
815     } else {
816         int_ty_to_nbits(cast_from, cx.tcx).to_string()
817     };
818     span_lint(
819         cx,
820         CAST_PRECISION_LOSS,
821         expr.span,
822         &format!(
823             "casting {0} to {1} causes a loss of precision {2}({0} is {3} bits wide, but {1}'s mantissa \
824              is only {4} bits wide)",
825             cast_from,
826             if cast_to_f64 { "f64" } else { "f32" },
827             if arch_dependent {
828                 arch_dependent_str
829             } else {
830                 ""
831             },
832             from_nbits_str,
833             mantissa_nbits
834         ),
835     );
836 }
837
838 fn should_strip_parens(op: &Expr, snip: &str) -> bool {
839     if let ExprKind::Binary(_, _, _) = op.node {
840         if snip.starts_with('(') && snip.ends_with(')') {
841             return true;
842         }
843     }
844     false
845 }
846
847 fn span_lossless_lint(cx: &LateContext<'_, '_>, expr: &Expr, op: &Expr, cast_from: Ty<'_>, cast_to: Ty<'_>) {
848     // Do not suggest using From in consts/statics until it is valid to do so (see #2267).
849     if in_constant(cx, expr.id) { return }
850     // The suggestion is to use a function call, so if the original expression
851     // has parens on the outside, they are no longer needed.
852     let opt = snippet_opt(cx, op.span);
853     let sugg = if let Some(ref snip) = opt {
854         if should_strip_parens(op, snip) {
855             &snip[1..snip.len() - 1]
856         } else {
857             snip.as_str()
858         }
859     } else {
860         ".."
861     };
862
863     span_lint_and_sugg(
864         cx,
865         CAST_LOSSLESS,
866         expr.span,
867         &format!("casting {} to {} may become silently lossy if types change", cast_from, cast_to),
868         "try",
869         format!("{}::from({})", cast_to, sugg),
870     );
871 }
872
873 enum ArchSuffix {
874     _32,
875     _64,
876     None,
877 }
878
879 fn check_truncation_and_wrapping(cx: &LateContext<'_, '_>, expr: &Expr, cast_from: Ty<'_>, cast_to: Ty<'_>) {
880     let arch_64_suffix = " on targets with 64-bit wide pointers";
881     let arch_32_suffix = " on targets with 32-bit wide pointers";
882     let cast_unsigned_to_signed = !cast_from.is_signed() && cast_to.is_signed();
883     let from_nbits = int_ty_to_nbits(cast_from, cx.tcx);
884     let to_nbits = int_ty_to_nbits(cast_to, cx.tcx);
885     let (span_truncation, suffix_truncation, span_wrap, suffix_wrap) =
886         match (is_isize_or_usize(cast_from), is_isize_or_usize(cast_to)) {
887             (true, true) | (false, false) => (
888                 to_nbits < from_nbits,
889                 ArchSuffix::None,
890                 to_nbits == from_nbits && cast_unsigned_to_signed,
891                 ArchSuffix::None,
892             ),
893             (true, false) => (
894                 to_nbits <= 32,
895                 if to_nbits == 32 {
896                     ArchSuffix::_64
897                 } else {
898                     ArchSuffix::None
899                 },
900                 to_nbits <= 32 && cast_unsigned_to_signed,
901                 ArchSuffix::_32,
902             ),
903             (false, true) => (
904                 from_nbits == 64,
905                 ArchSuffix::_32,
906                 cast_unsigned_to_signed,
907                 if from_nbits == 64 {
908                     ArchSuffix::_64
909                 } else {
910                     ArchSuffix::_32
911                 },
912             ),
913         };
914     if span_truncation {
915         span_lint(
916             cx,
917             CAST_POSSIBLE_TRUNCATION,
918             expr.span,
919             &format!(
920                 "casting {} to {} may truncate the value{}",
921                 cast_from,
922                 cast_to,
923                 match suffix_truncation {
924                     ArchSuffix::_32 => arch_32_suffix,
925                     ArchSuffix::_64 => arch_64_suffix,
926                     ArchSuffix::None => "",
927                 }
928             ),
929         );
930     }
931     if span_wrap {
932         span_lint(
933             cx,
934             CAST_POSSIBLE_WRAP,
935             expr.span,
936             &format!(
937                 "casting {} to {} may wrap around the value{}",
938                 cast_from,
939                 cast_to,
940                 match suffix_wrap {
941                     ArchSuffix::_32 => arch_32_suffix,
942                     ArchSuffix::_64 => arch_64_suffix,
943                     ArchSuffix::None => "",
944                 }
945             ),
946         );
947     }
948 }
949
950 fn check_lossless(cx: &LateContext<'_, '_>, expr: &Expr, op: &Expr, cast_from: Ty<'_>, cast_to: Ty<'_>) {
951     let cast_signed_to_unsigned = cast_from.is_signed() && !cast_to.is_signed();
952     let from_nbits = int_ty_to_nbits(cast_from, cx.tcx);
953     let to_nbits = int_ty_to_nbits(cast_to, cx.tcx);
954     if !is_isize_or_usize(cast_from) && !is_isize_or_usize(cast_to) && from_nbits < to_nbits && !cast_signed_to_unsigned
955     {
956         span_lossless_lint(cx, expr, op, cast_from, cast_to);
957     }
958 }
959
960 impl LintPass for CastPass {
961     fn get_lints(&self) -> LintArray {
962         lint_array!(
963             CAST_PRECISION_LOSS,
964             CAST_SIGN_LOSS,
965             CAST_POSSIBLE_TRUNCATION,
966             CAST_POSSIBLE_WRAP,
967             CAST_LOSSLESS,
968             UNNECESSARY_CAST,
969             CAST_PTR_ALIGNMENT,
970             FN_TO_NUMERIC_CAST
971         )
972     }
973 }
974
975 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for CastPass {
976     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
977         if let ExprKind::Cast(ref ex, _) = expr.node {
978             let (cast_from, cast_to) = (cx.tables.expr_ty(ex), cx.tables.expr_ty(expr));
979             lint_fn_to_numeric_cast(cx, expr, ex, cast_from, cast_to);
980             if let ExprKind::Lit(ref lit) = ex.node {
981                 use crate::syntax::ast::{LitIntType, LitKind};
982                 match lit.node {
983                     LitKind::Int(_, LitIntType::Unsuffixed) | LitKind::FloatUnsuffixed(_) => {},
984                     _ => if cast_from.sty == cast_to.sty && !in_external_macro(cx.sess(), expr.span) {
985                         span_lint(
986                             cx,
987                             UNNECESSARY_CAST,
988                             expr.span,
989                             &format!("casting to the same type is unnecessary (`{}` -> `{}`)", cast_from, cast_to),
990                         );
991                     },
992                 }
993             }
994             if cast_from.is_numeric() && cast_to.is_numeric() && !in_external_macro(cx.sess(), expr.span) {
995                 match (cast_from.is_integral(), cast_to.is_integral()) {
996                     (true, false) => {
997                         let from_nbits = int_ty_to_nbits(cast_from, cx.tcx);
998                         let to_nbits = if let ty::Float(FloatTy::F32) = cast_to.sty {
999                             32
1000                         } else {
1001                             64
1002                         };
1003                         if is_isize_or_usize(cast_from) || from_nbits >= to_nbits {
1004                             span_precision_loss_lint(cx, expr, cast_from, to_nbits == 64);
1005                         }
1006                         if from_nbits < to_nbits {
1007                             span_lossless_lint(cx, expr, ex, cast_from, cast_to);
1008                         }
1009                     },
1010                     (false, true) => {
1011                         span_lint(
1012                             cx,
1013                             CAST_POSSIBLE_TRUNCATION,
1014                             expr.span,
1015                             &format!("casting {} to {} may truncate the value", cast_from, cast_to),
1016                         );
1017                         if !cast_to.is_signed() {
1018                             span_lint(
1019                                 cx,
1020                                 CAST_SIGN_LOSS,
1021                                 expr.span,
1022                                 &format!("casting {} to {} may lose the sign of the value", cast_from, cast_to),
1023                             );
1024                         }
1025                     },
1026                     (true, true) => {
1027                         if cast_from.is_signed() && !cast_to.is_signed() {
1028                             span_lint(
1029                                 cx,
1030                                 CAST_SIGN_LOSS,
1031                                 expr.span,
1032                                 &format!("casting {} to {} may lose the sign of the value", cast_from, cast_to),
1033                             );
1034                         }
1035                         check_truncation_and_wrapping(cx, expr, cast_from, cast_to);
1036                         check_lossless(cx, expr, ex, cast_from, cast_to);
1037                     },
1038                     (false, false) => {
1039                         if let (&ty::Float(FloatTy::F64), &ty::Float(FloatTy::F32)) = (&cast_from.sty, &cast_to.sty)
1040                         {
1041                             span_lint(
1042                                 cx,
1043                                 CAST_POSSIBLE_TRUNCATION,
1044                                 expr.span,
1045                                 "casting f64 to f32 may truncate the value",
1046                             );
1047                         }
1048                         if let (&ty::Float(FloatTy::F32), &ty::Float(FloatTy::F64)) = (&cast_from.sty, &cast_to.sty)
1049                         {
1050                             span_lossless_lint(cx, expr, ex, cast_from, cast_to);
1051                         }
1052                     },
1053                 }
1054             }
1055
1056             if_chain!{
1057                 if let ty::RawPtr(from_ptr_ty) = &cast_from.sty;
1058                 if let ty::RawPtr(to_ptr_ty) = &cast_to.sty;
1059                 if let Some(from_align) = cx.layout_of(from_ptr_ty.ty).ok().map(|a| a.align.abi());
1060                 if let Some(to_align) = cx.layout_of(to_ptr_ty.ty).ok().map(|a| a.align.abi());
1061                 if from_align < to_align;
1062                 // with c_void, we inherently need to trust the user
1063                 if ! (
1064                     match_type(cx, from_ptr_ty.ty, &paths::C_VOID)
1065                     || match_type(cx, from_ptr_ty.ty, &paths::C_VOID_LIBC)
1066                 );
1067                 then {
1068                     span_lint(
1069                         cx,
1070                         CAST_PTR_ALIGNMENT,
1071                         expr.span,
1072                         &format!("casting from `{}` to a more-strictly-aligned pointer (`{}`)", cast_from, cast_to)
1073                     );
1074                 }
1075             }
1076         }
1077     }
1078 }
1079
1080 fn lint_fn_to_numeric_cast(cx: &LateContext<'_, '_>, expr: &Expr, cast_expr: &Expr, cast_from: Ty<'_>, cast_to: Ty<'_>) {
1081     match cast_from.sty {
1082         ty::FnDef(..) | ty::FnPtr(_) => {
1083             let from_snippet = snippet(cx, cast_expr.span, "x");
1084
1085             let to_nbits = int_ty_to_nbits(cast_to, cx.tcx);
1086             if to_nbits < cx.tcx.data_layout.pointer_size.bits() {
1087                 span_lint_and_sugg(
1088                     cx,
1089                     FN_TO_NUMERIC_CAST_WITH_TRUNCATION,
1090                     expr.span,
1091                     &format!("casting function pointer `{}` to `{}`, which truncates the value", from_snippet, cast_to),
1092                     "try",
1093                     format!("{} as usize", from_snippet)
1094                 );
1095
1096             } else if cast_to.sty != ty::Uint(UintTy::Usize) {
1097                 span_lint_and_sugg(
1098                     cx,
1099                     FN_TO_NUMERIC_CAST,
1100                     expr.span,
1101                     &format!("casting function pointer `{}` to `{}`", from_snippet, cast_to),
1102                     "try",
1103                     format!("{} as usize", from_snippet)
1104                 );
1105             }
1106         },
1107         _ => {}
1108     }
1109 }
1110
1111 /// **What it does:** Checks for types used in structs, parameters and `let`
1112 /// declarations above a certain complexity threshold.
1113 ///
1114 /// **Why is this bad?** Too complex types make the code less readable. Consider
1115 /// using a `type` definition to simplify them.
1116 ///
1117 /// **Known problems:** None.
1118 ///
1119 /// **Example:**
1120 /// ```rust
1121 /// struct Foo { inner: Rc<Vec<Vec<Box<(u32, u32, u32, u32)>>>> }
1122 /// ```
1123 declare_clippy_lint! {
1124     pub TYPE_COMPLEXITY,
1125     complexity,
1126     "usage of very complex types that might be better factored into `type` definitions"
1127 }
1128
1129 #[allow(missing_copy_implementations)]
1130 pub struct TypeComplexityPass {
1131     threshold: u64,
1132 }
1133
1134 impl TypeComplexityPass {
1135     pub fn new(threshold: u64) -> Self {
1136         Self {
1137             threshold,
1138         }
1139     }
1140 }
1141
1142 impl LintPass for TypeComplexityPass {
1143     fn get_lints(&self) -> LintArray {
1144         lint_array!(TYPE_COMPLEXITY)
1145     }
1146 }
1147
1148 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for TypeComplexityPass {
1149     fn check_fn(
1150         &mut self,
1151         cx: &LateContext<'a, 'tcx>,
1152         _: FnKind<'tcx>,
1153         decl: &'tcx FnDecl,
1154         _: &'tcx Body,
1155         _: Span,
1156         _: NodeId,
1157     ) {
1158         self.check_fndecl(cx, decl);
1159     }
1160
1161     fn check_struct_field(&mut self, cx: &LateContext<'a, 'tcx>, field: &'tcx StructField) {
1162         // enum variants are also struct fields now
1163         self.check_type(cx, &field.ty);
1164     }
1165
1166     fn check_item(&mut self, cx: &LateContext<'a, 'tcx>, item: &'tcx Item) {
1167         match item.node {
1168             ItemKind::Static(ref ty, _, _) | ItemKind::Const(ref ty, _) => self.check_type(cx, ty),
1169             // functions, enums, structs, impls and traits are covered
1170             _ => (),
1171         }
1172     }
1173
1174     fn check_trait_item(&mut self, cx: &LateContext<'a, 'tcx>, item: &'tcx TraitItem) {
1175         match item.node {
1176             TraitItemKind::Const(ref ty, _) | TraitItemKind::Type(_, Some(ref ty)) => self.check_type(cx, ty),
1177             TraitItemKind::Method(MethodSig { ref decl, .. }, TraitMethod::Required(_)) => self.check_fndecl(cx, decl),
1178             // methods with default impl are covered by check_fn
1179             _ => (),
1180         }
1181     }
1182
1183     fn check_impl_item(&mut self, cx: &LateContext<'a, 'tcx>, item: &'tcx ImplItem) {
1184         match item.node {
1185             ImplItemKind::Const(ref ty, _) | ImplItemKind::Type(ref ty) => self.check_type(cx, ty),
1186             // methods are covered by check_fn
1187             _ => (),
1188         }
1189     }
1190
1191     fn check_local(&mut self, cx: &LateContext<'a, 'tcx>, local: &'tcx Local) {
1192         if let Some(ref ty) = local.ty {
1193             self.check_type(cx, ty);
1194         }
1195     }
1196 }
1197
1198 impl<'a, 'tcx> TypeComplexityPass {
1199     fn check_fndecl(&self, cx: &LateContext<'a, 'tcx>, decl: &'tcx FnDecl) {
1200         for arg in &decl.inputs {
1201             self.check_type(cx, arg);
1202         }
1203         if let Return(ref ty) = decl.output {
1204             self.check_type(cx, ty);
1205         }
1206     }
1207
1208     fn check_type(&self, cx: &LateContext<'_, '_>, ty: &hir::Ty) {
1209         if in_macro(ty.span) {
1210             return;
1211         }
1212         let score = {
1213             let mut visitor = TypeComplexityVisitor { score: 0, nest: 1 };
1214             visitor.visit_ty(ty);
1215             visitor.score
1216         };
1217
1218         if score > self.threshold {
1219             span_lint(
1220                 cx,
1221                 TYPE_COMPLEXITY,
1222                 ty.span,
1223                 "very complex type used. Consider factoring parts into `type` definitions",
1224             );
1225         }
1226     }
1227 }
1228
1229 /// Walks a type and assigns a complexity score to it.
1230 struct TypeComplexityVisitor {
1231     /// total complexity score of the type
1232     score: u64,
1233     /// current nesting level
1234     nest: u64,
1235 }
1236
1237 impl<'tcx> Visitor<'tcx> for TypeComplexityVisitor {
1238     fn visit_ty(&mut self, ty: &'tcx hir::Ty) {
1239         let (add_score, sub_nest) = match ty.node {
1240             // _, &x and *x have only small overhead; don't mess with nesting level
1241             TyKind::Infer | TyKind::Ptr(..) | TyKind::Rptr(..) => (1, 0),
1242
1243             // the "normal" components of a type: named types, arrays/tuples
1244             TyKind::Path(..) | TyKind::Slice(..) | TyKind::Tup(..) | TyKind::Array(..) => (10 * self.nest, 1),
1245
1246             // function types bring a lot of overhead
1247             TyKind::BareFn(ref bare) if bare.abi == Abi::Rust => (50 * self.nest, 1),
1248
1249             TyKind::TraitObject(ref param_bounds, _) => {
1250                 let has_lifetime_parameters = param_bounds
1251                     .iter()
1252                     .any(|bound| bound.bound_generic_params.iter().any(|gen| match gen.kind {
1253                         GenericParamKind::Lifetime { .. } => true,
1254                         _ => false,
1255                     }));
1256                 if has_lifetime_parameters {
1257                     // complex trait bounds like A<'a, 'b>
1258                     (50 * self.nest, 1)
1259                 } else {
1260                     // simple trait bounds like A + B
1261                     (20 * self.nest, 0)
1262                 }
1263             },
1264
1265             _ => (0, 0),
1266         };
1267         self.score += add_score;
1268         self.nest += sub_nest;
1269         walk_ty(self, ty);
1270         self.nest -= sub_nest;
1271     }
1272     fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
1273         NestedVisitorMap::None
1274     }
1275 }
1276
1277 /// **What it does:** Checks for expressions where a character literal is cast
1278 /// to `u8` and suggests using a byte literal instead.
1279 ///
1280 /// **Why is this bad?** In general, casting values to smaller types is
1281 /// error-prone and should be avoided where possible. In the particular case of
1282 /// converting a character literal to u8, it is easy to avoid by just using a
1283 /// byte literal instead. As an added bonus, `b'a'` is even slightly shorter
1284 /// than `'a' as u8`.
1285 ///
1286 /// **Known problems:** None.
1287 ///
1288 /// **Example:**
1289 /// ```rust
1290 /// 'x' as u8
1291 /// ```
1292 ///
1293 /// A better version, using the byte literal:
1294 ///
1295 /// ```rust
1296 /// b'x'
1297 /// ```
1298 declare_clippy_lint! {
1299     pub CHAR_LIT_AS_U8,
1300     complexity,
1301     "casting a character literal to u8"
1302 }
1303
1304 pub struct CharLitAsU8;
1305
1306 impl LintPass for CharLitAsU8 {
1307     fn get_lints(&self) -> LintArray {
1308         lint_array!(CHAR_LIT_AS_U8)
1309     }
1310 }
1311
1312 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for CharLitAsU8 {
1313     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
1314         use crate::syntax::ast::{LitKind, UintTy};
1315
1316         if let ExprKind::Cast(ref e, _) = expr.node {
1317             if let ExprKind::Lit(ref l) = e.node {
1318                 if let LitKind::Char(_) = l.node {
1319                     if ty::Uint(UintTy::U8) == cx.tables.expr_ty(expr).sty && !in_macro(expr.span) {
1320                         let msg = "casting character literal to u8. `char`s \
1321                                    are 4 bytes wide in rust, so casting to u8 \
1322                                    truncates them";
1323                         let help = format!("Consider using a byte literal instead:\nb{}", snippet(cx, e.span, "'x'"));
1324                         span_help_and_lint(cx, CHAR_LIT_AS_U8, expr.span, msg, &help);
1325                     }
1326                 }
1327             }
1328         }
1329     }
1330 }
1331
1332 /// **What it does:** Checks for comparisons where one side of the relation is
1333 /// either the minimum or maximum value for its type and warns if it involves a
1334 /// case that is always true or always false. Only integer and boolean types are
1335 /// checked.
1336 ///
1337 /// **Why is this bad?** An expression like `min <= x` may misleadingly imply
1338 /// that is is possible for `x` to be less than the minimum. Expressions like
1339 /// `max < x` are probably mistakes.
1340 ///
1341 /// **Known problems:** For `usize` the size of the current compile target will
1342 /// be assumed (e.g. 64 bits on 64 bit systems). This means code that uses such
1343 /// a comparison to detect target pointer width will trigger this lint. One can
1344 /// use `mem::sizeof` and compare its value or conditional compilation
1345 /// attributes
1346 /// like `#[cfg(target_pointer_width = "64")] ..` instead.
1347 ///
1348 /// **Example:**
1349 /// ```rust
1350 /// vec.len() <= 0
1351 /// 100 > std::i32::MAX
1352 /// ```
1353 declare_clippy_lint! {
1354     pub ABSURD_EXTREME_COMPARISONS,
1355     correctness,
1356     "a comparison with a maximum or minimum value that is always true or false"
1357 }
1358
1359 pub struct AbsurdExtremeComparisons;
1360
1361 impl LintPass for AbsurdExtremeComparisons {
1362     fn get_lints(&self) -> LintArray {
1363         lint_array!(ABSURD_EXTREME_COMPARISONS)
1364     }
1365 }
1366
1367 enum ExtremeType {
1368     Minimum,
1369     Maximum,
1370 }
1371
1372 struct ExtremeExpr<'a> {
1373     which: ExtremeType,
1374     expr: &'a Expr,
1375 }
1376
1377 enum AbsurdComparisonResult {
1378     AlwaysFalse,
1379     AlwaysTrue,
1380     InequalityImpossible,
1381 }
1382
1383
1384 fn is_cast_between_fixed_and_target<'a, 'tcx>(
1385     cx: &LateContext<'a, 'tcx>,
1386     expr: &'tcx Expr
1387 ) -> bool {
1388
1389     if let ExprKind::Cast(ref cast_exp, _) = expr.node {
1390         let precast_ty = cx.tables.expr_ty(cast_exp);
1391         let cast_ty = cx.tables.expr_ty(expr);
1392
1393         return is_isize_or_usize(precast_ty) != is_isize_or_usize(cast_ty)
1394     }
1395
1396     false
1397 }
1398
1399 fn detect_absurd_comparison<'a, 'tcx>(
1400     cx: &LateContext<'a, 'tcx>,
1401     op: BinOpKind,
1402     lhs: &'tcx Expr,
1403     rhs: &'tcx Expr,
1404 ) -> Option<(ExtremeExpr<'tcx>, AbsurdComparisonResult)> {
1405     use crate::types::ExtremeType::*;
1406     use crate::types::AbsurdComparisonResult::*;
1407     use crate::utils::comparisons::*;
1408
1409     // absurd comparison only makes sense on primitive types
1410     // primitive types don't implement comparison operators with each other
1411     if cx.tables.expr_ty(lhs) != cx.tables.expr_ty(rhs) {
1412         return None;
1413     }
1414
1415     // comparisons between fix sized types and target sized types are considered unanalyzable
1416     if is_cast_between_fixed_and_target(cx, lhs) || is_cast_between_fixed_and_target(cx, rhs) {
1417         return None;
1418     }
1419
1420     let normalized = normalize_comparison(op, lhs, rhs);
1421     let (rel, normalized_lhs, normalized_rhs) = if let Some(val) = normalized {
1422         val
1423     } else {
1424         return None;
1425     };
1426
1427     let lx = detect_extreme_expr(cx, normalized_lhs);
1428     let rx = detect_extreme_expr(cx, normalized_rhs);
1429
1430     Some(match rel {
1431         Rel::Lt => {
1432             match (lx, rx) {
1433                 (Some(l @ ExtremeExpr { which: Maximum, .. }), _) => (l, AlwaysFalse), // max < x
1434                 (_, Some(r @ ExtremeExpr { which: Minimum, .. })) => (r, AlwaysFalse), // x < min
1435                 _ => return None,
1436             }
1437         },
1438         Rel::Le => {
1439             match (lx, rx) {
1440                 (Some(l @ ExtremeExpr { which: Minimum, .. }), _) => (l, AlwaysTrue), // min <= x
1441                 (Some(l @ ExtremeExpr { which: Maximum, .. }), _) => (l, InequalityImpossible), // max <= x
1442                 (_, Some(r @ ExtremeExpr { which: Minimum, .. })) => (r, InequalityImpossible), // x <= min
1443                 (_, Some(r @ ExtremeExpr { which: Maximum, .. })) => (r, AlwaysTrue), // x <= max
1444                 _ => return None,
1445             }
1446         },
1447         Rel::Ne | Rel::Eq => return None,
1448     })
1449 }
1450
1451 fn detect_extreme_expr<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) -> Option<ExtremeExpr<'tcx>> {
1452     use crate::types::ExtremeType::*;
1453
1454     let ty = cx.tables.expr_ty(expr);
1455
1456     let cv = constant(cx, cx.tables, expr)?.0;
1457
1458     let which = match (&ty.sty, cv) {
1459         (&ty::Bool, Constant::Bool(false)) |
1460         (&ty::Uint(_), Constant::Int(0)) => Minimum,
1461         (&ty::Int(ity), Constant::Int(i)) if i == unsext(cx.tcx, i128::min_value() >> (128 - int_bits(cx.tcx, ity)), ity) => Minimum,
1462
1463         (&ty::Bool, Constant::Bool(true)) => Maximum,
1464         (&ty::Int(ity), Constant::Int(i)) if i == unsext(cx.tcx, i128::max_value() >> (128 - int_bits(cx.tcx, ity)), ity) => Maximum,
1465         (&ty::Uint(uty), Constant::Int(i)) if clip(cx.tcx, u128::max_value(), uty) == i => Maximum,
1466
1467         _ => return None,
1468     };
1469     Some(ExtremeExpr {
1470         which,
1471         expr,
1472     })
1473 }
1474
1475 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for AbsurdExtremeComparisons {
1476     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
1477         use crate::types::ExtremeType::*;
1478         use crate::types::AbsurdComparisonResult::*;
1479
1480         if let ExprKind::Binary(ref cmp, ref lhs, ref rhs) = expr.node {
1481             if let Some((culprit, result)) = detect_absurd_comparison(cx, cmp.node, lhs, rhs) {
1482                 if !in_macro(expr.span) {
1483                     let msg = "this comparison involving the minimum or maximum element for this \
1484                                type contains a case that is always true or always false";
1485
1486                     let conclusion = match result {
1487                         AlwaysFalse => "this comparison is always false".to_owned(),
1488                         AlwaysTrue => "this comparison is always true".to_owned(),
1489                         InequalityImpossible => format!(
1490                             "the case where the two sides are not equal never occurs, consider using {} == {} \
1491                              instead",
1492                             snippet(cx, lhs.span, "lhs"),
1493                             snippet(cx, rhs.span, "rhs")
1494                         ),
1495                     };
1496
1497                     let help = format!(
1498                         "because {} is the {} value for this type, {}",
1499                         snippet(cx, culprit.expr.span, "x"),
1500                         match culprit.which {
1501                             Minimum => "minimum",
1502                             Maximum => "maximum",
1503                         },
1504                         conclusion
1505                     );
1506
1507                     span_help_and_lint(cx, ABSURD_EXTREME_COMPARISONS, expr.span, msg, &help);
1508                 }
1509             }
1510         }
1511     }
1512 }
1513
1514 /// **What it does:** Checks for comparisons where the relation is always either
1515 /// true or false, but where one side has been upcast so that the comparison is
1516 /// necessary. Only integer types are checked.
1517 ///
1518 /// **Why is this bad?** An expression like `let x : u8 = ...; (x as u32) > 300`
1519 /// will mistakenly imply that it is possible for `x` to be outside the range of
1520 /// `u8`.
1521 ///
1522 /// **Known problems:**
1523 /// https://github.com/rust-lang-nursery/rust-clippy/issues/886
1524 ///
1525 /// **Example:**
1526 /// ```rust
1527 /// let x : u8 = ...; (x as u32) > 300
1528 /// ```
1529 declare_clippy_lint! {
1530     pub INVALID_UPCAST_COMPARISONS,
1531     pedantic,
1532     "a comparison involving an upcast which is always true or false"
1533 }
1534
1535 pub struct InvalidUpcastComparisons;
1536
1537 impl LintPass for InvalidUpcastComparisons {
1538     fn get_lints(&self) -> LintArray {
1539         lint_array!(INVALID_UPCAST_COMPARISONS)
1540     }
1541 }
1542
1543 #[derive(Copy, Clone, Debug, Eq)]
1544 enum FullInt {
1545     S(i128),
1546     U(u128),
1547 }
1548
1549 impl FullInt {
1550     #[allow(clippy::cast_sign_loss)]
1551     fn cmp_s_u(s: i128, u: u128) -> Ordering {
1552         if s < 0 {
1553             Ordering::Less
1554         } else if u > (i128::max_value() as u128) {
1555             Ordering::Greater
1556         } else {
1557             (s as u128).cmp(&u)
1558         }
1559     }
1560 }
1561
1562 impl PartialEq for FullInt {
1563     fn eq(&self, other: &Self) -> bool {
1564         self.partial_cmp(other)
1565             .expect("partial_cmp only returns Some(_)") == Ordering::Equal
1566     }
1567 }
1568
1569 impl PartialOrd for FullInt {
1570     fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
1571         Some(match (self, other) {
1572             (&FullInt::S(s), &FullInt::S(o)) => s.cmp(&o),
1573             (&FullInt::U(s), &FullInt::U(o)) => s.cmp(&o),
1574             (&FullInt::S(s), &FullInt::U(o)) => Self::cmp_s_u(s, o),
1575             (&FullInt::U(s), &FullInt::S(o)) => Self::cmp_s_u(o, s).reverse(),
1576         })
1577     }
1578 }
1579 impl Ord for FullInt {
1580     fn cmp(&self, other: &Self) -> Ordering {
1581         self.partial_cmp(other)
1582             .expect("partial_cmp for FullInt can never return None")
1583     }
1584 }
1585
1586
1587 fn numeric_cast_precast_bounds<'a>(cx: &LateContext<'_, '_>, expr: &'a Expr) -> Option<(FullInt, FullInt)> {
1588     use crate::syntax::ast::{IntTy, UintTy};
1589     use std::*;
1590
1591     if let ExprKind::Cast(ref cast_exp, _) = expr.node {
1592         let pre_cast_ty = cx.tables.expr_ty(cast_exp);
1593         let cast_ty = cx.tables.expr_ty(expr);
1594         // if it's a cast from i32 to u32 wrapping will invalidate all these checks
1595         if cx.layout_of(pre_cast_ty).ok().map(|l| l.size) == cx.layout_of(cast_ty).ok().map(|l| l.size) {
1596             return None;
1597         }
1598         match pre_cast_ty.sty {
1599             ty::Int(int_ty) => Some(match int_ty {
1600                 IntTy::I8 => (FullInt::S(i128::from(i8::min_value())), FullInt::S(i128::from(i8::max_value()))),
1601                 IntTy::I16 => (
1602                     FullInt::S(i128::from(i16::min_value())),
1603                     FullInt::S(i128::from(i16::max_value())),
1604                 ),
1605                 IntTy::I32 => (
1606                     FullInt::S(i128::from(i32::min_value())),
1607                     FullInt::S(i128::from(i32::max_value())),
1608                 ),
1609                 IntTy::I64 => (
1610                     FullInt::S(i128::from(i64::min_value())),
1611                     FullInt::S(i128::from(i64::max_value())),
1612                 ),
1613                 IntTy::I128 => (FullInt::S(i128::min_value()), FullInt::S(i128::max_value())),
1614                 IntTy::Isize => (FullInt::S(isize::min_value() as i128), FullInt::S(isize::max_value() as i128)),
1615             }),
1616             ty::Uint(uint_ty) => Some(match uint_ty {
1617                 UintTy::U8 => (FullInt::U(u128::from(u8::min_value())), FullInt::U(u128::from(u8::max_value()))),
1618                 UintTy::U16 => (
1619                     FullInt::U(u128::from(u16::min_value())),
1620                     FullInt::U(u128::from(u16::max_value())),
1621                 ),
1622                 UintTy::U32 => (
1623                     FullInt::U(u128::from(u32::min_value())),
1624                     FullInt::U(u128::from(u32::max_value())),
1625                 ),
1626                 UintTy::U64 => (
1627                     FullInt::U(u128::from(u64::min_value())),
1628                     FullInt::U(u128::from(u64::max_value())),
1629                 ),
1630                 UintTy::U128 => (FullInt::U(u128::min_value()), FullInt::U(u128::max_value())),
1631                 UintTy::Usize => (FullInt::U(usize::min_value() as u128), FullInt::U(usize::max_value() as u128)),
1632             }),
1633             _ => None,
1634         }
1635     } else {
1636         None
1637     }
1638 }
1639
1640 fn node_as_const_fullint<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) -> Option<FullInt> {
1641     let val = constant(cx, cx.tables, expr)?.0;
1642     if let Constant::Int(const_int) = val {
1643         match cx.tables.expr_ty(expr).sty {
1644             ty::Int(ity) => Some(FullInt::S(sext(cx.tcx, const_int, ity))),
1645             ty::Uint(_) => Some(FullInt::U(const_int)),
1646             _ => None,
1647         }
1648     } else {
1649         None
1650     }
1651 }
1652
1653 fn err_upcast_comparison(cx: &LateContext<'_, '_>, span: Span, expr: &Expr, always: bool) {
1654     if let ExprKind::Cast(ref cast_val, _) = expr.node {
1655         span_lint(
1656             cx,
1657             INVALID_UPCAST_COMPARISONS,
1658             span,
1659             &format!(
1660                 "because of the numeric bounds on `{}` prior to casting, this expression is always {}",
1661                 snippet(cx, cast_val.span, "the expression"),
1662                 if always { "true" } else { "false" },
1663             ),
1664         );
1665     }
1666 }
1667
1668 fn upcast_comparison_bounds_err<'a, 'tcx>(
1669     cx: &LateContext<'a, 'tcx>,
1670     span: Span,
1671     rel: comparisons::Rel,
1672     lhs_bounds: Option<(FullInt, FullInt)>,
1673     lhs: &'tcx Expr,
1674     rhs: &'tcx Expr,
1675     invert: bool,
1676 ) {
1677     use crate::utils::comparisons::*;
1678
1679     if let Some((lb, ub)) = lhs_bounds {
1680         if let Some(norm_rhs_val) = node_as_const_fullint(cx, rhs) {
1681             if rel == Rel::Eq || rel == Rel::Ne {
1682                 if norm_rhs_val < lb || norm_rhs_val > ub {
1683                     err_upcast_comparison(cx, span, lhs, rel == Rel::Ne);
1684                 }
1685             } else if match rel {
1686                 Rel::Lt => if invert {
1687                     norm_rhs_val < lb
1688                 } else {
1689                     ub < norm_rhs_val
1690                 },
1691                 Rel::Le => if invert {
1692                     norm_rhs_val <= lb
1693                 } else {
1694                     ub <= norm_rhs_val
1695                 },
1696                 Rel::Eq | Rel::Ne => unreachable!(),
1697             } {
1698                 err_upcast_comparison(cx, span, lhs, true)
1699             } else if match rel {
1700                 Rel::Lt => if invert {
1701                     norm_rhs_val >= ub
1702                 } else {
1703                     lb >= norm_rhs_val
1704                 },
1705                 Rel::Le => if invert {
1706                     norm_rhs_val > ub
1707                 } else {
1708                     lb > norm_rhs_val
1709                 },
1710                 Rel::Eq | Rel::Ne => unreachable!(),
1711             } {
1712                 err_upcast_comparison(cx, span, lhs, false)
1713             }
1714         }
1715     }
1716 }
1717
1718 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for InvalidUpcastComparisons {
1719     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
1720         if let ExprKind::Binary(ref cmp, ref lhs, ref rhs) = expr.node {
1721             let normalized = comparisons::normalize_comparison(cmp.node, lhs, rhs);
1722             let (rel, normalized_lhs, normalized_rhs) = if let Some(val) = normalized {
1723                 val
1724             } else {
1725                 return;
1726             };
1727
1728             let lhs_bounds = numeric_cast_precast_bounds(cx, normalized_lhs);
1729             let rhs_bounds = numeric_cast_precast_bounds(cx, normalized_rhs);
1730
1731             upcast_comparison_bounds_err(cx, expr.span, rel, lhs_bounds, normalized_lhs, normalized_rhs, false);
1732             upcast_comparison_bounds_err(cx, expr.span, rel, rhs_bounds, normalized_rhs, normalized_lhs, true);
1733         }
1734     }
1735 }
1736
1737 /// **What it does:** Checks for public `impl` or `fn` missing generalization
1738 /// over different hashers and implicitly defaulting to the default hashing
1739 /// algorithm (SipHash).
1740 ///
1741 /// **Why is this bad?** `HashMap` or `HashSet` with custom hashers cannot be
1742 /// used with them.
1743 ///
1744 /// **Known problems:** Suggestions for replacing constructors can contain
1745 /// false-positives. Also applying suggestions can require modification of other
1746 /// pieces of code, possibly including external crates.
1747 ///
1748 /// **Example:**
1749 /// ```rust
1750 /// impl<K: Hash + Eq, V> Serialize for HashMap<K, V> { ... }
1751 ///
1752 /// pub foo(map: &mut HashMap<i32, i32>) { .. }
1753 /// ```
1754 declare_clippy_lint! {
1755     pub IMPLICIT_HASHER,
1756     style,
1757     "missing generalization over different hashers"
1758 }
1759
1760 pub struct ImplicitHasher;
1761
1762 impl LintPass for ImplicitHasher {
1763     fn get_lints(&self) -> LintArray {
1764         lint_array!(IMPLICIT_HASHER)
1765     }
1766 }
1767
1768 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for ImplicitHasher {
1769     #[allow(clippy::cast_possible_truncation)]
1770     fn check_item(&mut self, cx: &LateContext<'a, 'tcx>, item: &'tcx Item) {
1771         use crate::syntax_pos::BytePos;
1772
1773         fn suggestion<'a, 'tcx>(
1774             cx: &LateContext<'a, 'tcx>,
1775             db: &mut DiagnosticBuilder<'_>,
1776             generics_span: Span,
1777             generics_suggestion_span: Span,
1778             target: &ImplicitHasherType<'_>,
1779             vis: ImplicitHasherConstructorVisitor<'_, '_, '_>,
1780         ) {
1781             let generics_snip = snippet(cx, generics_span, "");
1782             // trim `<` `>`
1783             let generics_snip = if generics_snip.is_empty() {
1784                 ""
1785             } else {
1786                 &generics_snip[1..generics_snip.len() - 1]
1787             };
1788
1789             multispan_sugg(
1790                 db,
1791                 "consider adding a type parameter".to_string(),
1792                 vec![
1793                     (
1794                         generics_suggestion_span,
1795                         format!(
1796                             "<{}{}S: ::std::hash::BuildHasher{}>",
1797                             generics_snip,
1798                             if generics_snip.is_empty() { "" } else { ", " },
1799                             if vis.suggestions.is_empty() {
1800                                 ""
1801                             } else {
1802                                 // request users to add `Default` bound so that generic constructors can be used
1803                                 " + Default"
1804                             },
1805                         ),
1806                     ),
1807                     (
1808                         target.span(),
1809                         format!("{}<{}, S>", target.type_name(), target.type_arguments(),),
1810                     ),
1811                 ],
1812             );
1813
1814             if !vis.suggestions.is_empty() {
1815                 multispan_sugg(db, "...and use generic constructor".into(), vis.suggestions);
1816             }
1817         }
1818
1819         if !cx.access_levels.is_exported(item.id) {
1820             return;
1821         }
1822
1823         match item.node {
1824             ItemKind::Impl(_, _, _, ref generics, _, ref ty, ref items) => {
1825                 let mut vis = ImplicitHasherTypeVisitor::new(cx);
1826                 vis.visit_ty(ty);
1827
1828                 for target in &vis.found {
1829                     if differing_macro_contexts(item.span, target.span()) {
1830                         return;
1831                     }
1832
1833                     let generics_suggestion_span = generics.span.substitute_dummy({
1834                         let pos = snippet_opt(cx, item.span.until(target.span()))
1835                             .and_then(|snip| Some(item.span.lo() + BytePos(snip.find("impl")? as u32 + 4)));
1836                         if let Some(pos) = pos {
1837                             Span::new(pos, pos, item.span.data().ctxt)
1838                         } else {
1839                             return;
1840                         }
1841                     });
1842
1843                     let mut ctr_vis = ImplicitHasherConstructorVisitor::new(cx, target);
1844                     for item in items.iter().map(|item| cx.tcx.hir.impl_item(item.id)) {
1845                         ctr_vis.visit_impl_item(item);
1846                     }
1847
1848                     span_lint_and_then(
1849                         cx,
1850                         IMPLICIT_HASHER,
1851                         target.span(),
1852                         &format!("impl for `{}` should be generalized over different hashers", target.type_name()),
1853                         move |db| {
1854                             suggestion(cx, db, generics.span, generics_suggestion_span, target, ctr_vis);
1855                         },
1856                     );
1857                 }
1858             },
1859             ItemKind::Fn(ref decl, .., ref generics, body_id) => {
1860                 let body = cx.tcx.hir.body(body_id);
1861
1862                 for ty in &decl.inputs {
1863                     let mut vis = ImplicitHasherTypeVisitor::new(cx);
1864                     vis.visit_ty(ty);
1865
1866                     for target in &vis.found {
1867                         let generics_suggestion_span = generics.span.substitute_dummy({
1868                             let pos = snippet_opt(cx, item.span.until(body.arguments[0].pat.span))
1869                                 .and_then(|snip| {
1870                                     let i = snip.find("fn")?;
1871                                     Some(item.span.lo() + BytePos((i + (&snip[i..]).find('(')?) as u32))
1872                                 })
1873                                 .expect("failed to create span for type parameters");
1874                             Span::new(pos, pos, item.span.data().ctxt)
1875                         });
1876
1877                         let mut ctr_vis = ImplicitHasherConstructorVisitor::new(cx, target);
1878                         ctr_vis.visit_body(body);
1879
1880                         span_lint_and_then(
1881                             cx,
1882                             IMPLICIT_HASHER,
1883                             target.span(),
1884                             &format!(
1885                                 "parameter of type `{}` should be generalized over different hashers",
1886                                 target.type_name()
1887                             ),
1888                             move |db| {
1889                                 suggestion(cx, db, generics.span, generics_suggestion_span, target, ctr_vis);
1890                             },
1891                         );
1892                     }
1893                 }
1894             },
1895             _ => {},
1896         }
1897     }
1898 }
1899
1900 enum ImplicitHasherType<'tcx> {
1901     HashMap(Span, Ty<'tcx>, Cow<'static, str>, Cow<'static, str>),
1902     HashSet(Span, Ty<'tcx>, Cow<'static, str>),
1903 }
1904
1905 impl<'tcx> ImplicitHasherType<'tcx> {
1906     /// Checks that `ty` is a target type without a BuildHasher.
1907     fn new<'a>(cx: &LateContext<'a, 'tcx>, hir_ty: &hir::Ty) -> Option<Self> {
1908         if let TyKind::Path(QPath::Resolved(None, ref path)) = hir_ty.node {
1909             let params: Vec<_> = path.segments.last().as_ref()?.args.as_ref()?
1910                 .args.iter().filter_map(|arg| match arg {
1911                     GenericArg::Type(ty) => Some(ty),
1912                     GenericArg::Lifetime(_) => None,
1913                 }).collect();
1914             let params_len = params.len();
1915
1916             let ty = hir_ty_to_ty(cx.tcx, hir_ty);
1917
1918             if match_path(path, &paths::HASHMAP) && params_len == 2 {
1919                 Some(ImplicitHasherType::HashMap(
1920                     hir_ty.span,
1921                     ty,
1922                     snippet(cx, params[0].span, "K"),
1923                     snippet(cx, params[1].span, "V"),
1924                 ))
1925             } else if match_path(path, &paths::HASHSET) && params_len == 1 {
1926                 Some(ImplicitHasherType::HashSet(hir_ty.span, ty, snippet(cx, params[0].span, "T")))
1927             } else {
1928                 None
1929             }
1930         } else {
1931             None
1932         }
1933     }
1934
1935     fn type_name(&self) -> &'static str {
1936         match *self {
1937             ImplicitHasherType::HashMap(..) => "HashMap",
1938             ImplicitHasherType::HashSet(..) => "HashSet",
1939         }
1940     }
1941
1942     fn type_arguments(&self) -> String {
1943         match *self {
1944             ImplicitHasherType::HashMap(.., ref k, ref v) => format!("{}, {}", k, v),
1945             ImplicitHasherType::HashSet(.., ref t) => format!("{}", t),
1946         }
1947     }
1948
1949     fn ty(&self) -> Ty<'tcx> {
1950         match *self {
1951             ImplicitHasherType::HashMap(_, ty, ..) | ImplicitHasherType::HashSet(_, ty, ..) => ty,
1952         }
1953     }
1954
1955     fn span(&self) -> Span {
1956         match *self {
1957             ImplicitHasherType::HashMap(span, ..) | ImplicitHasherType::HashSet(span, ..) => span,
1958         }
1959     }
1960 }
1961
1962 struct ImplicitHasherTypeVisitor<'a, 'tcx: 'a> {
1963     cx: &'a LateContext<'a, 'tcx>,
1964     found: Vec<ImplicitHasherType<'tcx>>,
1965 }
1966
1967 impl<'a, 'tcx: 'a> ImplicitHasherTypeVisitor<'a, 'tcx> {
1968     fn new(cx: &'a LateContext<'a, 'tcx>) -> Self {
1969         Self { cx, found: vec![] }
1970     }
1971 }
1972
1973 impl<'a, 'tcx: 'a> Visitor<'tcx> for ImplicitHasherTypeVisitor<'a, 'tcx> {
1974     fn visit_ty(&mut self, t: &'tcx hir::Ty) {
1975         if let Some(target) = ImplicitHasherType::new(self.cx, t) {
1976             self.found.push(target);
1977         }
1978
1979         walk_ty(self, t);
1980     }
1981
1982     fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
1983         NestedVisitorMap::None
1984     }
1985 }
1986
1987 /// Looks for default-hasher-dependent constructors like `HashMap::new`.
1988 struct ImplicitHasherConstructorVisitor<'a, 'b, 'tcx: 'a + 'b> {
1989     cx: &'a LateContext<'a, 'tcx>,
1990     body: &'a TypeckTables<'tcx>,
1991     target: &'b ImplicitHasherType<'tcx>,
1992     suggestions: BTreeMap<Span, String>,
1993 }
1994
1995 impl<'a, 'b, 'tcx: 'a + 'b> ImplicitHasherConstructorVisitor<'a, 'b, 'tcx> {
1996     fn new(cx: &'a LateContext<'a, 'tcx>, target: &'b ImplicitHasherType<'tcx>) -> Self {
1997         Self {
1998             cx,
1999             body: cx.tables,
2000             target,
2001             suggestions: BTreeMap::new(),
2002         }
2003     }
2004 }
2005
2006 impl<'a, 'b, 'tcx: 'a + 'b> Visitor<'tcx> for ImplicitHasherConstructorVisitor<'a, 'b, 'tcx> {
2007     fn visit_body(&mut self, body: &'tcx Body) {
2008         self.body = self.cx.tcx.body_tables(body.id());
2009         walk_body(self, body);
2010     }
2011
2012     fn visit_expr(&mut self, e: &'tcx Expr) {
2013         if_chain! {
2014             if let ExprKind::Call(ref fun, ref args) = e.node;
2015             if let ExprKind::Path(QPath::TypeRelative(ref ty, ref method)) = fun.node;
2016             if let TyKind::Path(QPath::Resolved(None, ref ty_path)) = ty.node;
2017             then {
2018                 if !same_tys(self.cx, self.target.ty(), self.body.expr_ty(e)) {
2019                     return;
2020                 }
2021
2022                 if match_path(ty_path, &paths::HASHMAP) {
2023                     if method.ident.name == "new" {
2024                         self.suggestions
2025                             .insert(e.span, "HashMap::default()".to_string());
2026                     } else if method.ident.name == "with_capacity" {
2027                         self.suggestions.insert(
2028                             e.span,
2029                             format!(
2030                                 "HashMap::with_capacity_and_hasher({}, Default::default())",
2031                                 snippet(self.cx, args[0].span, "capacity"),
2032                             ),
2033                         );
2034                     }
2035                 } else if match_path(ty_path, &paths::HASHSET) {
2036                     if method.ident.name == "new" {
2037                         self.suggestions
2038                             .insert(e.span, "HashSet::default()".to_string());
2039                     } else if method.ident.name == "with_capacity" {
2040                         self.suggestions.insert(
2041                             e.span,
2042                             format!(
2043                                 "HashSet::with_capacity_and_hasher({}, Default::default())",
2044                                 snippet(self.cx, args[0].span, "capacity"),
2045                             ),
2046                         );
2047                     }
2048                 }
2049             }
2050         }
2051
2052         walk_expr(self, e);
2053     }
2054
2055     fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
2056         NestedVisitorMap::OnlyBodies(&self.cx.tcx.hir)
2057     }
2058 }