2 use crate::core::ResolverCaches;
3 use crate::html::markdown::markdown_links;
4 use crate::passes::collect_intra_doc_links::preprocess_link;
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;
18 use std::collections::hash_map::Entry;
21 crate fn early_resolve_intra_doc_links(
22 resolver: &mut Resolver<'_>,
26 let mut loader = IntraLinkCrateLoader {
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(),
35 // Because of the `crate::` prefix, any doc comment can reference
36 // the crate root's set of in-scope traits. This line makes sure
38 loader.add_traits_in_scope(CRATE_DEF_ID.to_def_id());
40 // Overridden `visit_item` below doesn't apply to the crate root,
41 // so we have to visit its attributes and reexports separately.
42 loader.load_links_in_attrs(&krate.attrs);
43 loader.process_module_children_or_reexports(CRATE_DEF_ID.to_def_id());
44 visit::walk_crate(&mut loader, krate);
45 loader.add_foreign_traits_in_scope();
47 // FIXME: somehow rustdoc is still missing crates even though we loaded all
48 // the known necessary crates. Load them all unconditionally until we find a way to fix this.
49 // DO NOT REMOVE THIS without first testing on the reproducer in
50 // https://github.com/jyn514/objr/commit/edcee7b8124abf0e4c63873e8422ff81beb11ebb
51 for (extern_name, _) in externs.iter().filter(|(_, entry)| entry.add_prelude) {
52 loader.resolver.resolve_rustdoc_path(extern_name, TypeNS, CRATE_DEF_ID.to_def_id());
56 traits_in_scope: loader.traits_in_scope,
57 all_traits: Some(loader.all_traits),
58 all_trait_impls: Some(loader.all_trait_impls),
62 struct IntraLinkCrateLoader<'r, 'ra> {
63 resolver: &'r mut Resolver<'ra>,
64 current_mod: LocalDefId,
65 visited_mods: DefIdSet,
66 traits_in_scope: DefIdMap<Vec<TraitCandidate>>,
67 all_traits: Vec<DefId>,
68 all_trait_impls: Vec<DefId>,
71 impl IntraLinkCrateLoader<'_, '_> {
72 fn add_traits_in_scope(&mut self, def_id: DefId) {
73 // Calls to `traits_in_scope` are expensive, so try to avoid them if only possible.
74 // Keys in the `traits_in_scope` cache are always module IDs.
75 if let Entry::Vacant(entry) = self.traits_in_scope.entry(def_id) {
76 let module = self.resolver.get_nearest_non_block_module(def_id);
77 let module_id = module.def_id();
78 let entry = if module_id == def_id {
80 } else if let Entry::Vacant(entry) = self.traits_in_scope.entry(module_id) {
85 if let Some(entry) = entry {
86 entry.insert(self.resolver.traits_in_scope(
88 &ParentScope::module(module, self.resolver),
89 SyntaxContext::root(),
96 fn add_traits_in_parent_scope(&mut self, def_id: DefId) {
97 if let Some(module_id) = self.resolver.parent(def_id) {
98 self.add_traits_in_scope(module_id);
102 /// Add traits in scope for links in impls collected by the `collect-intra-doc-links` pass.
103 /// That pass filters impls using type-based information, but we don't yet have such
104 /// information here, so we just conservatively calculate traits in scope for *all* modules
105 /// having impls in them.
106 fn add_foreign_traits_in_scope(&mut self) {
107 for cnum in Vec::from_iter(self.resolver.cstore().crates_untracked()) {
108 // FIXME: Due to #78696 rustdoc can query traits in scope for any crate root.
109 self.add_traits_in_scope(cnum.as_def_id());
111 let all_traits = Vec::from_iter(self.resolver.cstore().traits_in_crate_untracked(cnum));
112 let all_trait_impls =
113 Vec::from_iter(self.resolver.cstore().trait_impls_in_crate_untracked(cnum));
114 let all_inherent_impls =
115 Vec::from_iter(self.resolver.cstore().inherent_impls_in_crate_untracked(cnum));
116 let all_incoherent_impls =
117 Vec::from_iter(self.resolver.cstore().incoherent_impls_in_crate_untracked(cnum));
119 // Querying traits in scope is expensive so we try to prune the impl and traits lists
120 // using privacy, private traits and impls from other crates are never documented in
121 // the current crate, and links in their doc comments are not resolved.
122 for &def_id in &all_traits {
123 if self.resolver.cstore().visibility_untracked(def_id) == Visibility::Public {
124 self.add_traits_in_parent_scope(def_id);
127 for &(trait_def_id, impl_def_id, simplified_self_ty) in &all_trait_impls {
128 if self.resolver.cstore().visibility_untracked(trait_def_id) == Visibility::Public
129 && simplified_self_ty.and_then(|ty| ty.def()).map_or(true, |ty_def_id| {
130 self.resolver.cstore().visibility_untracked(ty_def_id) == Visibility::Public
133 self.add_traits_in_parent_scope(impl_def_id);
136 for (ty_def_id, impl_def_id) in all_inherent_impls {
137 if self.resolver.cstore().visibility_untracked(ty_def_id) == Visibility::Public {
138 self.add_traits_in_parent_scope(impl_def_id);
141 for def_id in all_incoherent_impls {
142 self.add_traits_in_parent_scope(def_id);
145 self.all_traits.extend(all_traits);
146 self.all_trait_impls.extend(all_trait_impls.into_iter().map(|(_, def_id, _)| def_id));
150 fn load_links_in_attrs(&mut self, attrs: &[ast::Attribute]) {
151 // FIXME: this needs to consider reexport inlining.
152 let attrs = clean::Attributes::from_ast(attrs, None);
153 for (parent_module, doc) in attrs.collapsed_doc_value_by_module_level() {
154 let module_id = parent_module.unwrap_or(self.current_mod.to_def_id());
156 self.add_traits_in_scope(module_id);
158 for link in markdown_links(&doc.as_str()) {
159 let path_str = if let Some(Ok(x)) = preprocess_link(&link) {
164 self.resolver.resolve_rustdoc_path(&path_str, TypeNS, module_id);
169 /// When reexports are inlined, they are replaced with item which they refer to, those items
170 /// may have links in their doc comments, those links are resolved at the item definition site,
171 /// so we need to know traits in scope at that definition site.
172 fn process_module_children_or_reexports(&mut self, module_id: DefId) {
173 if !self.visited_mods.insert(module_id) {
174 return; // avoid infinite recursion
177 for child in self.resolver.module_children_or_reexports(module_id) {
178 if child.vis == Visibility::Public {
179 if let Some(def_id) = child.res.opt_def_id() {
180 self.add_traits_in_parent_scope(def_id);
182 if let Res::Def(DefKind::Mod, module_id) = child.res {
183 self.process_module_children_or_reexports(module_id);
190 impl Visitor<'_> for IntraLinkCrateLoader<'_, '_> {
191 fn visit_item(&mut self, item: &ast::Item) {
192 if let ItemKind::Mod(..) = item.kind {
193 let old_mod = mem::replace(&mut self.current_mod, self.resolver.local_def_id(item.id));
195 // A module written with a outline doc comments will resolve traits relative
196 // to the parent module. Make sure the parent module's traits-in-scope are
197 // loaded, even if the module itself has no doc comments.
198 self.add_traits_in_parent_scope(self.current_mod.to_def_id());
200 self.load_links_in_attrs(&item.attrs);
201 self.process_module_children_or_reexports(self.current_mod.to_def_id());
202 visit::walk_item(self, item);
204 self.current_mod = old_mod;
207 ItemKind::Trait(..) => {
208 self.all_traits.push(self.resolver.local_def_id(item.id).to_def_id());
210 ItemKind::Impl(box ast::Impl { of_trait: Some(..), .. }) => {
211 self.all_trait_impls.push(self.resolver.local_def_id(item.id).to_def_id());
215 self.load_links_in_attrs(&item.attrs);
216 visit::walk_item(self, item);
220 fn visit_assoc_item(&mut self, item: &ast::AssocItem, ctxt: AssocCtxt) {
221 self.load_links_in_attrs(&item.attrs);
222 visit::walk_assoc_item(self, item, ctxt)
225 fn visit_foreign_item(&mut self, item: &ast::ForeignItem) {
226 self.load_links_in_attrs(&item.attrs);
227 visit::walk_foreign_item(self, item)
230 fn visit_variant(&mut self, v: &ast::Variant) {
231 self.load_links_in_attrs(&v.attrs);
232 visit::walk_variant(self, v)
235 fn visit_field_def(&mut self, field: &ast::FieldDef) {
236 self.load_links_in_attrs(&field.attrs);
237 visit::walk_field_def(self, field)
240 // NOTE: if doc-comments are ever allowed on other nodes (e.g. function parameters),
241 // then this will have to implement other visitor methods too.