src/librustdoc/html/render/context.rs

   1 use std::cell::RefCell;
   2 use std::collections::BTreeMap;
   3 use std::io;
   4 use std::path::{Path, PathBuf};
   5 use std::rc::Rc;
   6 use std::sync::mpsc::{channel, Receiver};
   7
   8 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
   9 use rustc_hir::def_id::{DefId, LOCAL_CRATE};
  10 use rustc_middle::ty::TyCtxt;
  11 use rustc_session::Session;
  12 use rustc_span::edition::Edition;
  13 use rustc_span::source_map::FileName;
  14 use rustc_span::symbol::sym;
  15
  16 use super::cache::{build_index, ExternalLocation};
  17 use super::print_item::{full_path, item_path, print_item};
  18 use super::write_shared::write_shared;
  19 use super::{print_sidebar, settings, AllTypes, NameDoc, StylePath, BASIC_KEYWORDS};
  20
  21 use crate::clean::{self, ExternalCrate};
  22 use crate::config::RenderOptions;
  23 use crate::docfs::{DocFS, PathError};
  24 use crate::error::Error;
  25 use crate::formats::cache::Cache;
  26 use crate::formats::item_type::ItemType;
  27 use crate::formats::FormatRenderer;
  28 use crate::html::escape::Escape;
  29 use crate::html::format::Buffer;
  30 use crate::html::markdown::{self, plain_text_summary, ErrorCodes, IdMap};
  31 use crate::html::{layout, sources};
  32
  33 /// Major driving force in all rustdoc rendering. This contains information
  34 /// about where in the tree-like hierarchy rendering is occurring and controls
  35 /// how the current page is being rendered.
  36 ///
  37 /// It is intended that this context is a lightweight object which can be fairly
  38 /// easily cloned because it is cloned per work-job (about once per item in the
  39 /// rustdoc tree).
  40 crate struct Context<'tcx> {
  41     /// Current hierarchy of components leading down to what's currently being
  42     /// rendered
  43     pub(crate) current: Vec<String>,
  44     /// The current destination folder of where HTML artifacts should be placed.
  45     /// This changes as the context descends into the module hierarchy.
  46     pub(super) dst: PathBuf,
  47     /// A flag, which when `true`, will render pages which redirect to the
  48     /// real location of an item. This is used to allow external links to
  49     /// publicly reused items to redirect to the right location.
  50     pub(super) render_redirect_pages: bool,
  51     /// The map used to ensure all generated 'id=' attributes are unique.
  52     pub(super) id_map: RefCell<IdMap>,
  53     /// Tracks section IDs for `Deref` targets so they match in both the main
  54     /// body and the sidebar.
  55     pub(super) deref_id_map: RefCell<FxHashMap<DefId, String>>,
  56     /// Shared mutable state.
  57     ///
  58     /// Issue for improving the situation: [#82381][]
  59     ///
  60     /// [#82381]: https://github.com/rust-lang/rust/issues/82381
  61     pub(super) shared: Rc<SharedContext<'tcx>>,
  62     /// The [`Cache`] used during rendering.
  63     ///
  64     /// Ideally the cache would be in [`SharedContext`], but it's mutated
  65     /// between when the `SharedContext` is created and when `Context`
  66     /// is created, so more refactoring would be needed.
  67     ///
  68     /// It's immutable once in `Context`, so it's not as bad that it's not in
  69     /// `SharedContext`.
  70     // FIXME: move `cache` to `SharedContext`
  71     pub(super) cache: Rc<Cache>,
  72 }
  73
  74 // `Context` is cloned a lot, so we don't want the size to grow unexpectedly.
  75 #[cfg(target_arch = "x86_64")]
  76 rustc_data_structures::static_assert_size!(Context<'_>, 152);
  77
  78 /// Shared mutable state used in [`Context`] and elsewhere.
  79 crate struct SharedContext<'tcx> {
  80     crate tcx: TyCtxt<'tcx>,
  81     /// The path to the crate root source minus the file name.
  82     /// Used for simplifying paths to the highlighted source code files.
  83     crate src_root: PathBuf,
  84     /// This describes the layout of each page, and is not modified after
  85     /// creation of the context (contains info like the favicon and added html).
  86     crate layout: layout::Layout,
  87     /// This flag indicates whether `[src]` links should be generated or not. If
  88     /// the source files are present in the html rendering, then this will be
  89     /// `true`.
  90     crate include_sources: bool,
  91     /// The local file sources we've emitted and their respective url-paths.
  92     crate local_sources: FxHashMap<PathBuf, String>,
  93     /// Whether the collapsed pass ran
  94     collapsed: bool,
  95     /// The base-URL of the issue tracker for when an item has been tagged with
  96     /// an issue number.
  97     pub(super) issue_tracker_base_url: Option<String>,
  98     /// The directories that have already been created in this doc run. Used to reduce the number
  99     /// of spurious `create_dir_all` calls.
 100     created_dirs: RefCell<FxHashSet<PathBuf>>,
 101     /// This flag indicates whether listings of modules (in the side bar and documentation itself)
 102     /// should be ordered alphabetically or in order of appearance (in the source code).
 103     pub(super) sort_modules_alphabetically: bool,
 104     /// Additional CSS files to be added to the generated docs.
 105     crate style_files: Vec<StylePath>,
 106     /// Suffix to be added on resource files (if suffix is "-v2" then "light.css" becomes
 107     /// "light-v2.css").
 108     crate resource_suffix: String,
 109     /// Optional path string to be used to load static files on output pages. If not set, uses
 110     /// combinations of `../` to reach the documentation root.
 111     crate static_root_path: Option<String>,
 112     /// The fs handle we are working with.
 113     crate fs: DocFS,
 114     pub(super) codes: ErrorCodes,
 115     pub(super) playground: Option<markdown::Playground>,
 116     all: RefCell<AllTypes>,
 117     /// Storage for the errors produced while generating documentation so they
 118     /// can be printed together at the end.
 119     errors: Receiver<String>,
 120     /// `None` by default, depends on the `generate-redirect-map` option flag. If this field is set
 121     /// to `Some(...)`, it'll store redirections and then generate a JSON file at the top level of
 122     /// the crate.
 123     redirections: Option<RefCell<FxHashMap<String, String>>>,
 124 }
 125
 126 impl SharedContext<'_> {
 127     crate fn ensure_dir(&self, dst: &Path) -> Result<(), Error> {
 128         let mut dirs = self.created_dirs.borrow_mut();
 129         if !dirs.contains(dst) {
 130             try_err!(self.fs.create_dir_all(dst), dst);
 131             dirs.insert(dst.to_path_buf());
 132         }
 133
 134         Ok(())
 135     }
 136
 137     /// Based on whether the `collapse-docs` pass was run, return either the `doc_value` or the
 138     /// `collapsed_doc_value` of the given item.
 139     crate fn maybe_collapsed_doc_value<'a>(&self, item: &'a clean::Item) -> Option<String> {
 140         if self.collapsed { item.collapsed_doc_value() } else { item.doc_value() }
 141     }
 142
 143     crate fn edition(&self) -> Edition {
 144         self.tcx.sess.edition()
 145     }
 146 }
 147
 148 impl<'tcx> Context<'tcx> {
 149     pub(crate) fn tcx(&self) -> TyCtxt<'tcx> {
 150         self.shared.tcx
 151     }
 152
 153     pub(crate) fn cache(&self) -> &Cache {
 154         &self.cache
 155     }
 156
 157     fn sess(&self) -> &'tcx Session {
 158         &self.shared.tcx.sess
 159     }
 160
 161     pub(super) fn derive_id(&self, id: String) -> String {
 162         let mut map = self.id_map.borrow_mut();
 163         map.derive(id)
 164     }
 165
 166     /// String representation of how to get back to the root path of the 'doc/'
 167     /// folder in terms of a relative URL.
 168     pub(super) fn root_path(&self) -> String {
 169         "../".repeat(self.current.len())
 170     }
 171
 172     fn render_item(&self, it: &clean::Item, is_module: bool) -> String {
 173         let mut title = String::new();
 174         if !is_module {
 175             title.push_str(&it.name.unwrap().as_str());
 176         }
 177         if !it.is_primitive() && !it.is_keyword() {
 178             if !is_module {
 179                 title.push_str(" in ");
 180             }
 181             // No need to include the namespace for primitive types and keywords
 182             title.push_str(&self.current.join("::"));
 183         };
 184         title.push_str(" - Rust");
 185         let tyname = it.type_();
 186         let desc = it.doc_value().as_ref().map(|doc| plain_text_summary(&doc));
 187         let desc = if let Some(desc) = desc {
 188             desc
 189         } else if it.is_crate() {
 190             format!("API documentation for the Rust `{}` crate.", self.shared.layout.krate)
 191         } else {
 192             format!(
 193                 "API documentation for the Rust `{}` {} in crate `{}`.",
 194                 it.name.as_ref().unwrap(),
 195                 tyname,
 196                 self.shared.layout.krate
 197             )
 198         };
 199         let keywords = make_item_keywords(it);
 200         let page = layout::Page {
 201             css_class: tyname.as_str(),
 202             root_path: &self.root_path(),
 203             static_root_path: self.shared.static_root_path.as_deref(),
 204             title: &title,
 205             description: &desc,
 206             keywords: &keywords,
 207             resource_suffix: &self.shared.resource_suffix,
 208             extra_scripts: &[],
 209             static_extra_scripts: &[],
 210         };
 211
 212         if !self.render_redirect_pages {
 213             layout::render(
 214                 &self.shared.layout,
 215                 &page,
 216                 |buf: &mut _| print_sidebar(self, it, buf),
 217                 |buf: &mut _| print_item(self, it, buf),
 218                 &self.shared.style_files,
 219             )
 220         } else {
 221             if let Some(&(ref names, ty)) = self.cache.paths.get(&it.def_id) {
 222                 let mut path = String::new();
 223                 for name in &names[..names.len() - 1] {
 224                     path.push_str(name);
 225                     path.push('/');
 226                 }
 227                 path.push_str(&item_path(ty, names.last().unwrap()));
 228                 match self.shared.redirections {
 229                     Some(ref redirections) => {
 230                         let mut current_path = String::new();
 231                         for name in &self.current {
 232                             current_path.push_str(name);
 233                             current_path.push('/');
 234                         }
 235                         current_path.push_str(&item_path(ty, names.last().unwrap()));
 236                         redirections.borrow_mut().insert(current_path, path);
 237                     }
 238                     None => return layout::redirect(&format!("{}{}", self.root_path(), path)),
 239                 }
 240             }
 241             String::new()
 242         }
 243     }
 244
 245     /// Construct a map of items shown in the sidebar to a plain-text summary of their docs.
 246     fn build_sidebar_items(&self, m: &clean::Module) -> BTreeMap<String, Vec<NameDoc>> {
 247         // BTreeMap instead of HashMap to get a sorted output
 248         let mut map: BTreeMap<_, Vec<_>> = BTreeMap::new();
 249         for item in &m.items {
 250             if item.is_stripped() {
 251                 continue;
 252             }
 253
 254             let short = item.type_();
 255             let myname = match item.name {
 256                 None => continue,
 257                 Some(ref s) => s.to_string(),
 258             };
 259             let short = short.to_string();
 260             map.entry(short).or_default().push((
 261                 myname,
 262                 Some(item.doc_value().map_or_else(String::new, |s| plain_text_summary(&s))),
 263             ));
 264         }
 265
 266         if self.shared.sort_modules_alphabetically {
 267             for items in map.values_mut() {
 268                 items.sort();
 269             }
 270         }
 271         map
 272     }
 273
 274     /// Generates a url appropriate for an `href` attribute back to the source of
 275     /// this item.
 276     ///
 277     /// The url generated, when clicked, will redirect the browser back to the
 278     /// original source code.
 279     ///
 280     /// If `None` is returned, then a source link couldn't be generated. This
 281     /// may happen, for example, with externally inlined items where the source
 282     /// of their crate documentation isn't known.
 283     pub(super) fn src_href(&self, item: &clean::Item) -> Option<String> {
 284         if item.span(self.tcx()).is_dummy() {
 285             return None;
 286         }
 287         let mut root = self.root_path();
 288         let mut path = String::new();
 289         let cnum = item.span(self.tcx()).cnum(self.sess());
 290
 291         // We can safely ignore synthetic `SourceFile`s.
 292         let file = match item.span(self.tcx()).filename(self.sess()) {
 293             FileName::Real(ref path) => path.local_path_if_available().to_path_buf(),
 294             _ => return None,
 295         };
 296         let file = &file;
 297
 298         let symbol;
 299         let (krate, path) = if cnum == LOCAL_CRATE {
 300             if let Some(path) = self.shared.local_sources.get(file) {
 301                 (self.shared.layout.krate.as_str(), path)
 302             } else {
 303                 return None;
 304             }
 305         } else {
 306             let (krate, src_root) = match *self.cache.extern_locations.get(&cnum)? {
 307                 ExternalLocation::Local => {
 308                     let e = ExternalCrate { crate_num: cnum };
 309                     (e.name(self.tcx()), e.src_root(self.tcx()))
 310                 }
 311                 ExternalLocation::Remote(ref s) => {
 312                     root = s.to_string();
 313                     let e = ExternalCrate { crate_num: cnum };
 314                     (e.name(self.tcx()), e.src_root(self.tcx()))
 315                 }
 316                 ExternalLocation::Unknown => return None,
 317             };
 318
 319             sources::clean_path(&src_root, file, false, |component| {
 320                 path.push_str(&component.to_string_lossy());
 321                 path.push('/');
 322             });
 323             let mut fname = file.file_name().expect("source has no filename").to_os_string();
 324             fname.push(".html");
 325             path.push_str(&fname.to_string_lossy());
 326             symbol = krate.as_str();
 327             (&*symbol, &path)
 328         };
 329
 330         let loline = item.span(self.tcx()).lo(self.sess()).line;
 331         let hiline = item.span(self.tcx()).hi(self.sess()).line;
 332         let lines =
 333             if loline == hiline { loline.to_string() } else { format!("{}-{}", loline, hiline) };
 334         Some(format!(
 335             "{root}src/{krate}/{path}#{lines}",
 336             root = Escape(&root),
 337             krate = krate,
 338             path = path,
 339             lines = lines
 340         ))
 341     }
 342 }
 343
 344 /// Generates the documentation for `crate` into the directory `dst`
 345 impl<'tcx> FormatRenderer<'tcx> for Context<'tcx> {
 346     fn descr() -> &'static str {
 347         "html"
 348     }
 349
 350     const RUN_ON_MODULE: bool = true;
 351
 352     fn init(
 353         mut krate: clean::Crate,
 354         options: RenderOptions,
 355         mut cache: Cache,
 356         tcx: TyCtxt<'tcx>,
 357     ) -> Result<(Self, clean::Crate), Error> {
 358         // need to save a copy of the options for rendering the index page
 359         let md_opts = options.clone();
 360         let emit_crate = options.should_emit_crate();
 361         let RenderOptions {
 362             output,
 363             external_html,
 364             id_map,
 365             playground_url,
 366             sort_modules_alphabetically,
 367             themes: style_files,
 368             default_settings,
 369             extension_css,
 370             resource_suffix,
 371             static_root_path,
 372             generate_search_filter,
 373             unstable_features,
 374             generate_redirect_map,
 375             ..
 376         } = options;
 377
 378         let src_root = match krate.src {
 379             FileName::Real(ref p) => match p.local_path_if_available().parent() {
 380                 Some(p) => p.to_path_buf(),
 381                 None => PathBuf::new(),
 382             },
 383             _ => PathBuf::new(),
 384         };
 385         // If user passed in `--playground-url` arg, we fill in crate name here
 386         let mut playground = None;
 387         if let Some(url) = playground_url {
 388             playground =
 389                 Some(markdown::Playground { crate_name: Some(krate.name.to_string()), url });
 390         }
 391         let mut layout = layout::Layout {
 392             logo: String::new(),
 393             favicon: String::new(),
 394             external_html,
 395             default_settings,
 396             krate: krate.name.to_string(),
 397             css_file_extension: extension_css,
 398             generate_search_filter,
 399         };
 400         let mut issue_tracker_base_url = None;
 401         let mut include_sources = true;
 402
 403         // Crawl the crate attributes looking for attributes which control how we're
 404         // going to emit HTML
 405         for attr in krate.module.attrs.lists(sym::doc) {
 406             match (attr.name_or_empty(), attr.value_str()) {
 407                 (sym::html_favicon_url, Some(s)) => {
 408                     layout.favicon = s.to_string();
 409                 }
 410                 (sym::html_logo_url, Some(s)) => {
 411                     layout.logo = s.to_string();
 412                 }
 413                 (sym::html_playground_url, Some(s)) => {
 414                     playground = Some(markdown::Playground {
 415                         crate_name: Some(krate.name.to_string()),
 416                         url: s.to_string(),
 417                     });
 418                 }
 419                 (sym::issue_tracker_base_url, Some(s)) => {
 420                     issue_tracker_base_url = Some(s.to_string());
 421                 }
 422                 (sym::html_no_source, None) if attr.is_word() => {
 423                     include_sources = false;
 424                 }
 425                 _ => {}
 426             }
 427         }
 428         let (sender, receiver) = channel();
 429         let mut scx = SharedContext {
 430             tcx,
 431             collapsed: krate.collapsed,
 432             src_root,
 433             include_sources,
 434             local_sources: Default::default(),
 435             issue_tracker_base_url,
 436             layout,
 437             created_dirs: Default::default(),
 438             sort_modules_alphabetically,
 439             style_files,
 440             resource_suffix,
 441             static_root_path,
 442             fs: DocFS::new(sender),
 443             codes: ErrorCodes::from(unstable_features.is_nightly_build()),
 444             playground,
 445             all: RefCell::new(AllTypes::new()),
 446             errors: receiver,
 447             redirections: if generate_redirect_map { Some(Default::default()) } else { None },
 448         };
 449
 450         // Add the default themes to the `Vec` of stylepaths
 451         //
 452         // Note that these must be added before `sources::render` is called
 453         // so that the resulting source pages are styled
 454         //
 455         // `light.css` is not disabled because it is the stylesheet that stays loaded
 456         // by the browser as the theme stylesheet. The theme system (hackily) works by
 457         // changing the href to this stylesheet. All other themes are disabled to
 458         // prevent rule conflicts
 459         scx.style_files.push(StylePath { path: PathBuf::from("light.css"), disabled: false });
 460         scx.style_files.push(StylePath { path: PathBuf::from("dark.css"), disabled: true });
 461         scx.style_files.push(StylePath { path: PathBuf::from("ayu.css"), disabled: true });
 462
 463         let dst = output;
 464         scx.ensure_dir(&dst)?;
 465         if emit_crate {
 466             krate = sources::render(&dst, &mut scx, krate)?;
 467         }
 468
 469         // Build our search index
 470         let index = build_index(&krate, &mut cache, tcx);
 471
 472         let mut cx = Context {
 473             current: Vec::new(),
 474             dst,
 475             render_redirect_pages: false,
 476             id_map: RefCell::new(id_map),
 477             deref_id_map: RefCell::new(FxHashMap::default()),
 478             shared: Rc::new(scx),
 479             cache: Rc::new(cache),
 480         };
 481
 482         // Write shared runs within a flock; disable thread dispatching of IO temporarily.
 483         Rc::get_mut(&mut cx.shared).unwrap().fs.set_sync_only(true);
 484         write_shared(&cx, &krate, index, &md_opts)?;
 485         Rc::get_mut(&mut cx.shared).unwrap().fs.set_sync_only(false);
 486         Ok((cx, krate))
 487     }
 488
 489     fn make_child_renderer(&self) -> Self {
 490         Self {
 491             current: self.current.clone(),
 492             dst: self.dst.clone(),
 493             render_redirect_pages: self.render_redirect_pages,
 494             id_map: RefCell::new(IdMap::new()),
 495             deref_id_map: RefCell::new(FxHashMap::default()),
 496             shared: Rc::clone(&self.shared),
 497             cache: Rc::clone(&self.cache),
 498         }
 499     }
 500
 501     fn after_krate(&mut self) -> Result<(), Error> {
 502         let crate_name = self.tcx().crate_name(LOCAL_CRATE);
 503         let final_file = self.dst.join(&*crate_name.as_str()).join("all.html");
 504         let settings_file = self.dst.join("settings.html");
 505
 506         let mut root_path = self.dst.to_str().expect("invalid path").to_owned();
 507         if !root_path.ends_with('/') {
 508             root_path.push('/');
 509         }
 510         let mut page = layout::Page {
 511             title: "List of all items in this crate",
 512             css_class: "mod",
 513             root_path: "../",
 514             static_root_path: self.shared.static_root_path.as_deref(),
 515             description: "List of all items in this crate",
 516             keywords: BASIC_KEYWORDS,
 517             resource_suffix: &self.shared.resource_suffix,
 518             extra_scripts: &[],
 519             static_extra_scripts: &[],
 520         };
 521         let sidebar = if let Some(ref version) = self.cache.crate_version {
 522             format!(
 523                 "<p class=\"location\">Crate {}</p>\
 524                      <div class=\"block version\">\
 525                          <p>Version {}</p>\
 526                      </div>\
 527                      <a id=\"all-types\" href=\"index.html\"><p>Back to index</p></a>",
 528                 crate_name,
 529                 Escape(version),
 530             )
 531         } else {
 532             String::new()
 533         };
 534         let all = self.shared.all.replace(AllTypes::new());
 535         let v = layout::render(
 536             &self.shared.layout,
 537             &page,
 538             sidebar,
 539             |buf: &mut Buffer| all.print(buf),
 540             &self.shared.style_files,
 541         );
 542         self.shared.fs.write(final_file, v.as_bytes())?;
 543
 544         // Generating settings page.
 545         page.title = "Rustdoc settings";
 546         page.description = "Settings of Rustdoc";
 547         page.root_path = "./";
 548
 549         let mut style_files = self.shared.style_files.clone();
 550         let sidebar = "<p class=\"location\">Settings</p><div class=\"sidebar-elems\"></div>";
 551         style_files.push(StylePath { path: PathBuf::from("settings.css"), disabled: false });
 552         let v = layout::render(
 553             &self.shared.layout,
 554             &page,
 555             sidebar,
 556             settings(
 557                 self.shared.static_root_path.as_deref().unwrap_or("./"),
 558                 &self.shared.resource_suffix,
 559                 &self.shared.style_files,
 560             )?,
 561             &style_files,
 562         );
 563         self.shared.fs.write(&settings_file, v.as_bytes())?;
 564         if let Some(ref redirections) = self.shared.redirections {
 565             if !redirections.borrow().is_empty() {
 566                 let redirect_map_path =
 567                     self.dst.join(&*crate_name.as_str()).join("redirect-map.json");
 568                 let paths = serde_json::to_string(&*redirections.borrow()).unwrap();
 569                 self.shared.ensure_dir(&self.dst.join(&*crate_name.as_str()))?;
 570                 self.shared.fs.write(&redirect_map_path, paths.as_bytes())?;
 571             }
 572         }
 573
 574         // Flush pending errors.
 575         Rc::get_mut(&mut self.shared).unwrap().fs.close();
 576         let nb_errors =
 577             self.shared.errors.iter().map(|err| self.tcx().sess.struct_err(&err).emit()).count();
 578         if nb_errors > 0 {
 579             Err(Error::new(io::Error::new(io::ErrorKind::Other, "I/O error"), ""))
 580         } else {
 581             Ok(())
 582         }
 583     }
 584
 585     fn mod_item_in(&mut self, item: &clean::Item) -> Result<(), Error> {
 586         // Stripped modules survive the rustdoc passes (i.e., `strip-private`)
 587         // if they contain impls for public types. These modules can also
 588         // contain items such as publicly re-exported structures.
 589         //
 590         // External crates will provide links to these structures, so
 591         // these modules are recursed into, but not rendered normally
 592         // (a flag on the context).
 593         if !self.render_redirect_pages {
 594             self.render_redirect_pages = item.is_stripped();
 595         }
 596         let scx = &self.shared;
 597         let item_name = item.name.as_ref().unwrap().to_string();
 598         self.dst.push(&item_name);
 599         self.current.push(item_name);
 600
 601         info!("Recursing into {}", self.dst.display());
 602
 603         let buf = self.render_item(item, true);
 604         // buf will be empty if the module is stripped and there is no redirect for it
 605         if !buf.is_empty() {
 606             self.shared.ensure_dir(&self.dst)?;
 607             let joint_dst = self.dst.join("index.html");
 608             scx.fs.write(&joint_dst, buf.as_bytes())?;
 609         }
 610
 611         // Render sidebar-items.js used throughout this module.
 612         if !self.render_redirect_pages {
 613             let module = match *item.kind {
 614                 clean::StrippedItem(box clean::ModuleItem(ref m)) | clean::ModuleItem(ref m) => m,
 615                 _ => unreachable!(),
 616             };
 617             let items = self.build_sidebar_items(module);
 618             let js_dst = self.dst.join("sidebar-items.js");
 619             let v = format!("initSidebarItems({});", serde_json::to_string(&items).unwrap());
 620             scx.fs.write(&js_dst, &v)?;
 621         }
 622         Ok(())
 623     }
 624
 625     fn mod_item_out(&mut self) -> Result<(), Error> {
 626         info!("Recursed; leaving {}", self.dst.display());
 627
 628         // Go back to where we were at
 629         self.dst.pop();
 630         self.current.pop();
 631         Ok(())
 632     }
 633
 634     fn item(&mut self, item: clean::Item) -> Result<(), Error> {
 635         // Stripped modules survive the rustdoc passes (i.e., `strip-private`)
 636         // if they contain impls for public types. These modules can also
 637         // contain items such as publicly re-exported structures.
 638         //
 639         // External crates will provide links to these structures, so
 640         // these modules are recursed into, but not rendered normally
 641         // (a flag on the context).
 642         if !self.render_redirect_pages {
 643             self.render_redirect_pages = item.is_stripped();
 644         }
 645
 646         let buf = self.render_item(&item, false);
 647         // buf will be empty if the item is stripped and there is no redirect for it
 648         if !buf.is_empty() {
 649             let name = item.name.as_ref().unwrap();
 650             let item_type = item.type_();
 651             let file_name = &item_path(item_type, &name.as_str());
 652             self.shared.ensure_dir(&self.dst)?;
 653             let joint_dst = self.dst.join(file_name);
 654             self.shared.fs.write(&joint_dst, buf.as_bytes())?;
 655
 656             if !self.render_redirect_pages {
 657                 self.shared.all.borrow_mut().append(full_path(self, &item), &item_type);
 658             }
 659             // If the item is a macro, redirect from the old macro URL (with !)
 660             // to the new one (without).
 661             if item_type == ItemType::Macro {
 662                 let redir_name = format!("{}.{}!.html", item_type, name);
 663                 if let Some(ref redirections) = self.shared.redirections {
 664                     let crate_name = &self.shared.layout.krate;
 665                     redirections.borrow_mut().insert(
 666                         format!("{}/{}", crate_name, redir_name),
 667                         format!("{}/{}", crate_name, file_name),
 668                     );
 669                 } else {
 670                     let v = layout::redirect(file_name);
 671                     let redir_dst = self.dst.join(redir_name);
 672                     self.shared.fs.write(&redir_dst, v.as_bytes())?;
 673                 }
 674             }
 675         }
 676         Ok(())
 677     }
 678
 679     fn cache(&self) -> &Cache {
 680         &self.cache
 681     }
 682 }
 683
 684 fn make_item_keywords(it: &clean::Item) -> String {
 685     format!("{}, {}", BASIC_KEYWORDS, it.name.as_ref().unwrap())
 686 }