src/librustdoc/visit_ast.rs

   1 //! The Rust AST Visitor. Extracts useful information and massages it into a form
   2 //! usable for `clean`.
   3
   4 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
   5 use rustc_hir as hir;
   6 use rustc_hir::def::{DefKind, Res};
   7 use rustc_hir::def_id::DefId;
   8 use rustc_hir::Node;
   9 use rustc_hir::CRATE_HIR_ID;
  10 use rustc_middle::middle::privacy::AccessLevel;
  11 use rustc_middle::ty::TyCtxt;
  12 use rustc_span;
  13 use rustc_span::def_id::{CRATE_DEF_ID, LOCAL_CRATE};
  14 use rustc_span::source_map::Spanned;
  15 use rustc_span::symbol::{kw, sym, Symbol};
  16
  17 use std::mem;
  18
  19 use crate::clean::{self, cfg::Cfg, AttributesExt, NestedAttributesExt};
  20 use crate::core;
  21 use crate::doctree::*;
  22
  23 // FIXME: Should this be replaced with tcx.def_path_str?
  24 fn def_id_to_path(tcx: TyCtxt<'_>, did: DefId) -> Vec<String> {
  25     let crate_name = tcx.crate_name(did.krate).to_string();
  26     let relative = tcx.def_path(did).data.into_iter().filter_map(|elem| {
  27         // extern blocks have an empty name
  28         let s = elem.data.to_string();
  29         if !s.is_empty() { Some(s) } else { None }
  30     });
  31     std::iter::once(crate_name).chain(relative).collect()
  32 }
  33
  34 crate fn inherits_doc_hidden(tcx: TyCtxt<'_>, mut node: hir::HirId) -> bool {
  35     while let Some(id) = tcx.hir().get_enclosing_scope(node) {
  36         node = id;
  37         if tcx.hir().attrs(node).lists(sym::doc).has_word(sym::hidden) {
  38             return true;
  39         }
  40     }
  41     false
  42 }
  43
  44 // Also, is there some reason that this doesn't use the 'visit'
  45 // framework from syntax?.
  46
  47 crate struct RustdocVisitor<'a, 'tcx> {
  48     cx: &'a mut core::DocContext<'tcx>,
  49     view_item_stack: FxHashSet<hir::HirId>,
  50     inlining: bool,
  51     /// Are the current module and all of its parents public?
  52     inside_public_path: bool,
  53     exact_paths: FxHashMap<DefId, Vec<String>>,
  54 }
  55
  56 impl<'a, 'tcx> RustdocVisitor<'a, 'tcx> {
  57     crate fn new(cx: &'a mut core::DocContext<'tcx>) -> RustdocVisitor<'a, 'tcx> {
  58         // If the root is re-exported, terminate all recursion.
  59         let mut stack = FxHashSet::default();
  60         stack.insert(hir::CRATE_HIR_ID);
  61         RustdocVisitor {
  62             cx,
  63             view_item_stack: stack,
  64             inlining: false,
  65             inside_public_path: true,
  66             exact_paths: FxHashMap::default(),
  67         }
  68     }
  69
  70     fn store_path(&mut self, did: DefId) {
  71         let tcx = self.cx.tcx;
  72         self.exact_paths.entry(did).or_insert_with(|| def_id_to_path(tcx, did));
  73     }
  74
  75     crate fn visit(mut self) -> Module<'tcx> {
  76         let span = self.cx.tcx.def_span(CRATE_DEF_ID);
  77         let mut top_level_module = self.visit_mod_contents(
  78             &Spanned { span, node: hir::VisibilityKind::Public },
  79             hir::CRATE_HIR_ID,
  80             self.cx.tcx.hir().root_module(),
  81             self.cx.tcx.crate_name(LOCAL_CRATE),
  82         );
  83
  84         // `#[macro_export] macro_rules!` items are reexported at the top level of the
  85         // crate, regardless of where they're defined. We want to document the
  86         // top level rexport of the macro, not its original definition, since
  87         // the rexport defines the path that a user will actually see. Accordingly,
  88         // we add the rexport as an item here, and then skip over the original
  89         // definition in `visit_item()` below.
  90         for export in self.cx.tcx.module_exports(CRATE_DEF_ID).unwrap_or(&[]) {
  91             if let Res::Def(DefKind::Macro(_), def_id) = export.res {
  92                 if let Some(local_def_id) = def_id.as_local() {
  93                     if self.cx.tcx.has_attr(def_id, sym::macro_export) {
  94                         let hir_id = self.cx.tcx.hir().local_def_id_to_hir_id(local_def_id);
  95                         let item = self.cx.tcx.hir().expect_item(hir_id);
  96                         top_level_module.items.push((item, None));
  97                     }
  98                 }
  99             }
 100         }
 101
 102         self.cx.cache.hidden_cfg = self
 103             .cx
 104             .tcx
 105             .hir()
 106             .attrs(CRATE_HIR_ID)
 107             .iter()
 108             .filter(|attr| attr.has_name(sym::doc))
 109             .flat_map(|attr| attr.meta_item_list().into_iter().flatten())
 110             .filter(|attr| attr.has_name(sym::cfg_hide))
 111             .flat_map(|attr| {
 112                 attr.meta_item_list()
 113                     .unwrap_or(&[])
 114                     .iter()
 115                     .filter_map(|attr| {
 116                         Some(
 117                             Cfg::parse(attr.meta_item()?)
 118                                 .map_err(|e| self.cx.sess().diagnostic().span_err(e.span, e.msg))
 119                                 .ok()?,
 120                         )
 121                     })
 122                     .collect::<Vec<_>>()
 123             })
 124             .collect();
 125
 126         self.cx.cache.exact_paths = self.exact_paths;
 127         top_level_module
 128     }
 129
 130     fn visit_mod_contents(
 131         &mut self,
 132         vis: &hir::Visibility<'_>,
 133         id: hir::HirId,
 134         m: &'tcx hir::Mod<'tcx>,
 135         name: Symbol,
 136     ) -> Module<'tcx> {
 137         let mut om = Module::new(name, id, m.inner);
 138         // Keep track of if there were any private modules in the path.
 139         let orig_inside_public_path = self.inside_public_path;
 140         self.inside_public_path &= vis.node.is_pub();
 141         for &i in m.item_ids {
 142             let item = self.cx.tcx.hir().item(i);
 143             self.visit_item(item, None, &mut om);
 144         }
 145         self.inside_public_path = orig_inside_public_path;
 146         om
 147     }
 148
 149     /// Tries to resolve the target of a `pub use` statement and inlines the
 150     /// target if it is defined locally and would not be documented otherwise,
 151     /// or when it is specifically requested with `please_inline`.
 152     /// (the latter is the case when the import is marked `doc(inline)`)
 153     ///
 154     /// Cross-crate inlining occurs later on during crate cleaning
 155     /// and follows different rules.
 156     ///
 157     /// Returns `true` if the target has been inlined.
 158     fn maybe_inline_local(
 159         &mut self,
 160         id: hir::HirId,
 161         res: Res,
 162         renamed: Option<Symbol>,
 163         glob: bool,
 164         om: &mut Module<'tcx>,
 165         please_inline: bool,
 166     ) -> bool {
 167         debug!("maybe_inline_local res: {:?}", res);
 168
 169         let tcx = self.cx.tcx;
 170         let res_did = if let Some(did) = res.opt_def_id() {
 171             did
 172         } else {
 173             return false;
 174         };
 175
 176         let use_attrs = tcx.hir().attrs(id);
 177         // Don't inline `doc(hidden)` imports so they can be stripped at a later stage.
 178         let is_no_inline = use_attrs.lists(sym::doc).has_word(sym::no_inline)
 179             || use_attrs.lists(sym::doc).has_word(sym::hidden);
 180
 181         // For cross-crate impl inlining we need to know whether items are
 182         // reachable in documentation -- a previously unreachable item can be
 183         // made reachable by cross-crate inlining which we're checking here.
 184         // (this is done here because we need to know this upfront).
 185         if !res_did.is_local() && !is_no_inline {
 186             let attrs = clean::inline::load_attrs(self.cx, res_did);
 187             let self_is_hidden = attrs.lists(sym::doc).has_word(sym::hidden);
 188             if !self_is_hidden {
 189                 if let Res::Def(kind, did) = res {
 190                     if kind == DefKind::Mod {
 191                         crate::visit_lib::LibEmbargoVisitor::new(self.cx).visit_mod(did)
 192                     } else {
 193                         // All items need to be handled here in case someone wishes to link
 194                         // to them with intra-doc links
 195                         self.cx.cache.access_levels.map.insert(did, AccessLevel::Public);
 196                     }
 197                 }
 198             }
 199             return false;
 200         }
 201
 202         let res_hir_id = match res_did.as_local() {
 203             Some(n) => tcx.hir().local_def_id_to_hir_id(n),
 204             None => return false,
 205         };
 206
 207         let is_private = !self.cx.cache.access_levels.is_public(res_did);
 208         let is_hidden = inherits_doc_hidden(self.cx.tcx, res_hir_id);
 209
 210         // Only inline if requested or if the item would otherwise be stripped.
 211         if (!please_inline && !is_private && !is_hidden) || is_no_inline {
 212             return false;
 213         }
 214
 215         if !self.view_item_stack.insert(res_hir_id) {
 216             return false;
 217         }
 218
 219         let ret = match tcx.hir().get(res_hir_id) {
 220             Node::Item(&hir::Item { kind: hir::ItemKind::Mod(ref m), .. }) if glob => {
 221                 let prev = mem::replace(&mut self.inlining, true);
 222                 for &i in m.item_ids {
 223                     let i = self.cx.tcx.hir().item(i);
 224                     self.visit_item(i, None, om);
 225                 }
 226                 self.inlining = prev;
 227                 true
 228             }
 229             Node::Item(it) if !glob => {
 230                 let prev = mem::replace(&mut self.inlining, true);
 231                 self.visit_item(it, renamed, om);
 232                 self.inlining = prev;
 233                 true
 234             }
 235             Node::ForeignItem(it) if !glob => {
 236                 let prev = mem::replace(&mut self.inlining, true);
 237                 self.visit_foreign_item(it, renamed, om);
 238                 self.inlining = prev;
 239                 true
 240             }
 241             _ => false,
 242         };
 243         self.view_item_stack.remove(&res_hir_id);
 244         ret
 245     }
 246
 247     fn visit_item(
 248         &mut self,
 249         item: &'tcx hir::Item<'_>,
 250         renamed: Option<Symbol>,
 251         om: &mut Module<'tcx>,
 252     ) {
 253         debug!("visiting item {:?}", item);
 254         let name = renamed.unwrap_or(item.ident.name);
 255
 256         let def_id = item.def_id.to_def_id();
 257         let is_pub = item.vis.node.is_pub() || self.cx.tcx.has_attr(def_id, sym::macro_export);
 258
 259         if is_pub {
 260             self.store_path(item.def_id.to_def_id());
 261         }
 262
 263         match item.kind {
 264             hir::ItemKind::ForeignMod { items, .. } => {
 265                 for item in items {
 266                     let item = self.cx.tcx.hir().foreign_item(item.id);
 267                     self.visit_foreign_item(item, None, om);
 268                 }
 269             }
 270             // If we're inlining, skip private items.
 271             _ if self.inlining && !is_pub => {}
 272             hir::ItemKind::GlobalAsm(..) => {}
 273             hir::ItemKind::Use(_, hir::UseKind::ListStem) => {}
 274             hir::ItemKind::Use(ref path, kind) => {
 275                 let is_glob = kind == hir::UseKind::Glob;
 276
 277                 // Struct and variant constructors and proc macro stubs always show up alongside
 278                 // their definitions, we've already processed them so just discard these.
 279                 if let Res::Def(DefKind::Ctor(..), _) | Res::SelfCtor(..) = path.res {
 280                     return;
 281                 }
 282
 283                 let attrs = self.cx.tcx.hir().attrs(item.hir_id());
 284
 285                 // If there was a private module in the current path then don't bother inlining
 286                 // anything as it will probably be stripped anyway.
 287                 if is_pub && self.inside_public_path {
 288                     let please_inline = attrs.iter().any(|item| match item.meta_item_list() {
 289                         Some(ref list) if item.has_name(sym::doc) => {
 290                             list.iter().any(|i| i.has_name(sym::inline))
 291                         }
 292                         _ => false,
 293                     });
 294                     let ident = if is_glob { None } else { Some(name) };
 295                     if self.maybe_inline_local(
 296                         item.hir_id(),
 297                         path.res,
 298                         ident,
 299                         is_glob,
 300                         om,
 301                         please_inline,
 302                     ) {
 303                         return;
 304                     }
 305                 }
 306
 307                 om.items.push((item, renamed))
 308             }
 309             hir::ItemKind::Macro(ref macro_def) => {
 310                 // `#[macro_export] macro_rules!` items are handled seperately in `visit()`,
 311                 // above, since they need to be documented at the module top level. Accordingly,
 312                 // we only want to handle macros if one of three conditions holds:
 313                 //
 314                 // 1. This macro was defined by `macro`, and thus isn't covered by the case
 315                 //    above.
 316                 // 2. This macro isn't marked with `#[macro_export]`, and thus isn't covered
 317                 //    by the case above.
 318                 // 3. We're inlining, since a reexport where inlining has been requested
 319                 //    should be inlined even if it is also documented at the top level.
 320
 321                 let def_id = item.def_id.to_def_id();
 322                 let is_macro_2_0 = !macro_def.macro_rules;
 323                 let nonexported = !self.cx.tcx.has_attr(def_id, sym::macro_export);
 324
 325                 if is_macro_2_0 || nonexported || self.inlining {
 326                     om.items.push((item, renamed));
 327                 }
 328             }
 329             hir::ItemKind::Mod(ref m) => {
 330                 om.mods.push(self.visit_mod_contents(&item.vis, item.hir_id(), m, name));
 331             }
 332             hir::ItemKind::Fn(..)
 333             | hir::ItemKind::ExternCrate(..)
 334             | hir::ItemKind::Enum(..)
 335             | hir::ItemKind::Struct(..)
 336             | hir::ItemKind::Union(..)
 337             | hir::ItemKind::TyAlias(..)
 338             | hir::ItemKind::OpaqueTy(..)
 339             | hir::ItemKind::Static(..)
 340             | hir::ItemKind::Trait(..)
 341             | hir::ItemKind::TraitAlias(..) => om.items.push((item, renamed)),
 342             hir::ItemKind::Const(..) => {
 343                 // Underscore constants do not correspond to a nameable item and
 344                 // so are never useful in documentation.
 345                 if name != kw::Underscore {
 346                     om.items.push((item, renamed));
 347                 }
 348             }
 349             hir::ItemKind::Impl(ref impl_) => {
 350                 // Don't duplicate impls when inlining or if it's implementing a trait, we'll pick
 351                 // them up regardless of where they're located.
 352                 if !self.inlining && impl_.of_trait.is_none() {
 353                     om.items.push((item, None));
 354                 }
 355             }
 356         }
 357     }
 358
 359     fn visit_foreign_item(
 360         &mut self,
 361         item: &'tcx hir::ForeignItem<'_>,
 362         renamed: Option<Symbol>,
 363         om: &mut Module<'tcx>,
 364     ) {
 365         // If inlining we only want to include public functions.
 366         if !self.inlining || item.vis.node.is_pub() {
 367             om.foreigns.push((item, renamed));
 368         }
 369     }
 370 }