src/librustdoc/passes/collect_intra_doc_links/early.rs

   1 use crate::clean;
   2 use crate::core::ResolverCaches;
   3 use crate::html::markdown::markdown_links;
   4 use crate::passes::collect_intra_doc_links::preprocess_link;
   5
   6 use rustc_ast::visit::{self, AssocCtxt, Visitor};
   7 use rustc_ast::{self as ast, ItemKind};
   8 use rustc_ast_lowering::ResolverAstLowering;
   9 use rustc_hir::def::Namespace::TypeNS;
  10 use rustc_hir::def::{DefKind, Res};
  11 use rustc_hir::def_id::{DefId, DefIdMap, DefIdSet, LocalDefId, CRATE_DEF_ID};
  12 use rustc_hir::TraitCandidate;
  13 use rustc_middle::ty::{DefIdTree, Visibility};
  14 use rustc_resolve::{ParentScope, Resolver};
  15 use rustc_session::config::Externs;
  16 use rustc_span::SyntaxContext;
  17
  18 use std::collections::hash_map::Entry;
  19 use std::mem;
  20
  21 crate fn early_resolve_intra_doc_links(
  22     resolver: &mut Resolver<'_>,
  23     krate: &ast::Crate,
  24     externs: Externs,
  25 ) -> ResolverCaches {
  26     let mut loader = IntraLinkCrateLoader {
  27         resolver,
  28         current_mod: CRATE_DEF_ID,
  29         visited_mods: Default::default(),
  30         traits_in_scope: Default::default(),
  31         all_traits: Default::default(),
  32         all_trait_impls: Default::default(),
  33     };
  34
  35     // Overridden `visit_item` below doesn't apply to the crate root,
  36     // so we have to visit its attributes and reexports separately.
  37     loader.load_links_in_attrs(&krate.attrs);
  38     loader.process_module_children_or_reexports(CRATE_DEF_ID.to_def_id());
  39     visit::walk_crate(&mut loader, krate);
  40     loader.add_foreign_traits_in_scope();
  41
  42     // FIXME: somehow rustdoc is still missing crates even though we loaded all
  43     // the known necessary crates. Load them all unconditionally until we find a way to fix this.
  44     // DO NOT REMOVE THIS without first testing on the reproducer in
  45     // https://github.com/jyn514/objr/commit/edcee7b8124abf0e4c63873e8422ff81beb11ebb
  46     for (extern_name, _) in externs.iter().filter(|(_, entry)| entry.add_prelude) {
  47         loader.resolver.resolve_rustdoc_path(extern_name, TypeNS, CRATE_DEF_ID.to_def_id());
  48     }
  49
  50     ResolverCaches {
  51         traits_in_scope: loader.traits_in_scope,
  52         all_traits: Some(loader.all_traits),
  53         all_trait_impls: Some(loader.all_trait_impls),
  54     }
  55 }
  56
  57 struct IntraLinkCrateLoader<'r, 'ra> {
  58     resolver: &'r mut Resolver<'ra>,
  59     current_mod: LocalDefId,
  60     visited_mods: DefIdSet,
  61     traits_in_scope: DefIdMap<Vec<TraitCandidate>>,
  62     all_traits: Vec<DefId>,
  63     all_trait_impls: Vec<DefId>,
  64 }
  65
  66 impl IntraLinkCrateLoader<'_, '_> {
  67     fn add_traits_in_scope(&mut self, def_id: DefId) {
  68         // Calls to `traits_in_scope` are expensive, so try to avoid them if only possible.
  69         // Keys in the `traits_in_scope` cache are always module IDs.
  70         if let Entry::Vacant(entry) = self.traits_in_scope.entry(def_id) {
  71             let module = self.resolver.get_nearest_non_block_module(def_id);
  72             let module_id = module.def_id();
  73             let entry = if module_id == def_id {
  74                 Some(entry)
  75             } else if let Entry::Vacant(entry) = self.traits_in_scope.entry(module_id) {
  76                 Some(entry)
  77             } else {
  78                 None
  79             };
  80             if let Some(entry) = entry {
  81                 entry.insert(self.resolver.traits_in_scope(
  82                     None,
  83                     &ParentScope::module(module, self.resolver),
  84                     SyntaxContext::root(),
  85                     None,
  86                 ));
  87             }
  88         }
  89     }
  90
  91     fn add_traits_in_parent_scope(&mut self, def_id: DefId) {
  92         if let Some(module_id) = self.resolver.parent(def_id) {
  93             self.add_traits_in_scope(module_id);
  94         }
  95     }
  96
  97     /// Add traits in scope for links in impls collected by the `collect-intra-doc-links` pass.
  98     /// That pass filters impls using type-based information, but we don't yet have such
  99     /// information here, so we just conservatively calculate traits in scope for *all* modules
 100     /// having impls in them.
 101     fn add_foreign_traits_in_scope(&mut self) {
 102         for cnum in Vec::from_iter(self.resolver.cstore().crates_untracked()) {
 103             let all_traits = Vec::from_iter(self.resolver.cstore().traits_in_crate_untracked(cnum));
 104             let all_trait_impls =
 105                 Vec::from_iter(self.resolver.cstore().trait_impls_in_crate_untracked(cnum));
 106             let all_inherent_impls =
 107                 Vec::from_iter(self.resolver.cstore().inherent_impls_in_crate_untracked(cnum));
 108             let all_incoherent_impls =
 109                 Vec::from_iter(self.resolver.cstore().incoherent_impls_in_crate_untracked(cnum));
 110
 111             // Querying traits in scope is expensive so we try to prune the impl and traits lists
 112             // using privacy, private traits and impls from other crates are never documented in
 113             // the current crate, and links in their doc comments are not resolved.
 114             for &def_id in &all_traits {
 115                 if self.resolver.cstore().visibility_untracked(def_id) == Visibility::Public {
 116                     self.add_traits_in_parent_scope(def_id);
 117                 }
 118             }
 119             for &(trait_def_id, impl_def_id, simplified_self_ty) in &all_trait_impls {
 120                 if self.resolver.cstore().visibility_untracked(trait_def_id) == Visibility::Public
 121                     && simplified_self_ty.and_then(|ty| ty.def()).map_or(true, |ty_def_id| {
 122                         self.resolver.cstore().visibility_untracked(ty_def_id) == Visibility::Public
 123                     })
 124                 {
 125                     self.add_traits_in_parent_scope(impl_def_id);
 126                 }
 127             }
 128             for (ty_def_id, impl_def_id) in all_inherent_impls {
 129                 if self.resolver.cstore().visibility_untracked(ty_def_id) == Visibility::Public {
 130                     self.add_traits_in_parent_scope(impl_def_id);
 131                 }
 132             }
 133             for def_id in all_incoherent_impls {
 134                 self.add_traits_in_parent_scope(def_id);
 135             }
 136
 137             self.all_traits.extend(all_traits);
 138             self.all_trait_impls.extend(all_trait_impls.into_iter().map(|(_, def_id, _)| def_id));
 139         }
 140     }
 141
 142     fn load_links_in_attrs(&mut self, attrs: &[ast::Attribute]) {
 143         // FIXME: this needs to consider reexport inlining.
 144         let attrs = clean::Attributes::from_ast(attrs, None);
 145         for (parent_module, doc) in attrs.collapsed_doc_value_by_module_level() {
 146             let module_id = parent_module.unwrap_or(self.current_mod.to_def_id());
 147
 148             self.add_traits_in_scope(module_id);
 149
 150             for link in markdown_links(&doc.as_str()) {
 151                 let path_str = if let Some(Ok(x)) = preprocess_link(&link) {
 152                     x.path_str
 153                 } else {
 154                     continue;
 155                 };
 156                 self.resolver.resolve_rustdoc_path(&path_str, TypeNS, module_id);
 157             }
 158         }
 159     }
 160
 161     /// When reexports are inlined, they are replaced with item which they refer to, those items
 162     /// may have links in their doc comments, those links are resolved at the item definition site,
 163     /// so we need to know traits in scope at that definition site.
 164     fn process_module_children_or_reexports(&mut self, module_id: DefId) {
 165         if !self.visited_mods.insert(module_id) {
 166             return; // avoid infinite recursion
 167         }
 168
 169         for child in self.resolver.module_children_or_reexports(module_id) {
 170             if child.vis == Visibility::Public {
 171                 if let Some(def_id) = child.res.opt_def_id() {
 172                     self.add_traits_in_parent_scope(def_id);
 173                 }
 174                 if let Res::Def(DefKind::Mod, module_id) = child.res {
 175                     self.process_module_children_or_reexports(module_id);
 176                 }
 177             }
 178         }
 179     }
 180 }
 181
 182 impl Visitor<'_> for IntraLinkCrateLoader<'_, '_> {
 183     fn visit_item(&mut self, item: &ast::Item) {
 184         if let ItemKind::Mod(..) = item.kind {
 185             let old_mod = mem::replace(&mut self.current_mod, self.resolver.local_def_id(item.id));
 186
 187             // A module written with a outline doc comments will resolve traits relative
 188             // to the parent module. Make sure the parent module's traits-in-scope are
 189             // loaded, even if the module itself has no doc comments.
 190             self.add_traits_in_parent_scope(self.current_mod.to_def_id());
 191
 192             self.load_links_in_attrs(&item.attrs);
 193             self.process_module_children_or_reexports(self.current_mod.to_def_id());
 194             visit::walk_item(self, item);
 195
 196             self.current_mod = old_mod;
 197         } else {
 198             match item.kind {
 199                 ItemKind::Trait(..) => {
 200                     self.all_traits.push(self.resolver.local_def_id(item.id).to_def_id());
 201                 }
 202                 ItemKind::Impl(box ast::Impl { of_trait: Some(..), .. }) => {
 203                     self.all_trait_impls.push(self.resolver.local_def_id(item.id).to_def_id());
 204                 }
 205                 _ => {}
 206             }
 207             self.load_links_in_attrs(&item.attrs);
 208             visit::walk_item(self, item);
 209         }
 210     }
 211
 212     fn visit_assoc_item(&mut self, item: &ast::AssocItem, ctxt: AssocCtxt) {
 213         self.load_links_in_attrs(&item.attrs);
 214         visit::walk_assoc_item(self, item, ctxt)
 215     }
 216
 217     fn visit_foreign_item(&mut self, item: &ast::ForeignItem) {
 218         self.load_links_in_attrs(&item.attrs);
 219         visit::walk_foreign_item(self, item)
 220     }
 221
 222     fn visit_variant(&mut self, v: &ast::Variant) {
 223         self.load_links_in_attrs(&v.attrs);
 224         visit::walk_variant(self, v)
 225     }
 226
 227     fn visit_field_def(&mut self, field: &ast::FieldDef) {
 228         self.load_links_in_attrs(&field.attrs);
 229         visit::walk_field_def(self, field)
 230     }
 231
 232     // NOTE: if doc-comments are ever allowed on other nodes (e.g. function parameters),
 233     // then this will have to implement other visitor methods too.
 234 }