clippy_lints/src/derive.rs

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