Skip to content

Commit a8dff34

Browse files
authored
Rollup merge of #88447 - inquisitivecrystal:rustdoc-vis, r=jyn514
Use computed visibility in rustdoc This PR changes `librustdoc` to use computed visibility instead of syntactic visibility. It was initially part of #88019, but was separated due to concerns that it might cause a regression somewhere we couldn't predict. r? `@jyn514` cc `@cjgillot` `@petrochenkov`
2 parents 68ca579 + 6622376 commit a8dff34

File tree

15 files changed

+38
-38
lines changed

15 files changed

+38
-38
lines changed

Diff for: compiler/rustc_metadata/src/rmeta/decoder.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1179,7 +1179,7 @@ impl<'a, 'tcx> CrateMetadataRef<'a> {
11791179
let ctor_res =
11801180
Res::Def(DefKind::Ctor(CtorOf::Variant, ctor_kind), ctor_def_id);
11811181
let mut vis = self.get_visibility(ctor_def_id.index);
1182-
if ctor_def_id == def_id && vis == ty::Visibility::Public {
1182+
if ctor_def_id == def_id && vis.is_public() {
11831183
// For non-exhaustive variants lower the constructor visibility to
11841184
// within the crate. We only need this for fictive constructors,
11851185
// for other constructors correct visibilities

Diff for: compiler/rustc_metadata/src/rmeta/decoder/cstore_impl.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -318,7 +318,7 @@ pub fn provide(providers: &mut Providers) {
318318
}
319319

320320
let mut add_child = |bfs_queue: &mut VecDeque<_>, child: &Export, parent: DefId| {
321-
if child.vis != ty::Visibility::Public {
321+
if !child.vis.is_public() {
322322
return;
323323
}
324324

Diff for: compiler/rustc_middle/src/ty/mod.rs

+4
Original file line numberDiff line numberDiff line change
@@ -333,6 +333,10 @@ impl Visibility {
333333
Visibility::Invisible => false,
334334
}
335335
}
336+
337+
pub fn is_public(self) -> bool {
338+
matches!(self, Visibility::Public)
339+
}
336340
}
337341

338342
/// The crate variances map is computed during typeck and contains the

Diff for: compiler/rustc_middle/src/ty/print/pretty.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -2404,7 +2404,7 @@ fn for_each_def(tcx: TyCtxt<'_>, mut collect_fn: impl for<'b> FnMut(&'b Ident, N
24042404
// Iterate external crate defs but be mindful about visibility
24052405
while let Some(def) = queue.pop() {
24062406
for child in tcx.item_children(def).iter() {
2407-
if child.vis != ty::Visibility::Public {
2407+
if !child.vis.is_public() {
24082408
continue;
24092409
}
24102410

Diff for: compiler/rustc_privacy/src/lib.rs

+4-5
Original file line numberDiff line numberDiff line change
@@ -543,7 +543,7 @@ impl EmbargoVisitor<'tcx> {
543543
module: LocalDefId,
544544
) {
545545
let level = Some(AccessLevel::Reachable);
546-
if let ty::Visibility::Public = vis {
546+
if vis.is_public() {
547547
self.update(def_id, level);
548548
}
549549
match def_kind {
@@ -580,7 +580,7 @@ impl EmbargoVisitor<'tcx> {
580580

581581
DefKind::Struct | DefKind::Union => {
582582
// While structs and unions have type privacy, their fields do not.
583-
if let ty::Visibility::Public = vis {
583+
if vis.is_public() {
584584
let item =
585585
self.tcx.hir().expect_item(self.tcx.hir().local_def_id_to_hir_id(def_id));
586586
if let hir::ItemKind::Struct(ref struct_def, _)
@@ -933,7 +933,7 @@ impl Visitor<'tcx> for EmbargoVisitor<'tcx> {
933933
let def_id = self.tcx.hir().local_def_id(id);
934934
if let Some(exports) = self.tcx.module_exports(def_id) {
935935
for export in exports.iter() {
936-
if export.vis == ty::Visibility::Public {
936+
if export.vis.is_public() {
937937
if let Some(def_id) = export.res.opt_def_id() {
938938
if let Some(def_id) = def_id.as_local() {
939939
self.update(def_id, Some(AccessLevel::Exported));
@@ -1918,8 +1918,7 @@ impl SearchInterfaceForPrivateItemsVisitor<'tcx> {
19181918
/// 1. It's contained within a public type
19191919
/// 2. It comes from a private crate
19201920
fn leaks_private_dep(&self, item_id: DefId) -> bool {
1921-
let ret = self.required_visibility == ty::Visibility::Public
1922-
&& self.tcx.is_private_dep(item_id.krate);
1921+
let ret = self.required_visibility.is_public() && self.tcx.is_private_dep(item_id.krate);
19231922

19241923
tracing::debug!("leaks_private_dep(item_id={:?})={}", item_id, ret);
19251924
ret

Diff for: compiler/rustc_resolve/src/check_unused.rs

+1-2
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@ use rustc_ast::visit::{self, Visitor};
3232
use rustc_ast_lowering::ResolverAstLowering;
3333
use rustc_data_structures::fx::FxHashSet;
3434
use rustc_errors::pluralize;
35-
use rustc_middle::ty;
3635
use rustc_session::lint::builtin::{MACRO_USE_EXTERN_CRATE, UNUSED_IMPORTS};
3736
use rustc_session::lint::BuiltinLintDiagnostics;
3837
use rustc_span::{MultiSpan, Span, DUMMY_SP};
@@ -228,7 +227,7 @@ impl Resolver<'_> {
228227
for import in self.potentially_unused_imports.iter() {
229228
match import.kind {
230229
_ if import.used.get()
231-
|| import.vis.get() == ty::Visibility::Public
230+
|| import.vis.get().is_public()
232231
|| import.span.is_dummy() =>
233232
{
234233
if let ImportKind::MacroUse = import.kind {

Diff for: compiler/rustc_resolve/src/diagnostics.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ use rustc_hir::def::{self, CtorKind, CtorOf, DefKind, NonMacroAttrKind};
1111
use rustc_hir::def_id::{DefId, CRATE_DEF_INDEX, LOCAL_CRATE};
1212
use rustc_hir::PrimTy;
1313
use rustc_middle::bug;
14-
use rustc_middle::ty::{self, DefIdTree};
14+
use rustc_middle::ty::DefIdTree;
1515
use rustc_session::Session;
1616
use rustc_span::hygiene::MacroKind;
1717
use rustc_span::lev_distance::find_best_match_for_name;
@@ -1308,7 +1308,7 @@ impl<'a> Resolver<'a> {
13081308
);
13091309
let def_span = self.session.source_map().guess_head_span(binding.span);
13101310
let mut note_span = MultiSpan::from_span(def_span);
1311-
if !first && binding.vis == ty::Visibility::Public {
1311+
if !first && binding.vis.is_public() {
13121312
note_span.push_span_label(def_span, "consider importing it directly".into());
13131313
}
13141314
err.span_note(note_span, &msg);

Diff for: compiler/rustc_resolve/src/imports.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ fn pub_use_of_private_extern_crate_hack(import: &Import<'_>, binding: &NameBindi
164164
import: Import { kind: ImportKind::ExternCrate { .. }, .. },
165165
..
166166
},
167-
) => import.vis.get() == ty::Visibility::Public,
167+
) => import.vis.get().is_public(),
168168
_ => false,
169169
}
170170
}

Diff for: compiler/rustc_typeck/src/check/expr.rs

+2-5
Original file line numberDiff line numberDiff line change
@@ -35,14 +35,11 @@ use rustc_hir::{ExprKind, QPath};
3535
use rustc_infer::infer;
3636
use rustc_infer::infer::type_variable::{TypeVariableOrigin, TypeVariableOriginKind};
3737
use rustc_infer::infer::InferOk;
38-
use rustc_middle::ty;
3938
use rustc_middle::ty::adjustment::{Adjust, Adjustment, AllowTwoPhase};
4039
use rustc_middle::ty::error::TypeError::{FieldMisMatch, Sorts};
4140
use rustc_middle::ty::relate::expected_found_bool;
4241
use rustc_middle::ty::subst::SubstsRef;
43-
use rustc_middle::ty::Ty;
44-
use rustc_middle::ty::TypeFoldable;
45-
use rustc_middle::ty::{AdtKind, Visibility};
42+
use rustc_middle::ty::{self, AdtKind, Ty, TypeFoldable};
4643
use rustc_session::parse::feature_err;
4744
use rustc_span::edition::LATEST_STABLE_EDITION;
4845
use rustc_span::hygiene::DesugaringKind;
@@ -1732,7 +1729,7 @@ impl<'a, 'tcx> FnCtxt<'a, 'tcx> {
17321729
.filter_map(|field| {
17331730
// ignore already set fields and private fields from non-local crates
17341731
if skip.iter().any(|&x| x == field.ident.name)
1735-
|| (!variant.def_id.is_local() && field.vis != Visibility::Public)
1732+
|| (!variant.def_id.is_local() && !field.vis.is_public())
17361733
{
17371734
None
17381735
} else {

Diff for: compiler/rustc_typeck/src/check/method/suggest.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1410,7 +1410,7 @@ impl<'a, 'tcx> FnCtxt<'a, 'tcx> {
14101410
}
14111411
}
14121412
// We only want to suggest public or local traits (#45781).
1413-
item.vis == ty::Visibility::Public || info.def_id.is_local()
1413+
item.vis.is_public() || info.def_id.is_local()
14141414
})
14151415
.is_some()
14161416
})

Diff for: src/librustdoc/clean/inline.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -435,7 +435,7 @@ crate fn build_impl(
435435
tcx.associated_items(did)
436436
.in_definition_order()
437437
.filter_map(|item| {
438-
if associated_trait.is_some() || item.vis == ty::Visibility::Public {
438+
if associated_trait.is_some() || item.vis.is_public() {
439439
Some(item.clean(cx))
440440
} else {
441441
None
@@ -515,7 +515,7 @@ fn build_module(
515515
// two namespaces, so the target may be listed twice. Make sure we only
516516
// visit each node at most once.
517517
for &item in cx.tcx.item_children(did).iter() {
518-
if item.vis == ty::Visibility::Public {
518+
if item.vis.is_public() {
519519
let res = item.res.expect_non_local();
520520
if let Some(def_id) = res.mod_def_id() {
521521
if did == def_id || !visited.insert(def_id) {

Diff for: src/librustdoc/clean/mod.rs

+8-4
Original file line numberDiff line numberDiff line change
@@ -1881,7 +1881,7 @@ fn clean_extern_crate(
18811881
// this is the ID of the crate itself
18821882
let crate_def_id = DefId { krate: cnum, index: CRATE_DEF_INDEX };
18831883
let attrs = cx.tcx.hir().attrs(krate.hir_id());
1884-
let please_inline = krate.vis.node.is_pub()
1884+
let please_inline = cx.tcx.visibility(krate.def_id).is_public()
18851885
&& attrs.iter().any(|a| {
18861886
a.has_name(sym::doc)
18871887
&& match a.meta_item_list() {
@@ -1933,9 +1933,12 @@ fn clean_use_statement(
19331933
return Vec::new();
19341934
}
19351935

1936+
let visibility = cx.tcx.visibility(import.def_id);
19361937
let attrs = cx.tcx.hir().attrs(import.hir_id());
19371938
let inline_attr = attrs.lists(sym::doc).get_word_attr(sym::inline);
1938-
let pub_underscore = import.vis.node.is_pub() && name == kw::Underscore;
1939+
let pub_underscore = visibility.is_public() && name == kw::Underscore;
1940+
let current_mod = cx.tcx.parent_module_from_def_id(import.def_id);
1941+
let parent_mod = cx.tcx.parent_module_from_def_id(current_mod);
19391942

19401943
if pub_underscore {
19411944
if let Some(ref inline) = inline_attr {
@@ -1954,8 +1957,9 @@ fn clean_use_statement(
19541957
// forcefully don't inline if this is not public or if the
19551958
// #[doc(no_inline)] attribute is present.
19561959
// Don't inline doc(hidden) imports so they can be stripped at a later stage.
1957-
let mut denied = !(import.vis.node.is_pub()
1958-
|| (cx.render_options.document_private && import.vis.node.is_pub_restricted()))
1960+
let mut denied = !(visibility.is_public()
1961+
|| (cx.render_options.document_private
1962+
&& visibility.is_accessible_from(parent_mod.to_def_id(), cx.tcx)))
19591963
|| pub_underscore
19601964
|| attrs.iter().any(|a| {
19611965
a.has_name(sym::doc)

Diff for: src/librustdoc/clean/types.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ impl ExternalCrate {
254254
as_keyword(Res::Def(DefKind::Mod, id.def_id.to_def_id()))
255255
}
256256
hir::ItemKind::Use(path, hir::UseKind::Single)
257-
if item.vis.node.is_pub() =>
257+
if tcx.visibility(id.def_id).is_public() =>
258258
{
259259
as_keyword(path.res.expect_non_local())
260260
.map(|(_, prim)| (id.def_id.to_def_id(), prim))
@@ -320,7 +320,7 @@ impl ExternalCrate {
320320
as_primitive(Res::Def(DefKind::Mod, id.def_id.to_def_id()))
321321
}
322322
hir::ItemKind::Use(path, hir::UseKind::Single)
323-
if item.vis.node.is_pub() =>
323+
if tcx.visibility(id.def_id).is_public() =>
324324
{
325325
as_primitive(path.res.expect_non_local()).map(|(_, prim)| {
326326
// Pretend the primitive is local.

Diff for: src/librustdoc/visit_ast.rs

+5-8
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ use rustc_hir::CRATE_HIR_ID;
1010
use rustc_middle::middle::privacy::AccessLevel;
1111
use rustc_middle::ty::TyCtxt;
1212
use rustc_span::def_id::{CRATE_DEF_ID, LOCAL_CRATE};
13-
use rustc_span::source_map::Spanned;
1413
use rustc_span::symbol::{kw, sym, Symbol};
1514

1615
use std::mem;
@@ -72,9 +71,7 @@ impl<'a, 'tcx> RustdocVisitor<'a, 'tcx> {
7271
}
7372

7473
crate fn visit(mut self) -> Module<'tcx> {
75-
let span = self.cx.tcx.def_span(CRATE_DEF_ID);
7674
let mut top_level_module = self.visit_mod_contents(
77-
&Spanned { span, node: hir::VisibilityKind::Public },
7875
hir::CRATE_HIR_ID,
7976
self.cx.tcx.hir().root_module(),
8077
self.cx.tcx.crate_name(LOCAL_CRATE),
@@ -134,15 +131,15 @@ impl<'a, 'tcx> RustdocVisitor<'a, 'tcx> {
134131

135132
fn visit_mod_contents(
136133
&mut self,
137-
vis: &hir::Visibility<'_>,
138134
id: hir::HirId,
139135
m: &'tcx hir::Mod<'tcx>,
140136
name: Symbol,
141137
) -> Module<'tcx> {
142138
let mut om = Module::new(name, id, m.inner);
139+
let def_id = self.cx.tcx.hir().local_def_id(id).to_def_id();
143140
// Keep track of if there were any private modules in the path.
144141
let orig_inside_public_path = self.inside_public_path;
145-
self.inside_public_path &= vis.node.is_pub();
142+
self.inside_public_path &= self.cx.tcx.visibility(def_id).is_public();
146143
for &i in m.item_ids {
147144
let item = self.cx.tcx.hir().item(i);
148145
self.visit_item(item, None, &mut om);
@@ -259,7 +256,7 @@ impl<'a, 'tcx> RustdocVisitor<'a, 'tcx> {
259256
let name = renamed.unwrap_or(item.ident.name);
260257

261258
let def_id = item.def_id.to_def_id();
262-
let is_pub = item.vis.node.is_pub() || self.cx.tcx.has_attr(def_id, sym::macro_export);
259+
let is_pub = self.cx.tcx.visibility(def_id).is_public();
263260

264261
if is_pub {
265262
self.store_path(item.def_id.to_def_id());
@@ -332,7 +329,7 @@ impl<'a, 'tcx> RustdocVisitor<'a, 'tcx> {
332329
}
333330
}
334331
hir::ItemKind::Mod(ref m) => {
335-
om.mods.push(self.visit_mod_contents(&item.vis, item.hir_id(), m, name));
332+
om.mods.push(self.visit_mod_contents(item.hir_id(), m, name));
336333
}
337334
hir::ItemKind::Fn(..)
338335
| hir::ItemKind::ExternCrate(..)
@@ -368,7 +365,7 @@ impl<'a, 'tcx> RustdocVisitor<'a, 'tcx> {
368365
om: &mut Module<'tcx>,
369366
) {
370367
// If inlining we only want to include public functions.
371-
if !self.inlining || item.vis.node.is_pub() {
368+
if !self.inlining || self.cx.tcx.visibility(item.def_id).is_public() {
372369
om.foreigns.push((item, renamed));
373370
}
374371
}

Diff for: src/librustdoc/visit_lib.rs

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ use rustc_data_structures::fx::FxHashSet;
22
use rustc_hir::def::{DefKind, Res};
33
use rustc_hir::def_id::{CrateNum, DefId, CRATE_DEF_INDEX};
44
use rustc_middle::middle::privacy::{AccessLevel, AccessLevels};
5-
use rustc_middle::ty::{TyCtxt, Visibility};
5+
use rustc_middle::ty::TyCtxt;
66
use rustc_span::symbol::sym;
77

88
use crate::clean::{AttributesExt, NestedAttributesExt};
@@ -59,7 +59,7 @@ impl<'a, 'tcx> LibEmbargoVisitor<'a, 'tcx> {
5959
for item in self.tcx.item_children(def_id).iter() {
6060
if let Some(def_id) = item.res.opt_def_id() {
6161
if self.tcx.def_key(def_id).parent.map_or(false, |d| d == def_id.index)
62-
|| item.vis == Visibility::Public
62+
|| item.vis.is_public()
6363
{
6464
self.visit_item(item.res);
6565
}
@@ -70,7 +70,7 @@ impl<'a, 'tcx> LibEmbargoVisitor<'a, 'tcx> {
7070
fn visit_item(&mut self, res: Res<!>) {
7171
let def_id = res.def_id();
7272
let vis = self.tcx.visibility(def_id);
73-
let inherited_item_level = if vis == Visibility::Public { self.prev_level } else { None };
73+
let inherited_item_level = if vis.is_public() { self.prev_level } else { None };
7474

7575
let item_level = self.update(def_id, inherited_item_level);
7676

0 commit comments

Comments
 (0)