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, lint_array};
   7 use rustc_data_structures::fx::FxHashMap;
   8 use std::default::Default;
   9 use syntax_pos::Span;
  10
  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 declare_clippy_lint! {
  38     pub MULTIPLE_INHERENT_IMPL,
  39     restriction,
  40     "Multiple inherent impl that could be grouped"
  41 }
  42
  43 pub struct Pass {
  44     impls: FxHashMap<def_id::DefId, (Span, Generics)>,
  45 }
  46
  47 impl Default for Pass {
  48     fn default() -> Self {
  49         Self {
  50             impls: FxHashMap::default(),
  51         }
  52     }
  53 }
  54
  55 impl LintPass for Pass {
  56     fn get_lints(&self) -> LintArray {
  57         lint_array!(MULTIPLE_INHERENT_IMPL)
  58     }
  59 }
  60
  61 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for Pass {
  62     fn check_item(&mut self, _: &LateContext<'a, 'tcx>, item: &'tcx Item) {
  63         if let ItemKind::Impl(_, _, _, ref generics, None, _, _) = item.node {
  64             // Remember for each inherent implementation encoutered its span and generics
  65             self.impls
  66                 .insert(item.hir_id.owner_def_id(), (item.span, generics.clone()));
  67         }
  68     }
  69
  70     fn check_crate_post(&mut self, cx: &LateContext<'a, 'tcx>, krate: &'tcx Crate) {
  71         if let Some(item) = krate.items.values().nth(0) {
  72             // Retrieve all inherent implementations from the crate, grouped by type
  73             for impls in cx
  74                 .tcx
  75                 .crate_inherent_impls(item.hir_id.owner_def_id().krate)
  76                 .inherent_impls
  77                 .values()
  78             {
  79                 // Filter out implementations that have generic params (type or lifetime)
  80                 let mut impl_spans = impls
  81                     .iter()
  82                     .filter_map(|impl_def| self.impls.get(impl_def))
  83                     .filter_map(|(span, generics)| if generics.params.len() == 0 { Some(span) } else { None });
  84                 if let Some(initial_span) = impl_spans.nth(0) {
  85                     impl_spans.for_each(|additional_span| {
  86                         span_lint_and_then(
  87                             cx,
  88                             MULTIPLE_INHERENT_IMPL,
  89                             *additional_span,
  90                             "Multiple implementations of this structure",
  91                             |db| {
  92                                 db.span_note(*initial_span, "First implementation here");
  93                             },
  94                         )
  95                     })
  96                 }
  97             }
  98         }
  99     }
 100 }