Skip to content

Commit 7b59089

Browse files
GuillaumeGomezGuillaumeGomez
committed
Split clean::Constant enum into a struct and an enum
1 parent ee50933 commit 7b59089

File tree

5 files changed

+46
-46
lines changed

5 files changed

+46
-46
lines changed

‎src/librustdoc/clean/inline.rs

+4-1
Original file line numberDiff line numberDiff line change
@@ -500,7 +500,10 @@ crate fn print_inlined_const(tcx: TyCtxt<'_>, did: DefId) -> String {
500500
}
501501

502502
fn build_const(cx: &mut DocContext<'_>, def_id: DefId) -> clean::Constant {
503-
clean::Constant::Extern { type_: cx.tcx.type_of(def_id).clean(cx), def_id }
503+
clean::Constant {
504+
type_: cx.tcx.type_of(def_id).clean(cx),
505+
kind: clean::ConstantKind::Extern { def_id },
506+
}
504507
}
505508

506509
fn build_static(cx: &mut DocContext<'_>, did: DefId, mutable: bool) -> clean::Static {

‎src/librustdoc/clean/mod.rs

+10-6
Original file line numberDiff line numberDiff line change
@@ -393,12 +393,12 @@ impl Clean<Lifetime> for hir::GenericParam<'_> {
393393

394394
impl Clean<Constant> for hir::ConstArg {
395395
fn clean(&self, cx: &mut DocContext<'_>) -> Constant {
396-
Constant::Anonymous {
396+
Constant {
397397
type_: cx
398398
.tcx
399399
.type_of(cx.tcx.hir().body_owner_def_id(self.value.body).to_def_id())
400400
.clean(cx),
401-
body: self.value.body,
401+
kind: ConstantKind::Anonymous { body: self.value.body },
402402
}
403403
}
404404
}
@@ -1744,7 +1744,10 @@ impl<'tcx> Clean<Type> for Ty<'tcx> {
17441744
impl<'tcx> Clean<Constant> for ty::Const<'tcx> {
17451745
fn clean(&self, cx: &mut DocContext<'_>) -> Constant {
17461746
// FIXME: instead of storing the stringified expression, store `self` directly instead.
1747-
Constant::TyConst { type_: self.ty.clean(cx), expr: self.to_string() }
1747+
Constant {
1748+
type_: self.ty.clean(cx),
1749+
kind: ConstantKind::TyConst { expr: self.to_string() },
1750+
}
17481751
}
17491752
}
17501753

@@ -1945,9 +1948,10 @@ impl Clean<Vec<Item>> for (&hir::Item<'_>, Option<Symbol>) {
19451948
ItemKind::Static(ty, mutability, body_id) => {
19461949
StaticItem(Static { type_: ty.clean(cx), mutability, expr: Some(body_id) })
19471950
}
1948-
ItemKind::Const(ty, body_id) => {
1949-
ConstantItem(Constant::Local { type_: ty.clean(cx), body: body_id, def_id })
1950-
}
1951+
ItemKind::Const(ty, body_id) => ConstantItem(Constant {
1952+
type_: ty.clean(cx),
1953+
kind: ConstantKind::Local { body: body_id, def_id },
1954+
}),
19511955
ItemKind::OpaqueTy(ref ty) => OpaqueTyItem(OpaqueTy {
19521956
bounds: ty.bounds.clean(cx),
19531957
generics: ty.generics.clean(cx),

‎src/librustdoc/clean/types.rs

+30-37
Original file line numberDiff line numberDiff line change
@@ -1987,67 +1987,60 @@ crate struct Static {
19871987
}
19881988

19891989
#[derive(Clone, PartialEq, Eq, Hash, Debug)]
1990-
crate enum Constant {
1990+
crate struct Constant {
1991+
crate type_: Type,
1992+
crate kind: ConstantKind,
1993+
}
1994+
1995+
#[derive(Clone, PartialEq, Eq, Hash, Debug)]
1996+
crate enum ConstantKind {
19911997
/// This is the wrapper around `ty::Const` for a non-local constant. Because it doesn't have a
19921998
/// `BodyId`, we need to handle it on its own.
1993-
TyConst { type_: Type, expr: String },
1994-
/// A constant (expression) that’s not an item or associated item. These are usually found
1999+
///
2000+
/// Note that `ty::Const` includes generic parameters, and may not always be uniquely identified
2001+
/// by a DefId. So this field must be different from `Extern`.
2002+
TyConst { expr: String },
2003+
/// A constant (expression) that's not an item or associated item. These are usually found
19952004
/// nested inside types (e.g., array lengths) or expressions (e.g., repeat counts), and also
19962005
/// used to define explicit discriminant values for enum variants.
1997-
Anonymous { type_: Type, body: BodyId },
2006+
Anonymous { body: BodyId },
19982007
/// A constant from a different crate.
1999-
Extern { type_: Type, def_id: DefId },
2000-
/// const FOO: u32 = ...;
2001-
Local { type_: Type, def_id: DefId, body: BodyId },
2008+
Extern { def_id: DefId },
2009+
/// `const FOO: u32 = ...;`
2010+
Local { def_id: DefId, body: BodyId },
20022011
}
20032012

20042013
impl Constant {
20052014
crate fn expr(&self, tcx: TyCtxt<'_>) -> String {
2006-
match self {
2007-
Self::TyConst { expr, .. } => expr.clone(),
2008-
Self::Extern { def_id, .. } => print_inlined_const(tcx, *def_id),
2009-
Self::Local { body, .. } | Self::Anonymous { body, .. } => print_const_expr(tcx, *body),
2015+
match self.kind {
2016+
ConstantKind::TyConst { ref expr } => expr.clone(),
2017+
ConstantKind::Extern { def_id } => print_inlined_const(tcx, def_id),
2018+
ConstantKind::Local { body, .. } | ConstantKind::Anonymous { body } => {
2019+
print_const_expr(tcx, body)
2020+
}
20102021
}
20112022
}
20122023

20132024
crate fn value(&self, tcx: TyCtxt<'_>) -> Option<String> {
2014-
match self {
2015-
Self::TyConst { .. } | Self::Anonymous { .. } => None,
2016-
Self::Extern { def_id, .. } | Self::Local { def_id, .. } => {
2017-
print_evaluated_const(tcx, *def_id)
2025+
match self.kind {
2026+
ConstantKind::TyConst { .. } | ConstantKind::Anonymous { .. } => None,
2027+
ConstantKind::Extern { def_id } | ConstantKind::Local { def_id, .. } => {
2028+
print_evaluated_const(tcx, def_id)
20182029
}
20192030
}
20202031
}
20212032

20222033
crate fn is_literal(&self, tcx: TyCtxt<'_>) -> bool {
2023-
match self {
2024-
Self::TyConst { .. } => false,
2025-
Self::Extern { def_id, .. } => def_id.as_local().map_or(false, |def_id| {
2034+
match self.kind {
2035+
ConstantKind::TyConst { .. } => false,
2036+
ConstantKind::Extern { def_id } => def_id.as_local().map_or(false, |def_id| {
20262037
is_literal_expr(tcx, tcx.hir().local_def_id_to_hir_id(def_id))
20272038
}),
2028-
Self::Local { body, .. } | Self::Anonymous { body, .. } => {
2039+
ConstantKind::Local { body, .. } | ConstantKind::Anonymous { body } => {
20292040
is_literal_expr(tcx, body.hir_id)
20302041
}
20312042
}
20322043
}
2033-
2034-
crate fn type_(&self) -> &Type {
2035-
match *self {
2036-
Self::TyConst { ref type_, .. }
2037-
| Self::Extern { ref type_, .. }
2038-
| Self::Local { ref type_, .. }
2039-
| Self::Anonymous { ref type_, .. } => type_,
2040-
}
2041-
}
2042-
2043-
crate fn to_type(self) -> Type {
2044-
match self {
2045-
Self::TyConst { type_, .. }
2046-
| Self::Extern { type_, .. }
2047-
| Self::Local { type_, .. }
2048-
| Self::Anonymous { type_, .. } => type_,
2049-
}
2050-
}
20512044
}
20522045

20532046
#[derive(Clone, Debug)]

‎src/librustdoc/html/render/print_item.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -982,7 +982,7 @@ fn item_constant(w: &mut Buffer, cx: &Context<'_>, it: &clean::Item, c: &clean::
982982
"{vis}const {name}: {typ}",
983983
vis = it.visibility.print_with_space(cx.tcx(), it.def_id, cx.cache()),
984984
name = it.name.as_ref().unwrap(),
985-
typ = c.type_().print(cx.cache(), cx.tcx()),
985+
typ = c.type_.print(cx.cache(), cx.tcx()),
986986
);
987987

988988
let value = c.value(cx.tcx());

‎src/librustdoc/json/conversions.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ impl FromWithTcx<clean::Constant> for Constant {
142142
let expr = constant.expr(tcx);
143143
let value = constant.value(tcx);
144144
let is_literal = constant.is_literal(tcx);
145-
Constant { type_: constant.to_type().into_tcx(tcx), expr, value, is_literal }
145+
Constant { type_: constant.type_.into_tcx(tcx), expr, value, is_literal }
146146
}
147147
}
148148

0 commit comments

Comments
 (0)