| // Copyright 2012-2013 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. |
| |
| //! Rust AST Visitor. Extracts useful information and massages it into a form |
| //! usable for clean |
| |
| use std::collections::HashSet; |
| use std::mem; |
| |
| use syntax::abi; |
| use syntax::ast; |
| use syntax::attr; |
| use syntax::attr::AttrMetaMethods; |
| use syntax_pos::Span; |
| |
| use rustc::hir::map as hir_map; |
| use rustc::hir::def::Def; |
| use rustc::middle::privacy::AccessLevel; |
| |
| use rustc::hir; |
| |
| use core; |
| use clean::{self, Clean, Attributes}; |
| use doctree::*; |
| |
| // looks to me like the first two of these are actually |
| // output parameters, maybe only mutated once; perhaps |
| // better simply to have the visit method return a tuple |
| // containing them? |
| |
| // also, is there some reason that this doesn't use the 'visit' |
| // framework from syntax? |
| |
| pub struct RustdocVisitor<'a, 'tcx: 'a> { |
| pub module: Module, |
| pub attrs: hir::HirVec<ast::Attribute>, |
| pub cx: &'a core::DocContext<'a, 'tcx>, |
| view_item_stack: HashSet<ast::NodeId>, |
| inlining_from_glob: bool, |
| } |
| |
| impl<'a, 'tcx> RustdocVisitor<'a, 'tcx> { |
| pub fn new(cx: &'a core::DocContext<'a, 'tcx>) -> RustdocVisitor<'a, 'tcx> { |
| // If the root is reexported, terminate all recursion. |
| let mut stack = HashSet::new(); |
| stack.insert(ast::CRATE_NODE_ID); |
| RustdocVisitor { |
| module: Module::new(None), |
| attrs: hir::HirVec::new(), |
| cx: cx, |
| view_item_stack: stack, |
| inlining_from_glob: false, |
| } |
| } |
| |
| fn stability(&self, id: ast::NodeId) -> Option<attr::Stability> { |
| self.cx.tcx_opt().and_then(|tcx| { |
| self.cx.map.opt_local_def_id(id) |
| .and_then(|def_id| tcx.lookup_stability(def_id)) |
| .cloned() |
| }) |
| } |
| |
| fn deprecation(&self, id: ast::NodeId) -> Option<attr::Deprecation> { |
| self.cx.tcx_opt().and_then(|tcx| { |
| self.cx.map.opt_local_def_id(id) |
| .and_then(|def_id| tcx.lookup_deprecation(def_id)) |
| }) |
| } |
| |
| pub fn visit(&mut self, krate: &hir::Crate) { |
| self.attrs = krate.attrs.clone(); |
| |
| self.module = self.visit_mod_contents(krate.span, |
| krate.attrs.clone(), |
| hir::Public, |
| ast::CRATE_NODE_ID, |
| &krate.module, |
| None); |
| // attach the crate's exported macros to the top-level module: |
| self.module.macros = krate.exported_macros.iter() |
| .map(|def| self.visit_macro(def)).collect(); |
| self.module.is_crate = true; |
| } |
| |
| pub fn visit_variant_data(&mut self, item: &hir::Item, |
| name: ast::Name, sd: &hir::VariantData, |
| generics: &hir::Generics) -> Struct { |
| debug!("Visiting struct"); |
| let struct_type = struct_type_from_def(&*sd); |
| Struct { |
| id: item.id, |
| struct_type: struct_type, |
| name: name, |
| vis: item.vis.clone(), |
| stab: self.stability(item.id), |
| depr: self.deprecation(item.id), |
| attrs: item.attrs.clone(), |
| generics: generics.clone(), |
| fields: sd.fields().iter().cloned().collect(), |
| whence: item.span |
| } |
| } |
| |
| pub fn visit_enum_def(&mut self, it: &hir::Item, |
| name: ast::Name, def: &hir::EnumDef, |
| params: &hir::Generics) -> Enum { |
| debug!("Visiting enum"); |
| Enum { |
| name: name, |
| variants: def.variants.iter().map(|v| Variant { |
| name: v.node.name, |
| attrs: v.node.attrs.clone(), |
| stab: self.stability(v.node.data.id()), |
| depr: self.deprecation(v.node.data.id()), |
| def: v.node.data.clone(), |
| whence: v.span, |
| }).collect(), |
| vis: it.vis.clone(), |
| stab: self.stability(it.id), |
| depr: self.deprecation(it.id), |
| generics: params.clone(), |
| attrs: it.attrs.clone(), |
| id: it.id, |
| whence: it.span, |
| } |
| } |
| |
| pub fn visit_fn(&mut self, item: &hir::Item, |
| name: ast::Name, fd: &hir::FnDecl, |
| unsafety: &hir::Unsafety, |
| constness: hir::Constness, |
| abi: &abi::Abi, |
| gen: &hir::Generics) -> Function { |
| debug!("Visiting fn"); |
| Function { |
| id: item.id, |
| vis: item.vis.clone(), |
| stab: self.stability(item.id), |
| depr: self.deprecation(item.id), |
| attrs: item.attrs.clone(), |
| decl: fd.clone(), |
| name: name, |
| whence: item.span, |
| generics: gen.clone(), |
| unsafety: *unsafety, |
| constness: constness, |
| abi: *abi, |
| } |
| } |
| |
| pub fn visit_mod_contents(&mut self, span: Span, attrs: hir::HirVec<ast::Attribute>, |
| vis: hir::Visibility, id: ast::NodeId, |
| m: &hir::Mod, |
| name: Option<ast::Name>) -> Module { |
| let mut om = Module::new(name); |
| om.where_outer = span; |
| om.where_inner = m.inner; |
| om.attrs = attrs; |
| om.vis = vis.clone(); |
| om.stab = self.stability(id); |
| om.depr = self.deprecation(id); |
| om.id = id; |
| for i in &m.item_ids { |
| let item = self.cx.map.expect_item(i.id); |
| self.visit_item(item, None, &mut om); |
| } |
| om |
| } |
| |
| fn visit_view_path(&mut self, path: hir::ViewPath_, |
| om: &mut Module, |
| id: ast::NodeId, |
| please_inline: bool) -> Option<hir::ViewPath_> { |
| match path { |
| hir::ViewPathSimple(dst, base) => { |
| if self.maybe_inline_local(id, Some(dst), false, om, please_inline) { |
| None |
| } else { |
| Some(hir::ViewPathSimple(dst, base)) |
| } |
| } |
| hir::ViewPathList(p, paths) => { |
| let mine = paths.into_iter().filter(|path| { |
| !self.maybe_inline_local(path.node.id(), path.node.rename(), |
| false, om, please_inline) |
| }).collect::<hir::HirVec<hir::PathListItem>>(); |
| |
| if mine.is_empty() { |
| None |
| } else { |
| Some(hir::ViewPathList(p, mine)) |
| } |
| } |
| |
| hir::ViewPathGlob(base) => { |
| if self.maybe_inline_local(id, None, true, om, please_inline) { |
| None |
| } else { |
| Some(hir::ViewPathGlob(base)) |
| } |
| } |
| } |
| |
| } |
| |
| /// Tries to resolve the target of a `pub use` statement and inlines the |
| /// target if it is defined locally and would not be documented otherwise, |
| /// or when it is specifically requested with `please_inline`. |
| /// (the latter is the case when the import is marked `doc(inline)`) |
| /// |
| /// Cross-crate inlining occurs later on during crate cleaning |
| /// and follows different rules. |
| /// |
| /// Returns true if the target has been inlined. |
| fn maybe_inline_local(&mut self, id: ast::NodeId, renamed: Option<ast::Name>, |
| glob: bool, om: &mut Module, please_inline: bool) -> bool { |
| |
| fn inherits_doc_hidden(cx: &core::DocContext, mut node: ast::NodeId) -> bool { |
| while let Some(id) = cx.map.get_enclosing_scope(node) { |
| node = id; |
| let attrs = cx.map.attrs(node).clean(cx); |
| if attrs.list("doc").has_word("hidden") { |
| return true; |
| } |
| if node == ast::CRATE_NODE_ID { |
| break; |
| } |
| } |
| false |
| } |
| |
| let tcx = match self.cx.tcx_opt() { |
| Some(tcx) => tcx, |
| None => return false |
| }; |
| let def = tcx.expect_def(id); |
| let def_did = def.def_id(); |
| |
| let use_attrs = tcx.map.attrs(id).clean(self.cx); |
| // Don't inline doc(hidden) imports so they can be stripped at a later stage. |
| let is_no_inline = use_attrs.list("doc").has_word("no_inline") || |
| use_attrs.list("doc").has_word("hidden"); |
| |
| // For cross-crate impl inlining we need to know whether items are |
| // reachable in documentation - a previously nonreachable item can be |
| // made reachable by cross-crate inlining which we're checking here. |
| // (this is done here because we need to know this upfront) |
| if !def_did.is_local() && !is_no_inline { |
| let attrs = clean::inline::load_attrs(self.cx, tcx, def_did); |
| let self_is_hidden = attrs.list("doc").has_word("hidden"); |
| match def { |
| Def::Trait(did) | |
| Def::Struct(did) | |
| Def::Enum(did) | |
| Def::TyAlias(did) if !self_is_hidden => { |
| self.cx.access_levels.borrow_mut().map.insert(did, AccessLevel::Public); |
| }, |
| Def::Mod(did) => if !self_is_hidden { |
| ::visit_lib::LibEmbargoVisitor::new(self.cx).visit_mod(did); |
| }, |
| _ => {}, |
| } |
| return false |
| } |
| |
| let def_node_id = match tcx.map.as_local_node_id(def_did) { |
| Some(n) => n, None => return false |
| }; |
| |
| let is_private = !self.cx.access_levels.borrow().is_public(def_did); |
| let is_hidden = inherits_doc_hidden(self.cx, def_node_id); |
| |
| // Only inline if requested or if the item would otherwise be stripped |
| if (!please_inline && !is_private && !is_hidden) || is_no_inline { |
| return false |
| } |
| |
| if !self.view_item_stack.insert(def_node_id) { return false } |
| |
| let ret = match tcx.map.get(def_node_id) { |
| hir_map::NodeItem(it) => { |
| if glob { |
| let prev = mem::replace(&mut self.inlining_from_glob, true); |
| match it.node { |
| hir::ItemMod(ref m) => { |
| for i in &m.item_ids { |
| let i = self.cx.map.expect_item(i.id); |
| self.visit_item(i, None, om); |
| } |
| } |
| hir::ItemEnum(..) => {} |
| _ => { panic!("glob not mapped to a module or enum"); } |
| } |
| self.inlining_from_glob = prev; |
| } else { |
| self.visit_item(it, renamed, om); |
| } |
| true |
| } |
| _ => false, |
| }; |
| self.view_item_stack.remove(&def_node_id); |
| return ret; |
| } |
| |
| pub fn visit_item(&mut self, item: &hir::Item, |
| renamed: Option<ast::Name>, om: &mut Module) { |
| debug!("Visiting item {:?}", item); |
| let name = renamed.unwrap_or(item.name); |
| match item.node { |
| hir::ItemExternCrate(ref p) => { |
| let cstore = &self.cx.sess().cstore; |
| om.extern_crates.push(ExternCrate { |
| cnum: cstore.extern_mod_stmt_cnum(item.id) |
| .unwrap_or(ast::CrateNum::max_value()), |
| name: name, |
| path: p.map(|x|x.to_string()), |
| vis: item.vis.clone(), |
| attrs: item.attrs.clone(), |
| whence: item.span, |
| }) |
| } |
| hir::ItemUse(ref vpath) => { |
| let node = vpath.node.clone(); |
| let node = if item.vis == hir::Public { |
| let please_inline = item.attrs.iter().any(|item| { |
| match item.meta_item_list() { |
| Some(list) if &item.name()[..] == "doc" => { |
| list.iter().any(|i| &i.name()[..] == "inline") |
| } |
| _ => false, |
| } |
| }); |
| match self.visit_view_path(node, om, item.id, please_inline) { |
| None => return, |
| Some(p) => p |
| } |
| } else { |
| node |
| }; |
| om.imports.push(Import { |
| id: item.id, |
| vis: item.vis.clone(), |
| attrs: item.attrs.clone(), |
| node: node, |
| whence: item.span, |
| }); |
| } |
| hir::ItemMod(ref m) => { |
| om.mods.push(self.visit_mod_contents(item.span, |
| item.attrs.clone(), |
| item.vis.clone(), |
| item.id, |
| m, |
| Some(name))); |
| }, |
| hir::ItemEnum(ref ed, ref gen) => |
| om.enums.push(self.visit_enum_def(item, name, ed, gen)), |
| hir::ItemStruct(ref sd, ref gen) => |
| om.structs.push(self.visit_variant_data(item, name, sd, gen)), |
| hir::ItemFn(ref fd, ref unsafety, constness, ref abi, ref gen, _) => |
| om.fns.push(self.visit_fn(item, name, &**fd, unsafety, |
| constness, abi, gen)), |
| hir::ItemTy(ref ty, ref gen) => { |
| let t = Typedef { |
| ty: ty.clone(), |
| gen: gen.clone(), |
| name: name, |
| id: item.id, |
| attrs: item.attrs.clone(), |
| whence: item.span, |
| vis: item.vis.clone(), |
| stab: self.stability(item.id), |
| depr: self.deprecation(item.id), |
| }; |
| om.typedefs.push(t); |
| }, |
| hir::ItemStatic(ref ty, ref mut_, ref exp) => { |
| let s = Static { |
| type_: ty.clone(), |
| mutability: mut_.clone(), |
| expr: exp.clone(), |
| id: item.id, |
| name: name, |
| attrs: item.attrs.clone(), |
| whence: item.span, |
| vis: item.vis.clone(), |
| stab: self.stability(item.id), |
| depr: self.deprecation(item.id), |
| }; |
| om.statics.push(s); |
| }, |
| hir::ItemConst(ref ty, ref exp) => { |
| let s = Constant { |
| type_: ty.clone(), |
| expr: exp.clone(), |
| id: item.id, |
| name: name, |
| attrs: item.attrs.clone(), |
| whence: item.span, |
| vis: item.vis.clone(), |
| stab: self.stability(item.id), |
| depr: self.deprecation(item.id), |
| }; |
| om.constants.push(s); |
| }, |
| hir::ItemTrait(unsafety, ref gen, ref b, ref items) => { |
| let t = Trait { |
| unsafety: unsafety, |
| name: name, |
| items: items.clone(), |
| generics: gen.clone(), |
| bounds: b.iter().cloned().collect(), |
| id: item.id, |
| attrs: item.attrs.clone(), |
| whence: item.span, |
| vis: item.vis.clone(), |
| stab: self.stability(item.id), |
| depr: self.deprecation(item.id), |
| }; |
| om.traits.push(t); |
| }, |
| hir::ItemImpl(unsafety, polarity, ref gen, ref tr, ref ty, ref items) => { |
| let i = Impl { |
| unsafety: unsafety, |
| polarity: polarity, |
| generics: gen.clone(), |
| trait_: tr.clone(), |
| for_: ty.clone(), |
| items: items.clone(), |
| attrs: item.attrs.clone(), |
| id: item.id, |
| whence: item.span, |
| vis: item.vis.clone(), |
| stab: self.stability(item.id), |
| depr: self.deprecation(item.id), |
| }; |
| // Don't duplicate impls when inlining glob imports, we'll pick |
| // them up regardless of where they're located. |
| if !self.inlining_from_glob { |
| om.impls.push(i); |
| } |
| }, |
| hir::ItemDefaultImpl(unsafety, ref trait_ref) => { |
| let i = DefaultImpl { |
| unsafety: unsafety, |
| trait_: trait_ref.clone(), |
| id: item.id, |
| attrs: item.attrs.clone(), |
| whence: item.span, |
| }; |
| // see comment above about ItemImpl |
| if !self.inlining_from_glob { |
| om.def_traits.push(i); |
| } |
| } |
| hir::ItemForeignMod(ref fm) => { |
| om.foreigns.push(fm.clone()); |
| } |
| } |
| } |
| |
| // convert each exported_macro into a doc item |
| fn visit_macro(&self, def: &hir::MacroDef) -> Macro { |
| // Extract the spans of all matchers. They represent the "interface" of the macro. |
| let matchers = def.body.chunks(4).map(|arm| arm[0].get_span()).collect(); |
| |
| Macro { |
| id: def.id, |
| attrs: def.attrs.clone(), |
| name: def.name, |
| whence: def.span, |
| matchers: matchers, |
| stab: self.stability(def.id), |
| depr: self.deprecation(def.id), |
| imported_from: def.imported_from, |
| } |
| } |
| } |