src/librustdoc/clean/mod.rs

   1 //! This module contains the "cleaned" pieces of the AST, and the functions
   2 //! that clean them.
   3
   4 mod auto_trait;
   5 mod blanket_impl;
   6 pub(crate) mod cfg;
   7 pub(crate) mod inline;
   8 mod render_macro_matchers;
   9 mod simplify;
  10 pub(crate) mod types;
  11 pub(crate) mod utils;
  12
  13 use rustc_ast as ast;
  14 use rustc_attr as attr;
  15 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
  16 use rustc_hir as hir;
  17 use rustc_hir::def::{CtorKind, DefKind, Res};
  18 use rustc_hir::def_id::{DefId, LOCAL_CRATE};
  19 use rustc_hir::PredicateOrigin;
  20 use rustc_infer::infer::region_constraints::{Constraint, RegionConstraintData};
  21 use rustc_middle::middle::resolve_lifetime as rl;
  22 use rustc_middle::ty::fold::TypeFolder;
  23 use rustc_middle::ty::subst::{InternalSubsts, Subst};
  24 use rustc_middle::ty::{self, AdtKind, DefIdTree, EarlyBinder, Lift, Ty, TyCtxt};
  25 use rustc_middle::{bug, span_bug};
  26 use rustc_span::hygiene::{AstPass, MacroKind};
  27 use rustc_span::symbol::{kw, sym, Ident, Symbol};
  28 use rustc_span::{self, ExpnKind};
  29 use rustc_typeck::hir_ty_to_ty;
  30
  31 use std::assert_matches::assert_matches;
  32 use std::collections::hash_map::Entry;
  33 use std::collections::BTreeMap;
  34 use std::default::Default;
  35 use std::hash::Hash;
  36 use std::mem;
  37 use thin_vec::ThinVec;
  38
  39 use crate::core::{self, DocContext, ImplTraitParam};
  40 use crate::formats::item_type::ItemType;
  41 use crate::visit_ast::Module as DocModule;
  42
  43 use utils::*;
  44
  45 pub(crate) use self::types::*;
  46 pub(crate) use self::utils::{get_auto_trait_and_blanket_impls, krate, register_res};
  47
  48 pub(crate) fn clean_doc_module<'tcx>(doc: &DocModule<'tcx>, cx: &mut DocContext<'tcx>) -> Item {
  49     let mut items: Vec<Item> = vec![];
  50     let mut inserted = FxHashSet::default();
  51     items.extend(doc.foreigns.iter().map(|(item, renamed)| {
  52         let item = clean_maybe_renamed_foreign_item(cx, item, *renamed);
  53         if let Some(name) = item.name {
  54             inserted.insert((item.type_(), name));
  55         }
  56         item
  57     }));
  58     items.extend(doc.mods.iter().map(|x| {
  59         inserted.insert((ItemType::Module, x.name));
  60         clean_doc_module(x, cx)
  61     }));
  62
  63     // Split up imports from all other items.
  64     //
  65     // This covers the case where somebody does an import which should pull in an item,
  66     // but there's already an item with the same namespace and same name. Rust gives
  67     // priority to the not-imported one, so we should, too.
  68     items.extend(doc.items.iter().flat_map(|(item, renamed)| {
  69         // First, lower everything other than imports.
  70         if matches!(item.kind, hir::ItemKind::Use(_, hir::UseKind::Glob)) {
  71             return Vec::new();
  72         }
  73         let v = clean_maybe_renamed_item(cx, item, *renamed);
  74         for item in &v {
  75             if let Some(name) = item.name {
  76                 inserted.insert((item.type_(), name));
  77             }
  78         }
  79         v
  80     }));
  81     items.extend(doc.items.iter().flat_map(|(item, renamed)| {
  82         // Now we actually lower the imports, skipping everything else.
  83         if let hir::ItemKind::Use(path, hir::UseKind::Glob) = item.kind {
  84             let name = renamed.unwrap_or_else(|| cx.tcx.hir().name(item.hir_id()));
  85             clean_use_statement(item, name, path, hir::UseKind::Glob, cx, &mut inserted)
  86         } else {
  87             // skip everything else
  88             Vec::new()
  89         }
  90     }));
  91
  92     // determine if we should display the inner contents or
  93     // the outer `mod` item for the source code.
  94
  95     let span = Span::new({
  96         let where_outer = doc.where_outer(cx.tcx);
  97         let sm = cx.sess().source_map();
  98         let outer = sm.lookup_char_pos(where_outer.lo());
  99         let inner = sm.lookup_char_pos(doc.where_inner.lo());
 100         if outer.file.start_pos == inner.file.start_pos {
 101             // mod foo { ... }
 102             where_outer
 103         } else {
 104             // mod foo; (and a separate SourceFile for the contents)
 105             doc.where_inner
 106         }
 107     });
 108
 109     Item::from_hir_id_and_parts(doc.id, Some(doc.name), ModuleItem(Module { items, span }), cx)
 110 }
 111
 112 fn clean_generic_bound<'tcx>(
 113     bound: &hir::GenericBound<'tcx>,
 114     cx: &mut DocContext<'tcx>,
 115 ) -> Option<GenericBound> {
 116     Some(match *bound {
 117         hir::GenericBound::Outlives(lt) => GenericBound::Outlives(clean_lifetime(lt, cx)),
 118         hir::GenericBound::LangItemTrait(lang_item, span, _, generic_args) => {
 119             let def_id = cx.tcx.require_lang_item(lang_item, Some(span));
 120
 121             let trait_ref = ty::TraitRef::identity(cx.tcx, def_id).skip_binder();
 122
 123             let generic_args = clean_generic_args(generic_args, cx);
 124             let GenericArgs::AngleBracketed { bindings, .. } = generic_args
 125             else {
 126                 bug!("clean: parenthesized `GenericBound::LangItemTrait`");
 127             };
 128
 129             let trait_ = clean_trait_ref_with_bindings(cx, trait_ref, bindings);
 130             GenericBound::TraitBound(
 131                 PolyTrait { trait_, generic_params: vec![] },
 132                 hir::TraitBoundModifier::None,
 133             )
 134         }
 135         hir::GenericBound::Trait(ref t, modifier) => {
 136             // `T: ~const Destruct` is hidden because `T: Destruct` is a no-op.
 137             if modifier == hir::TraitBoundModifier::MaybeConst
 138                 && cx.tcx.lang_items().destruct_trait() == Some(t.trait_ref.trait_def_id().unwrap())
 139             {
 140                 return None;
 141             }
 142
 143             GenericBound::TraitBound(clean_poly_trait_ref(t, cx), modifier)
 144         }
 145     })
 146 }
 147
 148 pub(crate) fn clean_trait_ref_with_bindings<'tcx>(
 149     cx: &mut DocContext<'tcx>,
 150     trait_ref: ty::TraitRef<'tcx>,
 151     bindings: ThinVec<TypeBinding>,
 152 ) -> Path {
 153     let kind = cx.tcx.def_kind(trait_ref.def_id).into();
 154     if !matches!(kind, ItemType::Trait | ItemType::TraitAlias) {
 155         span_bug!(cx.tcx.def_span(trait_ref.def_id), "`TraitRef` had unexpected kind {:?}", kind);
 156     }
 157     inline::record_extern_fqn(cx, trait_ref.def_id, kind);
 158     let path = external_path(cx, trait_ref.def_id, true, bindings, trait_ref.substs);
 159
 160     debug!("ty::TraitRef\n  subst: {:?}\n", trait_ref.substs);
 161
 162     path
 163 }
 164
 165 fn clean_poly_trait_ref_with_bindings<'tcx>(
 166     cx: &mut DocContext<'tcx>,
 167     poly_trait_ref: ty::PolyTraitRef<'tcx>,
 168     bindings: ThinVec<TypeBinding>,
 169 ) -> GenericBound {
 170     let poly_trait_ref = poly_trait_ref.lift_to_tcx(cx.tcx).unwrap();
 171
 172     // collect any late bound regions
 173     let late_bound_regions: Vec<_> = cx
 174         .tcx
 175         .collect_referenced_late_bound_regions(&poly_trait_ref)
 176         .into_iter()
 177         .filter_map(|br| match br {
 178             ty::BrNamed(_, name) if name != kw::UnderscoreLifetime => Some(GenericParamDef {
 179                 name,
 180                 kind: GenericParamDefKind::Lifetime { outlives: vec![] },
 181             }),
 182             _ => None,
 183         })
 184         .collect();
 185
 186     let trait_ = clean_trait_ref_with_bindings(cx, poly_trait_ref.skip_binder(), bindings);
 187     GenericBound::TraitBound(
 188         PolyTrait { trait_, generic_params: late_bound_regions },
 189         hir::TraitBoundModifier::None,
 190     )
 191 }
 192
 193 fn clean_lifetime<'tcx>(lifetime: hir::Lifetime, cx: &mut DocContext<'tcx>) -> Lifetime {
 194     let def = cx.tcx.named_region(lifetime.hir_id);
 195     if let Some(
 196         rl::Region::EarlyBound(node_id)
 197         | rl::Region::LateBound(_, _, node_id)
 198         | rl::Region::Free(_, node_id),
 199     ) = def
 200     {
 201         if let Some(lt) = cx.substs.get(&node_id).and_then(|p| p.as_lt()).cloned() {
 202             return lt;
 203         }
 204     }
 205     Lifetime(lifetime.name.ident().name)
 206 }
 207
 208 pub(crate) fn clean_const<'tcx>(constant: &hir::ConstArg, cx: &mut DocContext<'tcx>) -> Constant {
 209     let def_id = cx.tcx.hir().body_owner_def_id(constant.value.body).to_def_id();
 210     Constant {
 211         type_: clean_middle_ty(cx.tcx.type_of(def_id), cx, Some(def_id)),
 212         kind: ConstantKind::Anonymous { body: constant.value.body },
 213     }
 214 }
 215
 216 pub(crate) fn clean_middle_const<'tcx>(
 217     constant: ty::Const<'tcx>,
 218     cx: &mut DocContext<'tcx>,
 219 ) -> Constant {
 220     // FIXME: instead of storing the stringified expression, store `self` directly instead.
 221     Constant {
 222         type_: clean_middle_ty(constant.ty(), cx, None),
 223         kind: ConstantKind::TyConst { expr: constant.to_string() },
 224     }
 225 }
 226
 227 pub(crate) fn clean_middle_region<'tcx>(region: ty::Region<'tcx>) -> Option<Lifetime> {
 228     match *region {
 229         ty::ReStatic => Some(Lifetime::statik()),
 230         ty::ReLateBound(_, ty::BoundRegion { kind: ty::BrNamed(_, name), .. }) => {
 231             if name != kw::UnderscoreLifetime { Some(Lifetime(name)) } else { None }
 232         }
 233         ty::ReEarlyBound(ref data) => {
 234             if data.name != kw::UnderscoreLifetime {
 235                 Some(Lifetime(data.name))
 236             } else {
 237                 None
 238             }
 239         }
 240         ty::ReLateBound(..)
 241         | ty::ReFree(..)
 242         | ty::ReVar(..)
 243         | ty::RePlaceholder(..)
 244         | ty::ReEmpty(_)
 245         | ty::ReErased => {
 246             debug!("cannot clean region {:?}", region);
 247             None
 248         }
 249     }
 250 }
 251
 252 fn clean_where_predicate<'tcx>(
 253     predicate: &hir::WherePredicate<'tcx>,
 254     cx: &mut DocContext<'tcx>,
 255 ) -> Option<WherePredicate> {
 256     if !predicate.in_where_clause() {
 257         return None;
 258     }
 259     Some(match *predicate {
 260         hir::WherePredicate::BoundPredicate(ref wbp) => {
 261             let bound_params = wbp
 262                 .bound_generic_params
 263                 .iter()
 264                 .map(|param| {
 265                     // Higher-ranked params must be lifetimes.
 266                     // Higher-ranked lifetimes can't have bounds.
 267                     assert_matches!(
 268                         param,
 269                         hir::GenericParam { kind: hir::GenericParamKind::Lifetime { .. }, .. }
 270                     );
 271                     Lifetime(param.name.ident().name)
 272                 })
 273                 .collect();
 274             WherePredicate::BoundPredicate {
 275                 ty: clean_ty(wbp.bounded_ty, cx),
 276                 bounds: wbp.bounds.iter().filter_map(|x| clean_generic_bound(x, cx)).collect(),
 277                 bound_params,
 278             }
 279         }
 280
 281         hir::WherePredicate::RegionPredicate(ref wrp) => WherePredicate::RegionPredicate {
 282             lifetime: clean_lifetime(wrp.lifetime, cx),
 283             bounds: wrp.bounds.iter().filter_map(|x| clean_generic_bound(x, cx)).collect(),
 284         },
 285
 286         hir::WherePredicate::EqPredicate(ref wrp) => WherePredicate::EqPredicate {
 287             lhs: clean_ty(wrp.lhs_ty, cx),
 288             rhs: clean_ty(wrp.rhs_ty, cx).into(),
 289         },
 290     })
 291 }
 292
 293 pub(crate) fn clean_predicate<'tcx>(
 294     predicate: ty::Predicate<'tcx>,
 295     cx: &mut DocContext<'tcx>,
 296 ) -> Option<WherePredicate> {
 297     let bound_predicate = predicate.kind();
 298     match bound_predicate.skip_binder() {
 299         ty::PredicateKind::Trait(pred) => {
 300             clean_poly_trait_predicate(bound_predicate.rebind(pred), cx)
 301         }
 302         ty::PredicateKind::RegionOutlives(pred) => clean_region_outlives_predicate(pred),
 303         ty::PredicateKind::TypeOutlives(pred) => clean_type_outlives_predicate(pred, cx),
 304         ty::PredicateKind::Projection(pred) => Some(clean_projection_predicate(pred, cx)),
 305         ty::PredicateKind::ConstEvaluatable(..) => None,
 306         ty::PredicateKind::WellFormed(..) => None,
 307
 308         ty::PredicateKind::Subtype(..)
 309         | ty::PredicateKind::Coerce(..)
 310         | ty::PredicateKind::ObjectSafe(..)
 311         | ty::PredicateKind::ClosureKind(..)
 312         | ty::PredicateKind::ConstEquate(..)
 313         | ty::PredicateKind::TypeWellFormedFromEnv(..) => panic!("not user writable"),
 314     }
 315 }
 316
 317 fn clean_poly_trait_predicate<'tcx>(
 318     pred: ty::PolyTraitPredicate<'tcx>,
 319     cx: &mut DocContext<'tcx>,
 320 ) -> Option<WherePredicate> {
 321     // `T: ~const Destruct` is hidden because `T: Destruct` is a no-op.
 322     if pred.skip_binder().constness == ty::BoundConstness::ConstIfConst
 323         && Some(pred.skip_binder().def_id()) == cx.tcx.lang_items().destruct_trait()
 324     {
 325         return None;
 326     }
 327
 328     let poly_trait_ref = pred.map_bound(|pred| pred.trait_ref);
 329     Some(WherePredicate::BoundPredicate {
 330         ty: clean_middle_ty(poly_trait_ref.skip_binder().self_ty(), cx, None),
 331         bounds: vec![clean_poly_trait_ref_with_bindings(cx, poly_trait_ref, ThinVec::new())],
 332         bound_params: Vec::new(),
 333     })
 334 }
 335
 336 fn clean_region_outlives_predicate<'tcx>(
 337     pred: ty::OutlivesPredicate<ty::Region<'tcx>, ty::Region<'tcx>>,
 338 ) -> Option<WherePredicate> {
 339     let ty::OutlivesPredicate(a, b) = pred;
 340
 341     if a.is_empty() && b.is_empty() {
 342         return None;
 343     }
 344
 345     Some(WherePredicate::RegionPredicate {
 346         lifetime: clean_middle_region(a).expect("failed to clean lifetime"),
 347         bounds: vec![GenericBound::Outlives(
 348             clean_middle_region(b).expect("failed to clean bounds"),
 349         )],
 350     })
 351 }
 352
 353 fn clean_type_outlives_predicate<'tcx>(
 354     pred: ty::OutlivesPredicate<Ty<'tcx>, ty::Region<'tcx>>,
 355     cx: &mut DocContext<'tcx>,
 356 ) -> Option<WherePredicate> {
 357     let ty::OutlivesPredicate(ty, lt) = pred;
 358
 359     if lt.is_empty() {
 360         return None;
 361     }
 362
 363     Some(WherePredicate::BoundPredicate {
 364         ty: clean_middle_ty(ty, cx, None),
 365         bounds: vec![GenericBound::Outlives(
 366             clean_middle_region(lt).expect("failed to clean lifetimes"),
 367         )],
 368         bound_params: Vec::new(),
 369     })
 370 }
 371
 372 fn clean_middle_term<'tcx>(term: ty::Term<'tcx>, cx: &mut DocContext<'tcx>) -> Term {
 373     match term {
 374         ty::Term::Ty(ty) => Term::Type(clean_middle_ty(ty, cx, None)),
 375         ty::Term::Const(c) => Term::Constant(clean_middle_const(c, cx)),
 376     }
 377 }
 378
 379 fn clean_hir_term<'tcx>(term: &hir::Term<'tcx>, cx: &mut DocContext<'tcx>) -> Term {
 380     match term {
 381         hir::Term::Ty(ty) => Term::Type(clean_ty(ty, cx)),
 382         hir::Term::Const(c) => {
 383             let def_id = cx.tcx.hir().local_def_id(c.hir_id);
 384             Term::Constant(clean_middle_const(ty::Const::from_anon_const(cx.tcx, def_id), cx))
 385         }
 386     }
 387 }
 388
 389 fn clean_projection_predicate<'tcx>(
 390     pred: ty::ProjectionPredicate<'tcx>,
 391     cx: &mut DocContext<'tcx>,
 392 ) -> WherePredicate {
 393     let ty::ProjectionPredicate { projection_ty, term } = pred;
 394     WherePredicate::EqPredicate {
 395         lhs: clean_projection(projection_ty, cx, None),
 396         rhs: clean_middle_term(term, cx),
 397     }
 398 }
 399
 400 fn clean_projection<'tcx>(
 401     ty: ty::ProjectionTy<'tcx>,
 402     cx: &mut DocContext<'tcx>,
 403     def_id: Option<DefId>,
 404 ) -> Type {
 405     let lifted = ty.lift_to_tcx(cx.tcx).unwrap();
 406     let trait_ = clean_trait_ref_with_bindings(cx, lifted.trait_ref(cx.tcx), ThinVec::new());
 407     let self_type = clean_middle_ty(ty.self_ty(), cx, None);
 408     let self_def_id = if let Some(def_id) = def_id {
 409         cx.tcx.opt_parent(def_id).or(Some(def_id))
 410     } else {
 411         self_type.def_id(&cx.cache)
 412     };
 413     let should_show_cast = compute_should_show_cast(self_def_id, &trait_, &self_type);
 414     Type::QPath(Box::new(QPathData {
 415         assoc: projection_to_path_segment(ty, cx),
 416         should_show_cast,
 417         self_type,
 418         trait_,
 419     }))
 420 }
 421
 422 fn compute_should_show_cast(self_def_id: Option<DefId>, trait_: &Path, self_type: &Type) -> bool {
 423     !trait_.segments.is_empty()
 424         && self_def_id
 425             .zip(Some(trait_.def_id()))
 426             .map_or(!self_type.is_self_type(), |(id, trait_)| id != trait_)
 427 }
 428
 429 fn projection_to_path_segment<'tcx>(
 430     ty: ty::ProjectionTy<'tcx>,
 431     cx: &mut DocContext<'tcx>,
 432 ) -> PathSegment {
 433     let item = cx.tcx.associated_item(ty.item_def_id);
 434     let generics = cx.tcx.generics_of(ty.item_def_id);
 435     PathSegment {
 436         name: item.name,
 437         args: GenericArgs::AngleBracketed {
 438             args: substs_to_args(cx, &ty.substs[generics.parent_count..], false).into(),
 439             bindings: Default::default(),
 440         },
 441     }
 442 }
 443
 444 fn clean_generic_param_def<'tcx>(
 445     def: &ty::GenericParamDef,
 446     cx: &mut DocContext<'tcx>,
 447 ) -> GenericParamDef {
 448     let (name, kind) = match def.kind {
 449         ty::GenericParamDefKind::Lifetime => {
 450             (def.name, GenericParamDefKind::Lifetime { outlives: vec![] })
 451         }
 452         ty::GenericParamDefKind::Type { has_default, synthetic, .. } => {
 453             let default = if has_default {
 454                 Some(clean_middle_ty(cx.tcx.type_of(def.def_id), cx, Some(def.def_id)))
 455             } else {
 456                 None
 457             };
 458             (
 459                 def.name,
 460                 GenericParamDefKind::Type {
 461                     did: def.def_id,
 462                     bounds: vec![], // These are filled in from the where-clauses.
 463                     default: default.map(Box::new),
 464                     synthetic,
 465                 },
 466             )
 467         }
 468         ty::GenericParamDefKind::Const { has_default } => (
 469             def.name,
 470             GenericParamDefKind::Const {
 471                 did: def.def_id,
 472                 ty: Box::new(clean_middle_ty(cx.tcx.type_of(def.def_id), cx, Some(def.def_id))),
 473                 default: match has_default {
 474                     true => Some(Box::new(cx.tcx.const_param_default(def.def_id).to_string())),
 475                     false => None,
 476                 },
 477             },
 478         ),
 479     };
 480
 481     GenericParamDef { name, kind }
 482 }
 483
 484 fn clean_generic_param<'tcx>(
 485     cx: &mut DocContext<'tcx>,
 486     generics: Option<&hir::Generics<'tcx>>,
 487     param: &hir::GenericParam<'tcx>,
 488 ) -> GenericParamDef {
 489     let did = cx.tcx.hir().local_def_id(param.hir_id);
 490     let (name, kind) = match param.kind {
 491         hir::GenericParamKind::Lifetime { .. } => {
 492             let outlives = if let Some(generics) = generics {
 493                 generics
 494                     .outlives_for_param(did)
 495                     .filter(|bp| !bp.in_where_clause)
 496                     .flat_map(|bp| bp.bounds)
 497                     .map(|bound| match bound {
 498                         hir::GenericBound::Outlives(lt) => clean_lifetime(*lt, cx),
 499                         _ => panic!(),
 500                     })
 501                     .collect()
 502             } else {
 503                 Vec::new()
 504             };
 505             (param.name.ident().name, GenericParamDefKind::Lifetime { outlives })
 506         }
 507         hir::GenericParamKind::Type { ref default, synthetic } => {
 508             let bounds = if let Some(generics) = generics {
 509                 generics
 510                     .bounds_for_param(did)
 511                     .filter(|bp| bp.origin != PredicateOrigin::WhereClause)
 512                     .flat_map(|bp| bp.bounds)
 513                     .filter_map(|x| clean_generic_bound(x, cx))
 514                     .collect()
 515             } else {
 516                 Vec::new()
 517             };
 518             (
 519                 param.name.ident().name,
 520                 GenericParamDefKind::Type {
 521                     did: did.to_def_id(),
 522                     bounds,
 523                     default: default.map(|t| clean_ty(t, cx)).map(Box::new),
 524                     synthetic,
 525                 },
 526             )
 527         }
 528         hir::GenericParamKind::Const { ty, default } => (
 529             param.name.ident().name,
 530             GenericParamDefKind::Const {
 531                 did: did.to_def_id(),
 532                 ty: Box::new(clean_ty(ty, cx)),
 533                 default: default.map(|ct| {
 534                     let def_id = cx.tcx.hir().local_def_id(ct.hir_id);
 535                     Box::new(ty::Const::from_anon_const(cx.tcx, def_id).to_string())
 536                 }),
 537             },
 538         ),
 539     };
 540
 541     GenericParamDef { name, kind }
 542 }
 543
 544 /// Synthetic type-parameters are inserted after normal ones.
 545 /// In order for normal parameters to be able to refer to synthetic ones,
 546 /// scans them first.
 547 fn is_impl_trait(param: &hir::GenericParam<'_>) -> bool {
 548     match param.kind {
 549         hir::GenericParamKind::Type { synthetic, .. } => synthetic,
 550         _ => false,
 551     }
 552 }
 553
 554 /// This can happen for `async fn`, e.g. `async fn f<'_>(&'_ self)`.
 555 ///
 556 /// See `lifetime_to_generic_param` in `rustc_ast_lowering` for more information.
 557 fn is_elided_lifetime(param: &hir::GenericParam<'_>) -> bool {
 558     matches!(param.kind, hir::GenericParamKind::Lifetime { kind: hir::LifetimeParamKind::Elided })
 559 }
 560
 561 pub(crate) fn clean_generics<'tcx>(
 562     gens: &hir::Generics<'tcx>,
 563     cx: &mut DocContext<'tcx>,
 564 ) -> Generics {
 565     let impl_trait_params = gens
 566         .params
 567         .iter()
 568         .filter(|param| is_impl_trait(param))
 569         .map(|param| {
 570             let param = clean_generic_param(cx, Some(gens), param);
 571             match param.kind {
 572                 GenericParamDefKind::Lifetime { .. } => unreachable!(),
 573                 GenericParamDefKind::Type { did, ref bounds, .. } => {
 574                     cx.impl_trait_bounds.insert(did.into(), bounds.clone());
 575                 }
 576                 GenericParamDefKind::Const { .. } => unreachable!(),
 577             }
 578             param
 579         })
 580         .collect::<Vec<_>>();
 581
 582     let mut params = Vec::with_capacity(gens.params.len());
 583     for p in gens.params.iter().filter(|p| !is_impl_trait(p) && !is_elided_lifetime(p)) {
 584         let p = clean_generic_param(cx, Some(gens), p);
 585         params.push(p);
 586     }
 587     params.extend(impl_trait_params);
 588
 589     let mut generics = Generics {
 590         params,
 591         where_predicates: gens
 592             .predicates
 593             .iter()
 594             .filter_map(|x| clean_where_predicate(x, cx))
 595             .collect(),
 596     };
 597
 598     // Some duplicates are generated for ?Sized bounds between type params and where
 599     // predicates. The point in here is to move the bounds definitions from type params
 600     // to where predicates when such cases occur.
 601     for where_pred in &mut generics.where_predicates {
 602         match *where_pred {
 603             WherePredicate::BoundPredicate { ty: Generic(ref name), ref mut bounds, .. } => {
 604                 if bounds.is_empty() {
 605                     for param in &mut generics.params {
 606                         match param.kind {
 607                             GenericParamDefKind::Lifetime { .. } => {}
 608                             GenericParamDefKind::Type { bounds: ref mut ty_bounds, .. } => {
 609                                 if &param.name == name {
 610                                     mem::swap(bounds, ty_bounds);
 611                                     break;
 612                                 }
 613                             }
 614                             GenericParamDefKind::Const { .. } => {}
 615                         }
 616                     }
 617                 }
 618             }
 619             _ => continue,
 620         }
 621     }
 622     generics
 623 }
 624
 625 fn clean_ty_generics<'tcx>(
 626     cx: &mut DocContext<'tcx>,
 627     gens: &ty::Generics,
 628     preds: ty::GenericPredicates<'tcx>,
 629 ) -> Generics {
 630     // Don't populate `cx.impl_trait_bounds` before `clean`ning `where` clauses,
 631     // since `Clean for ty::Predicate` would consume them.
 632     let mut impl_trait = BTreeMap::<ImplTraitParam, Vec<GenericBound>>::default();
 633
 634     // Bounds in the type_params and lifetimes fields are repeated in the
 635     // predicates field (see rustc_typeck::collect::ty_generics), so remove
 636     // them.
 637     let stripped_params = gens
 638         .params
 639         .iter()
 640         .filter_map(|param| match param.kind {
 641             ty::GenericParamDefKind::Lifetime if param.name == kw::UnderscoreLifetime => None,
 642             ty::GenericParamDefKind::Lifetime => Some(clean_generic_param_def(param, cx)),
 643             ty::GenericParamDefKind::Type { synthetic, .. } => {
 644                 if param.name == kw::SelfUpper {
 645                     assert_eq!(param.index, 0);
 646                     return None;
 647                 }
 648                 if synthetic {
 649                     impl_trait.insert(param.index.into(), vec![]);
 650                     return None;
 651                 }
 652                 Some(clean_generic_param_def(param, cx))
 653             }
 654             ty::GenericParamDefKind::Const { .. } => Some(clean_generic_param_def(param, cx)),
 655         })
 656         .collect::<Vec<GenericParamDef>>();
 657
 658     // param index -> [(DefId of trait, associated type name and generics, type)]
 659     let mut impl_trait_proj = FxHashMap::<u32, Vec<(DefId, PathSegment, Ty<'_>)>>::default();
 660
 661     let where_predicates = preds
 662         .predicates
 663         .iter()
 664         .flat_map(|(p, _)| {
 665             let mut projection = None;
 666             let param_idx = (|| {
 667                 let bound_p = p.kind();
 668                 match bound_p.skip_binder() {
 669                     ty::PredicateKind::Trait(pred) => {
 670                         if let ty::Param(param) = pred.self_ty().kind() {
 671                             return Some(param.index);
 672                         }
 673                     }
 674                     ty::PredicateKind::TypeOutlives(ty::OutlivesPredicate(ty, _reg)) => {
 675                         if let ty::Param(param) = ty.kind() {
 676                             return Some(param.index);
 677                         }
 678                     }
 679                     ty::PredicateKind::Projection(p) => {
 680                         if let ty::Param(param) = p.projection_ty.self_ty().kind() {
 681                             projection = Some(bound_p.rebind(p));
 682                             return Some(param.index);
 683                         }
 684                     }
 685                     _ => (),
 686                 }
 687
 688                 None
 689             })();
 690
 691             if let Some(param_idx) = param_idx {
 692                 if let Some(b) = impl_trait.get_mut(&param_idx.into()) {
 693                     let p: WherePredicate = clean_predicate(*p, cx)?;
 694
 695                     b.extend(
 696                         p.get_bounds()
 697                             .into_iter()
 698                             .flatten()
 699                             .cloned()
 700                             .filter(|b| !b.is_sized_bound(cx)),
 701                     );
 702
 703                     let proj = projection.map(|p| {
 704                         (
 705                             clean_projection(p.skip_binder().projection_ty, cx, None),
 706                             p.skip_binder().term,
 707                         )
 708                     });
 709                     if let Some(((_, trait_did, name), rhs)) = proj
 710                         .as_ref()
 711                         .and_then(|(lhs, rhs): &(Type, _)| Some((lhs.projection()?, rhs)))
 712                     {
 713                         // FIXME(...): Remove this unwrap()
 714                         impl_trait_proj.entry(param_idx).or_default().push((
 715                             trait_did,
 716                             name,
 717                             rhs.ty().unwrap(),
 718                         ));
 719                     }
 720
 721                     return None;
 722                 }
 723             }
 724
 725             Some(p)
 726         })
 727         .collect::<Vec<_>>();
 728
 729     for (param, mut bounds) in impl_trait {
 730         // Move trait bounds to the front.
 731         bounds.sort_by_key(|b| !matches!(b, GenericBound::TraitBound(..)));
 732
 733         if let crate::core::ImplTraitParam::ParamIndex(idx) = param {
 734             if let Some(proj) = impl_trait_proj.remove(&idx) {
 735                 for (trait_did, name, rhs) in proj {
 736                     let rhs = clean_middle_ty(rhs, cx, None);
 737                     simplify::merge_bounds(cx, &mut bounds, trait_did, name, &Term::Type(rhs));
 738                 }
 739             }
 740         } else {
 741             unreachable!();
 742         }
 743
 744         cx.impl_trait_bounds.insert(param, bounds);
 745     }
 746
 747     // Now that `cx.impl_trait_bounds` is populated, we can process
 748     // remaining predicates which could contain `impl Trait`.
 749     let mut where_predicates =
 750         where_predicates.into_iter().flat_map(|p| clean_predicate(*p, cx)).collect::<Vec<_>>();
 751
 752     // Type parameters have a Sized bound by default unless removed with
 753     // ?Sized. Scan through the predicates and mark any type parameter with
 754     // a Sized bound, removing the bounds as we find them.
 755     //
 756     // Note that associated types also have a sized bound by default, but we
 757     // don't actually know the set of associated types right here so that's
 758     // handled in cleaning associated types
 759     let mut sized_params = FxHashSet::default();
 760     where_predicates.retain(|pred| match *pred {
 761         WherePredicate::BoundPredicate { ty: Generic(ref g), ref bounds, .. } => {
 762             if bounds.iter().any(|b| b.is_sized_bound(cx)) {
 763                 sized_params.insert(*g);
 764                 false
 765             } else {
 766                 true
 767             }
 768         }
 769         _ => true,
 770     });
 771
 772     // Run through the type parameters again and insert a ?Sized
 773     // unbound for any we didn't find to be Sized.
 774     for tp in &stripped_params {
 775         if matches!(tp.kind, types::GenericParamDefKind::Type { .. })
 776             && !sized_params.contains(&tp.name)
 777         {
 778             where_predicates.push(WherePredicate::BoundPredicate {
 779                 ty: Type::Generic(tp.name),
 780                 bounds: vec![GenericBound::maybe_sized(cx)],
 781                 bound_params: Vec::new(),
 782             })
 783         }
 784     }
 785
 786     // It would be nice to collect all of the bounds on a type and recombine
 787     // them if possible, to avoid e.g., `where T: Foo, T: Bar, T: Sized, T: 'a`
 788     // and instead see `where T: Foo + Bar + Sized + 'a`
 789
 790     Generics {
 791         params: stripped_params,
 792         where_predicates: simplify::where_clauses(cx, where_predicates),
 793     }
 794 }
 795
 796 fn clean_fn_or_proc_macro<'tcx>(
 797     item: &hir::Item<'tcx>,
 798     sig: &hir::FnSig<'tcx>,
 799     generics: &hir::Generics<'tcx>,
 800     body_id: hir::BodyId,
 801     name: &mut Symbol,
 802     cx: &mut DocContext<'tcx>,
 803 ) -> ItemKind {
 804     let attrs = cx.tcx.hir().attrs(item.hir_id());
 805     let macro_kind = attrs.iter().find_map(|a| {
 806         if a.has_name(sym::proc_macro) {
 807             Some(MacroKind::Bang)
 808         } else if a.has_name(sym::proc_macro_derive) {
 809             Some(MacroKind::Derive)
 810         } else if a.has_name(sym::proc_macro_attribute) {
 811             Some(MacroKind::Attr)
 812         } else {
 813             None
 814         }
 815     });
 816     match macro_kind {
 817         Some(kind) => {
 818             if kind == MacroKind::Derive {
 819                 *name = attrs
 820                     .lists(sym::proc_macro_derive)
 821                     .find_map(|mi| mi.ident())
 822                     .expect("proc-macro derives require a name")
 823                     .name;
 824             }
 825
 826             let mut helpers = Vec::new();
 827             for mi in attrs.lists(sym::proc_macro_derive) {
 828                 if !mi.has_name(sym::attributes) {
 829                     continue;
 830                 }
 831
 832                 if let Some(list) = mi.meta_item_list() {
 833                     for inner_mi in list {
 834                         if let Some(ident) = inner_mi.ident() {
 835                             helpers.push(ident.name);
 836                         }
 837                     }
 838                 }
 839             }
 840             ProcMacroItem(ProcMacro { kind, helpers })
 841         }
 842         None => {
 843             let mut func = clean_function(cx, sig, generics, body_id);
 844             clean_fn_decl_legacy_const_generics(&mut func, attrs);
 845             FunctionItem(func)
 846         }
 847     }
 848 }
 849
 850 /// This is needed to make it more "readable" when documenting functions using
 851 /// `rustc_legacy_const_generics`. More information in
 852 /// <https://github.com/rust-lang/rust/issues/83167>.
 853 fn clean_fn_decl_legacy_const_generics(func: &mut Function, attrs: &[ast::Attribute]) {
 854     for meta_item_list in attrs
 855         .iter()
 856         .filter(|a| a.has_name(sym::rustc_legacy_const_generics))
 857         .filter_map(|a| a.meta_item_list())
 858     {
 859         for (pos, literal) in meta_item_list.iter().filter_map(|meta| meta.literal()).enumerate() {
 860             match literal.kind {
 861                 ast::LitKind::Int(a, _) => {
 862                     let gen = func.generics.params.remove(0);
 863                     if let GenericParamDef { name, kind: GenericParamDefKind::Const { ty, .. } } =
 864                         gen
 865                     {
 866                         func.decl
 867                             .inputs
 868                             .values
 869                             .insert(a as _, Argument { name, type_: *ty, is_const: true });
 870                     } else {
 871                         panic!("unexpected non const in position {pos}");
 872                     }
 873                 }
 874                 _ => panic!("invalid arg index"),
 875             }
 876         }
 877     }
 878 }
 879
 880 fn clean_function<'tcx>(
 881     cx: &mut DocContext<'tcx>,
 882     sig: &hir::FnSig<'tcx>,
 883     generics: &hir::Generics<'tcx>,
 884     body_id: hir::BodyId,
 885 ) -> Box<Function> {
 886     let (generics, decl) = enter_impl_trait(cx, |cx| {
 887         // NOTE: generics must be cleaned before args
 888         let generics = clean_generics(generics, cx);
 889         let args = clean_args_from_types_and_body_id(cx, sig.decl.inputs, body_id);
 890         let mut decl = clean_fn_decl_with_args(cx, sig.decl, args);
 891         if sig.header.is_async() {
 892             decl.output = decl.sugared_async_return_type();
 893         }
 894         (generics, decl)
 895     });
 896     Box::new(Function { decl, generics })
 897 }
 898
 899 fn clean_args_from_types_and_names<'tcx>(
 900     cx: &mut DocContext<'tcx>,
 901     types: &[hir::Ty<'tcx>],
 902     names: &[Ident],
 903 ) -> Arguments {
 904     Arguments {
 905         values: types
 906             .iter()
 907             .enumerate()
 908             .map(|(i, ty)| {
 909                 let mut name = names.get(i).map_or(kw::Empty, |ident| ident.name);
 910                 if name.is_empty() {
 911                     name = kw::Underscore;
 912                 }
 913                 Argument { name, type_: clean_ty(ty, cx), is_const: false }
 914             })
 915             .collect(),
 916     }
 917 }
 918
 919 fn clean_args_from_types_and_body_id<'tcx>(
 920     cx: &mut DocContext<'tcx>,
 921     types: &[hir::Ty<'tcx>],
 922     body_id: hir::BodyId,
 923 ) -> Arguments {
 924     let body = cx.tcx.hir().body(body_id);
 925
 926     Arguments {
 927         values: types
 928             .iter()
 929             .enumerate()
 930             .map(|(i, ty)| Argument {
 931                 name: name_from_pat(body.params[i].pat),
 932                 type_: clean_ty(ty, cx),
 933                 is_const: false,
 934             })
 935             .collect(),
 936     }
 937 }
 938
 939 fn clean_fn_decl_with_args<'tcx>(
 940     cx: &mut DocContext<'tcx>,
 941     decl: &hir::FnDecl<'tcx>,
 942     args: Arguments,
 943 ) -> FnDecl {
 944     let output = match decl.output {
 945         hir::FnRetTy::Return(typ) => Return(clean_ty(typ, cx)),
 946         hir::FnRetTy::DefaultReturn(..) => DefaultReturn,
 947     };
 948     FnDecl { inputs: args, output, c_variadic: decl.c_variadic }
 949 }
 950
 951 fn clean_fn_decl_from_did_and_sig<'tcx>(
 952     cx: &mut DocContext<'tcx>,
 953     did: Option<DefId>,
 954     sig: ty::PolyFnSig<'tcx>,
 955 ) -> FnDecl {
 956     let mut names = did.map_or(&[] as &[_], |did| cx.tcx.fn_arg_names(did)).iter();
 957
 958     // We assume all empty tuples are default return type. This theoretically can discard `-> ()`,
 959     // but shouldn't change any code meaning.
 960     let output = match clean_middle_ty(sig.skip_binder().output(), cx, None) {
 961         Type::Tuple(inner) if inner.is_empty() => DefaultReturn,
 962         ty => Return(ty),
 963     };
 964
 965     FnDecl {
 966         output,
 967         c_variadic: sig.skip_binder().c_variadic,
 968         inputs: Arguments {
 969             values: sig
 970                 .skip_binder()
 971                 .inputs()
 972                 .iter()
 973                 .map(|t| Argument {
 974                     type_: clean_middle_ty(*t, cx, None),
 975                     name: names.next().map_or(kw::Empty, |i| i.name),
 976                     is_const: false,
 977                 })
 978                 .collect(),
 979         },
 980     }
 981 }
 982
 983 fn clean_trait_ref<'tcx>(trait_ref: &hir::TraitRef<'tcx>, cx: &mut DocContext<'tcx>) -> Path {
 984     let path = clean_path(trait_ref.path, cx);
 985     register_res(cx, path.res);
 986     path
 987 }
 988
 989 fn clean_poly_trait_ref<'tcx>(
 990     poly_trait_ref: &hir::PolyTraitRef<'tcx>,
 991     cx: &mut DocContext<'tcx>,
 992 ) -> PolyTrait {
 993     PolyTrait {
 994         trait_: clean_trait_ref(&poly_trait_ref.trait_ref, cx),
 995         generic_params: poly_trait_ref
 996             .bound_generic_params
 997             .iter()
 998             .filter(|p| !is_elided_lifetime(p))
 999             .map(|x| clean_generic_param(cx, None, x))
1000             .collect(),
1001     }
1002 }
1003
1004 fn clean_trait_item<'tcx>(trait_item: &hir::TraitItem<'tcx>, cx: &mut DocContext<'tcx>) -> Item {
1005     let local_did = trait_item.def_id.to_def_id();
1006     cx.with_param_env(local_did, |cx| {
1007         let inner = match trait_item.kind {
1008             hir::TraitItemKind::Const(ty, Some(default)) => AssocConstItem(
1009                 clean_ty(ty, cx),
1010                 ConstantKind::Local { def_id: local_did, body: default },
1011             ),
1012             hir::TraitItemKind::Const(ty, None) => TyAssocConstItem(clean_ty(ty, cx)),
1013             hir::TraitItemKind::Fn(ref sig, hir::TraitFn::Provided(body)) => {
1014                 let m = clean_function(cx, sig, trait_item.generics, body);
1015                 MethodItem(m, None)
1016             }
1017             hir::TraitItemKind::Fn(ref sig, hir::TraitFn::Required(names)) => {
1018                 let (generics, decl) = enter_impl_trait(cx, |cx| {
1019                     // NOTE: generics must be cleaned before args
1020                     let generics = clean_generics(trait_item.generics, cx);
1021                     let args = clean_args_from_types_and_names(cx, sig.decl.inputs, names);
1022                     let decl = clean_fn_decl_with_args(cx, sig.decl, args);
1023                     (generics, decl)
1024                 });
1025                 TyMethodItem(Box::new(Function { decl, generics }))
1026             }
1027             hir::TraitItemKind::Type(bounds, Some(default)) => {
1028                 let generics = enter_impl_trait(cx, |cx| clean_generics(trait_item.generics, cx));
1029                 let bounds = bounds.iter().filter_map(|x| clean_generic_bound(x, cx)).collect();
1030                 let item_type = clean_middle_ty(hir_ty_to_ty(cx.tcx, default), cx, None);
1031                 AssocTypeItem(
1032                     Box::new(Typedef {
1033                         type_: clean_ty(default, cx),
1034                         generics,
1035                         item_type: Some(item_type),
1036                     }),
1037                     bounds,
1038                 )
1039             }
1040             hir::TraitItemKind::Type(bounds, None) => {
1041                 let generics = enter_impl_trait(cx, |cx| clean_generics(trait_item.generics, cx));
1042                 let bounds = bounds.iter().filter_map(|x| clean_generic_bound(x, cx)).collect();
1043                 TyAssocTypeItem(Box::new(generics), bounds)
1044             }
1045         };
1046         let what_rustc_thinks =
1047             Item::from_def_id_and_parts(local_did, Some(trait_item.ident.name), inner, cx);
1048         // Trait items always inherit the trait's visibility -- we don't want to show `pub`.
1049         Item { visibility: Inherited, ..what_rustc_thinks }
1050     })
1051 }
1052
1053 pub(crate) fn clean_impl_item<'tcx>(
1054     impl_: &hir::ImplItem<'tcx>,
1055     cx: &mut DocContext<'tcx>,
1056 ) -> Item {
1057     let local_did = impl_.def_id.to_def_id();
1058     cx.with_param_env(local_did, |cx| {
1059         let inner = match impl_.kind {
1060             hir::ImplItemKind::Const(ty, expr) => {
1061                 let default = ConstantKind::Local { def_id: local_did, body: expr };
1062                 AssocConstItem(clean_ty(ty, cx), default)
1063             }
1064             hir::ImplItemKind::Fn(ref sig, body) => {
1065                 let m = clean_function(cx, sig, impl_.generics, body);
1066                 let defaultness = cx.tcx.impl_defaultness(impl_.def_id);
1067                 MethodItem(m, Some(defaultness))
1068             }
1069             hir::ImplItemKind::TyAlias(hir_ty) => {
1070                 let type_ = clean_ty(hir_ty, cx);
1071                 let generics = clean_generics(impl_.generics, cx);
1072                 let item_type = clean_middle_ty(hir_ty_to_ty(cx.tcx, hir_ty), cx, None);
1073                 AssocTypeItem(
1074                     Box::new(Typedef { type_, generics, item_type: Some(item_type) }),
1075                     Vec::new(),
1076                 )
1077             }
1078         };
1079
1080         let mut what_rustc_thinks =
1081             Item::from_def_id_and_parts(local_did, Some(impl_.ident.name), inner, cx);
1082
1083         let impl_ref = cx.tcx.impl_trait_ref(cx.tcx.local_parent(impl_.def_id));
1084
1085         // Trait impl items always inherit the impl's visibility --
1086         // we don't want to show `pub`.
1087         if impl_ref.is_some() {
1088             what_rustc_thinks.visibility = Inherited;
1089         }
1090
1091         what_rustc_thinks
1092     })
1093 }
1094
1095 pub(crate) fn clean_middle_assoc_item<'tcx>(
1096     assoc_item: &ty::AssocItem,
1097     cx: &mut DocContext<'tcx>,
1098 ) -> Item {
1099     let tcx = cx.tcx;
1100     let kind = match assoc_item.kind {
1101         ty::AssocKind::Const => {
1102             let ty = clean_middle_ty(tcx.type_of(assoc_item.def_id), cx, Some(assoc_item.def_id));
1103
1104             let provided = match assoc_item.container {
1105                 ty::ImplContainer => true,
1106                 ty::TraitContainer => tcx.impl_defaultness(assoc_item.def_id).has_value(),
1107             };
1108             if provided {
1109                 AssocConstItem(ty, ConstantKind::Extern { def_id: assoc_item.def_id })
1110             } else {
1111                 TyAssocConstItem(ty)
1112             }
1113         }
1114         ty::AssocKind::Fn => {
1115             let generics = clean_ty_generics(
1116                 cx,
1117                 tcx.generics_of(assoc_item.def_id),
1118                 tcx.explicit_predicates_of(assoc_item.def_id),
1119             );
1120             let sig = tcx.fn_sig(assoc_item.def_id);
1121             let mut decl = clean_fn_decl_from_did_and_sig(cx, Some(assoc_item.def_id), sig);
1122
1123             if assoc_item.fn_has_self_parameter {
1124                 let self_ty = match assoc_item.container {
1125                     ty::ImplContainer => tcx.type_of(assoc_item.container_id(tcx)),
1126                     ty::TraitContainer => tcx.types.self_param,
1127                 };
1128                 let self_arg_ty = sig.input(0).skip_binder();
1129                 if self_arg_ty == self_ty {
1130                     decl.inputs.values[0].type_ = Generic(kw::SelfUpper);
1131                 } else if let ty::Ref(_, ty, _) = *self_arg_ty.kind() {
1132                     if ty == self_ty {
1133                         match decl.inputs.values[0].type_ {
1134                             BorrowedRef { ref mut type_, .. } => **type_ = Generic(kw::SelfUpper),
1135                             _ => unreachable!(),
1136                         }
1137                     }
1138                 }
1139             }
1140
1141             let provided = match assoc_item.container {
1142                 ty::ImplContainer => true,
1143                 ty::TraitContainer => assoc_item.defaultness(tcx).has_value(),
1144             };
1145             if provided {
1146                 let defaultness = match assoc_item.container {
1147                     ty::ImplContainer => Some(assoc_item.defaultness(tcx)),
1148                     ty::TraitContainer => None,
1149                 };
1150                 MethodItem(Box::new(Function { generics, decl }), defaultness)
1151             } else {
1152                 TyMethodItem(Box::new(Function { generics, decl }))
1153             }
1154         }
1155         ty::AssocKind::Type => {
1156             let my_name = assoc_item.name;
1157
1158             fn param_eq_arg(param: &GenericParamDef, arg: &GenericArg) -> bool {
1159                 match (&param.kind, arg) {
1160                     (GenericParamDefKind::Type { .. }, GenericArg::Type(Type::Generic(ty)))
1161                         if *ty == param.name =>
1162                     {
1163                         true
1164                     }
1165                     (GenericParamDefKind::Lifetime { .. }, GenericArg::Lifetime(Lifetime(lt)))
1166                         if *lt == param.name =>
1167                     {
1168                         true
1169                     }
1170                     (GenericParamDefKind::Const { .. }, GenericArg::Const(c)) => match &c.kind {
1171                         ConstantKind::TyConst { expr } => expr == param.name.as_str(),
1172                         _ => false,
1173                     },
1174                     _ => false,
1175                 }
1176             }
1177
1178             if let ty::TraitContainer = assoc_item.container {
1179                 let bounds = tcx.explicit_item_bounds(assoc_item.def_id);
1180                 let predicates = ty::GenericPredicates { parent: None, predicates: bounds };
1181                 let mut generics =
1182                     clean_ty_generics(cx, tcx.generics_of(assoc_item.def_id), predicates);
1183                 // Filter out the bounds that are (likely?) directly attached to the associated type,
1184                 // as opposed to being located in the where clause.
1185                 let mut bounds = generics
1186                     .where_predicates
1187                     .drain_filter(|pred| match *pred {
1188                         WherePredicate::BoundPredicate {
1189                             ty: QPath(box QPathData { ref assoc, ref self_type, ref trait_, .. }),
1190                             ..
1191                         } => {
1192                             if assoc.name != my_name {
1193                                 return false;
1194                             }
1195                             if trait_.def_id() != assoc_item.container_id(tcx) {
1196                                 return false;
1197                             }
1198                             match *self_type {
1199                                 Generic(ref s) if *s == kw::SelfUpper => {}
1200                                 _ => return false,
1201                             }
1202                             match &assoc.args {
1203                                 GenericArgs::AngleBracketed { args, bindings } => {
1204                                     if !bindings.is_empty()
1205                                         || generics
1206                                             .params
1207                                             .iter()
1208                                             .zip(args.iter())
1209                                             .any(|(param, arg)| !param_eq_arg(param, arg))
1210                                     {
1211                                         return false;
1212                                     }
1213                                 }
1214                                 GenericArgs::Parenthesized { .. } => {
1215                                     // The only time this happens is if we're inside the rustdoc for Fn(),
1216                                     // which only has one associated type, which is not a GAT, so whatever.
1217                                 }
1218                             }
1219                             true
1220                         }
1221                         _ => false,
1222                     })
1223                     .flat_map(|pred| {
1224                         if let WherePredicate::BoundPredicate { bounds, .. } = pred {
1225                             bounds
1226                         } else {
1227                             unreachable!()
1228                         }
1229                     })
1230                     .collect::<Vec<_>>();
1231                 // Our Sized/?Sized bound didn't get handled when creating the generics
1232                 // because we didn't actually get our whole set of bounds until just now
1233                 // (some of them may have come from the trait). If we do have a sized
1234                 // bound, we remove it, and if we don't then we add the `?Sized` bound
1235                 // at the end.
1236                 match bounds.iter().position(|b| b.is_sized_bound(cx)) {
1237                     Some(i) => {
1238                         bounds.remove(i);
1239                     }
1240                     None => bounds.push(GenericBound::maybe_sized(cx)),
1241                 }
1242
1243                 if tcx.impl_defaultness(assoc_item.def_id).has_value() {
1244                     AssocTypeItem(
1245                         Box::new(Typedef {
1246                             type_: clean_middle_ty(
1247                                 tcx.type_of(assoc_item.def_id),
1248                                 cx,
1249                                 Some(assoc_item.def_id),
1250                             ),
1251                             generics,
1252                             // FIXME: should we obtain the Type from HIR and pass it on here?
1253                             item_type: None,
1254                         }),
1255                         bounds,
1256                     )
1257                 } else {
1258                     TyAssocTypeItem(Box::new(generics), bounds)
1259                 }
1260             } else {
1261                 // FIXME: when could this happen? Associated items in inherent impls?
1262                 AssocTypeItem(
1263                     Box::new(Typedef {
1264                         type_: clean_middle_ty(
1265                             tcx.type_of(assoc_item.def_id),
1266                             cx,
1267                             Some(assoc_item.def_id),
1268                         ),
1269                         generics: Generics { params: Vec::new(), where_predicates: Vec::new() },
1270                         item_type: None,
1271                     }),
1272                     Vec::new(),
1273                 )
1274             }
1275         }
1276     };
1277
1278     let mut what_rustc_thinks =
1279         Item::from_def_id_and_parts(assoc_item.def_id, Some(assoc_item.name), kind, cx);
1280
1281     let impl_ref = tcx.impl_trait_ref(tcx.parent(assoc_item.def_id));
1282
1283     // Trait impl items always inherit the impl's visibility --
1284     // we don't want to show `pub`.
1285     if impl_ref.is_some() {
1286         what_rustc_thinks.visibility = Visibility::Inherited;
1287     }
1288
1289     what_rustc_thinks
1290 }
1291
1292 fn clean_qpath<'tcx>(hir_ty: &hir::Ty<'tcx>, cx: &mut DocContext<'tcx>) -> Type {
1293     let hir::Ty { hir_id: _, span, ref kind } = *hir_ty;
1294     let hir::TyKind::Path(qpath) = kind else { unreachable!() };
1295
1296     match qpath {
1297         hir::QPath::Resolved(None, path) => {
1298             if let Res::Def(DefKind::TyParam, did) = path.res {
1299                 if let Some(new_ty) = cx.substs.get(&did).and_then(|p| p.as_ty()).cloned() {
1300                     return new_ty;
1301                 }
1302                 if let Some(bounds) = cx.impl_trait_bounds.remove(&did.into()) {
1303                     return ImplTrait(bounds);
1304                 }
1305             }
1306
1307             if let Some(expanded) = maybe_expand_private_type_alias(cx, path) {
1308                 expanded
1309             } else {
1310                 let path = clean_path(path, cx);
1311                 resolve_type(cx, path)
1312             }
1313         }
1314         hir::QPath::Resolved(Some(qself), p) => {
1315             // Try to normalize `<X as Y>::T` to a type
1316             let ty = hir_ty_to_ty(cx.tcx, hir_ty);
1317             if let Some(normalized_value) = normalize(cx, ty) {
1318                 return clean_middle_ty(normalized_value, cx, None);
1319             }
1320
1321             let trait_segments = &p.segments[..p.segments.len() - 1];
1322             let trait_def = cx.tcx.associated_item(p.res.def_id()).container_id(cx.tcx);
1323             let trait_ = self::Path {
1324                 res: Res::Def(DefKind::Trait, trait_def),
1325                 segments: trait_segments.iter().map(|x| clean_path_segment(x, cx)).collect(),
1326             };
1327             register_res(cx, trait_.res);
1328             let self_def_id = DefId::local(qself.hir_id.owner.local_def_index);
1329             let self_type = clean_ty(qself, cx);
1330             let should_show_cast = compute_should_show_cast(Some(self_def_id), &trait_, &self_type);
1331             Type::QPath(Box::new(QPathData {
1332                 assoc: clean_path_segment(p.segments.last().expect("segments were empty"), cx),
1333                 should_show_cast,
1334                 self_type,
1335                 trait_,
1336             }))
1337         }
1338         hir::QPath::TypeRelative(qself, segment) => {
1339             let ty = hir_ty_to_ty(cx.tcx, hir_ty);
1340             let res = match ty.kind() {
1341                 ty::Projection(proj) => Res::Def(DefKind::Trait, proj.trait_ref(cx.tcx).def_id),
1342                 // Rustdoc handles `ty::Error`s by turning them into `Type::Infer`s.
1343                 ty::Error(_) => return Type::Infer,
1344                 _ => bug!("clean: expected associated type, found `{:?}`", ty),
1345             };
1346             let trait_ = clean_path(&hir::Path { span, res, segments: &[] }, cx);
1347             register_res(cx, trait_.res);
1348             let self_def_id = res.opt_def_id();
1349             let self_type = clean_ty(qself, cx);
1350             let should_show_cast = compute_should_show_cast(self_def_id, &trait_, &self_type);
1351             Type::QPath(Box::new(QPathData {
1352                 assoc: clean_path_segment(segment, cx),
1353                 should_show_cast,
1354                 self_type,
1355                 trait_,
1356             }))
1357         }
1358         hir::QPath::LangItem(..) => bug!("clean: requiring documentation of lang item"),
1359     }
1360 }
1361
1362 fn maybe_expand_private_type_alias<'tcx>(
1363     cx: &mut DocContext<'tcx>,
1364     path: &hir::Path<'tcx>,
1365 ) -> Option<Type> {
1366     let Res::Def(DefKind::TyAlias, def_id) = path.res else { return None };
1367     // Substitute private type aliases
1368     let def_id = def_id.as_local()?;
1369     let alias = if !cx.cache.access_levels.is_exported(def_id.to_def_id()) {
1370         &cx.tcx.hir().expect_item(def_id).kind
1371     } else {
1372         return None;
1373     };
1374     let hir::ItemKind::TyAlias(ty, generics) = alias else { return None };
1375
1376     let provided_params = &path.segments.last().expect("segments were empty");
1377     let mut substs = FxHashMap::default();
1378     let generic_args = provided_params.args();
1379
1380     let mut indices: hir::GenericParamCount = Default::default();
1381     for param in generics.params.iter() {
1382         match param.kind {
1383             hir::GenericParamKind::Lifetime { .. } => {
1384                 let mut j = 0;
1385                 let lifetime = generic_args.args.iter().find_map(|arg| match arg {
1386                     hir::GenericArg::Lifetime(lt) => {
1387                         if indices.lifetimes == j {
1388                             return Some(lt);
1389                         }
1390                         j += 1;
1391                         None
1392                     }
1393                     _ => None,
1394                 });
1395                 if let Some(lt) = lifetime.cloned() {
1396                     let lt_def_id = cx.tcx.hir().local_def_id(param.hir_id);
1397                     let cleaned =
1398                         if !lt.is_elided() { clean_lifetime(lt, cx) } else { Lifetime::elided() };
1399                     substs.insert(lt_def_id.to_def_id(), SubstParam::Lifetime(cleaned));
1400                 }
1401                 indices.lifetimes += 1;
1402             }
1403             hir::GenericParamKind::Type { ref default, .. } => {
1404                 let ty_param_def_id = cx.tcx.hir().local_def_id(param.hir_id);
1405                 let mut j = 0;
1406                 let type_ = generic_args.args.iter().find_map(|arg| match arg {
1407                     hir::GenericArg::Type(ty) => {
1408                         if indices.types == j {
1409                             return Some(ty);
1410                         }
1411                         j += 1;
1412                         None
1413                     }
1414                     _ => None,
1415                 });
1416                 if let Some(ty) = type_ {
1417                     substs.insert(ty_param_def_id.to_def_id(), SubstParam::Type(clean_ty(ty, cx)));
1418                 } else if let Some(default) = *default {
1419                     substs.insert(
1420                         ty_param_def_id.to_def_id(),
1421                         SubstParam::Type(clean_ty(default, cx)),
1422                     );
1423                 }
1424                 indices.types += 1;
1425             }
1426             hir::GenericParamKind::Const { .. } => {
1427                 let const_param_def_id = cx.tcx.hir().local_def_id(param.hir_id);
1428                 let mut j = 0;
1429                 let const_ = generic_args.args.iter().find_map(|arg| match arg {
1430                     hir::GenericArg::Const(ct) => {
1431                         if indices.consts == j {
1432                             return Some(ct);
1433                         }
1434                         j += 1;
1435                         None
1436                     }
1437                     _ => None,
1438                 });
1439                 if let Some(ct) = const_ {
1440                     substs.insert(
1441                         const_param_def_id.to_def_id(),
1442                         SubstParam::Constant(clean_const(ct, cx)),
1443                     );
1444                 }
1445                 // FIXME(const_generics_defaults)
1446                 indices.consts += 1;
1447             }
1448         }
1449     }
1450
1451     Some(cx.enter_alias(substs, |cx| clean_ty(ty, cx)))
1452 }
1453
1454 pub(crate) fn clean_ty<'tcx>(ty: &hir::Ty<'tcx>, cx: &mut DocContext<'tcx>) -> Type {
1455     use rustc_hir::*;
1456
1457     match ty.kind {
1458         TyKind::Never => Primitive(PrimitiveType::Never),
1459         TyKind::Ptr(ref m) => RawPointer(m.mutbl, Box::new(clean_ty(m.ty, cx))),
1460         TyKind::Rptr(ref l, ref m) => {
1461             // There are two times a `Fresh` lifetime can be created:
1462             // 1. For `&'_ x`, written by the user. This corresponds to `lower_lifetime` in `rustc_ast_lowering`.
1463             // 2. For `&x` as a parameter to an `async fn`. This corresponds to `elided_ref_lifetime in `rustc_ast_lowering`.
1464             //    See #59286 for more information.
1465             // Ideally we would only hide the `'_` for case 2., but I don't know a way to distinguish it.
1466             // Turning `fn f(&'_ self)` into `fn f(&self)` isn't the worst thing in the world, though;
1467             // there's no case where it could cause the function to fail to compile.
1468             let elided =
1469                 l.is_elided() || matches!(l.name, LifetimeName::Param(_, ParamName::Fresh));
1470             let lifetime = if elided { None } else { Some(clean_lifetime(*l, cx)) };
1471             BorrowedRef { lifetime, mutability: m.mutbl, type_: Box::new(clean_ty(m.ty, cx)) }
1472         }
1473         TyKind::Slice(ty) => Slice(Box::new(clean_ty(ty, cx))),
1474         TyKind::Array(ty, ref length) => {
1475             let length = match length {
1476                 hir::ArrayLen::Infer(_, _) => "_".to_string(),
1477                 hir::ArrayLen::Body(anon_const) => {
1478                     let def_id = cx.tcx.hir().local_def_id(anon_const.hir_id);
1479                     // NOTE(min_const_generics): We can't use `const_eval_poly` for constants
1480                     // as we currently do not supply the parent generics to anonymous constants
1481                     // but do allow `ConstKind::Param`.
1482                     //
1483                     // `const_eval_poly` tries to to first substitute generic parameters which
1484                     // results in an ICE while manually constructing the constant and using `eval`
1485                     // does nothing for `ConstKind::Param`.
1486                     let ct = ty::Const::from_anon_const(cx.tcx, def_id);
1487                     let param_env = cx.tcx.param_env(def_id);
1488                     print_const(cx, ct.eval(cx.tcx, param_env))
1489                 }
1490             };
1491
1492             Array(Box::new(clean_ty(ty, cx)), length)
1493         }
1494         TyKind::Tup(tys) => Tuple(tys.iter().map(|ty| clean_ty(ty, cx)).collect()),
1495         TyKind::OpaqueDef(item_id, _) => {
1496             let item = cx.tcx.hir().item(item_id);
1497             if let hir::ItemKind::OpaqueTy(ref ty) = item.kind {
1498                 ImplTrait(ty.bounds.iter().filter_map(|x| clean_generic_bound(x, cx)).collect())
1499             } else {
1500                 unreachable!()
1501             }
1502         }
1503         TyKind::Path(_) => clean_qpath(ty, cx),
1504         TyKind::TraitObject(bounds, ref lifetime, _) => {
1505             let bounds = bounds.iter().map(|bound| clean_poly_trait_ref(bound, cx)).collect();
1506             let lifetime =
1507                 if !lifetime.is_elided() { Some(clean_lifetime(*lifetime, cx)) } else { None };
1508             DynTrait(bounds, lifetime)
1509         }
1510         TyKind::BareFn(barefn) => BareFunction(Box::new(clean_bare_fn_ty(barefn, cx))),
1511         // Rustdoc handles `TyKind::Err`s by turning them into `Type::Infer`s.
1512         TyKind::Infer | TyKind::Err => Infer,
1513         TyKind::Typeof(..) => panic!("unimplemented type {:?}", ty.kind),
1514     }
1515 }
1516
1517 /// Returns `None` if the type could not be normalized
1518 fn normalize<'tcx>(cx: &mut DocContext<'tcx>, ty: Ty<'_>) -> Option<Ty<'tcx>> {
1519     // HACK: low-churn fix for #79459 while we wait for a trait normalization fix
1520     if !cx.tcx.sess.opts.unstable_opts.normalize_docs {
1521         return None;
1522     }
1523
1524     use crate::rustc_trait_selection::infer::TyCtxtInferExt;
1525     use crate::rustc_trait_selection::traits::query::normalize::AtExt;
1526     use rustc_middle::traits::ObligationCause;
1527
1528     // Try to normalize `<X as Y>::T` to a type
1529     let lifted = ty.lift_to_tcx(cx.tcx).unwrap();
1530     let normalized = cx.tcx.infer_ctxt().enter(|infcx| {
1531         infcx
1532             .at(&ObligationCause::dummy(), cx.param_env)
1533             .normalize(lifted)
1534             .map(|resolved| infcx.resolve_vars_if_possible(resolved.value))
1535     });
1536     match normalized {
1537         Ok(normalized_value) => {
1538             debug!("normalized {:?} to {:?}", ty, normalized_value);
1539             Some(normalized_value)
1540         }
1541         Err(err) => {
1542             debug!("failed to normalize {:?}: {:?}", ty, err);
1543             None
1544         }
1545     }
1546 }
1547
1548 pub(crate) fn clean_middle_ty<'tcx>(
1549     this: Ty<'tcx>,
1550     cx: &mut DocContext<'tcx>,
1551     def_id: Option<DefId>,
1552 ) -> Type {
1553     trace!("cleaning type: {:?}", this);
1554     let ty = normalize(cx, this).unwrap_or(this);
1555     match *ty.kind() {
1556         ty::Never => Primitive(PrimitiveType::Never),
1557         ty::Bool => Primitive(PrimitiveType::Bool),
1558         ty::Char => Primitive(PrimitiveType::Char),
1559         ty::Int(int_ty) => Primitive(int_ty.into()),
1560         ty::Uint(uint_ty) => Primitive(uint_ty.into()),
1561         ty::Float(float_ty) => Primitive(float_ty.into()),
1562         ty::Str => Primitive(PrimitiveType::Str),
1563         ty::Slice(ty) => Slice(Box::new(clean_middle_ty(ty, cx, None))),
1564         ty::Array(ty, n) => {
1565             let mut n = cx.tcx.lift(n).expect("array lift failed");
1566             n = n.eval(cx.tcx, ty::ParamEnv::reveal_all());
1567             let n = print_const(cx, n);
1568             Array(Box::new(clean_middle_ty(ty, cx, None)), n)
1569         }
1570         ty::RawPtr(mt) => RawPointer(mt.mutbl, Box::new(clean_middle_ty(mt.ty, cx, None))),
1571         ty::Ref(r, ty, mutbl) => BorrowedRef {
1572             lifetime: clean_middle_region(r),
1573             mutability: mutbl,
1574             type_: Box::new(clean_middle_ty(ty, cx, None)),
1575         },
1576         ty::FnDef(..) | ty::FnPtr(_) => {
1577             let ty = cx.tcx.lift(this).expect("FnPtr lift failed");
1578             let sig = ty.fn_sig(cx.tcx);
1579             let decl = clean_fn_decl_from_did_and_sig(cx, None, sig);
1580             BareFunction(Box::new(BareFunctionDecl {
1581                 unsafety: sig.unsafety(),
1582                 generic_params: Vec::new(),
1583                 decl,
1584                 abi: sig.abi(),
1585             }))
1586         }
1587         ty::Adt(def, substs) => {
1588             let did = def.did();
1589             let kind = match def.adt_kind() {
1590                 AdtKind::Struct => ItemType::Struct,
1591                 AdtKind::Union => ItemType::Union,
1592                 AdtKind::Enum => ItemType::Enum,
1593             };
1594             inline::record_extern_fqn(cx, did, kind);
1595             let path = external_path(cx, did, false, ThinVec::new(), substs);
1596             Type::Path { path }
1597         }
1598         ty::Foreign(did) => {
1599             inline::record_extern_fqn(cx, did, ItemType::ForeignType);
1600             let path = external_path(cx, did, false, ThinVec::new(), InternalSubsts::empty());
1601             Type::Path { path }
1602         }
1603         ty::Dynamic(obj, ref reg) => {
1604             // HACK: pick the first `did` as the `did` of the trait object. Someone
1605             // might want to implement "native" support for marker-trait-only
1606             // trait objects.
1607             let mut dids = obj.auto_traits();
1608             let did = obj
1609                 .principal_def_id()
1610                 .or_else(|| dids.next())
1611                 .unwrap_or_else(|| panic!("found trait object `{:?}` with no traits?", this));
1612             let substs = match obj.principal() {
1613                 Some(principal) => principal.skip_binder().substs,
1614                 // marker traits have no substs.
1615                 _ => cx.tcx.intern_substs(&[]),
1616             };
1617
1618             inline::record_extern_fqn(cx, did, ItemType::Trait);
1619
1620             let lifetime = clean_middle_region(*reg);
1621             let mut bounds = dids
1622                 .map(|did| {
1623                     let empty = cx.tcx.intern_substs(&[]);
1624                     let path = external_path(cx, did, false, ThinVec::new(), empty);
1625                     inline::record_extern_fqn(cx, did, ItemType::Trait);
1626                     PolyTrait { trait_: path, generic_params: Vec::new() }
1627                 })
1628                 .collect::<Vec<_>>();
1629
1630             let bindings = obj
1631                 .projection_bounds()
1632                 .map(|pb| TypeBinding {
1633                     assoc: projection_to_path_segment(
1634                         pb.skip_binder()
1635                             .lift_to_tcx(cx.tcx)
1636                             .unwrap()
1637                             // HACK(compiler-errors): Doesn't actually matter what self
1638                             // type we put here, because we're only using the GAT's substs.
1639                             .with_self_ty(cx.tcx, cx.tcx.types.self_param)
1640                             .projection_ty,
1641                         cx,
1642                     ),
1643                     kind: TypeBindingKind::Equality {
1644                         term: clean_middle_term(pb.skip_binder().term, cx),
1645                     },
1646                 })
1647                 .collect();
1648
1649             let path = external_path(cx, did, false, bindings, substs);
1650             bounds.insert(0, PolyTrait { trait_: path, generic_params: Vec::new() });
1651
1652             DynTrait(bounds, lifetime)
1653         }
1654         ty::Tuple(t) => Tuple(t.iter().map(|t| clean_middle_ty(t, cx, None)).collect()),
1655
1656         ty::Projection(ref data) => clean_projection(*data, cx, def_id),
1657
1658         ty::Param(ref p) => {
1659             if let Some(bounds) = cx.impl_trait_bounds.remove(&p.index.into()) {
1660                 ImplTrait(bounds)
1661             } else {
1662                 Generic(p.name)
1663             }
1664         }
1665
1666         ty::Opaque(def_id, substs) => {
1667             // Grab the "TraitA + TraitB" from `impl TraitA + TraitB`,
1668             // by looking up the bounds associated with the def_id.
1669             let substs = cx.tcx.lift(substs).expect("Opaque lift failed");
1670             let bounds = cx
1671                 .tcx
1672                 .explicit_item_bounds(def_id)
1673                 .iter()
1674                 .map(|(bound, _)| EarlyBinder(*bound).subst(cx.tcx, substs))
1675                 .collect::<Vec<_>>();
1676             let mut regions = vec![];
1677             let mut has_sized = false;
1678             let mut bounds = bounds
1679                 .iter()
1680                 .filter_map(|bound| {
1681                     let bound_predicate = bound.kind();
1682                     let trait_ref = match bound_predicate.skip_binder() {
1683                         ty::PredicateKind::Trait(tr) => bound_predicate.rebind(tr.trait_ref),
1684                         ty::PredicateKind::TypeOutlives(ty::OutlivesPredicate(_ty, reg)) => {
1685                             if let Some(r) = clean_middle_region(reg) {
1686                                 regions.push(GenericBound::Outlives(r));
1687                             }
1688                             return None;
1689                         }
1690                         _ => return None,
1691                     };
1692
1693                     if let Some(sized) = cx.tcx.lang_items().sized_trait() {
1694                         if trait_ref.def_id() == sized {
1695                             has_sized = true;
1696                             return None;
1697                         }
1698                     }
1699
1700                     let bindings: ThinVec<_> = bounds
1701                         .iter()
1702                         .filter_map(|bound| {
1703                             if let ty::PredicateKind::Projection(proj) = bound.kind().skip_binder()
1704                             {
1705                                 if proj.projection_ty.trait_ref(cx.tcx) == trait_ref.skip_binder() {
1706                                     Some(TypeBinding {
1707                                         assoc: projection_to_path_segment(proj.projection_ty, cx),
1708                                         kind: TypeBindingKind::Equality {
1709                                             term: clean_middle_term(proj.term, cx),
1710                                         },
1711                                     })
1712                                 } else {
1713                                     None
1714                                 }
1715                             } else {
1716                                 None
1717                             }
1718                         })
1719                         .collect();
1720
1721                     Some(clean_poly_trait_ref_with_bindings(cx, trait_ref, bindings))
1722                 })
1723                 .collect::<Vec<_>>();
1724             bounds.extend(regions);
1725             if !has_sized && !bounds.is_empty() {
1726                 bounds.insert(0, GenericBound::maybe_sized(cx));
1727             }
1728             ImplTrait(bounds)
1729         }
1730
1731         ty::Closure(..) => panic!("Closure"),
1732         ty::Generator(..) => panic!("Generator"),
1733         ty::Bound(..) => panic!("Bound"),
1734         ty::Placeholder(..) => panic!("Placeholder"),
1735         ty::GeneratorWitness(..) => panic!("GeneratorWitness"),
1736         ty::Infer(..) => panic!("Infer"),
1737         ty::Error(_) => panic!("Error"),
1738     }
1739 }
1740
1741 pub(crate) fn clean_field<'tcx>(field: &hir::FieldDef<'tcx>, cx: &mut DocContext<'tcx>) -> Item {
1742     let def_id = cx.tcx.hir().local_def_id(field.hir_id).to_def_id();
1743     clean_field_with_def_id(def_id, field.ident.name, clean_ty(field.ty, cx), cx)
1744 }
1745
1746 pub(crate) fn clean_middle_field<'tcx>(field: &ty::FieldDef, cx: &mut DocContext<'tcx>) -> Item {
1747     clean_field_with_def_id(
1748         field.did,
1749         field.name,
1750         clean_middle_ty(cx.tcx.type_of(field.did), cx, Some(field.did)),
1751         cx,
1752     )
1753 }
1754
1755 pub(crate) fn clean_field_with_def_id(
1756     def_id: DefId,
1757     name: Symbol,
1758     ty: Type,
1759     cx: &mut DocContext<'_>,
1760 ) -> Item {
1761     let what_rustc_thinks =
1762         Item::from_def_id_and_parts(def_id, Some(name), StructFieldItem(ty), cx);
1763     if is_field_vis_inherited(cx.tcx, def_id) {
1764         // Variant fields inherit their enum's visibility.
1765         Item { visibility: Visibility::Inherited, ..what_rustc_thinks }
1766     } else {
1767         what_rustc_thinks
1768     }
1769 }
1770
1771 fn is_field_vis_inherited(tcx: TyCtxt<'_>, def_id: DefId) -> bool {
1772     let parent = tcx.parent(def_id);
1773     match tcx.def_kind(parent) {
1774         DefKind::Struct | DefKind::Union => false,
1775         DefKind::Variant => true,
1776         parent_kind => panic!("unexpected parent kind: {:?}", parent_kind),
1777     }
1778 }
1779
1780 pub(crate) fn clean_visibility(vis: ty::Visibility) -> Visibility {
1781     match vis {
1782         ty::Visibility::Public => Visibility::Public,
1783         ty::Visibility::Restricted(module) => Visibility::Restricted(module),
1784     }
1785 }
1786
1787 pub(crate) fn clean_variant_def<'tcx>(variant: &ty::VariantDef, cx: &mut DocContext<'tcx>) -> Item {
1788     let kind = match variant.ctor_kind {
1789         CtorKind::Const => Variant::CLike(match variant.discr {
1790             ty::VariantDiscr::Explicit(def_id) => Some(Discriminant { expr: None, value: def_id }),
1791             ty::VariantDiscr::Relative(_) => None,
1792         }),
1793         CtorKind::Fn => Variant::Tuple(
1794             variant.fields.iter().map(|field| clean_middle_field(field, cx)).collect(),
1795         ),
1796         CtorKind::Fictive => Variant::Struct(VariantStruct {
1797             struct_type: CtorKind::Fictive,
1798             fields: variant.fields.iter().map(|field| clean_middle_field(field, cx)).collect(),
1799         }),
1800     };
1801     let what_rustc_thinks =
1802         Item::from_def_id_and_parts(variant.def_id, Some(variant.name), VariantItem(kind), cx);
1803     // don't show `pub` for variants, which always inherit visibility
1804     Item { visibility: Inherited, ..what_rustc_thinks }
1805 }
1806
1807 fn clean_variant_data<'tcx>(
1808     variant: &hir::VariantData<'tcx>,
1809     disr_expr: &Option<hir::AnonConst>,
1810     cx: &mut DocContext<'tcx>,
1811 ) -> Variant {
1812     match variant {
1813         hir::VariantData::Struct(..) => Variant::Struct(VariantStruct {
1814             struct_type: CtorKind::from_hir(variant),
1815             fields: variant.fields().iter().map(|x| clean_field(x, cx)).collect(),
1816         }),
1817         hir::VariantData::Tuple(..) => {
1818             Variant::Tuple(variant.fields().iter().map(|x| clean_field(x, cx)).collect())
1819         }
1820         hir::VariantData::Unit(..) => Variant::CLike(disr_expr.map(|disr| Discriminant {
1821             expr: Some(disr.body),
1822             value: cx.tcx.hir().local_def_id(disr.hir_id).to_def_id(),
1823         })),
1824     }
1825 }
1826
1827 fn clean_path<'tcx>(path: &hir::Path<'tcx>, cx: &mut DocContext<'tcx>) -> Path {
1828     Path {
1829         res: path.res,
1830         segments: path.segments.iter().map(|x| clean_path_segment(x, cx)).collect(),
1831     }
1832 }
1833
1834 fn clean_generic_args<'tcx>(
1835     generic_args: &hir::GenericArgs<'tcx>,
1836     cx: &mut DocContext<'tcx>,
1837 ) -> GenericArgs {
1838     if generic_args.parenthesized {
1839         let output = clean_ty(generic_args.bindings[0].ty(), cx);
1840         let output = if output != Type::Tuple(Vec::new()) { Some(Box::new(output)) } else { None };
1841         let inputs =
1842             generic_args.inputs().iter().map(|x| clean_ty(x, cx)).collect::<Vec<_>>().into();
1843         GenericArgs::Parenthesized { inputs, output }
1844     } else {
1845         let args = generic_args
1846             .args
1847             .iter()
1848             .map(|arg| match arg {
1849                 hir::GenericArg::Lifetime(lt) if !lt.is_elided() => {
1850                     GenericArg::Lifetime(clean_lifetime(*lt, cx))
1851                 }
1852                 hir::GenericArg::Lifetime(_) => GenericArg::Lifetime(Lifetime::elided()),
1853                 hir::GenericArg::Type(ty) => GenericArg::Type(clean_ty(ty, cx)),
1854                 hir::GenericArg::Const(ct) => GenericArg::Const(Box::new(clean_const(ct, cx))),
1855                 hir::GenericArg::Infer(_inf) => GenericArg::Infer,
1856             })
1857             .collect::<Vec<_>>()
1858             .into();
1859         let bindings =
1860             generic_args.bindings.iter().map(|x| clean_type_binding(x, cx)).collect::<ThinVec<_>>();
1861         GenericArgs::AngleBracketed { args, bindings }
1862     }
1863 }
1864
1865 fn clean_path_segment<'tcx>(
1866     path: &hir::PathSegment<'tcx>,
1867     cx: &mut DocContext<'tcx>,
1868 ) -> PathSegment {
1869     PathSegment { name: path.ident.name, args: clean_generic_args(path.args(), cx) }
1870 }
1871
1872 fn clean_bare_fn_ty<'tcx>(
1873     bare_fn: &hir::BareFnTy<'tcx>,
1874     cx: &mut DocContext<'tcx>,
1875 ) -> BareFunctionDecl {
1876     let (generic_params, decl) = enter_impl_trait(cx, |cx| {
1877         // NOTE: generics must be cleaned before args
1878         let generic_params = bare_fn
1879             .generic_params
1880             .iter()
1881             .filter(|p| !is_elided_lifetime(p))
1882             .map(|x| clean_generic_param(cx, None, x))
1883             .collect();
1884         let args = clean_args_from_types_and_names(cx, bare_fn.decl.inputs, bare_fn.param_names);
1885         let decl = clean_fn_decl_with_args(cx, bare_fn.decl, args);
1886         (generic_params, decl)
1887     });
1888     BareFunctionDecl { unsafety: bare_fn.unsafety, abi: bare_fn.abi, decl, generic_params }
1889 }
1890
1891 fn clean_maybe_renamed_item<'tcx>(
1892     cx: &mut DocContext<'tcx>,
1893     item: &hir::Item<'tcx>,
1894     renamed: Option<Symbol>,
1895 ) -> Vec<Item> {
1896     use hir::ItemKind;
1897
1898     let def_id = item.def_id.to_def_id();
1899     let mut name = renamed.unwrap_or_else(|| cx.tcx.hir().name(item.hir_id()));
1900     cx.with_param_env(def_id, |cx| {
1901         let kind = match item.kind {
1902             ItemKind::Static(ty, mutability, body_id) => {
1903                 StaticItem(Static { type_: clean_ty(ty, cx), mutability, expr: Some(body_id) })
1904             }
1905             ItemKind::Const(ty, body_id) => ConstantItem(Constant {
1906                 type_: clean_ty(ty, cx),
1907                 kind: ConstantKind::Local { body: body_id, def_id },
1908             }),
1909             ItemKind::OpaqueTy(ref ty) => OpaqueTyItem(OpaqueTy {
1910                 bounds: ty.bounds.iter().filter_map(|x| clean_generic_bound(x, cx)).collect(),
1911                 generics: clean_generics(ty.generics, cx),
1912             }),
1913             ItemKind::TyAlias(hir_ty, generics) => {
1914                 let rustdoc_ty = clean_ty(hir_ty, cx);
1915                 let ty = clean_middle_ty(hir_ty_to_ty(cx.tcx, hir_ty), cx, None);
1916                 TypedefItem(Box::new(Typedef {
1917                     type_: rustdoc_ty,
1918                     generics: clean_generics(generics, cx),
1919                     item_type: Some(ty),
1920                 }))
1921             }
1922             ItemKind::Enum(ref def, generics) => EnumItem(Enum {
1923                 variants: def.variants.iter().map(|v| clean_variant(v, cx)).collect(),
1924                 generics: clean_generics(generics, cx),
1925             }),
1926             ItemKind::TraitAlias(generics, bounds) => TraitAliasItem(TraitAlias {
1927                 generics: clean_generics(generics, cx),
1928                 bounds: bounds.iter().filter_map(|x| clean_generic_bound(x, cx)).collect(),
1929             }),
1930             ItemKind::Union(ref variant_data, generics) => UnionItem(Union {
1931                 generics: clean_generics(generics, cx),
1932                 fields: variant_data.fields().iter().map(|x| clean_field(x, cx)).collect(),
1933             }),
1934             ItemKind::Struct(ref variant_data, generics) => StructItem(Struct {
1935                 struct_type: CtorKind::from_hir(variant_data),
1936                 generics: clean_generics(generics, cx),
1937                 fields: variant_data.fields().iter().map(|x| clean_field(x, cx)).collect(),
1938             }),
1939             ItemKind::Impl(impl_) => return clean_impl(impl_, item.hir_id(), cx),
1940             // proc macros can have a name set by attributes
1941             ItemKind::Fn(ref sig, generics, body_id) => {
1942                 clean_fn_or_proc_macro(item, sig, generics, body_id, &mut name, cx)
1943             }
1944             ItemKind::Macro(ref macro_def, _) => {
1945                 let ty_vis = clean_visibility(cx.tcx.visibility(def_id));
1946                 MacroItem(Macro {
1947                     source: display_macro_source(cx, name, macro_def, def_id, ty_vis),
1948                 })
1949             }
1950             ItemKind::Trait(_, _, generics, bounds, item_ids) => {
1951                 let items = item_ids
1952                     .iter()
1953                     .map(|ti| clean_trait_item(cx.tcx.hir().trait_item(ti.id), cx))
1954                     .collect();
1955
1956                 TraitItem(Box::new(Trait {
1957                     def_id,
1958                     items,
1959                     generics: clean_generics(generics, cx),
1960                     bounds: bounds.iter().filter_map(|x| clean_generic_bound(x, cx)).collect(),
1961                 }))
1962             }
1963             ItemKind::ExternCrate(orig_name) => {
1964                 return clean_extern_crate(item, name, orig_name, cx);
1965             }
1966             ItemKind::Use(path, kind) => {
1967                 return clean_use_statement(item, name, path, kind, cx, &mut FxHashSet::default());
1968             }
1969             _ => unreachable!("not yet converted"),
1970         };
1971
1972         vec![Item::from_def_id_and_parts(def_id, Some(name), kind, cx)]
1973     })
1974 }
1975
1976 fn clean_variant<'tcx>(variant: &hir::Variant<'tcx>, cx: &mut DocContext<'tcx>) -> Item {
1977     let kind = VariantItem(clean_variant_data(&variant.data, &variant.disr_expr, cx));
1978     let what_rustc_thinks =
1979         Item::from_hir_id_and_parts(variant.id, Some(variant.ident.name), kind, cx);
1980     // don't show `pub` for variants, which are always public
1981     Item { visibility: Inherited, ..what_rustc_thinks }
1982 }
1983
1984 fn clean_impl<'tcx>(
1985     impl_: &hir::Impl<'tcx>,
1986     hir_id: hir::HirId,
1987     cx: &mut DocContext<'tcx>,
1988 ) -> Vec<Item> {
1989     let tcx = cx.tcx;
1990     let mut ret = Vec::new();
1991     let trait_ = impl_.of_trait.as_ref().map(|t| clean_trait_ref(t, cx));
1992     let items = impl_
1993         .items
1994         .iter()
1995         .map(|ii| clean_impl_item(tcx.hir().impl_item(ii.id), cx))
1996         .collect::<Vec<_>>();
1997     let def_id = tcx.hir().local_def_id(hir_id);
1998
1999     // If this impl block is an implementation of the Deref trait, then we
2000     // need to try inlining the target's inherent impl blocks as well.
2001     if trait_.as_ref().map(|t| t.def_id()) == tcx.lang_items().deref_trait() {
2002         build_deref_target_impls(cx, &items, &mut ret);
2003     }
2004
2005     let for_ = clean_ty(impl_.self_ty, cx);
2006     let type_alias = for_.def_id(&cx.cache).and_then(|did| match tcx.def_kind(did) {
2007         DefKind::TyAlias => Some(clean_middle_ty(tcx.type_of(did), cx, Some(did))),
2008         _ => None,
2009     });
2010     let mut make_item = |trait_: Option<Path>, for_: Type, items: Vec<Item>| {
2011         let kind = ImplItem(Box::new(Impl {
2012             unsafety: impl_.unsafety,
2013             generics: clean_generics(impl_.generics, cx),
2014             trait_,
2015             for_,
2016             items,
2017             polarity: tcx.impl_polarity(def_id),
2018             kind: if utils::has_doc_flag(tcx, def_id.to_def_id(), sym::fake_variadic) {
2019                 ImplKind::FakeVaradic
2020             } else {
2021                 ImplKind::Normal
2022             },
2023         }));
2024         Item::from_hir_id_and_parts(hir_id, None, kind, cx)
2025     };
2026     if let Some(type_alias) = type_alias {
2027         ret.push(make_item(trait_.clone(), type_alias, items.clone()));
2028     }
2029     ret.push(make_item(trait_, for_, items));
2030     ret
2031 }
2032
2033 fn clean_extern_crate<'tcx>(
2034     krate: &hir::Item<'tcx>,
2035     name: Symbol,
2036     orig_name: Option<Symbol>,
2037     cx: &mut DocContext<'tcx>,
2038 ) -> Vec<Item> {
2039     // this is the ID of the `extern crate` statement
2040     let cnum = cx.tcx.extern_mod_stmt_cnum(krate.def_id).unwrap_or(LOCAL_CRATE);
2041     // this is the ID of the crate itself
2042     let crate_def_id = cnum.as_def_id();
2043     let attrs = cx.tcx.hir().attrs(krate.hir_id());
2044     let ty_vis = cx.tcx.visibility(krate.def_id);
2045     let please_inline = ty_vis.is_public()
2046         && attrs.iter().any(|a| {
2047             a.has_name(sym::doc)
2048                 && match a.meta_item_list() {
2049                     Some(l) => attr::list_contains_name(&l, sym::inline),
2050                     None => false,
2051                 }
2052         });
2053
2054     if please_inline {
2055         let mut visited = FxHashSet::default();
2056
2057         let res = Res::Def(DefKind::Mod, crate_def_id);
2058
2059         if let Some(items) = inline::try_inline(
2060             cx,
2061             cx.tcx.parent_module(krate.hir_id()).to_def_id(),
2062             Some(krate.def_id.to_def_id()),
2063             res,
2064             name,
2065             Some(attrs),
2066             &mut visited,
2067         ) {
2068             return items;
2069         }
2070     }
2071
2072     // FIXME: using `from_def_id_and_kind` breaks `rustdoc/masked` for some reason
2073     vec![Item {
2074         name: Some(name),
2075         attrs: Box::new(Attributes::from_ast(attrs)),
2076         item_id: crate_def_id.into(),
2077         visibility: clean_visibility(ty_vis),
2078         kind: Box::new(ExternCrateItem { src: orig_name }),
2079         cfg: attrs.cfg(cx.tcx, &cx.cache.hidden_cfg),
2080     }]
2081 }
2082
2083 fn clean_use_statement<'tcx>(
2084     import: &hir::Item<'tcx>,
2085     name: Symbol,
2086     path: &hir::Path<'tcx>,
2087     kind: hir::UseKind,
2088     cx: &mut DocContext<'tcx>,
2089     inlined_names: &mut FxHashSet<(ItemType, Symbol)>,
2090 ) -> Vec<Item> {
2091     // We need this comparison because some imports (for std types for example)
2092     // are "inserted" as well but directly by the compiler and they should not be
2093     // taken into account.
2094     if import.span.ctxt().outer_expn_data().kind == ExpnKind::AstPass(AstPass::StdImports) {
2095         return Vec::new();
2096     }
2097
2098     let visibility = cx.tcx.visibility(import.def_id);
2099     let attrs = cx.tcx.hir().attrs(import.hir_id());
2100     let inline_attr = attrs.lists(sym::doc).get_word_attr(sym::inline);
2101     let pub_underscore = visibility.is_public() && name == kw::Underscore;
2102     let current_mod = cx.tcx.parent_module_from_def_id(import.def_id);
2103
2104     // The parent of the module in which this import resides. This
2105     // is the same as `current_mod` if that's already the top
2106     // level module.
2107     let parent_mod = cx.tcx.parent_module_from_def_id(current_mod);
2108
2109     // This checks if the import can be seen from a higher level module.
2110     // In other words, it checks if the visibility is the equivalent of
2111     // `pub(super)` or higher. If the current module is the top level
2112     // module, there isn't really a parent module, which makes the results
2113     // meaningless. In this case, we make sure the answer is `false`.
2114     let is_visible_from_parent_mod = visibility.is_accessible_from(parent_mod.to_def_id(), cx.tcx)
2115         && !current_mod.is_top_level_module();
2116
2117     if pub_underscore {
2118         if let Some(ref inline) = inline_attr {
2119             rustc_errors::struct_span_err!(
2120                 cx.tcx.sess,
2121                 inline.span(),
2122                 E0780,
2123                 "anonymous imports cannot be inlined"
2124             )
2125             .span_label(import.span, "anonymous import")
2126             .emit();
2127         }
2128     }
2129
2130     // We consider inlining the documentation of `pub use` statements, but we
2131     // forcefully don't inline if this is not public or if the
2132     // #[doc(no_inline)] attribute is present.
2133     // Don't inline doc(hidden) imports so they can be stripped at a later stage.
2134     let mut denied = cx.output_format.is_json()
2135         || !(visibility.is_public()
2136             || (cx.render_options.document_private && is_visible_from_parent_mod))
2137         || pub_underscore
2138         || attrs.iter().any(|a| {
2139             a.has_name(sym::doc)
2140                 && match a.meta_item_list() {
2141                     Some(l) => {
2142                         attr::list_contains_name(&l, sym::no_inline)
2143                             || attr::list_contains_name(&l, sym::hidden)
2144                     }
2145                     None => false,
2146                 }
2147         });
2148
2149     // Also check whether imports were asked to be inlined, in case we're trying to re-export a
2150     // crate in Rust 2018+
2151     let path = clean_path(path, cx);
2152     let inner = if kind == hir::UseKind::Glob {
2153         if !denied {
2154             let mut visited = FxHashSet::default();
2155             if let Some(items) = inline::try_inline_glob(cx, path.res, &mut visited, inlined_names)
2156             {
2157                 return items;
2158             }
2159         }
2160         Import::new_glob(resolve_use_source(cx, path), true)
2161     } else {
2162         if inline_attr.is_none() {
2163             if let Res::Def(DefKind::Mod, did) = path.res {
2164                 if !did.is_local() && did.is_crate_root() {
2165                     // if we're `pub use`ing an extern crate root, don't inline it unless we
2166                     // were specifically asked for it
2167                     denied = true;
2168                 }
2169             }
2170         }
2171         if !denied {
2172             let mut visited = FxHashSet::default();
2173             let import_def_id = import.def_id.to_def_id();
2174
2175             if let Some(mut items) = inline::try_inline(
2176                 cx,
2177                 cx.tcx.parent_module(import.hir_id()).to_def_id(),
2178                 Some(import_def_id),
2179                 path.res,
2180                 name,
2181                 Some(attrs),
2182                 &mut visited,
2183             ) {
2184                 items.push(Item::from_def_id_and_parts(
2185                     import_def_id,
2186                     None,
2187                     ImportItem(Import::new_simple(name, resolve_use_source(cx, path), false)),
2188                     cx,
2189                 ));
2190                 return items;
2191             }
2192         }
2193         Import::new_simple(name, resolve_use_source(cx, path), true)
2194     };
2195
2196     vec![Item::from_def_id_and_parts(import.def_id.to_def_id(), None, ImportItem(inner), cx)]
2197 }
2198
2199 fn clean_maybe_renamed_foreign_item<'tcx>(
2200     cx: &mut DocContext<'tcx>,
2201     item: &hir::ForeignItem<'tcx>,
2202     renamed: Option<Symbol>,
2203 ) -> Item {
2204     let def_id = item.def_id.to_def_id();
2205     cx.with_param_env(def_id, |cx| {
2206         let kind = match item.kind {
2207             hir::ForeignItemKind::Fn(decl, names, generics) => {
2208                 let (generics, decl) = enter_impl_trait(cx, |cx| {
2209                     // NOTE: generics must be cleaned before args
2210                     let generics = clean_generics(generics, cx);
2211                     let args = clean_args_from_types_and_names(cx, decl.inputs, names);
2212                     let decl = clean_fn_decl_with_args(cx, decl, args);
2213                     (generics, decl)
2214                 });
2215                 ForeignFunctionItem(Box::new(Function { decl, generics }))
2216             }
2217             hir::ForeignItemKind::Static(ty, mutability) => {
2218                 ForeignStaticItem(Static { type_: clean_ty(ty, cx), mutability, expr: None })
2219             }
2220             hir::ForeignItemKind::Type => ForeignTypeItem,
2221         };
2222
2223         Item::from_hir_id_and_parts(
2224             item.hir_id(),
2225             Some(renamed.unwrap_or(item.ident.name)),
2226             kind,
2227             cx,
2228         )
2229     })
2230 }
2231
2232 fn clean_type_binding<'tcx>(
2233     type_binding: &hir::TypeBinding<'tcx>,
2234     cx: &mut DocContext<'tcx>,
2235 ) -> TypeBinding {
2236     TypeBinding {
2237         assoc: PathSegment {
2238             name: type_binding.ident.name,
2239             args: clean_generic_args(type_binding.gen_args, cx),
2240         },
2241         kind: match type_binding.kind {
2242             hir::TypeBindingKind::Equality { ref term } => {
2243                 TypeBindingKind::Equality { term: clean_hir_term(term, cx) }
2244             }
2245             hir::TypeBindingKind::Constraint { bounds } => TypeBindingKind::Constraint {
2246                 bounds: bounds.iter().filter_map(|b| clean_generic_bound(b, cx)).collect(),
2247             },
2248         },
2249     }
2250 }