src/librustdoc/visit_ast.rs

   1 // Copyright 2012-2013 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.
   4 //
   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.
  10
  11 //! Rust AST Visitor. Extracts useful information and massages it into a form
  12 //! usable for clean
  13
  14 use std::mem;
  15
  16 use rustc_target::spec::abi;
  17 use syntax::ast;
  18 use syntax::attr;
  19 use syntax_pos::Span;
  20
  21 use rustc::hir::map as hir_map;
  22 use rustc::hir::def::Def;
  23 use rustc::hir::def_id::{DefId, LOCAL_CRATE};
  24 use rustc::middle::cstore::{LoadedMacro, CrateStore};
  25 use rustc::middle::privacy::AccessLevel;
  26 use rustc::ty::Visibility;
  27 use rustc::util::nodemap::{FxHashSet, FxHashMap};
  28
  29 use rustc::hir;
  30
  31 use core;
  32 use clean::{self, AttributesExt, NestedAttributesExt, def_id_to_path};
  33 use doctree::*;
  34
  35 // looks to me like the first two of these are actually
  36 // output parameters, maybe only mutated once; perhaps
  37 // better simply to have the visit method return a tuple
  38 // containing them?
  39
  40 // also, is there some reason that this doesn't use the 'visit'
  41 // framework from syntax?
  42
  43 pub struct RustdocVisitor<'a, 'tcx: 'a, 'rcx: 'a> {
  44     pub cstore: &'a CrateStore,
  45     pub module: Module,
  46     pub attrs: hir::HirVec<ast::Attribute>,
  47     pub cx: &'a core::DocContext<'a, 'tcx, 'rcx>,
  48     view_item_stack: FxHashSet<ast::NodeId>,
  49     inlining: bool,
  50     /// Is the current module and all of its parents public?
  51     inside_public_path: bool,
  52     exact_paths: Option<FxHashMap<DefId, Vec<String>>>,
  53 }
  54
  55 impl<'a, 'tcx, 'rcx> RustdocVisitor<'a, 'tcx, 'rcx> {
  56     pub fn new(cstore: &'a CrateStore,
  57                cx: &'a core::DocContext<'a, 'tcx, 'rcx>) -> RustdocVisitor<'a, 'tcx, 'rcx> {
  58         // If the root is re-exported, terminate all recursion.
  59         let mut stack = FxHashSet();
  60         stack.insert(ast::CRATE_NODE_ID);
  61         RustdocVisitor {
  62             module: Module::new(None),
  63             attrs: hir::HirVec::new(),
  64             cx,
  65             view_item_stack: stack,
  66             inlining: false,
  67             inside_public_path: true,
  68             exact_paths: Some(FxHashMap()),
  69             cstore,
  70         }
  71     }
  72
  73     fn store_path(&mut self, did: DefId) {
  74         // We can't use the entry api, as that keeps the mutable borrow of self active
  75         // when we try to use cx
  76         let exact_paths = self.exact_paths.as_mut().unwrap();
  77         if exact_paths.get(&did).is_none() {
  78             let path = def_id_to_path(self.cx, did, self.cx.crate_name.clone());
  79             exact_paths.insert(did, path);
  80         }
  81     }
  82
  83     fn stability(&self, id: ast::NodeId) -> Option<attr::Stability> {
  84         self.cx.tcx.hir.opt_local_def_id(id)
  85             .and_then(|def_id| self.cx.tcx.lookup_stability(def_id)).cloned()
  86     }
  87
  88     fn deprecation(&self, id: ast::NodeId) -> Option<attr::Deprecation> {
  89         self.cx.tcx.hir.opt_local_def_id(id)
  90             .and_then(|def_id| self.cx.tcx.lookup_deprecation(def_id))
  91     }
  92
  93     pub fn visit(&mut self, krate: &hir::Crate) {
  94         self.attrs = krate.attrs.clone();
  95
  96         self.module = self.visit_mod_contents(krate.span,
  97                                               krate.attrs.clone(),
  98                                               hir::Public,
  99                                               ast::CRATE_NODE_ID,
 100                                               &krate.module,
 101                                               None);
 102         // attach the crate's exported macros to the top-level module:
 103         let macro_exports: Vec<_> =
 104             krate.exported_macros.iter().map(|def| self.visit_local_macro(def)).collect();
 105         self.module.macros.extend(macro_exports);
 106         self.module.is_crate = true;
 107
 108         self.cx.renderinfo.borrow_mut().exact_paths = self.exact_paths.take().unwrap();
 109     }
 110
 111     pub fn visit_variant_data(&mut self, item: &hir::Item,
 112                             name: ast::Name, sd: &hir::VariantData,
 113                             generics: &hir::Generics) -> Struct {
 114         debug!("Visiting struct");
 115         let struct_type = struct_type_from_def(&*sd);
 116         Struct {
 117             id: item.id,
 118             struct_type,
 119             name,
 120             vis: item.vis.clone(),
 121             stab: self.stability(item.id),
 122             depr: self.deprecation(item.id),
 123             attrs: item.attrs.clone(),
 124             generics: generics.clone(),
 125             fields: sd.fields().iter().cloned().collect(),
 126             whence: item.span
 127         }
 128     }
 129
 130     pub fn visit_union_data(&mut self, item: &hir::Item,
 131                             name: ast::Name, sd: &hir::VariantData,
 132                             generics: &hir::Generics) -> Union {
 133         debug!("Visiting union");
 134         let struct_type = struct_type_from_def(&*sd);
 135         Union {
 136             id: item.id,
 137             struct_type,
 138             name,
 139             vis: item.vis.clone(),
 140             stab: self.stability(item.id),
 141             depr: self.deprecation(item.id),
 142             attrs: item.attrs.clone(),
 143             generics: generics.clone(),
 144             fields: sd.fields().iter().cloned().collect(),
 145             whence: item.span
 146         }
 147     }
 148
 149     pub fn visit_enum_def(&mut self, it: &hir::Item,
 150                           name: ast::Name, def: &hir::EnumDef,
 151                           params: &hir::Generics) -> Enum {
 152         debug!("Visiting enum");
 153         Enum {
 154             name,
 155             variants: def.variants.iter().map(|v| Variant {
 156                 name: v.node.name,
 157                 attrs: v.node.attrs.clone(),
 158                 stab: self.stability(v.node.data.id()),
 159                 depr: self.deprecation(v.node.data.id()),
 160                 def: v.node.data.clone(),
 161                 whence: v.span,
 162             }).collect(),
 163             vis: it.vis.clone(),
 164             stab: self.stability(it.id),
 165             depr: self.deprecation(it.id),
 166             generics: params.clone(),
 167             attrs: it.attrs.clone(),
 168             id: it.id,
 169             whence: it.span,
 170         }
 171     }
 172
 173     pub fn visit_fn(&mut self, item: &hir::Item,
 174                     name: ast::Name, fd: &hir::FnDecl,
 175                     unsafety: &hir::Unsafety,
 176                     constness: hir::Constness,
 177                     abi: &abi::Abi,
 178                     gen: &hir::Generics,
 179                     body: hir::BodyId) -> Function {
 180         debug!("Visiting fn");
 181         Function {
 182             id: item.id,
 183             vis: item.vis.clone(),
 184             stab: self.stability(item.id),
 185             depr: self.deprecation(item.id),
 186             attrs: item.attrs.clone(),
 187             decl: fd.clone(),
 188             name,
 189             whence: item.span,
 190             generics: gen.clone(),
 191             unsafety: *unsafety,
 192             constness,
 193             abi: *abi,
 194             body,
 195         }
 196     }
 197
 198     pub fn visit_mod_contents(&mut self, span: Span, attrs: hir::HirVec<ast::Attribute>,
 199                               vis: hir::Visibility, id: ast::NodeId,
 200                               m: &hir::Mod,
 201                               name: Option<ast::Name>) -> Module {
 202         let mut om = Module::new(name);
 203         om.where_outer = span;
 204         om.where_inner = m.inner;
 205         om.attrs = attrs;
 206         om.vis = vis.clone();
 207         om.stab = self.stability(id);
 208         om.depr = self.deprecation(id);
 209         om.id = id;
 210         // Keep track of if there were any private modules in the path.
 211         let orig_inside_public_path = self.inside_public_path;
 212         self.inside_public_path &= vis == hir::Public;
 213         for i in &m.item_ids {
 214             let item = self.cx.tcx.hir.expect_item(i.id);
 215             self.visit_item(item, None, &mut om);
 216         }
 217         self.inside_public_path = orig_inside_public_path;
 218         let def_id = self.cx.tcx.hir.local_def_id(id);
 219         if let Some(exports) = self.cx.tcx.module_exports(def_id) {
 220             for export in exports.iter().filter(|e| e.vis == Visibility::Public) {
 221                 if let Def::Macro(def_id, ..) = export.def {
 222                     if def_id.krate == LOCAL_CRATE {
 223                         continue // These are `krate.exported_macros`, handled in `self.visit()`.
 224                     }
 225
 226                     let imported_from = self.cx.tcx.original_crate_name(def_id.krate);
 227                     let def = match self.cstore.load_macro_untracked(def_id, self.cx.sess()) {
 228                         LoadedMacro::MacroDef(macro_def) => macro_def,
 229                         // FIXME(jseyfried): document proc macro re-exports
 230                         LoadedMacro::ProcMacro(..) => continue,
 231                     };
 232
 233                     let matchers = if let ast::ItemKind::MacroDef(ref def) = def.node {
 234                         let tts: Vec<_> = def.stream().into_trees().collect();
 235                         tts.chunks(4).map(|arm| arm[0].span()).collect()
 236                     } else {
 237                         unreachable!()
 238                     };
 239
 240                     om.macros.push(Macro {
 241                         def_id,
 242                         attrs: def.attrs.clone().into(),
 243                         name: def.ident.name,
 244                         whence: def.span,
 245                         matchers,
 246                         stab: self.stability(def.id),
 247                         depr: self.deprecation(def.id),
 248                         imported_from: Some(imported_from),
 249                     })
 250                 }
 251             }
 252         }
 253         om
 254     }
 255
 256     /// Tries to resolve the target of a `pub use` statement and inlines the
 257     /// target if it is defined locally and would not be documented otherwise,
 258     /// or when it is specifically requested with `please_inline`.
 259     /// (the latter is the case when the import is marked `doc(inline)`)
 260     ///
 261     /// Cross-crate inlining occurs later on during crate cleaning
 262     /// and follows different rules.
 263     ///
 264     /// Returns true if the target has been inlined.
 265     fn maybe_inline_local(&mut self,
 266                           id: ast::NodeId,
 267                           def: Def,
 268                           renamed: Option<ast::Name>,
 269                           glob: bool,
 270                           om: &mut Module,
 271                           please_inline: bool) -> bool {
 272
 273         fn inherits_doc_hidden(cx: &core::DocContext, mut node: ast::NodeId) -> bool {
 274             while let Some(id) = cx.tcx.hir.get_enclosing_scope(node) {
 275                 node = id;
 276                 if cx.tcx.hir.attrs(node).lists("doc").has_word("hidden") {
 277                     return true;
 278                 }
 279                 if node == ast::CRATE_NODE_ID {
 280                     break;
 281                 }
 282             }
 283             false
 284         }
 285
 286         debug!("maybe_inline_local def: {:?}", def);
 287
 288         let tcx = self.cx.tcx;
 289         if def == Def::Err {
 290             return false;
 291         }
 292         let def_did = def.def_id();
 293
 294         let use_attrs = tcx.hir.attrs(id);
 295         // Don't inline doc(hidden) imports so they can be stripped at a later stage.
 296         let is_no_inline = use_attrs.lists("doc").has_word("no_inline") ||
 297                            use_attrs.lists("doc").has_word("hidden");
 298
 299         // For cross-crate impl inlining we need to know whether items are
 300         // reachable in documentation - a previously nonreachable item can be
 301         // made reachable by cross-crate inlining which we're checking here.
 302         // (this is done here because we need to know this upfront)
 303         if !def_did.is_local() && !is_no_inline {
 304             let attrs = clean::inline::load_attrs(self.cx, def_did);
 305             let self_is_hidden = attrs.lists("doc").has_word("hidden");
 306             match def {
 307                 Def::Trait(did) |
 308                 Def::Struct(did) |
 309                 Def::Union(did) |
 310                 Def::Enum(did) |
 311                 Def::TyForeign(did) |
 312                 Def::TyAlias(did) if !self_is_hidden => {
 313                     self.cx.access_levels.borrow_mut().map.insert(did, AccessLevel::Public);
 314                 },
 315                 Def::Mod(did) => if !self_is_hidden {
 316                     ::visit_lib::LibEmbargoVisitor::new(self.cx).visit_mod(did);
 317                 },
 318                 _ => {},
 319             }
 320
 321             return false
 322         }
 323
 324         let def_node_id = match tcx.hir.as_local_node_id(def_did) {
 325             Some(n) => n, None => return false
 326         };
 327
 328         let is_private = !self.cx.access_levels.borrow().is_public(def_did);
 329         let is_hidden = inherits_doc_hidden(self.cx, def_node_id);
 330
 331         // Only inline if requested or if the item would otherwise be stripped
 332         if (!please_inline && !is_private && !is_hidden) || is_no_inline {
 333             return false
 334         }
 335
 336         if !self.view_item_stack.insert(def_node_id) { return false }
 337
 338         let ret = match tcx.hir.get(def_node_id) {
 339             hir_map::NodeItem(&hir::Item { node: hir::ItemMod(ref m), .. }) if glob => {
 340                 let prev = mem::replace(&mut self.inlining, true);
 341                 for i in &m.item_ids {
 342                     let i = self.cx.tcx.hir.expect_item(i.id);
 343                     self.visit_item(i, None, om);
 344                 }
 345                 self.inlining = prev;
 346                 true
 347             }
 348             hir_map::NodeItem(it) if !glob => {
 349                 let prev = mem::replace(&mut self.inlining, true);
 350                 self.visit_item(it, renamed, om);
 351                 self.inlining = prev;
 352                 true
 353             }
 354             hir_map::NodeForeignItem(it) if !glob => {
 355                 // generate a fresh `extern {}` block if we want to inline a foreign item.
 356                 om.foreigns.push(hir::ForeignMod {
 357                     abi: tcx.hir.get_foreign_abi(it.id),
 358                     items: vec![hir::ForeignItem {
 359                         name: renamed.unwrap_or(it.name),
 360                         .. it.clone()
 361                     }].into(),
 362                 });
 363                 true
 364             }
 365             _ => false,
 366         };
 367         self.view_item_stack.remove(&def_node_id);
 368         ret
 369     }
 370
 371     pub fn visit_item(&mut self, item: &hir::Item,
 372                       renamed: Option<ast::Name>, om: &mut Module) {
 373         debug!("Visiting item {:?}", item);
 374         let name = renamed.unwrap_or(item.name);
 375
 376         if item.vis == hir::Public {
 377             let def_id = self.cx.tcx.hir.local_def_id(item.id);
 378             self.store_path(def_id);
 379         }
 380
 381         match item.node {
 382             hir::ItemForeignMod(ref fm) => {
 383                 // If inlining we only want to include public functions.
 384                 om.foreigns.push(if self.inlining {
 385                     hir::ForeignMod {
 386                         abi: fm.abi,
 387                         items: fm.items.iter().filter(|i| i.vis == hir::Public).cloned().collect(),
 388                     }
 389                 } else {
 390                     fm.clone()
 391                 });
 392             }
 393             // If we're inlining, skip private items.
 394             _ if self.inlining && item.vis != hir::Public => {}
 395             hir::ItemGlobalAsm(..) => {}
 396             hir::ItemExternCrate(orig_name) => {
 397                 let def_id = self.cx.tcx.hir.local_def_id(item.id);
 398                 om.extern_crates.push(ExternCrate {
 399                     cnum: self.cx.tcx.extern_mod_stmt_cnum(def_id)
 400                                 .unwrap_or(LOCAL_CRATE),
 401                     name,
 402                     path: orig_name.map(|x|x.to_string()),
 403                     vis: item.vis.clone(),
 404                     attrs: item.attrs.clone(),
 405                     whence: item.span,
 406                 })
 407             }
 408             hir::ItemUse(_, hir::UseKind::ListStem) => {}
 409             hir::ItemUse(ref path, kind) => {
 410                 let is_glob = kind == hir::UseKind::Glob;
 411
 412                 // If there was a private module in the current path then don't bother inlining
 413                 // anything as it will probably be stripped anyway.
 414                 if item.vis == hir::Public && self.inside_public_path {
 415                     let please_inline = item.attrs.iter().any(|item| {
 416                         match item.meta_item_list() {
 417                             Some(ref list) if item.check_name("doc") => {
 418                                 list.iter().any(|i| i.check_name("inline"))
 419                             }
 420                             _ => false,
 421                         }
 422                     });
 423                     let name = if is_glob { None } else { Some(name) };
 424                     if self.maybe_inline_local(item.id,
 425                                                path.def,
 426                                                name,
 427                                                is_glob,
 428                                                om,
 429                                                please_inline) {
 430                         return;
 431                     }
 432                 }
 433
 434                 om.imports.push(Import {
 435                     name,
 436                     id: item.id,
 437                     vis: item.vis.clone(),
 438                     attrs: item.attrs.clone(),
 439                     path: (**path).clone(),
 440                     glob: is_glob,
 441                     whence: item.span,
 442                 });
 443             }
 444             hir::ItemMod(ref m) => {
 445                 om.mods.push(self.visit_mod_contents(item.span,
 446                                                      item.attrs.clone(),
 447                                                      item.vis.clone(),
 448                                                      item.id,
 449                                                      m,
 450                                                      Some(name)));
 451             },
 452             hir::ItemEnum(ref ed, ref gen) =>
 453                 om.enums.push(self.visit_enum_def(item, name, ed, gen)),
 454             hir::ItemStruct(ref sd, ref gen) =>
 455                 om.structs.push(self.visit_variant_data(item, name, sd, gen)),
 456             hir::ItemUnion(ref sd, ref gen) =>
 457                 om.unions.push(self.visit_union_data(item, name, sd, gen)),
 458             hir::ItemFn(ref fd, ref unsafety, constness, ref abi, ref gen, body) =>
 459                 om.fns.push(self.visit_fn(item, name, &**fd, unsafety,
 460                                           constness, abi, gen, body)),
 461             hir::ItemTy(ref ty, ref gen) => {
 462                 let t = Typedef {
 463                     ty: ty.clone(),
 464                     gen: gen.clone(),
 465                     name,
 466                     id: item.id,
 467                     attrs: item.attrs.clone(),
 468                     whence: item.span,
 469                     vis: item.vis.clone(),
 470                     stab: self.stability(item.id),
 471                     depr: self.deprecation(item.id),
 472                 };
 473                 om.typedefs.push(t);
 474             },
 475             hir::ItemStatic(ref ty, ref mut_, ref exp) => {
 476                 let s = Static {
 477                     type_: ty.clone(),
 478                     mutability: mut_.clone(),
 479                     expr: exp.clone(),
 480                     id: item.id,
 481                     name,
 482                     attrs: item.attrs.clone(),
 483                     whence: item.span,
 484                     vis: item.vis.clone(),
 485                     stab: self.stability(item.id),
 486                     depr: self.deprecation(item.id),
 487                 };
 488                 om.statics.push(s);
 489             },
 490             hir::ItemConst(ref ty, ref exp) => {
 491                 let s = Constant {
 492                     type_: ty.clone(),
 493                     expr: exp.clone(),
 494                     id: item.id,
 495                     name,
 496                     attrs: item.attrs.clone(),
 497                     whence: item.span,
 498                     vis: item.vis.clone(),
 499                     stab: self.stability(item.id),
 500                     depr: self.deprecation(item.id),
 501                 };
 502                 om.constants.push(s);
 503             },
 504             hir::ItemTrait(is_auto, unsafety, ref gen, ref b, ref item_ids) => {
 505                 let items = item_ids.iter()
 506                                     .map(|ti| self.cx.tcx.hir.trait_item(ti.id).clone())
 507                                     .collect();
 508                 let t = Trait {
 509                     is_auto,
 510                     unsafety,
 511                     name,
 512                     items,
 513                     generics: gen.clone(),
 514                     bounds: b.iter().cloned().collect(),
 515                     id: item.id,
 516                     attrs: item.attrs.clone(),
 517                     whence: item.span,
 518                     vis: item.vis.clone(),
 519                     stab: self.stability(item.id),
 520                     depr: self.deprecation(item.id),
 521                 };
 522                 om.traits.push(t);
 523             },
 524             hir::ItemTraitAlias(..) => {
 525                 unimplemented!("trait objects are not yet implemented")
 526             },
 527
 528             hir::ItemImpl(unsafety,
 529                           polarity,
 530                           defaultness,
 531                           ref gen,
 532                           ref tr,
 533                           ref ty,
 534                           ref item_ids) => {
 535                 // Don't duplicate impls when inlining, we'll pick them up
 536                 // regardless of where they're located.
 537                 if !self.inlining {
 538                     let items = item_ids.iter()
 539                                         .map(|ii| self.cx.tcx.hir.impl_item(ii.id).clone())
 540                                         .collect();
 541                     let i = Impl {
 542                         unsafety,
 543                         polarity,
 544                         defaultness,
 545                         generics: gen.clone(),
 546                         trait_: tr.clone(),
 547                         for_: ty.clone(),
 548                         items,
 549                         attrs: item.attrs.clone(),
 550                         id: item.id,
 551                         whence: item.span,
 552                         vis: item.vis.clone(),
 553                         stab: self.stability(item.id),
 554                         depr: self.deprecation(item.id),
 555                     };
 556                     om.impls.push(i);
 557                 }
 558             },
 559         }
 560     }
 561
 562     // convert each exported_macro into a doc item
 563     fn visit_local_macro(&self, def: &hir::MacroDef) -> Macro {
 564         let tts = def.body.trees().collect::<Vec<_>>();
 565         // Extract the spans of all matchers. They represent the "interface" of the macro.
 566         let matchers = tts.chunks(4).map(|arm| arm[0].span()).collect();
 567
 568         Macro {
 569             def_id: self.cx.tcx.hir.local_def_id(def.id),
 570             attrs: def.attrs.clone(),
 571             name: def.name,
 572             whence: def.span,
 573             matchers,
 574             stab: self.stability(def.id),
 575             depr: self.deprecation(def.id),
 576             imported_from: None,
 577         }
 578     }
 579 }