1 use rustc_data_structures::fx::FxHashSet;
2 use rustc_hir::def::{DefKind, Res};
3 use rustc_hir::def_id::{CrateNum, DefId, CRATE_DEF_INDEX};
4 use rustc_middle::middle::privacy::{AccessLevel, AccessLevels};
5 use rustc_middle::ty::{TyCtxt, Visibility};
6 use rustc_span::symbol::sym;
8 use crate::clean::{AttributesExt, NestedAttributesExt};
10 // FIXME: this may not be exhaustive, but is sufficient for rustdocs current uses
12 /// Similar to `librustc_privacy::EmbargoVisitor`, but also takes
13 /// specific rustdoc annotations into account (i.e., `doc(hidden)`)
14 crate struct LibEmbargoVisitor<'a, 'tcx> {
16 // Accessibility levels for reachable nodes
17 access_levels: &'a mut AccessLevels<DefId>,
18 // Previous accessibility level, None means unreachable
19 prev_level: Option<AccessLevel>,
20 // Keeps track of already visited modules, in case a module re-exports its parent
21 visited_mods: FxHashSet<DefId>,
24 impl<'a, 'tcx> LibEmbargoVisitor<'a, 'tcx> {
25 crate fn new(cx: &'a mut crate::core::DocContext<'tcx>) -> LibEmbargoVisitor<'a, 'tcx> {
28 access_levels: &mut cx.renderinfo.get_mut().access_levels,
29 prev_level: Some(AccessLevel::Public),
30 visited_mods: FxHashSet::default(),
34 crate fn visit_lib(&mut self, cnum: CrateNum) {
35 let did = DefId { krate: cnum, index: CRATE_DEF_INDEX };
36 self.update(did, Some(AccessLevel::Public));
40 // Updates node level and returns the updated level
41 fn update(&mut self, did: DefId, level: Option<AccessLevel>) -> Option<AccessLevel> {
42 let is_hidden = self.tcx.get_attrs(did).lists(sym::doc).has_word(sym::hidden);
44 let old_level = self.access_levels.map.get(&did).cloned();
45 // Accessibility levels can only grow
46 if level > old_level && !is_hidden {
47 self.access_levels.map.insert(did, level.unwrap());
54 crate fn visit_mod(&mut self, def_id: DefId) {
55 if !self.visited_mods.insert(def_id) {
59 for item in self.tcx.item_children(def_id).iter() {
60 if let Some(def_id) = item.res.opt_def_id() {
61 if self.tcx.def_key(def_id).parent.map_or(false, |d| d == def_id.index)
62 || item.vis == Visibility::Public
64 self.visit_item(item.res);
70 fn visit_item(&mut self, res: Res) {
71 let def_id = res.def_id();
72 let vis = self.tcx.visibility(def_id);
73 let inherited_item_level = if vis == Visibility::Public { self.prev_level } else { None };
75 let item_level = self.update(def_id, inherited_item_level);
77 if let Res::Def(DefKind::Mod, _) = res {
78 let orig_level = self.prev_level;
80 self.prev_level = item_level;
81 self.visit_mod(def_id);
82 self.prev_level = orig_level;