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_data_structures::thin_vec::ThinVec;
   9 use rustc_hir as hir;
  10 use rustc_hir::def::{DefKind, Res};
  11 use rustc_hir::def_id::DefId;
  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, 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);
 167
 168     let relative =
 169         cx.tcx.def_path(did).data.into_iter().filter_map(|elem| elem.data.get_opt_name());
 170     let fqn = if let ItemType::Macro = kind {
 171         // Check to see if it is a macro 2.0 or built-in macro
 172         if matches!(
 173             CStore::from_tcx(cx.tcx).load_macro_untracked(did, cx.sess()),
 174             LoadedMacro::MacroDef(def, _)
 175                 if matches!(&def.kind, ast::ItemKind::MacroDef(ast_def)
 176                     if !ast_def.macro_rules)
 177         ) {
 178             once(crate_name).chain(relative).collect()
 179         } else {
 180             vec![crate_name, relative.last().expect("relative was empty")]
 181         }
 182     } else {
 183         once(crate_name).chain(relative).collect()
 184     };
 185
 186     if did.is_local() {
 187         cx.cache.exact_paths.insert(did, fqn);
 188     } else {
 189         cx.cache.external_paths.insert(did, (fqn, kind));
 190     }
 191 }
 192
 193 crate fn build_external_trait(cx: &mut DocContext<'_>, did: DefId) -> clean::Trait {
 194     let trait_items = cx
 195         .tcx
 196         .associated_items(did)
 197         .in_definition_order()
 198         .map(|item| {
 199             // When building an external trait, the cleaned trait will have all items public,
 200             // which causes methods to have a `pub` prefix, which is invalid since items in traits
 201             // can not have a visibility prefix. Thus we override the visibility here manually.
 202             // See https://github.com/rust-lang/rust/issues/81274
 203             clean::Item { visibility: Visibility::Inherited, ..item.clean(cx) }
 204         })
 205         .collect();
 206
 207     let predicates = cx.tcx.predicates_of(did);
 208     let generics = clean_ty_generics(cx, cx.tcx.generics_of(did), predicates);
 209     let generics = filter_non_trait_generics(did, generics);
 210     let (generics, supertrait_bounds) = separate_supertrait_bounds(generics);
 211     let is_auto = cx.tcx.trait_is_auto(did);
 212     clean::Trait {
 213         unsafety: cx.tcx.trait_def(did).unsafety,
 214         generics,
 215         items: trait_items,
 216         bounds: supertrait_bounds,
 217         is_auto,
 218     }
 219 }
 220
 221 fn build_external_function(cx: &mut DocContext<'_>, did: DefId) -> clean::Function {
 222     let sig = cx.tcx.fn_sig(did);
 223
 224     let constness =
 225         if cx.tcx.is_const_fn_raw(did) { hir::Constness::Const } else { hir::Constness::NotConst };
 226     let asyncness = cx.tcx.asyncness(did);
 227     let predicates = cx.tcx.predicates_of(did);
 228     let (generics, decl) = clean::enter_impl_trait(cx, |cx| {
 229         // NOTE: generics need to be cleaned before the decl!
 230         let generics = clean_ty_generics(cx, cx.tcx.generics_of(did), predicates);
 231         let decl = clean_fn_decl_from_did_and_sig(cx, did, sig);
 232         (generics, decl)
 233     });
 234     clean::Function {
 235         decl,
 236         generics,
 237         header: hir::FnHeader { unsafety: sig.unsafety(), abi: sig.abi(), constness, asyncness },
 238     }
 239 }
 240
 241 fn build_enum(cx: &mut DocContext<'_>, did: DefId) -> clean::Enum {
 242     let predicates = cx.tcx.explicit_predicates_of(did);
 243
 244     clean::Enum {
 245         generics: clean_ty_generics(cx, cx.tcx.generics_of(did), predicates),
 246         variants_stripped: false,
 247         variants: cx.tcx.adt_def(did).variants.iter().map(|v| v.clean(cx)).collect(),
 248     }
 249 }
 250
 251 fn build_struct(cx: &mut DocContext<'_>, did: DefId) -> clean::Struct {
 252     let predicates = cx.tcx.explicit_predicates_of(did);
 253     let variant = cx.tcx.adt_def(did).non_enum_variant();
 254
 255     clean::Struct {
 256         struct_type: variant.ctor_kind,
 257         generics: clean_ty_generics(cx, cx.tcx.generics_of(did), predicates),
 258         fields: variant.fields.iter().map(|x| x.clean(cx)).collect(),
 259         fields_stripped: false,
 260     }
 261 }
 262
 263 fn build_union(cx: &mut DocContext<'_>, did: DefId) -> clean::Union {
 264     let predicates = cx.tcx.explicit_predicates_of(did);
 265     let variant = cx.tcx.adt_def(did).non_enum_variant();
 266
 267     let generics = clean_ty_generics(cx, cx.tcx.generics_of(did), predicates);
 268     let fields = variant.fields.iter().map(|x| x.clean(cx)).collect();
 269     clean::Union { generics, fields, fields_stripped: false }
 270 }
 271
 272 fn build_type_alias(cx: &mut DocContext<'_>, did: DefId) -> clean::Typedef {
 273     let predicates = cx.tcx.explicit_predicates_of(did);
 274     let type_ = cx.tcx.type_of(did).clean(cx);
 275
 276     clean::Typedef {
 277         type_,
 278         generics: clean_ty_generics(cx, cx.tcx.generics_of(did), predicates),
 279         item_type: None,
 280     }
 281 }
 282
 283 /// Builds all inherent implementations of an ADT (struct/union/enum) or Trait item/path/reexport.
 284 crate fn build_impls(
 285     cx: &mut DocContext<'_>,
 286     parent_module: Option<DefId>,
 287     did: DefId,
 288     attrs: Option<Attrs<'_>>,
 289     ret: &mut Vec<clean::Item>,
 290 ) {
 291     let _prof_timer = cx.tcx.sess.prof.generic_activity("build_inherent_impls");
 292     let tcx = cx.tcx;
 293
 294     // for each implementation of an item represented by `did`, build the clean::Item for that impl
 295     for &did in tcx.inherent_impls(did).iter() {
 296         build_impl(cx, parent_module, did, attrs, ret);
 297     }
 298 }
 299
 300 /// `parent_module` refers to the parent of the re-export, not the original item
 301 fn merge_attrs(
 302     cx: &mut DocContext<'_>,
 303     parent_module: Option<DefId>,
 304     old_attrs: Attrs<'_>,
 305     new_attrs: Option<Attrs<'_>>,
 306 ) -> (clean::Attributes, Option<Arc<clean::cfg::Cfg>>) {
 307     // NOTE: If we have additional attributes (from a re-export),
 308     // always insert them first. This ensure that re-export
 309     // doc comments show up before the original doc comments
 310     // when we render them.
 311     if let Some(inner) = new_attrs {
 312         let mut both = inner.to_vec();
 313         both.extend_from_slice(old_attrs);
 314         (
 315             if let Some(new_id) = parent_module {
 316                 Attributes::from_ast(old_attrs, Some((inner, new_id)))
 317             } else {
 318                 Attributes::from_ast(&both, None)
 319             },
 320             both.cfg(cx.tcx, &cx.cache.hidden_cfg),
 321         )
 322     } else {
 323         (old_attrs.clean(cx), old_attrs.cfg(cx.tcx, &cx.cache.hidden_cfg))
 324     }
 325 }
 326
 327 /// Inline an `impl`, inherent or of a trait. The `did` must be for an `impl`.
 328 crate fn build_impl(
 329     cx: &mut DocContext<'_>,
 330     parent_module: impl Into<Option<DefId>>,
 331     did: DefId,
 332     attrs: Option<Attrs<'_>>,
 333     ret: &mut Vec<clean::Item>,
 334 ) {
 335     if !cx.inlined.insert(did.into()) {
 336         return;
 337     }
 338
 339     let _prof_timer = cx.tcx.sess.prof.generic_activity("build_impl");
 340
 341     let tcx = cx.tcx;
 342     let associated_trait = tcx.impl_trait_ref(did);
 343
 344     // Only inline impl if the implemented trait is
 345     // reachable in rustdoc generated documentation
 346     if !did.is_local() {
 347         if let Some(traitref) = associated_trait {
 348             let did = traitref.def_id;
 349             if !cx.cache.access_levels.is_public(did) {
 350                 return;
 351             }
 352
 353             if let Some(stab) = tcx.lookup_stability(did) {
 354                 if stab.level.is_unstable() && stab.feature == sym::rustc_private {
 355                     return;
 356                 }
 357             }
 358         }
 359     }
 360
 361     let impl_item = match did.as_local() {
 362         Some(did) => match &tcx.hir().expect_item(did).kind {
 363             hir::ItemKind::Impl(impl_) => Some(impl_),
 364             _ => panic!("`DefID` passed to `build_impl` is not an `impl"),
 365         },
 366         None => None,
 367     };
 368
 369     let for_ = match &impl_item {
 370         Some(impl_) => impl_.self_ty.clean(cx),
 371         None => tcx.type_of(did).clean(cx),
 372     };
 373
 374     // Only inline impl if the implementing type is
 375     // reachable in rustdoc generated documentation
 376     if !did.is_local() {
 377         if let Some(did) = for_.def_id(&cx.cache) {
 378             if !cx.cache.access_levels.is_public(did) {
 379                 return;
 380             }
 381
 382             if let Some(stab) = tcx.lookup_stability(did) {
 383                 if stab.level.is_unstable() && stab.feature == sym::rustc_private {
 384                     return;
 385                 }
 386             }
 387         }
 388     }
 389
 390     let document_hidden = cx.render_options.document_hidden;
 391     let predicates = tcx.explicit_predicates_of(did);
 392     let (trait_items, generics) = match impl_item {
 393         Some(impl_) => (
 394             impl_
 395                 .items
 396                 .iter()
 397                 .map(|item| tcx.hir().impl_item(item.id))
 398                 .filter(|item| {
 399                     // Filter out impl items whose corresponding trait item has `doc(hidden)`
 400                     // not to document such impl items.
 401                     // For inherent impls, we don't do any filtering, because that's already done in strip_hidden.rs.
 402
 403                     // When `--document-hidden-items` is passed, we don't
 404                     // do any filtering, too.
 405                     if document_hidden {
 406                         return true;
 407                     }
 408                     if let Some(associated_trait) = associated_trait {
 409                         let assoc_kind = match item.kind {
 410                             hir::ImplItemKind::Const(..) => ty::AssocKind::Const,
 411                             hir::ImplItemKind::Fn(..) => ty::AssocKind::Fn,
 412                             hir::ImplItemKind::TyAlias(..) => ty::AssocKind::Type,
 413                         };
 414                         let trait_item = tcx
 415                             .associated_items(associated_trait.def_id)
 416                             .find_by_name_and_kind(
 417                                 tcx,
 418                                 item.ident,
 419                                 assoc_kind,
 420                                 associated_trait.def_id,
 421                             )
 422                             .unwrap(); // SAFETY: For all impl items there exists trait item that has the same name.
 423                         !tcx.is_doc_hidden(trait_item.def_id)
 424                     } else {
 425                         true
 426                     }
 427                 })
 428                 .map(|item| item.clean(cx))
 429                 .collect::<Vec<_>>(),
 430             impl_.generics.clean(cx),
 431         ),
 432         None => (
 433             tcx.associated_items(did)
 434                 .in_definition_order()
 435                 .filter_map(|item| {
 436                     if associated_trait.is_some() || item.vis.is_public() {
 437                         Some(item.clean(cx))
 438                     } else {
 439                         None
 440                     }
 441                 })
 442                 .collect::<Vec<_>>(),
 443             clean::enter_impl_trait(cx, |cx| {
 444                 clean_ty_generics(cx, tcx.generics_of(did), predicates)
 445             }),
 446         ),
 447     };
 448     let polarity = tcx.impl_polarity(did);
 449     let trait_ = associated_trait.map(|t| t.clean(cx));
 450     if trait_.as_ref().map(|t| t.def_id()) == tcx.lang_items().deref_trait() {
 451         super::build_deref_target_impls(cx, &trait_items, ret);
 452     }
 453
 454     // Return if the trait itself or any types of the generic parameters are doc(hidden).
 455     let mut stack: Vec<&Type> = vec![&for_];
 456
 457     if let Some(did) = trait_.as_ref().map(|t| t.def_id()) {
 458         if tcx.is_doc_hidden(did) {
 459             return;
 460         }
 461     }
 462     if let Some(generics) = trait_.as_ref().and_then(|t| t.generics()) {
 463         stack.extend(generics);
 464     }
 465
 466     while let Some(ty) = stack.pop() {
 467         if let Some(did) = ty.def_id(&cx.cache) {
 468             if tcx.is_doc_hidden(did) {
 469                 return;
 470             }
 471         }
 472         if let Some(generics) = ty.generics() {
 473             stack.extend(generics);
 474         }
 475     }
 476
 477     if let Some(did) = trait_.as_ref().map(|t| t.def_id()) {
 478         record_extern_trait(cx, did);
 479     }
 480
 481     let (merged_attrs, cfg) = merge_attrs(cx, parent_module.into(), load_attrs(cx, did), attrs);
 482     trace!("merged_attrs={:?}", merged_attrs);
 483
 484     trace!(
 485         "build_impl: impl {:?} for {:?}",
 486         trait_.as_ref().map(|t| t.def_id()),
 487         for_.def_id(&cx.cache)
 488     );
 489     ret.push(clean::Item::from_def_id_and_attrs_and_parts(
 490         did,
 491         None,
 492         clean::ImplItem(clean::Impl {
 493             unsafety: hir::Unsafety::Normal,
 494             generics,
 495             trait_,
 496             for_,
 497             items: trait_items,
 498             polarity,
 499             kind: ImplKind::Normal,
 500         }),
 501         box merged_attrs,
 502         cx,
 503         cfg,
 504     ));
 505 }
 506
 507 fn build_module(
 508     cx: &mut DocContext<'_>,
 509     did: DefId,
 510     visited: &mut FxHashSet<DefId>,
 511 ) -> clean::Module {
 512     let mut items = Vec::new();
 513
 514     // If we're re-exporting a re-export it may actually re-export something in
 515     // two namespaces, so the target may be listed twice. Make sure we only
 516     // visit each node at most once.
 517     for &item in cx.tcx.module_children(did).iter() {
 518         if item.vis.is_public() {
 519             let res = item.res.expect_non_local();
 520             if let Some(def_id) = res.mod_def_id() {
 521                 if did == def_id || !visited.insert(def_id) {
 522                     continue;
 523                 }
 524             }
 525             if let Res::PrimTy(p) = res {
 526                 // Primitive types can't be inlined so generate an import instead.
 527                 let prim_ty = clean::PrimitiveType::from(p);
 528                 items.push(clean::Item {
 529                     name: None,
 530                     attrs: box clean::Attributes::default(),
 531                     def_id: ItemId::Primitive(prim_ty, did.krate),
 532                     visibility: clean::Public,
 533                     kind: box clean::ImportItem(clean::Import::new_simple(
 534                         item.ident.name,
 535                         clean::ImportSource {
 536                             path: clean::Path {
 537                                 res,
 538                                 segments: vec![clean::PathSegment {
 539                                     name: prim_ty.as_sym(),
 540                                     args: clean::GenericArgs::AngleBracketed {
 541                                         args: Vec::new(),
 542                                         bindings: ThinVec::new(),
 543                                     },
 544                                 }],
 545                             },
 546                             did: None,
 547                         },
 548                         true,
 549                     )),
 550                     cfg: None,
 551                 });
 552             } else if let Some(i) = try_inline(cx, did, None, res, item.ident.name, None, visited) {
 553                 items.extend(i)
 554             }
 555         }
 556     }
 557
 558     let span = clean::Span::new(cx.tcx.def_span(did));
 559     clean::Module { items, span }
 560 }
 561
 562 crate fn print_inlined_const(tcx: TyCtxt<'_>, did: DefId) -> String {
 563     if let Some(did) = did.as_local() {
 564         let hir_id = tcx.hir().local_def_id_to_hir_id(did);
 565         rustc_hir_pretty::id_to_string(&tcx.hir(), hir_id)
 566     } else {
 567         tcx.rendered_const(did)
 568     }
 569 }
 570
 571 fn build_const(cx: &mut DocContext<'_>, def_id: DefId) -> clean::Constant {
 572     clean::Constant {
 573         type_: cx.tcx.type_of(def_id).clean(cx),
 574         kind: clean::ConstantKind::Extern { def_id },
 575     }
 576 }
 577
 578 fn build_static(cx: &mut DocContext<'_>, did: DefId, mutable: bool) -> clean::Static {
 579     clean::Static {
 580         type_: cx.tcx.type_of(did).clean(cx),
 581         mutability: if mutable { Mutability::Mut } else { Mutability::Not },
 582         expr: None,
 583     }
 584 }
 585
 586 fn build_macro(
 587     cx: &mut DocContext<'_>,
 588     def_id: DefId,
 589     name: Symbol,
 590     import_def_id: Option<DefId>,
 591 ) -> clean::ItemKind {
 592     match CStore::from_tcx(cx.tcx).load_macro_untracked(def_id, cx.sess()) {
 593         LoadedMacro::MacroDef(item_def, _) => {
 594             if let ast::ItemKind::MacroDef(ref def) = item_def.kind {
 595                 let vis = cx.tcx.visibility(import_def_id.unwrap_or(def_id)).clean(cx);
 596                 clean::MacroItem(clean::Macro {
 597                     source: utils::display_macro_source(cx, name, def, def_id, vis),
 598                 })
 599             } else {
 600                 unreachable!()
 601             }
 602         }
 603         LoadedMacro::ProcMacro(ext) => clean::ProcMacroItem(clean::ProcMacro {
 604             kind: ext.macro_kind(),
 605             helpers: ext.helper_attrs,
 606         }),
 607     }
 608 }
 609
 610 /// A trait's generics clause actually contains all of the predicates for all of
 611 /// its associated types as well. We specifically move these clauses to the
 612 /// associated types instead when displaying, so when we're generating the
 613 /// generics for the trait itself we need to be sure to remove them.
 614 /// We also need to remove the implied "recursive" Self: Trait bound.
 615 ///
 616 /// The inverse of this filtering logic can be found in the `Clean`
 617 /// implementation for `AssociatedType`
 618 fn filter_non_trait_generics(trait_did: DefId, mut g: clean::Generics) -> clean::Generics {
 619     for pred in &mut g.where_predicates {
 620         match *pred {
 621             clean::WherePredicate::BoundPredicate {
 622                 ty: clean::Generic(ref s),
 623                 ref mut bounds,
 624                 ..
 625             } if *s == kw::SelfUpper => {
 626                 bounds.retain(|bound| match bound {
 627                     clean::GenericBound::TraitBound(clean::PolyTrait { trait_, .. }, _) => {
 628                         trait_.def_id() != trait_did
 629                     }
 630                     _ => true,
 631                 });
 632             }
 633             _ => {}
 634         }
 635     }
 636
 637     g.where_predicates.retain(|pred| match pred {
 638         clean::WherePredicate::BoundPredicate {
 639             ty: clean::QPath { self_type: box clean::Generic(ref s), trait_, name: _, .. },
 640             bounds,
 641             ..
 642         } => !(bounds.is_empty() || *s == kw::SelfUpper && trait_.def_id() == trait_did),
 643         _ => true,
 644     });
 645     g
 646 }
 647
 648 /// Supertrait bounds for a trait are also listed in the generics coming from
 649 /// the metadata for a crate, so we want to separate those out and create a new
 650 /// list of explicit supertrait bounds to render nicely.
 651 fn separate_supertrait_bounds(
 652     mut g: clean::Generics,
 653 ) -> (clean::Generics, Vec<clean::GenericBound>) {
 654     let mut ty_bounds = Vec::new();
 655     g.where_predicates.retain(|pred| match *pred {
 656         clean::WherePredicate::BoundPredicate { ty: clean::Generic(ref s), ref bounds, .. }
 657             if *s == kw::SelfUpper =>
 658         {
 659             ty_bounds.extend(bounds.iter().cloned());
 660             false
 661         }
 662         _ => true,
 663     });
 664     (g, ty_bounds)
 665 }
 666
 667 crate fn record_extern_trait(cx: &mut DocContext<'_>, did: DefId) {
 668     if did.is_local() {
 669         return;
 670     }
 671
 672     {
 673         if cx.external_traits.borrow().contains_key(&did) || cx.active_extern_traits.contains(&did)
 674         {
 675             return;
 676         }
 677     }
 678
 679     {
 680         cx.active_extern_traits.insert(did);
 681     }
 682
 683     debug!("record_extern_trait: {:?}", did);
 684     let trait_ = build_external_trait(cx, did);
 685
 686     let trait_ = clean::TraitWithExtraInfo {
 687         trait_,
 688         is_notable: clean::utils::has_doc_flag(cx.tcx.get_attrs(did), sym::notable_trait),
 689     };
 690     cx.external_traits.borrow_mut().insert(did, trait_);
 691     cx.active_extern_traits.remove(&did);
 692 }