clippy_lints/src/inherent_impl.rs

   1 //! lint on inherent implementations
   2
   3 use crate::utils::span_lint_and_then;
   4 use rustc::hir::*;
   5 use rustc::lint::{LateContext, LateLintPass, LintArray, LintPass};
   6 use rustc::{declare_tool_lint, impl_lint_pass};
   7 use rustc_data_structures::fx::FxHashMap;
   8 use syntax_pos::Span;
   9
  10 declare_clippy_lint! {
  11     /// **What it does:** Checks for multiple inherent implementations of a struct
  12     ///
  13     /// **Why is this bad?** Splitting the implementation of a type makes the code harder to navigate.
  14     ///
  15     /// **Known problems:** None.
  16     ///
  17     /// **Example:**
  18     /// ```rust
  19     /// struct X;
  20     /// impl X {
  21     ///     fn one() {}
  22     /// }
  23     /// impl X {
  24     ///     fn other() {}
  25     /// }
  26     /// ```
  27     ///
  28     /// Could be written:
  29     ///
  30     /// ```rust
  31     /// struct X;
  32     /// impl X {
  33     ///     fn one() {}
  34     ///     fn other() {}
  35     /// }
  36     /// ```
  37     pub MULTIPLE_INHERENT_IMPL,
  38     restriction,
  39     "Multiple inherent impl that could be grouped"
  40 }
  41
  42 #[allow(clippy::module_name_repetitions)]
  43 #[derive(Default)]
  44 pub struct MultipleInherentImpl {
  45     impls: FxHashMap<def_id::DefId, Span>,
  46 }
  47
  48 impl_lint_pass!(MultipleInherentImpl => [MULTIPLE_INHERENT_IMPL]);
  49
  50 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for MultipleInherentImpl {
  51     fn check_item(&mut self, _: &LateContext<'a, 'tcx>, item: &'tcx Item) {
  52         if let ItemKind::Impl(_, _, _, ref generics, None, _, _) = item.node {
  53             // Remember for each inherent implementation encoutered its span and generics
  54             // but filter out implementations that have generic params (type or lifetime)
  55             if generics.params.len() == 0 {
  56                 self.impls.insert(item.hir_id.owner_def_id(), item.span);
  57             }
  58         }
  59     }
  60
  61     fn check_crate_post(&mut self, cx: &LateContext<'a, 'tcx>, krate: &'tcx Crate) {
  62         if let Some(item) = krate.items.values().nth(0) {
  63             // Retrieve all inherent implementations from the crate, grouped by type
  64             for impls in cx
  65                 .tcx
  66                 .crate_inherent_impls(item.hir_id.owner_def_id().krate)
  67                 .inherent_impls
  68                 .values()
  69             {
  70                 // Filter out implementations that have generic params (type or lifetime)
  71                 let mut impl_spans = impls.iter().filter_map(|impl_def| self.impls.get(impl_def));
  72                 if let Some(initial_span) = impl_spans.nth(0) {
  73                     impl_spans.for_each(|additional_span| {
  74                         span_lint_and_then(
  75                             cx,
  76                             MULTIPLE_INHERENT_IMPL,
  77                             *additional_span,
  78                             "Multiple implementations of this structure",
  79                             |db| {
  80                                 db.span_note(*initial_span, "First implementation here");
  81                             },
  82                         )
  83                     })
  84                 }
  85             }
  86         }
  87     }
  88 }