src/librustdoc/html/layout.rs

   1 use std::path::PathBuf;
   2
   3 use crate::externalfiles::ExternalHtml;
   4 use crate::html::escape::Escape;
   5 use crate::html::format::{Buffer, Print};
   6 use crate::html::render::ensure_trailing_slash;
   7
   8 #[derive(Clone)]
   9 pub struct Layout {
  10     pub logo: String,
  11     pub favicon: String,
  12     pub external_html: ExternalHtml,
  13     pub krate: String,
  14     /// The given user css file which allow to customize the generated
  15     /// documentation theme.
  16     pub css_file_extension: Option<PathBuf>,
  17     /// If false, the `select` element to have search filtering by crates on rendered docs
  18     /// won't be generated.
  19     pub generate_search_filter: bool,
  20 }
  21
  22 pub struct Page<'a> {
  23     pub title: &'a str,
  24     pub css_class: &'a str,
  25     pub root_path: &'a str,
  26     pub static_root_path: Option<&'a str>,
  27     pub description: &'a str,
  28     pub keywords: &'a str,
  29     pub resource_suffix: &'a str,
  30     pub extra_scripts: &'a [&'a str],
  31     pub static_extra_scripts: &'a [&'a str],
  32 }
  33
  34 pub fn render<T: Print, S: Print>(
  35     layout: &Layout,
  36     page: &Page<'_>,
  37     sidebar: S,
  38     t: T,
  39     themes: &[PathBuf],
  40 ) -> String {
  41     let static_root_path = page.static_root_path.unwrap_or(page.root_path);
  42     format!(
  43         "<!DOCTYPE html>\
  44 <html lang=\"en\">\
  45 <head>\
  46     <meta charset=\"utf-8\">\
  47     <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">\
  48     <meta name=\"generator\" content=\"rustdoc\">\
  49     <meta name=\"description\" content=\"{description}\">\
  50     <meta name=\"keywords\" content=\"{keywords}\">\
  51     <title>{title}</title>\
  52     <link rel=\"stylesheet\" type=\"text/css\" href=\"{static_root_path}normalize{suffix}.css\">\
  53     <link rel=\"stylesheet\" type=\"text/css\" href=\"{static_root_path}rustdoc{suffix}.css\" \
  54           id=\"mainThemeStyle\">\
  55     {themes}\
  56     <link rel=\"stylesheet\" type=\"text/css\" href=\"{static_root_path}dark{suffix}.css\">\
  57     <link rel=\"stylesheet\" type=\"text/css\" href=\"{static_root_path}light{suffix}.css\" \
  58           id=\"themeStyle\">\
  59     <script src=\"{static_root_path}storage{suffix}.js\"></script>\
  60     <noscript><link rel=\"stylesheet\" href=\"{static_root_path}noscript{suffix}.css\"></noscript>\
  61     {css_extension}\
  62     {favicon}\
  63     {in_header}\
  64     <style type=\"text/css\">\
  65     #crate-search{{background-image:url(\"{static_root_path}down-arrow{suffix}.svg\");}}\
  66     </style>\
  67 </head>\
  68 <body class=\"rustdoc {css_class}\">\
  69     <!--[if lte IE 8]>\
  70     <div class=\"warning\">\
  71         This old browser is unsupported and will most likely display funky \
  72         things.\
  73     </div>\
  74     <![endif]-->\
  75     {before_content}\
  76     <nav class=\"sidebar\">\
  77         <div class=\"sidebar-menu\">&#9776;</div>\
  78         {logo}\
  79         {sidebar}\
  80     </nav>\
  81     <div class=\"theme-picker\">\
  82         <button id=\"theme-picker\" aria-label=\"Pick another theme!\">\
  83             <img src=\"{static_root_path}brush{suffix}.svg\" \
  84                  width=\"18\" \
  85                  alt=\"Pick another theme!\">\
  86         </button>\
  87         <div id=\"theme-choices\"></div>\
  88     </div>\
  89     <script src=\"{static_root_path}theme{suffix}.js\"></script>\
  90     <nav class=\"sub\">\
  91         <form class=\"search-form\">\
  92             <div class=\"search-container\">\
  93                 <div>{filter_crates}\
  94                     <input class=\"search-input\" name=\"search\" \
  95                            disabled \
  96                            autocomplete=\"off\" \
  97                            spellcheck=\"false\" \
  98                            placeholder=\"Click or press ‘S’ to search, ‘?’ for more options…\" \
  99                            type=\"search\">\
 100                 </div>\
 101                 <a id=\"settings-menu\" href=\"{root_path}settings.html\">\
 102                     <img src=\"{static_root_path}wheel{suffix}.svg\" \
 103                          width=\"18\" \
 104                          alt=\"Change settings\">\
 105                 </a>\
 106             </div>\
 107         </form>\
 108     </nav>\
 109     <section id=\"main\" class=\"content\">{content}</section>\
 110     <section id=\"search\" class=\"content hidden\"></section>\
 111     <section class=\"footer\"></section>\
 112     {after_content}\
 113     <script>\
 114         window.rootPath = \"{root_path}\";\
 115         window.currentCrate = \"{krate}\";\
 116     </script>\
 117     <script src=\"{root_path}aliases{suffix}.js\"></script>\
 118     <script src=\"{static_root_path}main{suffix}.js\"></script>\
 119     {static_extra_scripts}\
 120     {extra_scripts}\
 121     <script defer src=\"{root_path}search-index{suffix}.js\"></script>\
 122 </body>\
 123 </html>",
 124         css_extension = if layout.css_file_extension.is_some() {
 125             format!(
 126                 "<link rel=\"stylesheet\" \
 127                        type=\"text/css\" \
 128                        href=\"{static_root_path}theme{suffix}.css\">",
 129                 static_root_path = static_root_path,
 130                 suffix = page.resource_suffix
 131             )
 132         } else {
 133             String::new()
 134         },
 135         content = Buffer::html().to_display(t),
 136         static_root_path = static_root_path,
 137         root_path = page.root_path,
 138         css_class = page.css_class,
 139         logo = {
 140             let p = format!("{}{}", page.root_path, layout.krate);
 141             let p = ensure_trailing_slash(&p);
 142             if layout.logo.is_empty() {
 143                 format!(
 144                     "<a href='{path}index.html'>\
 145                      <div class='logo-container'>\
 146                      <img src='{static_root_path}rust-logo{suffix}.png' alt='logo'></div></a>",
 147                     path = p,
 148                     static_root_path = static_root_path,
 149                     suffix = page.resource_suffix
 150                 )
 151             } else {
 152                 format!(
 153                     "<a href='{}index.html'>\
 154                      <div class='logo-container'><img src='{}' alt='logo'></div></a>",
 155                     p, layout.logo
 156                 )
 157             }
 158         },
 159         title = page.title,
 160         description = page.description,
 161         keywords = page.keywords,
 162         favicon = if layout.favicon.is_empty() {
 163             format!(
 164                 r#"<link rel="shortcut icon" href="{static_root_path}favicon{suffix}.ico">"#,
 165                 static_root_path = static_root_path,
 166                 suffix = page.resource_suffix
 167             )
 168         } else {
 169             format!(r#"<link rel="shortcut icon" href="{}">"#, layout.favicon)
 170         },
 171         in_header = layout.external_html.in_header,
 172         before_content = layout.external_html.before_content,
 173         after_content = layout.external_html.after_content,
 174         sidebar = Buffer::html().to_display(sidebar),
 175         krate = layout.krate,
 176         themes = themes
 177             .iter()
 178             .filter_map(|t| t.file_stem())
 179             .filter_map(|t| t.to_str())
 180             .map(|t| format!(
 181                 r#"<link rel="stylesheet" type="text/css" href="{}.css">"#,
 182                 Escape(&format!("{}{}{}", static_root_path, t, page.resource_suffix))
 183             ))
 184             .collect::<String>(),
 185         suffix = page.resource_suffix,
 186         static_extra_scripts = page
 187             .static_extra_scripts
 188             .iter()
 189             .map(|e| {
 190                 format!(
 191                     "<script src=\"{static_root_path}{extra_script}.js\"></script>",
 192                     static_root_path = static_root_path,
 193                     extra_script = e
 194                 )
 195             })
 196             .collect::<String>(),
 197         extra_scripts = page
 198             .extra_scripts
 199             .iter()
 200             .map(|e| {
 201                 format!(
 202                     "<script src=\"{root_path}{extra_script}.js\"></script>",
 203                     root_path = page.root_path,
 204                     extra_script = e
 205                 )
 206             })
 207             .collect::<String>(),
 208         filter_crates = if layout.generate_search_filter {
 209             "<select id=\"crate-search\">\
 210             <option value=\"All crates\">All crates</option>\
 211         </select>"
 212         } else {
 213             ""
 214         },
 215     )
 216 }
 217
 218 pub fn redirect(url: &str) -> String {
 219     // <script> triggers a redirect before refresh, so this is fine.
 220     format!(
 221         r##"<!DOCTYPE html>
 222 <html lang="en">
 223 <head>
 224     <meta http-equiv="refresh" content="0;URL={url}">
 225 </head>
 226 <body>
 227     <p>Redirecting to <a href="{url}">{url}</a>...</p>
 228     <script>location.replace("{url}" + location.search + location.hash);</script>
 229 </body>
 230 </html>"##,
 231         url = url,
 232     )
 233 }