| //! Contains information about "passes", used to modify crate information during the documentation |
| //! process. |
| |
| use rustc::hir::def_id::DefId; |
| use rustc::lint as lint; |
| use rustc::middle::privacy::AccessLevels; |
| use rustc::util::nodemap::DefIdSet; |
| use std::mem; |
| use std::fmt; |
| use syntax::ast::NodeId; |
| |
| use clean::{self, GetDefId, Item}; |
| use core::{DocContext, DocAccessLevels}; |
| use fold; |
| use fold::StripItem; |
| |
| use html::markdown::{find_testable_code, ErrorCodes, LangString}; |
| |
| use self::collect_intra_doc_links::span_of_attrs; |
| |
| mod collapse_docs; |
| pub use self::collapse_docs::COLLAPSE_DOCS; |
| |
| mod strip_hidden; |
| pub use self::strip_hidden::STRIP_HIDDEN; |
| |
| mod strip_private; |
| pub use self::strip_private::STRIP_PRIVATE; |
| |
| mod strip_priv_imports; |
| pub use self::strip_priv_imports::STRIP_PRIV_IMPORTS; |
| |
| mod unindent_comments; |
| pub use self::unindent_comments::UNINDENT_COMMENTS; |
| |
| mod propagate_doc_cfg; |
| pub use self::propagate_doc_cfg::PROPAGATE_DOC_CFG; |
| |
| mod collect_intra_doc_links; |
| pub use self::collect_intra_doc_links::COLLECT_INTRA_DOC_LINKS; |
| |
| mod private_items_doc_tests; |
| pub use self::private_items_doc_tests::CHECK_PRIVATE_ITEMS_DOC_TESTS; |
| |
| mod collect_trait_impls; |
| pub use self::collect_trait_impls::COLLECT_TRAIT_IMPLS; |
| |
| /// Represents a single pass. |
| #[derive(Copy, Clone)] |
| pub enum Pass { |
| /// An "early pass" is run in the compiler context, and can gather information about types and |
| /// traits and the like. |
| EarlyPass { |
| name: &'static str, |
| pass: fn(clean::Crate, &DocContext) -> clean::Crate, |
| description: &'static str, |
| }, |
| /// A "late pass" is run between crate cleaning and page generation. |
| LatePass { |
| name: &'static str, |
| pass: fn(clean::Crate) -> clean::Crate, |
| description: &'static str, |
| }, |
| } |
| |
| impl fmt::Debug for Pass { |
| fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { |
| let mut dbg = match *self { |
| Pass::EarlyPass { .. } => f.debug_struct("EarlyPass"), |
| Pass::LatePass { .. } => f.debug_struct("LatePass"), |
| }; |
| |
| dbg.field("name", &self.name()) |
| .field("pass", &"...") |
| .field("description", &self.description()) |
| .finish() |
| } |
| } |
| |
| impl Pass { |
| /// Constructs a new early pass. |
| pub const fn early(name: &'static str, |
| pass: fn(clean::Crate, &DocContext) -> clean::Crate, |
| description: &'static str) -> Pass { |
| Pass::EarlyPass { name, pass, description } |
| } |
| |
| /// Constructs a new late pass. |
| pub const fn late(name: &'static str, |
| pass: fn(clean::Crate) -> clean::Crate, |
| description: &'static str) -> Pass { |
| Pass::LatePass { name, pass, description } |
| } |
| |
| /// Returns the name of this pass. |
| pub fn name(self) -> &'static str { |
| match self { |
| Pass::EarlyPass { name, .. } | |
| Pass::LatePass { name, .. } => name, |
| } |
| } |
| |
| /// Returns the description of this pass. |
| pub fn description(self) -> &'static str { |
| match self { |
| Pass::EarlyPass { description, .. } | |
| Pass::LatePass { description, .. } => description, |
| } |
| } |
| |
| /// If this pass is an early pass, returns the pointer to its function. |
| pub fn early_fn(self) -> Option<fn(clean::Crate, &DocContext) -> clean::Crate> { |
| match self { |
| Pass::EarlyPass { pass, .. } => Some(pass), |
| _ => None, |
| } |
| } |
| |
| /// If this pass is a late pass, returns the pointer to its function. |
| pub fn late_fn(self) -> Option<fn(clean::Crate) -> clean::Crate> { |
| match self { |
| Pass::LatePass { pass, .. } => Some(pass), |
| _ => None, |
| } |
| } |
| } |
| |
| /// The full list of passes. |
| pub const PASSES: &'static [Pass] = &[ |
| CHECK_PRIVATE_ITEMS_DOC_TESTS, |
| STRIP_HIDDEN, |
| UNINDENT_COMMENTS, |
| COLLAPSE_DOCS, |
| STRIP_PRIVATE, |
| STRIP_PRIV_IMPORTS, |
| PROPAGATE_DOC_CFG, |
| COLLECT_INTRA_DOC_LINKS, |
| COLLECT_TRAIT_IMPLS, |
| ]; |
| |
| /// The list of passes run by default. |
| pub const DEFAULT_PASSES: &'static [&'static str] = &[ |
| "collect-trait-impls", |
| "check-private-items-doc-tests", |
| "strip-hidden", |
| "strip-private", |
| "collect-intra-doc-links", |
| "collapse-docs", |
| "unindent-comments", |
| "propagate-doc-cfg", |
| ]; |
| |
| /// The list of default passes run with `--document-private-items` is passed to rustdoc. |
| pub const DEFAULT_PRIVATE_PASSES: &'static [&'static str] = &[ |
| "collect-trait-impls", |
| "check-private-items-doc-tests", |
| "strip-priv-imports", |
| "collect-intra-doc-links", |
| "collapse-docs", |
| "unindent-comments", |
| "propagate-doc-cfg", |
| ]; |
| |
| /// A shorthand way to refer to which set of passes to use, based on the presence of |
| /// `--no-defaults` or `--document-private-items`. |
| #[derive(Copy, Clone, PartialEq, Eq, Debug)] |
| pub enum DefaultPassOption { |
| Default, |
| Private, |
| None, |
| } |
| |
| /// Returns the given default set of passes. |
| pub fn defaults(default_set: DefaultPassOption) -> &'static [&'static str] { |
| match default_set { |
| DefaultPassOption::Default => DEFAULT_PASSES, |
| DefaultPassOption::Private => DEFAULT_PRIVATE_PASSES, |
| DefaultPassOption::None => &[], |
| } |
| } |
| |
| /// If the given name matches a known pass, returns its information. |
| pub fn find_pass(pass_name: &str) -> Option<Pass> { |
| PASSES.iter().find(|p| p.name() == pass_name).cloned() |
| } |
| |
| struct Stripper<'a> { |
| retained: &'a mut DefIdSet, |
| access_levels: &'a AccessLevels<DefId>, |
| update_retained: bool, |
| } |
| |
| impl<'a> fold::DocFolder for Stripper<'a> { |
| fn fold_item(&mut self, i: Item) -> Option<Item> { |
| match i.inner { |
| clean::StrippedItem(..) => { |
| // 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. |
| debug!("Stripper: recursing into stripped {} {:?}", i.type_(), i.name); |
| let old = mem::replace(&mut self.update_retained, false); |
| let ret = self.fold_item_recur(i); |
| self.update_retained = old; |
| return ret; |
| } |
| // These items can all get re-exported |
| clean::ExistentialItem(..) |
| | clean::TypedefItem(..) |
| | clean::StaticItem(..) |
| | clean::StructItem(..) |
| | clean::EnumItem(..) |
| | clean::TraitItem(..) |
| | clean::FunctionItem(..) |
| | clean::VariantItem(..) |
| | clean::MethodItem(..) |
| | clean::ForeignFunctionItem(..) |
| | clean::ForeignStaticItem(..) |
| | clean::ConstantItem(..) |
| | clean::UnionItem(..) |
| | clean::AssociatedConstItem(..) |
| | clean::ForeignTypeItem => { |
| if i.def_id.is_local() { |
| if !self.access_levels.is_exported(i.def_id) { |
| debug!("Stripper: stripping {} {:?}", i.type_(), i.name); |
| return None; |
| } |
| } |
| } |
| |
| clean::StructFieldItem(..) => { |
| if i.visibility != Some(clean::Public) { |
| return StripItem(i).strip(); |
| } |
| } |
| |
| clean::ModuleItem(..) => { |
| if i.def_id.is_local() && i.visibility != Some(clean::Public) { |
| debug!("Stripper: stripping module {:?}", i.name); |
| 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; |
| } |
| } |
| |
| // handled in the `strip-priv-imports` pass |
| clean::ExternCrateItem(..) | clean::ImportItem(..) => {} |
| |
| clean::ImplItem(..) => {} |
| |
| // tymethods/macros have no control over privacy |
| clean::MacroItem(..) | clean::TyMethodItem(..) => {} |
| |
| // Proc-macros are always public |
| clean::ProcMacroItem(..) => {} |
| |
| // Primitives are never stripped |
| clean::PrimitiveItem(..) => {} |
| |
| // Associated types are never stripped |
| clean::AssociatedTypeItem(..) => {} |
| |
| // Keywords are never stripped |
| clean::KeywordItem(..) => {} |
| } |
| |
| let fastreturn = match i.inner { |
| // nothing left to do for traits (don't want to filter their |
| // methods out, visibility controlled by the trait) |
| clean::TraitItem(..) => true, |
| |
| // implementations of traits are always public. |
| clean::ImplItem(ref imp) if imp.trait_.is_some() => true, |
| // Struct variant fields have inherited visibility |
| clean::VariantItem(clean::Variant { |
| kind: clean::VariantKind::Struct(..), |
| }) => true, |
| _ => false, |
| }; |
| |
| let i = if fastreturn { |
| if self.update_retained { |
| self.retained.insert(i.def_id); |
| } |
| return Some(i); |
| } else { |
| self.fold_item_recur(i) |
| }; |
| |
| if let Some(ref i) = i { |
| if self.update_retained { |
| self.retained.insert(i.def_id); |
| } |
| } |
| i |
| } |
| } |
| |
| // This stripper discards all impls which reference stripped items |
| struct ImplStripper<'a> { |
| retained: &'a DefIdSet, |
| } |
| |
| impl<'a> fold::DocFolder for ImplStripper<'a> { |
| fn fold_item(&mut self, i: Item) -> Option<Item> { |
| if let clean::ImplItem(ref imp) = i.inner { |
| // emptied none trait impls can be stripped |
| if imp.trait_.is_none() && imp.items.is_empty() { |
| return None; |
| } |
| if let Some(did) = imp.for_.def_id() { |
| if did.is_local() && !imp.for_.is_generic() && !self.retained.contains(&did) { |
| debug!("ImplStripper: impl item for stripped type; removing"); |
| return None; |
| } |
| } |
| if let Some(did) = imp.trait_.def_id() { |
| if did.is_local() && !self.retained.contains(&did) { |
| debug!("ImplStripper: impl item for stripped trait; removing"); |
| return None; |
| } |
| } |
| if let Some(generics) = imp.trait_.as_ref().and_then(|t| t.generics()) { |
| for typaram in generics { |
| if let Some(did) = typaram.def_id() { |
| if did.is_local() && !self.retained.contains(&did) { |
| debug!("ImplStripper: stripped item in trait's generics; \ |
| removing impl"); |
| return None; |
| } |
| } |
| } |
| } |
| } |
| self.fold_item_recur(i) |
| } |
| } |
| |
| // This stripper discards all private import statements (`use`, `extern crate`) |
| struct ImportStripper; |
| impl fold::DocFolder for ImportStripper { |
| fn fold_item(&mut self, i: Item) -> Option<Item> { |
| match i.inner { |
| clean::ExternCrateItem(..) | clean::ImportItem(..) |
| if i.visibility != Some(clean::Public) => |
| { |
| None |
| } |
| _ => self.fold_item_recur(i), |
| } |
| } |
| } |
| |
| pub fn look_for_tests<'a, 'tcx: 'a, 'rcx: 'a>( |
| cx: &'a DocContext<'a, 'tcx, 'rcx>, |
| dox: &str, |
| item: &Item, |
| check_missing_code: bool, |
| ) { |
| if cx.as_local_node_id(item.def_id).is_none() { |
| // If non-local, no need to check anything. |
| return; |
| } |
| |
| struct Tests { |
| found_tests: usize, |
| } |
| |
| impl ::test::Tester for Tests { |
| fn add_test(&mut self, _: String, _: LangString, _: usize) { |
| self.found_tests += 1; |
| } |
| } |
| |
| let mut tests = Tests { |
| found_tests: 0, |
| }; |
| |
| if find_testable_code(&dox, &mut tests, ErrorCodes::No).is_ok() { |
| if check_missing_code == true && tests.found_tests == 0 { |
| let mut diag = cx.tcx.struct_span_lint_node( |
| lint::builtin::MISSING_DOC_CODE_EXAMPLES, |
| NodeId::from_u32(0), |
| span_of_attrs(&item.attrs), |
| "Missing code example in this documentation"); |
| diag.emit(); |
| } else if check_missing_code == false && |
| tests.found_tests > 0 && |
| !cx.renderinfo.borrow().access_levels.is_doc_reachable(item.def_id) { |
| let mut diag = cx.tcx.struct_span_lint_node( |
| lint::builtin::PRIVATE_DOC_TESTS, |
| NodeId::from_u32(0), |
| span_of_attrs(&item.attrs), |
| "Documentation test in private item"); |
| diag.emit(); |
| } |
| } |
| } |