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