clippy_lints/src/derive.rs

   1 use rustc::lint::*;
   2 use rustc::{declare_lint, lint_array};
   3 use if_chain::if_chain;
   4 use rustc::ty::{self, Ty};
   5 use rustc::hir::*;
   6 use syntax::codemap::Span;
   7 use crate::utils::paths;
   8 use crate::utils::{is_automatically_derived, is_copy, match_path, span_lint_and_then};
   9
  10 /// **What it does:** Checks for deriving `Hash` but implementing `PartialEq`
  11 /// explicitly or vice versa.
  12 ///
  13 /// **Why is this bad?** The implementation of these traits must agree (for
  14 /// example for use with `HashMap`) so it’s probably a bad idea to use a
  15 /// default-generated `Hash` implementation with an explicitly defined
  16 /// `PartialEq`. In particular, the following must hold for any type:
  17 ///
  18 /// ```rust
  19 /// k1 == k2 ⇒ hash(k1) == hash(k2)
  20 /// ```
  21 ///
  22 /// **Known problems:** None.
  23 ///
  24 /// **Example:**
  25 /// ```rust
  26 /// #[derive(Hash)]
  27 /// struct Foo;
  28 ///
  29 /// impl PartialEq for Foo {
  30 ///     ...
  31 /// }
  32 /// ```
  33 declare_clippy_lint! {
  34     pub DERIVE_HASH_XOR_EQ,
  35     correctness,
  36     "deriving `Hash` but implementing `PartialEq` explicitly"
  37 }
  38
  39 /// **What it does:** Checks for explicit `Clone` implementations for `Copy`
  40 /// types.
  41 ///
  42 /// **Why is this bad?** To avoid surprising behaviour, these traits should
  43 /// agree and the behaviour of `Copy` cannot be overridden. In almost all
  44 /// situations a `Copy` type should have a `Clone` implementation that does
  45 /// nothing more than copy the object, which is what `#[derive(Copy, Clone)]`
  46 /// gets you.
  47 ///
  48 /// **Known problems:** Bounds of generic types are sometimes wrong: https://github.com/rust-lang/rust/issues/26925
  49 ///
  50 /// **Example:**
  51 /// ```rust
  52 /// #[derive(Copy)]
  53 /// struct Foo;
  54 ///
  55 /// impl Clone for Foo {
  56 ///     ..
  57 /// }
  58 /// ```
  59 declare_clippy_lint! {
  60     pub EXPL_IMPL_CLONE_ON_COPY,
  61     pedantic,
  62     "implementing `Clone` explicitly on `Copy` types"
  63 }
  64
  65 pub struct Derive;
  66
  67 impl LintPass for Derive {
  68     fn get_lints(&self) -> LintArray {
  69         lint_array!(EXPL_IMPL_CLONE_ON_COPY, DERIVE_HASH_XOR_EQ)
  70     }
  71 }
  72
  73 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for Derive {
  74     fn check_item(&mut self, cx: &LateContext<'a, 'tcx>, item: &'tcx Item) {
  75         if let ItemKind::Impl(_, _, _, _, Some(ref trait_ref), _, _) = item.node {
  76             let ty = cx.tcx.type_of(cx.tcx.hir.local_def_id(item.id));
  77             let is_automatically_derived = is_automatically_derived(&*item.attrs);
  78
  79             check_hash_peq(cx, item.span, trait_ref, ty, is_automatically_derived);
  80
  81             if !is_automatically_derived {
  82                 check_copy_clone(cx, item, trait_ref, ty);
  83             }
  84         }
  85     }
  86 }
  87
  88 /// Implementation of the `DERIVE_HASH_XOR_EQ` lint.
  89 fn check_hash_peq<'a, 'tcx>(
  90     cx: &LateContext<'a, 'tcx>,
  91     span: Span,
  92     trait_ref: &TraitRef,
  93     ty: Ty<'tcx>,
  94     hash_is_automatically_derived: bool,
  95 ) {
  96     if_chain! {
  97         if match_path(&trait_ref.path, &paths::HASH);
  98         if let Some(peq_trait_def_id) = cx.tcx.lang_items().eq_trait();
  99         then {
 100             // Look for the PartialEq implementations for `ty`
 101             cx.tcx.for_each_relevant_impl(peq_trait_def_id, ty, |impl_id| {
 102                 let peq_is_automatically_derived = is_automatically_derived(&cx.tcx.get_attrs(impl_id));
 103
 104                 if peq_is_automatically_derived == hash_is_automatically_derived {
 105                     return;
 106                 }
 107
 108                 let trait_ref = cx.tcx.impl_trait_ref(impl_id).expect("must be a trait implementation");
 109
 110                 // Only care about `impl PartialEq<Foo> for Foo`
 111                 // For `impl PartialEq<B> for A, input_types is [A, B]
 112                 if trait_ref.substs.type_at(1) == ty {
 113                     let mess = if peq_is_automatically_derived {
 114                         "you are implementing `Hash` explicitly but have derived `PartialEq`"
 115                     } else {
 116                         "you are deriving `Hash` but have implemented `PartialEq` explicitly"
 117                     };
 118
 119                     span_lint_and_then(
 120                         cx, DERIVE_HASH_XOR_EQ, span,
 121                         mess,
 122                         |db| {
 123                         if let Some(node_id) = cx.tcx.hir.as_local_node_id(impl_id) {
 124                             db.span_note(
 125                                 cx.tcx.hir.span(node_id),
 126                                 "`PartialEq` implemented here"
 127                             );
 128                         }
 129                     });
 130                 }
 131             });
 132         }
 133     }
 134 }
 135
 136 /// Implementation of the `EXPL_IMPL_CLONE_ON_COPY` lint.
 137 fn check_copy_clone<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, item: &Item, trait_ref: &TraitRef, ty: Ty<'tcx>) {
 138     if match_path(&trait_ref.path, &paths::CLONE_TRAIT) {
 139         if !is_copy(cx, ty) {
 140             return;
 141         }
 142
 143         match ty.sty {
 144             ty::TyAdt(def, _) if def.is_union() => return,
 145
 146             // Some types are not Clone by default but could be cloned “by hand” if necessary
 147             ty::TyAdt(def, substs) => for variant in &def.variants {
 148                 for field in &variant.fields {
 149                     if let ty::TyFnDef(..) = field.ty(cx.tcx, substs).sty {
 150                         return;
 151                     }
 152                 }
 153                 for subst in substs {
 154                     if let ty::subst::UnpackedKind::Type(subst) = subst.unpack() {
 155                         if let ty::TyParam(_) = subst.sty {
 156                             return;
 157                         }
 158                     }
 159                 }
 160             },
 161             _ => (),
 162         }
 163
 164         span_lint_and_then(
 165             cx,
 166             EXPL_IMPL_CLONE_ON_COPY,
 167             item.span,
 168             "you are implementing `Clone` explicitly on a `Copy` type",
 169             |db| {
 170                 db.span_note(item.span, "consider deriving `Clone` or removing `Copy`");
 171             },
 172         );
 173     }
 174 }