From d05323c7b4ebeaeaffe3ea8e0d02a8b01db67ddd Mon Sep 17 00:00:00 2001
From: Michael Howell <michael@notriddle.com>
Date: Sat, 24 Aug 2024 23:11:30 -0700
Subject: [PATCH 01/12] rustdoc: redesign toolbar and disclosure widgets
This adds labels to the icons and moves them away from the search box.
These changes are made together, because they work together, but are based on
several complaints:
* The [+/-] thing are a Reddit-ism. They don't look like buttons, but look
like syntax
<https://rust-lang.zulipchat.com/#narrow/stream/266220-t-rustdoc/topic/More.20visual.20difference.20for.20the.20.2B.2F-.20.20Icons>,
<https://github.com/rust-lang/rust/issues/59851>
(some of these are laundry lists with more suggestions, but they all
mention [+/-] looking wrong)
* The settings, help, and summary buttons are also too hard to recognize
<https://lwn.net/Articles/987070/>,
<https://github.com/rust-lang/rust/issues/90310>,
<https://github.com/rust-lang/rust/issues/14475#issuecomment-274241997>,
<https://internals.rust-lang.org/t/improve-rustdoc-design/12758>
("Not all functionality is self-explanatory, for example the [+] button in
the top right corner, the theme picker or the settings button.")
The toggle-all and toggle-individual buttons both need done at once, since we
want them to look like they go together. This changes them from both being
[+/-] to both being arrows.
Settings and Help are also migrated, so that the whole group can benefit from
being described using actual words.
Additionally, the Help button is only shown on SERPs, not all the time.
This is done for two major reasons:
* Most of what's in there is search-related. The things that aren't are
keyboard commands, and the search box tells you about that anyway.
Pressing <kbd>?</kbd> will temporarily show the button and its popover.
* I'm trading it off by showing the help button, even on mobile.
It's useful since you can use the search engine suggestions there.
* The three buttons were causing line wrapping on too many desktop layouts.
---
src/librustdoc/html/sources.rs | 35 ++-
src/librustdoc/html/static/css/noscript.css | 5 +-
src/librustdoc/html/static/css/rustdoc.css | 221 +++++++++++++-----
src/librustdoc/html/static/js/main.js | 122 +++++-----
src/librustdoc/html/static/js/search.js | 6 +-
src/librustdoc/html/static/js/settings.js | 19 +-
src/librustdoc/html/static/js/storage.js | 29 ++-
src/librustdoc/html/templates/print_item.html | 13 +-
src/librustdoc/html/templates/source.html | 13 +-
src/librustdoc/lib.rs | 1 +
src/tools/compiletest/src/runtest.rs | 2 +-
src/tools/html-checker/main.rs | 2 +-
tests/rustdoc-gui/help-page.goml | 8 +-
tests/rustdoc-gui/item-info.goml | 2 +-
tests/rustdoc-gui/mobile.goml | 15 --
tests/rustdoc-gui/notable-trait.goml | 5 +-
tests/rustdoc-gui/pocket-menu.goml | 3 +-
tests/rustdoc-gui/scrape-examples-layout.goml | 4 +-
tests/rustdoc-gui/search-form-elements.goml | 40 +---
tests/rustdoc-gui/search-result-display.goml | 13 +-
tests/rustdoc-gui/settings-button.goml | 8 +-
tests/rustdoc-gui/settings.goml | 2 +-
tests/rustdoc-gui/shortcuts.goml | 10 +-
.../sidebar-source-code-display.goml | 2 +-
tests/rustdoc-gui/sidebar.goml | 6 +-
tests/rustdoc-gui/source-anchor-scroll.goml | 8 +-
tests/rustdoc-gui/source-code-page.goml | 4 +-
.../src/theme_css/custom-theme.css | 1 +
tests/rustdoc-gui/toggle-docs.goml | 12 +-
.../rustdoc-gui/type-declation-overflow.goml | 17 +-
tests/rustdoc/html-no-source.rs | 8 +-
tests/rustdoc/source-version-separator.rs | 4 +-
.../version-separator-without-source.rs | 8 +-
33 files changed, 392 insertions(+), 256 deletions(-)
diff --git a/src/librustdoc/html/sources.rs b/src/librustdoc/html/sources.rs
index 551bb56685c99..bbd427bbdd205 100644
--- a/src/librustdoc/html/sources.rs
+++ b/src/librustdoc/html/sources.rs
@@ -26,8 +26,11 @@ pub(crate) fn render(cx: &mut Context<'_>, krate: &clean::Crate) -> Result<(), E
let dst = cx.dst.join("src").join(krate.name(cx.tcx()).as_str());
cx.shared.ensure_dir(&dst)?;
+ let crate_name = krate.name(cx.tcx());
+ let crate_name = crate_name.as_str();
- let mut collector = SourceCollector { dst, cx, emitted_local_sources: FxHashSet::default() };
+ let mut collector =
+ SourceCollector { dst, cx, emitted_local_sources: FxHashSet::default(), crate_name };
collector.visit_crate(krate);
Ok(())
}
@@ -115,6 +118,8 @@ struct SourceCollector<'a, 'tcx> {
/// Root destination to place all HTML output into
dst: PathBuf,
emitted_local_sources: FxHashSet<PathBuf>,
+
+ crate_name: &'a str,
}
impl DocVisitor for SourceCollector<'_, '_> {
@@ -210,6 +215,9 @@ impl SourceCollector<'_, '_> {
},
);
+ let src_fname = p.file_name().expect("source has no filename").to_os_string();
+ let mut fname = src_fname.clone();
+
let root_path = PathBuf::from("../../").join(root_path.into_inner());
let mut root_path = root_path.to_string_lossy();
if let Some(c) = root_path.as_bytes().last()
@@ -217,12 +225,12 @@ impl SourceCollector<'_, '_> {
{
root_path += "/";
}
+ let mut file_path = Path::new(&self.crate_name).join(&*cur.borrow());
+ file_path.push(&fname);
+ fname.push(".html");
let mut cur = self.dst.join(cur.into_inner());
shared.ensure_dir(&cur)?;
- let src_fname = p.file_name().expect("source has no filename").to_os_string();
- let mut fname = src_fname.clone();
- fname.push(".html");
cur.push(&fname);
let title = format!("{} - source", src_fname.to_string_lossy());
@@ -250,7 +258,7 @@ impl SourceCollector<'_, '_> {
cx,
&root_path,
highlight::DecorationInfo::default(),
- SourceContext::Standalone,
+ SourceContext::Standalone { file_path },
)
},
&shared.style_files,
@@ -313,10 +321,11 @@ struct ScrapedSource<'a, Code: std::fmt::Display> {
struct Source<Code: std::fmt::Display> {
lines: RangeInclusive<usize>,
code_html: Code,
+ file_path: Option<(String, String)>,
}
pub(crate) enum SourceContext<'a> {
- Standalone,
+ Standalone { file_path: PathBuf },
Embedded(ScrapedInfo<'a>),
}
@@ -345,9 +354,19 @@ pub(crate) fn print_src(
});
let lines = s.lines().count();
match source_context {
- SourceContext::Standalone => {
- Source { lines: (1..=lines), code_html: code }.render_into(&mut writer).unwrap()
+ SourceContext::Standalone { file_path } => Source {
+ lines: (1..=lines),
+ code_html: code,
+ file_path: if let Some(file_name) = file_path.file_name()
+ && let Some(file_path) = file_path.parent()
+ {
+ Some((file_path.display().to_string(), file_name.display().to_string()))
+ } else {
+ None
+ },
}
+ .render_into(&mut writer)
+ .unwrap(),
SourceContext::Embedded(info) => {
let lines = (1 + info.offset)..=(lines + info.offset);
ScrapedSource { info, lines, code_html: code }.render_into(&mut writer).unwrap();
diff --git a/src/librustdoc/html/static/css/noscript.css b/src/librustdoc/html/static/css/noscript.css
index e62b16267f102..477a79d63e948 100644
--- a/src/librustdoc/html/static/css/noscript.css
+++ b/src/librustdoc/html/static/css/noscript.css
@@ -61,6 +61,8 @@ nav.sub {
--copy-path-img-hover-filter: invert(35%);
--code-example-button-color: #7f7f7f;
--code-example-button-hover-color: #595959;
+ --settings-menu-filter: invert(50%);
+ --settings-menu-hover-filter: invert(35%);
--codeblock-error-hover-color: rgb(255, 0, 0);
--codeblock-error-color: rgba(255, 0, 0, .5);
--codeblock-ignore-hover-color: rgb(255, 142, 0);
@@ -87,7 +89,6 @@ nav.sub {
--search-tab-button-not-selected-background: #e6e6e6;
--search-tab-button-selected-border-top-color: #0089ff;
--search-tab-button-selected-background: #fff;
- --settings-menu-filter: none;
--stab-background-color: #fff5d6;
--stab-code-color: #000;
--code-highlight-kw-color: #8959a8;
@@ -192,6 +193,8 @@ nav.sub {
--search-tab-button-not-selected-background: #252525;
--search-tab-button-selected-border-top-color: #0089ff;
--search-tab-button-selected-background: #353535;
+ --settings-menu-filter: invert(50%);
+ --settings-menu-hover-filter: invert(65%);
--stab-background-color: #314559;
--stab-code-color: #e6e1cf;
--code-highlight-kw-color: #ab8ac1;
diff --git a/src/librustdoc/html/static/css/rustdoc.css b/src/librustdoc/html/static/css/rustdoc.css
index 38154dee3e287..2a9b4c9588380 100644
--- a/src/librustdoc/html/static/css/rustdoc.css
+++ b/src/librustdoc/html/static/css/rustdoc.css
@@ -165,7 +165,7 @@ h1, h2, h3, h4 {
.main-heading h1 {
margin: 0;
padding: 0;
- flex-grow: 1;
+ grid-area: main-heading-h1;
/* We use overflow-wrap: break-word for Safari, which doesn't recognize
`anywhere`: https://developer.mozilla.org/en-US/docs/Web/CSS/overflow-wrap */
overflow-wrap: break-word;
@@ -174,8 +174,12 @@ h1, h2, h3, h4 {
overflow-wrap: anywhere;
}
.main-heading {
- display: flex;
- flex-wrap: wrap;
+ position: relative;
+ display: grid;
+ grid-template-areas:
+ "main-heading-h1 main-heading-toolbar"
+ "main-heading-sub-heading main-heading-toolbar";
+ grid-template-columns: 1fr max-content;
padding-bottom: 6px;
margin-bottom: 15px;
}
@@ -218,9 +222,10 @@ h1, h2, h3, h4, h5, h6,
.search-results .result-name,
.item-name > a,
.out-of-band,
+.sub-heading,
span.since,
a.src,
-#help-button > a,
+rustdoc-toolbar,
summary.hideme,
.scraped-example-list,
/* This selector is for the items listed in the "all items" page. */
@@ -884,9 +889,19 @@ both the code example and the line numbers, so we need to remove the radius in t
overflow-x: auto;
}
-.out-of-band {
+.sub-heading {
flex-grow: 0;
font-size: 1.125rem;
+ grid-area: main-heading-sub-heading;
+}
+
+.main-heading rustdoc-toolbar, .main-heading .out-of-band {
+ grid-area: main-heading-toolbar;
+}
+rustdoc-toolbar {
+ display: flex;
+ flex-direction: row;
+ flex-wrap: nowrap;
}
.docblock code, .docblock-short code,
@@ -1282,10 +1297,16 @@ so that we can apply CSS-filters to change the arrow color in themes */
border-color: var(--settings-input-color) !important;
}
+#settings.popover {
+ --popover-arrow-offset: 118px;
+ top: 26px;
+}
+
/* use larger max-width for help popover, but not for help.html */
#help.popover {
max-width: 600px;
- --popover-arrow-offset: 48px;
+ --popover-arrow-offset: 36px;
+ top: 26px;
}
#help dt {
@@ -1293,10 +1314,15 @@ so that we can apply CSS-filters to change the arrow color in themes */
clear: left;
margin-right: 0.5rem;
}
+#help dd {
+ margin-bottom: 0.5rem;
+}
#help span.top, #help span.bottom {
text-align: center;
display: block;
font-size: 1.125rem;
+ padding: 0 0.5rem;
+ text-wrap-style: balance;
}
#help span.top {
margin: 10px 0;
@@ -1308,10 +1334,13 @@ so that we can apply CSS-filters to change the arrow color in themes */
clear: both;
border-top: 1px solid var(--border-color);
}
+.side-by-side {
+ display: flex;
+ margin-bottom: 20px;
+}
.side-by-side > div {
width: 50%;
- float: left;
- padding: 0 20px 20px 17px;
+ padding: 0 20px 0 17px;
}
.item-info .stab {
@@ -1374,7 +1403,9 @@ so that we can apply CSS-filters to change the arrow color in themes */
}
.rightside:not(a),
-.out-of-band {
+.out-of-band,
+.sub-heading,
+rustdoc-toolbar {
color: var(--right-side-color);
}
@@ -1588,8 +1619,8 @@ instead, we check that it's not a "finger" cursor.
display: block;
}
-.out-of-band > span.since {
- font-size: 1.25rem;
+.main-heading span.since::before {
+ content: "Since ";
}
.sub-variant h4 {
@@ -1691,6 +1722,8 @@ a.tooltip:hover::after {
}
#search-tabs {
+ grid-area: main-heading-sub-heading;
+ margin-top: 0.25rem;
display: flex;
flex-direction: row;
gap: 1px;
@@ -1752,9 +1785,10 @@ a.tooltip:hover::after {
border-bottom: 1px solid var(--border-color);
}
-#settings-menu, #help-button {
+#settings-menu, #help-button, button#toggle-all-docs {
margin-left: var(--button-left-margin);
display: flex;
+ line-height: initial;
}
#sidebar-button {
display: none;
@@ -1778,33 +1812,35 @@ a.tooltip:hover::after {
.hide-sidebar .src #sidebar-button {
position: static;
}
-#settings-menu > a, #help-button > a, #sidebar-button > a {
+#settings-menu > a, #help-button > a, #sidebar-button > a, button#toggle-all-docs {
display: flex;
align-items: center;
justify-content: center;
- background-color: var(--button-background-color);
- border: 1px solid var(--border-color);
+ flex-direction: column;
+ border: 1px solid transparent;
border-radius: var(--button-border-radius);
- color: var(--settings-button-color);
- /* Rare exception to specifying font sizes in rem. Since this is acting
- as an icon, it's okay to specify their sizes in pixels. */
- font-size: 20px;
+ color: var(--main-color);
+}
+#settings-menu > a, #help-button > a, button#toggle-all-docs {
+ width: 80px;
+}
+#sidebar-button > a {
+ background-color: var(--button-background-color);
+ border-color: var(--border-color);
width: 33px;
}
-#settings-menu > a:hover, #settings-menu > a:focus,
-#help-button > a:hover, #help-button > a:focus,
-#sidebar-button > a:hover, #sidebar-button > a:focus {
+#settings-menu > a:hover, #settings-menu > a:focus-visible,
+#help-button > a:hover, #help-button > a:focus-visible,
+#sidebar-button > a:hover, #sidebar-button > a:focus-visible,
+button#toggle-all-docs:hover, button#toggle-all-docs:focus-visible {
border-color: var(--settings-button-border-focus);
+ text-decoration: none;
}
-#settings-menu > a {
- line-height: 0;
- font-size: 0;
-}
#settings-menu > a:before {
/* Wheel <https://www.svgrepo.com/svg/384069/settings-cog-gear> */
- content: url('data:image/svg+xml,<svg width="22" height="22" viewBox="0 0 12 12" \
+ content: url('data:image/svg+xml,<svg width="18" height="18" viewBox="0 0 12 12" \
enable-background="new 0 0 12 12" xmlns="http://www.w3.org/2000/svg">\
<path d="M10.25,6c0-0.1243286-0.0261841-0.241333-0.0366211-0.362915l1.6077881-1.5545654l\
-1.25-2.1650391 c0,0-1.2674561,0.3625488-2.1323853,0.6099854c-0.2034912-0.1431885-0.421875\
@@ -1817,16 +1853,59 @@ a.tooltip:hover::after {
-0.3701782l2.1323853,0.6099854l1.25-2.1650391L10.2133789,6.362915 C10.2238159,6.241333,\
10.25,6.1243286,10.25,6z M6,7.5C5.1715698,7.5,4.5,6.8284302,4.5,6S5.1715698,4.5,6,4.5S7.5\
,5.1715698,7.5,6 S6.8284302,7.5,6,7.5z" fill="black"/></svg>');
- width: 22px;
- height: 22px;
+ width: 18px;
+ height: 18px;
filter: var(--settings-menu-filter);
}
+button#toggle-all-docs:before {
+ /* Custom arrow icon */
+ content: url('data:image/svg+xml,<svg width="18" height="18" viewBox="0 0 12 12" \
+ enable-background="new 0 0 12 12" xmlns="http://www.w3.org/2000/svg">\
+ <path d="M2,2l4,4l4,-4M2,6l4,4l4,-4" stroke="black" fill="none" stroke-width="2px"/></svg>');
+ width: 18px;
+ height: 18px;
+ filter: var(--settings-menu-filter);
+}
+
+#help-button > a:before {
+ /* Question mark with circle */
+ content: url('data:image/svg+xml,<svg width="18" height="18" viewBox="0 0 12 12" \
+ enable-background="new 0 0 12 12" xmlns="http://www.w3.org/2000/svg" fill="none">\
+ <circle r="5.25" cx="6" cy="6" stroke-width="1.25" stroke="black"/>\
+ <text x="4.25" y="9" style="font:8px sans-serif;font-weight:1000" fill="black">?</text></svg>');
+ width: 18px;
+ height: 18px;
+ filter: var(--settings-menu-filter);
+}
+
+button#toggle-all-docs:before,
+#help-button > a:before,
+#settings-menu > a:before {
+ filter: var(--settings-menu-filter);
+ margin: 8px;
+}
+
+@media not (pointer: coarse) {
+ button#toggle-all-docs:hover:before,
+ #help-button > a:hover:before,
+ #settings-menu > a:hover:before {
+ filter: var(--settings-menu-hover-filter);
+ }
+}
+
+rustdoc-toolbar span.label {
+ font-size: initial;
+ font-variant-caps: small-caps;
+ text-transform: lowercase;
+ flex-grow: 1;
+}
+
#sidebar-button > a:before {
/* sidebar resizer image */
content: url('data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 22 22" \
fill="none" stroke="black">\
- <rect x="1" y="1" width="20" height="20" ry="1.5" stroke-width="1.5"/>\
+ <rect x="1" y="1" width="20" height="20" ry="1.5" stroke-width="1.5" stroke="%23777"/>\
<circle cx="4.375" cy="4.375" r="1" stroke-width=".75"/>\
<path d="m7.6121 3v16 M5.375 7.625h-2 m2 3h-2 m2 3h-2" stroke-width="1.25"/></svg>');
width: 22px;
@@ -1941,10 +2020,10 @@ details.toggle > summary.hideme > span {
}
details.toggle > summary::before {
- /* toggle plus */
- background: url('data:image/svg+xml,<svg width="17" height="17" \
-shape-rendering="crispEdges" stroke="black" fill="none" xmlns="http://www.w3.org/2000/svg"><path \
-d="M5 2.5H2.5v12H5m7-12h2.5v12H12M5 8.5h7M8.5 12V8.625v0V5"/></svg>') no-repeat top left;
+ /* arrow pointing left */
+ background: url('data:image/svg+xml,<svg width="16" height="16" viewBox="0 0 12 12" \
+ enable-background="new 0 0 12 12" xmlns="http://www.w3.org/2000/svg">\
+ <path d="M4,2l4,4l-4,4" stroke="black" fill="none" stroke-width="1px"/></svg>');
content: "";
cursor: pointer;
width: 16px;
@@ -2027,10 +2106,10 @@ details.toggle[open] > summary.hideme > span {
}
details.toggle[open] > summary::before {
- /* toggle minus */
- background: url('data:image/svg+xml,<svg width="17" height="17" \
-shape-rendering="crispEdges" stroke="black" fill="none" xmlns="http://www.w3.org/2000/svg"><path \
-d="M5 2.5H2.5v12H5m7-12h2.5v12H12M5 8.5h7"/></svg>') no-repeat top left;
+ /* arrow pointing down */
+ background: url('data:image/svg+xml,<svg width="16" height="16" viewBox="0 0 12 12" \
+ enable-background="new 0 0 12 12" xmlns="http://www.w3.org/2000/svg">\
+ <path d="M2,4l4,4l4,-4" stroke="black" fill="none" stroke-width="1px"/></svg>');
}
details.toggle[open] > summary::after {
@@ -2076,6 +2155,15 @@ However, it's not needed with smaller screen width because the doc/code block is
opacity: 0.75;
}
+/* help button is mostly for search */
+#help-button:not(.help-open),
+#alternative-display #toggle-all-docs {
+ display: none;
+}
+#alternative-display #help-button {
+ display: flex;
+}
+
/* Media Queries */
/* Make sure all the buttons line wrap at the same time */
@@ -2083,6 +2171,12 @@ However, it's not needed with smaller screen width because the doc/code block is
#search-tabs .count {
display: block;
}
+ .side-by-side {
+ flex-direction: column-reverse;
+ }
+ .side-by-side > div {
+ width: auto;
+ }
}
/*
@@ -2099,6 +2193,27 @@ in src-script.js and main.js
scroll-margin-top: 45px;
}
+ /* We don't display this button on mobile devices. */
+ #copy-path {
+ display: none;
+ }
+
+ /* Text label takes up too much space at this size. */
+ rustdoc-toolbar span.label {
+ display: none;
+ }
+ #settings-menu > a, #help-button > a, button#toggle-all-docs {
+ width: 33px;
+ }
+ #settings.popover {
+ --popover-arrow-offset: 48px;
+ top: calc(100% - 8px);
+ }
+ #help.popover {
+ --popover-arrow-offset: 12px;
+ top: calc(100% - 8px);
+ }
+
.rustdoc {
/* Sidebar should overlay main content, rather than pushing main content to the right.
Turn off `display: flex` on the body element. */
@@ -2110,20 +2225,6 @@ in src-script.js and main.js
padding-top: 0px;
}
- .main-heading {
- flex-direction: column;
- }
-
- .out-of-band {
- text-align: left;
- margin-left: initial;
- padding: initial;
- }
-
- .out-of-band .since::before {
- content: "Since ";
- }
-
/* Hide the logo and item name from the sidebar. Those are displayed
in the mobile-topbar instead. */
.sidebar .logo-container,
@@ -2227,16 +2328,11 @@ in src-script.js and main.js
left: -11px;
}
- /* We don't display these buttons on mobile devices. */
- #copy-path, #help-button {
- display: none;
- }
-
/* sidebar button becomes topbar button */
#sidebar-button > a:before {
content: url('data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" \
viewBox="0 0 22 22" fill="none" stroke="black">\
- <rect x="1" y="1" width="20" height="20" ry="1.5" stroke-width="1.5"/>\
+ <rect x="1" y="1" width="20" height="20" ry="1.5" stroke-width="1.5" stroke="%23777"/>\
<circle cx="4.375" cy="4.375" r="1" stroke-width=".75"/>\
<path d="m3 7.375h16m0-3h-4" stroke-width="1.25"/></svg>');
width: 22px;
@@ -2536,6 +2632,8 @@ by default.
--copy-path-img-hover-filter: invert(35%);
--code-example-button-color: #7f7f7f;
--code-example-button-hover-color: #595959;
+ --settings-menu-filter: invert(50%);
+ --settings-menu-hover-filter: invert(35%);
--codeblock-error-hover-color: rgb(255, 0, 0);
--codeblock-error-color: rgba(255, 0, 0, .5);
--codeblock-ignore-hover-color: rgb(255, 142, 0);
@@ -2562,7 +2660,6 @@ by default.
--search-tab-button-not-selected-background: #e6e6e6;
--search-tab-button-selected-border-top-color: #0089ff;
--search-tab-button-selected-background: #fff;
- --settings-menu-filter: none;
--stab-background-color: #fff5d6;
--stab-code-color: #000;
--code-highlight-kw-color: #8959a8;
@@ -2666,7 +2763,8 @@ by default.
--search-tab-button-not-selected-background: #252525;
--search-tab-button-selected-border-top-color: #0089ff;
--search-tab-button-selected-background: #353535;
- --settings-menu-filter: none;
+ --settings-menu-filter: invert(50%);
+ --settings-menu-hover-filter: invert(65%);
--stab-background-color: #314559;
--stab-code-color: #e6e1cf;
--code-highlight-kw-color: #ab8ac1;
@@ -2777,7 +2875,8 @@ Original by Dempfi (https://github.com/dempfi/ayu)
--search-tab-button-not-selected-background: transparent !important;
--search-tab-button-selected-border-top-color: none;
--search-tab-button-selected-background: #141920 !important;
- --settings-menu-filter: invert(100%);
+ --settings-menu-filter: invert(70%);
+ --settings-menu-hover-filter: invert(100%);
--stab-background-color: #314559;
--stab-code-color: #e6e1cf;
--code-highlight-kw-color: #ff7733;
diff --git a/src/librustdoc/html/static/js/main.js b/src/librustdoc/html/static/js/main.js
index 858753a1917d8..53326f0fcadf1 100644
--- a/src/librustdoc/html/static/js/main.js
+++ b/src/librustdoc/html/static/js/main.js
@@ -22,14 +22,14 @@ function hideMain() {
}
function showMain() {
- removeClass(document.getElementById(MAIN_ID), "hidden");
-}
-
-function blurHandler(event, parentElem, hideCallback) {
- if (!parentElem.contains(document.activeElement) &&
- !parentElem.contains(event.relatedTarget)
- ) {
- hideCallback();
+ const main = document.getElementById(MAIN_ID);
+ removeClass(main, "hidden");
+ const mainHeading = main.querySelector(".main-heading");
+ if (mainHeading && searchState.rustdocToolbar) {
+ if (searchState.rustdocToolbar.parentElement) {
+ searchState.rustdocToolbar.parentElement.removeChild(searchState.rustdocToolbar);
+ }
+ mainHeading.appendChild(searchState.rustdocToolbar);
}
}
@@ -167,6 +167,14 @@ function switchDisplayedElement(elemToDisplay) {
el.appendChild(elemToDisplay);
hideMain();
removeClass(el, "hidden");
+
+ const mainHeading = elemToDisplay.querySelector(".main-heading");
+ if (mainHeading && searchState.rustdocToolbar) {
+ if (searchState.rustdocToolbar.parentElement) {
+ searchState.rustdocToolbar.parentElement.removeChild(searchState.rustdocToolbar);
+ }
+ mainHeading.appendChild(searchState.rustdocToolbar);
+ }
}
function browserSupportsHistoryApi() {
@@ -194,33 +202,36 @@ function preLoadCss(cssUrl) {
document.head.append(script);
}
- getSettingsButton().onclick = event => {
- if (event.ctrlKey || event.altKey || event.metaKey) {
- return;
- }
- window.hideAllModals(false);
- addClass(getSettingsButton(), "rotate");
- event.preventDefault();
- // Sending request for the CSS and the JS files at the same time so it will
- // hopefully be loaded when the JS will generate the settings content.
- loadScript(getVar("static-root-path") + getVar("settings-js"));
- // Pre-load all theme CSS files, so that switching feels seamless.
- //
- // When loading settings.html as a standalone page, the equivalent HTML is
- // generated in context.rs.
- setTimeout(() => {
- const themes = getVar("themes").split(",");
- for (const theme of themes) {
- // if there are no themes, do nothing
- // "".split(",") == [""]
- if (theme !== "") {
- preLoadCss(getVar("root-path") + theme + ".css");
- }
+ if (getSettingsButton()) {
+ getSettingsButton().onclick = event => {
+ if (event.ctrlKey || event.altKey || event.metaKey) {
+ return;
}
- }, 0);
- };
+ window.hideAllModals(false);
+ addClass(getSettingsButton(), "rotate");
+ event.preventDefault();
+ // Sending request for the CSS and the JS files at the same time so it will
+ // hopefully be loaded when the JS will generate the settings content.
+ loadScript(getVar("static-root-path") + getVar("settings-js"));
+ // Pre-load all theme CSS files, so that switching feels seamless.
+ //
+ // When loading settings.html as a standalone page, the equivalent HTML is
+ // generated in context.rs.
+ setTimeout(() => {
+ const themes = getVar("themes").split(",");
+ for (const theme of themes) {
+ // if there are no themes, do nothing
+ // "".split(",") == [""]
+ if (theme !== "") {
+ preLoadCss(getVar("root-path") + theme + ".css");
+ }
+ }
+ }, 0);
+ };
+ }
window.searchState = {
+ rustdocToolbar: document.querySelector("rustdoc-toolbar"),
loadingText: "Loading search results...",
input: document.getElementsByClassName("search-input")[0],
outputElement: () => {
@@ -919,8 +930,7 @@ function preLoadCss(cssUrl) {
e.open = true;
}
});
- innerToggle.title = "collapse all docs";
- innerToggle.children[0].innerText = "\u2212"; // "\u2212" is "−" minus sign
+ innerToggle.children[0].innerText = "Summary";
}
function collapseAllDocs() {
@@ -934,8 +944,7 @@ function preLoadCss(cssUrl) {
e.open = false;
}
});
- innerToggle.title = "expand all docs";
- innerToggle.children[0].innerText = "+";
+ innerToggle.children[0].innerText = "Show all";
}
function toggleAllDocs() {
@@ -1328,7 +1337,13 @@ function preLoadCss(cssUrl) {
}
function helpBlurHandler(event) {
- blurHandler(event, getHelpButton(), window.hidePopoverMenus);
+ if (!getHelpButton().contains(document.activeElement) &&
+ !getHelpButton().contains(event.relatedTarget) &&
+ !getSettingsButton().contains(document.activeElement) &&
+ !getSettingsButton().contains(event.relatedTarget)
+ ) {
+ window.hidePopoverMenus();
+ }
}
function buildHelpMenu() {
@@ -1431,9 +1446,13 @@ href="https://doc.rust-lang.org/${channel}/rustdoc/read-documentation/search.htm
* Hide all the popover menus.
*/
window.hidePopoverMenus = () => {
- onEachLazy(document.querySelectorAll(".search-form .popover"), elem => {
+ onEachLazy(document.querySelectorAll("rustdoc-toolbar .popover"), elem => {
elem.style.display = "none";
});
+ const button = getHelpButton();
+ if (button) {
+ removeClass(button, "help-open");
+ }
};
/**
@@ -1458,7 +1477,9 @@ href="https://doc.rust-lang.org/${channel}/rustdoc/read-documentation/search.htm
function showHelp() {
// Prevent `blur` events from being dispatched as a result of closing
// other modals.
- getHelpButton().querySelector("a").focus();
+ const button = getHelpButton();
+ addClass(button, "help-open");
+ button.querySelector("a").focus();
const menu = getHelpMenu(true);
if (menu.style.display === "none") {
window.hideAllModals();
@@ -1466,28 +1487,15 @@ href="https://doc.rust-lang.org/${channel}/rustdoc/read-documentation/search.htm
}
}
+ const helpLink = document.querySelector(`#${HELP_BUTTON_ID} > a`);
if (isHelpPage) {
- showHelp();
- document.querySelector(`#${HELP_BUTTON_ID} > a`).addEventListener("click", event => {
- // Already on the help page, make help button a no-op.
- const target = event.target;
- if (target.tagName !== "A" ||
- target.parentElement.id !== HELP_BUTTON_ID ||
- event.ctrlKey ||
- event.altKey ||
- event.metaKey) {
- return;
- }
- event.preventDefault();
- });
- } else {
- document.querySelector(`#${HELP_BUTTON_ID} > a`).addEventListener("click", event => {
+ buildHelpMenu();
+ } else if (helpLink) {
+ helpLink.addEventListener("click", event => {
// By default, have help button open docs in a popover.
// If user clicks with a moderator, though, use default browser behavior,
// probably opening in a new window or tab.
- const target = event.target;
- if (target.tagName !== "A" ||
- target.parentElement.id !== HELP_BUTTON_ID ||
+ if (!helpLink.contains(helpLink) ||
event.ctrlKey ||
event.altKey ||
event.metaKey) {
diff --git a/src/librustdoc/html/static/js/search.js b/src/librustdoc/html/static/js/search.js
index 4da0bbc787d9e..15b1046a27cdb 100644
--- a/src/librustdoc/html/static/js/search.js
+++ b/src/librustdoc/html/static/js/search.js
@@ -3605,7 +3605,8 @@ async function showResults(results, go_to_first, filterCrates) {
crates += "</select></div>";
}
- let output = `<h1 class="search-results-title">Results${crates}</h1>`;
+ let output = `<div class="main-heading">\
+ <h1 class="search-results-title">Results${crates}</h1></div>`;
if (results.query.error !== null) {
const error = results.query.error;
error.forEach((value, index) => {
@@ -3662,6 +3663,9 @@ async function showResults(results, go_to_first, filterCrates) {
resultsElem.appendChild(ret_returned[0]);
search.innerHTML = output;
+ if (searchState.rustdocToolbar) {
+ search.querySelector(".main-heading").appendChild(searchState.rustdocToolbar);
+ }
const crateSearch = document.getElementById("crate-search");
if (crateSearch) {
crateSearch.addEventListener("input", updateCrate);
diff --git a/src/librustdoc/html/static/js/settings.js b/src/librustdoc/html/static/js/settings.js
index c52a19ef98738..183663b94fc28 100644
--- a/src/librustdoc/html/static/js/settings.js
+++ b/src/librustdoc/html/static/js/settings.js
@@ -1,7 +1,7 @@
// Local js definitions:
/* global getSettingValue, updateLocalStorage, updateTheme */
-/* global addClass, removeClass, onEach, onEachLazy, blurHandler */
-/* global MAIN_ID, getVar, getSettingsButton */
+/* global addClass, removeClass, onEach, onEachLazy */
+/* global MAIN_ID, getVar, getSettingsButton, getHelpButton */
"use strict";
@@ -267,15 +267,16 @@
}
function settingsBlurHandler(event) {
- blurHandler(event, getSettingsButton(), window.hidePopoverMenus);
+ if (!getHelpButton().contains(document.activeElement) &&
+ !getHelpButton().contains(event.relatedTarget) &&
+ !getSettingsButton().contains(document.activeElement) &&
+ !getSettingsButton().contains(event.relatedTarget)
+ ) {
+ window.hidePopoverMenus();
+ }
}
- if (isSettingsPage) {
- // We replace the existing "onclick" callback to do nothing if clicked.
- getSettingsButton().onclick = event => {
- event.preventDefault();
- };
- } else {
+ if (!isSettingsPage) {
// We replace the existing "onclick" callback.
const settingsButton = getSettingsButton();
const settingsMenu = document.getElementById("settings");
diff --git a/src/librustdoc/html/static/js/storage.js b/src/librustdoc/html/static/js/storage.js
index d75fb7a7fb5ab..344743c87edd3 100644
--- a/src/librustdoc/html/static/js/storage.js
+++ b/src/librustdoc/html/static/js/storage.js
@@ -274,16 +274,29 @@ class RustdocSearchElement extends HTMLElement {
spellcheck="false"
placeholder="Type ‘S’ or ‘/’ to search, ‘?’ for more options…"
type="search">
- <div id="help-button" tabindex="-1">
- <a href="${rootPath}help.html" title="help">?</a>
- </div>
- <div id="settings-menu" tabindex="-1">
- <a href="${rootPath}settings.html" title="settings">
- Settings
- </a>
- </div>
</form>
</nav>`;
}
}
window.customElements.define("rustdoc-search", RustdocSearchElement);
+class RustdocToolbarElement extends HTMLElement {
+ constructor() {
+ super();
+ }
+ connectedCallback() {
+ // Avoid replacing the children after they're already here.
+ if (this.firstElementChild) {
+ return;
+ }
+ const rootPath = getVar("root-path");
+ this.innerHTML = `
+ <div id="settings-menu" tabindex="-1">
+ <a href="${rootPath}settings.html"><span class="label">Settings</span></a>
+ </div>
+ <button id="toggle-all-docs"><span class="label">Summary</span></button>
+ <div id="help-button" tabindex="-1">
+ <a href="${rootPath}help.html"><span class="label">Help</span></a>
+ </div>`;
+ }
+}
+window.customElements.define("rustdoc-toolbar", RustdocToolbarElement);
diff --git a/src/librustdoc/html/templates/print_item.html b/src/librustdoc/html/templates/print_item.html
index 76e770453b6ea..1b8c8293088fd 100644
--- a/src/librustdoc/html/templates/print_item.html
+++ b/src/librustdoc/html/templates/print_item.html
@@ -10,17 +10,16 @@ <h1>
Copy item path {# #}
</button> {# #}
</h1> {# #}
- <span class="out-of-band">
+ <rustdoc-toolbar></rustdoc-toolbar>
+ <span class="sub-heading">
{% if !stability_since_raw.is_empty() %}
- {{ stability_since_raw|safe +}} · {#+ #}
+ {{ stability_since_raw|safe +}}
{% endif %}
{% match src_href %}
{% when Some with (href) %}
- <a class="src" href="{{href|safe}}">source</a> · {#+ #}
+ {% if !stability_since_raw.is_empty() +%} · {%+ endif %}
+ <a class="src" href="{{href|safe}}">source</a> {#+ #}
{% else %}
{% endmatch %}
- <button id="toggle-all-docs" title="collapse all docs"> {# #}
- [<span>−</span>] {# #}
- </button> {# #}
- </span> {# #}
+ </span>
</div> {# #}
diff --git a/src/librustdoc/html/templates/source.html b/src/librustdoc/html/templates/source.html
index 60a47f1b5de7d..9daa0cf8ff688 100644
--- a/src/librustdoc/html/templates/source.html
+++ b/src/librustdoc/html/templates/source.html
@@ -1,4 +1,15 @@
-<div class="example-wrap">
+{% match file_path %}
+{% when Some with ((path, name)) %}
+<div class="main-heading"> {# #}
+ <h1> {# #}
+ <div class="sub-heading">{{path}}/</div>
+ {{name}}
+ </h1> {# #}
+ <rustdoc-toolbar></rustdoc-toolbar> {# #}
+</div>
+{% else %}
+{% endmatch %}
+<div class="example-wrap"> {# #}
{# https://developers.google.com/search/docs/crawling-indexing/robots-meta-tag#data-nosnippet-attr
Do not show "1 2 3 4 5 ..." in web search results. #}
<div data-nosnippet><pre class="src-line-numbers">
diff --git a/src/librustdoc/lib.rs b/src/librustdoc/lib.rs
index 6649e1721a48b..5f303d96c40df 100644
--- a/src/librustdoc/lib.rs
+++ b/src/librustdoc/lib.rs
@@ -10,6 +10,7 @@
#![feature(iter_intersperse)]
#![feature(let_chains)]
#![feature(never_type)]
+#![feature(os_str_display)]
#![feature(round_char_boundary)]
#![feature(test)]
#![feature(type_alias_impl_trait)]
diff --git a/src/tools/compiletest/src/runtest.rs b/src/tools/compiletest/src/runtest.rs
index c18f569e52867..d24dd334a3438 100644
--- a/src/tools/compiletest/src/runtest.rs
+++ b/src/tools/compiletest/src/runtest.rs
@@ -2739,7 +2739,7 @@ impl<'test> TestCx<'test> {
#[rustfmt::skip]
let tidy_args = [
- "--new-blocklevel-tags", "rustdoc-search",
+ "--new-blocklevel-tags", "rustdoc-search,rustdoc-toolbar",
"--indent", "yes",
"--indent-spaces", "2",
"--wrap", "0",
diff --git a/src/tools/html-checker/main.rs b/src/tools/html-checker/main.rs
index ecfbb1955e779..5cdc4d53ab500 100644
--- a/src/tools/html-checker/main.rs
+++ b/src/tools/html-checker/main.rs
@@ -31,7 +31,7 @@ fn check_html_file(file: &Path) -> usize {
.arg("--mute-id") // this option is useful in case we want to mute more warnings
.arg("yes")
.arg("--new-blocklevel-tags")
- .arg("rustdoc-search") // custom elements
+ .arg("rustdoc-search,rustdoc-toolbar") // custom elements
.arg("--mute")
.arg(&to_mute_s)
.arg(file);
diff --git a/tests/rustdoc-gui/help-page.goml b/tests/rustdoc-gui/help-page.goml
index f1a2675128ce4..6d6e353ae362b 100644
--- a/tests/rustdoc-gui/help-page.goml
+++ b/tests/rustdoc-gui/help-page.goml
@@ -4,7 +4,7 @@ set-window-size: (1000, 1000) // Try desktop size first.
wait-for: "#help"
assert-css: ("#help", {"display": "block"})
assert-css: ("#help dd", {"font-size": "16px"})
-click: "#help-button > a"
+assert-false: "#help-button > a"
assert-css: ("#help", {"display": "block"})
compare-elements-property: (".sub", "#help", ["offsetWidth"])
compare-elements-position: (".sub", "#help", ["x"])
@@ -50,7 +50,8 @@ call-function: ("check-colors", {
})
// This test ensures that opening the help popover without switching pages works.
-go-to: "file://" + |DOC_PATH| + "/test_docs/index.html"
+go-to: "file://" + |DOC_PATH| + "/test_docs/index.html?search=a"
+wait-for: "#search-tabs" // Waiting for the search.js to load.
set-window-size: (1000, 1000) // Only supported on desktop.
assert-false: "#help"
click: "#help-button > a"
@@ -62,7 +63,8 @@ compare-elements-property-false: (".sub", "#help", ["offsetWidth"])
compare-elements-position-false: (".sub", "#help", ["x"])
// This test ensures that the "the rustdoc book" anchor link within the help popover works.
-go-to: "file://" + |DOC_PATH| + "/test_docs/index.html"
+go-to: "file://" + |DOC_PATH| + "/test_docs/index.html?search=a"
+wait-for: "#search-tabs" // Waiting for the search.js to load.
set-window-size: (1000, 1000) // Popover only appears when the screen width is >700px.
assert-false: "#help"
click: "#help-button > a"
diff --git a/tests/rustdoc-gui/item-info.goml b/tests/rustdoc-gui/item-info.goml
index 7a0194c6cc1f6..debda8d06c2c7 100644
--- a/tests/rustdoc-gui/item-info.goml
+++ b/tests/rustdoc-gui/item-info.goml
@@ -20,7 +20,7 @@ store-position: (
{"x": second_line_x, "y": second_line_y},
)
assert: |first_line_x| != |second_line_x| && |first_line_x| == 516 && |second_line_x| == 272
-assert: |first_line_y| != |second_line_y| && |first_line_y| == 688 && |second_line_y| == 711
+assert: |first_line_y| != |second_line_y| && |first_line_y| == 715 && |second_line_y| == 738
// Now we ensure that they're not rendered on the same line.
set-window-size: (1100, 800)
diff --git a/tests/rustdoc-gui/mobile.goml b/tests/rustdoc-gui/mobile.goml
index e576385cd5370..a9eee53dd1d50 100644
--- a/tests/rustdoc-gui/mobile.goml
+++ b/tests/rustdoc-gui/mobile.goml
@@ -5,23 +5,8 @@ set-window-size: (400, 600)
set-font-size: 18
wait-for: 100 // wait a bit for the resize and the font-size change to be fully taken into account.
-// The out-of-band info (source, stable version, collapse) should be below the
-// h1 when the screen gets narrow enough.
-assert-css: (".main-heading", {
- "display": "flex",
- "flex-direction": "column"
-})
-
assert-property: (".mobile-topbar h2", {"offsetHeight": 33})
-// Note: We can't use assert-text here because the 'Since' is set by CSS and
-// is therefore not part of the DOM.
-assert-css: (".content .out-of-band .since::before", { "content": "\"Since \"" })
-
-set-window-size: (1000, 1000)
-wait-for: 100 // wait a bit for the resize to be fully taken into account.
-assert-css-false: (".content .out-of-band .since::before", { "content": "\"Since \"" })
-
// On the settings page, the theme buttons should not line-wrap. Instead, they should
// all be placed as a group on a line below the setting name "Theme."
go-to: "file://" + |DOC_PATH| + "/settings.html"
diff --git a/tests/rustdoc-gui/notable-trait.goml b/tests/rustdoc-gui/notable-trait.goml
index e2a8a43007eb0..b8fa26b17f6b6 100644
--- a/tests/rustdoc-gui/notable-trait.goml
+++ b/tests/rustdoc-gui/notable-trait.goml
@@ -248,12 +248,13 @@ click: "//*[@id='method.create_an_iterator_from_read']//*[@class='tooltip']"
assert-count: ("//*[@class='tooltip popover']", 1)
assert-false: "//*[@class='sidebar shown']"
-// Also check the focus handling for the help button.
+// Also check the focus handling for the settings button.
set-window-size: (1100, 600)
reload:
assert-count: ("//*[@class='tooltip popover']", 0)
click: "//*[@id='method.create_an_iterator_from_read']//*[@class='tooltip']"
assert-count: ("//*[@class='tooltip popover']", 1)
-click: "#help-button a"
+click: "#settings-menu a"
+wait-for: "#settings"
assert-count: ("//*[@class='tooltip popover']", 0)
assert-false: "#method\.create_an_iterator_from_read .tooltip:focus"
diff --git a/tests/rustdoc-gui/pocket-menu.goml b/tests/rustdoc-gui/pocket-menu.goml
index ec31f492abe7c..4a062fec7516d 100644
--- a/tests/rustdoc-gui/pocket-menu.goml
+++ b/tests/rustdoc-gui/pocket-menu.goml
@@ -1,6 +1,7 @@
// This test ensures that the "pocket menus" are working as expected.
include: "utils.goml"
-go-to: "file://" + |DOC_PATH| + "/test_docs/index.html"
+go-to: "file://" + |DOC_PATH| + "/test_docs/index.html?search=test"
+wait-for: "#crate-search"
// First we check that the help menu doesn't exist yet.
assert-false: "#help-button .popover"
// Then we display the help menu.
diff --git a/tests/rustdoc-gui/scrape-examples-layout.goml b/tests/rustdoc-gui/scrape-examples-layout.goml
index 6bea352bce4bb..55187a3e59647 100644
--- a/tests/rustdoc-gui/scrape-examples-layout.goml
+++ b/tests/rustdoc-gui/scrape-examples-layout.goml
@@ -72,8 +72,8 @@ click: ".scraped-example .button-holder .expand"
store-value: (offset_y, 4)
// First with desktop
-assert-position: (".scraped-example", {"y": 226})
-assert-position: (".scraped-example .prev", {"y": 226 + |offset_y|})
+assert-position: (".scraped-example", {"y": 253})
+assert-position: (".scraped-example .prev", {"y": 253 + |offset_y|})
// Gradient background should be at the top of the code block.
assert-css: (".scraped-example .example-wrap::before", {"top": "0px"})
diff --git a/tests/rustdoc-gui/search-form-elements.goml b/tests/rustdoc-gui/search-form-elements.goml
index 63d2ceb3e7c1c..efe39f7a9d1bf 100644
--- a/tests/rustdoc-gui/search-form-elements.goml
+++ b/tests/rustdoc-gui/search-form-elements.goml
@@ -1,13 +1,14 @@
// This test ensures that the elements in ".search-form" have the expected display.
include: "utils.goml"
-go-to: "file://" + |DOC_PATH| + "/test_docs/index.html"
+go-to: "file://" + |DOC_PATH| + "/test_docs/index.html?search=test"
+wait-for: "#search-tabs" // Waiting for the search.js to load.
show-text: true
define-function: (
"check-search-colors",
[
theme, border, background, search_input_color, search_input_border_focus,
- menu_button_border, menu_button_a_color, menu_button_a_border_hover, menu_a_color,
+ menu_button_a_color, menu_button_a_border_hover, menu_a_color,
],
block {
call-function: ("switch-theme", {"theme": |theme|})
@@ -29,30 +30,22 @@ define-function: (
"color": |search_input_color|,
},
)
- assert-css: (
- "#help-button",
- {"border-color": |menu_button_border|},
- )
assert-css: (
"#help-button > a",
{
"color": |menu_button_a_color|,
- "border-color": |border|,
- "background-color": |background|,
+ "border-color": "transparent",
+ "background-color": "transparent",
},
)
// Hover help button.
move-cursor-to: "#help-button"
- assert-css: (
- "#help-button:hover",
- {"border-color": |menu_button_border|},
- )
assert-css: (
"#help-button > a",
{
"color": |menu_button_a_color|,
"border-color": |menu_button_a_border_hover|,
- "background-color": |background|,
+ "background-color": "transparent",
},
)
// Link color inside
@@ -63,30 +56,22 @@ define-function: (
"color": |menu_a_color|,
},
)
- assert-css: (
- "#settings-menu",
- {"border-color": |menu_button_border|},
- )
assert-css: (
"#settings-menu > a",
{
"color": |menu_button_a_color|,
- "border-color": |border|,
- "background-color": |background|,
+ "border-color": "transparent",
+ "background-color": "transparent",
},
)
// Hover settings menu.
move-cursor-to: "#settings-menu"
- assert-css: (
- "#settings-menu:hover",
- {"border-color": |menu_button_border|},
- )
assert-css: (
"#settings-menu:hover > a",
{
"color": |menu_button_a_color|,
"border-color": |menu_button_a_border_hover|,
- "background-color": |background|,
+ "background-color": "transparent",
},
)
},
@@ -100,8 +85,7 @@ call-function: (
"background": "#141920",
"search_input_color": "#fff",
"search_input_border_focus": "#5c6773",
- "menu_button_border": "#c5c5c5",
- "menu_button_a_color": "#fff",
+ "menu_button_a_color": "#c5c5c5",
"menu_button_a_border_hover": "#e0e0e0",
"menu_a_color": "#39afd7",
}
@@ -114,8 +98,7 @@ call-function: (
"background": "#f0f0f0",
"search_input_color": "#111",
"search_input_border_focus": "#008dfd",
- "menu_button_border": "#ddd",
- "menu_button_a_color": "#000",
+ "menu_button_a_color": "#ddd",
"menu_button_a_border_hover": "#ffb900",
"menu_a_color": "#d2991d",
}
@@ -128,7 +111,6 @@ call-function: (
"background": "#fff",
"search_input_color": "#000",
"search_input_border_focus": "#66afe9",
- "menu_button_border": "#000",
"menu_button_a_color": "#000",
"menu_button_a_border_hover": "#717171",
"menu_a_color": "#3873ad",
diff --git a/tests/rustdoc-gui/search-result-display.goml b/tests/rustdoc-gui/search-result-display.goml
index 3ca46f3c56931..c69ca59d44a7c 100644
--- a/tests/rustdoc-gui/search-result-display.goml
+++ b/tests/rustdoc-gui/search-result-display.goml
@@ -51,7 +51,10 @@ set-window-size: (900, 900)
// First we check the current width, height and position.
assert-css: ("#crate-search", {"width": "223px"})
-assert-css: (".search-results-title", {"height": "50px", "width": "640px"})
+store-size: (".search-results-title", {
+ "height": search_results_title_height,
+ "width": search_results_title_width,
+})
assert-css: ("#search", {"width": "640px"})
// Then we update the text of one of the `<option>`.
@@ -61,10 +64,12 @@ set-text: (
)
// Then we compare again to confirm the height didn't change.
-assert-size: ("#crate-search", {"width": 527})
-assert-size: (".search-results-title", {"height": 50, "width": 640})
-// And we check that the `<select>` isn't bigger than its container (".search-results-title").
+assert-size: ("#crate-search", {"width": 760})
+assert-size: (".search-results-title", {
+ "height": |search_results_title_height|,
+})
assert-css: ("#search", {"width": "640px"})
+assert: |search_results_title_width| <= 640
// Now checking that the crate filter is working as expected too.
show-text: true
diff --git a/tests/rustdoc-gui/settings-button.goml b/tests/rustdoc-gui/settings-button.goml
index c38a537e04782..d78034769e245 100644
--- a/tests/rustdoc-gui/settings-button.goml
+++ b/tests/rustdoc-gui/settings-button.goml
@@ -11,8 +11,8 @@ define-function: (
call-function: ("switch-theme", {"theme": |theme|})
assert-css: ("#settings-menu > a::before", {
"filter": |filter|,
- "width": "22px",
- "height": "22px",
+ "width": "18px",
+ "height": "18px",
})
}
)
@@ -23,9 +23,9 @@ call-function: ("check-image", {
})
call-function: ("check-image", {
"theme": "dark",
- "filter": "none",
+ "filter": "invert(0.65)",
})
call-function: ("check-image", {
"theme": "light",
- "filter": "none",
+ "filter": "invert(0.35)",
})
diff --git a/tests/rustdoc-gui/settings.goml b/tests/rustdoc-gui/settings.goml
index 3f4f2946bf5af..1d93c07f9ec5c 100644
--- a/tests/rustdoc-gui/settings.goml
+++ b/tests/rustdoc-gui/settings.goml
@@ -305,6 +305,7 @@ wait-for-css: ("#help-button .popover", {"display": "block"})
// Now we go to the settings page to check that the CSS is loaded as expected.
go-to: "file://" + |DOC_PATH| + "/settings.html"
wait-for: "#settings"
+assert-false: "#settings-menu"
assert-css: (".setting-radio", {"cursor": "pointer"})
assert-attribute-false: ("#settings", {"class": "popover"}, CONTAINS)
@@ -324,6 +325,5 @@ javascript: true
show-text: true
reload:
set-window-size: (300, 1000)
-click: "#settings-menu"
wait-for: "#settings"
assert-css: (".setting-radio", {"cursor": "pointer"})
diff --git a/tests/rustdoc-gui/shortcuts.goml b/tests/rustdoc-gui/shortcuts.goml
index 2c61ee5428b86..5a6171d6f761a 100644
--- a/tests/rustdoc-gui/shortcuts.goml
+++ b/tests/rustdoc-gui/shortcuts.goml
@@ -13,19 +13,19 @@ press-key: "Escape"
assert-css: ("#help-button .popover", {"display": "none"})
// Checking doc collapse and expand.
// It should be displaying a "-":
-assert-text: ("#toggle-all-docs", "[−]")
+assert-text: ("#toggle-all-docs", "Summary")
press-key: "-"
-wait-for-text: ("#toggle-all-docs", "[+]")
+wait-for-text: ("#toggle-all-docs", "Show all")
assert-attribute: ("#toggle-all-docs", {"class": "will-expand"})
// Pressing it again shouldn't do anything.
press-key: "-"
-assert-text: ("#toggle-all-docs", "[+]")
+assert-text: ("#toggle-all-docs", "Show all")
assert-attribute: ("#toggle-all-docs", {"class": "will-expand"})
// Expanding now.
press-key: "+"
-wait-for-text: ("#toggle-all-docs", "[−]")
+wait-for-text: ("#toggle-all-docs", "Summary")
assert-attribute: ("#toggle-all-docs", {"class": ""})
// Pressing it again shouldn't do anything.
press-key: "+"
-assert-text: ("#toggle-all-docs", "[−]")
+assert-text: ("#toggle-all-docs", "Summary")
assert-attribute: ("#toggle-all-docs", {"class": ""})
diff --git a/tests/rustdoc-gui/sidebar-source-code-display.goml b/tests/rustdoc-gui/sidebar-source-code-display.goml
index 67152afbbaa33..99810cd786335 100644
--- a/tests/rustdoc-gui/sidebar-source-code-display.goml
+++ b/tests/rustdoc-gui/sidebar-source-code-display.goml
@@ -141,7 +141,7 @@ click: "#sidebar-button"
wait-for-css: (".src .sidebar > *", {"visibility": "hidden"})
// We scroll to line 117 to change the scroll position.
scroll-to: '//*[@id="117"]'
-store-value: (y_offset, "2493")
+store-value: (y_offset, "2567")
assert-window-property: {"pageYOffset": |y_offset|}
// Expanding the sidebar...
click: "#sidebar-button"
diff --git a/tests/rustdoc-gui/sidebar.goml b/tests/rustdoc-gui/sidebar.goml
index 7794cdbe9e264..bb7453fdeacf1 100644
--- a/tests/rustdoc-gui/sidebar.goml
+++ b/tests/rustdoc-gui/sidebar.goml
@@ -160,12 +160,12 @@ click: "//ul[@class='block mod']/preceding-sibling::h3/a"
// PAGE: index.html
assert-css: ("#modules", {"background-color": "#fdffd3"})
-// Finally, assert that the `[+]/[−]` toggle doesn't affect sidebar width.
+// Finally, assert that the Summary toggle doesn't affect sidebar width.
click: "#toggle-all-docs"
-assert-text: ("#toggle-all-docs", "[+]")
+assert-text: ("#toggle-all-docs", "Show all")
assert-property: (".sidebar", {"clientWidth": "200"})
click: "#toggle-all-docs"
-assert-text: ("#toggle-all-docs", "[−]")
+assert-text: ("#toggle-all-docs", "Summary")
assert-property: (".sidebar", {"clientWidth": "200"})
// Checks that all.html and index.html have their sidebar link in the same place.
diff --git a/tests/rustdoc-gui/source-anchor-scroll.goml b/tests/rustdoc-gui/source-anchor-scroll.goml
index 3508b26a0bf24..ad03fb3d3e8ef 100644
--- a/tests/rustdoc-gui/source-anchor-scroll.goml
+++ b/tests/rustdoc-gui/source-anchor-scroll.goml
@@ -8,13 +8,13 @@ set-window-size: (600, 800)
assert-property: ("html", {"scrollTop": "0"})
click: '//a[text() = "barbar" and @href="#5-7"]'
-assert-property: ("html", {"scrollTop": "123"})
+assert-property: ("html", {"scrollTop": "196"})
click: '//a[text() = "bar" and @href="#28-36"]'
-assert-property: ("html", {"scrollTop": "154"})
+assert-property: ("html", {"scrollTop": "228"})
click: '//a[normalize-space() = "sub_fn" and @href="#2-4"]'
-assert-property: ("html", {"scrollTop": "51"})
+assert-property: ("html", {"scrollTop": "124"})
// We now check that clicking on lines doesn't change the scroll
// Extra information: the "sub_fn" function header is on line 1.
click: '//*[@id="6"]'
-assert-property: ("html", {"scrollTop": "51"})
+assert-property: ("html", {"scrollTop": "124"})
diff --git a/tests/rustdoc-gui/source-code-page.goml b/tests/rustdoc-gui/source-code-page.goml
index 619d2b37d8daf..d9d66f62249c2 100644
--- a/tests/rustdoc-gui/source-code-page.goml
+++ b/tests/rustdoc-gui/source-code-page.goml
@@ -89,9 +89,9 @@ assert-css: (".src-line-numbers", {"text-align": "right"})
// do anything (and certainly not add a `#NaN` to the URL!).
go-to: "file://" + |DOC_PATH| + "/src/test_docs/lib.rs.html"
// We use this assert-position to know where we will click.
-assert-position: ("//*[@id='1']", {"x": 88, "y": 86})
+assert-position: ("//*[@id='1']", {"x": 88, "y": 162})
// We click on the left of the "1" anchor but still in the "src-line-number" `<pre>`.
-click: (87, 77)
+click: (163, 77)
assert-document-property: ({"URL": "/lib.rs.html"}, ENDS_WITH)
// Checking the source code sidebar.
diff --git a/tests/rustdoc-gui/src/theme_css/custom-theme.css b/tests/rustdoc-gui/src/theme_css/custom-theme.css
index 366f09f22b230..934cb973b78dc 100644
--- a/tests/rustdoc-gui/src/theme_css/custom-theme.css
+++ b/tests/rustdoc-gui/src/theme_css/custom-theme.css
@@ -52,6 +52,7 @@
--search-tab-button-selected-border-top-color: #0089ff;
--search-tab-button-selected-background: #fff;
--settings-menu-filter: none;
+ --settings-menu-hover-filter: invert(35%);
--stab-background-color: #fff5d6;
--stab-code-color: #000;
--code-highlight-kw-color: #8959a8;
diff --git a/tests/rustdoc-gui/toggle-docs.goml b/tests/rustdoc-gui/toggle-docs.goml
index 1235ee4b754ce..4607c604eeb3d 100644
--- a/tests/rustdoc-gui/toggle-docs.goml
+++ b/tests/rustdoc-gui/toggle-docs.goml
@@ -2,12 +2,12 @@
include: "utils.goml"
go-to: "file://" + |DOC_PATH| + "/test_docs/index.html"
assert-attribute: ("#main-content > details.top-doc", {"open": ""})
-assert-text: ("#toggle-all-docs", "[−]")
+assert-text: ("#toggle-all-docs", "Summary")
click: "#toggle-all-docs"
wait-for: 50
// This is now collapsed so there shouldn't be the "open" attribute on details.
assert-attribute-false: ("#main-content > details.top-doc", {"open": ""})
-assert-text: ("#toggle-all-docs", "[+]")
+assert-text: ("#toggle-all-docs", "Show all")
assert-css: (
"#main-content > details.top-doc > summary",
{"font-family": '"Fira Sans", Arial, NanumBarunGothic, sans-serif'},
@@ -15,12 +15,12 @@ assert-css: (
click: "#toggle-all-docs"
// Not collapsed anymore so the "open" attribute should be back.
wait-for-attribute: ("#main-content > details.top-doc", {"open": ""})
-assert-text: ("#toggle-all-docs", "[−]")
+assert-text: ("#toggle-all-docs", "Summary")
// Check that it works on non-module pages as well.
go-to: "file://" + |DOC_PATH| + "/test_docs/struct.Foo.html"
// We first check that everything is visible.
-assert-text: ("#toggle-all-docs", "[−]")
+assert-text: ("#toggle-all-docs", "Summary")
assert-attribute: ("#implementations-list details.toggle", {"open": ""}, ALL)
assert-attribute: ("#trait-implementations-list details.toggle", {"open": ""}, ALL)
assert-attribute-false: (
@@ -31,7 +31,7 @@ assert-attribute-false: (
// We collapse them all.
click: "#toggle-all-docs"
-wait-for-text: ("#toggle-all-docs", "[+]")
+wait-for-text: ("#toggle-all-docs", "Show all")
// We check that all <details> are collapsed (except for the impl block ones).
assert-attribute-false: ("details.toggle:not(.implementors-toggle)", {"open": ""}, ALL)
assert-attribute: ("#implementations-list > details.implementors-toggle", {"open": ""})
@@ -43,7 +43,7 @@ assert-attribute-false: (
)
// We open them all again.
click: "#toggle-all-docs"
-wait-for-text: ("#toggle-all-docs", "[−]")
+wait-for-text: ("#toggle-all-docs", "Summary")
assert-attribute: ("details.toggle", {"open": ""}, ALL)
// Checking the toggles style.
diff --git a/tests/rustdoc-gui/type-declation-overflow.goml b/tests/rustdoc-gui/type-declation-overflow.goml
index 8df946c6f39ed..4f8fe78ea4dc6 100644
--- a/tests/rustdoc-gui/type-declation-overflow.goml
+++ b/tests/rustdoc-gui/type-declation-overflow.goml
@@ -51,22 +51,23 @@ store-property: (".mobile-topbar", {"scrollWidth": scrollWidth})
assert-property: (".mobile-topbar", {"clientWidth": |scrollWidth|})
assert-css: (".mobile-topbar h2", {"overflow-x": "hidden"})
-// Check wrapping for top main-heading h1 and out-of-band.
-// On desktop, they wrap when too big.
+// Check that main heading and toolbar go side-by-side, both on desktop and on mobile.
set-window-size: (1100, 800)
go-to: "file://" + |DOC_PATH| + "/lib2/too_long/struct.SuperIncrediblyLongLongLongLongLongLongLongGigaGigaGigaMegaLongLongLongStructName.html"
-compare-elements-position-false: (".main-heading h1", ".main-heading .out-of-band", ["y"])
+compare-elements-position: (".main-heading h1", ".main-heading rustdoc-toolbar", ["y"])
+compare-elements-position-near-false: (".main-heading h1", ".main-heading rustdoc-toolbar", {"x": 550})
go-to: "file://" + |DOC_PATH| + "/lib2/index.html"
-compare-elements-position: (".main-heading h1", ".main-heading .out-of-band", ["y"])
-// make sure there is a gap between them
-compare-elements-position-near-false: (".main-heading h1", ".main-heading .out-of-band", {"x": 550})
+compare-elements-position: (".main-heading h1", ".main-heading rustdoc-toolbar", ["y"])
+compare-elements-position-near-false: (".main-heading h1", ".main-heading rustdoc-toolbar", {"x": 550})
// On mobile, they always wrap.
set-window-size: (600, 600)
go-to: "file://" + |DOC_PATH| + "/lib2/too_long/struct.SuperIncrediblyLongLongLongLongLongLongLongGigaGigaGigaMegaLongLongLongStructName.html"
-compare-elements-position-false: (".main-heading h1", ".main-heading .out-of-band", ["y"])
+compare-elements-position: (".main-heading h1", ".main-heading rustdoc-toolbar", ["y"])
+compare-elements-position-near-false: (".main-heading h1", ".main-heading rustdoc-toolbar", {"x": 200})
go-to: "file://" + |DOC_PATH| + "/lib2/index.html"
-compare-elements-position-false: (".main-heading h1", ".main-heading .out-of-band", ["y"])
+compare-elements-position: (".main-heading h1", ".main-heading rustdoc-toolbar", ["y"])
+compare-elements-position-near-false: (".main-heading h1", ".main-heading rustdoc-toolbar", {"x": 200})
// Now we will check that the scrolling is working.
// First on an item with "hidden methods".
diff --git a/tests/rustdoc/html-no-source.rs b/tests/rustdoc/html-no-source.rs
index 100ab0031f787..248afbd00eff9 100644
--- a/tests/rustdoc/html-no-source.rs
+++ b/tests/rustdoc/html-no-source.rs
@@ -11,14 +11,14 @@
//@ files 'src/foo' '[]'
//@ has foo/fn.foo.html
-//@ has - '//div[@class="main-heading"]/*[@class="out-of-band"]' '1.0.0 · '
-//@ !has - '//div[@class="main-heading"]/*[@class="out-of-band"]' '1.0.0 · source · '
+//@ has - '//div[@class="main-heading"]/*[@class="sub-heading"]' '1.0.0'
+//@ !has - '//div[@class="main-heading"]/*[@class="sub-heading"]' '1.0.0 · source'
#[stable(feature = "bar", since = "1.0")]
pub fn foo() {}
//@ has foo/struct.Bar.html
-//@ has - '//div[@class="main-heading"]/*[@class="out-of-band"]' '1.0.0 · '
-//@ !has - '//div[@class="main-heading"]/*[@class="out-of-band"]' '1.0.0 · source · '
+//@ has - '//div[@class="main-heading"]/*[@class="sub-heading"]' '1.0.0'
+//@ !has - '//div[@class="main-heading"]/*[@class="sub-heading"]' '1.0.0 · source'
#[stable(feature = "bar", since = "1.0")]
pub struct Bar;
diff --git a/tests/rustdoc/source-version-separator.rs b/tests/rustdoc/source-version-separator.rs
index a998c538eed74..9709bbe3c7181 100644
--- a/tests/rustdoc/source-version-separator.rs
+++ b/tests/rustdoc/source-version-separator.rs
@@ -3,7 +3,7 @@
#![feature(staged_api)]
//@ has foo/trait.Bar.html
-//@ has - '//div[@class="main-heading"]/*[@class="out-of-band"]' '1.0.0 · source · '
+//@ has - '//div[@class="main-heading"]/*[@class="sub-heading"]' '1.0.0 · source'
#[stable(feature = "bar", since = "1.0")]
pub trait Bar {
//@ has - '//*[@id="tymethod.foo"]/*[@class="rightside"]' '3.0.0 · source'
@@ -14,7 +14,7 @@ pub trait Bar {
//@ has - '//div[@id="implementors-list"]//*[@class="rightside"]' '4.0.0 · source'
//@ has foo/struct.Foo.html
-//@ has - '//div[@class="main-heading"]/*[@class="out-of-band"]' '1.0.0 · source · '
+//@ has - '//div[@class="main-heading"]/*[@class="sub-heading"]' '1.0.0 · source'
#[stable(feature = "baz", since = "1.0")]
pub struct Foo;
diff --git a/tests/rustdoc/version-separator-without-source.rs b/tests/rustdoc/version-separator-without-source.rs
index e439681484c36..7cd1780f1d30e 100644
--- a/tests/rustdoc/version-separator-without-source.rs
+++ b/tests/rustdoc/version-separator-without-source.rs
@@ -4,14 +4,14 @@
#![crate_name = "foo"]
//@ has foo/fn.foo.html
-//@ has - '//div[@class="main-heading"]/*[@class="out-of-band"]' '1.0.0 · '
-//@ !has - '//div[@class="main-heading"]/*[@class="out-of-band"]' '1.0.0 · source · '
+//@ has - '//div[@class="main-heading"]/*[@class="sub-heading"]' '1.0.0'
+//@ !has - '//div[@class="main-heading"]/*[@class="sub-heading"]' '1.0.0 · source'
#[stable(feature = "bar", since = "1.0")]
pub fn foo() {}
//@ has foo/struct.Bar.html
-//@ has - '//div[@class="main-heading"]/*[@class="out-of-band"]' '1.0.0 · '
-//@ !has - '//div[@class="main-heading"]/*[@class="out-of-band"]' '1.0.0 · source · '
+//@ has - '//div[@class="main-heading"]/*[@class="sub-heading"]' '1.0.0'
+//@ !has - '//div[@class="main-heading"]/*[@class="sub-heading"]' '1.0.0 · source'
#[stable(feature = "bar", since = "1.0")]
pub struct Bar;
From 5b1b2e97e36c4966b9c6c30d5679f6da76503fc7 Mon Sep 17 00:00:00 2001
From: Michael Howell <michael@notriddle.com>
Date: Mon, 2 Sep 2024 19:42:28 -0700
Subject: [PATCH 02/12] rustdoc: make the header show all three buttons
This tweaks it to use less space for the breadcrumbs.
---
src/librustdoc/html/static/css/rustdoc.css | 71 ++++++++++++-------
src/librustdoc/html/static/js/main.js | 8 +++
src/librustdoc/html/static/js/search.js | 8 +--
src/librustdoc/html/static/js/storage.js | 4 +-
src/librustdoc/html/templates/print_item.html | 13 ++--
tests/rustdoc-gui/anchors.goml | 5 +-
tests/rustdoc-gui/item-info.goml | 2 +-
tests/rustdoc-gui/scrape-examples-layout.goml | 8 +--
tests/rustdoc-gui/search-filter.goml | 5 +-
tests/rustdoc-gui/search-result-display.goml | 4 +-
.../search-result-go-to-first.goml | 3 +-
.../sidebar-source-code-display.goml | 2 +-
tests/rustdoc-gui/source-anchor-scroll.goml | 8 +--
tests/rustdoc-gui/source-code-page.goml | 14 ++--
.../src/theme_css/custom-theme.css | 1 +
tests/rustdoc-gui/toggle-click-deadspace.goml | 3 +-
tests/rustdoc-gui/toggle-docs-mobile.goml | 12 ++--
tests/rustdoc/empty-mod-private.rs | 9 ++-
tests/rustdoc/empty-mod-public.rs | 9 ++-
.../inline_cross/renamed-via-module.rs | 12 ++--
tests/rustdoc/keyword.rs | 1 -
tests/rustdoc/primitive-reference.rs | 1 -
tests/rustdoc/primitive-slice-auto-trait.rs | 3 +-
tests/rustdoc/primitive-tuple-auto-trait.rs | 3 +-
tests/rustdoc/primitive-unit-auto-trait.rs | 3 +-
tests/rustdoc/titles.rs | 44 +++++++-----
26 files changed, 154 insertions(+), 102 deletions(-)
diff --git a/src/librustdoc/html/static/css/rustdoc.css b/src/librustdoc/html/static/css/rustdoc.css
index 2a9b4c9588380..fe5d35cad4906 100644
--- a/src/librustdoc/html/static/css/rustdoc.css
+++ b/src/librustdoc/html/static/css/rustdoc.css
@@ -177,12 +177,21 @@ h1, h2, h3, h4 {
position: relative;
display: grid;
grid-template-areas:
+ "main-heading-breadcrumbs main-heading-breadcrumbs"
"main-heading-h1 main-heading-toolbar"
"main-heading-sub-heading main-heading-toolbar";
grid-template-columns: 1fr max-content;
+ grid-template-rows: 25px min-content min-content;
padding-bottom: 6px;
margin-bottom: 15px;
}
+.rustdoc-breadcrumbs {
+ grid-area: main-heading-breadcrumbs;
+ height: 25px;
+ line-height: 1.25;
+ display: flex;
+ align-items: end;
+}
/* The only headings that get underlines are:
Markdown-generated headings within the top-doc
Rustdoc-generated h2 section headings (e.g. "Implementations", "Required Methods", etc)
@@ -228,6 +237,7 @@ a.src,
rustdoc-toolbar,
summary.hideme,
.scraped-example-list,
+.rustdoc-breadcrumbs,
/* This selector is for the items listed in the "all items" page. */
ul.all-items {
font-family: "Fira Sans", Arial, NanumBarunGothic, sans-serif;
@@ -890,9 +900,10 @@ both the code example and the line numbers, so we need to remove the radius in t
}
.sub-heading {
+ font-size: 1rem;
flex-grow: 0;
- font-size: 1.125rem;
grid-area: main-heading-sub-heading;
+ line-height: 1.25;
}
.main-heading rustdoc-toolbar, .main-heading .out-of-band {
@@ -953,7 +964,7 @@ div.where {
nav.sub {
flex-grow: 1;
flex-flow: row nowrap;
- margin: 4px 0 25px 0;
+ margin: 4px 0 0 0;
display: flex;
align-items: center;
}
@@ -964,7 +975,7 @@ nav.sub {
flex-grow: 1;
}
.src nav.sub {
- margin: 0 0 15px 0;
+ margin: 0 0 -10px 0;
}
.section-header {
@@ -1074,6 +1085,11 @@ table,
with boxes (i.e. from the flex layout) */
align-items: baseline;
}
+.search-results-title + .sub-heading {
+ color: var(--main-color);
+ display: flex;
+ align-items: center;
+}
#crate-search-div {
/* ensures that 100% in properties of #crate-search-div:after
are relative to the size of this div */
@@ -1298,15 +1314,15 @@ so that we can apply CSS-filters to change the arrow color in themes */
}
#settings.popover {
- --popover-arrow-offset: 118px;
- top: 26px;
+ --popover-arrow-offset: 202px;
+ top: calc(100% - 12px);
}
/* use larger max-width for help popover, but not for help.html */
#help.popover {
max-width: 600px;
- --popover-arrow-offset: 36px;
- top: 26px;
+ --popover-arrow-offset: 118px;
+ top: calc(100% - 12px);
}
#help dt {
@@ -1722,7 +1738,6 @@ a.tooltip:hover::after {
}
#search-tabs {
- grid-area: main-heading-sub-heading;
margin-top: 0.25rem;
display: flex;
flex-direction: row;
@@ -1788,7 +1803,7 @@ a.tooltip:hover::after {
#settings-menu, #help-button, button#toggle-all-docs {
margin-left: var(--button-left-margin);
display: flex;
- line-height: initial;
+ line-height: 1.25;
}
#sidebar-button {
display: none;
@@ -1873,7 +1888,8 @@ button#toggle-all-docs:before {
content: url('data:image/svg+xml,<svg width="18" height="18" viewBox="0 0 12 12" \
enable-background="new 0 0 12 12" xmlns="http://www.w3.org/2000/svg" fill="none">\
<circle r="5.25" cx="6" cy="6" stroke-width="1.25" stroke="black"/>\
- <text x="4.25" y="9" style="font:8px sans-serif;font-weight:1000" fill="black">?</text></svg>');
+ <text x="6" y="7" style="font:8px sans-serif;font-weight:1000" text-anchor="middle" \
+ dominant-baseline="middle" fill="black">?</text></svg>');
width: 18px;
height: 18px;
filter: var(--settings-menu-filter);
@@ -1894,10 +1910,19 @@ button#toggle-all-docs:before,
}
}
+button[disabled]#toggle-all-docs {
+ opacity: 0.25;
+ border: solid 1px var(--main-background-color);
+ background-size: cover;
+}
+
+button[disabled]#toggle-all-docs:hover {
+ border: solid 1px var(--main-background-color);
+ cursor: not-allowed;
+}
+
rustdoc-toolbar span.label {
- font-size: initial;
- font-variant-caps: small-caps;
- text-transform: lowercase;
+ font-size: 1rem;
flex-grow: 1;
}
@@ -2155,15 +2180,6 @@ However, it's not needed with smaller screen width because the doc/code block is
opacity: 0.75;
}
-/* help button is mostly for search */
-#help-button:not(.help-open),
-#alternative-display #toggle-all-docs {
- display: none;
-}
-#alternative-display #help-button {
- display: flex;
-}
-
/* Media Queries */
/* Make sure all the buttons line wrap at the same time */
@@ -2206,12 +2222,10 @@ in src-script.js and main.js
width: 33px;
}
#settings.popover {
- --popover-arrow-offset: 48px;
- top: calc(100% - 8px);
+ --popover-arrow-offset: 86px;
}
#help.popover {
- --popover-arrow-offset: 12px;
- top: calc(100% - 8px);
+ --popover-arrow-offset: 48px;
}
.rustdoc {
@@ -2257,6 +2271,9 @@ in src-script.js and main.js
.src .search-form {
margin-left: 40px;
}
+ .src .main-heading {
+ margin-left: 8px;
+ }
.hide-sidebar .search-form {
margin-left: 32px;
}
@@ -2394,7 +2411,7 @@ in src-script.js and main.js
}
.src nav.sub {
- margin: 0;
+ margin: 0 0 -25px 0;
padding: var(--nav-sub-mobile-padding);
}
}
diff --git a/src/librustdoc/html/static/js/main.js b/src/librustdoc/html/static/js/main.js
index 53326f0fcadf1..3e8c903afcbd4 100644
--- a/src/librustdoc/html/static/js/main.js
+++ b/src/librustdoc/html/static/js/main.js
@@ -19,6 +19,10 @@ function resourcePath(basename, extension) {
function hideMain() {
addClass(document.getElementById(MAIN_ID), "hidden");
+ const toggle = document.getElementById("toggle-all-docs");
+ if (toggle) {
+ toggle.setAttribute("disabled", "disabled");
+ }
}
function showMain() {
@@ -31,6 +35,10 @@ function showMain() {
}
mainHeading.appendChild(searchState.rustdocToolbar);
}
+ const toggle = document.getElementById("toggle-all-docs");
+ if (toggle) {
+ toggle.removeAttribute("disabled");
+ }
}
window.rootPath = getVar("root-path");
diff --git a/src/librustdoc/html/static/js/search.js b/src/librustdoc/html/static/js/search.js
index 15b1046a27cdb..eed64d024c046 100644
--- a/src/librustdoc/html/static/js/search.js
+++ b/src/librustdoc/html/static/js/search.js
@@ -3597,16 +3597,16 @@ async function showResults(results, go_to_first, filterCrates) {
let crates = "";
if (rawSearchIndex.size > 1) {
- crates = " in <div id=\"crate-search-div\"><select id=\"crate-search\">" +
- "<option value=\"all crates\">all crates</option>";
+ crates = "<div class=\"sub-heading\"> in <div id=\"crate-search-div\">" +
+ "<select id=\"crate-search\"><option value=\"all crates\">all crates</option>";
for (const c of rawSearchIndex.keys()) {
crates += `<option value="${c}" ${c === filterCrates && "selected"}>${c}</option>`;
}
- crates += "</select></div>";
+ crates += "</select></div></div>";
}
let output = `<div class="main-heading">\
- <h1 class="search-results-title">Results${crates}</h1></div>`;
+ <h1 class="search-results-title">Results</h1>${crates}</div>`;
if (results.query.error !== null) {
const error = results.query.error;
error.forEach((value, index) => {
diff --git a/src/librustdoc/html/static/js/storage.js b/src/librustdoc/html/static/js/storage.js
index 344743c87edd3..d77804d045e36 100644
--- a/src/librustdoc/html/static/js/storage.js
+++ b/src/librustdoc/html/static/js/storage.js
@@ -293,10 +293,10 @@ class RustdocToolbarElement extends HTMLElement {
<div id="settings-menu" tabindex="-1">
<a href="${rootPath}settings.html"><span class="label">Settings</span></a>
</div>
- <button id="toggle-all-docs"><span class="label">Summary</span></button>
<div id="help-button" tabindex="-1">
<a href="${rootPath}help.html"><span class="label">Help</span></a>
- </div>`;
+ </div>
+ <button id="toggle-all-docs"><span class="label">Summary</span></button>`;
}
}
window.customElements.define("rustdoc-toolbar", RustdocToolbarElement);
diff --git a/src/librustdoc/html/templates/print_item.html b/src/librustdoc/html/templates/print_item.html
index 1b8c8293088fd..2c9f8dbddf090 100644
--- a/src/librustdoc/html/templates/print_item.html
+++ b/src/librustdoc/html/templates/print_item.html
@@ -1,11 +1,16 @@
<div class="main-heading"> {# #}
- <h1>
- {{typ}}
- {# The breadcrumbs of the item path, like std::string #}
+ {% if !path_components.is_empty() %}
+ <span class="rustdoc-breadcrumbs">
{% for component in path_components %}
<a href="{{component.path|safe}}index.html">{{component.name}}</a>::<wbr>
{% endfor %}
- <a class="{{item_type}}" href="#">{{name}}</a> {# #}
+ </span>
+ {% endif %}
+ <h1>
+ {{typ}}
+ <span{% if item_type != "mod" +%} class="{{item_type}}"{% endif %}>
+ {{name}}
+ </span> {# #}
<button id="copy-path" title="Copy item path to clipboard"> {# #}
Copy item path {# #}
</button> {# #}
diff --git a/tests/rustdoc-gui/anchors.goml b/tests/rustdoc-gui/anchors.goml
index 61b2e8880c602..3168c8e17c52f 100644
--- a/tests/rustdoc-gui/anchors.goml
+++ b/tests/rustdoc-gui/anchors.goml
@@ -12,8 +12,7 @@ define-function: (
call-function: ("switch-theme", {"theme": |theme|})
assert-css: ("#toggle-all-docs", {"color": |main_color|})
- assert-css: (".main-heading h1 a:nth-of-type(1)", {"color": |main_heading_color|})
- assert-css: (".main-heading a:nth-of-type(2)", {"color": |main_heading_type_color|})
+ assert-css: (".main-heading h1 span", {"color": |main_heading_type_color|})
assert-css: (
".rightside a.src",
{"color": |src_link_color|, "text-decoration": "none solid " + |src_link_color|},
@@ -55,7 +54,7 @@ define-function: (
assert-css: ("#top-doc-prose-title", {"color": |title_color|})
assert-css: (".sidebar .block a", {"color": |sidebar_link_color|})
- assert-css: (".main-heading h1 a", {"color": |title_color|})
+ assert-css: (".main-heading h1", {"color": |title_color|})
// We move the cursor over the "Implementations" title so the anchor is displayed.
move-cursor-to: "h2#implementations"
diff --git a/tests/rustdoc-gui/item-info.goml b/tests/rustdoc-gui/item-info.goml
index debda8d06c2c7..2824a5711405c 100644
--- a/tests/rustdoc-gui/item-info.goml
+++ b/tests/rustdoc-gui/item-info.goml
@@ -20,7 +20,7 @@ store-position: (
{"x": second_line_x, "y": second_line_y},
)
assert: |first_line_x| != |second_line_x| && |first_line_x| == 516 && |second_line_x| == 272
-assert: |first_line_y| != |second_line_y| && |first_line_y| == 715 && |second_line_y| == 738
+assert: |first_line_y| != |second_line_y| && |first_line_y| == 710 && |second_line_y| == 733
// Now we ensure that they're not rendered on the same line.
set-window-size: (1100, 800)
diff --git a/tests/rustdoc-gui/scrape-examples-layout.goml b/tests/rustdoc-gui/scrape-examples-layout.goml
index 55187a3e59647..803e8e499f476 100644
--- a/tests/rustdoc-gui/scrape-examples-layout.goml
+++ b/tests/rustdoc-gui/scrape-examples-layout.goml
@@ -72,8 +72,8 @@ click: ".scraped-example .button-holder .expand"
store-value: (offset_y, 4)
// First with desktop
-assert-position: (".scraped-example", {"y": 253})
-assert-position: (".scraped-example .prev", {"y": 253 + |offset_y|})
+assert-position: (".scraped-example", {"y": 248})
+assert-position: (".scraped-example .prev", {"y": 248 + |offset_y|})
// Gradient background should be at the top of the code block.
assert-css: (".scraped-example .example-wrap::before", {"top": "0px"})
@@ -82,8 +82,8 @@ assert-css: (".scraped-example .example-wrap::after", {"bottom": "0px"})
// Then with mobile
set-window-size: (600, 600)
store-size: (".scraped-example .scraped-example-title", {"height": title_height})
-assert-position: (".scraped-example", {"y": 284})
-assert-position: (".scraped-example .prev", {"y": 284 + |offset_y| + |title_height|})
+assert-position: (".scraped-example", {"y": 277})
+assert-position: (".scraped-example .prev", {"y": 277 + |offset_y| + |title_height|})
define-function: (
"check_title_and_code_position",
diff --git a/tests/rustdoc-gui/search-filter.goml b/tests/rustdoc-gui/search-filter.goml
index d6421599a207b..c5038e0892b04 100644
--- a/tests/rustdoc-gui/search-filter.goml
+++ b/tests/rustdoc-gui/search-filter.goml
@@ -56,7 +56,8 @@ assert-property: ("#crate-search", {"value": "lib2"})
assert-false: "#results .externcrate"
// Checking that the text for the "title" is correct (the "all crates" comes from the "<select>").
-assert-text: (".search-results-title", "Results in all crates", STARTS_WITH)
+assert-text: (".search-results-title", "Results", STARTS_WITH)
+assert-text: (".search-results-title + .sub-heading", " in all crates", STARTS_WITH)
// Checking the display of the crate filter.
// We start with the light theme.
@@ -84,6 +85,6 @@ wait-for-css: ("#crate-search", {
click: "#theme-ayu"
wait-for-css: ("#crate-search", {
"border": "1px solid #5c6773",
- "color": "#fff",
+ "color": "#c5c5c5",
"background-color": "#0f1419",
})
diff --git a/tests/rustdoc-gui/search-result-display.goml b/tests/rustdoc-gui/search-result-display.goml
index c69ca59d44a7c..156244f92b4f5 100644
--- a/tests/rustdoc-gui/search-result-display.goml
+++ b/tests/rustdoc-gui/search-result-display.goml
@@ -50,7 +50,7 @@ compare-elements-size-near: (
set-window-size: (900, 900)
// First we check the current width, height and position.
-assert-css: ("#crate-search", {"width": "223px"})
+assert-css: ("#crate-search", {"width": "159px"})
store-size: (".search-results-title", {
"height": search_results_title_height,
"width": search_results_title_width,
@@ -64,7 +64,7 @@ set-text: (
)
// Then we compare again to confirm the height didn't change.
-assert-size: ("#crate-search", {"width": 760})
+assert-size: ("#crate-search", {"width": 509})
assert-size: (".search-results-title", {
"height": |search_results_title_height|,
})
diff --git a/tests/rustdoc-gui/search-result-go-to-first.goml b/tests/rustdoc-gui/search-result-go-to-first.goml
index f4cfe096386d5..1e3850969e3bd 100644
--- a/tests/rustdoc-gui/search-result-go-to-first.goml
+++ b/tests/rustdoc-gui/search-result-go-to-first.goml
@@ -16,4 +16,5 @@ assert-css: ("#main-content", {"display": "none"})
// Now we can check that the feature is working as expected!
go-to: "file://" + |DOC_PATH| + "/test_docs/index.html?search=struct%3AFoo&go_to_first=true"
// Waiting for the page to load...
-wait-for-text: (".main-heading h1", "Struct test_docs::FooCopy item path")
+wait-for-text: (".main-heading .rustdoc-breadcrumbs", "test_docs::")
+wait-for-text: (".main-heading h1", "Struct FooCopy item path")
diff --git a/tests/rustdoc-gui/sidebar-source-code-display.goml b/tests/rustdoc-gui/sidebar-source-code-display.goml
index 99810cd786335..c3e02c4e9b409 100644
--- a/tests/rustdoc-gui/sidebar-source-code-display.goml
+++ b/tests/rustdoc-gui/sidebar-source-code-display.goml
@@ -141,7 +141,7 @@ click: "#sidebar-button"
wait-for-css: (".src .sidebar > *", {"visibility": "hidden"})
// We scroll to line 117 to change the scroll position.
scroll-to: '//*[@id="117"]'
-store-value: (y_offset, "2567")
+store-value: (y_offset, "2564")
assert-window-property: {"pageYOffset": |y_offset|}
// Expanding the sidebar...
click: "#sidebar-button"
diff --git a/tests/rustdoc-gui/source-anchor-scroll.goml b/tests/rustdoc-gui/source-anchor-scroll.goml
index ad03fb3d3e8ef..166890abe4b36 100644
--- a/tests/rustdoc-gui/source-anchor-scroll.goml
+++ b/tests/rustdoc-gui/source-anchor-scroll.goml
@@ -8,13 +8,13 @@ set-window-size: (600, 800)
assert-property: ("html", {"scrollTop": "0"})
click: '//a[text() = "barbar" and @href="#5-7"]'
-assert-property: ("html", {"scrollTop": "196"})
+assert-property: ("html", {"scrollTop": "194"})
click: '//a[text() = "bar" and @href="#28-36"]'
-assert-property: ("html", {"scrollTop": "228"})
+assert-property: ("html", {"scrollTop": "225"})
click: '//a[normalize-space() = "sub_fn" and @href="#2-4"]'
-assert-property: ("html", {"scrollTop": "124"})
+assert-property: ("html", {"scrollTop": "122"})
// We now check that clicking on lines doesn't change the scroll
// Extra information: the "sub_fn" function header is on line 1.
click: '//*[@id="6"]'
-assert-property: ("html", {"scrollTop": "124"})
+assert-property: ("html", {"scrollTop": "122"})
diff --git a/tests/rustdoc-gui/source-code-page.goml b/tests/rustdoc-gui/source-code-page.goml
index d9d66f62249c2..095354c2f4c1c 100644
--- a/tests/rustdoc-gui/source-code-page.goml
+++ b/tests/rustdoc-gui/source-code-page.goml
@@ -89,7 +89,7 @@ assert-css: (".src-line-numbers", {"text-align": "right"})
// do anything (and certainly not add a `#NaN` to the URL!).
go-to: "file://" + |DOC_PATH| + "/src/test_docs/lib.rs.html"
// We use this assert-position to know where we will click.
-assert-position: ("//*[@id='1']", {"x": 88, "y": 162})
+assert-position: ("//*[@id='1']", {"x": 88, "y": 163})
// We click on the left of the "1" anchor but still in the "src-line-number" `<pre>`.
click: (163, 77)
assert-document-property: ({"URL": "/lib.rs.html"}, ENDS_WITH)
@@ -159,19 +159,21 @@ call-function: ("check-sidebar-dir-entry", {
// Check the search form
assert-css: ("nav.sub", {"flex-direction": "row"})
// The goal of this test is to ensure the search input is perfectly centered
-// between the top of the page and the top of the gray code block.
+// between the top of the page and the header.
// To check this, we maintain the invariant:
//
// offsetTop[nav.sub form] = offsetTop[#main-content] - offsetHeight[nav.sub form] - offsetTop[nav.sub form]
-assert-property: ("nav.sub form", {"offsetTop": 15, "offsetHeight": 34})
-assert-property: ("#main-content", {"offsetTop": 64})
+assert-position: ("nav.sub form", {"y": 15})
+assert-property: ("nav.sub form", {"offsetHeight": 34})
+assert-position: ("h1", {"y": 64})
// 15 = 64 - 34 - 15
// Now do the same check on moderately-sized, tablet mobile.
set-window-size: (700, 700)
assert-css: ("nav.sub", {"flex-direction": "row"})
-assert-property: ("nav.sub form", {"offsetTop": 8, "offsetHeight": 34})
-assert-property: ("#main-content", {"offsetTop": 50})
+assert-position: ("nav.sub form", {"y": 8})
+assert-property: ("nav.sub form", {"offsetHeight": 34})
+assert-position: ("h1", {"y": 50})
// 8 = 50 - 34 - 8
// Check the sidebar directory entries have a marker and spacing (tablet).
diff --git a/tests/rustdoc-gui/src/theme_css/custom-theme.css b/tests/rustdoc-gui/src/theme_css/custom-theme.css
index 934cb973b78dc..5ea5009fb2e0a 100644
--- a/tests/rustdoc-gui/src/theme_css/custom-theme.css
+++ b/tests/rustdoc-gui/src/theme_css/custom-theme.css
@@ -53,6 +53,7 @@
--search-tab-button-selected-background: #fff;
--settings-menu-filter: none;
--settings-menu-hover-filter: invert(35%);
+ --settings-menu-disabled-filter: invert(14%) sepia(11%) saturate(14%) hue-rotate(337deg);
--stab-background-color: #fff5d6;
--stab-code-color: #000;
--code-highlight-kw-color: #8959a8;
diff --git a/tests/rustdoc-gui/toggle-click-deadspace.goml b/tests/rustdoc-gui/toggle-click-deadspace.goml
index 37bc3f7c37270..cbb0a2d5eb085 100644
--- a/tests/rustdoc-gui/toggle-click-deadspace.goml
+++ b/tests/rustdoc-gui/toggle-click-deadspace.goml
@@ -12,4 +12,5 @@ assert-attribute-false: (".impl-items .toggle", {"open": ""})
// Click the "Trait" part of "impl Trait" and verify it navigates.
click: "#impl-Trait-for-Foo h3 a:first-of-type"
-assert-text: (".main-heading h1", "Trait lib2::TraitCopy item path")
+assert-text: (".main-heading .rustdoc-breadcrumbs", "lib2::")
+assert-text: (".main-heading h1", "Trait TraitCopy item path")
diff --git a/tests/rustdoc-gui/toggle-docs-mobile.goml b/tests/rustdoc-gui/toggle-docs-mobile.goml
index b69aa6e30ca0b..59233d94fcc45 100644
--- a/tests/rustdoc-gui/toggle-docs-mobile.goml
+++ b/tests/rustdoc-gui/toggle-docs-mobile.goml
@@ -3,12 +3,12 @@
go-to: "file://" + |DOC_PATH| + "/test_docs/struct.Foo.html"
set-window-size: (433, 600)
assert-attribute: (".top-doc", {"open": ""})
-click: (4, 270) // This is the position of the top doc comment toggle
+click: (4, 260) // This is the position of the top doc comment toggle
assert-attribute-false: (".top-doc", {"open": ""})
-click: (4, 270)
+click: (4, 260)
assert-attribute: (".top-doc", {"open": ""})
// To ensure that the toggle isn't over the text, we check that the toggle isn't clicked.
-click: (3, 270)
+click: (3, 260)
assert-attribute: (".top-doc", {"open": ""})
// Assert the position of the toggle on the top doc block.
@@ -24,10 +24,10 @@ assert-position: (
// Now we do the same but with a little bigger width
set-window-size: (600, 600)
assert-attribute: (".top-doc", {"open": ""})
-click: (4, 270) // New Y position since all search elements are back on one line.
+click: (4, 260) // New Y position since all search elements are back on one line.
assert-attribute-false: (".top-doc", {"open": ""})
-click: (4, 270)
+click: (4, 260)
assert-attribute: (".top-doc", {"open": ""})
// To ensure that the toggle isn't over the text, we check that the toggle isn't clicked.
-click: (3, 270)
+click: (3, 260)
assert-attribute: (".top-doc", {"open": ""})
diff --git a/tests/rustdoc/empty-mod-private.rs b/tests/rustdoc/empty-mod-private.rs
index 4e408e3d4240a..2b446deda33e3 100644
--- a/tests/rustdoc/empty-mod-private.rs
+++ b/tests/rustdoc/empty-mod-private.rs
@@ -2,15 +2,18 @@
//@ has 'empty_mod_private/index.html' '//a[@href="foo/index.html"]' 'foo'
//@ hasraw 'empty_mod_private/sidebar-items.js' 'foo'
-//@ matches 'empty_mod_private/foo/index.html' '//h1' 'Module empty_mod_private::foo'
+//@ matches 'empty_mod_private/foo/index.html' '//h1' 'Module foo'
+//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'empty_mod_private::'
mod foo {}
//@ has 'empty_mod_private/index.html' '//a[@href="bar/index.html"]' 'bar'
//@ hasraw 'empty_mod_private/sidebar-items.js' 'bar'
-//@ matches 'empty_mod_private/bar/index.html' '//h1' 'Module empty_mod_private::bar'
+//@ matches 'empty_mod_private/bar/index.html' '//h1' 'Module bar'
+//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'empty_mod_private::'
mod bar {
//@ has 'empty_mod_private/bar/index.html' '//a[@href="baz/index.html"]' 'baz'
//@ hasraw 'empty_mod_private/bar/sidebar-items.js' 'baz'
- //@ matches 'empty_mod_private/bar/baz/index.html' '//h1' 'Module empty_mod_private::bar::baz'
+ //@ matches 'empty_mod_private/bar/baz/index.html' '//h1' 'Module baz'
+ //@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'empty_mod_private::bar::'
mod baz {}
}
diff --git a/tests/rustdoc/empty-mod-public.rs b/tests/rustdoc/empty-mod-public.rs
index b5a63525524ce..97f41a807c6cd 100644
--- a/tests/rustdoc/empty-mod-public.rs
+++ b/tests/rustdoc/empty-mod-public.rs
@@ -1,14 +1,17 @@
//@ has 'empty_mod_public/index.html' '//a[@href="foo/index.html"]' 'foo'
//@ hasraw 'empty_mod_public/sidebar-items.js' 'foo'
-//@ matches 'empty_mod_public/foo/index.html' '//h1' 'Module empty_mod_public::foo'
+//@ matches 'empty_mod_public/foo/index.html' '//h1' 'Module foo'
+//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'empty_mod_public::'
pub mod foo {}
//@ has 'empty_mod_public/index.html' '//a[@href="bar/index.html"]' 'bar'
//@ hasraw 'empty_mod_public/sidebar-items.js' 'bar'
-//@ matches 'empty_mod_public/bar/index.html' '//h1' 'Module empty_mod_public::bar'
+//@ matches 'empty_mod_public/bar/index.html' '//h1' 'Module bar'
+//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'empty_mod_public::'
pub mod bar {
//@ has 'empty_mod_public/bar/index.html' '//a[@href="baz/index.html"]' 'baz'
//@ hasraw 'empty_mod_public/bar/sidebar-items.js' 'baz'
- //@ matches 'empty_mod_public/bar/baz/index.html' '//h1' 'Module empty_mod_public::bar::baz'
+ //@ matches 'empty_mod_public/bar/baz/index.html' '//h1' 'Module baz'
+ //@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'empty_mod_public::bar::'
pub mod baz {}
}
diff --git a/tests/rustdoc/inline_cross/renamed-via-module.rs b/tests/rustdoc/inline_cross/renamed-via-module.rs
index bdaf2cf1f620c..a5af9b96f6c77 100644
--- a/tests/rustdoc/inline_cross/renamed-via-module.rs
+++ b/tests/rustdoc/inline_cross/renamed-via-module.rs
@@ -10,15 +10,19 @@ extern crate foo;
//@ has - '//a/[@href="struct.DeprecatedStepBy.html"]' "DeprecatedStepBy"
//@ has - '//a/[@href="struct.StepBy.html"]' "StepBy"
//@ has foo/iter/struct.DeprecatedStepBy.html
-//@ has - '//h1' "Struct foo::iter::DeprecatedStepBy"
+//@ has - '//h1' "Struct DeprecatedStepBy"
+//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::iter::'
//@ has foo/iter/struct.StepBy.html
-//@ has - '//h1' "Struct foo::iter::StepBy"
+//@ has - '//h1' "Struct StepBy"
+//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::iter::'
//@ has bar/iter/index.html
//@ has - '//a/[@href="struct.DeprecatedStepBy.html"]' "DeprecatedStepBy"
//@ has - '//a/[@href="struct.StepBy.html"]' "StepBy"
//@ has bar/iter/struct.DeprecatedStepBy.html
-//@ has - '//h1' "Struct bar::iter::DeprecatedStepBy"
+//@ has - '//h1' "Struct DeprecatedStepBy"
+//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'bar::iter::'
//@ has bar/iter/struct.StepBy.html
-//@ has - '//h1' "Struct bar::iter::StepBy"
+//@ has - '//h1' "Struct StepBy"
+//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'bar::iter::'
pub use foo::iter;
diff --git a/tests/rustdoc/keyword.rs b/tests/rustdoc/keyword.rs
index 0157c35288e87..519e1944bc78a 100644
--- a/tests/rustdoc/keyword.rs
+++ b/tests/rustdoc/keyword.rs
@@ -6,7 +6,6 @@
//@ has foo/index.html '//a[@href="keyword.match.html"]' 'match'
//@ has foo/index.html '//div[@class="sidebar-elems"]//li/a' 'Keywords'
//@ has foo/index.html '//div[@class="sidebar-elems"]//li/a/@href' '#keywords'
-//@ has foo/keyword.match.html '//a[@class="keyword"]' 'match'
//@ has foo/keyword.match.html '//h1' 'Keyword match'
//@ has foo/keyword.match.html '//section[@id="main-content"]//div[@class="docblock"]//p' 'this is a test!'
//@ has foo/index.html '//a/@href' '../foo/index.html'
diff --git a/tests/rustdoc/primitive-reference.rs b/tests/rustdoc/primitive-reference.rs
index c12d65ee0c578..bd6b2a32f754f 100644
--- a/tests/rustdoc/primitive-reference.rs
+++ b/tests/rustdoc/primitive-reference.rs
@@ -8,7 +8,6 @@
//@ has - '//div[@class="sidebar-elems"]//li/a' 'Primitive Types'
//@ has - '//div[@class="sidebar-elems"]//li/a/@href' '#primitives'
//@ has foo/primitive.reference.html
-//@ has - '//a[@class="primitive"]' 'reference'
//@ has - '//h1' 'Primitive Type reference'
//@ has - '//section[@id="main-content"]//div[@class="docblock"]//p' 'this is a test!'
diff --git a/tests/rustdoc/primitive-slice-auto-trait.rs b/tests/rustdoc/primitive-slice-auto-trait.rs
index a877b73cf9f86..e78d1d9461421 100644
--- a/tests/rustdoc/primitive-slice-auto-trait.rs
+++ b/tests/rustdoc/primitive-slice-auto-trait.rs
@@ -3,8 +3,7 @@
#![crate_name = "foo"]
#![feature(rustc_attrs)]
-//@ has foo/primitive.slice.html '//a[@class="primitive"]' 'slice'
-//@ has - '//h1' 'Primitive Type slice'
+//@ has foo/primitive.slice.html '//h1' 'Primitive Type slice'
//@ has - '//section[@id="main-content"]//div[@class="docblock"]//p' 'this is a test!'
//@ has - '//h2[@id="synthetic-implementations"]' 'Auto Trait Implementations'
//@ has - '//div[@id="synthetic-implementations-list"]//h3' 'impl<T> Send for [T]where T: Send'
diff --git a/tests/rustdoc/primitive-tuple-auto-trait.rs b/tests/rustdoc/primitive-tuple-auto-trait.rs
index 060c4ecfbdc1d..045478e6b4f8c 100644
--- a/tests/rustdoc/primitive-tuple-auto-trait.rs
+++ b/tests/rustdoc/primitive-tuple-auto-trait.rs
@@ -3,8 +3,7 @@
#![crate_name = "foo"]
#![feature(rustc_attrs)]
-//@ has foo/primitive.tuple.html '//a[@class="primitive"]' 'tuple'
-//@ has - '//h1' 'Primitive Type tuple'
+//@ has foo/primitive.tuple.html '//h1' 'Primitive Type tuple'
//@ has - '//section[@id="main-content"]//div[@class="docblock"]//p' 'this is a test!'
//@ has - '//h2[@id="synthetic-implementations"]' 'Auto Trait Implementations'
//@ has - '//div[@id="synthetic-implementations-list"]//h3' 'Send'
diff --git a/tests/rustdoc/primitive-unit-auto-trait.rs b/tests/rustdoc/primitive-unit-auto-trait.rs
index 7751a2bf1d043..6cae094c21c81 100644
--- a/tests/rustdoc/primitive-unit-auto-trait.rs
+++ b/tests/rustdoc/primitive-unit-auto-trait.rs
@@ -3,8 +3,7 @@
#![crate_name = "foo"]
#![feature(rustc_attrs)]
-//@ has foo/primitive.unit.html '//a[@class="primitive"]' 'unit'
-//@ has - '//h1' 'Primitive Type unit'
+//@ has foo/primitive.unit.html '//h1' 'Primitive Type unit'
//@ has - '//section[@id="main-content"]//div[@class="docblock"]//p' 'this is a test!'
//@ has - '//h2[@id="synthetic-implementations"]' 'Auto Trait Implementations'
//@ has - '//div[@id="synthetic-implementations-list"]//h3' 'impl Send for ()'
diff --git a/tests/rustdoc/titles.rs b/tests/rustdoc/titles.rs
index bdf950b0a6225..6113878a03f8a 100644
--- a/tests/rustdoc/titles.rs
+++ b/tests/rustdoc/titles.rs
@@ -5,53 +5,65 @@
//@ matches 'foo/index.html' '//div[@class="sidebar-crate"]/h2/a' 'foo'
//@ count 'foo/index.html' '//h2[@class="location"]' 0
-//@ matches 'foo/foo_mod/index.html' '//h1' 'Module foo::foo_mod'
-//@ matches 'foo/foo_mod/index.html' '//h2[@class="location"]' 'Module foo_mod'
+//@ matches 'foo/foo_mod/index.html' '//h1' 'Module foo_mod'
+//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::'
+//@ matches - '//h2[@class="location"]' 'Module foo_mod'
pub mod foo_mod {
pub struct __Thing {}
}
extern "C" {
- //@ matches 'foo/fn.foo_ffn.html' '//h1' 'Function foo::foo_ffn'
+ //@ matches 'foo/fn.foo_ffn.html' '//h1' 'Function foo_ffn'
+ //@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::'
pub fn foo_ffn();
}
-//@ matches 'foo/fn.foo_fn.html' '//h1' 'Function foo::foo_fn'
+//@ matches 'foo/fn.foo_fn.html' '//h1' 'Function foo_fn'
+//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::'
pub fn foo_fn() {}
-//@ matches 'foo/trait.FooTrait.html' '//h1' 'Trait foo::FooTrait'
-//@ matches 'foo/trait.FooTrait.html' '//h2[@class="location"]' 'FooTrait'
+//@ matches 'foo/trait.FooTrait.html' '//h1' 'Trait FooTrait'
+//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::'
+//@ matches - '//h2[@class="location"]' 'FooTrait'
pub trait FooTrait {}
-//@ matches 'foo/struct.FooStruct.html' '//h1' 'Struct foo::FooStruct'
-//@ matches 'foo/struct.FooStruct.html' '//h2[@class="location"]' 'FooStruct'
+//@ matches 'foo/struct.FooStruct.html' '//h1' 'Struct FooStruct'
+//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::'
+//@ matches - '//h2[@class="location"]' 'FooStruct'
pub struct FooStruct;
-//@ matches 'foo/enum.FooEnum.html' '//h1' 'Enum foo::FooEnum'
-//@ matches 'foo/enum.FooEnum.html' '//h2[@class="location"]' 'FooEnum'
+//@ matches 'foo/enum.FooEnum.html' '//h1' 'Enum FooEnum'
+//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::'
+//@ matches - '//h2[@class="location"]' 'FooEnum'
pub enum FooEnum {}
-//@ matches 'foo/type.FooType.html' '//h1' 'Type Alias foo::FooType'
-//@ matches 'foo/type.FooType.html' '//h2[@class="location"]' 'FooType'
+//@ matches 'foo/type.FooType.html' '//h1' 'Type Alias FooType'
+//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::'
+//@ matches - '//h2[@class="location"]' 'FooType'
pub type FooType = FooStruct;
-//@ matches 'foo/macro.foo_macro.html' '//h1' 'Macro foo::foo_macro'
+//@ matches 'foo/macro.foo_macro.html' '//h1' 'Macro foo_macro'
+//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::'
#[macro_export]
macro_rules! foo_macro {
() => {};
}
//@ matches 'foo/primitive.bool.html' '//h1' 'Primitive Type bool'
+//@ count - '//*[@class="rustdoc-breadcrumbs"]' 0
#[rustc_doc_primitive = "bool"]
mod bool {}
-//@ matches 'foo/static.FOO_STATIC.html' '//h1' 'Static foo::FOO_STATIC'
+//@ matches 'foo/static.FOO_STATIC.html' '//h1' 'Static FOO_STATIC'
+//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::'
pub static FOO_STATIC: FooStruct = FooStruct;
extern "C" {
- //@ matches 'foo/static.FOO_FSTATIC.html' '//h1' 'Static foo::FOO_FSTATIC'
+ //@ matches 'foo/static.FOO_FSTATIC.html' '//h1' 'Static FOO_FSTATIC'
+ //@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::'
pub static FOO_FSTATIC: FooStruct;
}
-//@ matches 'foo/constant.FOO_CONSTANT.html' '//h1' 'Constant foo::FOO_CONSTANT'
+//@ matches 'foo/constant.FOO_CONSTANT.html' '//h1' 'Constant FOO_CONSTANT'
+//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::'
pub const FOO_CONSTANT: FooStruct = FooStruct;
From df307d00852cdd0a23dfe7e981f3ad6aee7eda8a Mon Sep 17 00:00:00 2001
From: Michael Howell <michael@notriddle.com>
Date: Tue, 3 Sep 2024 14:25:40 -0700
Subject: [PATCH 03/12] rustdoc: tweak spacing in toolbar
---
src/librustdoc/html/static/css/rustdoc.css | 12 +++++++++---
tests/rustdoc-gui/item-info.goml | 2 +-
tests/rustdoc-gui/scrape-examples-layout.goml | 8 ++++----
3 files changed, 14 insertions(+), 8 deletions(-)
diff --git a/src/librustdoc/html/static/css/rustdoc.css b/src/librustdoc/html/static/css/rustdoc.css
index fe5d35cad4906..2dfe510721013 100644
--- a/src/librustdoc/html/static/css/rustdoc.css
+++ b/src/librustdoc/html/static/css/rustdoc.css
@@ -34,6 +34,8 @@ xmlns="http://www.w3.org/2000/svg" fill="black" height="18px">\
</g></svg>');
--button-left-margin: 4px;
--button-border-radius: 2px;
+ --toolbar-button-border-radius: 6px;
+ --code-block-border-radius: 6px;
}
/* See FiraSans-LICENSE.txt for the Fira Sans license. */
@@ -183,7 +185,7 @@ h1, h2, h3, h4 {
grid-template-columns: 1fr max-content;
grid-template-rows: 25px min-content min-content;
padding-bottom: 6px;
- margin-bottom: 15px;
+ margin-bottom: 11px;
}
.rustdoc-breadcrumbs {
grid-area: main-heading-breadcrumbs;
@@ -904,6 +906,7 @@ both the code example and the line numbers, so we need to remove the radius in t
flex-grow: 0;
grid-area: main-heading-sub-heading;
line-height: 1.25;
+ padding-bottom: 4px;
}
.main-heading rustdoc-toolbar, .main-heading .out-of-band {
@@ -918,6 +921,7 @@ rustdoc-toolbar {
.docblock code, .docblock-short code,
pre, .rustdoc.src .example-wrap {
background-color: var(--code-block-background-color);
+ border-radius: var(--code-block-border-radius);
}
#main-content {
@@ -1315,14 +1319,14 @@ so that we can apply CSS-filters to change the arrow color in themes */
#settings.popover {
--popover-arrow-offset: 202px;
- top: calc(100% - 12px);
+ top: calc(100% - 16px);
}
/* use larger max-width for help popover, but not for help.html */
#help.popover {
max-width: 600px;
--popover-arrow-offset: 118px;
- top: calc(100% - 12px);
+ top: calc(100% - 16px);
}
#help dt {
@@ -1838,6 +1842,7 @@ a.tooltip:hover::after {
}
#settings-menu > a, #help-button > a, button#toggle-all-docs {
width: 80px;
+ border-radius: var(--toolbar-button-border-radius);
}
#sidebar-button > a {
background-color: var(--button-background-color);
@@ -1924,6 +1929,7 @@ button[disabled]#toggle-all-docs:hover {
rustdoc-toolbar span.label {
font-size: 1rem;
flex-grow: 1;
+ padding-bottom: 4px;
}
#sidebar-button > a:before {
diff --git a/tests/rustdoc-gui/item-info.goml b/tests/rustdoc-gui/item-info.goml
index 2824a5711405c..c8aa7b31cadc6 100644
--- a/tests/rustdoc-gui/item-info.goml
+++ b/tests/rustdoc-gui/item-info.goml
@@ -20,7 +20,7 @@ store-position: (
{"x": second_line_x, "y": second_line_y},
)
assert: |first_line_x| != |second_line_x| && |first_line_x| == 516 && |second_line_x| == 272
-assert: |first_line_y| != |second_line_y| && |first_line_y| == 710 && |second_line_y| == 733
+assert: |first_line_y| != |second_line_y| && |first_line_y| == 714 && |second_line_y| == 737
// Now we ensure that they're not rendered on the same line.
set-window-size: (1100, 800)
diff --git a/tests/rustdoc-gui/scrape-examples-layout.goml b/tests/rustdoc-gui/scrape-examples-layout.goml
index 803e8e499f476..2bf2f10a2151b 100644
--- a/tests/rustdoc-gui/scrape-examples-layout.goml
+++ b/tests/rustdoc-gui/scrape-examples-layout.goml
@@ -72,8 +72,8 @@ click: ".scraped-example .button-holder .expand"
store-value: (offset_y, 4)
// First with desktop
-assert-position: (".scraped-example", {"y": 248})
-assert-position: (".scraped-example .prev", {"y": 248 + |offset_y|})
+assert-position: (".scraped-example", {"y": 252})
+assert-position: (".scraped-example .prev", {"y": 252 + |offset_y|})
// Gradient background should be at the top of the code block.
assert-css: (".scraped-example .example-wrap::before", {"top": "0px"})
@@ -82,8 +82,8 @@ assert-css: (".scraped-example .example-wrap::after", {"bottom": "0px"})
// Then with mobile
set-window-size: (600, 600)
store-size: (".scraped-example .scraped-example-title", {"height": title_height})
-assert-position: (".scraped-example", {"y": 277})
-assert-position: (".scraped-example .prev", {"y": 277 + |offset_y| + |title_height|})
+assert-position: (".scraped-example", {"y": 281})
+assert-position: (".scraped-example .prev", {"y": 281 + |offset_y| + |title_height|})
define-function: (
"check_title_and_code_position",
From 17f5afe4576fd51edd66ba36ddd78d889142f81b Mon Sep 17 00:00:00 2001
From: Michael Howell <michael@notriddle.com>
Date: Tue, 10 Sep 2024 18:37:37 -0700
Subject: [PATCH 04/12] Fix up standard library intro
---
library/std/src/lib.rs | 18 +++++++++++-------
library/stdarch | 2 +-
2 files changed, 12 insertions(+), 8 deletions(-)
diff --git a/library/std/src/lib.rs b/library/std/src/lib.rs
index 60969af3e8541..03b76383bf041 100644
--- a/library/std/src/lib.rs
+++ b/library/std/src/lib.rs
@@ -32,13 +32,17 @@
//!
//! Once you are familiar with the contents of the standard library you may
//! begin to find the verbosity of the prose distracting. At this stage in your
-//! development you may want to press the `[-]` button near the top of the
-//! page to collapse it into a more skimmable view.
-//!
-//! While you are looking at that `[-]` button also notice the `source`
-//! link. Rust's API documentation comes with the source code and you are
-//! encouraged to read it. The standard library source is generally high
-//! quality and a peek behind the curtains is often enlightening.
+//! development you may want to press the <code>
+//! <svg width="0.75rem" height="0.75rem" viewBox="0 0 12 12"
+//! stroke="currentColor" fill="none">
+//! <path d="M2,2l4,4l4,-4M2,6l4,4l4,-4"/></svg> Summary</code> button near the
+//! top of the page to collapse it into a more skimmable view.
+//!
+//! While you are looking at the top of the page, also notice the
+//! <code>source</code> link. Rust's API documentation comes with the source
+//! code and you are encouraged to read it. The standard library source is
+//! generally high quality and a peek behind the curtains is
+//! often enlightening.
//!
//! # What is in the standard library documentation?
//!
diff --git a/library/stdarch b/library/stdarch
index d9466edb4c53c..ace72223a0e32 160000
--- a/library/stdarch
+++ b/library/stdarch
@@ -1 +1 @@
-Subproject commit d9466edb4c53cece8686ee6e17b028436ddf4151
+Subproject commit ace72223a0e321c1b0a37b5862aa756fe8ab5111
From 1be4e7f25c95d37d8583034a2abe7c5c2f067734 Mon Sep 17 00:00:00 2001
From: Michael Howell <michael@notriddle.com>
Date: Tue, 10 Sep 2024 22:03:54 -0700
Subject: [PATCH 05/12] Tweak breadcrumbs list
---
src/librustdoc/html/static/css/rustdoc.css | 5 +++++
src/librustdoc/html/static/js/main.js | 11 ++++------
src/librustdoc/html/templates/print_item.html | 7 ++++--
.../search-result-go-to-first.goml | 2 +-
tests/rustdoc-gui/toggle-click-deadspace.goml | 2 +-
tests/rustdoc/empty-mod-private.rs | 6 ++---
tests/rustdoc/empty-mod-public.rs | 6 ++---
.../inline_cross/renamed-via-module.rs | 8 +++----
tests/rustdoc/titles.rs | 22 +++++++++----------
9 files changed, 37 insertions(+), 32 deletions(-)
diff --git a/src/librustdoc/html/static/css/rustdoc.css b/src/librustdoc/html/static/css/rustdoc.css
index 2dfe510721013..0237677f9d47b 100644
--- a/src/librustdoc/html/static/css/rustdoc.css
+++ b/src/librustdoc/html/static/css/rustdoc.css
@@ -194,6 +194,11 @@ h1, h2, h3, h4 {
display: flex;
align-items: end;
}
+.rustdoc-breadcrumbs a {
+ padding: 4px 0;
+ margin: -4px 0;
+ z-index: 1;
+}
/* The only headings that get underlines are:
Markdown-generated headings within the top-doc
Rustdoc-generated h2 section headings (e.g. "Implementations", "Required Methods", etc)
diff --git a/src/librustdoc/html/static/js/main.js b/src/librustdoc/html/static/js/main.js
index 3e8c903afcbd4..2fb686effc179 100644
--- a/src/librustdoc/html/static/js/main.js
+++ b/src/librustdoc/html/static/js/main.js
@@ -1,6 +1,6 @@
// Local js definitions:
/* global addClass, getSettingValue, hasClass, searchState, updateLocalStorage */
-/* global onEach, onEachLazy, removeClass, getVar */
+/* global onEachLazy, removeClass, getVar */
"use strict";
@@ -1826,14 +1826,11 @@ href="https://doc.rust-lang.org/${channel}/rustdoc/read-documentation/search.htm
return;
}
but.onclick = () => {
- const parent = but.parentElement;
const path = [];
-
- onEach(parent.childNodes, child => {
- if (child.tagName === "A") {
- path.push(child.textContent);
- }
+ onEachLazy(document.querySelectorAll(".rustdoc-breadcrumbs a"), a => {
+ path.push(a.textContent);
});
+ path.push(document.querySelector("title").textContent.split(" ")[0]);
copyContentToClipboard(path.join("::"));
copyButtonAnimation(but);
diff --git a/src/librustdoc/html/templates/print_item.html b/src/librustdoc/html/templates/print_item.html
index 2c9f8dbddf090..2187b13429bb5 100644
--- a/src/librustdoc/html/templates/print_item.html
+++ b/src/librustdoc/html/templates/print_item.html
@@ -1,8 +1,11 @@
<div class="main-heading"> {# #}
{% if !path_components.is_empty() %}
<span class="rustdoc-breadcrumbs">
- {% for component in path_components %}
- <a href="{{component.path|safe}}index.html">{{component.name}}</a>::<wbr>
+ {% for (i, component) in path_components.iter().enumerate() %}
+ {% if i != 0 %}
+ ::<wbr>
+ {% endif %}
+ <a href="{{component.path|safe}}index.html">{{component.name}}</a>
{% endfor %}
</span>
{% endif %}
diff --git a/tests/rustdoc-gui/search-result-go-to-first.goml b/tests/rustdoc-gui/search-result-go-to-first.goml
index 1e3850969e3bd..136213c517ebb 100644
--- a/tests/rustdoc-gui/search-result-go-to-first.goml
+++ b/tests/rustdoc-gui/search-result-go-to-first.goml
@@ -16,5 +16,5 @@ assert-css: ("#main-content", {"display": "none"})
// Now we can check that the feature is working as expected!
go-to: "file://" + |DOC_PATH| + "/test_docs/index.html?search=struct%3AFoo&go_to_first=true"
// Waiting for the page to load...
-wait-for-text: (".main-heading .rustdoc-breadcrumbs", "test_docs::")
+wait-for-text: (".main-heading .rustdoc-breadcrumbs", "test_docs")
wait-for-text: (".main-heading h1", "Struct FooCopy item path")
diff --git a/tests/rustdoc-gui/toggle-click-deadspace.goml b/tests/rustdoc-gui/toggle-click-deadspace.goml
index cbb0a2d5eb085..caca1b61493d2 100644
--- a/tests/rustdoc-gui/toggle-click-deadspace.goml
+++ b/tests/rustdoc-gui/toggle-click-deadspace.goml
@@ -12,5 +12,5 @@ assert-attribute-false: (".impl-items .toggle", {"open": ""})
// Click the "Trait" part of "impl Trait" and verify it navigates.
click: "#impl-Trait-for-Foo h3 a:first-of-type"
-assert-text: (".main-heading .rustdoc-breadcrumbs", "lib2::")
+assert-text: (".main-heading .rustdoc-breadcrumbs", "lib2")
assert-text: (".main-heading h1", "Trait TraitCopy item path")
diff --git a/tests/rustdoc/empty-mod-private.rs b/tests/rustdoc/empty-mod-private.rs
index 2b446deda33e3..5a8638cd5f5cd 100644
--- a/tests/rustdoc/empty-mod-private.rs
+++ b/tests/rustdoc/empty-mod-private.rs
@@ -3,17 +3,17 @@
//@ has 'empty_mod_private/index.html' '//a[@href="foo/index.html"]' 'foo'
//@ hasraw 'empty_mod_private/sidebar-items.js' 'foo'
//@ matches 'empty_mod_private/foo/index.html' '//h1' 'Module foo'
-//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'empty_mod_private::'
+//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'empty_mod_private'
mod foo {}
//@ has 'empty_mod_private/index.html' '//a[@href="bar/index.html"]' 'bar'
//@ hasraw 'empty_mod_private/sidebar-items.js' 'bar'
//@ matches 'empty_mod_private/bar/index.html' '//h1' 'Module bar'
-//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'empty_mod_private::'
+//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'empty_mod_private'
mod bar {
//@ has 'empty_mod_private/bar/index.html' '//a[@href="baz/index.html"]' 'baz'
//@ hasraw 'empty_mod_private/bar/sidebar-items.js' 'baz'
//@ matches 'empty_mod_private/bar/baz/index.html' '//h1' 'Module baz'
- //@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'empty_mod_private::bar::'
+ //@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'empty_mod_private::bar'
mod baz {}
}
diff --git a/tests/rustdoc/empty-mod-public.rs b/tests/rustdoc/empty-mod-public.rs
index 97f41a807c6cd..f06ac69f3ed81 100644
--- a/tests/rustdoc/empty-mod-public.rs
+++ b/tests/rustdoc/empty-mod-public.rs
@@ -1,17 +1,17 @@
//@ has 'empty_mod_public/index.html' '//a[@href="foo/index.html"]' 'foo'
//@ hasraw 'empty_mod_public/sidebar-items.js' 'foo'
//@ matches 'empty_mod_public/foo/index.html' '//h1' 'Module foo'
-//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'empty_mod_public::'
+//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'empty_mod_public'
pub mod foo {}
//@ has 'empty_mod_public/index.html' '//a[@href="bar/index.html"]' 'bar'
//@ hasraw 'empty_mod_public/sidebar-items.js' 'bar'
//@ matches 'empty_mod_public/bar/index.html' '//h1' 'Module bar'
-//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'empty_mod_public::'
+//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'empty_mod_public'
pub mod bar {
//@ has 'empty_mod_public/bar/index.html' '//a[@href="baz/index.html"]' 'baz'
//@ hasraw 'empty_mod_public/bar/sidebar-items.js' 'baz'
//@ matches 'empty_mod_public/bar/baz/index.html' '//h1' 'Module baz'
- //@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'empty_mod_public::bar::'
+ //@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'empty_mod_public::bar'
pub mod baz {}
}
diff --git a/tests/rustdoc/inline_cross/renamed-via-module.rs b/tests/rustdoc/inline_cross/renamed-via-module.rs
index a5af9b96f6c77..8bcdd9f7a39d0 100644
--- a/tests/rustdoc/inline_cross/renamed-via-module.rs
+++ b/tests/rustdoc/inline_cross/renamed-via-module.rs
@@ -11,18 +11,18 @@ extern crate foo;
//@ has - '//a/[@href="struct.StepBy.html"]' "StepBy"
//@ has foo/iter/struct.DeprecatedStepBy.html
//@ has - '//h1' "Struct DeprecatedStepBy"
-//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::iter::'
+//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::iter'
//@ has foo/iter/struct.StepBy.html
//@ has - '//h1' "Struct StepBy"
-//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::iter::'
+//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::iter'
//@ has bar/iter/index.html
//@ has - '//a/[@href="struct.DeprecatedStepBy.html"]' "DeprecatedStepBy"
//@ has - '//a/[@href="struct.StepBy.html"]' "StepBy"
//@ has bar/iter/struct.DeprecatedStepBy.html
//@ has - '//h1' "Struct DeprecatedStepBy"
-//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'bar::iter::'
+//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'bar::iter'
//@ has bar/iter/struct.StepBy.html
//@ has - '//h1' "Struct StepBy"
-//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'bar::iter::'
+//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'bar::iter'
pub use foo::iter;
diff --git a/tests/rustdoc/titles.rs b/tests/rustdoc/titles.rs
index 6113878a03f8a..922068adc5927 100644
--- a/tests/rustdoc/titles.rs
+++ b/tests/rustdoc/titles.rs
@@ -6,7 +6,7 @@
//@ count 'foo/index.html' '//h2[@class="location"]' 0
//@ matches 'foo/foo_mod/index.html' '//h1' 'Module foo_mod'
-//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::'
+//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo'
//@ matches - '//h2[@class="location"]' 'Module foo_mod'
pub mod foo_mod {
pub struct __Thing {}
@@ -14,36 +14,36 @@ pub mod foo_mod {
extern "C" {
//@ matches 'foo/fn.foo_ffn.html' '//h1' 'Function foo_ffn'
- //@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::'
+ //@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo'
pub fn foo_ffn();
}
//@ matches 'foo/fn.foo_fn.html' '//h1' 'Function foo_fn'
-//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::'
+//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo'
pub fn foo_fn() {}
//@ matches 'foo/trait.FooTrait.html' '//h1' 'Trait FooTrait'
-//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::'
+//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo'
//@ matches - '//h2[@class="location"]' 'FooTrait'
pub trait FooTrait {}
//@ matches 'foo/struct.FooStruct.html' '//h1' 'Struct FooStruct'
-//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::'
+//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo'
//@ matches - '//h2[@class="location"]' 'FooStruct'
pub struct FooStruct;
//@ matches 'foo/enum.FooEnum.html' '//h1' 'Enum FooEnum'
-//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::'
+//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo'
//@ matches - '//h2[@class="location"]' 'FooEnum'
pub enum FooEnum {}
//@ matches 'foo/type.FooType.html' '//h1' 'Type Alias FooType'
-//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::'
+//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo'
//@ matches - '//h2[@class="location"]' 'FooType'
pub type FooType = FooStruct;
//@ matches 'foo/macro.foo_macro.html' '//h1' 'Macro foo_macro'
-//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::'
+//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo'
#[macro_export]
macro_rules! foo_macro {
() => {};
@@ -55,15 +55,15 @@ macro_rules! foo_macro {
mod bool {}
//@ matches 'foo/static.FOO_STATIC.html' '//h1' 'Static FOO_STATIC'
-//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::'
+//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo'
pub static FOO_STATIC: FooStruct = FooStruct;
extern "C" {
//@ matches 'foo/static.FOO_FSTATIC.html' '//h1' 'Static FOO_FSTATIC'
- //@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::'
+ //@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo'
pub static FOO_FSTATIC: FooStruct;
}
//@ matches 'foo/constant.FOO_CONSTANT.html' '//h1' 'Constant FOO_CONSTANT'
-//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::'
+//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo'
pub const FOO_CONSTANT: FooStruct = FooStruct;
From f23d0b9c9dd42ef9153a8b86eecb0fd2fe62b6db Mon Sep 17 00:00:00 2001
From: onur-ozkan <work@onurozkan.dev>
Date: Sat, 21 Sep 2024 07:34:34 +0300
Subject: [PATCH 06/12] move enzyme flags from general cargo to rustc-specific
cargo
Signed-off-by: onur-ozkan <work@onurozkan.dev>
---
src/bootstrap/src/core/build_steps/compile.rs | 4 ++++
src/bootstrap/src/core/builder.rs | 6 ------
2 files changed, 4 insertions(+), 6 deletions(-)
diff --git a/src/bootstrap/src/core/build_steps/compile.rs b/src/bootstrap/src/core/build_steps/compile.rs
index e1ab1e7599e84..db7b239c0ae29 100644
--- a/src/bootstrap/src/core/build_steps/compile.rs
+++ b/src/bootstrap/src/core/build_steps/compile.rs
@@ -1057,6 +1057,10 @@ pub fn rustc_cargo(
// killed, rather than having an error bubble up and cause a panic.
cargo.rustflag("-Zon-broken-pipe=kill");
+ if builder.config.llvm_enzyme {
+ cargo.rustflag("-l").rustflag("Enzyme-19");
+ }
+
// We currently don't support cross-crate LTO in stage0. This also isn't hugely necessary
// and may just be a time sink.
if compiler.stage != 0 {
diff --git a/src/bootstrap/src/core/builder.rs b/src/bootstrap/src/core/builder.rs
index 003b11ec7cff4..ef020b00aa5a4 100644
--- a/src/bootstrap/src/core/builder.rs
+++ b/src/bootstrap/src/core/builder.rs
@@ -1591,12 +1591,6 @@ impl<'a> Builder<'a> {
rustflags.arg(sysroot_str);
}
- // https://rust-lang.zulipchat.com/#narrow/stream/182449-t-compiler.2Fhelp/topic/.E2.9C.94.20link.20new.20library.20into.20stage1.2Frustc
- if self.config.llvm_enzyme {
- rustflags.arg("-l");
- rustflags.arg("Enzyme-19");
- }
-
let use_new_symbol_mangling = match self.config.rust_new_symbol_mangling {
Some(setting) => {
// If an explicit setting is given, use that
From a35da65409c8a4c834b5df35d8955e287ae569e1 Mon Sep 17 00:00:00 2001
From: Veera <sveera.2001@gmail.com>
Date: Sat, 21 Sep 2024 11:11:11 -0400
Subject: [PATCH 07/12] Update Tests
---
.../evade-deduplication-issue-118612.rs | 24 +++++++++++++++++++
.../evade-deduplication-issue-118612.stderr | 20 ++++++++++++++++
2 files changed, 44 insertions(+)
create mode 100644 tests/ui/consts/const-eval/stable-metric/evade-deduplication-issue-118612.rs
create mode 100644 tests/ui/consts/const-eval/stable-metric/evade-deduplication-issue-118612.stderr
diff --git a/tests/ui/consts/const-eval/stable-metric/evade-deduplication-issue-118612.rs b/tests/ui/consts/const-eval/stable-metric/evade-deduplication-issue-118612.rs
new file mode 100644
index 0000000000000..a2d34eaa384c9
--- /dev/null
+++ b/tests/ui/consts/const-eval/stable-metric/evade-deduplication-issue-118612.rs
@@ -0,0 +1,24 @@
+//@ check-pass
+
+#![allow(long_running_const_eval)]
+
+//@ compile-flags: -Z tiny-const-eval-limit -Z deduplicate-diagnostics=yes
+const FOO: () = {
+ let mut i = 0;
+ loop {
+ //~^ WARN is taking a long time
+ //~| WARN is taking a long time
+ //~| WARN is taking a long time
+ //~| WARN is taking a long time
+ //~| WARN is taking a long time
+ if i == 1000 {
+ break;
+ } else {
+ i += 1;
+ }
+ }
+};
+
+fn main() {
+ FOO
+}
diff --git a/tests/ui/consts/const-eval/stable-metric/evade-deduplication-issue-118612.stderr b/tests/ui/consts/const-eval/stable-metric/evade-deduplication-issue-118612.stderr
new file mode 100644
index 0000000000000..b894b7b2132df
--- /dev/null
+++ b/tests/ui/consts/const-eval/stable-metric/evade-deduplication-issue-118612.stderr
@@ -0,0 +1,20 @@
+warning: constant evaluation is taking a long time
+ --> $DIR/evade-deduplication-issue-118612.rs:8:5
+ |
+LL | / loop {
+LL | |
+LL | |
+LL | |
+... |
+LL | | }
+LL | | }
+ | |_____^ the const evaluator is currently interpreting this expression
+ |
+help: the constant being evaluated
+ --> $DIR/evade-deduplication-issue-118612.rs:6:1
+ |
+LL | const FOO: () = {
+ | ^^^^^^^^^^^^^
+
+warning: 1 warning emitted
+
From 669f610f741f41bc8b2bef41d088589db4180355 Mon Sep 17 00:00:00 2001
From: Veera <sveera.2001@gmail.com>
Date: Sat, 21 Sep 2024 11:23:34 -0400
Subject: [PATCH 08/12] Prevent Deduplication of `LongRunningWarn`
---
.../src/const_eval/machine.rs | 9 ++-
compiler/rustc_const_eval/src/errors.rs | 2 +
.../evade-deduplication-issue-118612.stderr | 74 ++++++++++++++++++-
3 files changed, 83 insertions(+), 2 deletions(-)
diff --git a/compiler/rustc_const_eval/src/const_eval/machine.rs b/compiler/rustc_const_eval/src/const_eval/machine.rs
index 7405ca09342da..2025a465a2289 100644
--- a/compiler/rustc_const_eval/src/const_eval/machine.rs
+++ b/compiler/rustc_const_eval/src/const_eval/machine.rs
@@ -641,7 +641,14 @@ impl<'tcx> interpret::Machine<'tcx> for CompileTimeMachine<'tcx> {
// current number of evaluated terminators is a power of 2. The latter gives us a cheap
// way to implement exponential backoff.
let span = ecx.cur_span();
- ecx.tcx.dcx().emit_warn(LongRunningWarn { span, item_span: ecx.tcx.span });
+ // We store a unique number in `force_duplicate` to evade `-Z deduplicate-diagnostics`.
+ // `new_steps` is guaranteed to be unique because `ecx.machine.num_evaluated_steps` is
+ // always increasing.
+ ecx.tcx.dcx().emit_warn(LongRunningWarn {
+ span,
+ item_span: ecx.tcx.span,
+ force_duplicate: new_steps,
+ });
}
}
diff --git a/compiler/rustc_const_eval/src/errors.rs b/compiler/rustc_const_eval/src/errors.rs
index 0b366b43f95f6..bdd8c66bc244d 100644
--- a/compiler/rustc_const_eval/src/errors.rs
+++ b/compiler/rustc_const_eval/src/errors.rs
@@ -243,6 +243,8 @@ pub struct LongRunningWarn {
pub span: Span,
#[help]
pub item_span: Span,
+ // Used for evading `-Z deduplicate-diagnostics`.
+ pub force_duplicate: usize,
}
#[derive(Subdiagnostic)]
diff --git a/tests/ui/consts/const-eval/stable-metric/evade-deduplication-issue-118612.stderr b/tests/ui/consts/const-eval/stable-metric/evade-deduplication-issue-118612.stderr
index b894b7b2132df..cb19c59b15bc0 100644
--- a/tests/ui/consts/const-eval/stable-metric/evade-deduplication-issue-118612.stderr
+++ b/tests/ui/consts/const-eval/stable-metric/evade-deduplication-issue-118612.stderr
@@ -16,5 +16,77 @@ help: the constant being evaluated
LL | const FOO: () = {
| ^^^^^^^^^^^^^
-warning: 1 warning emitted
+warning: constant evaluation is taking a long time
+ --> $DIR/evade-deduplication-issue-118612.rs:8:5
+ |
+LL | / loop {
+LL | |
+LL | |
+LL | |
+... |
+LL | | }
+LL | | }
+ | |_____^ the const evaluator is currently interpreting this expression
+ |
+help: the constant being evaluated
+ --> $DIR/evade-deduplication-issue-118612.rs:6:1
+ |
+LL | const FOO: () = {
+ | ^^^^^^^^^^^^^
+
+warning: constant evaluation is taking a long time
+ --> $DIR/evade-deduplication-issue-118612.rs:8:5
+ |
+LL | / loop {
+LL | |
+LL | |
+LL | |
+... |
+LL | | }
+LL | | }
+ | |_____^ the const evaluator is currently interpreting this expression
+ |
+help: the constant being evaluated
+ --> $DIR/evade-deduplication-issue-118612.rs:6:1
+ |
+LL | const FOO: () = {
+ | ^^^^^^^^^^^^^
+
+warning: constant evaluation is taking a long time
+ --> $DIR/evade-deduplication-issue-118612.rs:8:5
+ |
+LL | / loop {
+LL | |
+LL | |
+LL | |
+... |
+LL | | }
+LL | | }
+ | |_____^ the const evaluator is currently interpreting this expression
+ |
+help: the constant being evaluated
+ --> $DIR/evade-deduplication-issue-118612.rs:6:1
+ |
+LL | const FOO: () = {
+ | ^^^^^^^^^^^^^
+
+warning: constant evaluation is taking a long time
+ --> $DIR/evade-deduplication-issue-118612.rs:8:5
+ |
+LL | / loop {
+LL | |
+LL | |
+LL | |
+... |
+LL | | }
+LL | | }
+ | |_____^ the const evaluator is currently interpreting this expression
+ |
+help: the constant being evaluated
+ --> $DIR/evade-deduplication-issue-118612.rs:6:1
+ |
+LL | const FOO: () = {
+ | ^^^^^^^^^^^^^
+
+warning: 5 warnings emitted
From e62b5e64a3f5ad34259d8d6ae4ad031083fa6692 Mon Sep 17 00:00:00 2001
From: Jubilee Young <workingjubilee@gmail.com>
Date: Sat, 21 Sep 2024 08:52:50 -0700
Subject: [PATCH 09/12] tests: Test that `extern "C" fn` ptrs lint on slices
---
tests/ui/lint/extern-C-fnptr-lints-slices.rs | 9 +++++++++
tests/ui/lint/extern-C-fnptr-lints-slices.stderr | 16 ++++++++++++++++
2 files changed, 25 insertions(+)
create mode 100644 tests/ui/lint/extern-C-fnptr-lints-slices.rs
create mode 100644 tests/ui/lint/extern-C-fnptr-lints-slices.stderr
diff --git a/tests/ui/lint/extern-C-fnptr-lints-slices.rs b/tests/ui/lint/extern-C-fnptr-lints-slices.rs
new file mode 100644
index 0000000000000..0c35eb37a4890
--- /dev/null
+++ b/tests/ui/lint/extern-C-fnptr-lints-slices.rs
@@ -0,0 +1,9 @@
+#[deny(improper_ctypes_definitions)]
+
+// It's an improper ctype (a slice) arg in an extern "C" fnptr.
+
+pub type F = extern "C" fn(&[u8]);
+//~^ ERROR: `extern` fn uses type `[u8]`, which is not FFI-safe
+
+
+fn main() {}
diff --git a/tests/ui/lint/extern-C-fnptr-lints-slices.stderr b/tests/ui/lint/extern-C-fnptr-lints-slices.stderr
new file mode 100644
index 0000000000000..d13f93ca96f22
--- /dev/null
+++ b/tests/ui/lint/extern-C-fnptr-lints-slices.stderr
@@ -0,0 +1,16 @@
+error: `extern` fn uses type `[u8]`, which is not FFI-safe
+ --> $DIR/extern-C-fnptr-lints-slices.rs:5:14
+ |
+LL | pub type F = extern "C" fn(&[u8]);
+ | ^^^^^^^^^^^^^^^^^^^^ not FFI-safe
+ |
+ = help: consider using a raw pointer instead
+ = note: slices have no C equivalent
+note: the lint level is defined here
+ --> $DIR/extern-C-fnptr-lints-slices.rs:1:8
+ |
+LL | #[deny(improper_ctypes_definitions)]
+ | ^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+error: aborting due to 1 previous error
+
From 7c352665525f19d99d4564d461589f47c290ac57 Mon Sep 17 00:00:00 2001
From: Guillaume Gomez <guillaume.gomez@huawei.com>
Date: Sat, 21 Sep 2024 15:58:18 +0200
Subject: [PATCH 10/12] Strip last backline from non-rust code examples
---
src/librustdoc/html/markdown.rs | 4 +++-
src/librustdoc/html/markdown/tests.rs | 6 ++----
2 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/src/librustdoc/html/markdown.rs b/src/librustdoc/html/markdown.rs
index 6f4665db6f1de..050ba60318e6a 100644
--- a/src/librustdoc/html/markdown.rs
+++ b/src/librustdoc/html/markdown.rs
@@ -261,7 +261,9 @@ impl<'a, I: Iterator<Item = Event<'a>>> Iterator for CodeBlocks<'_, 'a, I> {
</pre>\
</div>",
added_classes = added_classes.join(" "),
- text = Escape(&original_text),
+ text = Escape(
+ original_text.strip_suffix('\n').unwrap_or(&original_text)
+ ),
)
.into(),
));
diff --git a/src/librustdoc/html/markdown/tests.rs b/src/librustdoc/html/markdown/tests.rs
index e490099a92e14..3ec60c0efd216 100644
--- a/src/librustdoc/html/markdown/tests.rs
+++ b/src/librustdoc/html/markdown/tests.rs
@@ -524,15 +524,13 @@ fn test_ascii_with_prepending_hashtag() {
####.###..#....#....#..#.
#..#.#....#....#....#..#.
#..#.#....#....#....#..#.
-#..#.####.####.####..##..
-</code></pre></div>",
+#..#.####.####.####..##..</code></pre></div>",
);
t(
r#"```markdown
# hello
```"#,
"<div class=\"example-wrap\"><pre class=\"language-markdown\"><code>\
-# hello
-</code></pre></div>",
+# hello</code></pre></div>",
);
}
From 54efd132aeac8e12c6b2b734ab6f1ac3002f09fb Mon Sep 17 00:00:00 2001
From: Guillaume Gomez <guillaume.gomez@huawei.com>
Date: Sat, 21 Sep 2024 15:58:35 +0200
Subject: [PATCH 11/12] Generate line numbers for non-rust code examples as
well
---
src/librustdoc/html/static/js/main.js | 16 +++++++++-------
1 file changed, 9 insertions(+), 7 deletions(-)
diff --git a/src/librustdoc/html/static/js/main.js b/src/librustdoc/html/static/js/main.js
index a0ec45b5ef38c..0eba80133df12 100644
--- a/src/librustdoc/html/static/js/main.js
+++ b/src/librustdoc/html/static/js/main.js
@@ -986,7 +986,13 @@ function preLoadCss(cssUrl) {
}());
window.rustdoc_add_line_numbers_to_examples = () => {
- onEachLazy(document.getElementsByClassName("rust-example-rendered"), x => {
+ if (document.querySelector(".rustdoc.src")) {
+ // We are in the source code page, nothing to be done here!
+ return;
+ }
+ onEachLazy(document.querySelectorAll(
+ ":not(.scraped-example) > .example-wrap > pre:not(.example-line-numbers)",
+ ), x => {
const parent = x.parentNode;
const line_numbers = parent.querySelectorAll(".example-line-numbers");
if (line_numbers.length > 0) {
@@ -1005,12 +1011,8 @@ function preLoadCss(cssUrl) {
};
window.rustdoc_remove_line_numbers_from_examples = () => {
- onEachLazy(document.getElementsByClassName("rust-example-rendered"), x => {
- const parent = x.parentNode;
- const line_numbers = parent.querySelectorAll(".example-line-numbers");
- for (const node of line_numbers) {
- parent.removeChild(node);
- }
+ onEachLazy(document.querySelectorAll(".example-wrap > .example-line-numbers"), x => {
+ x.parentNode.removeChild(x);
});
};
From f451a410e34c15befefdfed3195442f0de6ec052 Mon Sep 17 00:00:00 2001
From: Guillaume Gomez <guillaume.gomez@huawei.com>
Date: Sat, 21 Sep 2024 17:00:42 +0200
Subject: [PATCH 12/12] Add GUI regression test for non-rust code blocks line
numbers
---
.../docblock-code-block-line-number.goml | 67 +++++++++++++++++--
1 file changed, 60 insertions(+), 7 deletions(-)
diff --git a/tests/rustdoc-gui/docblock-code-block-line-number.goml b/tests/rustdoc-gui/docblock-code-block-line-number.goml
index fed916ac24675..53f756dfcd64a 100644
--- a/tests/rustdoc-gui/docblock-code-block-line-number.goml
+++ b/tests/rustdoc-gui/docblock-code-block-line-number.goml
@@ -87,7 +87,7 @@ assert-css: ("#settings", {"display": "block"})
// Then, click the toggle button.
click: "input#line-numbers"
-wait-for: 100 // wait-for-false does not exist
+wait-for: 100 // FIXME: `wait-for-false` does not exist
assert-false: "pre.example-line-numbers"
assert-local-storage: {"rustdoc-line-numbers": "false" }
@@ -107,6 +107,8 @@ assert-css: (
click: "input#line-numbers"
wait-for: "pre.example-line-numbers"
assert-local-storage: {"rustdoc-line-numbers": "true" }
+wait-for: 100 // FIXME: `wait-for-false` does not exist
+assert: "pre.example-line-numbers"
// Same check with scraped examples line numbers.
go-to: "file://" + |DOC_PATH| + "/scrape_examples/fn.test_many.html"
@@ -145,9 +147,6 @@ assert-css: (
ALL,
)
-// Checking line numbers on scraped code examples.
-go-to: "file://" + |DOC_PATH| + "/scrape_examples/fn.test_many.html"
-
define-function: (
"check-padding",
[path, padding_bottom],
@@ -157,19 +156,19 @@ define-function: (
"padding-bottom": "0px",
"padding-left": "0px",
"padding-right": "0px",
- })
+ }, ALL)
assert-css: (|path| + " .src-line-numbers > pre", {
"padding-top": "14px",
"padding-bottom": |padding_bottom|,
"padding-left": "0px",
"padding-right": "0px",
- })
+ }, ALL)
assert-css: (|path| + " .src-line-numbers > pre > span", {
"padding-top": "0px",
"padding-bottom": "0px",
"padding-left": "8px",
"padding-right": "8px",
- })
+ }, ALL)
},
)
@@ -188,6 +187,35 @@ call-function: ("check-padding", {
"padding_bottom": "14px",
})
+define-function: ("check-line-numbers-existence", [], block {
+ assert-local-storage: {"rustdoc-line-numbers": "true" }
+ assert-false: ".example-line-numbers"
+ click: "#settings-menu"
+ wait-for: "#settings"
+
+ // Then, click the toggle button.
+ click: "input#line-numbers"
+ wait-for: 100 // FIXME: `wait-for-false` does not exist
+ assert-local-storage-false: {"rustdoc-line-numbers": "true" }
+ assert-false: ".example-line-numbers"
+ // Line numbers should still be there.
+ assert: ".src-line-numbers"
+ // Now disabling the setting.
+ click: "input#line-numbers"
+ wait-for: 100 // FIXME: `wait-for-false` does not exist
+ assert-local-storage: {"rustdoc-line-numbers": "true" }
+ assert-false: ".example-line-numbers"
+ // Line numbers should still be there.
+ assert: ".src-line-numbers"
+ // Closing settings menu.
+ click: "#settings-menu"
+ wait-for-css: ("#settings", {"display": "none"})
+})
+
+// Checking that turning off the line numbers setting won't remove line numbers from scraped
+// examples.
+call-function: ("check-line-numbers-existence", {})
+
// Now checking the line numbers in the source code page.
click: ".src"
assert-css: (".src-line-numbers", {
@@ -202,3 +230,28 @@ assert-css: (".src-line-numbers > a", {
"padding-left": "8px",
"padding-right": "8px",
})
+// Checking that turning off the line numbers setting won't remove line numbers.
+call-function: ("check-line-numbers-existence", {})
+
+// Now checking that even non-rust code blocks have line numbers generated.
+go-to: "file://" + |DOC_PATH| + "/lib2/sub_mod/struct.Foo.html"
+assert-local-storage: {"rustdoc-line-numbers": "true" }
+assert: ".example-wrap > pre.language-txt"
+assert: ".example-wrap > pre.rust"
+assert-count: (".example-wrap", 2)
+assert-count: (".example-wrap > pre.example-line-numbers", 2)
+
+click: "#settings-menu"
+wait-for: "#settings"
+
+// Then, click the toggle button.
+click: "input#line-numbers"
+wait-for: 100 // FIXME: `wait-for-false` does not exist
+assert-local-storage-false: {"rustdoc-line-numbers": "true" }
+assert-count: (".example-wrap > pre.example-line-numbers", 0)
+
+// Now turning off the setting.
+click: "input#line-numbers"
+wait-for: 100 // FIXME: `wait-for-false` does not exist
+assert-local-storage: {"rustdoc-line-numbers": "true" }
+assert-count: (".example-wrap > pre.example-line-numbers", 2)