2018-05-29 00:17:55 +00:00
|
|
|
//! lint on inherent implementations
|
|
|
|
|
2021-03-16 00:55:45 +00:00
|
|
|
use clippy_utils::diagnostics::span_lint_and_then;
|
2021-03-16 16:06:34 +00:00
|
|
|
use clippy_utils::in_macro;
|
2021-03-31 21:39:09 +00:00
|
|
|
use rustc_hir::def_id::DefIdMap;
|
2021-01-15 09:56:44 +00:00
|
|
|
use rustc_hir::{def_id, Crate, Impl, Item, ItemKind};
|
2020-01-12 06:08:41 +00:00
|
|
|
use rustc_lint::{LateContext, LateLintPass};
|
2020-01-11 11:37:08 +00:00
|
|
|
use rustc_session::{declare_tool_lint, impl_lint_pass};
|
2019-12-31 00:17:56 +00:00
|
|
|
use rustc_span::Span;
|
2018-05-29 00:17:55 +00:00
|
|
|
|
|
|
|
declare_clippy_lint! {
|
2019-03-05 16:50:33 +00:00
|
|
|
/// **What it does:** Checks for multiple inherent implementations of a struct
|
|
|
|
///
|
|
|
|
/// **Why is this bad?** Splitting the implementation of a type makes the code harder to navigate.
|
|
|
|
///
|
|
|
|
/// **Known problems:** None.
|
|
|
|
///
|
|
|
|
/// **Example:**
|
|
|
|
/// ```rust
|
|
|
|
/// struct X;
|
|
|
|
/// impl X {
|
|
|
|
/// fn one() {}
|
|
|
|
/// }
|
|
|
|
/// impl X {
|
|
|
|
/// fn other() {}
|
|
|
|
/// }
|
|
|
|
/// ```
|
|
|
|
///
|
|
|
|
/// Could be written:
|
|
|
|
///
|
|
|
|
/// ```rust
|
|
|
|
/// struct X;
|
|
|
|
/// impl X {
|
|
|
|
/// fn one() {}
|
|
|
|
/// fn other() {}
|
|
|
|
/// }
|
|
|
|
/// ```
|
2018-05-29 00:17:55 +00:00
|
|
|
pub MULTIPLE_INHERENT_IMPL,
|
2018-05-29 08:19:16 +00:00
|
|
|
restriction,
|
2018-05-29 00:17:55 +00:00
|
|
|
"Multiple inherent impl that could be grouped"
|
|
|
|
}
|
|
|
|
|
2019-04-08 20:43:55 +00:00
|
|
|
#[allow(clippy::module_name_repetitions)]
|
|
|
|
#[derive(Default)]
|
|
|
|
pub struct MultipleInherentImpl {
|
2021-03-31 21:39:09 +00:00
|
|
|
impls: DefIdMap<Span>,
|
2018-05-29 00:17:55 +00:00
|
|
|
}
|
|
|
|
|
2019-04-08 20:43:55 +00:00
|
|
|
impl_lint_pass!(MultipleInherentImpl => [MULTIPLE_INHERENT_IMPL]);
|
2018-05-29 00:17:55 +00:00
|
|
|
|
2020-06-25 20:41:36 +00:00
|
|
|
impl<'tcx> LateLintPass<'tcx> for MultipleInherentImpl {
|
|
|
|
fn check_item(&mut self, _: &LateContext<'tcx>, item: &'tcx Item<'_>) {
|
2020-11-22 22:46:21 +00:00
|
|
|
if let ItemKind::Impl(Impl {
|
2020-01-18 05:14:36 +00:00
|
|
|
ref generics,
|
|
|
|
of_trait: None,
|
|
|
|
..
|
2020-11-22 22:46:21 +00:00
|
|
|
}) = item.kind
|
2020-01-18 05:14:36 +00:00
|
|
|
{
|
2020-07-26 19:07:07 +00:00
|
|
|
// Remember for each inherent implementation encountered its span and generics
|
2019-06-21 06:14:07 +00:00
|
|
|
// but filter out implementations that have generic params (type or lifetime)
|
2019-09-28 01:46:55 +00:00
|
|
|
// or are derived from a macro
|
2019-12-31 07:50:43 +00:00
|
|
|
if !in_macro(item.span) && generics.params.is_empty() {
|
2021-01-30 16:47:51 +00:00
|
|
|
self.impls.insert(item.def_id.to_def_id(), item.span);
|
2019-06-21 06:14:07 +00:00
|
|
|
}
|
2018-05-29 00:17:55 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-06-25 20:41:36 +00:00
|
|
|
fn check_crate_post(&mut self, cx: &LateContext<'tcx>, krate: &'tcx Crate<'_>) {
|
2021-01-30 16:47:51 +00:00
|
|
|
if !krate.items.is_empty() {
|
2018-05-29 00:17:55 +00:00
|
|
|
// Retrieve all inherent implementations from the crate, grouped by type
|
2021-01-30 16:47:51 +00:00
|
|
|
for impls in cx.tcx.crate_inherent_impls(def_id::LOCAL_CRATE).inherent_impls.values() {
|
2018-05-29 00:17:55 +00:00
|
|
|
// Filter out implementations that have generic params (type or lifetime)
|
2019-06-21 06:14:07 +00:00
|
|
|
let mut impl_spans = impls.iter().filter_map(|impl_def| self.impls.get(impl_def));
|
2019-12-28 22:31:41 +00:00
|
|
|
if let Some(initial_span) = impl_spans.next() {
|
2018-05-29 00:17:55 +00:00
|
|
|
impl_spans.for_each(|additional_span| {
|
2018-08-28 11:13:42 +00:00
|
|
|
span_lint_and_then(
|
|
|
|
cx,
|
2018-05-29 00:17:55 +00:00
|
|
|
MULTIPLE_INHERENT_IMPL,
|
|
|
|
*additional_span,
|
2020-08-28 14:10:16 +00:00
|
|
|
"multiple implementations of this structure",
|
2020-04-17 06:08:00 +00:00
|
|
|
|diag| {
|
2020-08-28 14:10:16 +00:00
|
|
|
diag.span_note(*initial_span, "first implementation here");
|
2018-08-28 11:13:42 +00:00
|
|
|
},
|
2018-05-29 00:17:55 +00:00
|
|
|
)
|
|
|
|
})
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|