rust-clippy/clippy_lints/src/derive.rs

171 lines
5.9 KiB
Rust
Raw Normal View History

2018-05-30 08:15:50 +00:00
use crate::utils::paths;
use crate::utils::{is_automatically_derived, is_copy, match_path, span_lint_and_then};
2018-11-27 20:14:15 +00:00
use if_chain::if_chain;
use rustc::hir::*;
use rustc::lint::{LateContext, LateLintPass, LintArray, LintPass};
use rustc::ty::{self, Ty};
2019-04-08 20:43:55 +00:00
use rustc::{declare_lint_pass, declare_tool_lint};
use syntax::source_map::Span;
2018-03-28 13:24:26 +00:00
declare_clippy_lint! {
/// **What it does:** Checks for deriving `Hash` but implementing `PartialEq`
/// explicitly or vice versa.
///
/// **Why is this bad?** The implementation of these traits must agree (for
/// example for use with `HashMap`) so its probably a bad idea to use a
/// default-generated `Hash` implementation with an explicitly defined
/// `PartialEq`. In particular, the following must hold for any type:
///
2019-03-05 22:23:50 +00:00
/// ```text
/// k1 == k2 ⇒ hash(k1) == hash(k2)
/// ```
///
/// **Known problems:** None.
///
/// **Example:**
2019-03-05 22:23:50 +00:00
/// ```ignore
/// #[derive(Hash)]
/// struct Foo;
///
/// impl PartialEq for Foo {
/// ...
/// }
/// ```
2016-02-15 22:38:09 +00:00
pub DERIVE_HASH_XOR_EQ,
2018-03-28 13:24:26 +00:00
correctness,
"deriving `Hash` but implementing `PartialEq` explicitly"
}
2018-03-28 13:24:26 +00:00
declare_clippy_lint! {
/// **What it does:** Checks for explicit `Clone` implementations for `Copy`
/// types.
///
/// **Why is this bad?** To avoid surprising behaviour, these traits should
/// agree and the behaviour of `Copy` cannot be overridden. In almost all
/// situations a `Copy` type should have a `Clone` implementation that does
/// nothing more than copy the object, which is what `#[derive(Copy, Clone)]`
/// gets you.
///
/// **Known problems:** Bounds of generic types are sometimes wrong: https://github.com/rust-lang/rust/issues/26925
///
/// **Example:**
/// ```rust
/// #[derive(Copy)]
/// struct Foo;
///
/// impl Clone for Foo {
/// ..
/// }
/// ```
pub EXPL_IMPL_CLONE_ON_COPY,
2018-03-28 13:24:26 +00:00
pedantic,
"implementing `Clone` explicitly on `Copy` types"
}
2019-04-08 20:43:55 +00:00
declare_lint_pass!(Derive => [EXPL_IMPL_CLONE_ON_COPY, DERIVE_HASH_XOR_EQ]);
impl<'a, 'tcx> LateLintPass<'a, 'tcx> for Derive {
fn check_item(&mut self, cx: &LateContext<'a, 'tcx>, item: &'tcx Item) {
2018-07-16 13:07:39 +00:00
if let ItemKind::Impl(_, _, _, _, Some(ref trait_ref), _, _) = item.node {
2019-03-01 12:26:06 +00:00
let ty = cx.tcx.type_of(cx.tcx.hir().local_def_id_from_hir_id(item.hir_id));
let is_automatically_derived = is_automatically_derived(&*item.attrs);
2016-02-15 22:38:09 +00:00
check_hash_peq(cx, item.span, trait_ref, ty, is_automatically_derived);
if !is_automatically_derived {
2016-02-14 19:29:32 +00:00
check_copy_clone(cx, item, trait_ref, ty);
}
2016-06-05 18:46:27 +00:00
}
}
}
2016-02-15 22:38:09 +00:00
/// Implementation of the `DERIVE_HASH_XOR_EQ` lint.
fn check_hash_peq<'a, 'tcx>(
cx: &LateContext<'a, 'tcx>,
span: Span,
trait_ref: &TraitRef,
ty: Ty<'tcx>,
2017-08-09 07:30:56 +00:00
hash_is_automatically_derived: bool,
) {
if_chain! {
if match_path(&trait_ref.path, &paths::HASH);
if let Some(peq_trait_def_id) = cx.tcx.lang_items().eq_trait();
then {
// Look for the PartialEq implementations for `ty`
cx.tcx.for_each_relevant_impl(peq_trait_def_id, ty, |impl_id| {
let peq_is_automatically_derived = is_automatically_derived(&cx.tcx.get_attrs(impl_id));
2017-11-04 19:55:56 +00:00
if peq_is_automatically_derived == hash_is_automatically_derived {
return;
}
2017-11-04 19:55:56 +00:00
let trait_ref = cx.tcx.impl_trait_ref(impl_id).expect("must be a trait implementation");
2017-11-04 19:55:56 +00:00
// Only care about `impl PartialEq<Foo> for Foo`
// For `impl PartialEq<B> for A, input_types is [A, B]
if trait_ref.substs.type_at(1) == ty {
let mess = if peq_is_automatically_derived {
"you are implementing `Hash` explicitly but have derived `PartialEq`"
} else {
"you are deriving `Hash` but have implemented `PartialEq` explicitly"
};
2017-11-04 19:55:56 +00:00
span_lint_and_then(
cx, DERIVE_HASH_XOR_EQ, span,
mess,
|db| {
if let Some(node_id) = cx.tcx.hir().as_local_node_id(impl_id) {
db.span_note(
cx.tcx.hir().span(node_id),
"`PartialEq` implemented here"
);
}
});
}
});
}
}
}
/// Implementation of the `EXPL_IMPL_CLONE_ON_COPY` lint.
fn check_copy_clone<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, item: &Item, trait_ref: &TraitRef, ty: Ty<'tcx>) {
if match_path(&trait_ref.path, &paths::CLONE_TRAIT) {
if !is_copy(cx, ty) {
return;
}
match ty.sty {
ty::Adt(def, _) if def.is_union() => return,
2016-08-28 17:43:55 +00:00
// Some types are not Clone by default but could be cloned “by hand” if necessary
2018-11-27 20:14:15 +00:00
ty::Adt(def, substs) => {
for variant in &def.variants {
for field in &variant.fields {
if let ty::FnDef(..) = field.ty(cx.tcx, substs).sty {
return;
}
}
2018-11-27 20:14:15 +00:00
for subst in substs {
if let ty::subst::UnpackedKind::Type(subst) = subst.unpack() {
if let ty::Param(_) = subst.sty {
return;
}
}
}
}
2016-12-20 17:21:30 +00:00
},
_ => (),
}
2017-09-05 09:33:04 +00:00
span_lint_and_then(
cx,
EXPL_IMPL_CLONE_ON_COPY,
item.span,
"you are implementing `Clone` explicitly on a `Copy` type",
2017-11-04 19:55:56 +00:00
|db| {
db.span_note(item.span, "consider deriving `Clone` or removing `Copy`");
},
2017-09-05 09:33:04 +00:00
);
}
}