mirror of https://github.com/rust-lang/rust.git
Auto merge of #107000 - GuillaumeGomez:fix-items-in-doc-hidden-block, r=notriddle,petrochenkov
Fix handling of items inside a `doc(hidden)` block Fixes #106373. cc `@aDotInTheVoid` r? `@notriddle`
This commit is contained in:
commit
6c991b0740
|
@ -2213,21 +2213,17 @@ fn clean_maybe_renamed_item<'tcx>(
|
||||||
get_all_import_attributes(use_node, cx.tcx, item.owner_id.def_id, &mut extra_attrs);
|
get_all_import_attributes(use_node, cx.tcx, item.owner_id.def_id, &mut extra_attrs);
|
||||||
}
|
}
|
||||||
|
|
||||||
if !extra_attrs.is_empty() {
|
let mut item = if !extra_attrs.is_empty() {
|
||||||
extra_attrs.extend_from_slice(inline::load_attrs(cx, def_id));
|
extra_attrs.extend_from_slice(inline::load_attrs(cx, def_id));
|
||||||
let attrs = Attributes::from_ast(&extra_attrs);
|
let attrs = Attributes::from_ast(&extra_attrs);
|
||||||
let cfg = extra_attrs.cfg(cx.tcx, &cx.cache.hidden_cfg);
|
let cfg = extra_attrs.cfg(cx.tcx, &cx.cache.hidden_cfg);
|
||||||
|
|
||||||
vec![Item::from_def_id_and_attrs_and_parts(
|
Item::from_def_id_and_attrs_and_parts(def_id, Some(name), kind, Box::new(attrs), cfg)
|
||||||
def_id,
|
|
||||||
Some(name),
|
|
||||||
kind,
|
|
||||||
Box::new(attrs),
|
|
||||||
cfg,
|
|
||||||
)]
|
|
||||||
} else {
|
} else {
|
||||||
vec![Item::from_def_id_and_parts(def_id, Some(name), kind, cx)]
|
Item::from_def_id_and_parts(def_id, Some(name), kind, cx)
|
||||||
}
|
};
|
||||||
|
item.inline_stmt_id = import_id.map(|def_id| def_id.to_def_id());
|
||||||
|
vec![item]
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -138,7 +138,7 @@ pub(super) fn write_shared(
|
||||||
Ok((ret, krates))
|
Ok((ret, krates))
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Read a file and return all lines that match the <code>"{crate}":{data},\</code> format,
|
/// Read a file and return all lines that match the <code>"{crate}":{data},\ </code> format,
|
||||||
/// and return a tuple `(Vec<DataString>, Vec<CrateNameString>)`.
|
/// and return a tuple `(Vec<DataString>, Vec<CrateNameString>)`.
|
||||||
///
|
///
|
||||||
/// This forms the payload of files that look like this:
|
/// This forms the payload of files that look like this:
|
||||||
|
|
|
@ -1,4 +1,6 @@
|
||||||
//! Strip all doc(hidden) items from the output.
|
//! Strip all doc(hidden) items from the output.
|
||||||
|
|
||||||
|
use rustc_middle::ty::TyCtxt;
|
||||||
use rustc_span::symbol::sym;
|
use rustc_span::symbol::sym;
|
||||||
use std::mem;
|
use std::mem;
|
||||||
|
|
||||||
|
@ -7,6 +9,7 @@ use crate::clean::{Item, ItemIdSet, NestedAttributesExt};
|
||||||
use crate::core::DocContext;
|
use crate::core::DocContext;
|
||||||
use crate::fold::{strip_item, DocFolder};
|
use crate::fold::{strip_item, DocFolder};
|
||||||
use crate::passes::{ImplStripper, Pass};
|
use crate::passes::{ImplStripper, Pass};
|
||||||
|
use crate::visit_ast::inherits_doc_hidden;
|
||||||
|
|
||||||
pub(crate) const STRIP_HIDDEN: Pass = Pass {
|
pub(crate) const STRIP_HIDDEN: Pass = Pass {
|
||||||
name: "strip-hidden",
|
name: "strip-hidden",
|
||||||
|
@ -21,7 +24,12 @@ pub(crate) fn strip_hidden(krate: clean::Crate, cx: &mut DocContext<'_>) -> clea
|
||||||
|
|
||||||
// strip all #[doc(hidden)] items
|
// strip all #[doc(hidden)] items
|
||||||
let krate = {
|
let krate = {
|
||||||
let mut stripper = Stripper { retained: &mut retained, update_retained: true };
|
let mut stripper = Stripper {
|
||||||
|
retained: &mut retained,
|
||||||
|
update_retained: true,
|
||||||
|
tcx: cx.tcx,
|
||||||
|
is_in_hidden_item: false,
|
||||||
|
};
|
||||||
stripper.fold_crate(krate)
|
stripper.fold_crate(krate)
|
||||||
};
|
};
|
||||||
|
|
||||||
|
@ -36,40 +44,89 @@ pub(crate) fn strip_hidden(krate: clean::Crate, cx: &mut DocContext<'_>) -> clea
|
||||||
stripper.fold_crate(krate)
|
stripper.fold_crate(krate)
|
||||||
}
|
}
|
||||||
|
|
||||||
struct Stripper<'a> {
|
struct Stripper<'a, 'tcx> {
|
||||||
retained: &'a mut ItemIdSet,
|
retained: &'a mut ItemIdSet,
|
||||||
update_retained: bool,
|
update_retained: bool,
|
||||||
|
tcx: TyCtxt<'tcx>,
|
||||||
|
is_in_hidden_item: bool,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<'a> DocFolder for Stripper<'a> {
|
impl<'a, 'tcx> Stripper<'a, 'tcx> {
|
||||||
|
fn set_is_in_hidden_item_and_fold(&mut self, is_in_hidden_item: bool, i: Item) -> Item {
|
||||||
|
let prev = self.is_in_hidden_item;
|
||||||
|
self.is_in_hidden_item |= is_in_hidden_item;
|
||||||
|
let ret = self.fold_item_recur(i);
|
||||||
|
self.is_in_hidden_item = prev;
|
||||||
|
ret
|
||||||
|
}
|
||||||
|
|
||||||
|
/// In case `i` is a non-hidden impl block, then we special-case it by changing the value
|
||||||
|
/// of `is_in_hidden_item` to `true` because the impl children inherit its visibility.
|
||||||
|
fn recurse_in_impl(&mut self, i: Item) -> Item {
|
||||||
|
let prev = mem::replace(&mut self.is_in_hidden_item, false);
|
||||||
|
let ret = self.fold_item_recur(i);
|
||||||
|
self.is_in_hidden_item = prev;
|
||||||
|
ret
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<'a, 'tcx> DocFolder for Stripper<'a, 'tcx> {
|
||||||
fn fold_item(&mut self, i: Item) -> Option<Item> {
|
fn fold_item(&mut self, i: Item) -> Option<Item> {
|
||||||
if i.attrs.lists(sym::doc).has_word(sym::hidden) {
|
let has_doc_hidden = i.attrs.lists(sym::doc).has_word(sym::hidden);
|
||||||
debug!("strip_hidden: stripping {:?} {:?}", i.type_(), i.name);
|
let is_impl = matches!(*i.kind, clean::ImplItem(..));
|
||||||
// Use a dedicated hidden item for fields, variants, and modules.
|
let mut is_hidden = has_doc_hidden;
|
||||||
// We need to keep private fields and variants, so that the docs
|
if !is_impl {
|
||||||
// can show a placeholder "// some variants omitted". We need to keep
|
is_hidden = self.is_in_hidden_item || has_doc_hidden;
|
||||||
// private modules, because they can contain impl blocks, and impl
|
if !is_hidden && i.inline_stmt_id.is_none() {
|
||||||
// block privacy is inherited from the type and trait, not from the
|
// We don't need to check if it's coming from a reexport since the reexport itself was
|
||||||
// module it's defined in. Both of these are marked "stripped," and
|
// already checked.
|
||||||
// not included in the final docs, but since they still have an effect
|
is_hidden = i
|
||||||
// on the final doc, cannot be completely removed from the Clean IR.
|
.item_id
|
||||||
match *i.kind {
|
.as_def_id()
|
||||||
clean::StructFieldItem(..) | clean::ModuleItem(..) | clean::VariantItem(..) => {
|
.and_then(|def_id| def_id.as_local())
|
||||||
// We need to recurse into stripped modules to
|
.map(|def_id| inherits_doc_hidden(self.tcx, def_id))
|
||||||
// strip things like impl methods but when doing so
|
.unwrap_or(false);
|
||||||
// we must not add any items to the `retained` set.
|
|
||||||
let old = mem::replace(&mut self.update_retained, false);
|
|
||||||
let ret = strip_item(self.fold_item_recur(i));
|
|
||||||
self.update_retained = old;
|
|
||||||
return Some(ret);
|
|
||||||
}
|
|
||||||
_ => return None,
|
|
||||||
}
|
}
|
||||||
} else {
|
}
|
||||||
|
if !is_hidden {
|
||||||
if self.update_retained {
|
if self.update_retained {
|
||||||
self.retained.insert(i.item_id);
|
self.retained.insert(i.item_id);
|
||||||
}
|
}
|
||||||
|
return Some(if is_impl {
|
||||||
|
self.recurse_in_impl(i)
|
||||||
|
} else {
|
||||||
|
self.set_is_in_hidden_item_and_fold(false, i)
|
||||||
|
});
|
||||||
|
}
|
||||||
|
debug!("strip_hidden: stripping {:?} {:?}", i.type_(), i.name);
|
||||||
|
// Use a dedicated hidden item for fields, variants, and modules.
|
||||||
|
// We need to keep private fields and variants, so that the docs
|
||||||
|
// can show a placeholder "// some variants omitted". We need to keep
|
||||||
|
// private modules, because they can contain impl blocks, and impl
|
||||||
|
// block privacy is inherited from the type and trait, not from the
|
||||||
|
// module it's defined in. Both of these are marked "stripped," and
|
||||||
|
// not included in the final docs, but since they still have an effect
|
||||||
|
// on the final doc, cannot be completely removed from the Clean IR.
|
||||||
|
match *i.kind {
|
||||||
|
clean::StructFieldItem(..) | clean::ModuleItem(..) | clean::VariantItem(..) => {
|
||||||
|
// We need to recurse into stripped modules to
|
||||||
|
// strip things like impl methods but when doing so
|
||||||
|
// we must not add any items to the `retained` set.
|
||||||
|
let old = mem::replace(&mut self.update_retained, false);
|
||||||
|
let ret = strip_item(self.set_is_in_hidden_item_and_fold(true, i));
|
||||||
|
self.update_retained = old;
|
||||||
|
Some(ret)
|
||||||
|
}
|
||||||
|
_ => {
|
||||||
|
let ret = self.set_is_in_hidden_item_and_fold(true, i);
|
||||||
|
if has_doc_hidden {
|
||||||
|
// If the item itself has `#[doc(hidden)]`, then we simply remove it.
|
||||||
|
None
|
||||||
|
} else {
|
||||||
|
// However if it's a "descendant" of a `#[doc(hidden)]` item, then we strip it.
|
||||||
|
Some(strip_item(ret))
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
Some(self.fold_item_recur(i))
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -5,7 +5,9 @@ use rustc_data_structures::fx::FxHashSet;
|
||||||
use rustc_hir as hir;
|
use rustc_hir as hir;
|
||||||
use rustc_hir::def::{DefKind, Res};
|
use rustc_hir::def::{DefKind, Res};
|
||||||
use rustc_hir::def_id::{DefId, DefIdMap, LocalDefId, LocalDefIdSet};
|
use rustc_hir::def_id::{DefId, DefIdMap, LocalDefId, LocalDefIdSet};
|
||||||
|
use rustc_hir::intravisit::{walk_item, Visitor};
|
||||||
use rustc_hir::{Node, CRATE_HIR_ID};
|
use rustc_hir::{Node, CRATE_HIR_ID};
|
||||||
|
use rustc_middle::hir::nested_filter;
|
||||||
use rustc_middle::ty::{DefIdTree, TyCtxt};
|
use rustc_middle::ty::{DefIdTree, TyCtxt};
|
||||||
use rustc_span::def_id::{CRATE_DEF_ID, LOCAL_CRATE};
|
use rustc_span::def_id::{CRATE_DEF_ID, LOCAL_CRATE};
|
||||||
use rustc_span::symbol::{kw, sym, Symbol};
|
use rustc_span::symbol::{kw, sym, Symbol};
|
||||||
|
@ -53,19 +55,26 @@ fn def_id_to_path(tcx: TyCtxt<'_>, did: DefId) -> Vec<Symbol> {
|
||||||
std::iter::once(crate_name).chain(relative).collect()
|
std::iter::once(crate_name).chain(relative).collect()
|
||||||
}
|
}
|
||||||
|
|
||||||
pub(crate) fn inherits_doc_hidden(tcx: TyCtxt<'_>, mut node: LocalDefId) -> bool {
|
pub(crate) fn inherits_doc_hidden(tcx: TyCtxt<'_>, mut def_id: LocalDefId) -> bool {
|
||||||
while let Some(id) = tcx.opt_local_parent(node) {
|
let hir = tcx.hir();
|
||||||
node = id;
|
while let Some(id) = tcx.opt_local_parent(def_id) {
|
||||||
if tcx.is_doc_hidden(node.to_def_id()) {
|
def_id = id;
|
||||||
|
if tcx.is_doc_hidden(def_id.to_def_id()) {
|
||||||
return true;
|
return true;
|
||||||
|
} else if let Some(node) = hir.find_by_def_id(def_id) &&
|
||||||
|
matches!(
|
||||||
|
node,
|
||||||
|
hir::Node::Item(hir::Item { kind: hir::ItemKind::Impl(_), .. }),
|
||||||
|
)
|
||||||
|
{
|
||||||
|
// `impl` blocks stand a bit on their own: unless they have `#[doc(hidden)]` directly
|
||||||
|
// on them, they don't inherit it from the parent context.
|
||||||
|
return false;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
false
|
false
|
||||||
}
|
}
|
||||||
|
|
||||||
// Also, is there some reason that this doesn't use the 'visit'
|
|
||||||
// framework from syntax?.
|
|
||||||
|
|
||||||
pub(crate) struct RustdocVisitor<'a, 'tcx> {
|
pub(crate) struct RustdocVisitor<'a, 'tcx> {
|
||||||
cx: &'a mut core::DocContext<'tcx>,
|
cx: &'a mut core::DocContext<'tcx>,
|
||||||
view_item_stack: LocalDefIdSet,
|
view_item_stack: LocalDefIdSet,
|
||||||
|
@ -73,6 +82,7 @@ pub(crate) struct RustdocVisitor<'a, 'tcx> {
|
||||||
/// Are the current module and all of its parents public?
|
/// Are the current module and all of its parents public?
|
||||||
inside_public_path: bool,
|
inside_public_path: bool,
|
||||||
exact_paths: DefIdMap<Vec<Symbol>>,
|
exact_paths: DefIdMap<Vec<Symbol>>,
|
||||||
|
modules: Vec<Module<'tcx>>,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<'a, 'tcx> RustdocVisitor<'a, 'tcx> {
|
impl<'a, 'tcx> RustdocVisitor<'a, 'tcx> {
|
||||||
|
@ -80,12 +90,19 @@ impl<'a, 'tcx> RustdocVisitor<'a, 'tcx> {
|
||||||
// If the root is re-exported, terminate all recursion.
|
// If the root is re-exported, terminate all recursion.
|
||||||
let mut stack = LocalDefIdSet::default();
|
let mut stack = LocalDefIdSet::default();
|
||||||
stack.insert(CRATE_DEF_ID);
|
stack.insert(CRATE_DEF_ID);
|
||||||
|
let om = Module::new(
|
||||||
|
cx.tcx.crate_name(LOCAL_CRATE),
|
||||||
|
CRATE_DEF_ID,
|
||||||
|
cx.tcx.hir().root_module().spans.inner_span,
|
||||||
|
);
|
||||||
|
|
||||||
RustdocVisitor {
|
RustdocVisitor {
|
||||||
cx,
|
cx,
|
||||||
view_item_stack: stack,
|
view_item_stack: stack,
|
||||||
inlining: false,
|
inlining: false,
|
||||||
inside_public_path: true,
|
inside_public_path: true,
|
||||||
exact_paths: Default::default(),
|
exact_paths: Default::default(),
|
||||||
|
modules: vec![om],
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -95,12 +112,10 @@ impl<'a, 'tcx> RustdocVisitor<'a, 'tcx> {
|
||||||
}
|
}
|
||||||
|
|
||||||
pub(crate) fn visit(mut self) -> Module<'tcx> {
|
pub(crate) fn visit(mut self) -> Module<'tcx> {
|
||||||
let mut top_level_module = self.visit_mod_contents(
|
let root_module = self.cx.tcx.hir().root_module();
|
||||||
CRATE_DEF_ID,
|
self.visit_mod_contents(CRATE_DEF_ID, root_module);
|
||||||
self.cx.tcx.hir().root_module(),
|
|
||||||
self.cx.tcx.crate_name(LOCAL_CRATE),
|
let mut top_level_module = self.modules.pop().unwrap();
|
||||||
None,
|
|
||||||
);
|
|
||||||
|
|
||||||
// `#[macro_export] macro_rules!` items are reexported at the top level of the
|
// `#[macro_export] macro_rules!` items are reexported at the top level of the
|
||||||
// crate, regardless of where they're defined. We want to document the
|
// crate, regardless of where they're defined. We want to document the
|
||||||
|
@ -115,15 +130,13 @@ impl<'a, 'tcx> RustdocVisitor<'a, 'tcx> {
|
||||||
// macro in the same module.
|
// macro in the same module.
|
||||||
let mut inserted = FxHashSet::default();
|
let mut inserted = FxHashSet::default();
|
||||||
for export in self.cx.tcx.module_reexports(CRATE_DEF_ID).unwrap_or(&[]) {
|
for export in self.cx.tcx.module_reexports(CRATE_DEF_ID).unwrap_or(&[]) {
|
||||||
if let Res::Def(DefKind::Macro(_), def_id) = export.res {
|
if let Res::Def(DefKind::Macro(_), def_id) = export.res &&
|
||||||
if let Some(local_def_id) = def_id.as_local() {
|
let Some(local_def_id) = def_id.as_local() &&
|
||||||
if self.cx.tcx.has_attr(def_id, sym::macro_export) {
|
self.cx.tcx.has_attr(def_id, sym::macro_export) &&
|
||||||
if inserted.insert(def_id) {
|
inserted.insert(def_id)
|
||||||
let item = self.cx.tcx.hir().expect_item(local_def_id);
|
{
|
||||||
top_level_module.items.push((item, None, None));
|
let item = self.cx.tcx.hir().expect_item(local_def_id);
|
||||||
}
|
top_level_module.items.push((item, None, None));
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -157,23 +170,22 @@ impl<'a, 'tcx> RustdocVisitor<'a, 'tcx> {
|
||||||
top_level_module
|
top_level_module
|
||||||
}
|
}
|
||||||
|
|
||||||
fn visit_mod_contents(
|
/// This method will go through the given module items in two passes:
|
||||||
&mut self,
|
/// 1. The items which are not glob imports/reexports.
|
||||||
def_id: LocalDefId,
|
/// 2. The glob imports/reexports.
|
||||||
m: &'tcx hir::Mod<'tcx>,
|
fn visit_mod_contents(&mut self, def_id: LocalDefId, m: &'tcx hir::Mod<'tcx>) {
|
||||||
name: Symbol,
|
debug!("Going through module {:?}", m);
|
||||||
parent_id: Option<LocalDefId>,
|
|
||||||
) -> Module<'tcx> {
|
|
||||||
let mut om = Module::new(name, def_id, m.spans.inner_span);
|
|
||||||
// Keep track of if there were any private modules in the path.
|
// Keep track of if there were any private modules in the path.
|
||||||
let orig_inside_public_path = self.inside_public_path;
|
let orig_inside_public_path = self.inside_public_path;
|
||||||
self.inside_public_path &= self.cx.tcx.local_visibility(def_id).is_public();
|
self.inside_public_path &= self.cx.tcx.local_visibility(def_id).is_public();
|
||||||
|
|
||||||
|
// Reimplementation of `walk_mod` because we need to do it in two passes (explanations in
|
||||||
|
// the second loop):
|
||||||
for &i in m.item_ids {
|
for &i in m.item_ids {
|
||||||
let item = self.cx.tcx.hir().item(i);
|
let item = self.cx.tcx.hir().item(i);
|
||||||
if matches!(item.kind, hir::ItemKind::Use(_, hir::UseKind::Glob)) {
|
if !matches!(item.kind, hir::ItemKind::Use(_, hir::UseKind::Glob)) {
|
||||||
continue;
|
self.visit_item(item);
|
||||||
}
|
}
|
||||||
self.visit_item(item, None, &mut om, parent_id);
|
|
||||||
}
|
}
|
||||||
for &i in m.item_ids {
|
for &i in m.item_ids {
|
||||||
let item = self.cx.tcx.hir().item(i);
|
let item = self.cx.tcx.hir().item(i);
|
||||||
|
@ -181,11 +193,11 @@ impl<'a, 'tcx> RustdocVisitor<'a, 'tcx> {
|
||||||
// Later passes in rustdoc will de-duplicate by name and kind, so if glob-
|
// Later passes in rustdoc will de-duplicate by name and kind, so if glob-
|
||||||
// imported items appear last, then they'll be the ones that get discarded.
|
// imported items appear last, then they'll be the ones that get discarded.
|
||||||
if matches!(item.kind, hir::ItemKind::Use(_, hir::UseKind::Glob)) {
|
if matches!(item.kind, hir::ItemKind::Use(_, hir::UseKind::Glob)) {
|
||||||
self.visit_item(item, None, &mut om, parent_id);
|
self.visit_item(item);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
self.inside_public_path = orig_inside_public_path;
|
self.inside_public_path = orig_inside_public_path;
|
||||||
om
|
debug!("Leaving module {:?}", m);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Tries to resolve the target of a `pub use` statement and inlines the
|
/// Tries to resolve the target of a `pub use` statement and inlines the
|
||||||
|
@ -203,7 +215,6 @@ impl<'a, 'tcx> RustdocVisitor<'a, 'tcx> {
|
||||||
res: Res,
|
res: Res,
|
||||||
renamed: Option<Symbol>,
|
renamed: Option<Symbol>,
|
||||||
glob: bool,
|
glob: bool,
|
||||||
om: &mut Module<'tcx>,
|
|
||||||
please_inline: bool,
|
please_inline: bool,
|
||||||
) -> bool {
|
) -> bool {
|
||||||
debug!("maybe_inline_local res: {:?}", res);
|
debug!("maybe_inline_local res: {:?}", res);
|
||||||
|
@ -213,33 +224,30 @@ impl<'a, 'tcx> RustdocVisitor<'a, 'tcx> {
|
||||||
}
|
}
|
||||||
|
|
||||||
let tcx = self.cx.tcx;
|
let tcx = self.cx.tcx;
|
||||||
let Some(res_did) = res.opt_def_id() else {
|
let Some(ori_res_did) = res.opt_def_id() else {
|
||||||
return false;
|
return false;
|
||||||
};
|
};
|
||||||
|
|
||||||
let use_attrs = tcx.hir().attrs(tcx.hir().local_def_id_to_hir_id(def_id));
|
let use_attrs = tcx.hir().attrs(tcx.hir().local_def_id_to_hir_id(def_id));
|
||||||
// Don't inline `doc(hidden)` imports so they can be stripped at a later stage.
|
// Don't inline `doc(hidden)` imports so they can be stripped at a later stage.
|
||||||
let is_no_inline = use_attrs.lists(sym::doc).has_word(sym::no_inline)
|
let is_no_inline = use_attrs.lists(sym::doc).has_word(sym::no_inline)
|
||||||
|| tcx.is_doc_hidden(def_id.to_def_id());
|
|| use_attrs.lists(sym::doc).has_word(sym::hidden);
|
||||||
|
|
||||||
// For cross-crate impl inlining we need to know whether items are
|
// For cross-crate impl inlining we need to know whether items are
|
||||||
// reachable in documentation -- a previously unreachable item can be
|
// reachable in documentation -- a previously unreachable item can be
|
||||||
// made reachable by cross-crate inlining which we're checking here.
|
// made reachable by cross-crate inlining which we're checking here.
|
||||||
// (this is done here because we need to know this upfront).
|
// (this is done here because we need to know this upfront).
|
||||||
if !res_did.is_local() && !is_no_inline {
|
if !ori_res_did.is_local() && !is_no_inline {
|
||||||
crate::visit_lib::lib_embargo_visit_item(self.cx, res_did);
|
crate::visit_lib::lib_embargo_visit_item(self.cx, ori_res_did);
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
let Some(res_did) = res_did.as_local() else {
|
let Some(res_did) = ori_res_did.as_local() else {
|
||||||
return false;
|
return false;
|
||||||
};
|
};
|
||||||
|
|
||||||
let is_private = !self
|
let is_private =
|
||||||
.cx
|
!self.cx.cache.effective_visibilities.is_directly_public(self.cx.tcx, ori_res_did);
|
||||||
.cache
|
|
||||||
.effective_visibilities
|
|
||||||
.is_directly_public(self.cx.tcx, res_did.to_def_id());
|
|
||||||
let is_hidden = inherits_doc_hidden(self.cx.tcx, res_did);
|
let is_hidden = inherits_doc_hidden(self.cx.tcx, res_did);
|
||||||
|
|
||||||
// Only inline if requested or if the item would otherwise be stripped.
|
// Only inline if requested or if the item would otherwise be stripped.
|
||||||
|
@ -256,20 +264,20 @@ impl<'a, 'tcx> RustdocVisitor<'a, 'tcx> {
|
||||||
let prev = mem::replace(&mut self.inlining, true);
|
let prev = mem::replace(&mut self.inlining, true);
|
||||||
for &i in m.item_ids {
|
for &i in m.item_ids {
|
||||||
let i = self.cx.tcx.hir().item(i);
|
let i = self.cx.tcx.hir().item(i);
|
||||||
self.visit_item(i, None, om, Some(def_id));
|
self.visit_item_inner(i, None, Some(def_id));
|
||||||
}
|
}
|
||||||
self.inlining = prev;
|
self.inlining = prev;
|
||||||
true
|
true
|
||||||
}
|
}
|
||||||
Node::Item(it) if !glob => {
|
Node::Item(it) if !glob => {
|
||||||
let prev = mem::replace(&mut self.inlining, true);
|
let prev = mem::replace(&mut self.inlining, true);
|
||||||
self.visit_item(it, renamed, om, Some(def_id));
|
self.visit_item_inner(it, renamed, Some(def_id));
|
||||||
self.inlining = prev;
|
self.inlining = prev;
|
||||||
true
|
true
|
||||||
}
|
}
|
||||||
Node::ForeignItem(it) if !glob => {
|
Node::ForeignItem(it) if !glob => {
|
||||||
let prev = mem::replace(&mut self.inlining, true);
|
let prev = mem::replace(&mut self.inlining, true);
|
||||||
self.visit_foreign_item(it, renamed, om);
|
self.visit_foreign_item_inner(it, renamed);
|
||||||
self.inlining = prev;
|
self.inlining = prev;
|
||||||
true
|
true
|
||||||
}
|
}
|
||||||
|
@ -279,18 +287,28 @@ impl<'a, 'tcx> RustdocVisitor<'a, 'tcx> {
|
||||||
ret
|
ret
|
||||||
}
|
}
|
||||||
|
|
||||||
fn visit_item(
|
#[inline]
|
||||||
|
fn add_to_current_mod(
|
||||||
&mut self,
|
&mut self,
|
||||||
item: &'tcx hir::Item<'_>,
|
item: &'tcx hir::Item<'_>,
|
||||||
renamed: Option<Symbol>,
|
renamed: Option<Symbol>,
|
||||||
om: &mut Module<'tcx>,
|
|
||||||
parent_id: Option<LocalDefId>,
|
parent_id: Option<LocalDefId>,
|
||||||
) {
|
) {
|
||||||
|
self.modules.last_mut().unwrap().items.push((item, renamed, parent_id))
|
||||||
|
}
|
||||||
|
|
||||||
|
fn visit_item_inner(
|
||||||
|
&mut self,
|
||||||
|
item: &'tcx hir::Item<'_>,
|
||||||
|
renamed: Option<Symbol>,
|
||||||
|
import_id: Option<LocalDefId>,
|
||||||
|
) -> bool {
|
||||||
debug!("visiting item {:?}", item);
|
debug!("visiting item {:?}", item);
|
||||||
let name = renamed.unwrap_or(item.ident.name);
|
let name = renamed.unwrap_or(item.ident.name);
|
||||||
|
let tcx = self.cx.tcx;
|
||||||
|
|
||||||
let def_id = item.owner_id.to_def_id();
|
let def_id = item.owner_id.to_def_id();
|
||||||
let is_pub = self.cx.tcx.visibility(def_id).is_public();
|
let is_pub = tcx.visibility(def_id).is_public();
|
||||||
|
|
||||||
if is_pub {
|
if is_pub {
|
||||||
self.store_path(item.owner_id.to_def_id());
|
self.store_path(item.owner_id.to_def_id());
|
||||||
|
@ -299,8 +317,8 @@ impl<'a, 'tcx> RustdocVisitor<'a, 'tcx> {
|
||||||
match item.kind {
|
match item.kind {
|
||||||
hir::ItemKind::ForeignMod { items, .. } => {
|
hir::ItemKind::ForeignMod { items, .. } => {
|
||||||
for item in items {
|
for item in items {
|
||||||
let item = self.cx.tcx.hir().foreign_item(item.id);
|
let item = tcx.hir().foreign_item(item.id);
|
||||||
self.visit_foreign_item(item, None, om);
|
self.visit_foreign_item_inner(item, None);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
// If we're inlining, skip private items or item reexported as "_".
|
// If we're inlining, skip private items or item reexported as "_".
|
||||||
|
@ -315,7 +333,8 @@ impl<'a, 'tcx> RustdocVisitor<'a, 'tcx> {
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
let attrs = self.cx.tcx.hir().attrs(item.hir_id());
|
let attrs =
|
||||||
|
tcx.hir().attrs(tcx.hir().local_def_id_to_hir_id(item.owner_id.def_id));
|
||||||
|
|
||||||
// If there was a private module in the current path then don't bother inlining
|
// If there was a private module in the current path then don't bother inlining
|
||||||
// anything as it will probably be stripped anyway.
|
// anything as it will probably be stripped anyway.
|
||||||
|
@ -333,14 +352,13 @@ impl<'a, 'tcx> RustdocVisitor<'a, 'tcx> {
|
||||||
res,
|
res,
|
||||||
ident,
|
ident,
|
||||||
is_glob,
|
is_glob,
|
||||||
om,
|
|
||||||
please_inline,
|
please_inline,
|
||||||
) {
|
) {
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
om.items.push((item, renamed, parent_id))
|
self.add_to_current_mod(item, renamed, import_id);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
hir::ItemKind::Macro(ref macro_def, _) => {
|
hir::ItemKind::Macro(ref macro_def, _) => {
|
||||||
|
@ -357,14 +375,14 @@ impl<'a, 'tcx> RustdocVisitor<'a, 'tcx> {
|
||||||
|
|
||||||
let def_id = item.owner_id.to_def_id();
|
let def_id = item.owner_id.to_def_id();
|
||||||
let is_macro_2_0 = !macro_def.macro_rules;
|
let is_macro_2_0 = !macro_def.macro_rules;
|
||||||
let nonexported = !self.cx.tcx.has_attr(def_id, sym::macro_export);
|
let nonexported = !tcx.has_attr(def_id, sym::macro_export);
|
||||||
|
|
||||||
if is_macro_2_0 || nonexported || self.inlining {
|
if is_macro_2_0 || nonexported || self.inlining {
|
||||||
om.items.push((item, renamed, None));
|
self.add_to_current_mod(item, renamed, None);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
hir::ItemKind::Mod(ref m) => {
|
hir::ItemKind::Mod(ref m) => {
|
||||||
om.mods.push(self.visit_mod_contents(item.owner_id.def_id, m, name, parent_id));
|
self.enter_mod(item.owner_id.def_id, m, name);
|
||||||
}
|
}
|
||||||
hir::ItemKind::Fn(..)
|
hir::ItemKind::Fn(..)
|
||||||
| hir::ItemKind::ExternCrate(..)
|
| hir::ItemKind::ExternCrate(..)
|
||||||
|
@ -375,33 +393,87 @@ impl<'a, 'tcx> RustdocVisitor<'a, 'tcx> {
|
||||||
| hir::ItemKind::OpaqueTy(..)
|
| hir::ItemKind::OpaqueTy(..)
|
||||||
| hir::ItemKind::Static(..)
|
| hir::ItemKind::Static(..)
|
||||||
| hir::ItemKind::Trait(..)
|
| hir::ItemKind::Trait(..)
|
||||||
| hir::ItemKind::TraitAlias(..) => om.items.push((item, renamed, parent_id)),
|
| hir::ItemKind::TraitAlias(..) => {
|
||||||
|
self.add_to_current_mod(item, renamed, import_id);
|
||||||
|
}
|
||||||
hir::ItemKind::Const(..) => {
|
hir::ItemKind::Const(..) => {
|
||||||
// Underscore constants do not correspond to a nameable item and
|
// Underscore constants do not correspond to a nameable item and
|
||||||
// so are never useful in documentation.
|
// so are never useful in documentation.
|
||||||
if name != kw::Underscore {
|
if name != kw::Underscore {
|
||||||
om.items.push((item, renamed, parent_id));
|
self.add_to_current_mod(item, renamed, import_id);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
hir::ItemKind::Impl(impl_) => {
|
hir::ItemKind::Impl(impl_) => {
|
||||||
// Don't duplicate impls when inlining or if it's implementing a trait, we'll pick
|
// Don't duplicate impls when inlining or if it's implementing a trait, we'll pick
|
||||||
// them up regardless of where they're located.
|
// them up regardless of where they're located.
|
||||||
if !self.inlining && impl_.of_trait.is_none() {
|
if !self.inlining && impl_.of_trait.is_none() {
|
||||||
om.items.push((item, None, None));
|
self.add_to_current_mod(item, None, None);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
true
|
||||||
}
|
}
|
||||||
|
|
||||||
fn visit_foreign_item(
|
fn visit_foreign_item_inner(
|
||||||
&mut self,
|
&mut self,
|
||||||
item: &'tcx hir::ForeignItem<'_>,
|
item: &'tcx hir::ForeignItem<'_>,
|
||||||
renamed: Option<Symbol>,
|
renamed: Option<Symbol>,
|
||||||
om: &mut Module<'tcx>,
|
|
||||||
) {
|
) {
|
||||||
// If inlining we only want to include public functions.
|
// If inlining we only want to include public functions.
|
||||||
if !self.inlining || self.cx.tcx.visibility(item.owner_id).is_public() {
|
if !self.inlining || self.cx.tcx.visibility(item.owner_id).is_public() {
|
||||||
om.foreigns.push((item, renamed));
|
self.modules.last_mut().unwrap().foreigns.push((item, renamed));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// This method will create a new module and push it onto the "modules stack" then call
|
||||||
|
/// `visit_mod_contents`. Once done, it'll remove it from the "modules stack" and instead
|
||||||
|
/// add into the list of modules of the current module.
|
||||||
|
fn enter_mod(&mut self, id: LocalDefId, m: &'tcx hir::Mod<'tcx>, name: Symbol) {
|
||||||
|
self.modules.push(Module::new(name, id, m.spans.inner_span));
|
||||||
|
|
||||||
|
self.visit_mod_contents(id, m);
|
||||||
|
|
||||||
|
let last = self.modules.pop().unwrap();
|
||||||
|
self.modules.last_mut().unwrap().mods.push(last);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// We need to implement this visitor so it'll go everywhere and retrieve items we're interested in
|
||||||
|
// such as impl blocks in const blocks.
|
||||||
|
impl<'a, 'tcx> Visitor<'tcx> for RustdocVisitor<'a, 'tcx> {
|
||||||
|
type NestedFilter = nested_filter::All;
|
||||||
|
|
||||||
|
fn nested_visit_map(&mut self) -> Self::Map {
|
||||||
|
self.cx.tcx.hir()
|
||||||
|
}
|
||||||
|
|
||||||
|
fn visit_item(&mut self, i: &'tcx hir::Item<'tcx>) {
|
||||||
|
if self.visit_item_inner(i, None, None) {
|
||||||
|
walk_item(self, i);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn visit_mod(&mut self, _: &hir::Mod<'tcx>, _: Span, _: hir::HirId) {
|
||||||
|
// Handled in `visit_item_inner`
|
||||||
|
}
|
||||||
|
|
||||||
|
fn visit_use(&mut self, _: &hir::UsePath<'tcx>, _: hir::HirId) {
|
||||||
|
// Handled in `visit_item_inner`
|
||||||
|
}
|
||||||
|
|
||||||
|
fn visit_path(&mut self, _: &hir::Path<'tcx>, _: hir::HirId) {
|
||||||
|
// Handled in `visit_item_inner`
|
||||||
|
}
|
||||||
|
|
||||||
|
fn visit_label(&mut self, _: &rustc_ast::Label) {
|
||||||
|
// Unneeded.
|
||||||
|
}
|
||||||
|
|
||||||
|
fn visit_infer(&mut self, _: &hir::InferArg) {
|
||||||
|
// Unneeded.
|
||||||
|
}
|
||||||
|
|
||||||
|
fn visit_lifetime(&mut self, _: &hir::Lifetime) {
|
||||||
|
// Unneeded.
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,12 +1,10 @@
|
||||||
// check-pass
|
|
||||||
// normalize-stderr-test: "`.*`" -> "`DEF_ID`"
|
// normalize-stderr-test: "`.*`" -> "`DEF_ID`"
|
||||||
// normalize-stdout-test: "`.*`" -> "`DEF_ID`"
|
// normalize-stdout-test: "`.*`" -> "`DEF_ID`"
|
||||||
// edition:2018
|
// edition:2018
|
||||||
|
|
||||||
pub async fn f() -> impl std::fmt::Debug {
|
pub async fn f() -> impl std::fmt::Debug {
|
||||||
// rustdoc doesn't care that this is infinitely sized
|
|
||||||
#[derive(Debug)]
|
#[derive(Debug)]
|
||||||
enum E {
|
enum E { //~ ERROR
|
||||||
This(E),
|
This(E),
|
||||||
Unit,
|
Unit,
|
||||||
}
|
}
|
||||||
|
|
|
@ -0,0 +1,16 @@
|
||||||
|
error[E0072]: recursive type `DEF_ID` has infinite size
|
||||||
|
--> $DIR/infinite-recursive-type-impl-trait-return.rs:7:5
|
||||||
|
|
|
||||||
|
LL | enum E {
|
||||||
|
| ^^^^^^
|
||||||
|
LL | This(E),
|
||||||
|
| - recursive without indirection
|
||||||
|
|
|
||||||
|
help: insert some indirection (e.g., a `DEF_ID`) to break the cycle
|
||||||
|
|
|
||||||
|
LL | This(Box<E>),
|
||||||
|
| ++++ +
|
||||||
|
|
||||||
|
error: aborting due to previous error
|
||||||
|
|
||||||
|
For more information about this error, try `DEF_ID`.
|
|
@ -1,8 +1,5 @@
|
||||||
// check-pass
|
|
||||||
|
|
||||||
fn f() -> impl Sized {
|
fn f() -> impl Sized {
|
||||||
// rustdoc doesn't care that this is infinitely sized
|
enum E { //~ ERROR
|
||||||
enum E {
|
|
||||||
V(E),
|
V(E),
|
||||||
}
|
}
|
||||||
unimplemented!()
|
unimplemented!()
|
||||||
|
|
|
@ -0,0 +1,16 @@
|
||||||
|
error[E0072]: recursive type `f::E` has infinite size
|
||||||
|
--> $DIR/infinite-recursive-type-impl-trait.rs:2:5
|
||||||
|
|
|
||||||
|
LL | enum E {
|
||||||
|
| ^^^^^^
|
||||||
|
LL | V(E),
|
||||||
|
| - recursive without indirection
|
||||||
|
|
|
||||||
|
help: insert some indirection (e.g., a `Box`, `Rc`, or `&`) to break the cycle
|
||||||
|
|
|
||||||
|
LL | V(Box<E>),
|
||||||
|
| ++++ +
|
||||||
|
|
||||||
|
error: aborting due to previous error
|
||||||
|
|
||||||
|
For more information about this error, try `rustc --explain E0072`.
|
|
@ -0,0 +1,50 @@
|
||||||
|
// This is a regression test for <https://github.com/rust-lang/rust/issues/106373>.
|
||||||
|
// It ensures that the items in the `doc(hidden)` const block don't show up in the
|
||||||
|
// generated docs.
|
||||||
|
|
||||||
|
// compile-flags: --document-private-items
|
||||||
|
|
||||||
|
#![crate_name = "foo"]
|
||||||
|
|
||||||
|
// @has 'foo/index.html'
|
||||||
|
// @count - '//*[@class="item-table"]//a[@class="struct"]' 2
|
||||||
|
// @count - '//*[@class="item-table"]//a[@class="trait"]' 1
|
||||||
|
// @count - '//*[@class="item-table"]//a[@class="macro"]' 0
|
||||||
|
#[doc(hidden)]
|
||||||
|
const _: () = {
|
||||||
|
macro_rules! stry {
|
||||||
|
() => {};
|
||||||
|
}
|
||||||
|
|
||||||
|
struct ShouldBeHidden;
|
||||||
|
|
||||||
|
// @has 'foo/struct.Foo.html'
|
||||||
|
// @!has - '//*[@class="code-header"]' 'impl Bar for Foo'
|
||||||
|
#[doc(hidden)]
|
||||||
|
impl Bar for Foo {
|
||||||
|
fn bar(&self) {
|
||||||
|
struct SHouldAlsoBeHidden;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// @has 'foo/struct.Private.html'
|
||||||
|
// @has - '//*[@id="impl-Bar-for-Private"]/*[@class="code-header"]' 'impl Bar for Private'
|
||||||
|
// @has - '//*[@id="method.bar"]/*[@class="code-header"]' 'fn bar(&self)'
|
||||||
|
impl Bar for Private {
|
||||||
|
fn bar(&self) {}
|
||||||
|
}
|
||||||
|
|
||||||
|
// @has - '//*[@id="impl-Private"]/*[@class="code-header"]' 'impl Private'
|
||||||
|
// @has - '//*[@id="method.tralala"]/*[@class="code-header"]' 'fn tralala()'
|
||||||
|
impl Private {
|
||||||
|
fn tralala() {}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
struct Private;
|
||||||
|
pub struct Foo;
|
||||||
|
|
||||||
|
pub trait Bar {
|
||||||
|
fn bar(&self);
|
||||||
|
}
|
|
@ -0,0 +1,43 @@
|
||||||
|
// Regression test for #83026.
|
||||||
|
// The goal of this test is to ensure that impl blocks inside
|
||||||
|
// const expressions are documented as well.
|
||||||
|
|
||||||
|
#![crate_name = "foo"]
|
||||||
|
|
||||||
|
// @has 'foo/struct.A.html'
|
||||||
|
// @has - '//*[@id="method.new"]/*[@class="code-header"]' 'pub fn new() -> A'
|
||||||
|
// @has - '//*[@id="method.bar"]/*[@class="code-header"]' 'pub fn bar(&self)'
|
||||||
|
// @has - '//*[@id="method.woo"]/*[@class="code-header"]' 'pub fn woo(&self)'
|
||||||
|
// @has - '//*[@id="method.yoo"]/*[@class="code-header"]' 'pub fn yoo()'
|
||||||
|
// @has - '//*[@id="method.yuu"]/*[@class="code-header"]' 'pub fn yuu()'
|
||||||
|
pub struct A;
|
||||||
|
|
||||||
|
const _: () = {
|
||||||
|
impl A {
|
||||||
|
const FOO: () = {
|
||||||
|
impl A {
|
||||||
|
pub fn woo(&self) {}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
pub fn new() -> A {
|
||||||
|
A
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
pub const X: () = {
|
||||||
|
impl A {
|
||||||
|
pub fn bar(&self) {}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
fn foo() {
|
||||||
|
impl A {
|
||||||
|
pub fn yoo() {}
|
||||||
|
}
|
||||||
|
const _: () = {
|
||||||
|
impl A {
|
||||||
|
pub fn yuu() {}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
|
@ -9,9 +9,10 @@ pub trait Foo {}
|
||||||
// @has redirect/index.html
|
// @has redirect/index.html
|
||||||
// @has - '//code' 'pub use reexp_stripped::Bar'
|
// @has - '//code' 'pub use reexp_stripped::Bar'
|
||||||
// @has - '//code/a' 'Bar'
|
// @has - '//code/a' 'Bar'
|
||||||
|
// @has - '//a[@href="../reexp_stripped/hidden/struct.Bar.html"]' 'Bar'
|
||||||
// @has reexp_stripped/hidden/struct.Bar.html
|
// @has reexp_stripped/hidden/struct.Bar.html
|
||||||
// @has - '//p/a' '../../reexp_stripped/struct.Bar.html'
|
|
||||||
// @has 'reexp_stripped/struct.Bar.html'
|
// @has 'reexp_stripped/struct.Bar.html'
|
||||||
|
// @has - '//a[@href="struct.Bar.html"]' 'Bar'
|
||||||
#[doc(no_inline)]
|
#[doc(no_inline)]
|
||||||
pub use reexp_stripped::Bar;
|
pub use reexp_stripped::Bar;
|
||||||
impl Foo for Bar {}
|
impl Foo for Bar {}
|
||||||
|
|
Loading…
Reference in New Issue