src/librustdoc/passes/collect_trait_impls.rs

   1 use super::Pass;
   2 use crate::clean::*;
   3 use crate::core::DocContext;
   4 use crate::fold::DocFolder;
   5
   6 use rustc_data_structures::fx::FxHashSet;
   7 use rustc_hir::def_id::{DefId, LOCAL_CRATE};
   8 use rustc_span::symbol::sym;
   9
  10 pub const COLLECT_TRAIT_IMPLS: Pass = Pass {
  11     name: "collect-trait-impls",
  12     run: collect_trait_impls,
  13     description: "retrieves trait impls for items in the crate",
  14 };
  15
  16 pub fn collect_trait_impls(krate: Crate, cx: &DocContext<'_>) -> Crate {
  17     let mut synth = SyntheticImplCollector::new(cx);
  18     let mut krate = synth.fold_crate(krate);
  19
  20     let prims: FxHashSet<PrimitiveType> = krate.primitives.iter().map(|p| p.1).collect();
  21
  22     let crate_items = {
  23         let mut coll = ItemCollector::new();
  24         krate = coll.fold_crate(krate);
  25         coll.items
  26     };
  27
  28     let mut new_items = Vec::new();
  29
  30     for &cnum in cx.tcx.crates().iter() {
  31         for &(did, _) in cx.tcx.all_trait_implementations(cnum).iter() {
  32             inline::build_impl(cx, did, None, &mut new_items);
  33         }
  34     }
  35
  36     // Also try to inline primitive impls from other crates.
  37     for &def_id in PrimitiveType::all_impls(cx.tcx).values().flatten() {
  38         if !def_id.is_local() {
  39             inline::build_impl(cx, def_id, None, &mut new_items);
  40
  41             // FIXME(eddyb) is this `doc(hidden)` check needed?
  42             if !cx.tcx.get_attrs(def_id).lists(sym::doc).has_word(sym::hidden) {
  43                 let self_ty = cx.tcx.type_of(def_id);
  44                 let impls = get_auto_trait_and_blanket_impls(cx, self_ty, def_id);
  45                 let mut renderinfo = cx.renderinfo.borrow_mut();
  46
  47                 new_items.extend(impls.filter(|i| renderinfo.inlined.insert(i.def_id)));
  48             }
  49         }
  50     }
  51
  52     let mut cleaner = BadImplStripper { prims, items: crate_items };
  53
  54     // scan through included items ahead of time to splice in Deref targets to the "valid" sets
  55     for it in &new_items {
  56         if let ImplItem(Impl { ref for_, ref trait_, ref items, .. }) = it.inner {
  57             if cleaner.keep_item(for_) && trait_.def_id() == cx.tcx.lang_items().deref_trait() {
  58                 let target = items
  59                     .iter()
  60                     .find_map(|item| match item.inner {
  61                         TypedefItem(ref t, true) => Some(&t.type_),
  62                         _ => None,
  63                     })
  64                     .expect("Deref impl without Target type");
  65
  66                 if let Some(prim) = target.primitive_type() {
  67                     cleaner.prims.insert(prim);
  68                 } else if let Some(did) = target.def_id() {
  69                     cleaner.items.insert(did);
  70                 }
  71             }
  72         }
  73     }
  74
  75     new_items.retain(|it| {
  76         if let ImplItem(Impl { ref for_, ref trait_, ref blanket_impl, .. }) = it.inner {
  77             cleaner.keep_item(for_)
  78                 || trait_.as_ref().map_or(false, |t| cleaner.keep_item(t))
  79                 || blanket_impl.is_some()
  80         } else {
  81             true
  82         }
  83     });
  84
  85     // `tcx.crates()` doesn't include the local crate, and `tcx.all_trait_implementations`
  86     // doesn't work with it anyway, so pull them from the HIR map instead
  87     for &trait_did in cx.tcx.all_traits(LOCAL_CRATE).iter() {
  88         for &impl_node in cx.tcx.hir().trait_impls(trait_did) {
  89             let impl_did = cx.tcx.hir().local_def_id(impl_node);
  90             inline::build_impl(cx, impl_did.to_def_id(), None, &mut new_items);
  91         }
  92     }
  93
  94     if let Some(ref mut it) = krate.module {
  95         if let ModuleItem(Module { ref mut items, .. }) = it.inner {
  96             items.extend(synth.impls);
  97             items.extend(new_items);
  98         } else {
  99             panic!("collect-trait-impls can't run");
 100         }
 101     } else {
 102         panic!("collect-trait-impls can't run");
 103     }
 104
 105     krate
 106 }
 107
 108 struct SyntheticImplCollector<'a, 'tcx> {
 109     cx: &'a DocContext<'tcx>,
 110     impls: Vec<Item>,
 111 }
 112
 113 impl<'a, 'tcx> SyntheticImplCollector<'a, 'tcx> {
 114     fn new(cx: &'a DocContext<'tcx>) -> Self {
 115         SyntheticImplCollector { cx, impls: Vec::new() }
 116     }
 117 }
 118
 119 impl<'a, 'tcx> DocFolder for SyntheticImplCollector<'a, 'tcx> {
 120     fn fold_item(&mut self, i: Item) -> Option<Item> {
 121         if i.is_struct() || i.is_enum() || i.is_union() {
 122             // FIXME(eddyb) is this `doc(hidden)` check needed?
 123             if !self.cx.tcx.get_attrs(i.def_id).lists(sym::doc).has_word(sym::hidden) {
 124                 self.impls.extend(get_auto_trait_and_blanket_impls(
 125                     self.cx,
 126                     self.cx.tcx.type_of(i.def_id),
 127                     i.def_id,
 128                 ));
 129             }
 130         }
 131
 132         self.fold_item_recur(i)
 133     }
 134 }
 135
 136 #[derive(Default)]
 137 struct ItemCollector {
 138     items: FxHashSet<DefId>,
 139 }
 140
 141 impl ItemCollector {
 142     fn new() -> Self {
 143         Self::default()
 144     }
 145 }
 146
 147 impl DocFolder for ItemCollector {
 148     fn fold_item(&mut self, i: Item) -> Option<Item> {
 149         self.items.insert(i.def_id);
 150
 151         self.fold_item_recur(i)
 152     }
 153 }
 154
 155 struct BadImplStripper {
 156     prims: FxHashSet<PrimitiveType>,
 157     items: FxHashSet<DefId>,
 158 }
 159
 160 impl BadImplStripper {
 161     fn keep_item(&self, ty: &Type) -> bool {
 162         if let Generic(_) = ty {
 163             // keep impls made on generics
 164             true
 165         } else if let Some(prim) = ty.primitive_type() {
 166             self.prims.contains(&prim)
 167         } else if let Some(did) = ty.def_id() {
 168             self.items.contains(&did)
 169         } else {
 170             false
 171         }
 172     }
 173 }