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 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 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) => matches!(ty.kind(), ty::Param(..)),
 105                         ty::Ref(_region, ty, _mutbl) => matches!(ty.kind(), ty::Param(..)),
 106                         ty::RawPtr(ty::TypeAndMut { ty, .. }) => matches!(ty.kind(), ty::Param(..)),
 107                         ty::Tuple(tys) => tys.iter().all(|ty| matches!(ty.kind(), ty::Param(..))),
 108                         _ => true,
 109                     }
 110                 }) {
 111                     let impls = get_auto_trait_and_blanket_impls(cx, def_id);
 112                     new_items_external.extend(impls.filter(|i| cx.inlined.insert(i.item_id)));
 113                 }
 114             }
 115         }
 116     });
 117
 118     let mut cleaner = BadImplStripper { prims, items: crate_items, cache: &cx.cache };
 119     let mut type_did_to_deref_target: FxHashMap<DefId, &Type> = FxHashMap::default();
 120
 121     // Follow all `Deref` targets of included items and recursively add them as valid
 122     fn add_deref_target(
 123         cx: &DocContext<'_>,
 124         map: &FxHashMap<DefId, &Type>,
 125         cleaner: &mut BadImplStripper<'_>,
 126         targets: &mut FxHashSet<DefId>,
 127         type_did: DefId,
 128     ) {
 129         if let Some(target) = map.get(&type_did) {
 130             debug!("add_deref_target: type {:?}, target {:?}", type_did, target);
 131             if let Some(target_prim) = target.primitive_type() {
 132                 cleaner.prims.insert(target_prim);
 133             } else if let Some(target_did) = target.def_id(&cx.cache) {
 134                 // `impl Deref<Target = S> for S`
 135                 if !targets.insert(target_did) {
 136                     // Avoid infinite cycles
 137                     return;
 138                 }
 139                 cleaner.items.insert(target_did.into());
 140                 add_deref_target(cx, map, cleaner, targets, target_did);
 141             }
 142         }
 143     }
 144
 145     // scan through included items ahead of time to splice in Deref targets to the "valid" sets
 146     for it in new_items_external.iter().chain(new_items_local.iter()) {
 147         if let ImplItem(Impl { ref for_, ref trait_, ref items, .. }) = *it.kind {
 148             if trait_.as_ref().map(|t| t.def_id()) == cx.tcx.lang_items().deref_trait()
 149                 && cleaner.keep_impl(for_, true)
 150             {
 151                 let target = items
 152                     .iter()
 153                     .find_map(|item| match *item.kind {
 154                         AssocTypeItem(ref t, _) => Some(&t.type_),
 155                         _ => None,
 156                     })
 157                     .expect("Deref impl without Target type");
 158
 159                 if let Some(prim) = target.primitive_type() {
 160                     cleaner.prims.insert(prim);
 161                 } else if let Some(did) = target.def_id(&cx.cache) {
 162                     cleaner.items.insert(did.into());
 163                 }
 164                 if let Some(for_did) = for_.def_id(&cx.cache) {
 165                     if type_did_to_deref_target.insert(for_did, target).is_none() {
 166                         // Since only the `DefId` portion of the `Type` instances is known to be same for both the
 167                         // `Deref` target type and the impl for type positions, this map of types is keyed by
 168                         // `DefId` and for convenience uses a special cleaner that accepts `DefId`s directly.
 169                         if cleaner.keep_impl_with_def_id(for_did.into()) {
 170                             let mut targets = FxHashSet::default();
 171                             targets.insert(for_did);
 172                             add_deref_target(
 173                                 cx,
 174                                 &type_did_to_deref_target,
 175                                 &mut cleaner,
 176                                 &mut targets,
 177                                 for_did,
 178                             );
 179                         }
 180                     }
 181                 }
 182             }
 183         }
 184     }
 185
 186     // Filter out external items that are not needed
 187     new_items_external.retain(|it| {
 188         if let ImplItem(Impl { ref for_, ref trait_, ref kind, .. }) = *it.kind {
 189             cleaner.keep_impl(
 190                 for_,
 191                 trait_.as_ref().map(|t| t.def_id()) == cx.tcx.lang_items().deref_trait(),
 192             ) || trait_.as_ref().map_or(false, |t| cleaner.keep_impl_with_def_id(t.def_id().into()))
 193                 || kind.is_blanket()
 194         } else {
 195             true
 196         }
 197     });
 198
 199     if let ModuleItem(Module { items, .. }) = &mut *krate.module.kind {
 200         items.extend(synth_impls);
 201         items.extend(new_items_external);
 202         items.extend(new_items_local);
 203     } else {
 204         panic!("collect-trait-impls can't run");
 205     };
 206
 207     krate
 208 }
 209
 210 struct SyntheticImplCollector<'a, 'tcx> {
 211     cx: &'a mut DocContext<'tcx>,
 212     impls: Vec<Item>,
 213 }
 214
 215 impl<'a, 'tcx> DocVisitor for SyntheticImplCollector<'a, 'tcx> {
 216     fn visit_item(&mut self, i: &Item) {
 217         if i.is_struct() || i.is_enum() || i.is_union() {
 218             // FIXME(eddyb) is this `doc(hidden)` check needed?
 219             if !self.cx.tcx.is_doc_hidden(i.item_id.expect_def_id()) {
 220                 self.impls
 221                     .extend(get_auto_trait_and_blanket_impls(self.cx, i.item_id.expect_def_id()));
 222             }
 223         }
 224
 225         self.visit_item_recur(i)
 226     }
 227 }
 228
 229 #[derive(Default)]
 230 struct ItemCollector {
 231     items: FxHashSet<ItemId>,
 232 }
 233
 234 impl ItemCollector {
 235     fn new() -> Self {
 236         Self::default()
 237     }
 238 }
 239
 240 impl DocVisitor for ItemCollector {
 241     fn visit_item(&mut self, i: &Item) {
 242         self.items.insert(i.item_id);
 243
 244         self.visit_item_recur(i)
 245     }
 246 }
 247
 248 struct BadImplStripper<'a> {
 249     prims: FxHashSet<PrimitiveType>,
 250     items: FxHashSet<ItemId>,
 251     cache: &'a Cache,
 252 }
 253
 254 impl<'a> BadImplStripper<'a> {
 255     fn keep_impl(&self, ty: &Type, is_deref: bool) -> bool {
 256         if let Generic(_) = ty {
 257             // keep impls made on generics
 258             true
 259         } else if let Some(prim) = ty.primitive_type() {
 260             self.prims.contains(&prim)
 261         } else if let Some(did) = ty.def_id(self.cache) {
 262             is_deref || self.keep_impl_with_def_id(did.into())
 263         } else {
 264             false
 265         }
 266     }
 267
 268     fn keep_impl_with_def_id(&self, item_id: ItemId) -> bool {
 269         self.items.contains(&item_id)
 270     }
 271 }