mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Use rustc_resolve's descr() instead of rewriting it

Browse Source
This commit is contained in:
Joshua Nelson 2020-08-21 16:12:39 -04:00
parent ebc8cb470f
commit 6875220e1a
2 changed files with 38 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

86
src/librustdoc/passes/collect_intra_doc_links.rs
View File

@ -110,12 +110,7 @@ impl ResolutionFailure<'a> {
enum AnchorFailure { enum AnchorFailure {
MultipleAnchors, MultipleAnchors,
Primitive, RustdocAnchorConflict(Res),
Variant,
AssocConstant,
AssocType,
Field,
Method,
} }
struct LinkCollector<'a, 'tcx> { struct LinkCollector<'a, 'tcx> {
@ -288,7 +283,9 @@ impl<'a, 'tcx> LinkCollector<'a, 'tcx> {
// Not a trait item; just return what we found. // Not a trait item; just return what we found.
Res::PrimTy(..) => { Res::PrimTy(..) => {
if extra_fragment.is_some() { if extra_fragment.is_some() {
return Err(ErrorKind::AnchorFailure(AnchorFailure::Primitive)); return Err(ErrorKind::AnchorFailure(
AnchorFailure::RustdocAnchorConflict(res),
));
} }
return Ok((res, Some(path_str.to_owned()))); return Ok((res, Some(path_str.to_owned())));
} }
@ -305,7 +302,9 @@ impl<'a, 'tcx> LinkCollector<'a, 'tcx> {
} }
} else if let Some((path, prim)) = is_primitive(path_str, ns) { } else if let Some((path, prim)) = is_primitive(path_str, ns) {
if extra_fragment.is_some() { if extra_fragment.is_some() {
return Err(ErrorKind::AnchorFailure(AnchorFailure::Primitive)); return Err(ErrorKind::AnchorFailure(AnchorFailure::RustdocAnchorConflict(
prim,
)));
} }
return Ok((prim, Some(path.to_owned()))); return Ok((prim, Some(path.to_owned())));
} }
@ -444,11 +443,9 @@ impl<'a, 'tcx> LinkCollector<'a, 'tcx> {
ty::AssocKind::Type => "associatedtype", ty::AssocKind::Type => "associatedtype",
}; };
Some(if extra_fragment.is_some() { Some(if extra_fragment.is_some() {
Err(ErrorKind::AnchorFailure(if kind == ty::AssocKind::Fn { Err(ErrorKind::AnchorFailure(AnchorFailure::RustdocAnchorConflict(
AnchorFailure::Method ty_res,
} else { )))
AnchorFailure::AssocConstant
}))
} else { } else {
// HACK(jynelson): `clean` expects the type, not the associated item. // HACK(jynelson): `clean` expects the type, not the associated item.
// but the disambiguator logic expects the associated item. // but the disambiguator logic expects the associated item.
@ -470,11 +467,17 @@ impl<'a, 'tcx> LinkCollector<'a, 'tcx> {
}; };
field.map(|item| { field.map(|item| {
if extra_fragment.is_some() { if extra_fragment.is_some() {
Err(ErrorKind::AnchorFailure(if def.is_enum() { let res = Res::Def(
AnchorFailure::Variant if def.is_enum() {
} else { DefKind::Variant
AnchorFailure::Field } else {
})) DefKind::Field
},
item.did,
);
Err(ErrorKind::AnchorFailure(
AnchorFailure::RustdocAnchorConflict(res),
))
} else { } else {
Ok(( Ok((
ty_res, ty_res,
@ -518,13 +521,9 @@ impl<'a, 'tcx> LinkCollector<'a, 'tcx> {
}; };
if extra_fragment.is_some() { if extra_fragment.is_some() {
Err(ErrorKind::AnchorFailure(if item.kind == ty::AssocKind::Const { Err(ErrorKind::AnchorFailure(AnchorFailure::RustdocAnchorConflict(
AnchorFailure::AssocConstant ty_res,
} else if item.kind == ty::AssocKind::Type { )))
AnchorFailure::AssocType
} else {
AnchorFailure::Method
}))
} else { } else {
let res = Res::Def(item.kind.as_def_kind(), item.def_id); let res = Res::Def(item.kind.as_def_kind(), item.def_id);
Ok((res, Some(format!("{}.{}", kind, item_name)))) Ok((res, Some(format!("{}.{}", kind, item_name))))
@ -889,8 +888,10 @@ impl<'a, 'tcx> DocFolder for LinkCollector<'a, 'tcx> {
Some(res.0) Some(res.0)
} }
Err(ErrorKind::Resolve(kind)) => kind.full_res(), Err(ErrorKind::Resolve(kind)) => kind.full_res(),
// TODO: add `Res` to AnchorFailure Err(ErrorKind::AnchorFailure(
Err(ErrorKind::AnchorFailure(_)) => None, AnchorFailure::RustdocAnchorConflict(res),
)) => Some(res),
Err(ErrorKind::AnchorFailure(AnchorFailure::MultipleAnchors)) => None,
}; };
this.kind_side_channel.take().map(|(kind, id)| Res::Def(kind, id)).or(res) this.kind_side_channel.take().map(|(kind, id)| Res::Def(kind, id)).or(res)
}; };
@ -1070,7 +1071,7 @@ impl<'a, 'tcx> DocFolder for LinkCollector<'a, 'tcx> {
path_str, path_str,
&dox, &dox,
link_range, link_range,
AnchorFailure::Primitive, AnchorFailure::RustdocAnchorConflict(prim),
); );
continue; continue;
} }
@ -1555,28 +1556,11 @@ fn anchor_failure(
) { ) {
let msg = match failure { let msg = match failure {
AnchorFailure::MultipleAnchors => format!("`{}` contains multiple anchors", path_str), AnchorFailure::MultipleAnchors => format!("`{}` contains multiple anchors", path_str),
AnchorFailure::Primitive AnchorFailure::RustdocAnchorConflict(res) => format!(
| AnchorFailure::Variant "`{}` contains an anchor, but links to {kind}s are already anchored",
| AnchorFailure::AssocConstant path_str,
| AnchorFailure::AssocType kind = res.descr(),
| AnchorFailure::Field ),
| AnchorFailure::Method => {
let kind = match failure {
AnchorFailure::Primitive => "primitive type",
AnchorFailure::Variant => "enum variant",
AnchorFailure::AssocConstant => "associated constant",
AnchorFailure::AssocType => "associated type",
AnchorFailure::Field => "struct field",
AnchorFailure::Method => "method",
AnchorFailure::MultipleAnchors => unreachable!("should be handled already"),
};
format!(
"`{}` contains an anchor, but links to {kind}s are already anchored",
path_str,
kind = kind
)
}
}; };
report_diagnostic(cx, &msg, item, dox, &link_range, |diag, sp| { report_diagnostic(cx, &msg, item, dox, &link_range, |diag, sp| {
@ -1689,7 +1673,7 @@ fn handle_variant(
use rustc_middle::ty::DefIdTree; use rustc_middle::ty::DefIdTree;
if extra_fragment.is_some() { if extra_fragment.is_some() {
return Err(ErrorKind::AnchorFailure(AnchorFailure::Variant)); return Err(ErrorKind::AnchorFailure(AnchorFailure::RustdocAnchorConflict(res)));
} }
let parent = if let Some(parent) = cx.tcx.parent(res.def_id()) { let parent = if let Some(parent) = cx.tcx.parent(res.def_id()) {
parent parent

6
src/test/rustdoc-ui/intra-links-anchors.stderr
View File

@ -1,4 +1,4 @@
error: `Foo::f#hola` contains an anchor, but links to struct fields are already anchored error: `Foo::f#hola` contains an anchor, but links to fields are already anchored
--> $DIR/intra-links-anchors.rs:25:15 --> $DIR/intra-links-anchors.rs:25:15
| |
LL | /// Or maybe [Foo::f#hola]. LL | /// Or maybe [Foo::f#hola].
@ -16,13 +16,13 @@ error: `hello#people#!` contains multiple anchors
LL | /// Another anchor error: [hello#people#!]. LL | /// Another anchor error: [hello#people#!].
| ^^^^^^^^^^^^^^ contains invalid anchor | ^^^^^^^^^^^^^^ contains invalid anchor
error: `Enum::A#whatever` contains an anchor, but links to enum variants are already anchored error: `Enum::A#whatever` contains an anchor, but links to variants are already anchored
--> $DIR/intra-links-anchors.rs:37:28 --> $DIR/intra-links-anchors.rs:37:28
| |
LL | /// Damn enum's variants: [Enum::A#whatever]. LL | /// Damn enum's variants: [Enum::A#whatever].
| ^^^^^^^^^^^^^^^^ contains invalid anchor | ^^^^^^^^^^^^^^^^ contains invalid anchor
error: `u32#hello` contains an anchor, but links to primitive types are already anchored error: `u32#hello` contains an anchor, but links to builtin types are already anchored
--> $DIR/intra-links-anchors.rs:43:6 --> $DIR/intra-links-anchors.rs:43:6
| |
LL | /// [u32#hello] LL | /// [u32#hello]