src/librustdoc/passes/collect_trait_impls.rs

   1 //! Collects trait impls for each item in the crate. For example, if a crate
   2 //! defines a struct that implements a trait, this pass will note that the
   3 //! struct implements that trait.
   4 use super::Pass;
   5 use crate::clean::*;
   6 use crate::core::DocContext;
   7 use crate::formats::cache::Cache;
   8 use crate::visit::DocVisitor;
   9
  10 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
  11 use rustc_hir::def_id::DefId;
  12 use rustc_middle::ty::{self, DefIdTree};
  13 use rustc_span::symbol::sym;
  14
  15 pub(crate) const COLLECT_TRAIT_IMPLS: Pass = Pass {
  16     name: "collect-trait-impls",
  17     run: collect_trait_impls,
  18     description: "retrieves trait impls for items in the crate",
  19 };
  20
  21 pub(crate) fn collect_trait_impls(mut krate: Crate, cx: &mut DocContext<'_>) -> Crate {
  22     let synth_impls = cx.sess().time("collect_synthetic_impls", || {
  23         let mut synth = SyntheticImplCollector { cx, impls: Vec::new() };
  24         synth.visit_crate(&krate);
  25         synth.impls
  26     });
  27
  28     let prims: FxHashSet<PrimitiveType> = krate.primitives.iter().map(|p| p.1).collect();
  29
  30     let crate_items = {
  31         let mut coll = ItemCollector::new();
  32         cx.sess().time("collect_items_for_trait_impls", || coll.visit_crate(&krate));
  33         coll.items
  34     };
  35
  36     let mut new_items_external = Vec::new();
  37     let mut new_items_local = Vec::new();
  38
  39     // External trait impls.
  40     cx.with_all_trait_impls(|cx, all_trait_impls| {
  41         let _prof_timer = cx.tcx.sess.prof.generic_activity("build_extern_trait_impls");
  42         for &impl_def_id in all_trait_impls.iter().skip_while(|def_id| def_id.is_local()) {
  43             inline::build_impl(cx, None, impl_def_id, None, &mut new_items_external);
  44         }
  45     });
  46
  47     // Local trait impls.
  48     cx.with_all_trait_impls(|cx, all_trait_impls| {
  49         let _prof_timer = cx.tcx.sess.prof.generic_activity("build_local_trait_impls");
  50         let mut attr_buf = Vec::new();
  51         for &impl_def_id in all_trait_impls.iter().take_while(|def_id| def_id.is_local()) {
  52             let mut parent = Some(cx.tcx.parent(impl_def_id));
  53             while let Some(did) = parent {
  54                 attr_buf.extend(
  55                     cx.tcx
  56                         .get_attrs(did, sym::doc)
  57                         .filter(|attr| {
  58                             if let Some([attr]) = attr.meta_item_list().as_deref() {
  59                                 attr.has_name(sym::cfg)
  60                             } else {
  61                                 false
  62                             }
  63                         })
  64                         .cloned(),
  65                 );
  66                 parent = cx.tcx.opt_parent(did);
  67             }
  68             inline::build_impl(cx, None, impl_def_id, Some(&attr_buf), &mut new_items_local);
  69             attr_buf.clear();
  70         }
  71     });
  72
  73     cx.tcx.sess.prof.generic_activity("build_primitive_trait_impls").run(|| {
  74         for def_id in PrimitiveType::all_impls(cx.tcx) {
  75             // Try to inline primitive impls from other crates.
  76             if !def_id.is_local() {
  77                 inline::build_impl(cx, None, def_id, None, &mut new_items_external);
  78             }
  79         }
  80         for (prim, did) in PrimitiveType::primitive_locations(cx.tcx) {
  81             // Do not calculate blanket impl list for docs that are not going to be rendered.
  82             // While the `impl` blocks themselves are only in `libcore`, the module with `doc`
  83             // attached is directly included in `libstd` as well.
  84             let tcx = cx.tcx;
  85             if did.is_local() {
  86                 for def_id in prim.impls(tcx).filter(|def_id| {
  87                     // Avoid including impl blocks with filled-in generics.
  88                     // https://github.com/rust-lang/rust/issues/94937
  89                     //
  90                     // FIXME(notriddle): https://github.com/rust-lang/rust/issues/97129
  91                     //
  92                     // This tactic of using inherent impl blocks for getting
  93                     // auto traits and blanket impls is a hack. What we really
  94                     // want is to check if `[T]` impls `Send`, which has
  95                     // nothing to do with the inherent impl.
  96                     //
  97                     // Rustdoc currently uses these `impl` block as a source of
  98                     // the `Ty`, as well as the `ParamEnv`, `SubstsRef`, and
  99                     // `Generics`. To avoid relying on the `impl` block, these
 100                     // things would need to be created from wholecloth, in a
 101                     // form that is valid for use in type inference.
 102                     let ty = tcx.type_of(def_id);
 103                     match ty.kind() {
 104                         ty::Slice(ty)
 105                         | ty::Ref(_, ty, _)
 106                         | ty::RawPtr(ty::TypeAndMut { ty, .. }) => {
 107                             matches!(ty.kind(), ty::Param(..))
 108                         }
 109                         ty::Tuple(tys) => tys.iter().all(|ty| matches!(ty.kind(), ty::Param(..))),
 110                         _ => true,
 111                     }
 112                 }) {
 113                     let impls = get_auto_trait_and_blanket_impls(cx, def_id);
 114                     new_items_external.extend(impls.filter(|i| cx.inlined.insert(i.item_id)));
 115                 }
 116             }
 117         }
 118     });
 119
 120     let mut cleaner = BadImplStripper { prims, items: crate_items, cache: &cx.cache };
 121     let mut type_did_to_deref_target: FxHashMap<DefId, &Type> = FxHashMap::default();
 122
 123     // Follow all `Deref` targets of included items and recursively add them as valid
 124     fn add_deref_target(
 125         cx: &DocContext<'_>,
 126         map: &FxHashMap<DefId, &Type>,
 127         cleaner: &mut BadImplStripper<'_>,
 128         targets: &mut FxHashSet<DefId>,
 129         type_did: DefId,
 130     ) {
 131         if let Some(target) = map.get(&type_did) {
 132             debug!("add_deref_target: type {:?}, target {:?}", type_did, target);
 133             if let Some(target_prim) = target.primitive_type() {
 134                 cleaner.prims.insert(target_prim);
 135             } else if let Some(target_did) = target.def_id(&cx.cache) {
 136                 // `impl Deref<Target = S> for S`
 137                 if !targets.insert(target_did) {
 138                     // Avoid infinite cycles
 139                     return;
 140                 }
 141                 cleaner.items.insert(target_did.into());
 142                 add_deref_target(cx, map, cleaner, targets, target_did);
 143             }
 144         }
 145     }
 146
 147     // scan through included items ahead of time to splice in Deref targets to the "valid" sets
 148     for it in new_items_external.iter().chain(new_items_local.iter()) {
 149         if let ImplItem(box Impl { ref for_, ref trait_, ref items, .. }) = *it.kind {
 150             if trait_.as_ref().map(|t| t.def_id()) == cx.tcx.lang_items().deref_trait()
 151                 && cleaner.keep_impl(for_, true)
 152             {
 153                 let target = items
 154                     .iter()
 155                     .find_map(|item| match *item.kind {
 156                         AssocTypeItem(ref t, _) => Some(&t.type_),
 157                         _ => None,
 158                     })
 159                     .expect("Deref impl without Target type");
 160
 161                 if let Some(prim) = target.primitive_type() {
 162                     cleaner.prims.insert(prim);
 163                 } else if let Some(did) = target.def_id(&cx.cache) {
 164                     cleaner.items.insert(did.into());
 165                 }
 166                 if let Some(for_did) = for_.def_id(&cx.cache) {
 167                     if type_did_to_deref_target.insert(for_did, target).is_none() {
 168                         // Since only the `DefId` portion of the `Type` instances is known to be same for both the
 169                         // `Deref` target type and the impl for type positions, this map of types is keyed by
 170                         // `DefId` and for convenience uses a special cleaner that accepts `DefId`s directly.
 171                         if cleaner.keep_impl_with_def_id(for_did.into()) {
 172                             let mut targets = FxHashSet::default();
 173                             targets.insert(for_did);
 174                             add_deref_target(
 175                                 cx,
 176                                 &type_did_to_deref_target,
 177                                 &mut cleaner,
 178                                 &mut targets,
 179                                 for_did,
 180                             );
 181                         }
 182                     }
 183                 }
 184             }
 185         }
 186     }
 187
 188     // Filter out external items that are not needed
 189     new_items_external.retain(|it| {
 190         if let ImplItem(box Impl { ref for_, ref trait_, ref kind, .. }) = *it.kind {
 191             cleaner.keep_impl(
 192                 for_,
 193                 trait_.as_ref().map(|t| t.def_id()) == cx.tcx.lang_items().deref_trait(),
 194             ) || trait_.as_ref().map_or(false, |t| cleaner.keep_impl_with_def_id(t.def_id().into()))
 195                 || kind.is_blanket()
 196         } else {
 197             true
 198         }
 199     });
 200
 201     if let ModuleItem(Module { items, .. }) = &mut *krate.module.kind {
 202         items.extend(synth_impls);
 203         items.extend(new_items_external);
 204         items.extend(new_items_local);
 205     } else {
 206         panic!("collect-trait-impls can't run");
 207     };
 208
 209     krate
 210 }
 211
 212 struct SyntheticImplCollector<'a, 'tcx> {
 213     cx: &'a mut DocContext<'tcx>,
 214     impls: Vec<Item>,
 215 }
 216
 217 impl<'a, 'tcx> DocVisitor for SyntheticImplCollector<'a, 'tcx> {
 218     fn visit_item(&mut self, i: &Item) {
 219         if i.is_struct() || i.is_enum() || i.is_union() {
 220             // FIXME(eddyb) is this `doc(hidden)` check needed?
 221             if !self.cx.tcx.is_doc_hidden(i.item_id.expect_def_id()) {
 222                 self.impls
 223                     .extend(get_auto_trait_and_blanket_impls(self.cx, i.item_id.expect_def_id()));
 224             }
 225         }
 226
 227         self.visit_item_recur(i)
 228     }
 229 }
 230
 231 #[derive(Default)]
 232 struct ItemCollector {
 233     items: FxHashSet<ItemId>,
 234 }
 235
 236 impl ItemCollector {
 237     fn new() -> Self {
 238         Self::default()
 239     }
 240 }
 241
 242 impl DocVisitor for ItemCollector {
 243     fn visit_item(&mut self, i: &Item) {
 244         self.items.insert(i.item_id);
 245
 246         self.visit_item_recur(i)
 247     }
 248 }
 249
 250 struct BadImplStripper<'a> {
 251     prims: FxHashSet<PrimitiveType>,
 252     items: FxHashSet<ItemId>,
 253     cache: &'a Cache,
 254 }
 255
 256 impl<'a> BadImplStripper<'a> {
 257     fn keep_impl(&self, ty: &Type, is_deref: bool) -> bool {
 258         if let Generic(_) = ty {
 259             // keep impls made on generics
 260             true
 261         } else if let Some(prim) = ty.primitive_type() {
 262             self.prims.contains(&prim)
 263         } else if let Some(did) = ty.def_id(self.cache) {
 264             is_deref || self.keep_impl_with_def_id(did.into())
 265         } else {
 266             false
 267         }
 268     }
 269
 270     fn keep_impl_with_def_id(&self, item_id: ItemId) -> bool {
 271         self.items.contains(&item_id)
 272     }
 273 }