64 lines
2.1 KiB
Rust
64 lines
2.1 KiB
Rust
use rustc_hir::def_id::DefIdSet;
|
|
use rustc_span::symbol::sym;
|
|
use std::mem;
|
|
|
|
use crate::clean::Item;
|
|
use crate::clean::{self, AttributesExt, NestedAttributesExt};
|
|
use crate::core::DocContext;
|
|
use crate::fold::{DocFolder, StripItem};
|
|
use crate::passes::{ImplStripper, Pass};
|
|
|
|
crate const STRIP_HIDDEN: Pass = Pass {
|
|
name: "strip-hidden",
|
|
run: strip_hidden,
|
|
description: "strips all doc(hidden) items from the output",
|
|
};
|
|
|
|
/// Strip items marked `#[doc(hidden)]`
|
|
crate fn strip_hidden(krate: clean::Crate, _: &DocContext<'_>) -> clean::Crate {
|
|
let mut retained = DefIdSet::default();
|
|
|
|
// strip all #[doc(hidden)] items
|
|
let krate = {
|
|
let mut stripper = Stripper { retained: &mut retained, update_retained: true };
|
|
stripper.fold_crate(krate)
|
|
};
|
|
|
|
// strip all impls referencing stripped items
|
|
let mut stripper = ImplStripper { retained: &retained };
|
|
let krate = stripper.fold_crate(krate);
|
|
|
|
krate
|
|
}
|
|
|
|
struct Stripper<'a> {
|
|
retained: &'a mut DefIdSet,
|
|
update_retained: bool,
|
|
}
|
|
|
|
impl<'a> DocFolder for Stripper<'a> {
|
|
fn fold_item(&mut self, i: Item) -> Option<Item> {
|
|
if i.attrs.lists(sym::doc).has_word(sym::hidden) {
|
|
debug!("strip_hidden: stripping {:?} {:?}", i.type_(), i.name);
|
|
// use a dedicated hidden item for given item type if any
|
|
match i.kind {
|
|
clean::StructFieldItem(..) | clean::ModuleItem(..) => {
|
|
// We need to recurse into stripped modules to
|
|
// strip things like impl methods but when doing so
|
|
// we must not add any items to the `retained` set.
|
|
let old = mem::replace(&mut self.update_retained, false);
|
|
let ret = StripItem(self.fold_item_recur(i).unwrap()).strip();
|
|
self.update_retained = old;
|
|
return ret;
|
|
}
|
|
_ => return None,
|
|
}
|
|
} else {
|
|
if self.update_retained {
|
|
self.retained.insert(i.def_id);
|
|
}
|
|
}
|
|
self.fold_item_recur(i)
|
|
}
|
|
}
|