2016-04-15 09:34:48 -05:00
|
|
|
// Copyright 2016 The Rust Project Developers. See the COPYRIGHT
|
|
|
|
// file at the top-level directory of this distribution and at
|
|
|
|
// http://rust-lang.org/COPYRIGHT.
|
|
|
|
//
|
|
|
|
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
|
|
|
|
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
|
|
|
|
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
|
|
|
|
// option. This file may not be copied, modified, or distributed
|
|
|
|
// except according to those terms.
|
|
|
|
|
2016-09-15 03:05:45 -05:00
|
|
|
use rustc::middle::cstore::CrateStore;
|
2016-04-15 09:34:48 -05:00
|
|
|
use rustc::middle::privacy::{AccessLevels, AccessLevel};
|
|
|
|
use rustc::hir::def::Def;
|
2016-08-31 06:00:29 -05:00
|
|
|
use rustc::hir::def_id::{CrateNum, CRATE_DEF_INDEX, DefId};
|
2016-04-15 09:34:48 -05:00
|
|
|
use rustc::ty::Visibility;
|
|
|
|
|
|
|
|
use std::cell::RefMut;
|
|
|
|
|
|
|
|
use clean::{Attributes, Clean};
|
|
|
|
|
2016-04-17 01:54:48 -05:00
|
|
|
// FIXME: this may not be exhaustive, but is sufficient for rustdocs current uses
|
2016-04-15 09:34:48 -05:00
|
|
|
|
|
|
|
/// Similar to `librustc_privacy::EmbargoVisitor`, but also takes
|
|
|
|
/// specific rustdoc annotations into account (i.e. `doc(hidden)`)
|
|
|
|
pub struct LibEmbargoVisitor<'a, 'b: 'a, 'tcx: 'b> {
|
|
|
|
cx: &'a ::core::DocContext<'b, 'tcx>,
|
|
|
|
cstore: &'a CrateStore<'tcx>,
|
|
|
|
// Accessibility levels for reachable nodes
|
|
|
|
access_levels: RefMut<'a, AccessLevels<DefId>>,
|
|
|
|
// Previous accessibility level, None means unreachable
|
|
|
|
prev_level: Option<AccessLevel>,
|
|
|
|
}
|
|
|
|
|
|
|
|
impl<'a, 'b, 'tcx> LibEmbargoVisitor<'a, 'b, 'tcx> {
|
|
|
|
pub fn new(cx: &'a ::core::DocContext<'b, 'tcx>) -> LibEmbargoVisitor<'a, 'b, 'tcx> {
|
|
|
|
LibEmbargoVisitor {
|
|
|
|
cx: cx,
|
|
|
|
cstore: &*cx.sess().cstore,
|
|
|
|
access_levels: cx.access_levels.borrow_mut(),
|
|
|
|
prev_level: Some(AccessLevel::Public),
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-08-31 06:00:29 -05:00
|
|
|
pub fn visit_lib(&mut self, cnum: CrateNum) {
|
2016-04-15 09:34:48 -05:00
|
|
|
let did = DefId { krate: cnum, index: CRATE_DEF_INDEX };
|
2016-04-25 01:24:50 -05:00
|
|
|
self.update(did, Some(AccessLevel::Public));
|
2016-04-15 09:34:48 -05:00
|
|
|
self.visit_mod(did);
|
|
|
|
}
|
|
|
|
|
|
|
|
// Updates node level and returns the updated level
|
|
|
|
fn update(&mut self, did: DefId, level: Option<AccessLevel>) -> Option<AccessLevel> {
|
|
|
|
let attrs: Vec<_> = self.cx.tcx().get_attrs(did).iter()
|
|
|
|
.map(|a| a.clean(self.cx))
|
|
|
|
.collect();
|
|
|
|
let is_hidden = attrs.list("doc").has_word("hidden");
|
|
|
|
|
|
|
|
let old_level = self.access_levels.map.get(&did).cloned();
|
|
|
|
// Accessibility levels can only grow
|
|
|
|
if level > old_level && !is_hidden {
|
|
|
|
self.access_levels.map.insert(did, level.unwrap());
|
|
|
|
level
|
|
|
|
} else {
|
|
|
|
old_level
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-09-15 03:05:45 -05:00
|
|
|
pub fn visit_mod(&mut self, def_id: DefId) {
|
|
|
|
for item in self.cstore.item_children(def_id) {
|
|
|
|
self.visit_item(item.def_id);
|
2016-04-15 09:34:48 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-09-15 03:05:45 -05:00
|
|
|
fn visit_item(&mut self, def_id: DefId) {
|
|
|
|
let vis = self.cstore.visibility(def_id);
|
|
|
|
let inherited_item_level = if vis == Visibility::Public {
|
2016-09-08 11:05:50 -05:00
|
|
|
self.prev_level
|
|
|
|
} else {
|
|
|
|
None
|
2016-04-15 09:34:48 -05:00
|
|
|
};
|
|
|
|
|
2016-09-15 03:05:45 -05:00
|
|
|
let item_level = self.update(def_id, inherited_item_level);
|
2016-04-15 09:34:48 -05:00
|
|
|
|
2016-09-15 03:05:45 -05:00
|
|
|
if let Some(Def::Mod(_)) = self.cstore.describe_def(def_id) {
|
2016-04-15 09:34:48 -05:00
|
|
|
let orig_level = self.prev_level;
|
|
|
|
|
|
|
|
self.prev_level = item_level;
|
2016-09-15 03:05:45 -05:00
|
|
|
self.visit_mod(def_id);
|
2016-04-15 09:34:48 -05:00
|
|
|
self.prev_level = orig_level;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|