1 // Copyright 2012-2014 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.
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.
11 use rustc::hir::def_id::DefId;
12 use rustc::middle::privacy::AccessLevels;
13 use rustc::util::nodemap::DefIdSet;
16 use clean::{self, GetDefId, Item};
18 use fold::FoldItem::Strip;
22 pub use self::collapse_docs::collapse_docs;
25 pub use self::strip_hidden::strip_hidden;
28 pub use self::strip_private::strip_private;
30 mod strip_priv_imports;
31 pub use self::strip_priv_imports::strip_priv_imports;
33 mod unindent_comments;
34 pub use self::unindent_comments::unindent_comments;
36 mod propagate_doc_cfg;
37 pub use self::propagate_doc_cfg::propagate_doc_cfg;
39 type Pass = (&'static str, // name
40 fn(clean::Crate) -> plugins::PluginResult, // fn
41 &'static str); // description
43 pub const PASSES: &'static [Pass] = &[
44 ("strip-hidden", strip_hidden,
45 "strips all doc(hidden) items from the output"),
46 ("unindent-comments", unindent_comments,
47 "removes excess indentation on comments in order for markdown to like it"),
48 ("collapse-docs", collapse_docs,
49 "concatenates all document attributes into one document attribute"),
50 ("strip-private", strip_private,
51 "strips all private items from a crate which cannot be seen externally, \
52 implies strip-priv-imports"),
53 ("strip-priv-imports", strip_priv_imports,
54 "strips all private import statements (`use`, `extern crate`) from a crate"),
55 ("propagate-doc-cfg", propagate_doc_cfg,
56 "propagates `#[doc(cfg(...))]` to child items"),
59 pub const DEFAULT_PASSES: &'static [&'static str] = &[
69 retained: &'a mut DefIdSet,
70 access_levels: &'a AccessLevels<DefId>,
71 update_retained: bool,
74 impl<'a> fold::DocFolder for Stripper<'a> {
75 fn fold_item(&mut self, i: Item) -> Option<Item> {
77 clean::StrippedItem(..) => {
78 // We need to recurse into stripped modules to strip things
79 // like impl methods but when doing so we must not add any
80 // items to the `retained` set.
81 let old = mem::replace(&mut self.update_retained, false);
82 let ret = self.fold_item_recur(i);
83 self.update_retained = old;
86 // These items can all get re-exported
87 clean::TypedefItem(..) | clean::StaticItem(..) |
88 clean::StructItem(..) | clean::EnumItem(..) |
89 clean::TraitItem(..) | clean::FunctionItem(..) |
90 clean::VariantItem(..) | clean::MethodItem(..) |
91 clean::ForeignFunctionItem(..) | clean::ForeignStaticItem(..) |
92 clean::ConstantItem(..) | clean::UnionItem(..) |
93 clean::AssociatedConstItem(..) | clean::ForeignTypeItem => {
94 if i.def_id.is_local() {
95 if !self.access_levels.is_exported(i.def_id) {
101 clean::StructFieldItem(..) => {
102 if i.visibility != Some(clean::Public) {
103 return Strip(i).fold();
107 clean::ModuleItem(..) => {
108 if i.def_id.is_local() && i.visibility != Some(clean::Public) {
109 let old = mem::replace(&mut self.update_retained, false);
110 let ret = Strip(self.fold_item_recur(i).unwrap()).fold();
111 self.update_retained = old;
116 // handled in the `strip-priv-imports` pass
117 clean::ExternCrateItem(..) | clean::ImportItem(..) => {}
119 clean::AutoImplItem(..) | clean::ImplItem(..) => {}
121 // tymethods/macros have no control over privacy
122 clean::MacroItem(..) | clean::TyMethodItem(..) => {}
124 // Primitives are never stripped
125 clean::PrimitiveItem(..) => {}
127 // Associated types are never stripped
128 clean::AssociatedTypeItem(..) => {}
131 let fastreturn = match i.inner {
132 // nothing left to do for traits (don't want to filter their
133 // methods out, visibility controlled by the trait)
134 clean::TraitItem(..) => true,
136 // implementations of traits are always public.
137 clean::ImplItem(ref imp) if imp.trait_.is_some() => true,
138 // Struct variant fields have inherited visibility
139 clean::VariantItem(clean::Variant {
140 kind: clean::VariantKind::Struct(..)
145 let i = if fastreturn {
146 if self.update_retained {
147 self.retained.insert(i.def_id);
151 self.fold_item_recur(i)
154 if let Some(ref i) = i {
155 if self.update_retained {
156 self.retained.insert(i.def_id);
163 // This stripper discards all impls which reference stripped items
164 struct ImplStripper<'a> {
165 retained: &'a DefIdSet
168 impl<'a> fold::DocFolder for ImplStripper<'a> {
169 fn fold_item(&mut self, i: Item) -> Option<Item> {
170 if let clean::ImplItem(ref imp) = i.inner {
171 // emptied none trait impls can be stripped
172 if imp.trait_.is_none() && imp.items.is_empty() {
175 if let Some(did) = imp.for_.def_id() {
176 if did.is_local() && !imp.for_.is_generic() &&
177 !self.retained.contains(&did)
182 if let Some(did) = imp.trait_.def_id() {
183 if did.is_local() && !self.retained.contains(&did) {
187 if let Some(generics) = imp.trait_.as_ref().and_then(|t| t.generics()) {
188 for typaram in generics {
189 if let Some(did) = typaram.def_id() {
190 if did.is_local() && !self.retained.contains(&did) {
197 self.fold_item_recur(i)
201 // This stripper discards all private import statements (`use`, `extern crate`)
202 struct ImportStripper;
203 impl fold::DocFolder for ImportStripper {
204 fn fold_item(&mut self, i: Item) -> Option<Item> {
206 clean::ExternCrateItem(..) |
207 clean::ImportItem(..) if i.visibility != Some(clean::Public) => None,
208 _ => self.fold_item_recur(i)