1 use crate::core::DocContext;
2 use rustc_data_structures::fx::FxHashSet;
3 use rustc_hir::def::DefKind;
4 use rustc_hir::def_id::DefId;
5 use rustc_middle::ty::TyCtxt;
7 // FIXME: this may not be exhaustive, but is sufficient for rustdocs current uses
10 pub(crate) struct RustdocEffectiveVisibilities {
11 extern_public: FxHashSet<DefId>,
14 macro_rules! define_method {
16 pub(crate) fn $method(&self, tcx: TyCtxt<'_>, def_id: DefId) -> bool {
17 match def_id.as_local() {
18 Some(def_id) => tcx.effective_visibilities(()).$method(def_id),
19 None => self.extern_public.contains(&def_id),
25 impl RustdocEffectiveVisibilities {
26 define_method!(is_directly_public);
27 define_method!(is_exported);
28 define_method!(is_reachable);
31 pub(crate) fn lib_embargo_visit_item(cx: &mut DocContext<'_>, def_id: DefId) {
32 assert!(!def_id.is_local());
35 extern_public: &mut cx.cache.effective_visibilities.extern_public,
36 visited_mods: Default::default(),
41 /// Similar to `librustc_privacy::EmbargoVisitor`, but also takes
42 /// specific rustdoc annotations into account (i.e., `doc(hidden)`)
43 struct LibEmbargoVisitor<'a, 'tcx> {
45 // Effective visibilities for reachable nodes
46 extern_public: &'a mut FxHashSet<DefId>,
47 // Keeps track of already visited modules, in case a module re-exports its parent
48 visited_mods: FxHashSet<DefId>,
51 impl LibEmbargoVisitor<'_, '_> {
52 fn visit_mod(&mut self, def_id: DefId) {
53 if !self.visited_mods.insert(def_id) {
57 for item in self.tcx.module_children(def_id).iter() {
58 if let Some(def_id) = item.res.opt_def_id() {
59 if item.vis.is_public() {
60 self.visit_item(def_id);
66 fn visit_item(&mut self, def_id: DefId) {
67 if !self.tcx.is_doc_hidden(def_id) {
68 self.extern_public.insert(def_id);
69 if self.tcx.def_kind(def_id) == DefKind::Mod {
70 self.visit_mod(def_id);