Skip to content

Commit 02b9701

Browse files
authored
Rollup merge of #99287 - GuillaumeGomez:rustdoc-json-double-export, r=notriddle
[rustdoc-json] JSON no longer inlines Fixes #98007. Fixes #96161. Fixes #83057. Fixes #83720. I took over #93518 and applied the comments and added more tests. There was one thing missing (which is in the second commit): if a non-exported item was used in a public API but not reexported, it was still missing. cc `@CraftSpider` `@Urgau` `@Enselic` r? `@notriddle`
2 parents fa298be + b95b138 commit 02b9701

20 files changed

+194
-35
lines changed

src/librustdoc/clean/mod.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2120,8 +2120,9 @@ fn clean_use_statement<'tcx>(
21202120
// forcefully don't inline if this is not public or if the
21212121
// #[doc(no_inline)] attribute is present.
21222122
// Don't inline doc(hidden) imports so they can be stripped at a later stage.
2123-
let mut denied = !(visibility.is_public()
2124-
|| (cx.render_options.document_private && is_visible_from_parent_mod))
2123+
let mut denied = cx.output_format.is_json()
2124+
|| !(visibility.is_public()
2125+
|| (cx.render_options.document_private && is_visible_from_parent_mod))
21252126
|| pub_underscore
21262127
|| attrs.iter().any(|a| {
21272128
a.has_name(sym::doc)

src/librustdoc/core.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,8 @@ pub(crate) struct DocContext<'tcx> {
8181
pub(crate) inlined: FxHashSet<ItemId>,
8282
/// Used by `calculate_doc_coverage`.
8383
pub(crate) output_format: OutputFormat,
84+
/// Used by `strip_private`.
85+
pub(crate) show_coverage: bool,
8486
}
8587

8688
impl<'tcx> DocContext<'tcx> {
@@ -381,6 +383,7 @@ pub(crate) fn run_global_ctxt(
381383
inlined: FxHashSet::default(),
382384
output_format,
383385
render_options,
386+
show_coverage,
384387
};
385388

386389
// Small hack to force the Sized trait to be present.

src/librustdoc/json/conversions.rs

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,16 @@ impl JsonRenderer<'_> {
4343
let span = item.span(self.tcx);
4444
let clean::Item { name, attrs: _, kind: _, visibility, item_id, cfg: _ } = item;
4545
let inner = match *item.kind {
46-
clean::StrippedItem(_) | clean::KeywordItem(_) => return None,
46+
clean::KeywordItem(_) => return None,
47+
clean::StrippedItem(ref inner) => {
48+
match &**inner {
49+
// We document non-empty stripped modules as with `Module::is_stripped` set to
50+
// `true`, to prevent contained items from being orphaned for downstream users,
51+
// as JSON does no inlining.
52+
clean::ModuleItem(m) if !m.items.is_empty() => from_clean_item(item, self.tcx),
53+
_ => return None,
54+
}
55+
}
4756
_ => from_clean_item(item, self.tcx),
4857
};
4958
Some(Item {
@@ -220,7 +229,9 @@ fn from_clean_item(item: clean::Item, tcx: TyCtxt<'_>) -> ItemEnum {
220229
let header = item.fn_header(tcx);
221230

222231
match *item.kind {
223-
ModuleItem(m) => ItemEnum::Module(Module { is_crate, items: ids(m.items, tcx) }),
232+
ModuleItem(m) => {
233+
ItemEnum::Module(Module { is_crate, items: ids(m.items, tcx), is_stripped: false })
234+
}
224235
ImportItem(i) => ItemEnum::Import(i.into_tcx(tcx)),
225236
StructItem(s) => ItemEnum::Struct(s.into_tcx(tcx)),
226237
UnionItem(u) => ItemEnum::Union(u.into_tcx(tcx)),
@@ -257,8 +268,19 @@ fn from_clean_item(item: clean::Item, tcx: TyCtxt<'_>) -> ItemEnum {
257268
bounds: b.into_iter().map(|x| x.into_tcx(tcx)).collect(),
258269
default: Some(t.item_type.unwrap_or(t.type_).into_tcx(tcx)),
259270
},
260-
// `convert_item` early returns `None` for striped items and keywords.
261-
StrippedItem(_) | KeywordItem(_) => unreachable!(),
271+
// `convert_item` early returns `None` for stripped items and keywords.
272+
KeywordItem(_) => unreachable!(),
273+
StrippedItem(inner) => {
274+
match *inner {
275+
ModuleItem(m) => ItemEnum::Module(Module {
276+
is_crate,
277+
items: ids(m.items, tcx),
278+
is_stripped: true,
279+
}),
280+
// `convert_item` early returns `None` for stripped items we're not including
281+
_ => unreachable!(),
282+
}
283+
}
262284
ExternCrateItem { ref src } => ItemEnum::ExternCrate {
263285
name: name.as_ref().unwrap().to_string(),
264286
rename: src.map(|x| x.to_string()),

src/librustdoc/json/mod.rs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ use rustc_span::def_id::LOCAL_CRATE;
2121
use rustdoc_json_types as types;
2222

2323
use crate::clean::types::{ExternalCrate, ExternalLocation};
24+
use crate::clean::ItemKind;
2425
use crate::config::RenderOptions;
2526
use crate::docfs::PathError;
2627
use crate::error::Error;
@@ -175,6 +176,14 @@ impl<'tcx> FormatRenderer<'tcx> for JsonRenderer<'tcx> {
175176
/// the hashmap because certain items (traits and types) need to have their mappings for trait
176177
/// implementations filled out before they're inserted.
177178
fn item(&mut self, item: clean::Item) -> Result<(), Error> {
179+
trace!("rendering {} {:?}", item.type_(), item.name);
180+
181+
// Flatten items that recursively store other items. We include orphaned items from
182+
// stripped modules and etc that are otherwise reachable.
183+
if let ItemKind::StrippedItem(inner) = &*item.kind {
184+
inner.inner_items().for_each(|i| self.item(i.clone()).unwrap());
185+
}
186+
178187
// Flatten items that recursively store other items
179188
item.kind.inner_items().for_each(|i| self.item(i.clone()).unwrap());
180189

src/librustdoc/passes/strip_private.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ pub(crate) fn strip_private(mut krate: clean::Crate, cx: &mut DocContext<'_>) ->
2424
retained: &mut retained,
2525
access_levels: &cx.cache.access_levels,
2626
update_retained: true,
27+
is_json_output: cx.output_format.is_json() && !cx.show_coverage,
2728
};
2829
krate = ImportStripper.fold_crate(stripper.fold_crate(krate));
2930
}

src/librustdoc/passes/stripper.rs

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,29 @@ use rustc_hir::def_id::DefId;
33
use rustc_middle::middle::privacy::AccessLevels;
44
use std::mem;
55

6-
use crate::clean::{self, Item, ItemIdSet};
6+
use crate::clean::{self, Item, ItemId, ItemIdSet};
77
use crate::fold::{strip_item, DocFolder};
88
use crate::formats::cache::Cache;
99

1010
pub(crate) struct Stripper<'a> {
1111
pub(crate) retained: &'a mut ItemIdSet,
1212
pub(crate) access_levels: &'a AccessLevels<DefId>,
1313
pub(crate) update_retained: bool,
14+
pub(crate) is_json_output: bool,
15+
}
16+
17+
impl<'a> Stripper<'a> {
18+
// We need to handle this differently for the JSON output because some non exported items could
19+
// be used in public API. And so, we need these items as well. `is_exported` only checks if they
20+
// are in the public API, which is not enough.
21+
#[inline]
22+
fn is_item_reachable(&self, item_id: ItemId) -> bool {
23+
if self.is_json_output {
24+
self.access_levels.is_reachable(item_id.expect_def_id())
25+
} else {
26+
self.access_levels.is_exported(item_id.expect_def_id())
27+
}
28+
}
1429
}
1530

1631
impl<'a> DocFolder for Stripper<'a> {
@@ -45,9 +60,8 @@ impl<'a> DocFolder for Stripper<'a> {
4560
| clean::TraitAliasItem(..)
4661
| clean::MacroItem(..)
4762
| clean::ForeignTypeItem => {
48-
if i.item_id.is_local()
49-
&& !self.access_levels.is_exported(i.item_id.expect_def_id())
50-
{
63+
let item_id = i.item_id;
64+
if item_id.is_local() && !self.is_item_reachable(item_id) {
5165
debug!("Stripper: stripping {:?} {:?}", i.type_(), i.name);
5266
return None;
5367
}

src/librustdoc/visit_ast.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,10 @@ impl<'a, 'tcx> RustdocVisitor<'a, 'tcx> {
190190
) -> bool {
191191
debug!("maybe_inline_local res: {:?}", res);
192192

193+
if self.cx.output_format.is_json() {
194+
return false;
195+
}
196+
193197
let tcx = self.cx.tcx;
194198
let Some(res_did) = res.opt_def_id() else {
195199
return false;

src/rustdoc-json-types/lib.rs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ use std::path::PathBuf;
99
use serde::{Deserialize, Serialize};
1010

1111
/// rustdoc format-version.
12-
pub const FORMAT_VERSION: u32 = 15;
12+
pub const FORMAT_VERSION: u32 = 16;
1313

1414
/// A `Crate` is the root of the emitted JSON blob. It contains all type/documentation information
1515
/// about the language items in the local crate, as well as info about external items to allow
@@ -245,6 +245,9 @@ pub enum ItemEnum {
245245
pub struct Module {
246246
pub is_crate: bool,
247247
pub items: Vec<Id>,
248+
/// If `true`, this module is not part of the public API, but it contains
249+
/// items that are re-exported as public API.
250+
pub is_stripped: bool,
248251
}
249252

250253
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
// Regression test for <https://github.com/rust-lang/rust/issues/98007>.
2+
3+
#![feature(no_core)]
4+
#![no_core]
5+
6+
mod auto {
7+
mod action_row {
8+
pub struct ActionRowBuilder;
9+
}
10+
11+
#[doc(hidden)]
12+
pub mod builders {
13+
pub use super::action_row::ActionRowBuilder;
14+
}
15+
}
16+
17+
// @count doc_hidden_failure.json "$.index[*][?(@.name=='builders')]" 2
18+
pub use auto::*;
19+
20+
pub mod builders {
21+
pub use crate::auto::builders::*;
22+
}
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
pub struct Foo;

0 commit comments

Comments
 (0)