src/librustdoc/clean/inline.rs

   1 //! Support for inlining external documentation into the current AST.
   2
   3 use std::iter::once;
   4 use std::sync::Arc;
   5
   6 use rustc_ast as ast;
   7 use rustc_data_structures::fx::FxHashSet;
   8 use rustc_hir as hir;
   9 use rustc_hir::def::{DefKind, Res};
  10 use rustc_hir::def_id::DefId;
  11 use rustc_hir::definitions::DefPathData;
  12 use rustc_hir::Mutability;
  13 use rustc_metadata::creader::{CStore, LoadedMacro};
  14 use rustc_middle::ty::{self, TyCtxt};
  15 use rustc_span::hygiene::MacroKind;
  16 use rustc_span::symbol::{kw, sym, Symbol};
  17
  18 use crate::clean::{
  19     self, clean_fn_decl_from_did_and_sig, clean_ty_generics, utils, Attributes, AttributesExt,
  20     Clean, ImplKind, ItemId, NestedAttributesExt, Type, Visibility,
  21 };
  22 use crate::core::DocContext;
  23 use crate::formats::item_type::ItemType;
  24
  25 type Attrs<'hir> = rustc_middle::ty::Attributes<'hir>;
  26
  27 /// Attempt to inline a definition into this AST.
  28 ///
  29 /// This function will fetch the definition specified, and if it is
  30 /// from another crate it will attempt to inline the documentation
  31 /// from the other crate into this crate.
  32 ///
  33 /// This is primarily used for `pub use` statements which are, in general,
  34 /// implementation details. Inlining the documentation should help provide a
  35 /// better experience when reading the documentation in this use case.
  36 ///
  37 /// The returned value is `None` if the definition could not be inlined,
  38 /// and `Some` of a vector of items if it was successfully expanded.
  39 ///
  40 /// `parent_module` refers to the parent of the *re-export*, not the original item.
  41 crate fn try_inline(
  42     cx: &mut DocContext<'_>,
  43     parent_module: DefId,
  44     import_def_id: Option<DefId>,
  45     res: Res,
  46     name: Symbol,
  47     attrs: Option<Attrs<'_>>,
  48     visited: &mut FxHashSet<DefId>,
  49 ) -> Option<Vec<clean::Item>> {
  50     let did = res.opt_def_id()?;
  51     if did.is_local() {
  52         return None;
  53     }
  54     let mut ret = Vec::new();
  55
  56     debug!("attrs={:?}", attrs);
  57     let attrs_clone = attrs;
  58
  59     let kind = match res {
  60         Res::Def(DefKind::Trait, did) => {
  61             record_extern_fqn(cx, did, ItemType::Trait);
  62             build_impls(cx, Some(parent_module), did, attrs, &mut ret);
  63             clean::TraitItem(build_external_trait(cx, did))
  64         }
  65         Res::Def(DefKind::Fn, did) => {
  66             record_extern_fqn(cx, did, ItemType::Function);
  67             clean::FunctionItem(build_external_function(cx, did))
  68         }
  69         Res::Def(DefKind::Struct, did) => {
  70             record_extern_fqn(cx, did, ItemType::Struct);
  71             build_impls(cx, Some(parent_module), did, attrs, &mut ret);
  72             clean::StructItem(build_struct(cx, did))
  73         }
  74         Res::Def(DefKind::Union, did) => {
  75             record_extern_fqn(cx, did, ItemType::Union);
  76             build_impls(cx, Some(parent_module), did, attrs, &mut ret);
  77             clean::UnionItem(build_union(cx, did))
  78         }
  79         Res::Def(DefKind::TyAlias, did) => {
  80             record_extern_fqn(cx, did, ItemType::Typedef);
  81             build_impls(cx, Some(parent_module), did, attrs, &mut ret);
  82             clean::TypedefItem(build_type_alias(cx, did), false)
  83         }
  84         Res::Def(DefKind::Enum, did) => {
  85             record_extern_fqn(cx, did, ItemType::Enum);
  86             build_impls(cx, Some(parent_module), did, attrs, &mut ret);
  87             clean::EnumItem(build_enum(cx, did))
  88         }
  89         Res::Def(DefKind::ForeignTy, did) => {
  90             record_extern_fqn(cx, did, ItemType::ForeignType);
  91             build_impls(cx, Some(parent_module), did, attrs, &mut ret);
  92             clean::ForeignTypeItem
  93         }
  94         // Never inline enum variants but leave them shown as re-exports.
  95         Res::Def(DefKind::Variant, _) => return None,
  96         // Assume that enum variants and struct types are re-exported next to
  97         // their constructors.
  98         Res::Def(DefKind::Ctor(..), _) | Res::SelfCtor(..) => return Some(Vec::new()),
  99         Res::Def(DefKind::Mod, did) => {
 100             record_extern_fqn(cx, did, ItemType::Module);
 101             clean::ModuleItem(build_module(cx, did, visited))
 102         }
 103         Res::Def(DefKind::Static, did) => {
 104             record_extern_fqn(cx, did, ItemType::Static);
 105             clean::StaticItem(build_static(cx, did, cx.tcx.is_mutable_static(did)))
 106         }
 107         Res::Def(DefKind::Const, did) => {
 108             record_extern_fqn(cx, did, ItemType::Constant);
 109             clean::ConstantItem(build_const(cx, did))
 110         }
 111         Res::Def(DefKind::Macro(kind), did) => {
 112             let mac = build_macro(cx, did, name, import_def_id);
 113
 114             let type_kind = match kind {
 115                 MacroKind::Bang => ItemType::Macro,
 116                 MacroKind::Attr => ItemType::ProcAttribute,
 117                 MacroKind::Derive => ItemType::ProcDerive,
 118             };
 119             record_extern_fqn(cx, did, type_kind);
 120             mac
 121         }
 122         _ => return None,
 123     };
 124
 125     let (attrs, cfg) = merge_attrs(cx, Some(parent_module), load_attrs(cx, did), attrs_clone);
 126     cx.inlined.insert(did.into());
 127     let mut item =
 128         clean::Item::from_def_id_and_attrs_and_parts(did, Some(name), kind, box attrs, cx, cfg);
 129     if let Some(import_def_id) = import_def_id {
 130         // The visibility needs to reflect the one from the reexport and not from the "source" DefId.
 131         item.visibility = cx.tcx.visibility(import_def_id).clean(cx);
 132     }
 133     ret.push(item);
 134     Some(ret)
 135 }
 136
 137 crate fn try_inline_glob(
 138     cx: &mut DocContext<'_>,
 139     res: Res,
 140     visited: &mut FxHashSet<DefId>,
 141 ) -> Option<Vec<clean::Item>> {
 142     let did = res.opt_def_id()?;
 143     if did.is_local() {
 144         return None;
 145     }
 146
 147     match res {
 148         Res::Def(DefKind::Mod, did) => {
 149             let m = build_module(cx, did, visited);
 150             Some(m.items)
 151         }
 152         // glob imports on things like enums aren't inlined even for local exports, so just bail
 153         _ => None,
 154     }
 155 }
 156
 157 crate fn load_attrs<'hir>(cx: &DocContext<'hir>, did: DefId) -> Attrs<'hir> {
 158     cx.tcx.get_attrs(did)
 159 }
 160
 161 /// Record an external fully qualified name in the external_paths cache.
 162 ///
 163 /// These names are used later on by HTML rendering to generate things like
 164 /// source links back to the original item.
 165 crate fn record_extern_fqn(cx: &mut DocContext<'_>, did: DefId, kind: ItemType) {
 166     let crate_name = cx.tcx.crate_name(did.krate).to_string();
 167
 168     let relative = cx.tcx.def_path(did).data.into_iter().filter_map(|elem| {
 169         // Filter out extern blocks
 170         (elem.data != DefPathData::ForeignMod).then(|| elem.data.to_string())
 171     });
 172     let fqn = if let ItemType::Macro = kind {
 173         // Check to see if it is a macro 2.0 or built-in macro
 174         if matches!(
 175             CStore::from_tcx(cx.tcx).load_macro_untracked(did, cx.sess()),
 176             LoadedMacro::MacroDef(def, _)
 177                 if matches!(&def.kind, ast::ItemKind::MacroDef(ast_def)
 178                     if !ast_def.macro_rules)
 179         ) {
 180             once(crate_name).chain(relative).collect()
 181         } else {
 182             vec![crate_name, relative.last().expect("relative was empty")]
 183         }
 184     } else {
 185         once(crate_name).chain(relative).collect()
 186     };
 187
 188     if did.is_local() {
 189         cx.cache.exact_paths.insert(did, fqn);
 190     } else {
 191         cx.cache.external_paths.insert(did, (fqn, kind));
 192     }
 193 }
 194
 195 crate fn build_external_trait(cx: &mut DocContext<'_>, did: DefId) -> clean::Trait {
 196     let trait_items = cx
 197         .tcx
 198         .associated_items(did)
 199         .in_definition_order()
 200         .map(|item| {
 201             // When building an external trait, the cleaned trait will have all items public,
 202             // which causes methods to have a `pub` prefix, which is invalid since items in traits
 203             // can not have a visibility prefix. Thus we override the visibility here manually.
 204             // See https://github.com/rust-lang/rust/issues/81274
 205             clean::Item { visibility: Visibility::Inherited, ..item.clean(cx) }
 206         })
 207         .collect();
 208
 209     let predicates = cx.tcx.predicates_of(did);
 210     let generics = clean_ty_generics(cx, cx.tcx.generics_of(did), predicates);
 211     let generics = filter_non_trait_generics(did, generics);
 212     let (generics, supertrait_bounds) = separate_supertrait_bounds(generics);
 213     let is_auto = cx.tcx.trait_is_auto(did);
 214     clean::Trait {
 215         unsafety: cx.tcx.trait_def(did).unsafety,
 216         generics,
 217         items: trait_items,
 218         bounds: supertrait_bounds,
 219         is_auto,
 220     }
 221 }
 222
 223 fn build_external_function(cx: &mut DocContext<'_>, did: DefId) -> clean::Function {
 224     let sig = cx.tcx.fn_sig(did);
 225
 226     let constness =
 227         if cx.tcx.is_const_fn_raw(did) { hir::Constness::Const } else { hir::Constness::NotConst };
 228     let asyncness = cx.tcx.asyncness(did);
 229     let predicates = cx.tcx.predicates_of(did);
 230     let (generics, decl) = clean::enter_impl_trait(cx, |cx| {
 231         // NOTE: generics need to be cleaned before the decl!
 232         let generics = clean_ty_generics(cx, cx.tcx.generics_of(did), predicates);
 233         let decl = clean_fn_decl_from_did_and_sig(cx, did, sig);
 234         (generics, decl)
 235     });
 236     clean::Function {
 237         decl,
 238         generics,
 239         header: hir::FnHeader { unsafety: sig.unsafety(), abi: sig.abi(), constness, asyncness },
 240     }
 241 }
 242
 243 fn build_enum(cx: &mut DocContext<'_>, did: DefId) -> clean::Enum {
 244     let predicates = cx.tcx.explicit_predicates_of(did);
 245
 246     clean::Enum {
 247         generics: clean_ty_generics(cx, cx.tcx.generics_of(did), predicates),
 248         variants_stripped: false,
 249         variants: cx.tcx.adt_def(did).variants.iter().map(|v| v.clean(cx)).collect(),
 250     }
 251 }
 252
 253 fn build_struct(cx: &mut DocContext<'_>, did: DefId) -> clean::Struct {
 254     let predicates = cx.tcx.explicit_predicates_of(did);
 255     let variant = cx.tcx.adt_def(did).non_enum_variant();
 256
 257     clean::Struct {
 258         struct_type: variant.ctor_kind,
 259         generics: clean_ty_generics(cx, cx.tcx.generics_of(did), predicates),
 260         fields: variant.fields.iter().map(|x| x.clean(cx)).collect(),
 261         fields_stripped: false,
 262     }
 263 }
 264
 265 fn build_union(cx: &mut DocContext<'_>, did: DefId) -> clean::Union {
 266     let predicates = cx.tcx.explicit_predicates_of(did);
 267     let variant = cx.tcx.adt_def(did).non_enum_variant();
 268
 269     let generics = clean_ty_generics(cx, cx.tcx.generics_of(did), predicates);
 270     let fields = variant.fields.iter().map(|x| x.clean(cx)).collect();
 271     clean::Union { generics, fields, fields_stripped: false }
 272 }
 273
 274 fn build_type_alias(cx: &mut DocContext<'_>, did: DefId) -> clean::Typedef {
 275     let predicates = cx.tcx.explicit_predicates_of(did);
 276     let type_ = cx.tcx.type_of(did).clean(cx);
 277
 278     clean::Typedef {
 279         type_,
 280         generics: clean_ty_generics(cx, cx.tcx.generics_of(did), predicates),
 281         item_type: None,
 282     }
 283 }
 284
 285 /// Builds all inherent implementations of an ADT (struct/union/enum) or Trait item/path/reexport.
 286 crate fn build_impls(
 287     cx: &mut DocContext<'_>,
 288     parent_module: Option<DefId>,
 289     did: DefId,
 290     attrs: Option<Attrs<'_>>,
 291     ret: &mut Vec<clean::Item>,
 292 ) {
 293     let tcx = cx.tcx;
 294
 295     // for each implementation of an item represented by `did`, build the clean::Item for that impl
 296     for &did in tcx.inherent_impls(did).iter() {
 297         build_impl(cx, parent_module, did, attrs, ret);
 298     }
 299 }
 300
 301 /// `parent_module` refers to the parent of the re-export, not the original item
 302 fn merge_attrs(
 303     cx: &mut DocContext<'_>,
 304     parent_module: Option<DefId>,
 305     old_attrs: Attrs<'_>,
 306     new_attrs: Option<Attrs<'_>>,
 307 ) -> (clean::Attributes, Option<Arc<clean::cfg::Cfg>>) {
 308     // NOTE: If we have additional attributes (from a re-export),
 309     // always insert them first. This ensure that re-export
 310     // doc comments show up before the original doc comments
 311     // when we render them.
 312     if let Some(inner) = new_attrs {
 313         let mut both = inner.to_vec();
 314         both.extend_from_slice(old_attrs);
 315         (
 316             if let Some(new_id) = parent_module {
 317                 Attributes::from_ast(old_attrs, Some((inner, new_id)))
 318             } else {
 319                 Attributes::from_ast(&both, None)
 320             },
 321             both.cfg(cx.tcx, &cx.cache.hidden_cfg),
 322         )
 323     } else {
 324         (old_attrs.clean(cx), old_attrs.cfg(cx.tcx, &cx.cache.hidden_cfg))
 325     }
 326 }
 327
 328 /// Inline an `impl`, inherent or of a trait. The `did` must be for an `impl`.
 329 crate fn build_impl(
 330     cx: &mut DocContext<'_>,
 331     parent_module: impl Into<Option<DefId>>,
 332     did: DefId,
 333     attrs: Option<Attrs<'_>>,
 334     ret: &mut Vec<clean::Item>,
 335 ) {
 336     if !cx.inlined.insert(did.into()) {
 337         return;
 338     }
 339
 340     let _prof_timer = cx.tcx.sess.prof.generic_activity("build_extern_trait_impl");
 341
 342     let tcx = cx.tcx;
 343     let associated_trait = tcx.impl_trait_ref(did);
 344
 345     // Only inline impl if the implemented trait is
 346     // reachable in rustdoc generated documentation
 347     if !did.is_local() {
 348         if let Some(traitref) = associated_trait {
 349             let did = traitref.def_id;
 350             if !cx.cache.access_levels.is_public(did) {
 351                 return;
 352             }
 353
 354             if let Some(stab) = tcx.lookup_stability(did) {
 355                 if stab.level.is_unstable() && stab.feature == sym::rustc_private {
 356                     return;
 357                 }
 358             }
 359         }
 360     }
 361
 362     let impl_item = match did.as_local() {
 363         Some(did) => match &tcx.hir().expect_item(did).kind {
 364             hir::ItemKind::Impl(impl_) => Some(impl_),
 365             _ => panic!("`DefID` passed to `build_impl` is not an `impl"),
 366         },
 367         None => None,
 368     };
 369
 370     let for_ = match &impl_item {
 371         Some(impl_) => impl_.self_ty.clean(cx),
 372         None => tcx.type_of(did).clean(cx),
 373     };
 374
 375     // Only inline impl if the implementing type is
 376     // reachable in rustdoc generated documentation
 377     if !did.is_local() {
 378         if let Some(did) = for_.def_id(&cx.cache) {
 379             if !cx.cache.access_levels.is_public(did) {
 380                 return;
 381             }
 382
 383             if let Some(stab) = tcx.lookup_stability(did) {
 384                 if stab.level.is_unstable() && stab.feature == sym::rustc_private {
 385                     return;
 386                 }
 387             }
 388         }
 389     }
 390
 391     let document_hidden = cx.render_options.document_hidden;
 392     let predicates = tcx.explicit_predicates_of(did);
 393     let (trait_items, generics) = match impl_item {
 394         Some(impl_) => (
 395             impl_
 396                 .items
 397                 .iter()
 398                 .map(|item| tcx.hir().impl_item(item.id))
 399                 .filter(|item| {
 400                     // Filter out impl items whose corresponding trait item has `doc(hidden)`
 401                     // not to document such impl items.
 402                     // For inherent impls, we don't do any filtering, because that's already done in strip_hidden.rs.
 403
 404                     // When `--document-hidden-items` is passed, we don't
 405                     // do any filtering, too.
 406                     if document_hidden {
 407                         return true;
 408                     }
 409                     if let Some(associated_trait) = associated_trait {
 410                         let assoc_kind = match item.kind {
 411                             hir::ImplItemKind::Const(..) => ty::AssocKind::Const,
 412                             hir::ImplItemKind::Fn(..) => ty::AssocKind::Fn,
 413                             hir::ImplItemKind::TyAlias(..) => ty::AssocKind::Type,
 414                         };
 415                         let trait_item = tcx
 416                             .associated_items(associated_trait.def_id)
 417                             .find_by_name_and_kind(
 418                                 tcx,
 419                                 item.ident,
 420                                 assoc_kind,
 421                                 associated_trait.def_id,
 422                             )
 423                             .unwrap(); // SAFETY: For all impl items there exists trait item that has the same name.
 424                         !tcx.get_attrs(trait_item.def_id).lists(sym::doc).has_word(sym::hidden)
 425                     } else {
 426                         true
 427                     }
 428                 })
 429                 .map(|item| item.clean(cx))
 430                 .collect::<Vec<_>>(),
 431             impl_.generics.clean(cx),
 432         ),
 433         None => (
 434             tcx.associated_items(did)
 435                 .in_definition_order()
 436                 .filter_map(|item| {
 437                     if associated_trait.is_some() || item.vis.is_public() {
 438                         Some(item.clean(cx))
 439                     } else {
 440                         None
 441                     }
 442                 })
 443                 .collect::<Vec<_>>(),
 444             clean::enter_impl_trait(cx, |cx| {
 445                 clean_ty_generics(cx, tcx.generics_of(did), predicates)
 446             }),
 447         ),
 448     };
 449     let polarity = tcx.impl_polarity(did);
 450     let trait_ = associated_trait.map(|t| t.clean(cx));
 451     if trait_.as_ref().map(|t| t.def_id()) == tcx.lang_items().deref_trait() {
 452         super::build_deref_target_impls(cx, &trait_items, ret);
 453     }
 454
 455     // Return if the trait itself or any types of the generic parameters are doc(hidden).
 456     let mut stack: Vec<&Type> = vec![&for_];
 457
 458     if let Some(did) = trait_.as_ref().map(|t| t.def_id()) {
 459         if tcx.get_attrs(did).lists(sym::doc).has_word(sym::hidden) {
 460             return;
 461         }
 462     }
 463     if let Some(generics) = trait_.as_ref().and_then(|t| t.generics()) {
 464         stack.extend(generics);
 465     }
 466
 467     while let Some(ty) = stack.pop() {
 468         if let Some(did) = ty.def_id(&cx.cache) {
 469             if tcx.get_attrs(did).lists(sym::doc).has_word(sym::hidden) {
 470                 return;
 471             }
 472         }
 473         if let Some(generics) = ty.generics() {
 474             stack.extend(generics);
 475         }
 476     }
 477
 478     if let Some(did) = trait_.as_ref().map(|t| t.def_id()) {
 479         record_extern_trait(cx, did);
 480     }
 481
 482     let (merged_attrs, cfg) = merge_attrs(cx, parent_module.into(), load_attrs(cx, did), attrs);
 483     trace!("merged_attrs={:?}", merged_attrs);
 484
 485     trace!(
 486         "build_impl: impl {:?} for {:?}",
 487         trait_.as_ref().map(|t| t.def_id()),
 488         for_.def_id(&cx.cache)
 489     );
 490     ret.push(clean::Item::from_def_id_and_attrs_and_parts(
 491         did,
 492         None,
 493         clean::ImplItem(clean::Impl {
 494             unsafety: hir::Unsafety::Normal,
 495             generics,
 496             trait_,
 497             for_,
 498             items: trait_items,
 499             polarity,
 500             kind: ImplKind::Normal,
 501         }),
 502         box merged_attrs,
 503         cx,
 504         cfg,
 505     ));
 506 }
 507
 508 fn build_module(
 509     cx: &mut DocContext<'_>,
 510     did: DefId,
 511     visited: &mut FxHashSet<DefId>,
 512 ) -> clean::Module {
 513     let mut items = Vec::new();
 514
 515     // If we're re-exporting a re-export it may actually re-export something in
 516     // two namespaces, so the target may be listed twice. Make sure we only
 517     // visit each node at most once.
 518     for &item in cx.tcx.item_children(did).iter() {
 519         if item.vis.is_public() {
 520             let res = item.res.expect_non_local();
 521             if let Some(def_id) = res.mod_def_id() {
 522                 if did == def_id || !visited.insert(def_id) {
 523                     continue;
 524                 }
 525             }
 526             if let Res::PrimTy(p) = res {
 527                 // Primitive types can't be inlined so generate an import instead.
 528                 let prim_ty = clean::PrimitiveType::from(p);
 529                 items.push(clean::Item {
 530                     name: None,
 531                     attrs: box clean::Attributes::default(),
 532                     def_id: ItemId::Primitive(prim_ty, did.krate),
 533                     visibility: clean::Public,
 534                     kind: box clean::ImportItem(clean::Import::new_simple(
 535                         item.ident.name,
 536                         clean::ImportSource {
 537                             path: clean::Path {
 538                                 res,
 539                                 segments: vec![clean::PathSegment {
 540                                     name: prim_ty.as_sym(),
 541                                     args: clean::GenericArgs::AngleBracketed {
 542                                         args: Vec::new(),
 543                                         bindings: Vec::new(),
 544                                     },
 545                                 }],
 546                             },
 547                             did: None,
 548                         },
 549                         true,
 550                     )),
 551                     cfg: None,
 552                 });
 553             } else if let Some(i) = try_inline(cx, did, None, res, item.ident.name, None, visited) {
 554                 items.extend(i)
 555             }
 556         }
 557     }
 558
 559     let span = clean::Span::new(cx.tcx.def_span(did));
 560     clean::Module { items, span }
 561 }
 562
 563 crate fn print_inlined_const(tcx: TyCtxt<'_>, did: DefId) -> String {
 564     if let Some(did) = did.as_local() {
 565         let hir_id = tcx.hir().local_def_id_to_hir_id(did);
 566         rustc_hir_pretty::id_to_string(&tcx.hir(), hir_id)
 567     } else {
 568         tcx.rendered_const(did)
 569     }
 570 }
 571
 572 fn build_const(cx: &mut DocContext<'_>, def_id: DefId) -> clean::Constant {
 573     clean::Constant {
 574         type_: cx.tcx.type_of(def_id).clean(cx),
 575         kind: clean::ConstantKind::Extern { def_id },
 576     }
 577 }
 578
 579 fn build_static(cx: &mut DocContext<'_>, did: DefId, mutable: bool) -> clean::Static {
 580     clean::Static {
 581         type_: cx.tcx.type_of(did).clean(cx),
 582         mutability: if mutable { Mutability::Mut } else { Mutability::Not },
 583         expr: None,
 584     }
 585 }
 586
 587 fn build_macro(
 588     cx: &mut DocContext<'_>,
 589     def_id: DefId,
 590     name: Symbol,
 591     import_def_id: Option<DefId>,
 592 ) -> clean::ItemKind {
 593     match CStore::from_tcx(cx.tcx).load_macro_untracked(def_id, cx.sess()) {
 594         LoadedMacro::MacroDef(item_def, _) => {
 595             if let ast::ItemKind::MacroDef(ref def) = item_def.kind {
 596                 let vis = cx.tcx.visibility(import_def_id.unwrap_or(def_id)).clean(cx);
 597                 clean::MacroItem(clean::Macro {
 598                     source: utils::display_macro_source(cx, name, def, def_id, vis),
 599                 })
 600             } else {
 601                 unreachable!()
 602             }
 603         }
 604         LoadedMacro::ProcMacro(ext) => clean::ProcMacroItem(clean::ProcMacro {
 605             kind: ext.macro_kind(),
 606             helpers: ext.helper_attrs,
 607         }),
 608     }
 609 }
 610
 611 /// A trait's generics clause actually contains all of the predicates for all of
 612 /// its associated types as well. We specifically move these clauses to the
 613 /// associated types instead when displaying, so when we're generating the
 614 /// generics for the trait itself we need to be sure to remove them.
 615 /// We also need to remove the implied "recursive" Self: Trait bound.
 616 ///
 617 /// The inverse of this filtering logic can be found in the `Clean`
 618 /// implementation for `AssociatedType`
 619 fn filter_non_trait_generics(trait_did: DefId, mut g: clean::Generics) -> clean::Generics {
 620     for pred in &mut g.where_predicates {
 621         match *pred {
 622             clean::WherePredicate::BoundPredicate {
 623                 ty: clean::Generic(ref s),
 624                 ref mut bounds,
 625                 ..
 626             } if *s == kw::SelfUpper => {
 627                 bounds.retain(|bound| match bound {
 628                     clean::GenericBound::TraitBound(clean::PolyTrait { trait_, .. }, _) => {
 629                         trait_.def_id() != trait_did
 630                     }
 631                     _ => true,
 632                 });
 633             }
 634             _ => {}
 635         }
 636     }
 637
 638     g.where_predicates.retain(|pred| match pred {
 639         clean::WherePredicate::BoundPredicate {
 640             ty: clean::QPath { self_type: box clean::Generic(ref s), trait_, name: _, .. },
 641             bounds,
 642             ..
 643         } => !(bounds.is_empty() || *s == kw::SelfUpper && trait_.def_id() == trait_did),
 644         _ => true,
 645     });
 646     g
 647 }
 648
 649 /// Supertrait bounds for a trait are also listed in the generics coming from
 650 /// the metadata for a crate, so we want to separate those out and create a new
 651 /// list of explicit supertrait bounds to render nicely.
 652 fn separate_supertrait_bounds(
 653     mut g: clean::Generics,
 654 ) -> (clean::Generics, Vec<clean::GenericBound>) {
 655     let mut ty_bounds = Vec::new();
 656     g.where_predicates.retain(|pred| match *pred {
 657         clean::WherePredicate::BoundPredicate { ty: clean::Generic(ref s), ref bounds, .. }
 658             if *s == kw::SelfUpper =>
 659         {
 660             ty_bounds.extend(bounds.iter().cloned());
 661             false
 662         }
 663         _ => true,
 664     });
 665     (g, ty_bounds)
 666 }
 667
 668 crate fn record_extern_trait(cx: &mut DocContext<'_>, did: DefId) {
 669     if did.is_local() {
 670         return;
 671     }
 672
 673     {
 674         if cx.external_traits.borrow().contains_key(&did) || cx.active_extern_traits.contains(&did)
 675         {
 676             return;
 677         }
 678     }
 679
 680     {
 681         cx.active_extern_traits.insert(did);
 682     }
 683
 684     debug!("record_extern_trait: {:?}", did);
 685     let trait_ = build_external_trait(cx, did);
 686
 687     let trait_ = clean::TraitWithExtraInfo {
 688         trait_,
 689         is_notable: clean::utils::has_doc_flag(cx.tcx.get_attrs(did), sym::notable_trait),
 690     };
 691     cx.external_traits.borrow_mut().insert(did, trait_);
 692     cx.active_extern_traits.remove(&did);
 693 }