src/librustdoc/visit_lib.rs

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