rustdoc: improve static file handling

All static files used by rustdoc are now stored in static.files/ and
include a hash of their contents. They no longer include the contents of
the --resource-suffix flag. This clarifies caching semantics: anything
in static.files can use a long Cache-Control header because any updates
will show up as a new URL.

Invocation-specific files like crates-NN.js, search-index-NN.js,
sidebar-items-NN.js, and implementors/trait.Xyz.js still get the
resource suffix.

Author: jsha

src/librustdoc/html/layout.rs

@@ -2,10 +2,10 @@ use std::path::PathBuf;
 
 use rustc_data_structures::fx::FxHashMap;
 
-use crate::error::Error;
 use crate::externalfiles::ExternalHtml;
 use crate::html::format::{Buffer, Print};
 use crate::html::render::{ensure_trailing_slash, StylePath};
+use crate::html::static_files;
 
 use askama::Template;
 
@@ -45,6 +45,25 @@ struct PageLayout<'a> {
     static_root_path: &'a str,
     page: &'a Page<'a>,
     layout: &'a Layout,
+    font_preloads: Vec<&'static static_files::StaticFile>,
+
+    storage_js: &'static static_files::StaticFile,
+    main_js: &'static static_files::StaticFile,
+    source_script_js: &'static static_files::StaticFile,
+    scrape_examples_js: &'static static_files::StaticFile,
+
+    search_js: &'static static_files::StaticFile,
+    settings_js: &'static static_files::StaticFile,
+    settings_css: &'static static_files::StaticFile,
+
+    favicon_svg: &'static static_files::StaticFile,
+    favicon_png_16: &'static static_files::StaticFile,
+    favicon_png_32: &'static static_files::StaticFile,
+
+    rust_logo_svg: &'static static_files::StaticFile,
+    wheel_svg: &'static static_files::StaticFile,
+
+    css: Vec<&'static static_files::StaticFile>,
     themes: Vec<String>,
     sidebar: String,
     content: String,
@@ -61,19 +80,47 @@ pub(crate) fn render<T: Print, S: Print>(
 ) -> String {
     let static_root_path = page.get_static_root_path();
     let krate_with_trailing_slash = ensure_trailing_slash(&layout.krate).to_string();
-    let mut themes: Vec<String> = style_files
-        .iter()
-        .map(StylePath::basename)
-        .collect::<Result<_, Error>>()
-        .unwrap_or_default();
+    let mut themes: Vec<String> =
+        style_files.iter().map(|s| s.path.display().to_string()).collect();
+    themes.push(static_files::themes::LIGHT.to_string());
+    themes.push(static_files::themes::DARK.to_string());
+    themes.push(static_files::themes::AYU.to_string());
     themes.sort();
+    let css = vec![&static_files::NORMALIZE_CSS, &static_files::RUSTDOC_CSS];
+
     let rustdoc_version = rustc_interface::util::version_str().unwrap_or("unknown version");
     let content = Buffer::html().to_display(t); // Note: This must happen before making the sidebar.
     let sidebar = Buffer::html().to_display(sidebar);
     PageLayout {
         static_root_path,
         page,
         layout,
+        font_preloads: vec![
+            &static_files::source_serif_4::REGULAR,
+            &static_files::source_serif_4::BOLD,
+            &static_files::fira_sans::REGULAR,
+            &static_files::fira_sans::MEDIUM,
+            &static_files::source_code_pro::REGULAR,
+            &static_files::source_code_pro::SEMIBOLD,
+        ],
+
+        storage_js: &static_files::STORAGE_JS,
+        main_js: &static_files::MAIN_JS,
+        source_script_js: &static_files::sidebar::SOURCE_SCRIPT,
+        scrape_examples_js: &static_files::SCRAPE_EXAMPLES_JS,
+
+        search_js: &static_files::SEARCH_JS,
+        settings_js: &static_files::SETTINGS_JS,
+        settings_css: &static_files::SETTINGS_CSS,
+
+        favicon_svg: &static_files::RUST_FAVICON_SVG,
+        favicon_png_16: &static_files::RUST_FAVICON_PNG_16,
+        favicon_png_32: &static_files::RUST_FAVICON_PNG_32,
+
+        rust_logo_svg: &static_files::RUST_LOGO_SVG,
+        wheel_svg: &static_files::WHEEL_SVG,
+
+        css,
         themes,
         sidebar,
         content,

src/librustdoc/html/render/context.rs

@@ -469,7 +469,7 @@ impl<'tcx> FormatRenderer<'tcx> for Context<'tcx> {
         );
 
         let (sender, receiver) = channel();
-        let mut scx = SharedContext {
+        let scx = SharedContext {
             tcx,
             src_root,
             local_sources,
@@ -501,9 +501,9 @@ impl<'tcx> FormatRenderer<'tcx> for Context<'tcx> {
         // by the browser as the theme stylesheet. The theme system (hackily) works by
         // changing the href to this stylesheet. All other themes are disabled to
         // prevent rule conflicts
-        scx.style_files.push(StylePath { path: PathBuf::from("light.css") });
-        scx.style_files.push(StylePath { path: PathBuf::from("dark.css") });
-        scx.style_files.push(StylePath { path: PathBuf::from("ayu.css") });
+        // scx.style_files.push(StylePath { path: PathBuf::from("light.css") });
+        // scx.style_files.push(StylePath { path: PathBuf::from("dark.css") });
+        // scx.style_files.push(StylePath { path: PathBuf::from("ayu.css") });
 
         let dst = output;
         scx.ensure_dir(&dst)?;

src/librustdoc/html/render/mod.rs

@@ -339,7 +339,7 @@ impl AllTypes {
 }
 
 fn scrape_examples_help(shared: &SharedContext<'_>) -> String {
-    let mut content = SCRAPE_EXAMPLES_HELP_MD.to_owned();
+    let mut content = SCRAPE_EXAMPLES_HELP_MD.as_str().to_owned();
     content.push_str(&format!(
       "## More information\n\n\
       If you want more information about this feature, please read the [corresponding chapter in the Rustdoc book]({}/rustdoc/scraped-examples.html).",

src/librustdoc/html/render/print_item.rs

@@ -30,10 +30,10 @@ use crate::html::format::{
     join_with_double_colon, print_abi_with_space, print_constness_with_space, print_where_clause,
     Buffer, Ending, PrintWithSpace,
 };
-use crate::html::highlight;
 use crate::html::layout::Page;
 use crate::html::markdown::{HeadingOffset, MarkdownSummaryLine};
 use crate::html::url_parts_builder::UrlPartsBuilder;
+use crate::html::{highlight, static_files};
 
 use askama::Template;
 use itertools::Itertools;
@@ -52,8 +52,8 @@ struct PathComponent {
 #[derive(Template)]
 #[template(path = "print_item.html")]
 struct ItemVars<'a> {
-    page: &'a Page<'a>,
     static_root_path: &'a str,
+    clipboard_svg: &'static static_files::StaticFile,
     typ: &'a str,
     name: &'a str,
     item_type: &'a str,
@@ -147,8 +147,8 @@ pub(super) fn print_item(
     };
 
     let item_vars = ItemVars {
-        page,
         static_root_path: page.get_static_root_path(),
+        clipboard_svg: &static_files::CLIPBOARD_SVG,
         typ,
         name: item.name.as_ref().unwrap().as_str(),
         item_type: &item.type_().to_string(),