src/librustdoc/clean/inline.rs

   1 //! Support for inlining external documentation into the current AST.
   2
   3 use std::iter::once;
   4
   5 use rustc::ty;
   6 use rustc_data_structures::fx::FxHashSet;
   7 use rustc_hir as hir;
   8 use rustc_hir::def::{CtorKind, DefKind, Res};
   9 use rustc_hir::def_id::DefId;
  10 use rustc_hir::Mutability;
  11 use rustc_metadata::creader::LoadedMacro;
  12 use rustc_mir::const_eval::is_min_const_fn;
  13 use rustc_span::hygiene::MacroKind;
  14 use rustc_span::symbol::sym;
  15 use rustc_span::Span;
  16 use syntax::ast;
  17
  18 use crate::clean::{self, GetDefId, ToSource, TypeKind};
  19 use crate::core::DocContext;
  20 use crate::doctree;
  21
  22 use super::Clean;
  23
  24 type Attrs<'hir> = rustc::ty::Attributes<'hir>;
  25
  26 /// Attempt to inline a definition into this AST.
  27 ///
  28 /// This function will fetch the definition specified, and if it is
  29 /// from another crate it will attempt to inline the documentation
  30 /// from the other crate into this crate.
  31 ///
  32 /// This is primarily used for `pub use` statements which are, in general,
  33 /// implementation details. Inlining the documentation should help provide a
  34 /// better experience when reading the documentation in this use case.
  35 ///
  36 /// The returned value is `None` if the definition could not be inlined,
  37 /// and `Some` of a vector of items if it was successfully expanded.
  38 pub fn try_inline(
  39     cx: &DocContext<'_>,
  40     res: Res,
  41     name: ast::Name,
  42     attrs: Option<Attrs<'_>>,
  43     visited: &mut FxHashSet<DefId>,
  44 ) -> Option<Vec<clean::Item>> {
  45     let did = if let Some(did) = res.opt_def_id() {
  46         did
  47     } else {
  48         return None;
  49     };
  50     if did.is_local() {
  51         return None;
  52     }
  53     let mut ret = Vec::new();
  54
  55     let attrs_clone = attrs.clone();
  56
  57     let inner = match res {
  58         Res::Def(DefKind::Trait, did) => {
  59             record_extern_fqn(cx, did, clean::TypeKind::Trait);
  60             ret.extend(build_impls(cx, did, attrs));
  61             clean::TraitItem(build_external_trait(cx, did))
  62         }
  63         Res::Def(DefKind::Fn, did) => {
  64             record_extern_fqn(cx, did, clean::TypeKind::Function);
  65             clean::FunctionItem(build_external_function(cx, did))
  66         }
  67         Res::Def(DefKind::Struct, did) => {
  68             record_extern_fqn(cx, did, clean::TypeKind::Struct);
  69             ret.extend(build_impls(cx, did, attrs));
  70             clean::StructItem(build_struct(cx, did))
  71         }
  72         Res::Def(DefKind::Union, did) => {
  73             record_extern_fqn(cx, did, clean::TypeKind::Union);
  74             ret.extend(build_impls(cx, did, attrs));
  75             clean::UnionItem(build_union(cx, did))
  76         }
  77         Res::Def(DefKind::TyAlias, did) => {
  78             record_extern_fqn(cx, did, clean::TypeKind::Typedef);
  79             ret.extend(build_impls(cx, did, attrs));
  80             clean::TypedefItem(build_type_alias(cx, did), false)
  81         }
  82         Res::Def(DefKind::Enum, did) => {
  83             record_extern_fqn(cx, did, clean::TypeKind::Enum);
  84             ret.extend(build_impls(cx, did, attrs));
  85             clean::EnumItem(build_enum(cx, did))
  86         }
  87         Res::Def(DefKind::ForeignTy, did) => {
  88             record_extern_fqn(cx, did, clean::TypeKind::Foreign);
  89             ret.extend(build_impls(cx, did, attrs));
  90             clean::ForeignTypeItem
  91         }
  92         // Never inline enum variants but leave them shown as re-exports.
  93         Res::Def(DefKind::Variant, _) => return None,
  94         // Assume that enum variants and struct types are re-exported next to
  95         // their constructors.
  96         Res::Def(DefKind::Ctor(..), _) | Res::SelfCtor(..) => return Some(Vec::new()),
  97         Res::Def(DefKind::Mod, did) => {
  98             record_extern_fqn(cx, did, clean::TypeKind::Module);
  99             clean::ModuleItem(build_module(cx, did, visited))
 100         }
 101         Res::Def(DefKind::Static, did) => {
 102             record_extern_fqn(cx, did, clean::TypeKind::Static);
 103             clean::StaticItem(build_static(cx, did, cx.tcx.is_mutable_static(did)))
 104         }
 105         Res::Def(DefKind::Const, did) => {
 106             record_extern_fqn(cx, did, clean::TypeKind::Const);
 107             clean::ConstantItem(build_const(cx, did))
 108         }
 109         Res::Def(DefKind::Macro(kind), did) => {
 110             let mac = build_macro(cx, did, name);
 111
 112             let type_kind = match kind {
 113                 MacroKind::Bang => TypeKind::Macro,
 114                 MacroKind::Attr => TypeKind::Attr,
 115                 MacroKind::Derive => TypeKind::Derive,
 116             };
 117             record_extern_fqn(cx, did, type_kind);
 118             mac
 119         }
 120         _ => return None,
 121     };
 122
 123     let target_attrs = load_attrs(cx, did);
 124     let attrs = merge_attrs(cx, target_attrs, attrs_clone);
 125
 126     cx.renderinfo.borrow_mut().inlined.insert(did);
 127     ret.push(clean::Item {
 128         source: cx.tcx.def_span(did).clean(cx),
 129         name: Some(name.clean(cx)),
 130         attrs,
 131         inner,
 132         visibility: clean::Public,
 133         stability: cx.tcx.lookup_stability(did).clean(cx),
 134         deprecation: cx.tcx.lookup_deprecation(did).clean(cx),
 135         def_id: did,
 136     });
 137     Some(ret)
 138 }
 139
 140 pub fn try_inline_glob(
 141     cx: &DocContext<'_>,
 142     res: Res,
 143     visited: &mut FxHashSet<DefId>,
 144 ) -> Option<Vec<clean::Item>> {
 145     if res == Res::Err {
 146         return None;
 147     }
 148     let did = res.def_id();
 149     if did.is_local() {
 150         return None;
 151     }
 152
 153     match res {
 154         Res::Def(DefKind::Mod, did) => {
 155             let m = build_module(cx, did, visited);
 156             Some(m.items)
 157         }
 158         // glob imports on things like enums aren't inlined even for local exports, so just bail
 159         _ => None,
 160     }
 161 }
 162
 163 pub fn load_attrs<'hir>(cx: &DocContext<'hir>, did: DefId) -> Attrs<'hir> {
 164     cx.tcx.get_attrs(did)
 165 }
 166
 167 /// Record an external fully qualified name in the external_paths cache.
 168 ///
 169 /// These names are used later on by HTML rendering to generate things like
 170 /// source links back to the original item.
 171 pub fn record_extern_fqn(cx: &DocContext<'_>, did: DefId, kind: clean::TypeKind) {
 172     let crate_name = cx.tcx.crate_name(did.krate).to_string();
 173
 174     let relative = cx.tcx.def_path(did).data.into_iter().filter_map(|elem| {
 175         // extern blocks have an empty name
 176         let s = elem.data.to_string();
 177         if !s.is_empty() { Some(s) } else { None }
 178     });
 179     let fqn = if let clean::TypeKind::Macro = kind {
 180         vec![crate_name, relative.last().expect("relative was empty")]
 181     } else {
 182         once(crate_name).chain(relative).collect()
 183     };
 184
 185     if did.is_local() {
 186         cx.renderinfo.borrow_mut().exact_paths.insert(did, fqn);
 187     } else {
 188         cx.renderinfo.borrow_mut().external_paths.insert(did, (fqn, kind));
 189     }
 190 }
 191
 192 pub fn build_external_trait(cx: &DocContext<'_>, did: DefId) -> clean::Trait {
 193     let auto_trait = cx.tcx.trait_def(did).has_auto_impl;
 194     let trait_items = cx.tcx.associated_items(did).map(|item| item.clean(cx)).collect();
 195     let predicates = cx.tcx.predicates_of(did);
 196     let generics = (cx.tcx.generics_of(did), predicates).clean(cx);
 197     let generics = filter_non_trait_generics(did, generics);
 198     let (generics, supertrait_bounds) = separate_supertrait_bounds(generics);
 199     let is_spotlight = load_attrs(cx, did).clean(cx).has_doc_flag(sym::spotlight);
 200     let is_auto = cx.tcx.trait_is_auto(did);
 201     clean::Trait {
 202         auto: auto_trait,
 203         unsafety: cx.tcx.trait_def(did).unsafety,
 204         generics,
 205         items: trait_items,
 206         bounds: supertrait_bounds,
 207         is_spotlight,
 208         is_auto,
 209     }
 210 }
 211
 212 fn build_external_function(cx: &DocContext<'_>, did: DefId) -> clean::Function {
 213     let sig = cx.tcx.fn_sig(did);
 214
 215     let constness =
 216         if is_min_const_fn(cx.tcx, did) { hir::Constness::Const } else { hir::Constness::NotConst };
 217     let asyncness = cx.tcx.asyncness(did);
 218     let predicates = cx.tcx.predicates_of(did);
 219     let (generics, decl) = clean::enter_impl_trait(cx, || {
 220         ((cx.tcx.generics_of(did), predicates).clean(cx), (did, sig).clean(cx))
 221     });
 222     let (all_types, ret_types) = clean::get_all_types(&generics, &decl, cx);
 223     clean::Function {
 224         decl,
 225         generics,
 226         header: hir::FnHeader { unsafety: sig.unsafety(), abi: sig.abi(), constness, asyncness },
 227         all_types,
 228         ret_types,
 229     }
 230 }
 231
 232 fn build_enum(cx: &DocContext<'_>, did: DefId) -> clean::Enum {
 233     let predicates = cx.tcx.explicit_predicates_of(did);
 234
 235     clean::Enum {
 236         generics: (cx.tcx.generics_of(did), predicates).clean(cx),
 237         variants_stripped: false,
 238         variants: cx.tcx.adt_def(did).variants.clean(cx),
 239     }
 240 }
 241
 242 fn build_struct(cx: &DocContext<'_>, did: DefId) -> clean::Struct {
 243     let predicates = cx.tcx.explicit_predicates_of(did);
 244     let variant = cx.tcx.adt_def(did).non_enum_variant();
 245
 246     clean::Struct {
 247         struct_type: match variant.ctor_kind {
 248             CtorKind::Fictive => doctree::Plain,
 249             CtorKind::Fn => doctree::Tuple,
 250             CtorKind::Const => doctree::Unit,
 251         },
 252         generics: (cx.tcx.generics_of(did), predicates).clean(cx),
 253         fields: variant.fields.clean(cx),
 254         fields_stripped: false,
 255     }
 256 }
 257
 258 fn build_union(cx: &DocContext<'_>, did: DefId) -> clean::Union {
 259     let predicates = cx.tcx.explicit_predicates_of(did);
 260     let variant = cx.tcx.adt_def(did).non_enum_variant();
 261
 262     clean::Union {
 263         struct_type: doctree::Plain,
 264         generics: (cx.tcx.generics_of(did), predicates).clean(cx),
 265         fields: variant.fields.clean(cx),
 266         fields_stripped: false,
 267     }
 268 }
 269
 270 fn build_type_alias(cx: &DocContext<'_>, did: DefId) -> clean::Typedef {
 271     let predicates = cx.tcx.explicit_predicates_of(did);
 272
 273     clean::Typedef {
 274         type_: cx.tcx.type_of(did).clean(cx),
 275         generics: (cx.tcx.generics_of(did), predicates).clean(cx),
 276     }
 277 }
 278
 279 pub fn build_impls(cx: &DocContext<'_>, did: DefId, attrs: Option<Attrs<'_>>) -> Vec<clean::Item> {
 280     let tcx = cx.tcx;
 281     let mut impls = Vec::new();
 282
 283     for &did in tcx.inherent_impls(did).iter() {
 284         build_impl(cx, did, attrs.clone(), &mut impls);
 285     }
 286
 287     impls
 288 }
 289
 290 fn merge_attrs(
 291     cx: &DocContext<'_>,
 292     attrs: Attrs<'_>,
 293     other_attrs: Option<Attrs<'_>>,
 294 ) -> clean::Attributes {
 295     let mut merged_attrs: Vec<ast::Attribute> = Vec::with_capacity(attrs.len());
 296     // If we have additional attributes (from a re-export),
 297     // always insert them first. This ensure that re-export
 298     // doc comments show up before the original doc comments
 299     // when we render them.
 300     if let Some(a) = other_attrs {
 301         merged_attrs.extend(a.iter().cloned());
 302     }
 303     merged_attrs.extend(attrs.to_vec());
 304     merged_attrs.clean(cx)
 305 }
 306
 307 pub fn build_impl(
 308     cx: &DocContext<'_>,
 309     did: DefId,
 310     attrs: Option<Attrs<'_>>,
 311     ret: &mut Vec<clean::Item>,
 312 ) {
 313     if !cx.renderinfo.borrow_mut().inlined.insert(did) {
 314         return;
 315     }
 316
 317     let attrs = merge_attrs(cx, load_attrs(cx, did), attrs);
 318
 319     let tcx = cx.tcx;
 320     let associated_trait = tcx.impl_trait_ref(did);
 321
 322     // Only inline impl if the implemented trait is
 323     // reachable in rustdoc generated documentation
 324     if !did.is_local() {
 325         if let Some(traitref) = associated_trait {
 326             if !cx.renderinfo.borrow().access_levels.is_public(traitref.def_id) {
 327                 return;
 328             }
 329         }
 330     }
 331
 332     let for_ = if let Some(hir_id) = tcx.hir().as_local_hir_id(did) {
 333         match tcx.hir().expect_item(hir_id).kind {
 334             hir::ItemKind::Impl(.., ref t, _) => t.clean(cx),
 335             _ => panic!("did given to build_impl was not an impl"),
 336         }
 337     } else {
 338         tcx.type_of(did).clean(cx)
 339     };
 340
 341     // Only inline impl if the implementing type is
 342     // reachable in rustdoc generated documentation
 343     if !did.is_local() {
 344         if let Some(did) = for_.def_id() {
 345             if !cx.renderinfo.borrow().access_levels.is_public(did) {
 346                 return;
 347             }
 348         }
 349     }
 350
 351     let predicates = tcx.explicit_predicates_of(did);
 352     let (trait_items, generics) = if let Some(hir_id) = tcx.hir().as_local_hir_id(did) {
 353         match tcx.hir().expect_item(hir_id).kind {
 354             hir::ItemKind::Impl(.., ref gen, _, _, ref item_ids) => (
 355                 item_ids.iter().map(|ii| tcx.hir().impl_item(ii.id).clean(cx)).collect::<Vec<_>>(),
 356                 gen.clean(cx),
 357             ),
 358             _ => panic!("did given to build_impl was not an impl"),
 359         }
 360     } else {
 361         (
 362             tcx.associated_items(did)
 363                 .filter_map(|item| {
 364                     if associated_trait.is_some() || item.vis == ty::Visibility::Public {
 365                         Some(item.clean(cx))
 366                     } else {
 367                         None
 368                     }
 369                 })
 370                 .collect::<Vec<_>>(),
 371             clean::enter_impl_trait(cx, || (tcx.generics_of(did), predicates).clean(cx)),
 372         )
 373     };
 374     let polarity = tcx.impl_polarity(did);
 375     let trait_ = associated_trait.clean(cx).map(|bound| match bound {
 376         clean::GenericBound::TraitBound(polyt, _) => polyt.trait_,
 377         clean::GenericBound::Outlives(..) => unreachable!(),
 378     });
 379     if trait_.def_id() == tcx.lang_items().deref_trait() {
 380         super::build_deref_target_impls(cx, &trait_items, ret);
 381     }
 382     if let Some(trait_did) = trait_.def_id() {
 383         record_extern_trait(cx, trait_did);
 384     }
 385
 386     let provided = trait_
 387         .def_id()
 388         .map(|did| {
 389             tcx.provided_trait_methods(did).into_iter().map(|meth| meth.ident.to_string()).collect()
 390         })
 391         .unwrap_or_default();
 392
 393     debug!("build_impl: impl {:?} for {:?}", trait_.def_id(), for_.def_id());
 394
 395     ret.push(clean::Item {
 396         inner: clean::ImplItem(clean::Impl {
 397             unsafety: hir::Unsafety::Normal,
 398             generics,
 399             provided_trait_methods: provided,
 400             trait_,
 401             for_,
 402             items: trait_items,
 403             polarity: Some(polarity.clean(cx)),
 404             synthetic: false,
 405             blanket_impl: None,
 406         }),
 407         source: tcx.def_span(did).clean(cx),
 408         name: None,
 409         attrs,
 410         visibility: clean::Inherited,
 411         stability: tcx.lookup_stability(did).clean(cx),
 412         deprecation: tcx.lookup_deprecation(did).clean(cx),
 413         def_id: did,
 414     });
 415 }
 416
 417 fn build_module(cx: &DocContext<'_>, did: DefId, visited: &mut FxHashSet<DefId>) -> clean::Module {
 418     let mut items = Vec::new();
 419     fill_in(cx, did, &mut items, visited);
 420     return clean::Module { items, is_crate: false };
 421
 422     fn fill_in(
 423         cx: &DocContext<'_>,
 424         did: DefId,
 425         items: &mut Vec<clean::Item>,
 426         visited: &mut FxHashSet<DefId>,
 427     ) {
 428         // If we're re-exporting a re-export it may actually re-export something in
 429         // two namespaces, so the target may be listed twice. Make sure we only
 430         // visit each node at most once.
 431         for &item in cx.tcx.item_children(did).iter() {
 432             let def_id = item.res.def_id();
 433             if item.vis == ty::Visibility::Public {
 434                 if did == def_id || !visited.insert(def_id) {
 435                     continue;
 436                 }
 437                 if let Some(i) = try_inline(cx, item.res, item.ident.name, None, visited) {
 438                     items.extend(i)
 439                 }
 440             }
 441         }
 442     }
 443 }
 444
 445 pub fn print_inlined_const(cx: &DocContext<'_>, did: DefId) -> String {
 446     if let Some(node_id) = cx.tcx.hir().as_local_hir_id(did) {
 447         cx.tcx.hir().hir_to_pretty_string(node_id)
 448     } else {
 449         cx.tcx.rendered_const(did)
 450     }
 451 }
 452
 453 fn build_const(cx: &DocContext<'_>, did: DefId) -> clean::Constant {
 454     clean::Constant {
 455         type_: cx.tcx.type_of(did).clean(cx),
 456         expr: print_inlined_const(cx, did),
 457         value: clean::utils::print_evaluated_const(cx, did),
 458         is_literal: cx
 459             .tcx
 460             .hir()
 461             .as_local_hir_id(did)
 462             .map_or(false, |hir_id| clean::utils::is_literal_expr(cx, hir_id)),
 463     }
 464 }
 465
 466 fn build_static(cx: &DocContext<'_>, did: DefId, mutable: bool) -> clean::Static {
 467     clean::Static {
 468         type_: cx.tcx.type_of(did).clean(cx),
 469         mutability: if mutable { Mutability::Mut } else { Mutability::Not },
 470         expr: "\n\n\n".to_string(), // trigger the "[definition]" links
 471     }
 472 }
 473
 474 fn build_macro(cx: &DocContext<'_>, did: DefId, name: ast::Name) -> clean::ItemEnum {
 475     let imported_from = cx.tcx.original_crate_name(did.krate);
 476     match cx.enter_resolver(|r| r.cstore().load_macro_untracked(did, cx.sess())) {
 477         LoadedMacro::MacroDef(def, _) => {
 478             let matchers: Vec<Span> = if let ast::ItemKind::MacroDef(ref def) = def.kind {
 479                 let tts: Vec<_> = def.body.inner_tokens().into_trees().collect();
 480                 tts.chunks(4).map(|arm| arm[0].span()).collect()
 481             } else {
 482                 unreachable!()
 483             };
 484
 485             let source = format!(
 486                 "macro_rules! {} {{\n{}}}",
 487                 name.clean(cx),
 488                 matchers
 489                     .iter()
 490                     .map(|span| { format!("    {} => {{ ... }};\n", span.to_src(cx)) })
 491                     .collect::<String>()
 492             );
 493
 494             clean::MacroItem(clean::Macro { source, imported_from: Some(imported_from).clean(cx) })
 495         }
 496         LoadedMacro::ProcMacro(ext) => clean::ProcMacroItem(clean::ProcMacro {
 497             kind: ext.macro_kind(),
 498             helpers: ext.helper_attrs.clean(cx),
 499         }),
 500     }
 501 }
 502
 503 /// A trait's generics clause actually contains all of the predicates for all of
 504 /// its associated types as well. We specifically move these clauses to the
 505 /// associated types instead when displaying, so when we're generating the
 506 /// generics for the trait itself we need to be sure to remove them.
 507 /// We also need to remove the implied "recursive" Self: Trait bound.
 508 ///
 509 /// The inverse of this filtering logic can be found in the `Clean`
 510 /// implementation for `AssociatedType`
 511 fn filter_non_trait_generics(trait_did: DefId, mut g: clean::Generics) -> clean::Generics {
 512     for pred in &mut g.where_predicates {
 513         match *pred {
 514             clean::WherePredicate::BoundPredicate { ty: clean::Generic(ref s), ref mut bounds }
 515                 if *s == "Self" =>
 516             {
 517                 bounds.retain(|bound| match *bound {
 518                     clean::GenericBound::TraitBound(
 519                         clean::PolyTrait { trait_: clean::ResolvedPath { did, .. }, .. },
 520                         _,
 521                     ) => did != trait_did,
 522                     _ => true,
 523                 });
 524             }
 525             _ => {}
 526         }
 527     }
 528
 529     g.where_predicates.retain(|pred| match *pred {
 530         clean::WherePredicate::BoundPredicate {
 531             ty:
 532                 clean::QPath {
 533                     self_type: box clean::Generic(ref s),
 534                     trait_: box clean::ResolvedPath { did, .. },
 535                     name: ref _name,
 536                 },
 537             ref bounds,
 538         } => !(*s == "Self" && did == trait_did) && !bounds.is_empty(),
 539         _ => true,
 540     });
 541     g
 542 }
 543
 544 /// Supertrait bounds for a trait are also listed in the generics coming from
 545 /// the metadata for a crate, so we want to separate those out and create a new
 546 /// list of explicit supertrait bounds to render nicely.
 547 fn separate_supertrait_bounds(
 548     mut g: clean::Generics,
 549 ) -> (clean::Generics, Vec<clean::GenericBound>) {
 550     let mut ty_bounds = Vec::new();
 551     g.where_predicates.retain(|pred| match *pred {
 552         clean::WherePredicate::BoundPredicate { ty: clean::Generic(ref s), ref bounds }
 553             if *s == "Self" =>
 554         {
 555             ty_bounds.extend(bounds.iter().cloned());
 556             false
 557         }
 558         _ => true,
 559     });
 560     (g, ty_bounds)
 561 }
 562
 563 pub fn record_extern_trait(cx: &DocContext<'_>, did: DefId) {
 564     if did.is_local() {
 565         return;
 566     }
 567
 568     {
 569         if cx.external_traits.borrow().contains_key(&did)
 570             || cx.active_extern_traits.borrow().contains(&did)
 571         {
 572             return;
 573         }
 574     }
 575
 576     cx.active_extern_traits.borrow_mut().insert(did);
 577
 578     debug!("record_extern_trait: {:?}", did);
 579     let trait_ = build_external_trait(cx, did);
 580
 581     cx.external_traits.borrow_mut().insert(did, trait_);
 582     cx.active_extern_traits.borrow_mut().remove(&did);
 583 }