src/librustdoc/visit_lib.rs

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