Skip to content

Commit 46fdeb2

Browse files
notriddlenotriddle
committed
rustdoc: make JS trait impls act more like HTML
1 parent 62c67a6 commit 46fdeb2

File tree

6 files changed

+100
-8
lines changed

6 files changed

+100
-8
lines changed

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

-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,6 @@ use rustc_hir::def_id::{DefId, DefIdSet};
5555
use rustc_hir::Mutability;
5656
use rustc_middle::middle::stability;
5757
use rustc_middle::ty::{self, TyCtxt};
58-
use rustc_middle::ty::fast_reject::{DeepRejectCtxt, TreatParams};
5958
use rustc_span::{
6059
symbol::{sym, Symbol},
6160
BytePos, FileName, RealFileName,

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

+19-2
Original file line numberDiff line numberDiff line change
@@ -530,20 +530,37 @@ if (typeof exports !== 'undefined') {exports.searchIndex = searchIndex};
530530
.values()
531531
.flat_map(|AliasedTypeImpl { impl_, type_aliases }| {
532532
let mut ret = Vec::new();
533-
let trait_ = impl_.inner_impl().trait_.as_ref().map(|path| path.last().to_string());
533+
let trait_ = impl_
534+
.inner_impl()
535+
.trait_
536+
.as_ref()
537+
.map(|trait_| format!("{:#}", trait_.print(cx)));
534538
// render_impl will filter out "impossible-to-call" methods
535539
// to make that functionality work here, it needs to be called with
536540
// each type alias, and if it gives a different result, split the impl
537541
for &(type_alias_fqp, ref type_alias_item) in type_aliases {
538542
let mut buf = Buffer::html();
539543
cx.id_map = Default::default();
540544
cx.deref_id_map = Default::default();
545+
let target_did = impl_
546+
.inner_impl()
547+
.trait_
548+
.as_ref()
549+
.map(|trait_| trait_.def_id())
550+
.or_else(|| impl_.inner_impl().for_.def_id(cache));
551+
let provided_methods;
552+
let assoc_link = if let Some(target_did) = target_did {
553+
provided_methods = impl_.inner_impl().provided_trait_methods(cx.tcx());
554+
AssocItemLink::GotoSource(ItemId::DefId(target_did), &provided_methods)
555+
} else {
556+
AssocItemLink::Anchor(None)
557+
};
541558
super::render_impl(
542559
&mut buf,
543560
cx,
544561
*impl_,
545562
&type_alias_item,
546-
AssocItemLink::Anchor(None),
563+
assoc_link,
547564
RenderMode::Normal,
548565
None,
549566
&[],

‎src/librustdoc/html/static/js/main.js

+12-3
Original file line numberDiff line numberDiff line change
@@ -680,12 +680,14 @@ function preLoadCss(cssUrl) {
680680

681681
let implementations = document.getElementById("implementations-list");
682682
let trait_implementations = document.getElementById("trait-implementations-list");
683+
let trait_implementations_header = document.getElementById("trait-implementations");
683684

684685
// We want to include the current type alias's impls, and no others.
685686
const script = document.querySelector("script[data-self-path]");
686687
const selfPath = script ? script.getAttribute("data-self-path") : null;
687688

688689
// These sidebar blocks need filled in, too.
690+
const mainContent = document.querySelector("#main-content");
689691
const sidebarSection = document.querySelector(".sidebar section");
690692
let methods = document.querySelector(".sidebar .block.method");
691693
let associatedTypes = document.querySelector(".sidebar .block.associatedtype");
@@ -719,18 +721,18 @@ function preLoadCss(cssUrl) {
719721
const h = document.createElement("h3");
720722
h.appendChild(link);
721723
trait_implementations = outputList;
724+
trait_implementations_header = outputListHeader;
722725
sidebarSection.appendChild(h);
723726
sidebarTraitList = document.createElement("ul");
724727
sidebarTraitList.className = "block trait-implementation";
725728
sidebarSection.appendChild(sidebarTraitList);
726-
const mainContent = document.querySelector("#main-content");
727729
mainContent.appendChild(outputListHeader);
728730
mainContent.appendChild(outputList);
729731
} else {
730732
implementations = outputList;
731733
if (trait_implementations) {
732-
document.insertBefore(outputListHeader, trait_implementations);
733-
document.insertBefore(outputList, trait_implementations);
734+
mainContent.insertBefore(outputListHeader, trait_implementations_header);
735+
mainContent.insertBefore(outputList, trait_implementations_header);
734736
} else {
735737
const mainContent = document.querySelector("#main-content");
736738
mainContent.appendChild(outputListHeader);
@@ -762,7 +764,14 @@ function preLoadCss(cssUrl) {
762764
}
763765
}
764766
if (i !== 0) {
767+
const oldHref = `#${el.id}`;
768+
const newHref = `#${el.id}-${i}`;
765769
el.id = `${el.id}-${i}`;
770+
onEachLazy(template.content.querySelectorAll("a[href]"), link => {
771+
if (link.getAttribute("href") === oldHref) {
772+
link.href = newHref;
773+
}
774+
});
766775
}
767776
idMap.set(el.id, i + 1);
768777
});

‎tests/rustdoc-gui/src/test_docs/lib.rs

+20
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,26 @@ impl SomeOtherTypeWithMethodsAndInlining {
167167
pub fn some_other_method_directly(&self) {}
168168
}
169169

170+
/// Another type alias, this time with methods.
171+
pub struct UnderlyingFooBarBaz;
172+
pub type SomeOtherTypeWithMethodsAndInliningAndTraits = UnderlyingFooBarBaz;
173+
174+
impl AsRef<str> for UnderlyingFooBarBaz {
175+
fn as_ref(&self) -> &str {
176+
"hello"
177+
}
178+
}
179+
180+
impl UnderlyingFooBarBaz {
181+
pub fn inherent_fn(&self) {}
182+
}
183+
184+
impl AsRef<u8> for SomeOtherTypeWithMethodsAndInliningAndTraits {
185+
fn as_ref(&self) -> &u8 {
186+
b"hello"
187+
}
188+
}
189+
170190
pub mod huge_amount_of_consts {
171191
include!(concat!(env!("OUT_DIR"), "/huge_amount_of_consts.rs"));
172192
}

‎tests/rustdoc-gui/type-impls.goml

+48-1
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,39 @@ assert-text: (".block.method li:nth-child(2)", 'some_other_method_directly')
2424
assert-text: (".block.method li:nth-child(3)", 'warning1')
2525
assert-text: (".block.method li:nth-child(4)", 'warning2')
2626

27+
// Now try trait implementation merging and duplicate renumbering
28+
go-to: "file://" + |DOC_PATH| + "/test_docs/type.SomeOtherTypeWithMethodsAndInliningAndTraits.html"
29+
30+
// method directly on type alias
31+
assert: "//*[@id='method.as_ref']"
32+
assert-count: ("//*[@id='method.as_ref']", 1)
33+
// method on underlying type
34+
assert: "//*[@id='method.as_ref-1']"
35+
36+
// sidebar items
37+
assert-count: (
38+
"//*[@class='sidebar-elems']//h3/a[@href='#trait-implementations']",
39+
1
40+
)
41+
assert-text: ("//*[@class='sidebar-elems']//li/a[@href='#impl-AsRef%3Cstr%3E-for-UnderlyingFooBarBaz']", "AsRef<str>")
42+
assert-text: (
43+
"//*[@class='sidebar-elems']//li/a[@href='#impl-AsRef%3Cu8%3E-for-UnderlyingFooBarBaz']",
44+
"AsRef<u8>"
45+
)
46+
assert-count: ("#trait-implementations-list", 1)
47+
assert-count: ("#trait-implementations-list > details", 2)
48+
// Both links point at the underlying trait
49+
store-property: ("//*[@id='method.as_ref']//a[@class='fn']", {"href": href})
50+
assert-property: ("//*[@id='method.as_ref-1']//a[@class='fn']", {"href": |href|})
51+
// Both links have a self-anchor
52+
assert: "//*[@id='method.as_ref']//a[@class='anchor'][@href='#method.as_ref']"
53+
assert: "//*[@id='method.as_ref-1']//a[@class='anchor'][@href='#method.as_ref-1']"
54+
2755
///////////////////////////////////////////////////////////////////////////
2856
// Now, if JavaScript is disabled, only the first method will be present //
2957
///////////////////////////////////////////////////////////////////////////
3058
javascript: false
31-
reload:
59+
go-to: "file://" + |DOC_PATH| + "/test_docs/type.SomeOtherTypeWithMethodsAndInlining.html"
3260

3361
// method directly on type alias
3462
wait-for: "//*[@id='method.some_other_method_directly']"
@@ -37,3 +65,22 @@ wait-for: "//*[@id='method.some_other_method_directly']"
3765
assert-false: "//*[@id='method.must_use']"
3866
assert-false: "//*[@id='method.warning1']"
3967
assert-false: "//*[@id='method.warning2']"
68+
69+
// Now try trait implementation merging and duplicate renumbering
70+
go-to: "file://" + |DOC_PATH| + "/test_docs/type.SomeOtherTypeWithMethodsAndInliningAndTraits.html"
71+
72+
// methods directly on type alias
73+
assert: "//*[@id='method.as_ref']"
74+
assert-count: ("//*[@id='method.as_ref']", 1)
75+
// method on target type
76+
assert-false: "//*[@id='method.as_ref-1']"
77+
78+
// sidebar items
79+
assert-count: (
80+
"//*[@class='sidebar-elems']//h3/a[@href='#trait-implementations']",
81+
1
82+
)
83+
assert-false: "//a[@href='#impl-AsRef%3Cstr%3E-for-UnderlyingFooBarBaz']"
84+
assert: "//a[@href='#impl-AsRef%3Cu8%3E-for-UnderlyingFooBarBaz']"
85+
assert-count: ("#trait-implementations-list", 1)
86+
assert-count: ("#trait-implementations-list > details", 1)

‎tests/rustdoc/type-alias/deref-32077.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ impl Bar for GenericStruct<u32> {}
2222
// We check that "Aliased type" is also present as a title in the sidebar.
2323
// @has - '//*[@class="sidebar-elems"]//h3/a[@href="#aliased-type"]' 'Aliased type'
2424
// We check that we have the implementation of the type alias itself.
25-
// @has - '//*[@id="impl-TypedefStruct"]/h3' 'impl TypedefStruct'
25+
// @has - '//*[@id="impl-GenericStruct%3Cu8%3E"]/h3' 'impl TypedefStruct'
2626
// @has - '//*[@id="method.on_alias"]/h4' 'pub fn on_alias()'
2727
// This trait implementation doesn't match the type alias parameters so shouldn't appear in docs.
2828
// @!has - '//h3' 'impl Bar for GenericStruct<u32> {}'

0 commit comments

Comments
 (0)