Skip to content

Commit be9fd75

Browse files
compiler-errorscompiler-errors
committed
rustdoc + rustdoc-json support for non_lifetime_binders
1 parent bf57e8a commit be9fd75

File tree

7 files changed

+73
-29
lines changed

7 files changed

+73
-29
lines changed

‎src/librustdoc/clean/mod.rs‎

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@ use rustc_span::hygiene::{AstPass, MacroKind};
3131
use rustc_span::symbol::{kw, sym, Ident, Symbol};
3232
use rustc_span::{self, ExpnKind};
3333

34-
use std::assert_matches::assert_matches;
3534
use std::borrow::Cow;
3635
use std::collections::hash_map::Entry;
3736
use std::collections::BTreeMap;
@@ -270,15 +269,7 @@ fn clean_where_predicate<'tcx>(
270269
let bound_params = wbp
271270
.bound_generic_params
272271
.iter()
273-
.map(|param| {
274-
// Higher-ranked params must be lifetimes.
275-
// Higher-ranked lifetimes can't have bounds.
276-
assert_matches!(
277-
param,
278-
hir::GenericParam { kind: hir::GenericParamKind::Lifetime { .. }, .. }
279-
);
280-
Lifetime(param.name.ident().name)
281-
})
272+
.map(|param| clean_generic_param(cx, None, param))
282273
.collect();
283274
WherePredicate::BoundPredicate {
284275
ty: clean_ty(wbp.bounded_ty, cx),
@@ -410,7 +401,7 @@ fn clean_projection_predicate<'tcx>(
410401
.collect_referenced_late_bound_regions(&pred)
411402
.into_iter()
412403
.filter_map(|br| match br {
413-
ty::BrNamed(_, name) if br.is_named() => Some(Lifetime(name)),
404+
ty::BrNamed(_, name) if br.is_named() => Some(GenericParamDef::lifetime(name)),
414405
_ => None,
415406
})
416407
.collect();
@@ -508,7 +499,6 @@ fn clean_generic_param_def<'tcx>(
508499
ty::GenericParamDefKind::Const { has_default } => (
509500
def.name,
510501
GenericParamDefKind::Const {
511-
did: def.def_id,
512502
ty: Box::new(clean_middle_ty(
513503
ty::Binder::dummy(
514504
cx.tcx
@@ -578,7 +568,6 @@ fn clean_generic_param<'tcx>(
578568
hir::GenericParamKind::Const { ty, default } => (
579569
param.name.ident().name,
580570
GenericParamDefKind::Const {
581-
did: param.def_id.to_def_id(),
582571
ty: Box::new(clean_ty(ty, cx)),
583572
default: default
584573
.map(|ct| Box::new(ty::Const::from_anon_const(cx.tcx, ct.def_id).to_string())),
@@ -831,7 +820,7 @@ fn clean_ty_generics<'tcx>(
831820
p.get_bound_params()
832821
.into_iter()
833822
.flatten()
834-
.map(|param| GenericParamDef::lifetime(param.0))
823+
.cloned()
835824
.collect(),
836825
));
837826
}

‎src/librustdoc/clean/simplify.rs‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,7 @@ pub(crate) fn where_clauses(cx: &DocContext<'_>, clauses: Vec<WP>) -> ThinVec<WP
4949
equalities.retain(|(lhs, rhs, bound_params)| {
5050
let Some((ty, trait_did, name)) = lhs.projection() else { return true; };
5151
let Some((bounds, _)) = tybounds.get_mut(ty) else { return true };
52-
let bound_params = bound_params
53-
.into_iter()
54-
.map(|param| clean::GenericParamDef::lifetime(param.0))
55-
.collect();
56-
merge_bounds(cx, bounds, bound_params, trait_did, name, rhs)
52+
merge_bounds(cx, bounds, bound_params.clone(), trait_did, name, rhs)
5753
});
5854

5955
// And finally, let's reassemble everything

‎src/librustdoc/clean/types.rs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1236,9 +1236,9 @@ impl Lifetime {
12361236

12371237
#[derive(Clone, Debug)]
12381238
pub(crate) enum WherePredicate {
1239-
BoundPredicate { ty: Type, bounds: Vec<GenericBound>, bound_params: Vec<Lifetime> },
1239+
BoundPredicate { ty: Type, bounds: Vec<GenericBound>, bound_params: Vec<GenericParamDef> },
12401240
RegionPredicate { lifetime: Lifetime, bounds: Vec<GenericBound> },
1241-
EqPredicate { lhs: Box<Type>, rhs: Box<Term>, bound_params: Vec<Lifetime> },
1241+
EqPredicate { lhs: Box<Type>, rhs: Box<Term>, bound_params: Vec<GenericParamDef> },
12421242
}
12431243

12441244
impl WherePredicate {
@@ -1250,7 +1250,7 @@ impl WherePredicate {
12501250
}
12511251
}
12521252

1253-
pub(crate) fn get_bound_params(&self) -> Option<&[Lifetime]> {
1253+
pub(crate) fn get_bound_params(&self) -> Option<&[GenericParamDef]> {
12541254
match self {
12551255
Self::BoundPredicate { bound_params, .. } | Self::EqPredicate { bound_params, .. } => {
12561256
Some(bound_params)
@@ -1264,7 +1264,7 @@ impl WherePredicate {
12641264
pub(crate) enum GenericParamDefKind {
12651265
Lifetime { outlives: Vec<Lifetime> },
12661266
Type { did: DefId, bounds: Vec<GenericBound>, default: Option<Box<Type>>, synthetic: bool },
1267-
Const { did: DefId, ty: Box<Type>, default: Option<Box<String>> },
1267+
Const { ty: Box<Type>, default: Option<Box<String>> },
12681268
}
12691269

12701270
impl GenericParamDefKind {

‎src/librustdoc/html/format.rs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -307,13 +307,13 @@ pub(crate) fn print_where_clause<'a, 'tcx: 'a>(
307307
write!(
308308
f,
309309
"for<{:#}> {ty_cx:#}: {generic_bounds:#}",
310-
comma_sep(bound_params.iter().map(|lt| lt.print()), true)
310+
comma_sep(bound_params.iter().map(|lt| lt.print(cx)), true)
311311
)
312312
} else {
313313
write!(
314314
f,
315315
"for&lt;{}&gt; {ty_cx}: {generic_bounds}",
316-
comma_sep(bound_params.iter().map(|lt| lt.print()), true)
316+
comma_sep(bound_params.iter().map(|lt| lt.print(cx)), true)
317317
)
318318
}
319319
}

‎src/librustdoc/json/conversions.rs‎

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -456,7 +456,7 @@ impl FromWithTcx<clean::GenericParamDefKind> for GenericParamDefKind {
456456
default: default.map(|x| (*x).into_tcx(tcx)),
457457
synthetic,
458458
},
459-
Const { did: _, ty, default } => GenericParamDefKind::Const {
459+
Const { ty, default } => GenericParamDefKind::Const {
460460
type_: (*ty).into_tcx(tcx),
461461
default: default.map(|x| *x),
462462
},
@@ -473,9 +473,35 @@ impl FromWithTcx<clean::WherePredicate> for WherePredicate {
473473
bounds: bounds.into_tcx(tcx),
474474
generic_params: bound_params
475475
.into_iter()
476-
.map(|x| GenericParamDef {
477-
name: x.0.to_string(),
478-
kind: GenericParamDefKind::Lifetime { outlives: vec![] },
476+
.map(|x| {
477+
let name = x.name.to_string();
478+
let kind = match x.kind {
479+
clean::GenericParamDefKind::Lifetime { outlives } => {
480+
GenericParamDefKind::Lifetime {
481+
outlives: outlives.iter().map(|lt| lt.0.to_string()).collect(),
482+
}
483+
}
484+
clean::GenericParamDefKind::Type {
485+
did: _,
486+
bounds,
487+
default,
488+
synthetic,
489+
} => GenericParamDefKind::Type {
490+
bounds: bounds
491+
.into_iter()
492+
.map(|bound| bound.into_tcx(tcx))
493+
.collect(),
494+
default: default.map(|ty| (*ty).into_tcx(tcx)),
495+
synthetic,
496+
},
497+
clean::GenericParamDefKind::Const { ty, default } => {
498+
GenericParamDefKind::Const {
499+
type_: (*ty).into_tcx(tcx),
500+
default: default.map(|d| *d),
501+
}
502+
}
503+
};
504+
GenericParamDef { name, kind }
479505
})
480506
.collect(),
481507
},

‎tests/rustdoc-json/non_lifetime_binders.rs‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
// ignore-tidy-linelength
2+
3+
#![feature(non_lifetime_binders)]
4+
#![allow(incomplete_features)]
5+
6+
#![no_core]
7+
#![feature(lang_items, no_core)]
8+
9+
#[lang = "sized"]
10+
pub trait Sized {}
11+
12+
pub trait Trait {}
13+
14+
#[lang = "phantom_data"]
15+
struct PhantomData<T_>;
16+
17+
pub struct Wrapper<T_>(PhantomData<T_>);
18+
19+
// @count "$.index[*][?(@.name=='foo')].inner.generics.where_predicates[0].bound_predicate.generic_params[*]" 2
20+
// @is "$.index[*][?(@.name=='foo')].inner.generics.where_predicates[0].bound_predicate.generic_params[0].name" \"\'a\"
21+
// @is "$.index[*][?(@.name=='foo')].inner.generics.where_predicates[0].bound_predicate.generic_params[0].kind" '{ "lifetime": { "outlives": [] } }'
22+
// @is "$.index[*][?(@.name=='foo')].inner.generics.where_predicates[0].bound_predicate.generic_params[1].name" \"T\"
23+
// @is "$.index[*][?(@.name=='foo')].inner.generics.where_predicates[0].bound_predicate.generic_params[1].kind" '{ "type": { "bounds": [], "default": null, "synthetic": false } }'
24+
pub fn foo() where for<'a, T> &'a Wrapper<T>: Trait {}

‎tests/rustdoc/non_lifetime_binders.rs‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
#![feature(non_lifetime_binders)]
2+
#![allow(incomplete_features)]
3+
4+
pub trait Trait {}
5+
6+
pub struct Wrapper<T: ?Sized>(Box<T>);
7+
8+
// @has non_lifetime_binders/fn.foo.html '//pre' "fn foo()where for<'a, T> &'a Wrapper<T>: Trait"
9+
pub fn foo() where for<'a, T> &'a Wrapper<T>: Trait {}

0 commit comments

Comments
 (0)