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::Mutability;
  12 use rustc_metadata::creader::{CStore, LoadedMacro};
  13 use rustc_middle::ty::{self, TyCtxt};
  14 use rustc_span::hygiene::MacroKind;
  15 use rustc_span::symbol::{kw, sym, Symbol};
  16
  17 use crate::clean::{
  18     self, utils, Attributes, AttributesExt, GetDefId, ItemId, NestedAttributesExt, Type,
  19 };
  20 use crate::core::DocContext;
  21 use crate::formats::item_type::ItemType;
  22
  23 use super::{Clean, Visibility};
  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         // extern blocks have an empty name
 170         let s = elem.data.to_string();
 171         if !s.is_empty() { Some(s) } else { None }
 172     });
 173     let fqn = if let ItemType::Macro = kind {
 174         // Check to see if it is a macro 2.0 or built-in macro
 175         if matches!(
 176             CStore::from_tcx(cx.tcx).load_macro_untracked(did, cx.sess()),
 177             LoadedMacro::MacroDef(def, _)
 178                 if matches!(&def.kind, ast::ItemKind::MacroDef(ast_def)
 179                     if !ast_def.macro_rules)
 180         ) {
 181             once(crate_name).chain(relative).collect()
 182         } else {
 183             vec![crate_name, relative.last().expect("relative was empty")]
 184         }
 185     } else {
 186         once(crate_name).chain(relative).collect()
 187     };
 188
 189     if did.is_local() {
 190         cx.cache.exact_paths.insert(did, fqn);
 191     } else {
 192         cx.cache.external_paths.insert(did, (fqn, kind));
 193     }
 194 }
 195
 196 crate fn build_external_trait(cx: &mut DocContext<'_>, did: DefId) -> clean::Trait {
 197     let trait_items = cx
 198         .tcx
 199         .associated_items(did)
 200         .in_definition_order()
 201         .map(|item| {
 202             // When building an external trait, the cleaned trait will have all items public,
 203             // which causes methods to have a `pub` prefix, which is invalid since items in traits
 204             // can not have a visibility prefix. Thus we override the visibility here manually.
 205             // See https://github.com/rust-lang/rust/issues/81274
 206             clean::Item { visibility: Visibility::Inherited, ..item.clean(cx) }
 207         })
 208         .collect();
 209
 210     let predicates = cx.tcx.predicates_of(did);
 211     let generics = (cx.tcx.generics_of(did), predicates).clean(cx);
 212     let generics = filter_non_trait_generics(did, generics);
 213     let (generics, supertrait_bounds) = separate_supertrait_bounds(generics);
 214     let is_auto = cx.tcx.trait_is_auto(did);
 215     clean::Trait {
 216         unsafety: cx.tcx.trait_def(did).unsafety,
 217         generics,
 218         items: trait_items,
 219         bounds: supertrait_bounds,
 220         is_auto,
 221     }
 222 }
 223
 224 fn build_external_function(cx: &mut DocContext<'_>, did: DefId) -> clean::Function {
 225     let sig = cx.tcx.fn_sig(did);
 226
 227     let constness =
 228         if cx.tcx.is_const_fn_raw(did) { hir::Constness::Const } else { hir::Constness::NotConst };
 229     let asyncness = cx.tcx.asyncness(did);
 230     let predicates = cx.tcx.predicates_of(did);
 231     let (generics, decl) = clean::enter_impl_trait(cx, |cx| {
 232         ((cx.tcx.generics_of(did), predicates).clean(cx), (did, sig).clean(cx))
 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: (cx.tcx.generics_of(did), predicates).clean(cx),
 246         variants_stripped: false,
 247         variants: cx.tcx.adt_def(did).variants.clean(cx),
 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: (cx.tcx.generics_of(did), predicates).clean(cx),
 258         fields: variant.fields.clean(cx),
 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     clean::Union {
 268         generics: (cx.tcx.generics_of(did), predicates).clean(cx),
 269         fields: variant.fields.clean(cx),
 270         fields_stripped: false,
 271     }
 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: (cx.tcx.generics_of(did), predicates).clean(cx),
 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 /// Builds a specific implementation of a type. The `did` could be a type method or trait method.
 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 tcx = cx.tcx;
 341     let associated_trait = tcx.impl_trait_ref(did);
 342
 343     // Only inline impl if the implemented trait is
 344     // reachable in rustdoc generated documentation
 345     if !did.is_local() {
 346         if let Some(traitref) = associated_trait {
 347             let did = traitref.def_id;
 348             if !cx.cache.access_levels.is_public(did) {
 349                 return;
 350             }
 351
 352             if let Some(stab) = tcx.lookup_stability(did) {
 353                 if stab.level.is_unstable() && stab.feature == sym::rustc_private {
 354                     return;
 355                 }
 356             }
 357         }
 358     }
 359
 360     let impl_item = match did.as_local() {
 361         Some(did) => {
 362             let hir_id = tcx.hir().local_def_id_to_hir_id(did);
 363             match &tcx.hir().expect_item(hir_id).kind {
 364                 hir::ItemKind::Impl(impl_) => Some(impl_),
 365                 _ => panic!("`DefID` passed to `build_impl` is not an `impl"),
 366             }
 367         }
 368         None => None,
 369     };
 370
 371     let for_ = match &impl_item {
 372         Some(impl_) => impl_.self_ty.clean(cx),
 373         None => tcx.type_of(did).clean(cx),
 374     };
 375
 376     // Only inline impl if the implementing type is
 377     // reachable in rustdoc generated documentation
 378     if !did.is_local() {
 379         if let Some(did) = for_.def_id() {
 380             if !cx.cache.access_levels.is_public(did) {
 381                 return;
 382             }
 383
 384             if let Some(stab) = tcx.lookup_stability(did) {
 385                 if stab.level.is_unstable() && stab.feature == sym::rustc_private {
 386                     return;
 387                 }
 388             }
 389         }
 390     }
 391
 392     let document_hidden = cx.render_options.document_hidden;
 393     let predicates = tcx.explicit_predicates_of(did);
 394     let (trait_items, generics) = match impl_item {
 395         Some(impl_) => (
 396             impl_
 397                 .items
 398                 .iter()
 399                 .map(|item| tcx.hir().impl_item(item.id))
 400                 .filter(|item| {
 401                     // Filter out impl items whose corresponding trait item has `doc(hidden)`
 402                     // not to document such impl items.
 403                     // For inherent impls, we don't do any filtering, because that's already done in strip_hidden.rs.
 404
 405                     // When `--document-hidden-items` is passed, we don't
 406                     // do any filtering, too.
 407                     if document_hidden {
 408                         return true;
 409                     }
 410                     if let Some(associated_trait) = associated_trait {
 411                         let assoc_kind = match item.kind {
 412                             hir::ImplItemKind::Const(..) => ty::AssocKind::Const,
 413                             hir::ImplItemKind::Fn(..) => ty::AssocKind::Fn,
 414                             hir::ImplItemKind::TyAlias(..) => ty::AssocKind::Type,
 415                         };
 416                         let trait_item = tcx
 417                             .associated_items(associated_trait.def_id)
 418                             .find_by_name_and_kind(
 419                                 tcx,
 420                                 item.ident,
 421                                 assoc_kind,
 422                                 associated_trait.def_id,
 423                             )
 424                             .unwrap(); // SAFETY: For all impl items there exists trait item that has the same name.
 425                         !tcx.get_attrs(trait_item.def_id).lists(sym::doc).has_word(sym::hidden)
 426                     } else {
 427                         true
 428                     }
 429                 })
 430                 .map(|item| item.clean(cx))
 431                 .collect::<Vec<_>>(),
 432             impl_.generics.clean(cx),
 433         ),
 434         None => (
 435             tcx.associated_items(did)
 436                 .in_definition_order()
 437                 .filter_map(|item| {
 438                     if associated_trait.is_some() || item.vis == ty::Visibility::Public {
 439                         Some(item.clean(cx))
 440                     } else {
 441                         None
 442                     }
 443                 })
 444                 .collect::<Vec<_>>(),
 445             clean::enter_impl_trait(cx, |cx| (tcx.generics_of(did), predicates).clean(cx)),
 446         ),
 447     };
 448     let polarity = tcx.impl_polarity(did);
 449     let trait_ = associated_trait.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.get_attrs(did).lists(sym::doc).has_word(sym::hidden) {
 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() {
 468             if tcx.get_attrs(did).lists(sym::doc).has_word(sym::hidden) {
 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!("build_impl: impl {:?} for {:?}", trait_.as_ref().map(|t| t.def_id()), for_.def_id());
 485     ret.push(clean::Item::from_def_id_and_attrs_and_parts(
 486         did,
 487         None,
 488         clean::ImplItem(clean::Impl {
 489             span: clean::types::rustc_span(did, cx.tcx),
 490             unsafety: hir::Unsafety::Normal,
 491             generics,
 492             trait_,
 493             for_,
 494             items: trait_items,
 495             negative_polarity: polarity.clean(cx),
 496             synthetic: false,
 497             blanket_impl: None,
 498         }),
 499         box merged_attrs,
 500         cx,
 501         cfg,
 502     ));
 503 }
 504
 505 fn build_module(
 506     cx: &mut DocContext<'_>,
 507     did: DefId,
 508     visited: &mut FxHashSet<DefId>,
 509 ) -> clean::Module {
 510     let mut items = Vec::new();
 511
 512     // If we're re-exporting a re-export it may actually re-export something in
 513     // two namespaces, so the target may be listed twice. Make sure we only
 514     // visit each node at most once.
 515     for &item in cx.tcx.item_children(did).iter() {
 516         if item.vis == ty::Visibility::Public {
 517             let res = item.res.expect_non_local();
 518             if let Some(def_id) = res.mod_def_id() {
 519                 if did == def_id || !visited.insert(def_id) {
 520                     continue;
 521                 }
 522             }
 523             if let Res::PrimTy(p) = res {
 524                 // Primitive types can't be inlined so generate an import instead.
 525                 let prim_ty = clean::PrimitiveType::from(p);
 526                 items.push(clean::Item {
 527                     name: None,
 528                     attrs: box clean::Attributes::default(),
 529                     def_id: ItemId::Primitive(prim_ty, did.krate),
 530                     visibility: clean::Public,
 531                     kind: box clean::ImportItem(clean::Import::new_simple(
 532                         item.ident.name,
 533                         clean::ImportSource {
 534                             path: clean::Path {
 535                                 res,
 536                                 segments: vec![clean::PathSegment {
 537                                     name: prim_ty.as_sym(),
 538                                     args: clean::GenericArgs::AngleBracketed {
 539                                         args: Vec::new(),
 540                                         bindings: Vec::new(),
 541                                     },
 542                                 }],
 543                             },
 544                             did: None,
 545                         },
 546                         true,
 547                     )),
 548                     cfg: None,
 549                 });
 550             } else if let Some(i) = try_inline(cx, did, None, res, item.ident.name, None, visited) {
 551                 items.extend(i)
 552             }
 553         }
 554     }
 555
 556     let span = clean::Span::new(cx.tcx.def_span(did));
 557     clean::Module { items, span }
 558 }
 559
 560 crate fn print_inlined_const(tcx: TyCtxt<'_>, did: DefId) -> String {
 561     if let Some(did) = did.as_local() {
 562         let hir_id = tcx.hir().local_def_id_to_hir_id(did);
 563         rustc_hir_pretty::id_to_string(&tcx.hir(), hir_id)
 564     } else {
 565         tcx.rendered_const(did)
 566     }
 567 }
 568
 569 fn build_const(cx: &mut DocContext<'_>, def_id: DefId) -> clean::Constant {
 570     clean::Constant {
 571         type_: cx.tcx.type_of(def_id).clean(cx),
 572         kind: clean::ConstantKind::Extern { def_id },
 573     }
 574 }
 575
 576 fn build_static(cx: &mut DocContext<'_>, did: DefId, mutable: bool) -> clean::Static {
 577     clean::Static {
 578         type_: cx.tcx.type_of(did).clean(cx),
 579         mutability: if mutable { Mutability::Mut } else { Mutability::Not },
 580         expr: None,
 581     }
 582 }
 583
 584 fn build_macro(
 585     cx: &mut DocContext<'_>,
 586     def_id: DefId,
 587     name: Symbol,
 588     import_def_id: Option<DefId>,
 589 ) -> clean::ItemKind {
 590     match CStore::from_tcx(cx.tcx).load_macro_untracked(def_id, cx.sess()) {
 591         LoadedMacro::MacroDef(item_def, _) => {
 592             if let ast::ItemKind::MacroDef(ref def) = item_def.kind {
 593                 clean::MacroItem(clean::Macro {
 594                     source: utils::display_macro_source(
 595                         cx,
 596                         name,
 597                         def,
 598                         def_id,
 599                         cx.tcx.visibility(import_def_id.unwrap_or(def_id)),
 600                     ),
 601                 })
 602             } else {
 603                 unreachable!()
 604             }
 605         }
 606         LoadedMacro::ProcMacro(ext) => clean::ProcMacroItem(clean::ProcMacro {
 607             kind: ext.macro_kind(),
 608             helpers: ext.helper_attrs,
 609         }),
 610     }
 611 }
 612
 613 /// A trait's generics clause actually contains all of the predicates for all of
 614 /// its associated types as well. We specifically move these clauses to the
 615 /// associated types instead when displaying, so when we're generating the
 616 /// generics for the trait itself we need to be sure to remove them.
 617 /// We also need to remove the implied "recursive" Self: Trait bound.
 618 ///
 619 /// The inverse of this filtering logic can be found in the `Clean`
 620 /// implementation for `AssociatedType`
 621 fn filter_non_trait_generics(trait_did: DefId, mut g: clean::Generics) -> clean::Generics {
 622     for pred in &mut g.where_predicates {
 623         match *pred {
 624             clean::WherePredicate::BoundPredicate {
 625                 ty: clean::Generic(ref s),
 626                 ref mut bounds,
 627                 ..
 628             } if *s == kw::SelfUpper => {
 629                 bounds.retain(|bound| match bound {
 630                     clean::GenericBound::TraitBound(clean::PolyTrait { trait_, .. }, _) => {
 631                         trait_.def_id() != trait_did
 632                     }
 633                     _ => true,
 634                 });
 635             }
 636             _ => {}
 637         }
 638     }
 639
 640     g.where_predicates.retain(|pred| match pred {
 641         clean::WherePredicate::BoundPredicate {
 642             ty: clean::QPath { self_type: box clean::Generic(ref s), trait_, name: _, .. },
 643             bounds,
 644             ..
 645         } => !(bounds.is_empty() || *s == kw::SelfUpper && trait_.def_id() == trait_did),
 646         _ => true,
 647     });
 648     g
 649 }
 650
 651 /// Supertrait bounds for a trait are also listed in the generics coming from
 652 /// the metadata for a crate, so we want to separate those out and create a new
 653 /// list of explicit supertrait bounds to render nicely.
 654 fn separate_supertrait_bounds(
 655     mut g: clean::Generics,
 656 ) -> (clean::Generics, Vec<clean::GenericBound>) {
 657     let mut ty_bounds = Vec::new();
 658     g.where_predicates.retain(|pred| match *pred {
 659         clean::WherePredicate::BoundPredicate { ty: clean::Generic(ref s), ref bounds, .. }
 660             if *s == kw::SelfUpper =>
 661         {
 662             ty_bounds.extend(bounds.iter().cloned());
 663             false
 664         }
 665         _ => true,
 666     });
 667     (g, ty_bounds)
 668 }
 669
 670 crate fn record_extern_trait(cx: &mut DocContext<'_>, did: DefId) {
 671     if did.is_local() {
 672         return;
 673     }
 674
 675     {
 676         if cx.external_traits.borrow().contains_key(&did) || cx.active_extern_traits.contains(&did)
 677         {
 678             return;
 679         }
 680     }
 681
 682     {
 683         cx.active_extern_traits.insert(did);
 684     }
 685
 686     debug!("record_extern_trait: {:?}", did);
 687     let trait_ = build_external_trait(cx, did);
 688
 689     let trait_ = clean::TraitWithExtraInfo {
 690         trait_,
 691         is_notable: clean::utils::has_doc_flag(cx.tcx.get_attrs(did), sym::notable_trait),
 692     };
 693     cx.external_traits.borrow_mut().insert(did, trait_);
 694     cx.active_extern_traits.remove(&did);
 695 }