1 //! Simplification of where-clauses and parameter bounds into a prettier and
2 //! more canonical form.
4 //! Currently all cross-crate-inlined function use `rustc_middle::ty` to reconstruct
5 //! the AST (e.g., see all of `clean::inline`), but this is not always a
6 //! non-lossy transformation. The current format of storage for where-clauses
7 //! for functions and such is simply a list of predicates. One example of this
8 //! is that the AST predicate of: `where T: Trait<Foo = Bar>` is encoded as:
9 //! `where T: Trait, <T as Trait>::Foo = Bar`.
11 //! This module attempts to reconstruct the original where and/or parameter
12 //! bounds by special casing scenarios such as these. Fun!
14 use rustc_data_structures::fx::FxIndexMap;
15 use rustc_hir::def_id::DefId;
19 use crate::clean::GenericArgs as PP;
20 use crate::clean::WherePredicate as WP;
21 use crate::core::DocContext;
23 pub(crate) fn where_clauses(cx: &DocContext<'_>, clauses: Vec<WP>) -> Vec<WP> {
24 // First, partition the where clause into its separate components.
26 // We use `FxIndexMap` so that the insertion order is preserved to prevent messing up to
27 // the order of the generated bounds.
28 let mut tybounds = FxIndexMap::default();
29 let mut lifetimes = Vec::new();
30 let mut equalities = Vec::new();
32 for clause in clauses {
34 WP::BoundPredicate { ty, bounds, bound_params } => {
35 let (b, p): &mut (Vec<_>, Vec<_>) = tybounds.entry(ty).or_default();
37 p.extend(bound_params);
39 WP::RegionPredicate { lifetime, bounds } => {
40 lifetimes.push((lifetime, bounds));
42 WP::EqPredicate { lhs, rhs, bound_params } => equalities.push((lhs, rhs, bound_params)),
46 // Look for equality predicates on associated types that can be merged into
47 // general bound predicates.
48 equalities.retain(|&(ref lhs, ref rhs, ref bound_params)| {
49 let Some((ty, trait_did, name)) = lhs.projection() else { return true; };
50 let Some((bounds, _)) = tybounds.get_mut(ty) else { return true };
51 let bound_params = bound_params
53 .map(|param| clean::GenericParamDef {
55 kind: clean::GenericParamDefKind::Lifetime { outlives: Vec::new() },
58 merge_bounds(cx, bounds, bound_params, trait_did, name, rhs)
61 // And finally, let's reassemble everything
62 let mut clauses = Vec::new();
64 lifetimes.into_iter().map(|(lt, bounds)| WP::RegionPredicate { lifetime: lt, bounds }),
66 clauses.extend(tybounds.into_iter().map(|(ty, (bounds, bound_params))| WP::BoundPredicate {
71 clauses.extend(equalities.into_iter().map(|(lhs, rhs, bound_params)| WP::EqPredicate {
79 pub(crate) fn merge_bounds(
80 cx: &clean::DocContext<'_>,
81 bounds: &mut Vec<clean::GenericBound>,
82 mut bound_params: Vec<clean::GenericParamDef>,
84 assoc: clean::PathSegment,
87 !bounds.iter_mut().any(|b| {
88 let trait_ref = match *b {
89 clean::GenericBound::TraitBound(ref mut tr, _) => tr,
90 clean::GenericBound::Outlives(..) => return false,
92 // If this QPath's trait `trait_did` is the same as, or a supertrait
93 // of, the bound's trait `did` then we can keep going, otherwise
94 // this is just a plain old equality bound.
95 if !trait_is_same_or_supertrait(cx, trait_ref.trait_.def_id(), trait_did) {
98 let last = trait_ref.trait_.segments.last_mut().expect("segments were empty");
100 trait_ref.generic_params.append(&mut bound_params);
101 // Since the parameters (probably) originate from `tcx.collect_*_late_bound_regions` which
102 // returns a hash set, sort them alphabetically to guarantee a stable and deterministic
103 // output (and to fully deduplicate them).
104 trait_ref.generic_params.sort_unstable_by(|p, q| p.name.as_str().cmp(q.name.as_str()));
105 trait_ref.generic_params.dedup_by_key(|p| p.name);
108 PP::AngleBracketed { ref mut bindings, .. } => {
109 bindings.push(clean::TypeBinding {
110 assoc: assoc.clone(),
111 kind: clean::TypeBindingKind::Equality { term: rhs.clone() },
114 PP::Parenthesized { ref mut output, .. } => match output {
115 Some(o) => assert_eq!(&clean::Term::Type(o.as_ref().clone()), rhs),
117 if *rhs != clean::Term::Type(clean::Type::Tuple(Vec::new())) {
118 *output = Some(Box::new(rhs.ty().unwrap().clone()));
127 fn trait_is_same_or_supertrait(cx: &DocContext<'_>, child: DefId, trait_: DefId) -> bool {
131 let predicates = cx.tcx.super_predicates_of(child);
132 debug_assert!(cx.tcx.generics_of(child).has_self);
133 let self_ty = cx.tcx.types.self_param;
137 .filter_map(|(pred, _)| {
138 if let ty::PredicateKind::Trait(pred) = pred.kind().skip_binder() {
139 if pred.trait_ref.self_ty() == self_ty { Some(pred.def_id()) } else { None }
144 .any(|did| trait_is_same_or_supertrait(cx, did, trait_))