From 9fd5a679846a738d1117590a319fb12651711da4 Mon Sep 17 00:00:00 2001
From: Guillaume Gomez Crate {}
");
+ if end_newline {
+ clause.push_str(" where");
+ } else {
+ clause.push_str(" where");
+ }
}
+ for (i, pred) in gens.where_predicates.iter().enumerate() {
+ if f.alternate() {
+ clause.push(' ');
+ } else {
+ clause.push_str("
");
+ }
- match pred {
- clean::WherePredicate::BoundPredicate { ty, bounds } => {
- let bounds = bounds;
- if f.alternate() {
- clause.push_str(&format!(
- "{:#}: {:#}",
- ty.print(),
- print_generic_bounds(bounds)
- ));
- } else {
+ match pred {
+ clean::WherePredicate::BoundPredicate { ty, bounds } => {
+ let bounds = bounds;
+ if f.alternate() {
+ clause.push_str(&format!(
+ "{:#}: {:#}",
+ ty.print(cache),
+ print_generic_bounds(bounds, cache)
+ ));
+ } else {
+ clause.push_str(&format!(
+ "{}: {}",
+ ty.print(cache),
+ print_generic_bounds(bounds, cache)
+ ));
+ }
+ }
+ clean::WherePredicate::RegionPredicate { lifetime, bounds } => {
clause.push_str(&format!(
"{}: {}",
- ty.print(),
- print_generic_bounds(bounds)
+ lifetime.print(),
+ bounds
+ .iter()
+ .map(|b| b.print(cache).to_string())
+ .collect::
tags and breaking spaces still renders properly
- if f.alternate() {
- clause.push(' ');
- } else {
- clause.push_str(" ");
+ if end_newline {
+ // add a space so stripping
tags and breaking spaces still renders properly
+ if f.alternate() {
+ clause.push(' ');
+ } else {
+ clause.push_str(" ");
+ }
}
- }
- if !f.alternate() {
- clause.push_str("
", &format!("
{}", padding));
- clause.insert_str(0, &" ".repeat(indent.saturating_sub(1)));
- if !end_newline {
- clause.insert_str(0, "
");
+ if !f.alternate() {
+ clause.push_str("");
+ let padding = " ".repeat(indent + 4);
+ clause = clause.replace("
", &format!("
{}", padding));
+ clause.insert_str(0, &" ".repeat(indent.saturating_sub(1)));
+ if !end_newline {
+ clause.insert_str(0, "
");
+ }
}
- }
- write!(f, "{}", clause)
+ write!(f, "{}", clause)
+ })
}
}
@@ -327,34 +340,34 @@ impl clean::Constant {
}
impl clean::PolyTrait {
- fn print(&self) -> impl fmt::Display + '_ {
+ fn print<'a>(&'a self, cache: &'a Cache) -> impl fmt::Display + 'a {
display_fn(move |f| {
if !self.generic_params.is_empty() {
if f.alternate() {
write!(
f,
"for<{:#}> ",
- comma_sep(self.generic_params.iter().map(|g| g.print()))
+ comma_sep(self.generic_params.iter().map(|g| g.print(cache)))
)?;
} else {
write!(
f,
"for<{}> ",
- comma_sep(self.generic_params.iter().map(|g| g.print()))
+ comma_sep(self.generic_params.iter().map(|g| g.print(cache)))
)?;
}
}
if f.alternate() {
- write!(f, "{:#}", self.trait_.print())
+ write!(f, "{:#}", self.trait_.print(cache))
} else {
- write!(f, "{}", self.trait_.print())
+ write!(f, "{}", self.trait_.print(cache))
}
})
}
}
impl clean::GenericBound {
- crate fn print(&self) -> impl fmt::Display + '_ {
+ crate fn print<'a>(&'a self, cache: &'a Cache) -> impl fmt::Display + 'a {
display_fn(move |f| match self {
clean::GenericBound::Outlives(lt) => write!(f, "{}", lt.print()),
clean::GenericBound::TraitBound(ty, modifier) => {
@@ -364,9 +377,9 @@ impl clean::GenericBound {
hir::TraitBoundModifier::MaybeConst => "?const",
};
if f.alternate() {
- write!(f, "{}{:#}", modifier_str, ty.print())
+ write!(f, "{}{:#}", modifier_str, ty.print(cache))
} else {
- write!(f, "{}{}", modifier_str, ty.print())
+ write!(f, "{}{}", modifier_str, ty.print(cache))
}
}
})
@@ -374,7 +387,7 @@ impl clean::GenericBound {
}
impl clean::GenericArgs {
- fn print(&self) -> impl fmt::Display + '_ {
+ fn print<'a>(&'a self, cache: &'a Cache) -> impl fmt::Display + 'a {
display_fn(move |f| {
match self {
clean::GenericArgs::AngleBracketed { args, bindings } => {
@@ -391,9 +404,9 @@ impl clean::GenericArgs {
}
comma = true;
if f.alternate() {
- write!(f, "{:#}", arg.print())?;
+ write!(f, "{:#}", arg.print(cache))?;
} else {
- write!(f, "{}", arg.print())?;
+ write!(f, "{}", arg.print(cache))?;
}
}
for binding in bindings {
@@ -402,9 +415,9 @@ impl clean::GenericArgs {
}
comma = true;
if f.alternate() {
- write!(f, "{:#}", binding.print())?;
+ write!(f, "{:#}", binding.print(cache))?;
} else {
- write!(f, "{}", binding.print())?;
+ write!(f, "{}", binding.print(cache))?;
}
}
if f.alternate() {
@@ -423,17 +436,17 @@ impl clean::GenericArgs {
}
comma = true;
if f.alternate() {
- write!(f, "{:#}", ty.print())?;
+ write!(f, "{:#}", ty.print(cache))?;
} else {
- write!(f, "{}", ty.print())?;
+ write!(f, "{}", ty.print(cache))?;
}
}
f.write_str(")")?;
if let Some(ref ty) = *output {
if f.alternate() {
- write!(f, " -> {:#}", ty.print())?;
+ write!(f, " -> {:#}", ty.print(cache))?;
} else {
- write!(f, " -> {}", ty.print())?;
+ write!(f, " -> {}", ty.print(cache))?;
}
}
}
@@ -444,19 +457,19 @@ impl clean::GenericArgs {
}
impl clean::PathSegment {
- crate fn print(&self) -> impl fmt::Display + '_ {
+ crate fn print<'a>(&'a self, cache: &'a Cache) -> impl fmt::Display + 'a {
display_fn(move |f| {
if f.alternate() {
- write!(f, "{}{:#}", self.name, self.args.print())
+ write!(f, "{}{:#}", self.name, self.args.print(cache))
} else {
- write!(f, "{}{}", self.name, self.args.print())
+ write!(f, "{}{}", self.name, self.args.print(cache))
}
})
}
}
impl clean::Path {
- crate fn print(&self) -> impl fmt::Display + '_ {
+ crate fn print<'a>(&'a self, cache: &'a Cache) -> impl fmt::Display + 'a {
display_fn(move |f| {
if self.global {
f.write_str("::")?
@@ -467,9 +480,9 @@ impl clean::Path {
f.write_str("::")?
}
if f.alternate() {
- write!(f, "{:#}", seg.print())?;
+ write!(f, "{:#}", seg.print(cache))?;
} else {
- write!(f, "{}", seg.print())?;
+ write!(f, "{}", seg.print(cache))?;
}
}
Ok(())
@@ -477,8 +490,7 @@ impl clean::Path {
}
}
-crate fn href(did: DefId) -> Option<(String, ItemType, Vec");
@@ -1738,7 +1736,7 @@ fn print_item(cx: &Context<'_>, item: &clean::Item, buf: &mut Buffer, cache: &Ca
// this page, and this link will be auto-clicked. The `id` attribute is
// used to find the link to auto-click.
if cx.shared.include_sources && !item.is_primitive() {
- write_srclink(cx, item, buf, cache);
+ write_srclink(cx, item, buf);
}
write!(buf, ""); // out-of-band
@@ -1797,20 +1795,20 @@ fn print_item(cx: &Context<'_>, item: &clean::Item, buf: &mut Buffer, cache: &Ca
clean::FunctionItem(ref f) | clean::ForeignFunctionItem(ref f) => {
item_function(buf, cx, item, f)
}
- clean::TraitItem(ref t) => item_trait(buf, cx, item, t, cache),
- clean::StructItem(ref s) => item_struct(buf, cx, item, s, cache),
- clean::UnionItem(ref s) => item_union(buf, cx, item, s, cache),
- clean::EnumItem(ref e) => item_enum(buf, cx, item, e, cache),
- clean::TypedefItem(ref t, _) => item_typedef(buf, cx, item, t, cache),
+ clean::TraitItem(ref t) => item_trait(buf, cx, item, t),
+ clean::StructItem(ref s) => item_struct(buf, cx, item, s),
+ clean::UnionItem(ref s) => item_union(buf, cx, item, s),
+ clean::EnumItem(ref e) => item_enum(buf, cx, item, e),
+ clean::TypedefItem(ref t, _) => item_typedef(buf, cx, item, t),
clean::MacroItem(ref m) => item_macro(buf, cx, item, m),
clean::ProcMacroItem(ref m) => item_proc_macro(buf, cx, item, m),
- clean::PrimitiveItem(_) => item_primitive(buf, cx, item, cache),
+ clean::PrimitiveItem(_) => item_primitive(buf, cx, item),
clean::StaticItem(ref i) | clean::ForeignStaticItem(ref i) => item_static(buf, cx, item, i),
clean::ConstantItem(ref c) => item_constant(buf, cx, item, c),
- clean::ForeignTypeItem => item_foreign_type(buf, cx, item, cache),
+ clean::ForeignTypeItem => item_foreign_type(buf, cx, item),
clean::KeywordItem(_) => item_keyword(buf, cx, item),
- clean::OpaqueTyItem(ref e) => item_opaque_ty(buf, cx, item, e, cache),
- clean::TraitAliasItem(ref ta) => item_trait_alias(buf, cx, item, ta, cache),
+ clean::OpaqueTyItem(ref e) => item_opaque_ty(buf, cx, item, e),
+ clean::TraitAliasItem(ref ta) => item_trait_alias(buf, cx, item, ta),
_ => {
// We don't generate pages for any other type.
unreachable!();
@@ -1884,10 +1882,11 @@ fn document_short(
return;
}
if let Some(s) = item.doc_value() {
- let mut summary_html = MarkdownSummaryLine(&s, &item.links()).into_string();
+ let mut summary_html = MarkdownSummaryLine(&s, &item.links(&cx.cache)).into_string();
if s.contains('\n') {
- let link = format!(r#" Read more"#, naive_assoc_href(item, link));
+ let link =
+ format!(r#" Read more"#, naive_assoc_href(item, link, cx.cache()));
if let Some(idx) = summary_html.rfind("
{}extern crate {} as {};",
- myitem.visibility.print_with_space(cx.tcx(), myitem.def_id),
- anchor(myitem.def_id, &*src.as_str()),
+ myitem.visibility.print_with_space(cx.tcx(), myitem.def_id, cx.cache()),
+ anchor(myitem.def_id, &*src.as_str(), cx.cache()),
name
),
None => write!(
w,
"{}extern crate {};",
- myitem.visibility.print_with_space(cx.tcx(), myitem.def_id),
- anchor(myitem.def_id, &*name.as_str())
+ myitem.visibility.print_with_space(cx.tcx(), myitem.def_id, cx.cache()),
+ anchor(myitem.def_id, &*name.as_str(), cx.cache())
),
}
write!(w, " ");
@@ -2179,8 +2178,8 @@ fn item_module(w: &mut Buffer, cx: &Context<'_>, item: &clean::Item, items: &[cl
write!(
w,
"{}{} ",
- myitem.visibility.print_with_space(cx.tcx(), myitem.def_id),
- import.print()
+ myitem.visibility.print_with_space(cx.tcx(), myitem.def_id, cx.cache()),
+ import.print(cx.cache())
);
}
@@ -2211,7 +2210,7 @@ fn item_module(w: &mut Buffer, cx: &Context<'_>, item: &clean::Item, items: &[cl
");
@@ -2456,17 +2455,18 @@ fn item_function(w: &mut Buffer, cx: &Context<'_>, it: &clean::Item, f: &clean::
w,
"{vis}{constness}{asyncness}{unsafety}{abi}fn \
{name}{generics}{decl}{spotlight}{where_clause}",
- vis = it.visibility.print_with_space(cx.tcx(), it.def_id),
+ vis = it.visibility.print_with_space(cx.tcx(), it.def_id, cx.cache()),
constness = f.header.constness.print_with_space(),
asyncness = f.header.asyncness.print_with_space(),
unsafety = f.header.unsafety.print_with_space(),
abi = print_abi_with_space(f.header.abi),
name = it.name.as_ref().unwrap(),
- generics = f.generics.print(),
- where_clause = WhereClause { gens: &f.generics, indent: 0, end_newline: true },
+ generics = f.generics.print(cx.cache()),
+ where_clause =
+ WhereClause { gens: &f.generics, indent: 0, end_newline: true }.print(cx.cache()),
decl = Function { decl: &f.decl, header_len, indent: 0, asyncness: f.header.asyncness }
- .print(),
- spotlight = spotlight_decl(&f.decl),
+ .print(cx.cache()),
+ spotlight = spotlight_decl(&f.decl, &cx.cache),
);
document(w, cx, it, None)
}
@@ -2478,7 +2478,6 @@ fn render_implementor(
w: &mut Buffer,
implementor_dups: &FxHashMap");
render_attributes(w, it, true);
@@ -3122,16 +3111,16 @@ fn item_struct(
item_type = ItemType::StructField,
id = id,
name = field.name.as_ref().unwrap(),
- ty = ty.print()
+ ty = ty.print(cx.cache())
);
document(w, cx, field, Some(it));
}
}
}
- render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All, cache)
+ render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
}
-fn item_union(w: &mut Buffer, cx: &Context<'_>, it: &clean::Item, s: &clean::Union, cache: &Cache) {
+fn item_union(w: &mut Buffer, cx: &Context<'_>, it: &clean::Item, s: &clean::Union) {
wrap_into_docblock(w, |w| {
write!(w, "");
render_attributes(w, it, true);
@@ -3166,7 +3155,7 @@ fn item_union(w: &mut Buffer, cx: &Context<'_>, it: &clean::Item, s: &clean::Uni
id = id,
name = name,
shortty = ItemType::StructField,
- ty = ty.print()
+ ty = ty.print(cx.cache())
);
if let Some(stability_class) = field.stability_class(cx.tcx()) {
write!(w, "", stab = stability_class);
@@ -3174,20 +3163,20 @@ fn item_union(w: &mut Buffer, cx: &Context<'_>, it: &clean::Item, s: &clean::Uni
document(w, cx, field, Some(it));
}
}
- render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All, cache)
+ render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
}
-fn item_enum(w: &mut Buffer, cx: &Context<'_>, it: &clean::Item, e: &clean::Enum, cache: &Cache) {
+fn item_enum(w: &mut Buffer, cx: &Context<'_>, it: &clean::Item, e: &clean::Enum) {
wrap_into_docblock(w, |w| {
write!(w, "");
render_attributes(w, it, true);
write!(
w,
"{}enum {}{}{}",
- it.visibility.print_with_space(cx.tcx(), it.def_id),
+ it.visibility.print_with_space(cx.tcx(), it.def_id, cx.cache()),
it.name.as_ref().unwrap(),
- e.generics.print(),
- WhereClause { gens: &e.generics, indent: 0, end_newline: true }
+ e.generics.print(cx.cache()),
+ WhereClause { gens: &e.generics, indent: 0, end_newline: true }.print(cx.cache())
);
if e.variants.is_empty() && !e.variants_stripped {
write!(w, " {{}}");
@@ -3205,7 +3194,7 @@ fn item_enum(w: &mut Buffer, cx: &Context<'_>, it: &clean::Item, e: &clean::Enum
if i > 0 {
write!(w, ", ")
}
- write!(w, "{}", ty.print());
+ write!(w, "{}", ty.print(cx.cache()));
}
write!(w, ")");
}
@@ -3252,7 +3241,7 @@ fn item_enum(w: &mut Buffer, cx: &Context<'_>, it: &clean::Item, e: &clean::Enum
if i > 0 {
write!(w, ", ");
}
- write!(w, "{}", ty.print());
+ write!(w, "{}", ty.print(cx.cache()));
}
write!(w, ")");
}
@@ -3289,7 +3278,7 @@ fn item_enum(w: &mut Buffer, cx: &Context<'_>, it: &clean::Item, e: &clean::Enum
",
id = id,
f = field.name.as_ref().unwrap(),
- t = ty.print()
+ t = ty.print(cx.cache())
);
document(w, cx, field, Some(variant));
}
@@ -3299,7 +3288,7 @@ fn item_enum(w: &mut Buffer, cx: &Context<'_>, it: &clean::Item, e: &clean::Enum
render_stability_since(w, variant, it, cx.tcx());
}
}
- render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All, cache)
+ render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
}
const ALLOWED_ATTRIBUTES: &[Symbol] = &[
@@ -3357,17 +3346,21 @@ fn render_struct(
write!(
w,
"{}{}{}",
- it.visibility.print_with_space(cx.tcx(), it.def_id),
+ it.visibility.print_with_space(cx.tcx(), it.def_id, cx.cache()),
if structhead { "struct " } else { "" },
it.name.as_ref().unwrap()
);
if let Some(g) = g {
- write!(w, "{}", g.print())
+ write!(w, "{}", g.print(cx.cache()))
}
match ty {
CtorKind::Fictive => {
if let Some(g) = g {
- write!(w, "{}", WhereClause { gens: g, indent: 0, end_newline: true })
+ write!(
+ w,
+ "{}",
+ WhereClause { gens: g, indent: 0, end_newline: true }.print(cx.cache())
+ )
}
let mut has_visible_fields = false;
write!(w, " {{");
@@ -3377,9 +3370,9 @@ fn render_struct(
w,
"\n{} {}{}: {},",
tab,
- field.visibility.print_with_space(cx.tcx(), field.def_id),
+ field.visibility.print_with_space(cx.tcx(), field.def_id, cx.cache()),
field.name.as_ref().unwrap(),
- ty.print()
+ ty.print(cx.cache())
);
has_visible_fields = true;
}
@@ -3409,8 +3402,8 @@ fn render_struct(
write!(
w,
"{}{}",
- field.visibility.print_with_space(cx.tcx(), field.def_id),
- ty.print()
+ field.visibility.print_with_space(cx.tcx(), field.def_id, cx.cache()),
+ ty.print(cx.cache())
)
}
_ => unreachable!(),
@@ -3418,14 +3411,22 @@ fn render_struct(
}
write!(w, ")");
if let Some(g) = g {
- write!(w, "{}", WhereClause { gens: g, indent: 0, end_newline: false })
+ write!(
+ w,
+ "{}",
+ WhereClause { gens: g, indent: 0, end_newline: false }.print(cx.cache())
+ )
}
write!(w, ";");
}
CtorKind::Const => {
// Needed for PhantomData.
if let Some(g) = g {
- write!(w, "{}", WhereClause { gens: g, indent: 0, end_newline: false })
+ write!(
+ w,
+ "{}",
+ WhereClause { gens: g, indent: 0, end_newline: false }.print(cx.cache())
+ )
}
write!(w, ";");
}
@@ -3444,13 +3445,13 @@ fn render_union(
write!(
w,
"{}{}{}",
- it.visibility.print_with_space(cx.tcx(), it.def_id),
+ it.visibility.print_with_space(cx.tcx(), it.def_id, cx.cache()),
if structhead { "union " } else { "" },
it.name.as_ref().unwrap()
);
if let Some(g) = g {
- write!(w, "{}", g.print());
- write!(w, "{}", WhereClause { gens: g, indent: 0, end_newline: true });
+ write!(w, "{}", g.print(cx.cache()));
+ write!(w, "{}", WhereClause { gens: g, indent: 0, end_newline: true }.print(cx.cache()));
}
write!(w, " {{\n{}", tab);
@@ -3459,9 +3460,9 @@ fn render_union(
write!(
w,
" {}{}: {},\n{}",
- field.visibility.print_with_space(cx.tcx(), field.def_id),
+ field.visibility.print_with_space(cx.tcx(), field.def_id, cx.cache()),
field.name.as_ref().unwrap(),
- ty.print(),
+ ty.print(cx.cache()),
tab
);
}
@@ -3494,10 +3495,9 @@ fn render_assoc_items(
containing_item: &clean::Item,
it: DefId,
what: AssocItemRender<'_>,
- cache: &Cache,
) {
info!("Documenting associated items of {:?}", containing_item.name);
- let v = match cache.impls.get(&it) {
+ let v = match cx.cache.impls.get(&it) {
Some(v) => v,
None => return,
};
@@ -3514,9 +3514,11 @@ fn render_assoc_items(
RenderMode::Normal
}
AssocItemRender::DerefFor { trait_, type_, deref_mut_ } => {
- let id =
- cx.derive_id(small_url_encode(&format!("deref-methods-{:#}", type_.print())));
- cx.deref_id_map.borrow_mut().insert(type_.def_id().unwrap(), id.clone());
+ let id = cx.derive_id(small_url_encode(&format!(
+ "deref-methods-{:#}",
+ type_.print(cx.cache())
+ )));
+ cx.deref_id_map.borrow_mut().insert(type_.def_id(cx.cache()).unwrap(), id.clone());
write!(
w,
"\
@@ -3524,8 +3526,8 @@ fn render_assoc_items(
\
",
id = id,
- trait_ = trait_.print(),
- type_ = type_.print(),
+ trait_ = trait_.print(cx.cache()),
+ type_ = type_.print(cx.cache()),
);
RenderMode::ForDeref { mut_: deref_mut_ }
}
@@ -3545,17 +3547,18 @@ fn render_assoc_items(
false,
true,
&[],
- cache,
);
}
}
if !traits.is_empty() {
- let deref_impl =
- traits.iter().find(|t| t.inner_impl().trait_.def_id() == cache.deref_trait_did);
+ let deref_impl = traits
+ .iter()
+ .find(|t| t.inner_impl().trait_.def_id(cx.cache()) == cx.cache.deref_trait_did);
if let Some(impl_) = deref_impl {
- let has_deref_mut =
- traits.iter().any(|t| t.inner_impl().trait_.def_id() == cache.deref_mut_trait_did);
- render_deref_methods(w, cx, impl_, containing_item, has_deref_mut, cache);
+ let has_deref_mut = traits
+ .iter()
+ .any(|t| t.inner_impl().trait_.def_id(cx.cache()) == cx.cache.deref_mut_trait_did);
+ render_deref_methods(w, cx, impl_, containing_item, has_deref_mut);
}
// If we were already one level into rendering deref methods, we don't want to render
@@ -3570,7 +3573,7 @@ fn render_assoc_items(
concrete.into_iter().partition(|t| t.inner_impl().blanket_impl.is_some());
let mut impls = Buffer::empty_from(&w);
- render_impls(cx, &mut impls, &concrete, containing_item, cache);
+ render_impls(cx, &mut impls, &concrete, containing_item);
let impls = impls.into_inner();
if !impls.is_empty() {
write!(
@@ -3592,7 +3595,7 @@ fn render_assoc_items(
\
"
);
- render_impls(cx, w, &synthetic, containing_item, cache);
+ render_impls(cx, w, &synthetic, containing_item);
write!(w, "");
}
@@ -3605,7 +3608,7 @@ fn render_assoc_items(
\
"
);
- render_impls(cx, w, &blanket_impl, containing_item, cache);
+ render_impls(cx, w, &blanket_impl, containing_item);
write!(w, "");
}
}
@@ -3617,7 +3620,6 @@ fn render_deref_methods(
impl_: &Impl,
container_item: &clean::Item,
deref_mut: bool,
- cache: &Cache,
) {
let deref_type = impl_.inner_impl().trait_.as_ref().unwrap();
let (target, real_target) = impl_
@@ -3634,25 +3636,25 @@ fn render_deref_methods(
.expect("Expected associated type binding");
let what =
AssocItemRender::DerefFor { trait_: deref_type, type_: real_target, deref_mut_: deref_mut };
- if let Some(did) = target.def_id() {
- if let Some(type_did) = impl_.inner_impl().for_.def_id() {
+ if let Some(did) = target.def_id(cx.cache()) {
+ if let Some(type_did) = impl_.inner_impl().for_.def_id(cx.cache()) {
// `impl Deref for S`
if did == type_did {
// Avoid infinite cycles
return;
}
}
- render_assoc_items(w, cx, container_item, did, what, cache);
+ render_assoc_items(w, cx, container_item, did, what);
} else {
if let Some(prim) = target.primitive_type() {
- if let Some(&did) = cache.primitive_locations.get(&prim) {
- render_assoc_items(w, cx, container_item, did, what, cache);
+ if let Some(&did) = cx.cache.primitive_locations.get(&prim) {
+ render_assoc_items(w, cx, container_item, did, what);
}
}
}
}
-fn should_render_item(item: &clean::Item, deref_mut_: bool) -> bool {
+fn should_render_item(item: &clean::Item, deref_mut_: bool, cache: &Cache) -> bool {
let self_type_opt = match *item.kind {
clean::MethodItem(ref method, _) => method.decl.self_type(),
clean::TyMethodItem(ref method) => method.decl.self_type(),
@@ -3666,7 +3668,7 @@ fn should_render_item(item: &clean::Item, deref_mut_: bool) -> bool {
(mutability == Mutability::Mut, false, false)
}
SelfTy::SelfExplicit(clean::ResolvedPath { did, .. }) => {
- (false, Some(did) == cache().owned_box_did, false)
+ (false, Some(did) == cache.owned_box_did, false)
}
SelfTy::SelfValue => (false, false, true),
_ => (false, false, false),
@@ -3678,31 +3680,30 @@ fn should_render_item(item: &clean::Item, deref_mut_: bool) -> bool {
}
}
-fn spotlight_decl(decl: &clean::FnDecl) -> String {
+fn spotlight_decl(decl: &clean::FnDecl, c: &Cache) -> String {
let mut out = Buffer::html();
let mut trait_ = String::new();
- if let Some(did) = decl.output.def_id() {
- let c = cache();
+ if let Some(did) = decl.output.def_id(c) {
if let Some(impls) = c.impls.get(&did) {
for i in impls {
let impl_ = i.inner_impl();
- if impl_.trait_.def_id().map_or(false, |d| c.traits[&d].is_spotlight) {
+ if impl_.trait_.def_id(c).map_or(false, |d| c.traits[&d].is_spotlight) {
if out.is_empty() {
out.push_str(&format!(
"Notable traits for {}
\
",
- impl_.for_.print()
+ impl_.for_.print(c)
));
- trait_.push_str(&impl_.for_.print().to_string());
+ trait_.push_str(&impl_.for_.print(c).to_string());
}
//use the "where" class here to make it small
out.push_str(&format!(
"{}",
- impl_.print()
+ impl_.print(c)
));
- let t_did = impl_.trait_.def_id().unwrap();
+ let t_did = impl_.trait_.def_id(c).unwrap();
for it in &impl_.items {
if let clean::TypedefItem(ref tydef, _) = *it.kind {
out.push_str(" ");
@@ -3713,6 +3714,7 @@ fn spotlight_decl(decl: &clean::FnDecl) -> String {
Some(&tydef.type_),
AssocItemLink::GotoSource(t_did, &FxHashSet::default()),
"",
+ c,
);
out.push_str(";");
}
@@ -3750,18 +3752,17 @@ fn render_impl(
// This argument is used to reference same type with different paths to avoid duplication
// in documentation pages for trait with automatic implementations like "Send" and "Sync".
aliases: &[String],
- cache: &Cache,
) {
- let traits = &cache.traits;
- let trait_ = i.trait_did().map(|did| &traits[&did]);
+ let traits = &cx.cache.traits;
+ let trait_ = i.trait_did(cx.cache()).map(|did| &traits[&did]);
if render_mode == RenderMode::Normal {
let id = cx.derive_id(match i.inner_impl().trait_ {
Some(ref t) => {
if is_on_foreign_type {
- get_id_for_impl_on_foreign_type(&i.inner_impl().for_, t)
+ get_id_for_impl_on_foreign_type(&i.inner_impl().for_, t, cx.cache())
} else {
- format!("impl-{}", small_url_encode(&format!("{:#}", t.print())))
+ format!("impl-{}", small_url_encode(&format!("{:#}", t.print(cx.cache()))))
}
}
None => "impl".to_string(),
@@ -3773,12 +3774,20 @@ fn render_impl(
};
if let Some(use_absolute) = use_absolute {
write!(w, "", id, aliases);
- fmt_impl_for_trait_page(&i.inner_impl(), w, use_absolute);
+ fmt_impl_for_trait_page(&i.inner_impl(), w, use_absolute, cx.cache());
if show_def_docs {
for it in &i.inner_impl().items {
if let clean::TypedefItem(ref tydef, _) = *it.kind {
write!(w, " ");
- assoc_type(w, it, &[], Some(&tydef.type_), AssocItemLink::Anchor(None), "");
+ assoc_type(
+ w,
+ it,
+ &[],
+ Some(&tydef.type_),
+ AssocItemLink::Anchor(None),
+ "",
+ cx.cache(),
+ );
write!(w, ";");
}
}
@@ -3790,7 +3799,7 @@ fn render_impl(
"{}",
id,
aliases,
- i.inner_impl().print()
+ i.inner_impl().print(cx.cache())
);
}
write!(w, "", id);
@@ -3801,7 +3810,7 @@ fn render_impl(
outer_version,
outer_const_version,
);
- write_srclink(cx, &i.impl_item, w, cache);
+ write_srclink(cx, &i.impl_item, w);
write!(w, "
");
if trait_.is_some() {
@@ -3817,7 +3826,7 @@ fn render_impl(
"{}",
Markdown(
&*dox,
- &i.impl_item.links(),
+ &i.impl_item.links(&cx.cache),
&mut ids,
cx.shared.codes,
cx.shared.edition,
@@ -3840,14 +3849,15 @@ fn render_impl(
outer_const_version: Option<&str>,
trait_: Option<&clean::Trait>,
show_def_docs: bool,
- cache: &Cache,
) {
let item_type = item.type_();
let name = item.name.as_ref().unwrap();
let render_method_item = match render_mode {
RenderMode::Normal => true,
- RenderMode::ForDeref { mut_: deref_mut_ } => should_render_item(&item, deref_mut_),
+ RenderMode::ForDeref { mut_: deref_mut_ } => {
+ should_render_item(&item, deref_mut_, &cx.cache)
+ }
};
let (is_hidden, extra_class) =
@@ -3874,14 +3884,22 @@ fn render_impl(
outer_version,
outer_const_version,
);
- write_srclink(cx, item, w, cache);
+ write_srclink(cx, item, w);
write!(w, "");
}
}
clean::TypedefItem(ref tydef, _) => {
let id = cx.derive_id(format!("{}.{}", ItemType::AssocType, name));
write!(w, "", id, item_type, extra_class);
- assoc_type(w, item, &Vec::new(), Some(&tydef.type_), link.anchor(&id), "");
+ assoc_type(
+ w,
+ item,
+ &Vec::new(),
+ Some(&tydef.type_),
+ link.anchor(&id),
+ "",
+ cx.cache(),
+ );
write!(w, "
");
}
clean::AssocConstItem(ref ty, ref default) => {
@@ -3896,13 +3914,13 @@ fn render_impl(
outer_version,
outer_const_version,
);
- write_srclink(cx, item, w, cache);
+ write_srclink(cx, item, w);
write!(w, "");
}
clean::AssocTypeItem(ref bounds, ref default) => {
let id = cx.derive_id(format!("{}.{}", item_type, name));
write!(w, "", id, item_type, extra_class);
- assoc_type(w, item, bounds, default.as_ref(), link.anchor(&id), "");
+ assoc_type(w, item, bounds, default.as_ref(), link.anchor(&id), "", cx.cache());
write!(w, "
");
}
clean::StrippedItem(..) => return,
@@ -3961,7 +3979,6 @@ fn render_impl(
outer_const_version,
trait_,
show_def_docs,
- cache,
);
}
@@ -3975,14 +3992,13 @@ fn render_impl(
outer_version: Option<&str>,
outer_const_version: Option<&str>,
show_def_docs: bool,
- cache: &Cache,
) {
for trait_item in &t.items {
let n = trait_item.name;
if i.items.iter().any(|m| m.name == n) {
continue;
}
- let did = i.trait_.as_ref().unwrap().def_id().unwrap();
+ let did = i.trait_.as_ref().unwrap().def_id(cx.cache()).unwrap();
let assoc_link = AssocItemLink::GotoSource(did, &i.provided_trait_methods);
doc_impl_item(
@@ -3997,7 +4013,6 @@ fn render_impl(
outer_const_version,
None,
show_def_docs,
- cache,
);
}
}
@@ -4018,29 +4033,23 @@ fn render_impl(
outer_version,
outer_const_version,
show_def_docs,
- cache,
);
}
}
write!(w, "");
}
-fn item_opaque_ty(
- w: &mut Buffer,
- cx: &Context<'_>,
- it: &clean::Item,
- t: &clean::OpaqueTy,
- cache: &Cache,
-) {
+fn item_opaque_ty(w: &mut Buffer, cx: &Context<'_>, it: &clean::Item, t: &clean::OpaqueTy) {
write!(w, "");
render_attributes(w, it, false);
write!(
w,
"type {}{}{where_clause} = impl {bounds};",
it.name.as_ref().unwrap(),
- t.generics.print(),
- where_clause = WhereClause { gens: &t.generics, indent: 0, end_newline: true },
- bounds = bounds(&t.bounds, false)
+ t.generics.print(cx.cache()),
+ where_clause =
+ WhereClause { gens: &t.generics, indent: 0, end_newline: true }.print(cx.cache()),
+ bounds = bounds(&t.bounds, false, cx.cache())
);
document(w, cx, it, None);
@@ -4049,25 +4058,19 @@ fn item_opaque_ty(
// won't be visible anywhere in the docs. It would be nice to also show
// associated items from the aliased type (see discussion in #32077), but
// we need #14072 to make sense of the generics.
- render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All, cache)
+ render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
}
-fn item_trait_alias(
- w: &mut Buffer,
- cx: &Context<'_>,
- it: &clean::Item,
- t: &clean::TraitAlias,
- cache: &Cache,
-) {
+fn item_trait_alias(w: &mut Buffer, cx: &Context<'_>, it: &clean::Item, t: &clean::TraitAlias) {
write!(w, "");
render_attributes(w, it, false);
write!(
w,
"trait {}{}{} = {};",
it.name.as_ref().unwrap(),
- t.generics.print(),
- WhereClause { gens: &t.generics, indent: 0, end_newline: true },
- bounds(&t.bounds, true)
+ t.generics.print(cx.cache()),
+ WhereClause { gens: &t.generics, indent: 0, end_newline: true }.print(cx.cache()),
+ bounds(&t.bounds, true, cx.cache())
);
document(w, cx, it, None);
@@ -4076,25 +4079,20 @@ fn item_trait_alias(
// won't be visible anywhere in the docs. It would be nice to also show
// associated items from the aliased type (see discussion in #32077), but
// we need #14072 to make sense of the generics.
- render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All, cache)
+ render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
}
-fn item_typedef(
- w: &mut Buffer,
- cx: &Context<'_>,
- it: &clean::Item,
- t: &clean::Typedef,
- cache: &Cache,
-) {
+fn item_typedef(w: &mut Buffer, cx: &Context<'_>, it: &clean::Item, t: &clean::Typedef) {
write!(w, "");
render_attributes(w, it, false);
write!(
w,
"type {}{}{where_clause} = {type_};",
it.name.as_ref().unwrap(),
- t.generics.print(),
- where_clause = WhereClause { gens: &t.generics, indent: 0, end_newline: true },
- type_ = t.type_.print()
+ t.generics.print(cx.cache()),
+ where_clause =
+ WhereClause { gens: &t.generics, indent: 0, end_newline: true }.print(cx.cache()),
+ type_ = t.type_.print(cx.cache())
);
document(w, cx, it, None);
@@ -4103,25 +4101,25 @@ fn item_typedef(
// won't be visible anywhere in the docs. It would be nice to also show
// associated items from the aliased type (see discussion in #32077), but
// we need #14072 to make sense of the generics.
- render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All, cache)
+ render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
}
-fn item_foreign_type(w: &mut Buffer, cx: &Context<'_>, it: &clean::Item, cache: &Cache) {
+fn item_foreign_type(w: &mut Buffer, cx: &Context<'_>, it: &clean::Item) {
writeln!(w, "extern {{");
render_attributes(w, it, false);
write!(
w,
" {}type {};\n}}",
- it.visibility.print_with_space(cx.tcx(), it.def_id),
+ it.visibility.print_with_space(cx.tcx(), it.def_id, cx.cache()),
it.name.as_ref().unwrap(),
);
document(w, cx, it, None);
- render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All, cache)
+ render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
}
-fn print_sidebar(cx: &Context<'_>, it: &clean::Item, buffer: &mut Buffer, cache: &Cache) {
+fn print_sidebar(cx: &Context<'_>, it: &clean::Item, buffer: &mut Buffer) {
let parentlen = cx.current.len() - if it.is_mod() { 1 } else { 0 };
if it.is_struct()
@@ -4156,7 +4154,7 @@ fn print_sidebar(cx: &Context<'_>, it: &clean::Item, buffer: &mut Buffer, cache:
}
if it.is_crate() {
- if let Some(ref version) = cache.crate_version {
+ if let Some(ref version) = cx.cache.crate_version {
write!(
buffer,
"\
@@ -4245,12 +4243,13 @@ fn get_methods(
for_deref: bool,
used_links: &mut FxHashSet,
deref_mut: bool,
+ cache: &Cache,
) -> Vec {
i.items
.iter()
.filter_map(|item| match item.name {
Some(ref name) if !name.is_empty() && item.is_method() => {
- if !for_deref || should_render_item(item, deref_mut) {
+ if !for_deref || should_render_item(item, deref_mut, cache) {
Some(format!(
"{}",
get_next_url(used_links, format!("method.{}", name)),
@@ -4283,8 +4282,7 @@ fn small_url_encode(s: &str) -> String {
fn sidebar_assoc_items(cx: &Context<'_>, it: &clean::Item) -> String {
let mut out = String::new();
- let c = cache();
- if let Some(v) = c.impls.get(&it.def_id) {
+ if let Some(v) = cx.cache.impls.get(&it.def_id) {
let mut used_links = FxHashSet::default();
{
@@ -4292,7 +4290,9 @@ fn sidebar_assoc_items(cx: &Context<'_>, it: &clean::Item) -> String {
let mut ret = v
.iter()
.filter(|i| i.inner_impl().trait_.is_none())
- .flat_map(move |i| get_methods(i.inner_impl(), false, used_links_bor, false))
+ .flat_map(move |i| {
+ get_methods(i.inner_impl(), false, used_links_bor, false, &cx.cache)
+ })
.collect::>();
if !ret.is_empty() {
// We want links' order to be reproducible so we don't use unstable sort.
@@ -4309,7 +4309,7 @@ fn sidebar_assoc_items(cx: &Context<'_>, it: &clean::Item) -> String {
if let Some(impl_) = v
.iter()
.filter(|i| i.inner_impl().trait_.is_some())
- .find(|i| i.inner_impl().trait_.def_id() == c.deref_trait_did)
+ .find(|i| i.inner_impl().trait_.def_id(cx.cache()) == cx.cache.deref_trait_did)
{
out.push_str(&sidebar_deref_methods(cx, impl_, v));
}
@@ -4320,9 +4320,9 @@ fn sidebar_assoc_items(cx: &Context<'_>, it: &clean::Item) -> String {
.iter()
.filter_map(|it| {
if let Some(ref i) = it.inner_impl().trait_ {
- let i_display = format!("{:#}", i.print());
+ let i_display = format!("{:#}", i.print(cx.cache()));
let out = Escape(&i_display);
- let encoded = small_url_encode(&format!("{:#}", i.print()));
+ let encoded = small_url_encode(&format!("{:#}", i.print(cx.cache())));
let generated = format!(
"{}{}",
encoded,
@@ -4380,7 +4380,7 @@ fn sidebar_assoc_items(cx: &Context<'_>, it: &clean::Item) -> String {
fn sidebar_deref_methods(cx: &Context<'_>, impl_: &Impl, v: &Vec) -> String {
let mut out = String::new();
- let c = cache();
+ let c = cx.cache();
debug!("found Deref: {:?}", impl_);
if let Some((target, real_target)) =
@@ -4396,9 +4396,9 @@ fn sidebar_deref_methods(cx: &Context<'_>, impl_: &Impl, v: &Vec) -> Strin
let deref_mut = v
.iter()
.filter(|i| i.inner_impl().trait_.is_some())
- .any(|i| i.inner_impl().trait_.def_id() == c.deref_mut_trait_did);
+ .any(|i| i.inner_impl().trait_.def_id(cx.cache()) == c.deref_mut_trait_did);
let inner_impl = target
- .def_id()
+ .def_id(cx.cache())
.or_else(|| {
target.primitive_type().and_then(|prim| c.primitive_locations.get(&prim).cloned())
})
@@ -4409,18 +4409,18 @@ fn sidebar_deref_methods(cx: &Context<'_>, impl_: &Impl, v: &Vec) -> Strin
let mut ret = impls
.iter()
.filter(|i| i.inner_impl().trait_.is_none())
- .flat_map(|i| get_methods(i.inner_impl(), true, &mut used_links, deref_mut))
+ .flat_map(|i| get_methods(i.inner_impl(), true, &mut used_links, deref_mut, c))
.collect::>();
if !ret.is_empty() {
let deref_id_map = cx.deref_id_map.borrow();
let id = deref_id_map
- .get(&real_target.def_id().unwrap())
+ .get(&real_target.def_id(cx.cache()).unwrap())
.expect("Deref section without derived id");
out.push_str(&format!(
"Methods from {}<Target={}>",
id,
- Escape(&format!("{:#}", impl_.inner_impl().trait_.as_ref().unwrap().print())),
- Escape(&format!("{:#}", real_target.print())),
+ Escape(&format!("{:#}", impl_.inner_impl().trait_.as_ref().unwrap().print(c))),
+ Escape(&format!("{:#}", real_target.print(c))),
));
// We want links' order to be reproducible so we don't use unstable sort.
ret.sort();
@@ -4429,14 +4429,14 @@ fn sidebar_deref_methods(cx: &Context<'_>, impl_: &Impl, v: &Vec) -> Strin
}
// Recurse into any further impls that might exist for `target`
- if let Some(target_did) = target.def_id() {
+ if let Some(target_did) = target.def_id(cx.cache()) {
if let Some(target_impls) = c.impls.get(&target_did) {
if let Some(target_deref_impl) = target_impls
.iter()
.filter(|i| i.inner_impl().trait_.is_some())
- .find(|i| i.inner_impl().trait_.def_id() == c.deref_trait_did)
+ .find(|i| i.inner_impl().trait_.def_id(cx.cache()) == c.deref_trait_did)
{
- if let Some(type_did) = impl_.inner_impl().for_.def_id() {
+ if let Some(type_did) = impl_.inner_impl().for_.def_id(cx.cache()) {
// `impl Deref for S`
if target_did == type_did {
// Avoid infinite cycles
@@ -4473,17 +4473,21 @@ fn sidebar_struct(cx: &Context<'_>, buf: &mut Buffer, it: &clean::Item, s: &clea
}
}
-fn get_id_for_impl_on_foreign_type(for_: &clean::Type, trait_: &clean::Type) -> String {
- small_url_encode(&format!("impl-{:#}-for-{:#}", trait_.print(), for_.print()))
+fn get_id_for_impl_on_foreign_type(
+ for_: &clean::Type,
+ trait_: &clean::Type,
+ cache: &Cache,
+) -> String {
+ small_url_encode(&format!("impl-{:#}-for-{:#}", trait_.print(cache), for_.print(cache)))
}
-fn extract_for_impl_name(item: &clean::Item) -> Option<(String, String)> {
+fn extract_for_impl_name(item: &clean::Item, cache: &Cache) -> Option<(String, String)> {
match *item.kind {
clean::ItemKind::ImplItem(ref i) => {
if let Some(ref trait_) = i.trait_ {
Some((
- format!("{:#}", i.for_.print()),
- get_id_for_impl_on_foreign_type(&i.for_, trait_),
+ format!("{:#}", i.for_.print(cache)),
+ get_id_for_impl_on_foreign_type(&i.for_, trait_, cache),
))
} else {
None
@@ -4570,13 +4574,16 @@ fn sidebar_trait(cx: &Context<'_>, buf: &mut Buffer, it: &clean::Item, t: &clean
));
}
- let c = cache();
-
- if let Some(implementors) = c.implementors.get(&it.def_id) {
+ if let Some(implementors) = cx.cache.implementors.get(&it.def_id) {
let mut res = implementors
.iter()
- .filter(|i| i.inner_impl().for_.def_id().map_or(false, |d| !c.paths.contains_key(&d)))
- .filter_map(|i| extract_for_impl_name(&i.impl_item))
+ .filter(|i| {
+ i.inner_impl()
+ .for_
+ .def_id(cx.cache())
+ .map_or(false, |d| !cx.cache.paths.contains_key(&d))
+ })
+ .filter_map(|i| extract_for_impl_name(&i.impl_item, cx.cache()))
.collect::>();
if !res.is_empty() {
@@ -4815,9 +4822,9 @@ fn item_proc_macro(w: &mut Buffer, cx: &Context<'_>, it: &clean::Item, m: &clean
document(w, cx, it, None)
}
-fn item_primitive(w: &mut Buffer, cx: &Context<'_>, it: &clean::Item, cache: &Cache) {
+fn item_primitive(w: &mut Buffer, cx: &Context<'_>, it: &clean::Item) {
document(w, cx, it, None);
- render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All, cache)
+ render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
}
fn item_keyword(w: &mut Buffer, cx: &Context<'_>, it: &clean::Item) {
@@ -4836,11 +4843,10 @@ fn make_item_keywords(it: &clean::Item) -> String {
/// types are re-exported, we don't use the corresponding
/// entry from the js file, as inlining will have already
/// picked up the impl
-fn collect_paths_for_type(first_ty: clean::Type) -> Vec {
+fn collect_paths_for_type(first_ty: clean::Type, cache: &Cache) -> Vec {
let mut out = Vec::new();
let mut visited = FxHashSet::default();
let mut work = VecDeque::new();
- let cache = cache();
work.push_back(first_ty);
diff --git a/src/librustdoc/json/mod.rs b/src/librustdoc/json/mod.rs
index 512c9124727ef..6b19e9885c7a6 100644
--- a/src/librustdoc/json/mod.rs
+++ b/src/librustdoc/json/mod.rs
@@ -32,6 +32,7 @@ crate struct JsonRenderer<'tcx> {
index: Rc>>,
/// The directory where the blob will be written to.
out_path: PathBuf,
+ cache: Rc,
}
impl JsonRenderer<'_> {
@@ -39,12 +40,9 @@ impl JsonRenderer<'_> {
self.tcx.sess
}
- fn get_trait_implementors(
- &mut self,
- id: rustc_span::def_id::DefId,
- cache: &Cache,
- ) -> Vec {
- cache
+ fn get_trait_implementors(&mut self, id: rustc_span::def_id::DefId) -> Vec {
+ self.cache
+ .clone()
.implementors
.get(&id)
.map(|implementors| {
@@ -52,7 +50,7 @@ impl JsonRenderer<'_> {
.iter()
.map(|i| {
let item = &i.impl_item;
- self.item(item.clone(), cache).unwrap();
+ self.item(item.clone()).unwrap();
item.def_id.into()
})
.collect()
@@ -60,8 +58,9 @@ impl JsonRenderer<'_> {
.unwrap_or_default()
}
- fn get_impls(&mut self, id: rustc_span::def_id::DefId, cache: &Cache) -> Vec {
- cache
+ fn get_impls(&mut self, id: rustc_span::def_id::DefId) -> Vec {
+ self.cache
+ .clone()
.impls
.get(&id)
.map(|impls| {
@@ -70,7 +69,7 @@ impl JsonRenderer<'_> {
.filter_map(|i| {
let item = &i.impl_item;
if item.def_id.is_local() {
- self.item(item.clone(), cache).unwrap();
+ self.item(item.clone()).unwrap();
Some(item.def_id.into())
} else {
None
@@ -81,24 +80,26 @@ impl JsonRenderer<'_> {
.unwrap_or_default()
}
- fn get_trait_items(&mut self, cache: &Cache) -> Vec<(types::Id, types::Item)> {
- cache
+ fn get_trait_items(&mut self) -> Vec<(types::Id, types::Item)> {
+ self.cache
+ .clone()
.traits
.iter()
.filter_map(|(&id, trait_item)| {
// only need to synthesize items for external traits
if !id.is_local() {
- trait_item.items.clone().into_iter().for_each(|i| self.item(i, cache).unwrap());
+ trait_item.items.clone().into_iter().for_each(|i| self.item(i).unwrap());
Some((
id.into(),
types::Item {
id: id.into(),
crate_id: id.krate.as_u32(),
- name: cache
+ name: self
+ .cache
.paths
.get(&id)
.unwrap_or_else(|| {
- cache
+ self.cache
.external_paths
.get(&id)
.expect("Trait should either be in local or external paths")
@@ -134,8 +135,8 @@ impl<'tcx> FormatRenderer<'tcx> for JsonRenderer<'tcx> {
options: RenderOptions,
_render_info: RenderInfo,
_edition: Edition,
- _cache: &mut Cache,
- tcx: TyCtxt<'tcx>,
+ cache: Cache,
+ tcx: ty::TyCtxt<'tcx>,
) -> Result<(Self, clean::Crate), Error> {
debug!("Initializing json renderer");
Ok((
@@ -143,6 +144,7 @@ impl<'tcx> FormatRenderer<'tcx> for JsonRenderer<'tcx> {
tcx,
index: Rc::new(RefCell::new(FxHashMap::default())),
out_path: options.output,
+ cache: Rc::new(cache),
},
krate,
))
@@ -151,18 +153,18 @@ impl<'tcx> FormatRenderer<'tcx> for JsonRenderer<'tcx> {
/// Inserts an item into the index. This should be used rather than directly calling insert on
/// the hashmap because certain items (traits and types) need to have their mappings for trait
/// implementations filled out before they're inserted.
- fn item(&mut self, item: clean::Item, cache: &Cache) -> Result<(), Error> {
+ fn item(&mut self, item: clean::Item) -> Result<(), Error> {
// Flatten items that recursively store other items
- item.kind.inner_items().for_each(|i| self.item(i.clone(), cache).unwrap());
+ item.kind.inner_items().for_each(|i| self.item(i.clone()).unwrap());
let id = item.def_id;
if let Some(mut new_item) = self.convert_item(item) {
if let types::ItemEnum::TraitItem(ref mut t) = new_item.inner {
- t.implementors = self.get_trait_implementors(id, cache)
+ t.implementors = self.get_trait_implementors(id)
} else if let types::ItemEnum::StructItem(ref mut s) = new_item.inner {
- s.impls = self.get_impls(id, cache)
+ s.impls = self.get_impls(id)
} else if let types::ItemEnum::EnumItem(ref mut e) = new_item.inner {
- e.impls = self.get_impls(id, cache)
+ e.impls = self.get_impls(id)
}
let removed = self.index.borrow_mut().insert(id.into(), new_item.clone());
// FIXME(adotinthevoid): Currently, the index is duplicated. This is a sanity check
@@ -175,27 +177,20 @@ impl<'tcx> FormatRenderer<'tcx> for JsonRenderer<'tcx> {
Ok(())
}
- fn mod_item_in(
- &mut self,
- item: &clean::Item,
- _module_name: &str,
- cache: &Cache,
- ) -> Result<(), Error> {
+ fn mod_item_in(&mut self, item: &clean::Item, _module_name: &str) -> Result<(), Error> {
use clean::types::ItemKind::*;
if let ModuleItem(m) = &*item.kind {
for item in &m.items {
match &*item.kind {
// These don't have names so they don't get added to the output by default
- ImportItem(_) => self.item(item.clone(), cache).unwrap(),
- ExternCrateItem(_, _) => self.item(item.clone(), cache).unwrap(),
- ImplItem(i) => {
- i.items.iter().for_each(|i| self.item(i.clone(), cache).unwrap())
- }
+ ImportItem(_) => self.item(item.clone()).unwrap(),
+ ExternCrateItem(_, _) => self.item(item.clone()).unwrap(),
+ ImplItem(i) => i.items.iter().for_each(|i| self.item(i.clone()).unwrap()),
_ => {}
}
}
}
- self.item(item.clone(), cache).unwrap();
+ self.item(item.clone()).unwrap();
Ok(())
}
@@ -206,22 +201,22 @@ impl<'tcx> FormatRenderer<'tcx> for JsonRenderer<'tcx> {
fn after_krate(
&mut self,
krate: &clean::Crate,
- cache: &Cache,
_diag: &rustc_errors::Handler,
) -> Result<(), Error> {
debug!("Done with crate");
let mut index = (*self.index).clone().into_inner();
- index.extend(self.get_trait_items(cache));
+ index.extend(self.get_trait_items());
let output = types::Crate {
root: types::Id(String::from("0:0")),
crate_version: krate.version.clone(),
- includes_private: cache.document_private,
+ includes_private: self.cache.document_private,
index,
- paths: cache
+ paths: self
+ .cache
.paths
.clone()
.into_iter()
- .chain(cache.external_paths.clone().into_iter())
+ .chain(self.cache.external_paths.clone().into_iter())
.map(|(k, (path, kind))| {
(
k.into(),
@@ -229,7 +224,8 @@ impl<'tcx> FormatRenderer<'tcx> for JsonRenderer<'tcx> {
)
})
.collect(),
- external_crates: cache
+ external_crates: self
+ .cache
.extern_locations
.iter()
.map(|(k, v)| {
@@ -254,4 +250,8 @@ impl<'tcx> FormatRenderer<'tcx> for JsonRenderer<'tcx> {
serde_json::ser::to_writer(&file, &output).unwrap();
Ok(())
}
+
+ fn cache(&self) -> &Cache {
+ &self.cache
+ }
}
diff --git a/src/librustdoc/passes/calculate_doc_coverage.rs b/src/librustdoc/passes/calculate_doc_coverage.rs
index 05a3a15adac80..61e14c0522277 100644
--- a/src/librustdoc/passes/calculate_doc_coverage.rs
+++ b/src/librustdoc/passes/calculate_doc_coverage.rs
@@ -218,7 +218,12 @@ impl<'a, 'b> fold::DocFolder for CoverageCalculator<'a, 'b> {
clean::ImplItem(ref impl_) => {
let filename = i.source.filename(self.ctx.sess());
if let Some(ref tr) = impl_.trait_ {
- debug!("impl {:#} for {:#} in {}", tr.print(), impl_.for_.print(), filename,);
+ debug!(
+ "impl {:#} for {:#} in {}",
+ tr.print(&self.ctx.cache),
+ impl_.for_.print(&self.ctx.cache),
+ filename,
+ );
// don't count trait impls, the missing-docs lint doesn't so we shouldn't
// either
@@ -227,7 +232,7 @@ impl<'a, 'b> fold::DocFolder for CoverageCalculator<'a, 'b> {
// inherent impls *can* be documented, and those docs show up, but in most
// cases it doesn't make sense, as all methods on a type are in one single
// impl block
- debug!("impl {:#} in {}", impl_.for_.print(), filename);
+ debug!("impl {:#} in {}", impl_.for_.print(&self.ctx.cache), filename);
}
}
_ => {
diff --git a/src/librustdoc/passes/collect_trait_impls.rs b/src/librustdoc/passes/collect_trait_impls.rs
index 7b5e9e5905f33..9dc12737d6a86 100644
--- a/src/librustdoc/passes/collect_trait_impls.rs
+++ b/src/librustdoc/passes/collect_trait_impls.rs
@@ -2,6 +2,7 @@ use super::Pass;
use crate::clean::*;
use crate::core::DocContext;
use crate::fold::DocFolder;
+use crate::formats::cache::Cache;
use rustc_data_structures::fx::{FxHashMap, FxHashSet};
use rustc_hir::def_id::{DefId, LOCAL_CRATE};
@@ -96,12 +97,12 @@ crate fn collect_trait_impls(krate: Crate, cx: &DocContext<'_>) -> Crate {
// Gather all type to `Deref` target edges.
for it in &new_items {
if let ImplItem(Impl { ref for_, ref trait_, ref items, .. }) = *it.kind {
- if trait_.def_id() == cx.tcx.lang_items().deref_trait() {
+ if trait_.def_id(&cx.cache) == cx.tcx.lang_items().deref_trait() {
let target = items.iter().find_map(|item| match *item.kind {
TypedefItem(ref t, true) => Some(&t.type_),
_ => None,
});
- if let (Some(for_did), Some(target)) = (for_.def_id(), target) {
+ if let (Some(for_did), Some(target)) = (for_.def_id(&cx.cache), target) {
type_did_to_deref_target.insert(for_did, target);
}
}
@@ -112,19 +113,20 @@ crate fn collect_trait_impls(krate: Crate, cx: &DocContext<'_>) -> Crate {
map: &FxHashMap,
cleaner: &mut BadImplStripper,
type_did: &DefId,
+ cache: &Cache,
) {
if let Some(target) = map.get(type_did) {
debug!("add_deref_target: type {:?}, target {:?}", type_did, target);
if let Some(target_prim) = target.primitive_type() {
cleaner.prims.insert(target_prim);
- } else if let Some(target_did) = target.def_id() {
+ } else if let Some(target_did) = target.def_id(cache) {
// `impl Deref for S`
if target_did == *type_did {
// Avoid infinite cycles
return;
}
cleaner.items.insert(target_did);
- add_deref_target(map, cleaner, &target_did);
+ add_deref_target(map, cleaner, &target_did, cache);
}
}
}
@@ -133,14 +135,14 @@ crate fn collect_trait_impls(krate: Crate, cx: &DocContext<'_>) -> Crate {
// `Deref` target type and the impl for type positions, this map of types is keyed by
// `DefId` and for convenience uses a special cleaner that accepts `DefId`s directly.
if cleaner.keep_impl_with_def_id(type_did) {
- add_deref_target(&type_did_to_deref_target, &mut cleaner, type_did);
+ add_deref_target(&type_did_to_deref_target, &mut cleaner, type_did, &cx.cache);
}
}
new_items.retain(|it| {
if let ImplItem(Impl { ref for_, ref trait_, ref blanket_impl, .. }) = *it.kind {
- cleaner.keep_impl(for_)
- || trait_.as_ref().map_or(false, |t| cleaner.keep_impl(t))
+ cleaner.keep_impl(for_, &cx.cache)
+ || trait_.as_ref().map_or(false, |t| cleaner.keep_impl(t, &cx.cache))
|| blanket_impl.is_some()
} else {
true
@@ -216,13 +218,13 @@ struct BadImplStripper {
}
impl BadImplStripper {
- fn keep_impl(&self, ty: &Type) -> bool {
+ fn keep_impl(&self, ty: &Type, cache: &Cache) -> bool {
if let Generic(_) = ty {
// keep impls made on generics
true
} else if let Some(prim) = ty.primitive_type() {
self.prims.contains(&prim)
- } else if let Some(did) = ty.def_id() {
+ } else if let Some(did) = ty.def_id(cache) {
self.keep_impl_with_def_id(&did)
} else {
false
diff --git a/src/librustdoc/passes/strip_hidden.rs b/src/librustdoc/passes/strip_hidden.rs
index a276b7a63371b..c67f7869f4baf 100644
--- a/src/librustdoc/passes/strip_hidden.rs
+++ b/src/librustdoc/passes/strip_hidden.rs
@@ -15,7 +15,7 @@ crate const STRIP_HIDDEN: Pass = Pass {
};
/// Strip items marked `#[doc(hidden)]`
-crate fn strip_hidden(krate: clean::Crate, _: &DocContext<'_>) -> clean::Crate {
+crate fn strip_hidden(krate: clean::Crate, cx: &DocContext<'_>) -> clean::Crate {
let mut retained = DefIdSet::default();
// strip all #[doc(hidden)] items
@@ -25,7 +25,7 @@ crate fn strip_hidden(krate: clean::Crate, _: &DocContext<'_>) -> clean::Crate {
};
// strip all impls referencing stripped items
- let mut stripper = ImplStripper { retained: &retained };
+ let mut stripper = ImplStripper { retained: &retained, cache: &cx.cache };
stripper.fold_crate(krate)
}
diff --git a/src/librustdoc/passes/strip_private.rs b/src/librustdoc/passes/strip_private.rs
index e812bcd87fe3c..0ca4db83b7064 100644
--- a/src/librustdoc/passes/strip_private.rs
+++ b/src/librustdoc/passes/strip_private.rs
@@ -30,6 +30,6 @@ crate fn strip_private(mut krate: clean::Crate, cx: &DocContext<'_>) -> clean::C
}
// strip all impls referencing private items
- let mut stripper = ImplStripper { retained: &retained };
+ let mut stripper = ImplStripper { retained: &retained, cache: &cx.cache };
stripper.fold_crate(krate)
}
diff --git a/src/librustdoc/passes/stripper.rs b/src/librustdoc/passes/stripper.rs
index 162b70973b418..424928e2377b0 100644
--- a/src/librustdoc/passes/stripper.rs
+++ b/src/librustdoc/passes/stripper.rs
@@ -4,6 +4,7 @@ use std::mem;
use crate::clean::{self, GetDefId, Item};
use crate::fold::{DocFolder, StripItem};
+use crate::formats::cache::Cache;
crate struct Stripper<'a> {
crate retained: &'a mut DefIdSet,
@@ -117,6 +118,7 @@ impl<'a> DocFolder for Stripper<'a> {
/// This stripper discards all impls which reference stripped items
crate struct ImplStripper<'a> {
crate retained: &'a DefIdSet,
+ crate cache: &'a Cache,
}
impl<'a> DocFolder for ImplStripper<'a> {
@@ -126,13 +128,13 @@ impl<'a> DocFolder for ImplStripper<'a> {
if imp.trait_.is_none() && imp.items.is_empty() {
return None;
}
- if let Some(did) = imp.for_.def_id() {
+ if let Some(did) = imp.for_.def_id(&self.cache) {
if did.is_local() && !imp.for_.is_generic() && !self.retained.contains(&did) {
debug!("ImplStripper: impl item for stripped type; removing");
return None;
}
}
- if let Some(did) = imp.trait_.def_id() {
+ if let Some(did) = imp.trait_.def_id(&self.cache) {
if did.is_local() && !self.retained.contains(&did) {
debug!("ImplStripper: impl item for stripped trait; removing");
return None;
@@ -140,7 +142,7 @@ impl<'a> DocFolder for ImplStripper<'a> {
}
if let Some(generics) = imp.trait_.as_ref().and_then(|t| t.generics()) {
for typaram in generics {
- if let Some(did) = typaram.def_id() {
+ if let Some(did) = typaram.def_id(&self.cache) {
if did.is_local() && !self.retained.contains(&did) {
debug!(
"ImplStripper: stripped item in trait's generics; removing impl"
From c448270099444486cdf3c22bc841a5c673d9da4f Mon Sep 17 00:00:00 2001
From: Guillaume Gomez
Date: Wed, 13 Jan 2021 22:06:41 +0100
Subject: [PATCH 02/10] Use empty Cache for methods requiring it when filling
Cache itself
---
src/librustdoc/formats/cache.rs | 118 +++++++++++++++++++-------------
1 file changed, 70 insertions(+), 48 deletions(-)
diff --git a/src/librustdoc/formats/cache.rs b/src/librustdoc/formats/cache.rs
index c4c8145a57d0a..6e42acfe11f7d 100644
--- a/src/librustdoc/formats/cache.rs
+++ b/src/librustdoc/formats/cache.rs
@@ -193,7 +193,11 @@ impl Cache {
}
cache.stack.push(krate.name.to_string());
- krate = cache.fold_crate(krate);
+
+ krate = {
+ let mut cache_wrapper = CacheWrapper { cache: &mut cache, tmp_cache: Cache::default() };
+ cache_wrapper.fold_crate(krate)
+ };
for (trait_did, dids, impl_) in cache.orphan_trait_impls.drain(..) {
if cache.traits.contains_key(&trait_did) {
@@ -207,7 +211,15 @@ impl Cache {
}
}
-impl DocFolder for Cache {
+/// This struct is needed because we need to use an empty `Cache` for all functions requiring
+/// a `Cache`. If we use the already filled one (`cache` in here), it'll provide information
+/// about implementations that aren't related to the type being checked.
+struct CacheWrapper<'a> {
+ cache: &'a mut Cache,
+ tmp_cache: Cache,
+}
+
+impl<'a> DocFolder for CacheWrapper<'a> {
fn fold_item(&mut self, item: clean::Item) -> Option {
if item.def_id.is_local() {
debug!("folding {} \"{:?}\", id {:?}", item.type_(), item.name, item.def_id);
@@ -217,17 +229,21 @@ impl DocFolder for Cache {
// we don't want it or its children in the search index.
let orig_stripped_mod = match *item.kind {
clean::StrippedItem(box clean::ModuleItem(..)) => {
- mem::replace(&mut self.stripped_mod, true)
+ mem::replace(&mut self.cache.stripped_mod, true)
}
- _ => self.stripped_mod,
+ _ => self.cache.stripped_mod,
};
// If the impl is from a masked crate or references something from a
// masked crate then remove it completely.
if let clean::ImplItem(ref i) = *item.kind {
- if self.masked_crates.contains(&item.def_id.krate)
- || i.trait_.def_id(self).map_or(false, |d| self.masked_crates.contains(&d.krate))
- || i.for_.def_id(self).map_or(false, |d| self.masked_crates.contains(&d.krate))
+ if self.cache.masked_crates.contains(&item.def_id.krate)
+ || i.trait_
+ .def_id(&self.tmp_cache)
+ .map_or(false, |d| self.cache.masked_crates.contains(&d.krate))
+ || i.for_
+ .def_id(&self.tmp_cache)
+ .map_or(false, |d| self.cache.masked_crates.contains(&d.krate))
{
return None;
}
@@ -236,14 +252,15 @@ impl DocFolder for Cache {
// Propagate a trait method's documentation to all implementors of the
// trait.
if let clean::TraitItem(ref t) = *item.kind {
- self.traits.entry(item.def_id).or_insert_with(|| t.clone());
+ self.cache.traits.entry(item.def_id).or_insert_with(|| t.clone());
}
// Collect all the implementors of traits.
if let clean::ImplItem(ref i) = *item.kind {
- if let Some(did) = i.trait_.def_id(self) {
+ if let Some(did) = i.trait_.def_id(&self.tmp_cache) {
if i.blanket_impl.is_none() {
- self.implementors
+ self.cache
+ .implementors
.entry(did)
.or_default()
.push(Impl { impl_item: item.clone() });
@@ -256,7 +273,7 @@ impl DocFolder for Cache {
let (parent, is_inherent_impl_item) = match *item.kind {
clean::StrippedItem(..) => ((None, None), false),
clean::AssocConstItem(..) | clean::TypedefItem(_, true)
- if self.parent_is_trait_impl =>
+ if self.cache.parent_is_trait_impl =>
{
// skip associated items in trait impls
((None, None), false)
@@ -266,18 +283,18 @@ impl DocFolder for Cache {
| clean::StructFieldItem(..)
| clean::VariantItem(..) => (
(
- Some(*self.parent_stack.last().expect("parent_stack is empty")),
- Some(&self.stack[..self.stack.len() - 1]),
+ Some(*self.cache.parent_stack.last().expect("parent_stack is empty")),
+ Some(&self.cache.stack[..self.cache.stack.len() - 1]),
),
false,
),
clean::MethodItem(..) | clean::AssocConstItem(..) => {
- if self.parent_stack.is_empty() {
+ if self.cache.parent_stack.is_empty() {
((None, None), false)
} else {
- let last = self.parent_stack.last().expect("parent_stack is empty 2");
+ let last = self.cache.parent_stack.last().expect("parent_stack is empty 2");
let did = *last;
- let path = match self.paths.get(&did) {
+ let path = match self.cache.paths.get(&did) {
// The current stack not necessarily has correlation
// for where the type was defined. On the other
// hand, `paths` always has the right
@@ -289,24 +306,24 @@ impl DocFolder for Cache {
| ItemType::Union
| ItemType::Enum,
)) => Some(&fqp[..fqp.len() - 1]),
- Some(..) => Some(&*self.stack),
+ Some(..) => Some(&*self.cache.stack),
None => None,
};
((Some(*last), path), true)
}
}
- _ => ((None, Some(&*self.stack)), false),
+ _ => ((None, Some(&*self.cache.stack)), false),
};
match parent {
- (parent, Some(path)) if is_inherent_impl_item || !self.stripped_mod => {
+ (parent, Some(path)) if is_inherent_impl_item || !self.cache.stripped_mod => {
debug_assert!(!item.is_stripped());
// A crate has a module at its root, containing all items,
// which should not be indexed. The crate-item itself is
// inserted later on when serializing the search-index.
if item.def_id.index != CRATE_DEF_INDEX {
- self.search_index.push(IndexItem {
+ self.cache.search_index.push(IndexItem {
ty: item.type_(),
name: s.to_string(),
path: path.join("::"),
@@ -315,21 +332,22 @@ impl DocFolder for Cache {
.map_or_else(String::new, |x| short_markdown_summary(&x.as_str())),
parent,
parent_idx: None,
- search_type: get_index_search_type(&item, self),
+ search_type: get_index_search_type(&item, &self.tmp_cache),
});
for alias in item.attrs.get_doc_aliases() {
- self.aliases
+ self.cache
+ .aliases
.entry(alias.to_lowercase())
.or_insert(Vec::new())
- .push(self.search_index.len() - 1);
+ .push(self.cache.search_index.len() - 1);
}
}
}
(Some(parent), None) if is_inherent_impl_item => {
// We have a parent, but we don't know where they're
// defined yet. Wait for later to index this item.
- self.orphan_impl_items.push((parent, item.clone()));
+ self.cache.orphan_impl_items.push((parent, item.clone()));
}
_ => {}
}
@@ -338,7 +356,7 @@ impl DocFolder for Cache {
// Keep track of the fully qualified path for this item.
let pushed = match item.name {
Some(n) if !n.is_empty() => {
- self.stack.push(n.to_string());
+ self.cache.stack.push(n.to_string());
true
}
_ => false,
@@ -360,7 +378,7 @@ impl DocFolder for Cache {
| clean::MacroItem(..)
| clean::ProcMacroItem(..)
| clean::VariantItem(..)
- if !self.stripped_mod =>
+ if !self.cache.stripped_mod =>
{
// Re-exported items mean that the same id can show up twice
// in the rustdoc ast that we're looking at. We know,
@@ -368,21 +386,21 @@ impl DocFolder for Cache {
// `public_items` map, so we can skip inserting into the
// paths map if there was already an entry present and we're
// not a public item.
- if !self.paths.contains_key(&item.def_id)
- || self.access_levels.is_public(item.def_id)
+ if !self.cache.paths.contains_key(&item.def_id)
+ || self.cache.access_levels.is_public(item.def_id)
{
- self.paths.insert(item.def_id, (self.stack.clone(), item.type_()));
+ self.cache.paths.insert(item.def_id, (self.cache.stack.clone(), item.type_()));
}
}
clean::PrimitiveItem(..) => {
- self.paths.insert(item.def_id, (self.stack.clone(), item.type_()));
+ self.cache.paths.insert(item.def_id, (self.cache.stack.clone(), item.type_()));
}
_ => {}
}
// Maintain the parent stack
- let orig_parent_is_trait_impl = self.parent_is_trait_impl;
+ let orig_parent_is_trait_impl = self.cache.parent_is_trait_impl;
let parent_pushed = match *item.kind {
clean::TraitItem(..)
| clean::EnumItem(..)
@@ -390,24 +408,24 @@ impl DocFolder for Cache {
| clean::StructItem(..)
| clean::UnionItem(..)
| clean::VariantItem(..) => {
- self.parent_stack.push(item.def_id);
- self.parent_is_trait_impl = false;
+ self.cache.parent_stack.push(item.def_id);
+ self.cache.parent_is_trait_impl = false;
true
}
clean::ImplItem(ref i) => {
- self.parent_is_trait_impl = i.trait_.is_some();
+ self.cache.parent_is_trait_impl = i.trait_.is_some();
match i.for_ {
clean::ResolvedPath { did, .. } => {
- self.parent_stack.push(did);
+ self.cache.parent_stack.push(did);
true
}
ref t => {
let prim_did = t
.primitive_type()
- .and_then(|t| self.primitive_locations.get(&t).cloned());
+ .and_then(|t| self.cache.primitive_locations.get(&t).cloned());
match prim_did {
Some(did) => {
- self.parent_stack.push(did);
+ self.cache.parent_stack.push(did);
true
}
None => false,
@@ -432,8 +450,9 @@ impl DocFolder for Cache {
dids.insert(did);
}
ref t => {
- let did =
- t.primitive_type().and_then(|t| self.primitive_locations.get(&t).cloned());
+ let did = t
+ .primitive_type()
+ .and_then(|t| self.cache.primitive_locations.get(&t).cloned());
if let Some(did) = did {
dids.insert(did);
@@ -443,19 +462,22 @@ impl DocFolder for Cache {
if let Some(generics) = i.trait_.as_ref().and_then(|t| t.generics()) {
for bound in generics {
- if let Some(did) = bound.def_id(self) {
+ if let Some(did) = bound.def_id(&self.tmp_cache) {
dids.insert(did);
}
}
}
let impl_item = Impl { impl_item: item };
- if impl_item.trait_did(self).map_or(true, |d| self.traits.contains_key(&d)) {
+ if impl_item
+ .trait_did(&self.tmp_cache)
+ .map_or(true, |d| self.cache.traits.contains_key(&d))
+ {
for did in dids {
- self.impls.entry(did).or_insert(vec![]).push(impl_item.clone());
+ self.cache.impls.entry(did).or_insert(vec![]).push(impl_item.clone());
}
} else {
- let trait_did = impl_item.trait_did(self).expect("no trait did");
- self.orphan_trait_impls.push((trait_did, dids, impl_item));
+ let trait_did = impl_item.trait_did(&self.tmp_cache).expect("no trait did");
+ self.cache.orphan_trait_impls.push((trait_did, dids, impl_item));
}
None
} else {
@@ -463,13 +485,13 @@ impl DocFolder for Cache {
};
if pushed {
- self.stack.pop().expect("stack already empty");
+ self.cache.stack.pop().expect("stack already empty");
}
if parent_pushed {
- self.parent_stack.pop().expect("parent stack already empty");
+ self.cache.parent_stack.pop().expect("parent stack already empty");
}
- self.stripped_mod = orig_stripped_mod;
- self.parent_is_trait_impl = orig_parent_is_trait_impl;
+ self.cache.stripped_mod = orig_stripped_mod;
+ self.cache.parent_is_trait_impl = orig_parent_is_trait_impl;
ret
}
}
From 19630ead410873a08b271606b8ac5a27029d70b6 Mon Sep 17 00:00:00 2001
From: Guillaume Gomez
Date: Fri, 15 Jan 2021 15:36:15 +0100
Subject: [PATCH 03/10] Remove cache usage wherever possible
---
src/librustdoc/clean/inline.rs | 10 +-
src/librustdoc/clean/mod.rs | 6 +-
src/librustdoc/clean/types.rs | 78 +++++++++----
src/librustdoc/clean/utils.rs | 24 ++--
src/librustdoc/formats/cache.rs | 117 ++++++++-----------
src/librustdoc/formats/mod.rs | 8 +-
src/librustdoc/html/render/cache.rs | 19 +--
src/librustdoc/html/render/mod.rs | 49 ++++----
src/librustdoc/passes/collect_trait_impls.rs | 20 ++--
src/librustdoc/passes/strip_hidden.rs | 4 +-
src/librustdoc/passes/strip_private.rs | 2 +-
src/librustdoc/passes/stripper.rs | 8 +-
12 files changed, 179 insertions(+), 166 deletions(-)
diff --git a/src/librustdoc/clean/inline.rs b/src/librustdoc/clean/inline.rs
index 6ef74d6e9920c..1f9e7f8ae5cd4 100644
--- a/src/librustdoc/clean/inline.rs
+++ b/src/librustdoc/clean/inline.rs
@@ -368,7 +368,7 @@ crate fn build_impl(
// Only inline impl if the implementing type is
// reachable in rustdoc generated documentation
if !did.is_local() {
- if let Some(did) = for_.def_id(&cx.cache) {
+ if let Some(did) = for_.def_id() {
if !cx.renderinfo.borrow().access_levels.is_public(did) {
return;
}
@@ -410,19 +410,19 @@ crate fn build_impl(
clean::GenericBound::TraitBound(polyt, _) => polyt.trait_,
clean::GenericBound::Outlives(..) => unreachable!(),
});
- if trait_.def_id(&cx.cache) == tcx.lang_items().deref_trait() {
+ if trait_.def_id() == tcx.lang_items().deref_trait() {
super::build_deref_target_impls(cx, &trait_items, ret);
}
- if let Some(trait_did) = trait_.def_id(&cx.cache) {
+ if let Some(trait_did) = trait_.def_id() {
record_extern_trait(cx, trait_did);
}
let provided = trait_
- .def_id(&cx.cache)
+ .def_id()
.map(|did| tcx.provided_trait_methods(did).map(|meth| meth.ident.name).collect())
.unwrap_or_default();
- debug!("build_impl: impl {:?} for {:?}", trait_.def_id(&cx.cache), for_.def_id(&cx.cache));
+ debug!("build_impl: impl {:?} for {:?}", trait_.def_id(), for_.def_id());
let mut item = clean::Item::from_def_id_and_parts(
did,
diff --git a/src/librustdoc/clean/mod.rs b/src/librustdoc/clean/mod.rs
index dcb0b325b9775..03454bb8b7ff0 100644
--- a/src/librustdoc/clean/mod.rs
+++ b/src/librustdoc/clean/mod.rs
@@ -2089,17 +2089,17 @@ fn clean_impl(impl_: &hir::Impl<'_>, hir_id: hir::HirId, cx: &DocContext<'_>) ->
// If this impl block is an implementation of the Deref trait, then we
// need to try inlining the target's inherent impl blocks as well.
- if trait_.def_id(&cx.cache) == cx.tcx.lang_items().deref_trait() {
+ if trait_.def_id() == cx.tcx.lang_items().deref_trait() {
build_deref_target_impls(cx, &items, &mut ret);
}
let provided: FxHashSet = trait_
- .def_id(&cx.cache)
+ .def_id()
.map(|did| cx.tcx.provided_trait_methods(did).map(|meth| meth.ident.name).collect())
.unwrap_or_default();
let for_ = impl_.self_ty.clean(cx);
- let type_alias = for_.def_id(&cx.cache).and_then(|did| match cx.tcx.def_kind(did) {
+ let type_alias = for_.def_id().and_then(|did| match cx.tcx.def_kind(did) {
DefKind::TyAlias => Some(cx.tcx.type_of(did).clean(cx)),
_ => None,
});
diff --git a/src/librustdoc/clean/types.rs b/src/librustdoc/clean/types.rs
index d03c457c8965c..1e3c3a23c9884 100644
--- a/src/librustdoc/clean/types.rs
+++ b/src/librustdoc/clean/types.rs
@@ -958,7 +958,7 @@ impl GenericBound {
crate fn is_sized_bound(&self, cx: &DocContext<'_>) -> bool {
use rustc_hir::TraitBoundModifier as TBM;
if let GenericBound::TraitBound(PolyTrait { ref trait_, .. }, TBM::None) = *self {
- if trait_.def_id(&cx.cache) == cx.tcx.lang_items().sized_trait() {
+ if trait_.def_id() == cx.tcx.lang_items().sized_trait() {
return true;
}
}
@@ -1171,9 +1171,16 @@ crate enum FnRetTy {
}
impl GetDefId for FnRetTy {
- fn def_id(&self, cache: &Cache) -> Option {
+ fn def_id(&self) -> Option {
match *self {
- Return(ref ty) => ty.def_id(cache),
+ Return(ref ty) => ty.def_id(),
+ DefaultReturn => None,
+ }
+ }
+
+ fn def_id_full(&self, cache: &Cache) -> Option {
+ match *self {
+ Return(ref ty) => ty.def_id_full(cache),
DefaultReturn => None,
}
}
@@ -1299,12 +1306,20 @@ crate enum TypeKind {
}
crate trait GetDefId {
- fn def_id(&self, cache: &Cache) -> Option;
+ /// Doesn't retrieve primitive types `DefId`. Use `def_id_full` if you want it.
+ fn def_id(&self) -> Option;
+ /// Retrieves all types' `DefId` (including primitives). If you're not interested about
+ /// primitives, use `def_id`.
+ fn def_id_full(&self, cache: &Cache) -> Option;
}
impl GetDefId for Option {
- fn def_id(&self, cache: &Cache) -> Option {
- self.as_ref().and_then(|d| d.def_id(cache))
+ fn def_id(&self) -> Option {
+ self.as_ref().and_then(|d| d.def_id())
+ }
+
+ fn def_id_full(&self, cache: &Cache) -> Option {
+ self.as_ref().and_then(|d| d.def_id_full(cache))
}
}
@@ -1393,33 +1408,50 @@ impl Type {
}
}
-impl GetDefId for Type {
- fn def_id(&self, cache: &Cache) -> Option {
+impl Type {
+ fn inner_def_id(&self, cache: Option<&Cache>) -> Option {
+ fn inner(t: &T, cache: Option<&Cache>) -> Option {
+ match cache {
+ Some(c) => t.def_id_full(c),
+ None => t.def_id(),
+ }
+ }
+
match *self {
ResolvedPath { did, .. } => Some(did),
- Primitive(p) => cache.primitive_locations.get(&p).cloned(),
+ Primitive(p) => cache.and_then(|c| c.primitive_locations.get(&p).cloned()),
BorrowedRef { type_: box Generic(..), .. } => {
- Primitive(PrimitiveType::Reference).def_id(cache)
+ inner(&Primitive(PrimitiveType::Reference), cache)
}
- BorrowedRef { ref type_, .. } => type_.def_id(cache),
+ BorrowedRef { ref type_, .. } => inner(&**type_, cache),
Tuple(ref tys) => {
if tys.is_empty() {
- Primitive(PrimitiveType::Unit).def_id(cache)
+ inner(&Primitive(PrimitiveType::Unit), cache)
} else {
- Primitive(PrimitiveType::Tuple).def_id(cache)
+ inner(&Primitive(PrimitiveType::Tuple), cache)
}
}
- BareFunction(..) => Primitive(PrimitiveType::Fn).def_id(cache),
- Never => Primitive(PrimitiveType::Never).def_id(cache),
- Slice(..) => Primitive(PrimitiveType::Slice).def_id(cache),
- Array(..) => Primitive(PrimitiveType::Array).def_id(cache),
- RawPointer(..) => Primitive(PrimitiveType::RawPointer).def_id(cache),
- QPath { ref self_type, .. } => self_type.def_id(cache),
+ BareFunction(..) => inner(&Primitive(PrimitiveType::Fn), cache),
+ Never => inner(&Primitive(PrimitiveType::Never), cache),
+ Slice(..) => inner(&Primitive(PrimitiveType::Slice), cache),
+ Array(..) => inner(&Primitive(PrimitiveType::Array), cache),
+ RawPointer(..) => inner(&Primitive(PrimitiveType::RawPointer), cache),
+ QPath { ref self_type, .. } => inner(&**self_type, cache),
_ => None,
}
}
}
+impl GetDefId for Type {
+ fn def_id(&self) -> Option {
+ self.inner_def_id(None)
+ }
+
+ fn def_id_full(&self, cache: &Cache) -> Option {
+ self.inner_def_id(Some(cache))
+ }
+}
+
impl PrimitiveType {
crate fn from_hir(prim: hir::PrimTy) -> PrimitiveType {
match prim {
@@ -1814,8 +1846,12 @@ crate struct Typedef {
}
impl GetDefId for Typedef {
- fn def_id(&self, cache: &Cache) -> Option {
- self.type_.def_id(cache)
+ fn def_id(&self) -> Option {
+ self.type_.def_id()
+ }
+
+ fn def_id_full(&self, cache: &Cache) -> Option {
+ self.type_.def_id_full(cache)
}
}
diff --git a/src/librustdoc/clean/utils.rs b/src/librustdoc/clean/utils.rs
index e6a94926329b9..869d48fc25e07 100644
--- a/src/librustdoc/clean/utils.rs
+++ b/src/librustdoc/clean/utils.rs
@@ -179,9 +179,7 @@ crate fn get_real_types(
if arg.is_full_generic() {
let arg_s = Symbol::intern(&arg.print(&cx.cache).to_string());
if let Some(where_pred) = generics.where_predicates.iter().find(|g| match g {
- WherePredicate::BoundPredicate { ty, .. } => {
- ty.def_id(&cx.cache) == arg.def_id(&cx.cache)
- }
+ WherePredicate::BoundPredicate { ty, .. } => ty.def_id() == arg.def_id(),
_ => false,
}) {
let bounds = where_pred.get_bounds().unwrap_or_else(|| &[]);
@@ -197,7 +195,7 @@ crate fn get_real_types(
res.extend(adds);
} else if !ty.is_full_generic() {
if let Some(kind) =
- ty.def_id(&cx.cache).map(|did| cx.tcx.def_kind(did).clean(cx))
+ ty.def_id().map(|did| cx.tcx.def_kind(did).clean(cx))
{
res.insert((ty, kind));
}
@@ -214,9 +212,7 @@ crate fn get_real_types(
if !adds.is_empty() {
res.extend(adds);
} else if !ty.is_full_generic() {
- if let Some(kind) =
- ty.def_id(&cx.cache).map(|did| cx.tcx.def_kind(did).clean(cx))
- {
+ if let Some(kind) = ty.def_id().map(|did| cx.tcx.def_kind(did).clean(cx)) {
res.insert((ty.clone(), kind));
}
}
@@ -224,7 +220,7 @@ crate fn get_real_types(
}
}
} else {
- if let Some(kind) = arg.def_id(&cx.cache).map(|did| cx.tcx.def_kind(did).clean(cx)) {
+ if let Some(kind) = arg.def_id().map(|did| cx.tcx.def_kind(did).clean(cx)) {
res.insert((arg.clone(), kind));
}
if let Some(gens) = arg.generics() {
@@ -234,9 +230,7 @@ crate fn get_real_types(
if !adds.is_empty() {
res.extend(adds);
}
- } else if let Some(kind) =
- gen.def_id(&cx.cache).map(|did| cx.tcx.def_kind(did).clean(cx))
- {
+ } else if let Some(kind) = gen.def_id().map(|did| cx.tcx.def_kind(did).clean(cx)) {
res.insert((gen.clone(), kind));
}
}
@@ -263,9 +257,7 @@ crate fn get_all_types(
if !args.is_empty() {
all_types.extend(args);
} else {
- if let Some(kind) =
- arg.type_.def_id(&cx.cache).map(|did| cx.tcx.def_kind(did).clean(cx))
- {
+ if let Some(kind) = arg.type_.def_id().map(|did| cx.tcx.def_kind(did).clean(cx)) {
all_types.insert((arg.type_.clone(), kind));
}
}
@@ -275,9 +267,7 @@ crate fn get_all_types(
FnRetTy::Return(ref return_type) => {
let mut ret = get_real_types(generics, &return_type, cx, 0);
if ret.is_empty() {
- if let Some(kind) =
- return_type.def_id(&cx.cache).map(|did| cx.tcx.def_kind(did).clean(cx))
- {
+ if let Some(kind) = return_type.def_id().map(|did| cx.tcx.def_kind(did).clean(cx)) {
ret.insert((return_type.clone(), kind));
}
}
diff --git a/src/librustdoc/formats/cache.rs b/src/librustdoc/formats/cache.rs
index 6e42acfe11f7d..c506f5a37b15b 100644
--- a/src/librustdoc/formats/cache.rs
+++ b/src/librustdoc/formats/cache.rs
@@ -194,10 +194,7 @@ impl Cache {
cache.stack.push(krate.name.to_string());
- krate = {
- let mut cache_wrapper = CacheWrapper { cache: &mut cache, tmp_cache: Cache::default() };
- cache_wrapper.fold_crate(krate)
- };
+ krate = cache.fold_crate(krate);
for (trait_did, dids, impl_) in cache.orphan_trait_impls.drain(..) {
if cache.traits.contains_key(&trait_did) {
@@ -211,15 +208,7 @@ impl Cache {
}
}
-/// This struct is needed because we need to use an empty `Cache` for all functions requiring
-/// a `Cache`. If we use the already filled one (`cache` in here), it'll provide information
-/// about implementations that aren't related to the type being checked.
-struct CacheWrapper<'a> {
- cache: &'a mut Cache,
- tmp_cache: Cache,
-}
-
-impl<'a> DocFolder for CacheWrapper<'a> {
+impl DocFolder for Cache {
fn fold_item(&mut self, item: clean::Item) -> Option {
if item.def_id.is_local() {
debug!("folding {} \"{:?}\", id {:?}", item.type_(), item.name, item.def_id);
@@ -229,21 +218,17 @@ impl<'a> DocFolder for CacheWrapper<'a> {
// we don't want it or its children in the search index.
let orig_stripped_mod = match *item.kind {
clean::StrippedItem(box clean::ModuleItem(..)) => {
- mem::replace(&mut self.cache.stripped_mod, true)
+ mem::replace(&mut self.stripped_mod, true)
}
- _ => self.cache.stripped_mod,
+ _ => self.stripped_mod,
};
// If the impl is from a masked crate or references something from a
// masked crate then remove it completely.
if let clean::ImplItem(ref i) = *item.kind {
- if self.cache.masked_crates.contains(&item.def_id.krate)
- || i.trait_
- .def_id(&self.tmp_cache)
- .map_or(false, |d| self.cache.masked_crates.contains(&d.krate))
- || i.for_
- .def_id(&self.tmp_cache)
- .map_or(false, |d| self.cache.masked_crates.contains(&d.krate))
+ if self.masked_crates.contains(&item.def_id.krate)
+ || i.trait_.def_id().map_or(false, |d| self.masked_crates.contains(&d.krate))
+ || i.for_.def_id().map_or(false, |d| self.masked_crates.contains(&d.krate))
{
return None;
}
@@ -252,15 +237,14 @@ impl<'a> DocFolder for CacheWrapper<'a> {
// Propagate a trait method's documentation to all implementors of the
// trait.
if let clean::TraitItem(ref t) = *item.kind {
- self.cache.traits.entry(item.def_id).or_insert_with(|| t.clone());
+ self.traits.entry(item.def_id).or_insert_with(|| t.clone());
}
// Collect all the implementors of traits.
if let clean::ImplItem(ref i) = *item.kind {
- if let Some(did) = i.trait_.def_id(&self.tmp_cache) {
+ if let Some(did) = i.trait_.def_id() {
if i.blanket_impl.is_none() {
- self.cache
- .implementors
+ self.implementors
.entry(did)
.or_default()
.push(Impl { impl_item: item.clone() });
@@ -273,7 +257,7 @@ impl<'a> DocFolder for CacheWrapper<'a> {
let (parent, is_inherent_impl_item) = match *item.kind {
clean::StrippedItem(..) => ((None, None), false),
clean::AssocConstItem(..) | clean::TypedefItem(_, true)
- if self.cache.parent_is_trait_impl =>
+ if self.parent_is_trait_impl =>
{
// skip associated items in trait impls
((None, None), false)
@@ -283,18 +267,18 @@ impl<'a> DocFolder for CacheWrapper<'a> {
| clean::StructFieldItem(..)
| clean::VariantItem(..) => (
(
- Some(*self.cache.parent_stack.last().expect("parent_stack is empty")),
- Some(&self.cache.stack[..self.cache.stack.len() - 1]),
+ Some(*self.parent_stack.last().expect("parent_stack is empty")),
+ Some(&self.stack[..self.stack.len() - 1]),
),
false,
),
clean::MethodItem(..) | clean::AssocConstItem(..) => {
- if self.cache.parent_stack.is_empty() {
+ if self.parent_stack.is_empty() {
((None, None), false)
} else {
- let last = self.cache.parent_stack.last().expect("parent_stack is empty 2");
+ let last = self.parent_stack.last().expect("parent_stack is empty 2");
let did = *last;
- let path = match self.cache.paths.get(&did) {
+ let path = match self.paths.get(&did) {
// The current stack not necessarily has correlation
// for where the type was defined. On the other
// hand, `paths` always has the right
@@ -306,24 +290,24 @@ impl<'a> DocFolder for CacheWrapper<'a> {
| ItemType::Union
| ItemType::Enum,
)) => Some(&fqp[..fqp.len() - 1]),
- Some(..) => Some(&*self.cache.stack),
+ Some(..) => Some(&*self.stack),
None => None,
};
((Some(*last), path), true)
}
}
- _ => ((None, Some(&*self.cache.stack)), false),
+ _ => ((None, Some(&*self.stack)), false),
};
match parent {
- (parent, Some(path)) if is_inherent_impl_item || !self.cache.stripped_mod => {
+ (parent, Some(path)) if is_inherent_impl_item || !self.stripped_mod => {
debug_assert!(!item.is_stripped());
// A crate has a module at its root, containing all items,
// which should not be indexed. The crate-item itself is
// inserted later on when serializing the search-index.
if item.def_id.index != CRATE_DEF_INDEX {
- self.cache.search_index.push(IndexItem {
+ self.search_index.push(IndexItem {
ty: item.type_(),
name: s.to_string(),
path: path.join("::"),
@@ -332,22 +316,21 @@ impl<'a> DocFolder for CacheWrapper<'a> {
.map_or_else(String::new, |x| short_markdown_summary(&x.as_str())),
parent,
parent_idx: None,
- search_type: get_index_search_type(&item, &self.tmp_cache),
+ search_type: get_index_search_type(&item, None),
});
for alias in item.attrs.get_doc_aliases() {
- self.cache
- .aliases
+ self.aliases
.entry(alias.to_lowercase())
.or_insert(Vec::new())
- .push(self.cache.search_index.len() - 1);
+ .push(self.search_index.len() - 1);
}
}
}
(Some(parent), None) if is_inherent_impl_item => {
// We have a parent, but we don't know where they're
// defined yet. Wait for later to index this item.
- self.cache.orphan_impl_items.push((parent, item.clone()));
+ self.orphan_impl_items.push((parent, item.clone()));
}
_ => {}
}
@@ -356,7 +339,7 @@ impl<'a> DocFolder for CacheWrapper<'a> {
// Keep track of the fully qualified path for this item.
let pushed = match item.name {
Some(n) if !n.is_empty() => {
- self.cache.stack.push(n.to_string());
+ self.stack.push(n.to_string());
true
}
_ => false,
@@ -378,7 +361,7 @@ impl<'a> DocFolder for CacheWrapper<'a> {
| clean::MacroItem(..)
| clean::ProcMacroItem(..)
| clean::VariantItem(..)
- if !self.cache.stripped_mod =>
+ if !self.stripped_mod =>
{
// Re-exported items mean that the same id can show up twice
// in the rustdoc ast that we're looking at. We know,
@@ -386,21 +369,21 @@ impl<'a> DocFolder for CacheWrapper<'a> {
// `public_items` map, so we can skip inserting into the
// paths map if there was already an entry present and we're
// not a public item.
- if !self.cache.paths.contains_key(&item.def_id)
- || self.cache.access_levels.is_public(item.def_id)
+ if !self.paths.contains_key(&item.def_id)
+ || self.access_levels.is_public(item.def_id)
{
- self.cache.paths.insert(item.def_id, (self.cache.stack.clone(), item.type_()));
+ self.paths.insert(item.def_id, (self.stack.clone(), item.type_()));
}
}
clean::PrimitiveItem(..) => {
- self.cache.paths.insert(item.def_id, (self.cache.stack.clone(), item.type_()));
+ self.paths.insert(item.def_id, (self.stack.clone(), item.type_()));
}
_ => {}
}
// Maintain the parent stack
- let orig_parent_is_trait_impl = self.cache.parent_is_trait_impl;
+ let orig_parent_is_trait_impl = self.parent_is_trait_impl;
let parent_pushed = match *item.kind {
clean::TraitItem(..)
| clean::EnumItem(..)
@@ -408,24 +391,24 @@ impl<'a> DocFolder for CacheWrapper<'a> {
| clean::StructItem(..)
| clean::UnionItem(..)
| clean::VariantItem(..) => {
- self.cache.parent_stack.push(item.def_id);
- self.cache.parent_is_trait_impl = false;
+ self.parent_stack.push(item.def_id);
+ self.parent_is_trait_impl = false;
true
}
clean::ImplItem(ref i) => {
- self.cache.parent_is_trait_impl = i.trait_.is_some();
+ self.parent_is_trait_impl = i.trait_.is_some();
match i.for_ {
clean::ResolvedPath { did, .. } => {
- self.cache.parent_stack.push(did);
+ self.parent_stack.push(did);
true
}
ref t => {
let prim_did = t
.primitive_type()
- .and_then(|t| self.cache.primitive_locations.get(&t).cloned());
+ .and_then(|t| self.primitive_locations.get(&t).cloned());
match prim_did {
Some(did) => {
- self.cache.parent_stack.push(did);
+ self.parent_stack.push(did);
true
}
None => false,
@@ -450,9 +433,8 @@ impl<'a> DocFolder for CacheWrapper<'a> {
dids.insert(did);
}
ref t => {
- let did = t
- .primitive_type()
- .and_then(|t| self.cache.primitive_locations.get(&t).cloned());
+ let did =
+ t.primitive_type().and_then(|t| self.primitive_locations.get(&t).cloned());
if let Some(did) = did {
dids.insert(did);
@@ -462,22 +444,19 @@ impl<'a> DocFolder for CacheWrapper<'a> {
if let Some(generics) = i.trait_.as_ref().and_then(|t| t.generics()) {
for bound in generics {
- if let Some(did) = bound.def_id(&self.tmp_cache) {
+ if let Some(did) = bound.def_id() {
dids.insert(did);
}
}
}
let impl_item = Impl { impl_item: item };
- if impl_item
- .trait_did(&self.tmp_cache)
- .map_or(true, |d| self.cache.traits.contains_key(&d))
- {
+ if impl_item.trait_did().map_or(true, |d| self.traits.contains_key(&d)) {
for did in dids {
- self.cache.impls.entry(did).or_insert(vec![]).push(impl_item.clone());
+ self.impls.entry(did).or_insert(vec![]).push(impl_item.clone());
}
} else {
- let trait_did = impl_item.trait_did(&self.tmp_cache).expect("no trait did");
- self.cache.orphan_trait_impls.push((trait_did, dids, impl_item));
+ let trait_did = impl_item.trait_did().expect("no trait did");
+ self.orphan_trait_impls.push((trait_did, dids, impl_item));
}
None
} else {
@@ -485,13 +464,13 @@ impl<'a> DocFolder for CacheWrapper<'a> {
};
if pushed {
- self.cache.stack.pop().expect("stack already empty");
+ self.stack.pop().expect("stack already empty");
}
if parent_pushed {
- self.cache.parent_stack.pop().expect("parent stack already empty");
+ self.parent_stack.pop().expect("parent stack already empty");
}
- self.cache.stripped_mod = orig_stripped_mod;
- self.cache.parent_is_trait_impl = orig_parent_is_trait_impl;
+ self.stripped_mod = orig_stripped_mod;
+ self.parent_is_trait_impl = orig_parent_is_trait_impl;
ret
}
}
diff --git a/src/librustdoc/formats/mod.rs b/src/librustdoc/formats/mod.rs
index 4d766af98feaf..1ce6572bbed04 100644
--- a/src/librustdoc/formats/mod.rs
+++ b/src/librustdoc/formats/mod.rs
@@ -39,7 +39,11 @@ impl Impl {
}
}
- crate fn trait_did(&self, cache: &Cache) -> Option {
- self.inner_impl().trait_.def_id(cache)
+ crate fn trait_did(&self) -> Option {
+ self.inner_impl().trait_.def_id()
+ }
+
+ crate fn trait_did_full(&self, cache: &Cache) -> Option {
+ self.inner_impl().trait_.def_id_full(cache)
}
}
diff --git a/src/librustdoc/html/render/cache.rs b/src/librustdoc/html/render/cache.rs
index a2fae03d87a2d..74a770b954853 100644
--- a/src/librustdoc/html/render/cache.rs
+++ b/src/librustdoc/html/render/cache.rs
@@ -78,7 +78,7 @@ crate fn build_index(krate: &clean::Crate, cache: &mut Cache) -> String {
desc: item.doc_value().map_or_else(String::new, |s| short_markdown_summary(&s)),
parent: Some(did),
parent_idx: None,
- search_type: get_index_search_type(&item, cache),
+ search_type: get_index_search_type(&item, Some(cache)),
});
for alias in item.attrs.get_doc_aliases() {
cache
@@ -164,7 +164,10 @@ crate fn build_index(krate: &clean::Crate, cache: &mut Cache) -> String {
)
}
-crate fn get_index_search_type(item: &clean::Item, cache: &Cache) -> Option {
+crate fn get_index_search_type(
+ item: &clean::Item,
+ cache: Option<&Cache>,
+) -> Option {
let (all_types, ret_types) = match *item.kind {
clean::FunctionItem(ref f) => (&f.all_types, &f.ret_types),
clean::MethodItem(ref m, _) => (&m.all_types, &m.ret_types),
@@ -174,12 +177,12 @@ crate fn get_index_search_type(item: &clean::Item, cache: &Cache) -> Option>();
let output = if output.is_empty() { None } else { Some(output) };
@@ -187,9 +190,9 @@ crate fn get_index_search_type(item: &clean::Item, cache: &Cache) -> Option RenderType {
+fn get_index_type(clean_type: &clean::Type, cache: &Option<&Cache>) -> RenderType {
RenderType {
- ty: clean_type.def_id(cache),
+ ty: cache.map_or_else(|| clean_type.def_id(), |cache| clean_type.def_id_full(cache)),
idx: None,
name: get_index_type_name(clean_type, true).map(|s| s.as_str().to_ascii_lowercase()),
generics: get_generics(clean_type, cache),
@@ -216,14 +219,14 @@ fn get_index_type_name(clean_type: &clean::Type, accept_generic: bool) -> Option
}
}
-fn get_generics(clean_type: &clean::Type, cache: &Cache) -> Option> {
+fn get_generics(clean_type: &clean::Type, cache: &Option<&Cache>) -> Option> {
clean_type.generics().and_then(|types| {
let r = types
.iter()
.filter_map(|t| {
get_index_type_name(t, false).map(|name| Generic {
name: name.as_str().to_ascii_lowercase(),
- defid: t.def_id(cache),
+ defid: cache.map_or_else(|| t.def_id(), |cache| t.def_id_full(cache)),
idx: None,
})
})
diff --git a/src/librustdoc/html/render/mod.rs b/src/librustdoc/html/render/mod.rs
index 88e61403ddbe6..f4ff1f3b6d55b 100644
--- a/src/librustdoc/html/render/mod.rs
+++ b/src/librustdoc/html/render/mod.rs
@@ -2515,7 +2515,7 @@ fn render_impls(
let mut impls = traits
.iter()
.map(|i| {
- let did = i.trait_did(cx.cache()).unwrap();
+ let did = i.trait_did_full(cx.cache()).unwrap();
let assoc_link = AssocItemLink::GotoSource(did, &i.inner_impl().provided_trait_methods);
let mut buffer = if w.is_for_html() { Buffer::html() } else { Buffer::new() };
render_impl(
@@ -2755,7 +2755,10 @@ fn item_trait(w: &mut Buffer, cx: &Context<'_>, it: &clean::Item, t: &clean::Tra
}
let (local, foreign) = implementors.iter().partition::, _>(|i| {
- i.inner_impl().for_.def_id(cx.cache()).map_or(true, |d| cx.cache.paths.contains_key(&d))
+ i.inner_impl()
+ .for_
+ .def_id_full(cx.cache())
+ .map_or(true, |d| cx.cache.paths.contains_key(&d))
});
let (mut synthetic, mut concrete): (Vec<&&Impl>, Vec<&&Impl>) =
@@ -3518,7 +3521,9 @@ fn render_assoc_items(
"deref-methods-{:#}",
type_.print(cx.cache())
)));
- cx.deref_id_map.borrow_mut().insert(type_.def_id(cx.cache()).unwrap(), id.clone());
+ cx.deref_id_map
+ .borrow_mut()
+ .insert(type_.def_id_full(cx.cache()).unwrap(), id.clone());
write!(
w,
"\
@@ -3553,11 +3558,11 @@ fn render_assoc_items(
if !traits.is_empty() {
let deref_impl = traits
.iter()
- .find(|t| t.inner_impl().trait_.def_id(cx.cache()) == cx.cache.deref_trait_did);
+ .find(|t| t.inner_impl().trait_.def_id_full(cx.cache()) == cx.cache.deref_trait_did);
if let Some(impl_) = deref_impl {
- let has_deref_mut = traits
- .iter()
- .any(|t| t.inner_impl().trait_.def_id(cx.cache()) == cx.cache.deref_mut_trait_did);
+ let has_deref_mut = traits.iter().any(|t| {
+ t.inner_impl().trait_.def_id_full(cx.cache()) == cx.cache.deref_mut_trait_did
+ });
render_deref_methods(w, cx, impl_, containing_item, has_deref_mut);
}
@@ -3636,8 +3641,8 @@ fn render_deref_methods(
.expect("Expected associated type binding");
let what =
AssocItemRender::DerefFor { trait_: deref_type, type_: real_target, deref_mut_: deref_mut };
- if let Some(did) = target.def_id(cx.cache()) {
- if let Some(type_did) = impl_.inner_impl().for_.def_id(cx.cache()) {
+ if let Some(did) = target.def_id_full(cx.cache()) {
+ if let Some(type_did) = impl_.inner_impl().for_.def_id_full(cx.cache()) {
// `impl Deref for S`
if did == type_did {
// Avoid infinite cycles
@@ -3684,11 +3689,11 @@ fn spotlight_decl(decl: &clean::FnDecl, c: &Cache) -> String {
let mut out = Buffer::html();
let mut trait_ = String::new();
- if let Some(did) = decl.output.def_id(c) {
+ if let Some(did) = decl.output.def_id_full(c) {
if let Some(impls) = c.impls.get(&did) {
for i in impls {
let impl_ = i.inner_impl();
- if impl_.trait_.def_id(c).map_or(false, |d| c.traits[&d].is_spotlight) {
+ if impl_.trait_.def_id_full(c).map_or(false, |d| c.traits[&d].is_spotlight) {
if out.is_empty() {
out.push_str(&format!(
"Notable traits for {}
\
@@ -3703,7 +3708,7 @@ fn spotlight_decl(decl: &clean::FnDecl, c: &Cache) -> String {
"{}",
impl_.print(c)
));
- let t_did = impl_.trait_.def_id(c).unwrap();
+ let t_did = impl_.trait_.def_id_full(c).unwrap();
for it in &impl_.items {
if let clean::TypedefItem(ref tydef, _) = *it.kind {
out.push_str(" ");
@@ -3754,7 +3759,7 @@ fn render_impl(
aliases: &[String],
) {
let traits = &cx.cache.traits;
- let trait_ = i.trait_did(cx.cache()).map(|did| &traits[&did]);
+ let trait_ = i.trait_did_full(cx.cache()).map(|did| &traits[&did]);
if render_mode == RenderMode::Normal {
let id = cx.derive_id(match i.inner_impl().trait_ {
@@ -3998,7 +4003,7 @@ fn render_impl(
if i.items.iter().any(|m| m.name == n) {
continue;
}
- let did = i.trait_.as_ref().unwrap().def_id(cx.cache()).unwrap();
+ let did = i.trait_.as_ref().unwrap().def_id_full(cx.cache()).unwrap();
let assoc_link = AssocItemLink::GotoSource(did, &i.provided_trait_methods);
doc_impl_item(
@@ -4309,7 +4314,7 @@ fn sidebar_assoc_items(cx: &Context<'_>, it: &clean::Item) -> String {
if let Some(impl_) = v
.iter()
.filter(|i| i.inner_impl().trait_.is_some())
- .find(|i| i.inner_impl().trait_.def_id(cx.cache()) == cx.cache.deref_trait_did)
+ .find(|i| i.inner_impl().trait_.def_id_full(cx.cache()) == cx.cache.deref_trait_did)
{
out.push_str(&sidebar_deref_methods(cx, impl_, v));
}
@@ -4396,9 +4401,9 @@ fn sidebar_deref_methods(cx: &Context<'_>, impl_: &Impl, v: &Vec) -> Strin
let deref_mut = v
.iter()
.filter(|i| i.inner_impl().trait_.is_some())
- .any(|i| i.inner_impl().trait_.def_id(cx.cache()) == c.deref_mut_trait_did);
+ .any(|i| i.inner_impl().trait_.def_id_full(cx.cache()) == c.deref_mut_trait_did);
let inner_impl = target
- .def_id(cx.cache())
+ .def_id_full(cx.cache())
.or_else(|| {
target.primitive_type().and_then(|prim| c.primitive_locations.get(&prim).cloned())
})
@@ -4414,7 +4419,7 @@ fn sidebar_deref_methods(cx: &Context<'_>, impl_: &Impl, v: &Vec) -> Strin
if !ret.is_empty() {
let deref_id_map = cx.deref_id_map.borrow();
let id = deref_id_map
- .get(&real_target.def_id(cx.cache()).unwrap())
+ .get(&real_target.def_id_full(cx.cache()).unwrap())
.expect("Deref section without derived id");
out.push_str(&format!(
"Methods from {}<Target={}>",
@@ -4429,14 +4434,14 @@ fn sidebar_deref_methods(cx: &Context<'_>, impl_: &Impl, v: &Vec) -> Strin
}
// Recurse into any further impls that might exist for `target`
- if let Some(target_did) = target.def_id(cx.cache()) {
+ if let Some(target_did) = target.def_id_full(cx.cache()) {
if let Some(target_impls) = c.impls.get(&target_did) {
if let Some(target_deref_impl) = target_impls
.iter()
.filter(|i| i.inner_impl().trait_.is_some())
- .find(|i| i.inner_impl().trait_.def_id(cx.cache()) == c.deref_trait_did)
+ .find(|i| i.inner_impl().trait_.def_id_full(cx.cache()) == c.deref_trait_did)
{
- if let Some(type_did) = impl_.inner_impl().for_.def_id(cx.cache()) {
+ if let Some(type_did) = impl_.inner_impl().for_.def_id_full(cx.cache()) {
// `impl Deref for S`
if target_did == type_did {
// Avoid infinite cycles
@@ -4580,7 +4585,7 @@ fn sidebar_trait(cx: &Context<'_>, buf: &mut Buffer, it: &clean::Item, t: &clean
.filter(|i| {
i.inner_impl()
.for_
- .def_id(cx.cache())
+ .def_id_full(cx.cache())
.map_or(false, |d| !cx.cache.paths.contains_key(&d))
})
.filter_map(|i| extract_for_impl_name(&i.impl_item, cx.cache()))
diff --git a/src/librustdoc/passes/collect_trait_impls.rs b/src/librustdoc/passes/collect_trait_impls.rs
index 9dc12737d6a86..7b5e9e5905f33 100644
--- a/src/librustdoc/passes/collect_trait_impls.rs
+++ b/src/librustdoc/passes/collect_trait_impls.rs
@@ -2,7 +2,6 @@ use super::Pass;
use crate::clean::*;
use crate::core::DocContext;
use crate::fold::DocFolder;
-use crate::formats::cache::Cache;
use rustc_data_structures::fx::{FxHashMap, FxHashSet};
use rustc_hir::def_id::{DefId, LOCAL_CRATE};
@@ -97,12 +96,12 @@ crate fn collect_trait_impls(krate: Crate, cx: &DocContext<'_>) -> Crate {
// Gather all type to `Deref` target edges.
for it in &new_items {
if let ImplItem(Impl { ref for_, ref trait_, ref items, .. }) = *it.kind {
- if trait_.def_id(&cx.cache) == cx.tcx.lang_items().deref_trait() {
+ if trait_.def_id() == cx.tcx.lang_items().deref_trait() {
let target = items.iter().find_map(|item| match *item.kind {
TypedefItem(ref t, true) => Some(&t.type_),
_ => None,
});
- if let (Some(for_did), Some(target)) = (for_.def_id(&cx.cache), target) {
+ if let (Some(for_did), Some(target)) = (for_.def_id(), target) {
type_did_to_deref_target.insert(for_did, target);
}
}
@@ -113,20 +112,19 @@ crate fn collect_trait_impls(krate: Crate, cx: &DocContext<'_>) -> Crate {
map: &FxHashMap,
cleaner: &mut BadImplStripper,
type_did: &DefId,
- cache: &Cache,
) {
if let Some(target) = map.get(type_did) {
debug!("add_deref_target: type {:?}, target {:?}", type_did, target);
if let Some(target_prim) = target.primitive_type() {
cleaner.prims.insert(target_prim);
- } else if let Some(target_did) = target.def_id(cache) {
+ } else if let Some(target_did) = target.def_id() {
// `impl Deref for S`
if target_did == *type_did {
// Avoid infinite cycles
return;
}
cleaner.items.insert(target_did);
- add_deref_target(map, cleaner, &target_did, cache);
+ add_deref_target(map, cleaner, &target_did);
}
}
}
@@ -135,14 +133,14 @@ crate fn collect_trait_impls(krate: Crate, cx: &DocContext<'_>) -> Crate {
// `Deref` target type and the impl for type positions, this map of types is keyed by
// `DefId` and for convenience uses a special cleaner that accepts `DefId`s directly.
if cleaner.keep_impl_with_def_id(type_did) {
- add_deref_target(&type_did_to_deref_target, &mut cleaner, type_did, &cx.cache);
+ add_deref_target(&type_did_to_deref_target, &mut cleaner, type_did);
}
}
new_items.retain(|it| {
if let ImplItem(Impl { ref for_, ref trait_, ref blanket_impl, .. }) = *it.kind {
- cleaner.keep_impl(for_, &cx.cache)
- || trait_.as_ref().map_or(false, |t| cleaner.keep_impl(t, &cx.cache))
+ cleaner.keep_impl(for_)
+ || trait_.as_ref().map_or(false, |t| cleaner.keep_impl(t))
|| blanket_impl.is_some()
} else {
true
@@ -218,13 +216,13 @@ struct BadImplStripper {
}
impl BadImplStripper {
- fn keep_impl(&self, ty: &Type, cache: &Cache) -> bool {
+ fn keep_impl(&self, ty: &Type) -> bool {
if let Generic(_) = ty {
// keep impls made on generics
true
} else if let Some(prim) = ty.primitive_type() {
self.prims.contains(&prim)
- } else if let Some(did) = ty.def_id(cache) {
+ } else if let Some(did) = ty.def_id() {
self.keep_impl_with_def_id(&did)
} else {
false
diff --git a/src/librustdoc/passes/strip_hidden.rs b/src/librustdoc/passes/strip_hidden.rs
index c67f7869f4baf..a276b7a63371b 100644
--- a/src/librustdoc/passes/strip_hidden.rs
+++ b/src/librustdoc/passes/strip_hidden.rs
@@ -15,7 +15,7 @@ crate const STRIP_HIDDEN: Pass = Pass {
};
/// Strip items marked `#[doc(hidden)]`
-crate fn strip_hidden(krate: clean::Crate, cx: &DocContext<'_>) -> clean::Crate {
+crate fn strip_hidden(krate: clean::Crate, _: &DocContext<'_>) -> clean::Crate {
let mut retained = DefIdSet::default();
// strip all #[doc(hidden)] items
@@ -25,7 +25,7 @@ crate fn strip_hidden(krate: clean::Crate, cx: &DocContext<'_>) -> clean::Crate
};
// strip all impls referencing stripped items
- let mut stripper = ImplStripper { retained: &retained, cache: &cx.cache };
+ let mut stripper = ImplStripper { retained: &retained };
stripper.fold_crate(krate)
}
diff --git a/src/librustdoc/passes/strip_private.rs b/src/librustdoc/passes/strip_private.rs
index 0ca4db83b7064..e812bcd87fe3c 100644
--- a/src/librustdoc/passes/strip_private.rs
+++ b/src/librustdoc/passes/strip_private.rs
@@ -30,6 +30,6 @@ crate fn strip_private(mut krate: clean::Crate, cx: &DocContext<'_>) -> clean::C
}
// strip all impls referencing private items
- let mut stripper = ImplStripper { retained: &retained, cache: &cx.cache };
+ let mut stripper = ImplStripper { retained: &retained };
stripper.fold_crate(krate)
}
diff --git a/src/librustdoc/passes/stripper.rs b/src/librustdoc/passes/stripper.rs
index 424928e2377b0..162b70973b418 100644
--- a/src/librustdoc/passes/stripper.rs
+++ b/src/librustdoc/passes/stripper.rs
@@ -4,7 +4,6 @@ use std::mem;
use crate::clean::{self, GetDefId, Item};
use crate::fold::{DocFolder, StripItem};
-use crate::formats::cache::Cache;
crate struct Stripper<'a> {
crate retained: &'a mut DefIdSet,
@@ -118,7 +117,6 @@ impl<'a> DocFolder for Stripper<'a> {
/// This stripper discards all impls which reference stripped items
crate struct ImplStripper<'a> {
crate retained: &'a DefIdSet,
- crate cache: &'a Cache,
}
impl<'a> DocFolder for ImplStripper<'a> {
@@ -128,13 +126,13 @@ impl<'a> DocFolder for ImplStripper<'a> {
if imp.trait_.is_none() && imp.items.is_empty() {
return None;
}
- if let Some(did) = imp.for_.def_id(&self.cache) {
+ if let Some(did) = imp.for_.def_id() {
if did.is_local() && !imp.for_.is_generic() && !self.retained.contains(&did) {
debug!("ImplStripper: impl item for stripped type; removing");
return None;
}
}
- if let Some(did) = imp.trait_.def_id(&self.cache) {
+ if let Some(did) = imp.trait_.def_id() {
if did.is_local() && !self.retained.contains(&did) {
debug!("ImplStripper: impl item for stripped trait; removing");
return None;
@@ -142,7 +140,7 @@ impl<'a> DocFolder for ImplStripper<'a> {
}
if let Some(generics) = imp.trait_.as_ref().and_then(|t| t.generics()) {
for typaram in generics {
- if let Some(did) = typaram.def_id(&self.cache) {
+ if let Some(did) = typaram.def_id() {
if did.is_local() && !self.retained.contains(&did) {
debug!(
"ImplStripper: stripped item in trait's generics; removing impl"
From 6a36b3f49d209a5321450d934f8a241d5cccbb0e Mon Sep 17 00:00:00 2001
From: Guillaume Gomez
Date: Thu, 21 Jan 2021 21:54:14 +0100
Subject: [PATCH 04/10] Apply review comments and improve code
---
src/librustdoc/clean/types.rs | 42 +++++++++++++----------------
src/librustdoc/html/render/cache.rs | 2 +-
2 files changed, 20 insertions(+), 24 deletions(-)
diff --git a/src/librustdoc/clean/types.rs b/src/librustdoc/clean/types.rs
index 1e3c3a23c9884..7f329511c3470 100644
--- a/src/librustdoc/clean/types.rs
+++ b/src/librustdoc/clean/types.rs
@@ -1410,34 +1410,30 @@ impl Type {
impl Type {
fn inner_def_id(&self, cache: Option<&Cache>) -> Option {
- fn inner(t: &T, cache: Option<&Cache>) -> Option {
- match cache {
- Some(c) => t.def_id_full(c),
- None => t.def_id(),
- }
- }
-
- match *self {
- ResolvedPath { did, .. } => Some(did),
- Primitive(p) => cache.and_then(|c| c.primitive_locations.get(&p).cloned()),
- BorrowedRef { type_: box Generic(..), .. } => {
- inner(&Primitive(PrimitiveType::Reference), cache)
- }
- BorrowedRef { ref type_, .. } => inner(&**type_, cache),
+ let t: &dyn GetDefId = match *self {
+ ResolvedPath { did, .. } => return Some(did),
+ Primitive(p) => return cache.and_then(|c| c.primitive_locations.get(&p).cloned()),
+ BorrowedRef { type_: box Generic(..), .. } => &Primitive(PrimitiveType::Reference),
+ BorrowedRef { ref type_, .. } => return type_.inner_def_id(cache),
Tuple(ref tys) => {
if tys.is_empty() {
- inner(&Primitive(PrimitiveType::Unit), cache)
+ &Primitive(PrimitiveType::Unit)
} else {
- inner(&Primitive(PrimitiveType::Tuple), cache)
+ &Primitive(PrimitiveType::Tuple)
}
}
- BareFunction(..) => inner(&Primitive(PrimitiveType::Fn), cache),
- Never => inner(&Primitive(PrimitiveType::Never), cache),
- Slice(..) => inner(&Primitive(PrimitiveType::Slice), cache),
- Array(..) => inner(&Primitive(PrimitiveType::Array), cache),
- RawPointer(..) => inner(&Primitive(PrimitiveType::RawPointer), cache),
- QPath { ref self_type, .. } => inner(&**self_type, cache),
- _ => None,
+ BareFunction(..) => &Primitive(PrimitiveType::Fn),
+ Never => &Primitive(PrimitiveType::Never),
+ Slice(..) => &Primitive(PrimitiveType::Slice),
+ Array(..) => &Primitive(PrimitiveType::Array),
+ RawPointer(..) => &Primitive(PrimitiveType::RawPointer),
+ QPath { ref self_type, .. } => return self_type.inner_def_id(cache),
+ // FIXME: remove this wildcard
+ _ => return None,
+ };
+ match cache {
+ Some(c) => t.def_id_full(c),
+ None => t.def_id(),
}
}
}
diff --git a/src/librustdoc/html/render/cache.rs b/src/librustdoc/html/render/cache.rs
index 74a770b954853..5c02be14181ed 100644
--- a/src/librustdoc/html/render/cache.rs
+++ b/src/librustdoc/html/render/cache.rs
@@ -78,7 +78,7 @@ crate fn build_index(krate: &clean::Crate, cache: &mut Cache) -> String {
desc: item.doc_value().map_or_else(String::new, |s| short_markdown_summary(&s)),
parent: Some(did),
parent_idx: None,
- search_type: get_index_search_type(&item, Some(cache)),
+ search_type: get_index_search_type(&item, None),
});
for alias in item.attrs.get_doc_aliases() {
cache
From d98a72c77bb4bbc58598a285446bde63b9b372c9 Mon Sep 17 00:00:00 2001
From: Guillaume Gomez
Date: Fri, 22 Jan 2021 21:17:32 +0100
Subject: [PATCH 05/10] Update to new rustdoc APIs
---
src/librustdoc/clean/types.rs | 1 -
src/librustdoc/formats/renderer.rs | 7 ++-----
src/librustdoc/html/render/mod.rs | 2 +-
src/librustdoc/json/mod.rs | 2 +-
4 files changed, 4 insertions(+), 8 deletions(-)
diff --git a/src/librustdoc/clean/types.rs b/src/librustdoc/clean/types.rs
index 7f329511c3470..46cdefb5a517f 100644
--- a/src/librustdoc/clean/types.rs
+++ b/src/librustdoc/clean/types.rs
@@ -37,7 +37,6 @@ use crate::clean::inline;
use crate::clean::types::Type::{QPath, ResolvedPath};
use crate::clean::Clean;
use crate::core::DocContext;
-use crate::doctree;
use crate::formats::cache::Cache;
use crate::formats::item_type::ItemType;
use crate::html::render::cache::ExternalLocation;
diff --git a/src/librustdoc/formats/renderer.rs b/src/librustdoc/formats/renderer.rs
index 65e2187e4aeab..6ecc4695dc8fb 100644
--- a/src/librustdoc/formats/renderer.rs
+++ b/src/librustdoc/formats/renderer.rs
@@ -1,4 +1,4 @@
-use rustc_middle::ty;
+use rustc_middle::ty::TyCtxt;
use rustc_span::edition::Edition;
use crate::clean;
@@ -21,7 +21,7 @@ crate trait FormatRenderer<'tcx>: Clone {
render_info: RenderInfo,
edition: Edition,
cache: Cache,
- tcx: ty::TyCtxt<'tcx>,
+ tcx: TyCtxt<'tcx>,
) -> Result<(Self, clean::Crate), Error>;
/// Renders a single non-module item. This means no recursive sub-item rendering is required.
@@ -69,9 +69,6 @@ crate fn run_format<'tcx, T: FormatRenderer<'tcx>>(
.extra_verbose_generic_activity("create_renderer", T::descr())
.run(|| T::init(krate, options, render_info, edition, cache, tcx))?;
- let (mut format_renderer, mut krate) =
- T::init(krate, options, render_info, edition, cache, tcx)?;
-
let mut item = match krate.module.take() {
Some(i) => i,
None => return Ok(()),
diff --git a/src/librustdoc/html/render/mod.rs b/src/librustdoc/html/render/mod.rs
index f4ff1f3b6d55b..187e0ec0106b3 100644
--- a/src/librustdoc/html/render/mod.rs
+++ b/src/librustdoc/html/render/mod.rs
@@ -394,7 +394,7 @@ impl<'tcx> FormatRenderer<'tcx> for Context<'tcx> {
_render_info: RenderInfo,
edition: Edition,
mut cache: Cache,
- tcx: ty::TyCtxt<'tcx>,
+ tcx: TyCtxt<'tcx>,
) -> Result<(Self, clean::Crate), Error> {
// need to save a copy of the options for rendering the index page
let md_opts = options.clone();
diff --git a/src/librustdoc/json/mod.rs b/src/librustdoc/json/mod.rs
index 6b19e9885c7a6..029e752df9f9d 100644
--- a/src/librustdoc/json/mod.rs
+++ b/src/librustdoc/json/mod.rs
@@ -136,7 +136,7 @@ impl<'tcx> FormatRenderer<'tcx> for JsonRenderer<'tcx> {
_render_info: RenderInfo,
_edition: Edition,
cache: Cache,
- tcx: ty::TyCtxt<'tcx>,
+ tcx: TyCtxt<'tcx>,
) -> Result<(Self, clean::Crate), Error> {
debug!("Initializing json renderer");
Ok((
From 522f48cb3fc5858a8be12e4c7f6b52829b289851 Mon Sep 17 00:00:00 2001
From: Guillaume Gomez
Date: Sat, 23 Jan 2021 23:45:54 +0100
Subject: [PATCH 06/10] Improve documentation on GetDefId trait's methods
---
src/librustdoc/clean/types.rs | 16 +++++++++++++---
1 file changed, 13 insertions(+), 3 deletions(-)
diff --git a/src/librustdoc/clean/types.rs b/src/librustdoc/clean/types.rs
index 46cdefb5a517f..f23d3df4a6363 100644
--- a/src/librustdoc/clean/types.rs
+++ b/src/librustdoc/clean/types.rs
@@ -1305,10 +1305,20 @@ crate enum TypeKind {
}
crate trait GetDefId {
- /// Doesn't retrieve primitive types `DefId`. Use `def_id_full` if you want it.
+ /// Use this method to get the [`DefId`] of a [`clean`] AST node.
+ /// This will return [`None`] when called on a primitive [`clean::Type`].
+ /// Use [`Self::def_id_full`] if you are calling it on a primitive [`clean::Type`].
+ ///
+ /// [`clean`]: crate::clean
+ /// [`clean::Type`]: Type
fn def_id(&self) -> Option;
- /// Retrieves all types' `DefId` (including primitives). If you're not interested about
- /// primitives, use `def_id`.
+
+ /// Use this method to get the [`DefId`] of a [`clean`] AST node that may be
+ /// a primitive [`clean::Type`].
+ ///
+ /// See [`Self::def_id`] for more.
+ ///
+ /// [`clean::Type`]: Type
fn def_id_full(&self, cache: &Cache) -> Option;
}
From 9a64180f0d51de5cb4aa3fe8b3f3d14be5ee103c Mon Sep 17 00:00:00 2001
From: Guillaume Gomez
Date: Sun, 24 Jan 2021 01:08:34 +0100
Subject: [PATCH 07/10] Unify cache usage and improve naming
---
src/librustdoc/html/render/mod.rs | 23 ++++++++++++-----------
1 file changed, 12 insertions(+), 11 deletions(-)
diff --git a/src/librustdoc/html/render/mod.rs b/src/librustdoc/html/render/mod.rs
index 187e0ec0106b3..c71b2b549e1f0 100644
--- a/src/librustdoc/html/render/mod.rs
+++ b/src/librustdoc/html/render/mod.rs
@@ -1144,7 +1144,7 @@ themePicker.onblur = handleThemeButtonsBlur;
Some(Implementor {
text: imp.inner_impl().print(cx.cache()).to_string(),
synthetic: imp.inner_impl().synthetic,
- types: collect_paths_for_type(imp.inner_impl().for_.clone(), &cx.cache),
+ types: collect_paths_for_type(imp.inner_impl().for_.clone(), cx.cache()),
})
}
})
@@ -2466,7 +2466,7 @@ fn item_function(w: &mut Buffer, cx: &Context<'_>, it: &clean::Item, f: &clean::
WhereClause { gens: &f.generics, indent: 0, end_newline: true }.print(cx.cache()),
decl = Function { decl: &f.decl, header_len, indent: 0, asyncness: f.header.asyncness }
.print(cx.cache()),
- spotlight = spotlight_decl(&f.decl, &cx.cache),
+ spotlight = spotlight_decl(&f.decl, cx.cache()),
);
document(w, cx, it, None)
}
@@ -3685,30 +3685,31 @@ fn should_render_item(item: &clean::Item, deref_mut_: bool, cache: &Cache) -> bo
}
}
-fn spotlight_decl(decl: &clean::FnDecl, c: &Cache) -> String {
+fn spotlight_decl(decl: &clean::FnDecl, cache: &Cache) -> String {
let mut out = Buffer::html();
let mut trait_ = String::new();
- if let Some(did) = decl.output.def_id_full(c) {
- if let Some(impls) = c.impls.get(&did) {
+ if let Some(did) = decl.output.def_id_full(cache) {
+ if let Some(impls) = cache.impls.get(&did) {
for i in impls {
let impl_ = i.inner_impl();
- if impl_.trait_.def_id_full(c).map_or(false, |d| c.traits[&d].is_spotlight) {
+ if impl_.trait_.def_id_full(cache).map_or(false, |d| cache.traits[&d].is_spotlight)
+ {
if out.is_empty() {
out.push_str(&format!(
"Notable traits for {}
\
",
- impl_.for_.print(c)
+ impl_.for_.print(cache)
));
- trait_.push_str(&impl_.for_.print(c).to_string());
+ trait_.push_str(&impl_.for_.print(cache).to_string());
}
//use the "where" class here to make it small
out.push_str(&format!(
"{}",
- impl_.print(c)
+ impl_.print(cache)
));
- let t_did = impl_.trait_.def_id_full(c).unwrap();
+ let t_did = impl_.trait_.def_id_full(cache).unwrap();
for it in &impl_.items {
if let clean::TypedefItem(ref tydef, _) = *it.kind {
out.push_str(" ");
@@ -3719,7 +3720,7 @@ fn spotlight_decl(decl: &clean::FnDecl, c: &Cache) -> String {
Some(&tydef.type_),
AssocItemLink::GotoSource(t_did, &FxHashSet::default()),
"",
- c,
+ cache,
);
out.push_str(";");
}
From cac238e4a3a838f9379b4c07d7463226929cf424 Mon Sep 17 00:00:00 2001
From: Guillaume Gomez
Date: Sun, 24 Jan 2021 17:41:21 +0100
Subject: [PATCH 08/10] More cleanup
---
src/librustdoc/clean/types.rs | 32 +++++++++++++------------------
src/librustdoc/html/render/mod.rs | 7 ++-----
src/librustdoc/json/mod.rs | 9 +++------
3 files changed, 18 insertions(+), 30 deletions(-)
diff --git a/src/librustdoc/clean/types.rs b/src/librustdoc/clean/types.rs
index f23d3df4a6363..7b5abc0335e27 100644
--- a/src/librustdoc/clean/types.rs
+++ b/src/librustdoc/clean/types.rs
@@ -1307,18 +1307,15 @@ crate enum TypeKind {
crate trait GetDefId {
/// Use this method to get the [`DefId`] of a [`clean`] AST node.
/// This will return [`None`] when called on a primitive [`clean::Type`].
- /// Use [`Self::def_id_full`] if you are calling it on a primitive [`clean::Type`].
+ /// Use [`Self::def_id_full`] if you want to include primitives.
///
/// [`clean`]: crate::clean
- /// [`clean::Type`]: Type
+ // FIXME: get rid of this function and always use `def_id_full`
fn def_id(&self) -> Option;
- /// Use this method to get the [`DefId`] of a [`clean`] AST node that may be
- /// a primitive [`clean::Type`].
+ /// Use this method to get the [DefId] of a [clean] AST node, including [PrimitiveType]s.
///
/// See [`Self::def_id`] for more.
- ///
- /// [`clean::Type`]: Type
fn def_id_full(&self, cache: &Cache) -> Option;
}
@@ -1419,31 +1416,28 @@ impl Type {
impl Type {
fn inner_def_id(&self, cache: Option<&Cache>) -> Option {
- let t: &dyn GetDefId = match *self {
+ let t: PrimitiveType = match *self {
ResolvedPath { did, .. } => return Some(did),
Primitive(p) => return cache.and_then(|c| c.primitive_locations.get(&p).cloned()),
- BorrowedRef { type_: box Generic(..), .. } => &Primitive(PrimitiveType::Reference),
+ BorrowedRef { type_: box Generic(..), .. } => PrimitiveType::Reference,
BorrowedRef { ref type_, .. } => return type_.inner_def_id(cache),
Tuple(ref tys) => {
if tys.is_empty() {
- &Primitive(PrimitiveType::Unit)
+ PrimitiveType::Unit
} else {
- &Primitive(PrimitiveType::Tuple)
+ PrimitiveType::Tuple
}
}
- BareFunction(..) => &Primitive(PrimitiveType::Fn),
- Never => &Primitive(PrimitiveType::Never),
- Slice(..) => &Primitive(PrimitiveType::Slice),
- Array(..) => &Primitive(PrimitiveType::Array),
- RawPointer(..) => &Primitive(PrimitiveType::RawPointer),
+ BareFunction(..) => PrimitiveType::Fn,
+ Never => PrimitiveType::Never,
+ Slice(..) => PrimitiveType::Slice,
+ Array(..) => PrimitiveType::Array,
+ RawPointer(..) => PrimitiveType::RawPointer,
QPath { ref self_type, .. } => return self_type.inner_def_id(cache),
// FIXME: remove this wildcard
_ => return None,
};
- match cache {
- Some(c) => t.def_id_full(c),
- None => t.def_id(),
- }
+ cache.and_then(|c| Primitive(t).def_id_full(c))
}
}
diff --git a/src/librustdoc/html/render/mod.rs b/src/librustdoc/html/render/mod.rs
index c71b2b549e1f0..bb9a7be590e87 100644
--- a/src/librustdoc/html/render/mod.rs
+++ b/src/librustdoc/html/render/mod.rs
@@ -2587,11 +2587,8 @@ fn item_trait(w: &mut Buffer, cx: &Context<'_>, it: &clean::Item, t: &clean::Tra
);
if !t.generics.where_predicates.is_empty() {
- write!(
- w,
- "{}",
- WhereClause { gens: &t.generics, indent: 0, end_newline: true }.print(cx.cache())
- );
+ let where_ = WhereClause { gens: &t.generics, indent: 0, end_newline: true };
+ write!(w, "{}", where_.print(cx.cache()));
} else {
write!(w, " ");
}
diff --git a/src/librustdoc/json/mod.rs b/src/librustdoc/json/mod.rs
index 029e752df9f9d..a8a4b74b818b6 100644
--- a/src/librustdoc/json/mod.rs
+++ b/src/librustdoc/json/mod.rs
@@ -41,8 +41,7 @@ impl JsonRenderer<'_> {
}
fn get_trait_implementors(&mut self, id: rustc_span::def_id::DefId) -> Vec {
- self.cache
- .clone()
+ Rc::clone(&self.cache)
.implementors
.get(&id)
.map(|implementors| {
@@ -59,8 +58,7 @@ impl JsonRenderer<'_> {
}
fn get_impls(&mut self, id: rustc_span::def_id::DefId) -> Vec {
- self.cache
- .clone()
+ Rc::clone(&self.cache)
.impls
.get(&id)
.map(|impls| {
@@ -81,8 +79,7 @@ impl JsonRenderer<'_> {
}
fn get_trait_items(&mut self) -> Vec<(types::Id, types::Item)> {
- self.cache
- .clone()
+ Rc::clone(&self.cache)
.traits
.iter()
.filter_map(|(&id, trait_item)| {
From 5f22b30ca6020720d2934c3ef850ea879a1419e3 Mon Sep 17 00:00:00 2001
From: Guillaume Gomez
Date: Sun, 24 Jan 2021 17:41:41 +0100
Subject: [PATCH 09/10] Add search index test for primitive types
---
src/test/rustdoc-js-std/primitive.js | 75 ++++++++++++++++++++++++++++
1 file changed, 75 insertions(+)
create mode 100644 src/test/rustdoc-js-std/primitive.js
diff --git a/src/test/rustdoc-js-std/primitive.js b/src/test/rustdoc-js-std/primitive.js
new file mode 100644
index 0000000000000..e5690383e4f0b
--- /dev/null
+++ b/src/test/rustdoc-js-std/primitive.js
@@ -0,0 +1,75 @@
+const QUERY = [
+ 'i8',
+ 'u32',
+ 'str',
+ 'char',
+ 'unit',
+ 'tuple',
+ 'fn',
+];
+
+const EXPECTED = [
+ {
+ 'others': [
+ {
+ 'path': 'std',
+ 'name': 'i8',
+ 'href': '../std/primitive.i8.html',
+ },
+ ]
+ },
+ {
+ 'others': [
+ {
+ 'path': 'std',
+ 'name': 'u32',
+ 'href': '../std/primitive.u32.html',
+ },
+ ]
+ },
+ {
+ 'others': [
+ {
+ 'path': 'std',
+ 'name': 'str',
+ 'href': '../std/primitive.str.html',
+ },
+ ]
+ },
+ {
+ 'others': [
+ {
+ 'path': 'std',
+ 'name': 'char',
+ 'href': '../std/primitive.char.html',
+ },
+ ]
+ },
+ {
+ 'others': [
+ {
+ 'path': 'std',
+ 'name': 'unit',
+ 'href': '../std/primitive.unit.html',
+ },
+ ]
+ },
+ {
+ 'others': [
+ {
+ 'path': 'std',
+ 'name': 'tuple',
+ 'href': '../std/primitive.tuple.html',
+ },
+ ]
+ },
+ {
+ 'others': [
+ {
+ 'path': 'std',
+ 'name': 'fn',
+ 'href': '../std/primitive.fn.html',
+ },
+ ]
+ },
+];
From d78e1ed623d0679f20bd12ae79f41629218ff916 Mon Sep 17 00:00:00 2001
From: Guillaume Gomez
Date: Tue, 26 Jan 2021 11:40:48 +0100
Subject: [PATCH 10/10] Fix clean/types doc links
---
src/librustdoc/clean/types.rs | 3 +++
1 file changed, 3 insertions(+)
diff --git a/src/librustdoc/clean/types.rs b/src/librustdoc/clean/types.rs
index 7b5abc0335e27..86bce8b8707a0 100644
--- a/src/librustdoc/clean/types.rs
+++ b/src/librustdoc/clean/types.rs
@@ -1310,12 +1310,15 @@ crate trait GetDefId {
/// Use [`Self::def_id_full`] if you want to include primitives.
///
/// [`clean`]: crate::clean
+ /// [`clean::Type`]: crate::clean::Type
// FIXME: get rid of this function and always use `def_id_full`
fn def_id(&self) -> Option;
/// Use this method to get the [DefId] of a [clean] AST node, including [PrimitiveType]s.
///
/// See [`Self::def_id`] for more.
+ ///
+ /// [clean]: crate::clean
fn def_id_full(&self, cache: &Cache) -> Option;
}