Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rustdoc: Cleanup clean part 2 #88895

Merged
merged 3 commits into from
Sep 26, 2021
Merged

rustdoc: Cleanup clean part 2 #88895

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
07d6454
Remove `Type::ResolvedPath.is_generic`
camelid Aug 23, 2021
1085dc2
Rename `is_generic()` to `is_assoc_ty()`
camelid Aug 31, 2021
dace2ee
rustdoc: Document `is_assoc_ty()`
camelid Sep 25, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 3 additions & 12 deletions src/librustdoc/clean/auto_trait.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -354,7 +354,7 @@ impl<'a, 'tcx> AutoTraitFinder<'a, 'tcx> {
let (poly_trait, output) =
(data.0.as_ref().unwrap().clone(), data.1.as_ref().cloned().map(Box::new));
let new_ty = match poly_trait.trait_ {
Type::ResolvedPath { ref path, ref did, ref is_generic } => {
Type::ResolvedPath { ref path, ref did } => {
let mut new_path = path.clone();
let last_segment =
new_path.segments.pop().expect("segments were empty");
Expand Down Expand Up @@ -389,11 +389,7 @@ impl<'a, 'tcx> AutoTraitFinder<'a, 'tcx> {
.segments
.push(PathSegment { name: last_segment.name, args: new_params });

Type::ResolvedPath {
path: new_path,
did: *did,
is_generic: *is_generic,
}
Type::ResolvedPath { path: new_path, did: *did }
}
_ => panic!("Unexpected data: {:?}, {:?}", ty, data),
};
Expand Down Expand Up @@ -563,11 +559,7 @@ impl<'a, 'tcx> AutoTraitFinder<'a, 'tcx> {
Type::QPath { name: left_name, ref self_type, ref trait_, .. } => {
let ty = &*self_type;
match **trait_ {
Type::ResolvedPath {
path: ref trait_path,
ref did,
ref is_generic,
} => {
Type::ResolvedPath { path: ref trait_path, ref did } => {
let mut new_trait_path = trait_path.clone();

if self.is_fn_ty(trait_) && left_name == sym::Output {
Expand Down Expand Up @@ -612,7 +604,6 @@ impl<'a, 'tcx> AutoTraitFinder<'a, 'tcx> {
trait_: Type::ResolvedPath {
path: new_trait_path,
did: *did,
is_generic: *is_generic,
},
generic_params: Vec::new(),
},
Expand Down
13 changes: 5 additions & 8 deletions src/librustdoc/clean/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ impl Clean<Type> for (ty::TraitRef<'_>, &[TypeBinding]) {

debug!("ty::TraitRef\n subst: {:?}\n", trait_ref.substs);

ResolvedPath { path, did: trait_ref.def_id, is_generic: false }
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This path is for a trait in a ty::TraitRef (e.g., a where clause trait bound), so its Res should be correct and preserve the is_generic: false behavior.

ResolvedPath { path, did: trait_ref.def_id }
}
}

Expand Down Expand Up @@ -1442,12 +1442,12 @@ impl<'tcx> Clean<Type> for Ty<'tcx> {
};
inline::record_extern_fqn(cx, did, kind);
let path = external_path(cx, did, false, vec![], substs);
ResolvedPath { path, did, is_generic: false }
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This path is for a struct/enum/union declaration, so its Res should be correct and preserve the is_generic: false behavior.

ResolvedPath { path, did }
}
ty::Foreign(did) => {
inline::record_extern_fqn(cx, did, ItemType::ForeignType);
let path = external_path(cx, did, false, vec![], InternalSubsts::empty());
ResolvedPath { path, did, is_generic: false }
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This path is for an extern type Foo declaration, so its Res should be correct and preserve the is_generic: false behavior.

ResolvedPath { path, did }
}
ty::Dynamic(ref obj, ref reg) => {
// HACK: pick the first `did` as the `did` of the trait object. Someone
Expand All @@ -1473,7 +1473,7 @@ impl<'tcx> Clean<Type> for Ty<'tcx> {
let path = external_path(cx, did, false, vec![], empty);
inline::record_extern_fqn(cx, did, ItemType::Trait);
let bound = PolyTrait {
trait_: ResolvedPath { path, did, is_generic: false },
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This path is for one of the trait bounds after the first (i.e., one of the auto trait bounds) in a dyn Trait1 + Trait2 + ... object, so its Res should be correct and preserve the is_generic: false behavior.

trait_: ResolvedPath { path, did },
generic_params: Vec::new(),
};
bounds.push(bound);
Expand All @@ -1490,10 +1490,7 @@ impl<'tcx> Clean<Type> for Ty<'tcx> {
let path = external_path(cx, did, false, bindings, substs);
bounds.insert(
0,
PolyTrait {
trait_: ResolvedPath { path, did, is_generic: false },
generic_params: Vec::new(),
},
Comment on lines -1493 to -1496
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This path is for the first trait bound in a dyn Trait1 + Trait2 + ... object, so its Res should be correct and preserve the is_generic: false behavior.

PolyTrait { trait_: ResolvedPath { path, did }, generic_params: Vec::new() },
);

DynTrait(bounds, lifetime)
Expand Down
22 changes: 13 additions & 9 deletions src/librustdoc/clean/types.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1114,10 +1114,7 @@ impl GenericBound {
let path = external_path(cx, did, false, vec![], empty);
inline::record_extern_fqn(cx, did, ItemType::Trait);
GenericBound::TraitBound(
PolyTrait {
trait_: ResolvedPath { path, did, is_generic: false },
generic_params: Vec::new(),
},
Comment on lines -1117 to -1120
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This path belongs to the Sized trait, so it's not an associated type, and Path::is_assoc_ty should preserve that because the Res should be "correct by construction".

PolyTrait { trait_: ResolvedPath { path, did }, generic_params: Vec::new() },
hir::TraitBoundModifier::Maybe,
)
}
Expand Down Expand Up @@ -1384,8 +1381,6 @@ crate enum Type {
ResolvedPath {
path: Path,
did: DefId,
/// `true` if is a `T::Name` path for associated types.
camelid marked this conversation as resolved.
Show resolved Hide resolved
is_generic: bool,
},
/// `dyn for<'a> Trait<'a> + Send + 'static`
DynTrait(Vec<PolyTrait>, Option<Lifetime>),
Expand Down Expand Up @@ -1503,9 +1498,9 @@ impl Type {
}
}

crate fn is_generic(&self) -> bool {
match *self {
ResolvedPath { is_generic, .. } => is_generic,
crate fn is_assoc_ty(&self) -> bool {
match self {
ResolvedPath { path, .. } => path.is_assoc_ty(),
_ => false,
}
}
Expand Down Expand Up @@ -1994,6 +1989,15 @@ impl Path {
String::from(if self.global { "::" } else { "" })
+ &self.segments.iter().map(|s| s.name.to_string()).collect::<Vec<_>>().join("::")
}

crate fn is_assoc_ty(&self) -> bool {
match self.res {
Res::SelfTy(..) if self.segments.len() != 1 => true,
Res::Def(DefKind::TyParam, _) if self.segments.len() != 1 => true,
Res::Def(DefKind::AssocTy, _) => true,
_ => false,
}
}
Comment on lines +1995 to +2002
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This code is adapted directly from resolve_type().

}

#[derive(Clone, PartialEq, Eq, Debug, Hash)]
Expand Down
24 changes: 9 additions & 15 deletions src/librustdoc/clean/utils.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,9 +159,7 @@ pub(super) fn external_path(

crate fn strip_type(ty: Type) -> Type {
match ty {
Type::ResolvedPath { path, did, is_generic } => {
Type::ResolvedPath { path: strip_path(&path), did, is_generic }
}
Type::ResolvedPath { path, did } => Type::ResolvedPath { path: strip_path(&path), did },
Type::DynTrait(mut bounds, lt) => {
let first = bounds.remove(0);
let stripped_trait = strip_type(first.trait_);
Expand Down Expand Up @@ -404,19 +402,15 @@ crate fn print_const_expr(tcx: TyCtxt<'_>, body: hir::BodyId) -> String {
crate fn resolve_type(cx: &mut DocContext<'_>, path: Path) -> Type {
debug!("resolve_type({:?})", path);

let is_generic = match path.res {
Res::PrimTy(p) => return Primitive(PrimitiveType::from(p)),
Res::SelfTy(..) if path.segments.len() == 1 => {
return Generic(kw::SelfUpper);
}
Res::Def(DefKind::TyParam, _) if path.segments.len() == 1 => {
return Generic(path.segments[0].name);
match path.res {
Res::PrimTy(p) => Primitive(PrimitiveType::from(p)),
Res::SelfTy(..) if path.segments.len() == 1 => Generic(kw::SelfUpper),
Res::Def(DefKind::TyParam, _) if path.segments.len() == 1 => Generic(path.segments[0].name),
_ => {
let did = register_res(cx, path.res);
ResolvedPath { path, did }
}
Res::SelfTy(..) | Res::Def(DefKind::TyParam | DefKind::AssocTy, _) => true,
_ => false,
};
let did = register_res(cx, path.res);
ResolvedPath { path, did, is_generic }
}
}
Comment on lines +405 to 414
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The part of this code that computed is_generic is now covered by Path::is_assoc_ty(), so I removed it.


crate fn get_auto_trait_and_blanket_impls(
Expand Down
37 changes: 13 additions & 24 deletions src/librustdoc/html/format.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -752,9 +752,9 @@ fn fmt_type<'cx>(

match *t {
clean::Generic(name) => write!(f, "{}", name),
clean::ResolvedPath { did, ref path, is_generic } => {
clean::ResolvedPath { did, ref path } => {
// Paths like `T::Output` and `Self::Output` should be rendered with all segments.
resolved_path(f, did, path, is_generic, use_absolute, cx)
resolved_path(f, did, path, path.is_assoc_ty(), use_absolute, cx)
}
clean::DynTrait(ref bounds, ref lt) => {
f.write_str("dyn ")?;
Expand Down Expand Up @@ -825,28 +825,17 @@ fn fmt_type<'cx>(
hir::Mutability::Mut => "mut",
hir::Mutability::Not => "const",
};
match **t {
clean::Generic(_) | clean::ResolvedPath { is_generic: true, .. } => {
if f.alternate() {
primitive_link(
f,
clean::PrimitiveType::RawPointer,
&format!("*{} {:#}", m, t.print(cx)),
cx,
)
} else {
primitive_link(
f,
clean::PrimitiveType::RawPointer,
&format!("*{} {}", m, t.print(cx)),
cx,
)
}
}
_ => {
primitive_link(f, clean::PrimitiveType::RawPointer, &format!("*{} ", m), cx)?;
fmt::Display::fmt(&t.print(cx), f)
}

if matches!(**t, clean::Generic(_)) || t.is_assoc_ty() {
let text = if f.alternate() {
format!("*{} {:#}", m, t.print(cx))
} else {
format!("*{} {}", m, t.print(cx))
};
primitive_link(f, clean::PrimitiveType::RawPointer, &text, cx)
} else {
primitive_link(f, clean::PrimitiveType::RawPointer, &format!("*{} ", m), cx)?;
fmt::Display::fmt(&t.print(cx), f)
}
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made a couple of cleanup changes here to reduce rightward drift and make the code easier to understand:

  • replaced match with if matches!
  • extracted a text local variable

The only other change is replacing the pattern clean::Generic(_) | clean::ResolvedPath { is_generic: true, .. } with the conditional if matches!(**t, clean::Generic(_)) || t.is_assoc_ty()), which is necessary now that the is_generic field has been removed in favor of using an is_assoc_ty() function.

}
clean::BorrowedRef { lifetime: ref l, mutability, type_: ref ty } => {
Expand Down
18 changes: 9 additions & 9 deletions src/librustdoc/html/render/print_item.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -712,11 +712,10 @@ fn item_trait(w: &mut Buffer, cx: &Context<'_>, it: &clean::Item, t: &clean::Tra
let mut implementor_dups: FxHashMap<Symbol, (DefId, bool)> = FxHashMap::default();
for implementor in implementors {
match implementor.inner_impl().for_ {
clean::ResolvedPath { ref path, did, is_generic: false, .. }
clean::ResolvedPath { ref path, did, .. }
| clean::BorrowedRef {
type_: box clean::ResolvedPath { ref path, did, is_generic: false, .. },
..
} => {
type_: box clean::ResolvedPath { ref path, did, .. }, ..
} if !path.is_assoc_ty() => {
Comment on lines +715 to +718
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as the above comment.

let &mut (prev_did, ref mut has_duplicates) =
implementor_dups.entry(path.last()).or_insert((did, false));
if prev_did != did {
Expand Down Expand Up @@ -1410,11 +1409,12 @@ fn render_implementor(
// If there's already another implementor that has the same abridged name, use the
// full path, for example in `std::iter::ExactSizeIterator`
let use_absolute = match implementor.inner_impl().for_ {
clean::ResolvedPath { ref path, is_generic: false, .. }
| clean::BorrowedRef {
type_: box clean::ResolvedPath { ref path, is_generic: false, .. },
..
} => implementor_dups[&path.last()].1,
clean::ResolvedPath { ref path, .. }
| clean::BorrowedRef { type_: box clean::ResolvedPath { ref path, .. }, .. }
if !path.is_assoc_ty() =>
{
implementor_dups[&path.last()].1
}
Comment on lines +1412 to +1417
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is_assoc_ty() is the replacement for is_generic == true; this is the negation of that.

_ => false,
};
render_impl(
Expand Down
2 changes: 1 addition & 1 deletion src/librustdoc/json/conversions.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -387,7 +387,7 @@ impl FromWithTcx<clean::Type> for Type {
fn from_tcx(ty: clean::Type, tcx: TyCtxt<'_>) -> Self {
use clean::Type::*;
match ty {
ResolvedPath { path, did, is_generic: _ } => Type::ResolvedPath {
ResolvedPath { path, did } => Type::ResolvedPath {
name: path.whole_name(),
id: from_item_id(did.into()),
args: path.segments.last().map(|args| Box::new(args.clone().args.into_tcx(tcx))),
Expand Down
2 changes: 1 addition & 1 deletion src/librustdoc/passes/stripper.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ impl<'a> DocFolder for ImplStripper<'a> {
return None;
}
if let Some(did) = imp.for_.def_id() {
if did.is_local() && !imp.for_.is_generic() && !self.retained.contains(&did.into())
if did.is_local() && !imp.for_.is_assoc_ty() && !self.retained.contains(&did.into())
{
debug!("ImplStripper: impl item for stripped type; removing");
return None;
Expand Down