Skip to content

Commit

Permalink
Always hide private fields in aliased type
Browse files Browse the repository at this point in the history
  • Loading branch information
Urgau committed May 9, 2024
1 parent cb93c24 commit 9b25ab4
Show file tree
Hide file tree
Showing 5 changed files with 82 additions and 0 deletions.
5 changes: 5 additions & 0 deletions src/librustdoc/passes/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ use crate::core::DocContext;
mod stripper;
pub(crate) use stripper::*;

mod strip_aliased_non_local;
pub(crate) use self::strip_aliased_non_local::STRIP_ALIASED_NON_LOCAL;

mod strip_hidden;
pub(crate) use self::strip_hidden::STRIP_HIDDEN;

Expand Down Expand Up @@ -71,6 +74,7 @@ pub(crate) enum Condition {
pub(crate) const PASSES: &[Pass] = &[
CHECK_CUSTOM_CODE_CLASSES,
CHECK_DOC_TEST_VISIBILITY,
STRIP_ALIASED_NON_LOCAL,
STRIP_HIDDEN,
STRIP_PRIVATE,
STRIP_PRIV_IMPORTS,
Expand All @@ -86,6 +90,7 @@ pub(crate) const DEFAULT_PASSES: &[ConditionalPass] = &[
ConditionalPass::always(CHECK_CUSTOM_CODE_CLASSES),
ConditionalPass::always(COLLECT_TRAIT_IMPLS),
ConditionalPass::always(CHECK_DOC_TEST_VISIBILITY),
ConditionalPass::always(STRIP_ALIASED_NON_LOCAL),
ConditionalPass::new(STRIP_HIDDEN, WhenNotDocumentHidden),
ConditionalPass::new(STRIP_PRIVATE, WhenNotDocumentPrivate),
ConditionalPass::new(STRIP_PRIV_IMPORTS, WhenDocumentPrivate),
Expand Down
55 changes: 55 additions & 0 deletions src/librustdoc/passes/strip_aliased_non_local.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
use rustc_middle::ty::TyCtxt;
use rustc_middle::ty::Visibility;

use crate::clean;
use crate::clean::Item;
use crate::core::DocContext;
use crate::fold::{strip_item, DocFolder};
use crate::passes::Pass;

pub(crate) const STRIP_ALIASED_NON_LOCAL: Pass = Pass {
name: "strip-aliased-non-local",
run: strip_aliased_non_local,
description: "strips all non-local private aliased items from the output",
};

fn strip_aliased_non_local(krate: clean::Crate, cx: &mut DocContext<'_>) -> clean::Crate {
let mut stripper = NonLocalAliasedStripper { tcx: cx.tcx };
stripper.fold_crate(krate)
}

struct NonLocalAliasedStripper<'tcx> {
pub(crate) tcx: TyCtxt<'tcx>,
}

impl<'tcx> DocFolder for NonLocalAliasedStripper<'tcx> {
fn fold_item(&mut self, i: Item) -> Option<Item> {
Some(match *i.kind {
clean::TypeAliasItem(..) => {
let mut stripper = NonLocalStripper { tcx: self.tcx };
// don't call `fold_item` as that could the type-alias it-self which
// we don't want to remove
stripper.fold_item_recur(i)
}
_ => self.fold_item_recur(i),
})
}
}

struct NonLocalStripper<'tcx> {
pub(crate) tcx: TyCtxt<'tcx>,
}

impl<'tcx> DocFolder for NonLocalStripper<'tcx> {
fn fold_item(&mut self, i: Item) -> Option<Item> {
// If not local, we want to respect the original visibility of
// the field and not the one given by the user for the currrent crate.
if !i.def_id().map_or(true, |did| did.is_local()) {
if i.visibility(self.tcx) != Some(Visibility::Public) || i.is_doc_hidden() {
return Some(strip_item(i));
}
}

Some(self.fold_item_recur(i))
}
}
2 changes: 2 additions & 0 deletions tests/rustdoc-ui/issues/issue-91713.stdout
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
Available passes for running rustdoc:
check-custom-code-classes - check for custom code classes without the feature-gate enabled
check_doc_test_visibility - run various visibility-related lints on doctests
strip-aliased-non-local - strips all non-local private aliased items from the output
strip-hidden - strips all `#[doc(hidden)]` items from the output
strip-private - strips all private items from a crate which cannot be seen externally, implies strip-priv-imports
strip-priv-imports - strips all private import statements (`use`, `extern crate`) from a crate
Expand All @@ -14,6 +15,7 @@ Default passes for rustdoc:
check-custom-code-classes
collect-trait-impls
check_doc_test_visibility
strip-aliased-non-local
strip-hidden (when not --document-hidden-items)
strip-private (when not --document-private-items)
strip-priv-imports (when --document-private-items)
Expand Down
11 changes: 11 additions & 0 deletions tests/rustdoc/private-non-local-fields-2.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
//! This test makes sure that with never show the inner fields in the
//! aliased type view of type alias.

//@ compile-flags: -Z unstable-options --document-private-items

#![crate_name = "foo"]

use std::collections::BTreeMap;

// @has 'foo/type.FooBar.html' '//*[@class="rust item-decl"]/code' 'struct FooBar { /* private fields */ }'
pub type FooBar = BTreeMap<u32, String>;
9 changes: 9 additions & 0 deletions tests/rustdoc/private-non-local-fields.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
//! This test makes sure that with never show the inner fields in the
//! aliased type view of type alias.

#![crate_name = "foo"]

use std::collections::BTreeMap;

// @has 'foo/type.FooBar.html' '//*[@class="rust item-decl"]/code' 'struct FooBar { /* private fields */ }'
pub type FooBar = BTreeMap<u32, String>;

0 comments on commit 9b25ab4

Please sign in to comment.