Skip to content

Commit 1c158b6

Browse files
borsbors
committed
Auto merge of rust-lang#83833 - jyn514:no-resolver, r=GuillaumeGomez
rustdoc: Store intra-doc links in Cache instead of on items directly Items are first built after rustdoc creates the TyCtxt. To allow resolving the links before the TyCtxt is built, the links can't be stored on `clean::Item` directly. Helps with rust-lang#83761. Opening this early because I think it might decrease memory usage.
2 parents c53d2d4 + 9e11902 commit 1c158b6

File tree

4 files changed

+82
-82
lines changed

4 files changed

+82
-82
lines changed

‎src/librustdoc/clean/types.rs

+64-73
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,69 @@ impl Item {
195195
}
196196

197197
crate fn links(&self, cache: &Cache) -> Vec<RenderedLink> {
198-
self.attrs.links(self.def_id.krate, cache)
198+
use crate::html::format::href;
199+
use crate::html::render::CURRENT_DEPTH;
200+
201+
cache
202+
.intra_doc_links
203+
.get(&self.def_id)
204+
.map_or(&[][..], |v| v.as_slice())
205+
.iter()
206+
.filter_map(|ItemLink { link: s, link_text, did, fragment }| {
207+
match *did {
208+
Some(did) => {
209+
if let Some((mut href, ..)) = href(did, cache) {
210+
if let Some(ref fragment) = *fragment {
211+
href.push('#');
212+
href.push_str(fragment);
213+
}
214+
Some(RenderedLink {
215+
original_text: s.clone(),
216+
new_text: link_text.clone(),
217+
href,
218+
})
219+
} else {
220+
None
221+
}
222+
}
223+
None => {
224+
if let Some(ref fragment) = *fragment {
225+
let url = match cache.extern_locations.get(&self.def_id.krate) {
226+
Some(&(_, _, ExternalLocation::Local)) => {
227+
let depth = CURRENT_DEPTH.with(|l| l.get());
228+
"../".repeat(depth)
229+
}
230+
Some(&(_, _, ExternalLocation::Remote(ref s))) => s.to_string(),
231+
Some(&(_, _, ExternalLocation::Unknown)) | None => String::from(
232+
// NOTE: intentionally doesn't pass crate name to avoid having
233+
// different primitive links between crates
234+
if UnstableFeatures::from_environment(None).is_nightly_build() {
235+
"https://doc.rust-lang.org/nightly"
236+
} else {
237+
"https://doc.rust-lang.org"
238+
},
239+
),
240+
};
241+
// This is a primitive so the url is done "by hand".
242+
let tail = fragment.find('#').unwrap_or_else(|| fragment.len());
243+
Some(RenderedLink {
244+
original_text: s.clone(),
245+
new_text: link_text.clone(),
246+
href: format!(
247+
"{}{}std/primitive.{}.html{}",
248+
url,
249+
if !url.ends_with('/') { "/" } else { "" },
250+
&fragment[..tail],
251+
&fragment[tail..]
252+
),
253+
})
254+
} else {
255+
panic!("This isn't a primitive?!");
256+
}
257+
}
258+
}
259+
})
260+
.collect()
199261
}
200262

201263
crate fn is_crate(&self) -> bool {
@@ -572,15 +634,13 @@ crate struct Attributes {
572634
crate other_attrs: Vec<ast::Attribute>,
573635
crate cfg: Option<Arc<Cfg>>,
574636
crate span: Option<rustc_span::Span>,
575-
/// map from Rust paths to resolved defs and potential URL fragments
576-
crate links: Vec<ItemLink>,
577637
crate inner_docs: bool,
578638
}
579639

580640
#[derive(Clone, Debug, Default, PartialEq, Eq, Hash)]
581641
/// A link that has not yet been rendered.
582642
///
583-
/// This link will be turned into a rendered link by [`Attributes::links`]
643+
/// This link will be turned into a rendered link by [`Item::links`].
584644
crate struct ItemLink {
585645
/// The original link written in the markdown
586646
pub(crate) link: String,
@@ -806,7 +866,6 @@ impl Attributes {
806866
other_attrs,
807867
cfg: if cfg == Cfg::True { None } else { Some(Arc::new(cfg)) },
808868
span: sp,
809-
links: vec![],
810869
inner_docs,
811870
}
812871
}
@@ -850,72 +909,6 @@ impl Attributes {
850909
if self.doc_strings.is_empty() { None } else { Some(self.doc_strings.iter().collect()) }
851910
}
852911

853-
/// Gets links as a vector
854-
///
855-
/// Cache must be populated before call
856-
crate fn links(&self, krate: CrateNum, cache: &Cache) -> Vec<RenderedLink> {
857-
use crate::html::format::href;
858-
use crate::html::render::CURRENT_DEPTH;
859-
860-
self.links
861-
.iter()
862-
.filter_map(|ItemLink { link: s, link_text, did, fragment }| {
863-
match *did {
864-
Some(did) => {
865-
if let Some((mut href, ..)) = href(did, cache) {
866-
if let Some(ref fragment) = *fragment {
867-
href.push('#');
868-
href.push_str(fragment);
869-
}
870-
Some(RenderedLink {
871-
original_text: s.clone(),
872-
new_text: link_text.clone(),
873-
href,
874-
})
875-
} else {
876-
None
877-
}
878-
}
879-
None => {
880-
if let Some(ref fragment) = *fragment {
881-
let url = match cache.extern_locations.get(&krate) {
882-
Some(&(_, _, ExternalLocation::Local)) => {
883-
let depth = CURRENT_DEPTH.with(|l| l.get());
884-
"../".repeat(depth)
885-
}
886-
Some(&(_, _, ExternalLocation::Remote(ref s))) => s.to_string(),
887-
Some(&(_, _, ExternalLocation::Unknown)) | None => String::from(
888-
// NOTE: intentionally doesn't pass crate name to avoid having
889-
// different primitive links between crates
890-
if UnstableFeatures::from_environment(None).is_nightly_build() {
891-
"https://doc.rust-lang.org/nightly"
892-
} else {
893-
"https://doc.rust-lang.org"
894-
},
895-
),
896-
};
897-
// This is a primitive so the url is done "by hand".
898-
let tail = fragment.find('#').unwrap_or_else(|| fragment.len());
899-
Some(RenderedLink {
900-
original_text: s.clone(),
901-
new_text: link_text.clone(),
902-
href: format!(
903-
"{}{}std/primitive.{}.html{}",
904-
url,
905-
if !url.ends_with('/') { "/" } else { "" },
906-
&fragment[..tail],
907-
&fragment[tail..]
908-
),
909-
})
910-
} else {
911-
panic!("This isn't a primitive?!");
912-
}
913-
}
914-
}
915-
})
916-
.collect()
917-
}
918-
919912
crate fn get_doc_aliases(&self) -> Box<[String]> {
920913
let mut aliases = FxHashSet::default();
921914

@@ -942,7 +935,6 @@ impl PartialEq for Attributes {
942935
self.doc_strings == rhs.doc_strings
943936
&& self.cfg == rhs.cfg
944937
&& self.span == rhs.span
945-
&& self.links == rhs.links
946938
&& self
947939
.other_attrs
948940
.iter()
@@ -958,7 +950,6 @@ impl Hash for Attributes {
958950
self.doc_strings.hash(hasher);
959951
self.cfg.hash(hasher);
960952
self.span.hash(hasher);
961-
self.links.hash(hasher);
962953
for attr in &self.other_attrs {
963954
attr.id.hash(hasher);
964955
}

‎src/librustdoc/formats/cache.rs

+5
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,11 @@ crate struct Cache {
120120
// when gathering trait documentation on a type, hold impls here while
121121
// folding and add them to the cache later on if we find the trait.
122122
orphan_trait_impls: Vec<(DefId, FxHashSet<DefId>, Impl)>,
123+
124+
/// All intra-doc links resolved so far.
125+
///
126+
/// Links are indexed by the DefId of the item they document.
127+
crate intra_doc_links: BTreeMap<DefId, Vec<clean::ItemLink>>,
123128
}
124129

125130
/// This struct is used to wrap the `cache` and `tcx` in order to run `DocFolder`.

‎src/librustdoc/json/conversions.rs

+11-7
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,16 @@ use std::collections::HashSet;
2424
impl JsonRenderer<'_> {
2525
pub(super) fn convert_item(&self, item: clean::Item) -> Option<Item> {
2626
let deprecation = item.deprecation(self.tcx);
27+
let links = self
28+
.cache
29+
.intra_doc_links
30+
.get(&item.def_id)
31+
.into_iter()
32+
.flatten()
33+
.filter_map(|clean::ItemLink { link, did, .. }| {
34+
did.map(|did| (link.clone(), from_def_id(did)))
35+
})
36+
.collect();
2737
let clean::Item { span, name, attrs, kind, visibility, def_id } = item;
2838
let inner = match *kind {
2939
clean::StrippedItem(_) => return None,
@@ -36,20 +46,14 @@ impl JsonRenderer<'_> {
3646
span: self.convert_span(span),
3747
visibility: self.convert_visibility(visibility),
3848
docs: attrs.collapsed_doc_value(),
39-
links: attrs
40-
.links
41-
.into_iter()
42-
.filter_map(|clean::ItemLink { link, did, .. }| {
43-
did.map(|did| (link, from_def_id(did)))
44-
})
45-
.collect(),
4649
attrs: attrs
4750
.other_attrs
4851
.iter()
4952
.map(rustc_ast_pretty::pprust::attribute_to_string)
5053
.collect(),
5154
deprecation: deprecation.map(from_deprecation),
5255
inner,
56+
links,
5357
})
5458
}
5559

‎src/librustdoc/passes/collect_intra_doc_links.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -788,7 +788,7 @@ fn is_derive_trait_collision<T>(ns: &PerNS<Result<(Res, T), ResolutionFailure<'_
788788
}
789789

790790
impl<'a, 'tcx> DocFolder for LinkCollector<'a, 'tcx> {
791-
fn fold_item(&mut self, mut item: Item) -> Option<Item> {
791+
fn fold_item(&mut self, item: Item) -> Option<Item> {
792792
use rustc_middle::ty::DefIdTree;
793793

794794
let parent_node = if item.is_fake() {
@@ -873,7 +873,7 @@ impl<'a, 'tcx> DocFolder for LinkCollector<'a, 'tcx> {
873873
for md_link in markdown_links(&doc) {
874874
let link = self.resolve_link(&item, &doc, &self_name, parent_node, krate, md_link);
875875
if let Some(link) = link {
876-
item.attrs.links.push(link);
876+
self.cx.cache.intra_doc_links.entry(item.def_id).or_default().push(link);
877877
}
878878
}
879879
}

0 commit comments

Comments
 (0)