bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Fix bugs; fix and add tests

Browse source
This commit is contained in:
Camelid 2020-12-25 15:38:46 -08:00
parent d3f4c48b49
commit 50c1c27fa6
8 changed files with 110 additions and 87 deletions
Download patch file Download diff file Expand all files Collapse all files

10
src/librustdoc/clean/mod.rs
View file

@ -2299,14 +2299,20 @@ impl Clean<Item> for (&hir::MacroDef<'_>, Option<Symbol>) {
if matchers.len() <= 1 { if matchers.len() <= 1 {
format!( format!(
"{}macro {}{} {{\n ...\n}}", "{}macro {}{} {{\n ...\n}}",
vis.print_with_space(cx.tcx, item.hir_id.owner), vis.print_with_space(
cx.tcx,
cx.tcx.hir().local_def_id(item.hir_id).to_def_id()
),
name, name,
matchers.iter().map(|span| span.to_src(cx)).collect::<String>(), matchers.iter().map(|span| span.to_src(cx)).collect::<String>(),
) )
} else { } else {
format!( format!(
"{}macro {} {{\n{}}}", "{}macro {} {{\n{}}}",
vis.print_with_space(cx.tcx, item.hir_id.owner), vis.print_with_space(
cx.tcx,
cx.tcx.hir().local_def_id(item.hir_id).to_def_id()
),
name, name,
matchers matchers
.iter() .iter()

24
src/librustdoc/clean/utils.rs
View file

@ -15,7 +15,7 @@ use rustc_hir::def::{DefKind, Res};
use rustc_hir::def_id::{DefId, LOCAL_CRATE}; use rustc_hir::def_id::{DefId, LOCAL_CRATE};
use rustc_middle::mir::interpret::ConstValue; use rustc_middle::mir::interpret::ConstValue;
use rustc_middle::ty::subst::{GenericArgKind, SubstsRef}; use rustc_middle::ty::subst::{GenericArgKind, SubstsRef};
use rustc_middle::ty::{self, DefIdTree, Ty}; use rustc_middle::ty::{self, DefIdTree, Ty, TyCtxt};
use rustc_span::symbol::{kw, sym, Symbol}; use rustc_span::symbol::{kw, sym, Symbol};
use std::mem; use std::mem;
@ -624,3 +624,25 @@ where
*cx.impl_trait_bounds.borrow_mut() = old_bounds; *cx.impl_trait_bounds.borrow_mut() = old_bounds;
r r
} }
crate fn find_closest_parent_module(tcx: TyCtxt<'_>, def_id: DefId) -> Option<DefId> {
let mut current = def_id;
// The immediate parent might not always be a module.
// Find the first parent which is.
loop {
if let Some(parent) = tcx.parent(current) {
if tcx.def_kind(parent) == DefKind::Mod {
break Some(parent);
}
current = parent;
} else {
debug!(
"{:?} has no parent (kind={:?}, original was {:?})",
current,
tcx.def_kind(current),
def_id
);
break None;
}
}
}

56
src/librustdoc/html/format.rs
View file

@ -12,10 +12,10 @@ use std::fmt;
use rustc_data_structures::fx::FxHashSet; use rustc_data_structures::fx::FxHashSet;
use rustc_hir as hir; use rustc_hir as hir;
use rustc_middle::ty::TyCtxt; use rustc_middle::ty::TyCtxt;
use rustc_span::def_id::{DefId, LocalDefId, CRATE_DEF_INDEX}; use rustc_span::def_id::{DefId, CRATE_DEF_INDEX};
use rustc_target::spec::abi::Abi; use rustc_target::spec::abi::Abi;
use crate::clean::{self, PrimitiveType}; use crate::clean::{self, utils::find_closest_parent_module, PrimitiveType};
use crate::formats::cache::cache; use crate::formats::cache::cache;
use crate::formats::item_type::ItemType; use crate::formats::item_type::ItemType;
use crate::html::escape::Escape; use crate::html::escape::Escape;
@ -1088,38 +1088,40 @@ impl clean::Visibility {
crate fn print_with_space<'tcx>( crate fn print_with_space<'tcx>(
self, self,
tcx: TyCtxt<'tcx>, tcx: TyCtxt<'tcx>,
item_did: LocalDefId, item_did: DefId,
) -> impl fmt::Display + 'tcx { ) -> impl fmt::Display + 'tcx {
use rustc_span::symbol::kw; use rustc_span::symbol::kw;
display_fn(move |f| match self { display_fn(move |f| match self {
clean::Public => f.write_str("pub "), clean::Public => f.write_str("pub "),
clean::Inherited => Ok(()), clean::Inherited => Ok(()),
clean::Visibility::Restricted(did)
if did.index == tcx.parent_module_from_def_id(item_did).local_def_index => clean::Visibility::Restricted(vis_did) => {
{ if find_closest_parent_module(tcx, item_did) == Some(vis_did) {
Ok(()) // `pub(in foo)` where `foo` is the parent module
} // is the same as no visibility modifier
clean::Visibility::Restricted(did) if did.index == CRATE_DEF_INDEX => { Ok(())
write!(f, "pub(crate) ") } else if vis_did.index == CRATE_DEF_INDEX {
} write!(f, "pub(crate) ")
clean::Visibility::Restricted(did) => { } else {
f.write_str("pub(")?; f.write_str("pub(")?;
let path = tcx.def_path(did); let path = tcx.def_path(vis_did);
debug!("path={:?}", path); debug!("path={:?}", path);
let first_name = let first_name =
path.data[0].data.get_opt_name().expect("modules are always named"); path.data[0].data.get_opt_name().expect("modules are always named");
if path.data.len() != 1 || (first_name != kw::SelfLower && first_name != kw::Super) if path.data.len() != 1
{ || (first_name != kw::SelfLower && first_name != kw::Super)
f.write_str("in ")?; {
f.write_str("in ")?;
}
// modified from `resolved_path()` to work with `DefPathData`
let last_name = path.data.last().unwrap().data.get_opt_name().unwrap();
for seg in &path.data[..path.data.len() - 1] {
write!(f, "{}::", seg.data.get_opt_name().unwrap())?;
}
let path = anchor(vis_did, &last_name.as_str()).to_string();
write!(f, "{}) ", path)
} }
// modified from `resolved_path()` to work with `DefPathData`
let last_name = path.data.last().unwrap().data.get_opt_name().unwrap();
for seg in &path.data[..path.data.len() - 1] {
write!(f, "{}::", seg.data.get_opt_name().unwrap())?;
}
let path = anchor(did, &last_name.as_str()).to_string();
write!(f, "{}) ", path)
} }
}) })
} }

38
src/librustdoc/html/render/mod.rs
View file

@ -2157,14 +2157,14 @@ fn item_module(w: &mut Buffer, cx: &Context<'_>, item: &clean::Item, items: &[cl
Some(ref src) => write!( Some(ref src) => write!(
w, w,
"<tr><td><code>{}extern crate {} as {};", "<tr><td><code>{}extern crate {} as {};",
myitem.visibility.print_with_space(cx.tcx(), myitem.def_id.expect_local()), myitem.visibility.print_with_space(cx.tcx(), myitem.def_id),
anchor(myitem.def_id, &*src.as_str()), anchor(myitem.def_id, &*src.as_str()),
name name
), ),
None => write!( None => write!(
w, w,
"<tr><td><code>{}extern crate {};", "<tr><td><code>{}extern crate {};",
myitem.visibility.print_with_space(cx.tcx(), myitem.def_id.expect_local()), myitem.visibility.print_with_space(cx.tcx(), myitem.def_id),
anchor(myitem.def_id, &*name.as_str()) anchor(myitem.def_id, &*name.as_str())
), ),
} }
@ -2175,7 +2175,7 @@ fn item_module(w: &mut Buffer, cx: &Context<'_>, item: &clean::Item, items: &[cl
write!( write!(
w, w,
"<tr><td><code>{}{}</code></td></tr>", "<tr><td><code>{}{}</code></td></tr>",
myitem.visibility.print_with_space(cx.tcx(), myitem.def_id.expect_local()), myitem.visibility.print_with_space(cx.tcx(), myitem.def_id),
import.print() import.print()
); );
} }
@ -2392,7 +2392,7 @@ fn item_constant(w: &mut Buffer, cx: &Context<'_>, it: &clean::Item, c: &clean::
write!( write!(
w, w,
"{vis}const {name}: {typ}", "{vis}const {name}: {typ}",
vis = it.visibility.print_with_space(cx.tcx(), it.def_id.expect_local()), vis = it.visibility.print_with_space(cx.tcx(), it.def_id),
name = it.name.as_ref().unwrap(), name = it.name.as_ref().unwrap(),
typ = c.type_.print(), typ = c.type_.print(),
); );
@ -2426,7 +2426,7 @@ fn item_static(w: &mut Buffer, cx: &Context<'_>, it: &clean::Item, s: &clean::St
write!( write!(
w, w,
"{vis}static {mutability}{name}: {typ}</pre>", "{vis}static {mutability}{name}: {typ}</pre>",
vis = it.visibility.print_with_space(cx.tcx(), it.def_id.expect_local()), vis = it.visibility.print_with_space(cx.tcx(), it.def_id),
mutability = s.mutability.print_with_space(), mutability = s.mutability.print_with_space(),
name = it.name.as_ref().unwrap(), name = it.name.as_ref().unwrap(),
typ = s.type_.print() typ = s.type_.print()
@ -2437,7 +2437,7 @@ fn item_static(w: &mut Buffer, cx: &Context<'_>, it: &clean::Item, s: &clean::St
fn item_function(w: &mut Buffer, cx: &Context<'_>, it: &clean::Item, f: &clean::Function) { fn item_function(w: &mut Buffer, cx: &Context<'_>, it: &clean::Item, f: &clean::Function) {
let header_len = format!( let header_len = format!(
"{}{}{}{}{:#}fn {}{:#}", "{}{}{}{}{:#}fn {}{:#}",
it.visibility.print_with_space(cx.tcx(), it.def_id.expect_local()), it.visibility.print_with_space(cx.tcx(), it.def_id),
f.header.constness.print_with_space(), f.header.constness.print_with_space(),
f.header.asyncness.print_with_space(), f.header.asyncness.print_with_space(),
f.header.unsafety.print_with_space(), f.header.unsafety.print_with_space(),
@ -2452,7 +2452,7 @@ fn item_function(w: &mut Buffer, cx: &Context<'_>, it: &clean::Item, f: &clean::
w, w,
"{vis}{constness}{asyncness}{unsafety}{abi}fn \ "{vis}{constness}{asyncness}{unsafety}{abi}fn \
{name}{generics}{decl}{spotlight}{where_clause}</pre>", {name}{generics}{decl}{spotlight}{where_clause}</pre>",
vis = it.visibility.print_with_space(cx.tcx(), it.def_id.expect_local()), vis = it.visibility.print_with_space(cx.tcx(), it.def_id),
constness = f.header.constness.print_with_space(), constness = f.header.constness.print_with_space(),
asyncness = f.header.asyncness.print_with_space(), asyncness = f.header.asyncness.print_with_space(),
unsafety = f.header.unsafety.print_with_space(), unsafety = f.header.unsafety.print_with_space(),
@ -2578,7 +2578,7 @@ fn item_trait(w: &mut Buffer, cx: &Context<'_>, it: &clean::Item, t: &clean::Tra
write!( write!(
w, w,
"{}{}{}trait {}{}{}", "{}{}{}trait {}{}{}",
it.visibility.print_with_space(cx.tcx(), it.def_id.expect_local()), it.visibility.print_with_space(cx.tcx(), it.def_id),
t.unsafety.print_with_space(), t.unsafety.print_with_space(),
if t.is_auto { "auto " } else { "" }, if t.is_auto { "auto " } else { "" },
it.name.as_ref().unwrap(), it.name.as_ref().unwrap(),
@ -2896,7 +2896,7 @@ fn assoc_const(
w, w,
"{}{}const <a href=\"{}\" class=\"constant\"><b>{}</b></a>: {}", "{}{}const <a href=\"{}\" class=\"constant\"><b>{}</b></a>: {}",
extra, extra,
it.visibility.print_with_space(cx.tcx(), it.def_id.expect_local()), it.visibility.print_with_space(cx.tcx(), it.def_id),
naive_assoc_href(it, link), naive_assoc_href(it, link),
it.name.as_ref().unwrap(), it.name.as_ref().unwrap(),
ty.print() ty.print()
@ -3015,7 +3015,7 @@ fn render_assoc_item(
}; };
let mut header_len = format!( let mut header_len = format!(
"{}{}{}{}{}{:#}fn {}{:#}", "{}{}{}{}{}{:#}fn {}{:#}",
meth.visibility.print_with_space(cx.tcx(), meth.def_id.expect_local()), meth.visibility.print_with_space(cx.tcx(), meth.def_id),
header.constness.print_with_space(), header.constness.print_with_space(),
header.asyncness.print_with_space(), header.asyncness.print_with_space(),
header.unsafety.print_with_space(), header.unsafety.print_with_space(),
@ -3037,7 +3037,7 @@ fn render_assoc_item(
"{}{}{}{}{}{}{}fn <a href=\"{href}\" class=\"fnname\">{name}</a>\ "{}{}{}{}{}{}{}fn <a href=\"{href}\" class=\"fnname\">{name}</a>\
{generics}{decl}{spotlight}{where_clause}", {generics}{decl}{spotlight}{where_clause}",
if parent == ItemType::Trait { " " } else { "" }, if parent == ItemType::Trait { " " } else { "" },
meth.visibility.print_with_space(cx.tcx(), meth.def_id.expect_local()), meth.visibility.print_with_space(cx.tcx(), meth.def_id),
header.constness.print_with_space(), header.constness.print_with_space(),
header.asyncness.print_with_space(), header.asyncness.print_with_space(),
header.unsafety.print_with_space(), header.unsafety.print_with_space(),
@ -3189,7 +3189,7 @@ fn item_enum(w: &mut Buffer, cx: &Context<'_>, it: &clean::Item, e: &clean::Enum
write!( write!(
w, w,
"{}enum {}{}{}", "{}enum {}{}{}",
it.visibility.print_with_space(cx.tcx(), it.def_id.expect_local()), it.visibility.print_with_space(cx.tcx(), it.def_id),
it.name.as_ref().unwrap(), it.name.as_ref().unwrap(),
e.generics.print(), e.generics.print(),
WhereClause { gens: &e.generics, indent: 0, end_newline: true } WhereClause { gens: &e.generics, indent: 0, end_newline: true }
@ -3364,7 +3364,7 @@ fn render_struct(
write!( write!(
w, w,
"{}{}{}", "{}{}{}",
it.visibility.print_with_space(cx.tcx(), it.def_id.expect_local()), it.visibility.print_with_space(cx.tcx(), it.def_id),
if structhead { "struct " } else { "" }, if structhead { "struct " } else { "" },
it.name.as_ref().unwrap() it.name.as_ref().unwrap()
); );
@ -3384,7 +3384,7 @@ fn render_struct(
w, w,
"\n{} {}{}: {},", "\n{} {}{}: {},",
tab, tab,
field.visibility.print_with_space(cx.tcx(), field.def_id.expect_local()), field.visibility.print_with_space(cx.tcx(), field.def_id),
field.name.as_ref().unwrap(), field.name.as_ref().unwrap(),
ty.print() ty.print()
); );
@ -3416,9 +3416,7 @@ fn render_struct(
write!( write!(
w, w,
"{}{}", "{}{}",
field field.visibility.print_with_space(cx.tcx(), field.def_id),
.visibility
.print_with_space(cx.tcx(), field.def_id.expect_local()),
ty.print() ty.print()
) )
} }
@ -3453,7 +3451,7 @@ fn render_union(
write!( write!(
w, w,
"{}{}{}", "{}{}{}",
it.visibility.print_with_space(cx.tcx(), it.def_id.expect_local()), it.visibility.print_with_space(cx.tcx(), it.def_id),
if structhead { "union " } else { "" }, if structhead { "union " } else { "" },
it.name.as_ref().unwrap() it.name.as_ref().unwrap()
); );
@ -3468,7 +3466,7 @@ fn render_union(
write!( write!(
w, w,
" {}{}: {},\n{}", " {}{}: {},\n{}",
field.visibility.print_with_space(cx.tcx(), field.def_id.expect_local()), field.visibility.print_with_space(cx.tcx(), field.def_id),
field.name.as_ref().unwrap(), field.name.as_ref().unwrap(),
ty.print(), ty.print(),
tab tab
@ -4107,7 +4105,7 @@ fn item_foreign_type(w: &mut Buffer, cx: &Context<'_>, it: &clean::Item, cache:
write!( write!(
w, w,
" {}type {};\n}}</pre>", " {}type {};\n}}</pre>",
it.visibility.print_with_space(cx.tcx(), it.def_id.expect_local()), it.visibility.print_with_space(cx.tcx(), it.def_id),
it.name.as_ref().unwrap(), it.name.as_ref().unwrap(),
); );

22
src/librustdoc/passes/collect_intra_doc_links.rs
View file

@ -31,7 +31,7 @@ use std::cell::Cell;
use std::mem; use std::mem;
use std::ops::Range; use std::ops::Range;
use crate::clean::{self, Crate, Item, ItemLink, PrimitiveType}; use crate::clean::{self, utils::find_closest_parent_module, Crate, Item, ItemLink, PrimitiveType};
use crate::core::DocContext; use crate::core::DocContext;
use crate::fold::DocFolder; use crate::fold::DocFolder;
use crate::html::markdown::markdown_links; use crate::html::markdown::markdown_links;
@ -774,25 +774,7 @@ impl<'a, 'tcx> DocFolder for LinkCollector<'a, 'tcx> {
} else if item.def_id.is_top_level_module() { } else if item.def_id.is_top_level_module() {
Some(item.def_id) Some(item.def_id)
} else { } else {
let mut current = item.def_id; find_closest_parent_module(self.cx.tcx, item.def_id)
// The immediate parent might not always be a module.
// Find the first parent which is.
loop {
if let Some(parent) = self.cx.tcx.parent(current) {
if self.cx.tcx.def_kind(parent) == DefKind::Mod {
break Some(parent);
}
current = parent;
} else {
debug!(
"{:?} has no parent (kind={:?}, original was {:?})",
current,
self.cx.tcx.def_kind(current),
item.def_id
);
break None;
}
}
}; };
if parent_node.is_some() { if parent_node.is_some() {

2
src/test/rustdoc/decl_macro_priv.rs
View file

@ -2,7 +2,7 @@
#![feature(decl_macro)] #![feature(decl_macro)]
// @has decl_macro_priv/macro.crate_macro.html //pre 'pub(crate) macro crate_macro() {' // @has decl_macro_priv/macro.crate_macro.html //pre 'macro crate_macro() {'
// @has - //pre '...' // @has - //pre '...'
// @has - //pre '}' // @has - //pre '}'
pub(crate) macro crate_macro() {} pub(crate) macro crate_macro() {}

32
src/test/rustdoc/pub-restricted.rs
View file

@ -6,27 +6,27 @@
// @has 'foo/struct.FooPublic.html' '//pre' 'pub struct FooPublic' // @has 'foo/struct.FooPublic.html' '//pre' 'pub struct FooPublic'
pub struct FooPublic; pub struct FooPublic;
// @has 'foo/struct.FooJustCrate.html' '//pre' 'pub(crate) struct FooJustCrate' // @has 'foo/struct.FooJustCrate.html' '//pre' 'struct FooJustCrate'
crate struct FooJustCrate; crate struct FooJustCrate;
// @has 'foo/struct.FooPubCrate.html' '//pre' 'pub(crate) struct FooPubCrate' // @has 'foo/struct.FooPubCrate.html' '//pre' 'struct FooPubCrate'
pub(crate) struct FooPubCrate; pub(crate) struct FooPubCrate;
// @has 'foo/struct.FooSelf.html' '//pre' 'pub(crate) struct FooSelf' // @has 'foo/struct.FooSelf.html' '//pre' 'struct FooSelf'
pub(self) struct FooSelf; pub(self) struct FooSelf;
// @has 'foo/struct.FooInSelf.html' '//pre' 'pub(crate) struct FooInSelf' // @has 'foo/struct.FooInSelf.html' '//pre' 'struct FooInSelf'
pub(in self) struct FooInSelf; pub(in self) struct FooInSelf;
mod a { mod a {
// @has 'foo/a/struct.FooSuper.html' '//pre' 'pub(crate) struct FooSuper' // @has 'foo/a/struct.FooASuper.html' '//pre' 'pub(crate) struct FooASuper'
pub(super) struct FooSuper; pub(super) struct FooASuper;
// @has 'foo/a/struct.FooInSuper.html' '//pre' 'pub(crate) struct FooInSuper' // @has 'foo/a/struct.FooAInSuper.html' '//pre' 'pub(crate) struct FooAInSuper'
pub(in super) struct FooInSuper; pub(in super) struct FooAInSuper;
// @has 'foo/a/struct.FooInA.html' '//pre' 'pub(in a) struct FooInA' // @has 'foo/a/struct.FooAInA.html' '//pre' 'struct FooAInA'
pub(in a) struct FooInA; pub(in a) struct FooAInA;
mod b { mod b {
// @has 'foo/a/b/struct.FooInSelfSuperB.html' '//pre' 'pub(in a::b) struct FooInSelfSuperB' // @has 'foo/a/b/struct.FooBSuper.html' '//pre' 'pub(super) struct FooBSuper'
pub(in a::b) struct FooInSelfSuperB; pub(super) struct FooBSuper;
// @has 'foo/a/b/struct.FooInSuperSuper.html' '//pre' 'pub(crate) struct FooInSuperSuper' // @has 'foo/a/b/struct.FooBInSuperSuper.html' '//pre' 'pub(crate) struct FooBInSuperSuper'
pub(in super::super) struct FooInSuperSuper; pub(in super::super) struct FooBInSuperSuper;
// @has 'foo/a/b/struct.FooInAB.html' '//pre' 'pub(in a::b) struct FooInAB' // @has 'foo/a/b/struct.FooBInAB.html' '//pre' 'struct FooBInAB'
pub(in a::b) struct FooInAB; pub(in a::b) struct FooBInAB;
} }
} }

13
src/test/rustdoc/visibility.rs Normal file
View file

@ -0,0 +1,13 @@
// compile-flags: --document-private-items
#![crate_name = "foo"]
// @has 'foo/fn.foo.html' '//pre' 'fn foo'
// !@has 'foo/fn.foo.html' '//pre' 'pub'
fn foo() {}
mod bar {
// @has 'foo/bar/fn.baz.html' '//pre' 'fn baz'
// !@has 'foo/bar/fn.baz.html' '//pre' 'pub'
fn baz() {}
}