src/librustdoc/visit_lib.rs

   1 use rustc::middle::privacy::{AccessLevels, AccessLevel};
   2 use rustc::hir::def::{Res, DefKind};
   3 use rustc::hir::def_id::{CrateNum, CRATE_DEF_INDEX, DefId};
   4 use rustc::ty::Visibility;
   5 use rustc::util::nodemap::FxHashSet;
   6 use syntax::symbol::sym;
   7
   8 use std::cell::RefMut;
   9
  10 use crate::clean::{AttributesExt, NestedAttributesExt};
  11
  12 // FIXME: this may not be exhaustive, but is sufficient for rustdocs current uses
  13
  14 /// Similar to `librustc_privacy::EmbargoVisitor`, but also takes
  15 /// specific rustdoc annotations into account (i.e., `doc(hidden)`)
  16 pub struct LibEmbargoVisitor<'a, 'tcx> {
  17     cx: &'a crate::core::DocContext<'tcx>,
  18     // Accessibility levels for reachable nodes
  19     access_levels: RefMut<'a, AccessLevels<DefId>>,
  20     // Previous accessibility level, None means unreachable
  21     prev_level: Option<AccessLevel>,
  22     // Keeps track of already visited modules, in case a module re-exports its parent
  23     visited_mods: FxHashSet<DefId>,
  24 }
  25
  26 impl<'a, 'tcx> LibEmbargoVisitor<'a, 'tcx> {
  27     pub fn new(
  28         cx: &'a crate::core::DocContext<'tcx>
  29     ) -> LibEmbargoVisitor<'a, 'tcx> {
  30         LibEmbargoVisitor {
  31             cx,
  32             access_levels: RefMut::map(cx.renderinfo.borrow_mut(), |ri| &mut ri.access_levels),
  33             prev_level: Some(AccessLevel::Public),
  34             visited_mods: FxHashSet::default()
  35         }
  36     }
  37
  38     pub fn visit_lib(&mut self, cnum: CrateNum) {
  39         let did = DefId { krate: cnum, index: CRATE_DEF_INDEX };
  40         self.update(did, Some(AccessLevel::Public));
  41         self.visit_mod(did);
  42     }
  43
  44     // Updates node level and returns the updated level
  45     fn update(&mut self, did: DefId, level: Option<AccessLevel>) -> Option<AccessLevel> {
  46         let is_hidden = self.cx.tcx.get_attrs(did).lists(sym::doc).has_word(sym::hidden);
  47
  48         let old_level = self.access_levels.map.get(&did).cloned();
  49         // Accessibility levels can only grow
  50         if level > old_level && !is_hidden {
  51             self.access_levels.map.insert(did, level.unwrap());
  52             level
  53         } else {
  54             old_level
  55         }
  56     }
  57
  58     pub fn visit_mod(&mut self, def_id: DefId) {
  59         if !self.visited_mods.insert(def_id) {
  60             return;
  61         }
  62
  63         for item in self.cx.tcx.item_children(def_id).iter() {
  64             if let Some(def_id) = item.res.opt_def_id() {
  65                 if self.cx.tcx.def_key(def_id).parent.map_or(false, |d| d == def_id.index) ||
  66                     item.vis == Visibility::Public {
  67                     self.visit_item(item.res);
  68                 }
  69             }
  70         }
  71     }
  72
  73     fn visit_item(&mut self, res: Res) {
  74         let def_id = res.def_id();
  75         let vis = self.cx.tcx.visibility(def_id);
  76         let inherited_item_level = if vis == Visibility::Public {
  77             self.prev_level
  78         } else {
  79             None
  80         };
  81
  82         let item_level = self.update(def_id, inherited_item_level);
  83
  84         if let Res::Def(DefKind::Mod, _) = res {
  85             let orig_level = self.prev_level;
  86
  87             self.prev_level = item_level;
  88             self.visit_mod(def_id);
  89             self.prev_level = orig_level;
  90         }
  91     }
  92 }