1 // Copyright 2013-2015 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
11 //! Rustdoc's HTML Rendering module
13 //! This modules contains the bulk of the logic necessary for rendering a
14 //! rustdoc `clean::Crate` instance to a set of static HTML pages. This
15 //! rendering process is largely driven by the `format!` syntax extension to
16 //! perform all I/O into files and streams.
18 //! The rendering process is largely driven by the `Context` and `Cache`
19 //! structures. The cache is pre-populated by crawling the crate in question,
20 //! and then it is shared among the various rendering threads. The cache is meant
21 //! to be a fairly large structure not implementing `Clone` (because it's shared
22 //! among threads). The context, however, should be a lightweight structure. This
23 //! is cloned per-thread and contains information about what is currently being
26 //! In order to speed up rendering (mostly because of markdown rendering), the
27 //! rendering process has been parallelized. This parallelization is only
28 //! exposed through the `crate` method on the context, and then also from the
29 //! fact that the shared cache is stored in TLS (and must be accessed as such).
31 //! In addition to rendering the crate itself, this module is also responsible
32 //! for creating the corresponding search index and source file renderings.
33 //! These threads are not parallelized (they haven't been a bottleneck yet), and
34 //! both occur before the crate is rendered.
35 pub use self::ExternalLocation::*;
37 use std::ascii::AsciiExt;
38 use std::cell::RefCell;
39 use std::cmp::Ordering;
40 use std::collections::BTreeMap;
41 use std::default::Default;
43 use std::fmt::{self, Display, Formatter, Write as FmtWrite};
44 use std::fs::{self, File, OpenOptions};
45 use std::io::prelude::*;
46 use std::io::{self, BufWriter, BufReader};
47 use std::iter::repeat;
49 use std::path::{PathBuf, Path, Component};
53 use externalfiles::ExternalHtml;
55 use serialize::json::{ToJson, Json, as_json};
56 use syntax::{abi, ast};
57 use syntax::feature_gate::UnstableFeatures;
58 use rustc::hir::def_id::{CrateNum, CRATE_DEF_INDEX, DefId};
59 use rustc::middle::privacy::AccessLevels;
60 use rustc::middle::stability;
62 use rustc::util::nodemap::{FxHashMap, FxHashSet};
63 use rustc::session::config::nightly_options::is_nightly_build;
64 use rustc_data_structures::flock;
66 use clean::{self, AttributesExt, GetDefId, SelfTy, Mutability};
69 use html::escape::Escape;
70 use html::format::{ConstnessSpace};
71 use html::format::{TyParamBounds, WhereClause, href, AbiSpace};
72 use html::format::{VisSpace, Method, UnsafetySpace, MutableSpace};
73 use html::format::fmt_impl_for_trait_page;
74 use html::item_type::ItemType;
75 use html::markdown::{self, Markdown, MarkdownHtml, MarkdownSummaryLine, RenderType};
76 use html::{highlight, layout};
78 /// A pair of name and its optional document.
79 pub type NameDoc = (String, Option<String>);
81 /// Major driving force in all rustdoc rendering. This contains information
82 /// about where in the tree-like hierarchy rendering is occurring and controls
83 /// how the current page is being rendered.
85 /// It is intended that this context is a lightweight object which can be fairly
86 /// easily cloned because it is cloned per work-job (about once per item in the
90 /// Current hierarchy of components leading down to what's currently being
92 pub current: Vec<String>,
93 /// The current destination folder of where HTML artifacts should be placed.
94 /// This changes as the context descends into the module hierarchy.
96 /// A flag, which when `true`, will render pages which redirect to the
97 /// real location of an item. This is used to allow external links to
98 /// publicly reused items to redirect to the right location.
99 pub render_redirect_pages: bool,
100 pub shared: Arc<SharedContext>,
101 pub render_type: RenderType,
104 pub struct SharedContext {
105 /// The path to the crate root source minus the file name.
106 /// Used for simplifying paths to the highlighted source code files.
107 pub src_root: PathBuf,
108 /// This describes the layout of each page, and is not modified after
109 /// creation of the context (contains info like the favicon and added html).
110 pub layout: layout::Layout,
111 /// This flag indicates whether [src] links should be generated or not. If
112 /// the source files are present in the html rendering, then this will be
114 pub include_sources: bool,
115 /// The local file sources we've emitted and their respective url-paths.
116 pub local_sources: FxHashMap<PathBuf, String>,
117 /// All the passes that were run on this crate.
118 pub passes: FxHashSet<String>,
119 /// The base-URL of the issue tracker for when an item has been tagged with
121 pub issue_tracker_base_url: Option<String>,
122 /// The given user css file which allow to customize the generated
123 /// documentation theme.
124 pub css_file_extension: Option<PathBuf>,
127 /// Indicates where an external crate can be found.
128 pub enum ExternalLocation {
129 /// Remote URL root of the external crate
131 /// This external crate can be found in the local doc/ folder
133 /// The external crate could not be found.
137 /// Metadata about an implementor of a trait.
138 pub struct Implementor {
140 pub stability: Option<clean::Stability>,
141 pub impl_: clean::Impl,
144 /// Metadata about implementations for a type.
147 pub impl_item: clean::Item,
151 fn inner_impl(&self) -> &clean::Impl {
152 match self.impl_item.inner {
153 clean::ImplItem(ref impl_) => impl_,
154 _ => panic!("non-impl item found in impl")
158 fn trait_did(&self) -> Option<DefId> {
159 self.inner_impl().trait_.def_id()
169 impl error::Error for Error {
170 fn description(&self) -> &str {
171 self.error.description()
175 impl Display for Error {
176 fn fmt(&self, f: &mut Formatter) -> fmt::Result {
177 write!(f, "\"{}\": {}", self.file.display(), self.error)
182 pub fn new(e: io::Error, file: &Path) -> Error {
184 file: file.to_path_buf(),
190 macro_rules! try_err {
191 ($e:expr, $file:expr) => ({
194 Err(e) => return Err(Error::new(e, $file)),
199 /// This cache is used to store information about the `clean::Crate` being
200 /// rendered in order to provide more useful documentation. This contains
201 /// information like all implementors of a trait, all traits a type implements,
202 /// documentation for all known traits, etc.
204 /// This structure purposefully does not implement `Clone` because it's intended
205 /// to be a fairly large and expensive structure to clone. Instead this adheres
206 /// to `Send` so it may be stored in a `Arc` instance and shared among the various
207 /// rendering threads.
210 /// Mapping of typaram ids to the name of the type parameter. This is used
211 /// when pretty-printing a type (so pretty printing doesn't have to
212 /// painfully maintain a context like this)
213 pub typarams: FxHashMap<DefId, String>,
215 /// Maps a type id to all known implementations for that type. This is only
216 /// recognized for intra-crate `ResolvedPath` types, and is used to print
217 /// out extra documentation on the page of an enum/struct.
219 /// The values of the map are a list of implementations and documentation
220 /// found on that implementation.
221 pub impls: FxHashMap<DefId, Vec<Impl>>,
223 /// Maintains a mapping of local crate node ids to the fully qualified name
224 /// and "short type description" of that node. This is used when generating
225 /// URLs when a type is being linked to. External paths are not located in
226 /// this map because the `External` type itself has all the information
228 pub paths: FxHashMap<DefId, (Vec<String>, ItemType)>,
230 /// Similar to `paths`, but only holds external paths. This is only used for
231 /// generating explicit hyperlinks to other crates.
232 pub external_paths: FxHashMap<DefId, (Vec<String>, ItemType)>,
234 /// This map contains information about all known traits of this crate.
235 /// Implementations of a crate should inherit the documentation of the
236 /// parent trait if no extra documentation is specified, and default methods
237 /// should show up in documentation about trait implementations.
238 pub traits: FxHashMap<DefId, clean::Trait>,
240 /// When rendering traits, it's often useful to be able to list all
241 /// implementors of the trait, and this mapping is exactly, that: a mapping
242 /// of trait ids to the list of known implementors of the trait
243 pub implementors: FxHashMap<DefId, Vec<Implementor>>,
245 /// Cache of where external crate documentation can be found.
246 pub extern_locations: FxHashMap<CrateNum, (String, PathBuf, ExternalLocation)>,
248 /// Cache of where documentation for primitives can be found.
249 pub primitive_locations: FxHashMap<clean::PrimitiveType, DefId>,
251 // Note that external items for which `doc(hidden)` applies to are shown as
252 // non-reachable while local items aren't. This is because we're reusing
253 // the access levels from crateanalysis.
254 pub access_levels: Arc<AccessLevels<DefId>>,
256 // Private fields only used when initially crawling a crate to build a cache
259 parent_stack: Vec<DefId>,
260 parent_is_trait_impl: bool,
261 search_index: Vec<IndexItem>,
263 deref_trait_did: Option<DefId>,
264 deref_mut_trait_did: Option<DefId>,
265 owned_box_did: Option<DefId>,
267 // In rare case where a structure is defined in one module but implemented
268 // in another, if the implementing module is parsed before defining module,
269 // then the fully qualified name of the structure isn't presented in `paths`
270 // yet when its implementation methods are being indexed. Caches such methods
271 // and their parent id here and indexes them at the end of crate parsing.
272 orphan_impl_items: Vec<(DefId, clean::Item)>,
275 /// Temporary storage for data obtained during `RustdocVisitor::clean()`.
276 /// Later on moved into `CACHE_KEY`.
278 pub struct RenderInfo {
279 pub inlined: FxHashSet<DefId>,
280 pub external_paths: ::core::ExternalPaths,
281 pub external_typarams: FxHashMap<DefId, String>,
282 pub deref_trait_did: Option<DefId>,
283 pub deref_mut_trait_did: Option<DefId>,
284 pub owned_box_did: Option<DefId>,
287 /// Helper struct to render all source code to HTML pages
288 struct SourceCollector<'a> {
289 scx: &'a mut SharedContext,
291 /// Root destination to place all HTML output into
295 /// Wrapper struct to render the source code of a file. This will do things like
296 /// adding line numbers to the left-hand side.
297 struct Source<'a>(&'a str);
299 // Helper structs for rendering items/sidebars and carrying along contextual
302 #[derive(Copy, Clone)]
305 item: &'a clean::Item,
308 struct Sidebar<'a> { cx: &'a Context, item: &'a clean::Item, }
310 /// Struct representing one entry in the JS search index. These are all emitted
311 /// by hand to a large JS file at the end of cache-creation.
317 parent: Option<DefId>,
318 parent_idx: Option<usize>,
319 search_type: Option<IndexItemFunctionType>,
322 impl ToJson for IndexItem {
323 fn to_json(&self) -> Json {
324 assert_eq!(self.parent.is_some(), self.parent_idx.is_some());
326 let mut data = Vec::with_capacity(6);
327 data.push((self.ty as usize).to_json());
328 data.push(self.name.to_json());
329 data.push(self.path.to_json());
330 data.push(self.desc.to_json());
331 data.push(self.parent_idx.to_json());
332 data.push(self.search_type.to_json());
338 /// A type used for the search index.
340 name: Option<String>,
343 impl ToJson for Type {
344 fn to_json(&self) -> Json {
347 let mut data = BTreeMap::new();
348 data.insert("name".to_owned(), name.to_json());
356 /// Full type of functions/methods in the search index.
357 struct IndexItemFunctionType {
362 impl ToJson for IndexItemFunctionType {
363 fn to_json(&self) -> Json {
364 // If we couldn't figure out a type, just write `null`.
365 if self.inputs.iter().chain(self.output.iter()).any(|ref i| i.name.is_none()) {
368 let mut data = BTreeMap::new();
369 data.insert("inputs".to_owned(), self.inputs.to_json());
370 data.insert("output".to_owned(), self.output.to_json());
376 // TLS keys used to carry information around during rendering.
378 thread_local!(static CACHE_KEY: RefCell<Arc<Cache>> = Default::default());
379 thread_local!(pub static CURRENT_LOCATION_KEY: RefCell<Vec<String>> =
380 RefCell::new(Vec::new()));
381 thread_local!(static USED_ID_MAP: RefCell<FxHashMap<String, usize>> =
382 RefCell::new(init_ids()));
384 fn init_ids() -> FxHashMap<String, usize> {
400 ].into_iter().map(|id| (String::from(*id), 1)).collect()
403 /// This method resets the local table of used ID attributes. This is typically
404 /// used at the beginning of rendering an entire HTML page to reset from the
405 /// previous state (if any).
406 pub fn reset_ids(embedded: bool) {
407 USED_ID_MAP.with(|s| {
408 *s.borrow_mut() = if embedded {
416 pub fn derive_id(candidate: String) -> String {
417 USED_ID_MAP.with(|map| {
418 let id = match map.borrow_mut().get_mut(&candidate) {
421 let id = format!("{}-{}", candidate, *a);
427 map.borrow_mut().insert(id.clone(), 1);
432 /// Generates the documentation for `crate` into the directory `dst`
433 pub fn run(mut krate: clean::Crate,
434 external_html: &ExternalHtml,
435 playground_url: Option<String>,
437 passes: FxHashSet<String>,
438 css_file_extension: Option<PathBuf>,
439 renderinfo: RenderInfo,
440 render_type: RenderType) -> Result<(), Error> {
441 let src_root = match krate.src.parent() {
442 Some(p) => p.to_path_buf(),
443 None => PathBuf::new(),
445 let mut scx = SharedContext {
448 include_sources: true,
449 local_sources: FxHashMap(),
450 issue_tracker_base_url: None,
451 layout: layout::Layout {
452 logo: "".to_string(),
453 favicon: "".to_string(),
454 external_html: external_html.clone(),
455 krate: krate.name.clone(),
457 css_file_extension: css_file_extension.clone(),
460 // If user passed in `--playground-url` arg, we fill in crate name here
461 if let Some(url) = playground_url {
462 markdown::PLAYGROUND.with(|slot| {
463 *slot.borrow_mut() = Some((Some(krate.name.clone()), url));
467 // Crawl the crate attributes looking for attributes which control how we're
468 // going to emit HTML
469 if let Some(attrs) = krate.module.as_ref().map(|m| &m.attrs) {
470 for attr in attrs.lists("doc") {
471 let name = attr.name().map(|s| s.as_str());
472 match (name.as_ref().map(|s| &s[..]), attr.value_str()) {
473 (Some("html_favicon_url"), Some(s)) => {
474 scx.layout.favicon = s.to_string();
476 (Some("html_logo_url"), Some(s)) => {
477 scx.layout.logo = s.to_string();
479 (Some("html_playground_url"), Some(s)) => {
480 markdown::PLAYGROUND.with(|slot| {
481 let name = krate.name.clone();
482 *slot.borrow_mut() = Some((Some(name), s.to_string()));
485 (Some("issue_tracker_base_url"), Some(s)) => {
486 scx.issue_tracker_base_url = Some(s.to_string());
488 (Some("html_no_source"), None) if attr.is_word() => {
489 scx.include_sources = false;
495 try_err!(fs::create_dir_all(&dst), &dst);
496 krate = render_sources(&dst, &mut scx, krate)?;
500 render_redirect_pages: false,
501 shared: Arc::new(scx),
502 render_type: render_type,
505 // Crawl the crate to build various caches used for the output
515 let external_paths = external_paths.into_iter()
516 .map(|(k, (v, t))| (k, (v, ItemType::from(t))))
519 let mut cache = Cache {
521 external_paths: external_paths,
523 implementors: FxHashMap(),
525 parent_stack: Vec::new(),
526 search_index: Vec::new(),
527 parent_is_trait_impl: false,
528 extern_locations: FxHashMap(),
529 primitive_locations: FxHashMap(),
531 access_levels: krate.access_levels.clone(),
532 orphan_impl_items: Vec::new(),
533 traits: mem::replace(&mut krate.external_traits, FxHashMap()),
534 deref_trait_did: deref_trait_did,
535 deref_mut_trait_did: deref_mut_trait_did,
536 owned_box_did: owned_box_did,
537 typarams: external_typarams,
540 // Cache where all our extern crates are located
541 for &(n, ref e) in &krate.externs {
542 let src_root = match Path::new(&e.src).parent() {
543 Some(p) => p.to_path_buf(),
544 None => PathBuf::new(),
546 cache.extern_locations.insert(n, (e.name.clone(), src_root,
547 extern_location(e, &cx.dst)));
549 let did = DefId { krate: n, index: CRATE_DEF_INDEX };
550 cache.external_paths.insert(did, (vec![e.name.to_string()], ItemType::Module));
553 // Cache where all known primitives have their documentation located.
555 // Favor linking to as local extern as possible, so iterate all crates in
556 // reverse topological order.
557 for &(_, ref e) in krate.externs.iter().rev() {
558 for &(def_id, prim, _) in &e.primitives {
559 cache.primitive_locations.insert(prim, def_id);
562 for &(def_id, prim, _) in &krate.primitives {
563 cache.primitive_locations.insert(prim, def_id);
566 cache.stack.push(krate.name.clone());
567 krate = cache.fold_crate(krate);
569 // Build our search index
570 let index = build_index(&krate, &mut cache);
572 // Freeze the cache now that the index has been built. Put an Arc into TLS
573 // for future parallelization opportunities
574 let cache = Arc::new(cache);
575 CACHE_KEY.with(|v| *v.borrow_mut() = cache.clone());
576 CURRENT_LOCATION_KEY.with(|s| s.borrow_mut().clear());
578 write_shared(&cx, &krate, &*cache, index)?;
580 // And finally render the whole crate's documentation
584 /// Build the search index from the collected metadata
585 fn build_index(krate: &clean::Crate, cache: &mut Cache) -> String {
586 let mut nodeid_to_pathid = FxHashMap();
587 let mut crate_items = Vec::with_capacity(cache.search_index.len());
588 let mut crate_paths = Vec::<Json>::new();
590 let Cache { ref mut search_index,
591 ref orphan_impl_items,
592 ref mut paths, .. } = *cache;
594 // Attach all orphan items to the type's definition if the type
595 // has since been learned.
596 for &(did, ref item) in orphan_impl_items {
597 if let Some(&(ref fqp, _)) = paths.get(&did) {
598 search_index.push(IndexItem {
600 name: item.name.clone().unwrap(),
601 path: fqp[..fqp.len() - 1].join("::"),
602 desc: plain_summary_line(item.doc_value()),
605 search_type: get_index_search_type(&item),
610 // Reduce `NodeId` in paths into smaller sequential numbers,
611 // and prune the paths that do not appear in the index.
612 let mut lastpath = String::new();
613 let mut lastpathid = 0usize;
615 for item in search_index {
616 item.parent_idx = item.parent.map(|nodeid| {
617 if nodeid_to_pathid.contains_key(&nodeid) {
618 *nodeid_to_pathid.get(&nodeid).unwrap()
620 let pathid = lastpathid;
621 nodeid_to_pathid.insert(nodeid, pathid);
624 let &(ref fqp, short) = paths.get(&nodeid).unwrap();
625 crate_paths.push(((short as usize), fqp.last().unwrap().clone()).to_json());
630 // Omit the parent path if it is same to that of the prior item.
631 if lastpath == item.path {
634 lastpath = item.path.clone();
636 crate_items.push(item.to_json());
639 let crate_doc = krate.module.as_ref().map(|module| {
640 plain_summary_line(module.doc_value())
641 }).unwrap_or(String::new());
643 let mut crate_data = BTreeMap::new();
644 crate_data.insert("doc".to_owned(), Json::String(crate_doc));
645 crate_data.insert("items".to_owned(), Json::Array(crate_items));
646 crate_data.insert("paths".to_owned(), Json::Array(crate_paths));
648 // Collect the index into a string
649 format!("searchIndex[{}] = {};",
650 as_json(&krate.name),
651 Json::Object(crate_data))
654 fn write_shared(cx: &Context,
655 krate: &clean::Crate,
657 search_index: String) -> Result<(), Error> {
658 // Write out the shared files. Note that these are shared among all rustdoc
659 // docs placed in the output directory, so this needs to be a synchronized
660 // operation with respect to all other rustdocs running around.
661 try_err!(fs::create_dir_all(&cx.dst), &cx.dst);
662 let _lock = flock::Lock::panicking_new(&cx.dst.join(".lock"), true, true, true);
664 // Add all the static files. These may already exist, but we just
665 // overwrite them anyway to make sure that they're fresh and up-to-date.
667 write(cx.dst.join("main.js"),
668 include_bytes!("static/main.js"))?;
669 write(cx.dst.join("rustdoc.css"),
670 include_bytes!("static/rustdoc.css"))?;
671 write(cx.dst.join("main.css"),
672 include_bytes!("static/styles/main.css"))?;
673 if let Some(ref css) = cx.shared.css_file_extension {
674 let mut content = String::new();
675 let css = css.as_path();
676 let mut f = try_err!(File::open(css), css);
678 try_err!(f.read_to_string(&mut content), css);
679 let css = cx.dst.join("theme.css");
680 let css = css.as_path();
681 let mut f = try_err!(File::create(css), css);
682 try_err!(write!(f, "{}", &content), css);
684 write(cx.dst.join("normalize.css"),
685 include_bytes!("static/normalize.css"))?;
686 write(cx.dst.join("FiraSans-Regular.woff"),
687 include_bytes!("static/FiraSans-Regular.woff"))?;
688 write(cx.dst.join("FiraSans-Medium.woff"),
689 include_bytes!("static/FiraSans-Medium.woff"))?;
690 write(cx.dst.join("FiraSans-LICENSE.txt"),
691 include_bytes!("static/FiraSans-LICENSE.txt"))?;
692 write(cx.dst.join("Heuristica-Italic.woff"),
693 include_bytes!("static/Heuristica-Italic.woff"))?;
694 write(cx.dst.join("Heuristica-LICENSE.txt"),
695 include_bytes!("static/Heuristica-LICENSE.txt"))?;
696 write(cx.dst.join("SourceSerifPro-Regular.woff"),
697 include_bytes!("static/SourceSerifPro-Regular.woff"))?;
698 write(cx.dst.join("SourceSerifPro-Bold.woff"),
699 include_bytes!("static/SourceSerifPro-Bold.woff"))?;
700 write(cx.dst.join("SourceSerifPro-LICENSE.txt"),
701 include_bytes!("static/SourceSerifPro-LICENSE.txt"))?;
702 write(cx.dst.join("SourceCodePro-Regular.woff"),
703 include_bytes!("static/SourceCodePro-Regular.woff"))?;
704 write(cx.dst.join("SourceCodePro-Semibold.woff"),
705 include_bytes!("static/SourceCodePro-Semibold.woff"))?;
706 write(cx.dst.join("SourceCodePro-LICENSE.txt"),
707 include_bytes!("static/SourceCodePro-LICENSE.txt"))?;
708 write(cx.dst.join("LICENSE-MIT.txt"),
709 include_bytes!("static/LICENSE-MIT.txt"))?;
710 write(cx.dst.join("LICENSE-APACHE.txt"),
711 include_bytes!("static/LICENSE-APACHE.txt"))?;
712 write(cx.dst.join("COPYRIGHT.txt"),
713 include_bytes!("static/COPYRIGHT.txt"))?;
715 fn collect(path: &Path, krate: &str,
716 key: &str) -> io::Result<Vec<String>> {
717 let mut ret = Vec::new();
719 for line in BufReader::new(File::open(path)?).lines() {
721 if !line.starts_with(key) {
724 if line.starts_with(&format!(r#"{}["{}"]"#, key, krate)) {
727 ret.push(line.to_string());
733 // Update the search index
734 let dst = cx.dst.join("search-index.js");
735 let mut all_indexes = try_err!(collect(&dst, &krate.name, "searchIndex"), &dst);
736 all_indexes.push(search_index);
737 // Sort the indexes by crate so the file will be generated identically even
738 // with rustdoc running in parallel.
740 let mut w = try_err!(File::create(&dst), &dst);
741 try_err!(writeln!(&mut w, "var searchIndex = {{}};"), &dst);
742 for index in &all_indexes {
743 try_err!(writeln!(&mut w, "{}", *index), &dst);
745 try_err!(writeln!(&mut w, "initSearch(searchIndex);"), &dst);
747 // Update the list of all implementors for traits
748 let dst = cx.dst.join("implementors");
749 for (&did, imps) in &cache.implementors {
750 // Private modules can leak through to this phase of rustdoc, which
751 // could contain implementations for otherwise private types. In some
752 // rare cases we could find an implementation for an item which wasn't
753 // indexed, so we just skip this step in that case.
755 // FIXME: this is a vague explanation for why this can't be a `get`, in
756 // theory it should be...
757 let &(ref remote_path, remote_item_type) = match cache.paths.get(&did) {
759 None => match cache.external_paths.get(&did) {
765 let mut implementors = format!(r#"implementors["{}"] = ["#, krate.name);
767 // If the trait and implementation are in the same crate, then
768 // there's no need to emit information about it (there's inlining
769 // going on). If they're in different crates then the crate defining
770 // the trait will be interested in our implementation.
771 if imp.def_id.krate == did.krate { continue }
772 write!(implementors, "{},", as_json(&imp.impl_.to_string())).unwrap();
774 implementors.push_str("];");
776 let mut mydst = dst.clone();
777 for part in &remote_path[..remote_path.len() - 1] {
780 try_err!(fs::create_dir_all(&mydst), &mydst);
781 mydst.push(&format!("{}.{}.js",
782 remote_item_type.css_class(),
783 remote_path[remote_path.len() - 1]));
785 let mut all_implementors = try_err!(collect(&mydst, &krate.name, "implementors"), &mydst);
786 all_implementors.push(implementors);
787 // Sort the implementors by crate so the file will be generated
788 // identically even with rustdoc running in parallel.
789 all_implementors.sort();
791 let mut f = try_err!(File::create(&mydst), &mydst);
792 try_err!(writeln!(&mut f, "(function() {{var implementors = {{}};"), &mydst);
793 for implementor in &all_implementors {
794 try_err!(writeln!(&mut f, "{}", *implementor), &mydst);
796 try_err!(writeln!(&mut f, "{}", r"
797 if (window.register_implementors) {
798 window.register_implementors(implementors);
800 window.pending_implementors = implementors;
803 try_err!(writeln!(&mut f, r"}})()"), &mydst);
808 fn render_sources(dst: &Path, scx: &mut SharedContext,
809 krate: clean::Crate) -> Result<clean::Crate, Error> {
810 info!("emitting source files");
811 let dst = dst.join("src").join(&krate.name);
812 try_err!(fs::create_dir_all(&dst), &dst);
813 let mut folder = SourceCollector {
817 Ok(folder.fold_crate(krate))
820 /// Writes the entire contents of a string to a destination, not attempting to
821 /// catch any errors.
822 fn write(dst: PathBuf, contents: &[u8]) -> Result<(), Error> {
823 Ok(try_err!(try_err!(File::create(&dst), &dst).write_all(contents), &dst))
826 /// Takes a path to a source file and cleans the path to it. This canonicalizes
827 /// things like ".." to components which preserve the "top down" hierarchy of a
828 /// static HTML tree. Each component in the cleaned path will be passed as an
829 /// argument to `f`. The very last component of the path (ie the file name) will
830 /// be passed to `f` if `keep_filename` is true, and ignored otherwise.
831 // FIXME (#9639): The closure should deal with &[u8] instead of &str
832 // FIXME (#9639): This is too conservative, rejecting non-UTF-8 paths
833 fn clean_srcpath<F>(src_root: &Path, p: &Path, keep_filename: bool, mut f: F) where
836 // make it relative, if possible
837 let p = p.strip_prefix(src_root).unwrap_or(p);
839 let mut iter = p.components().peekable();
841 while let Some(c) = iter.next() {
842 if !keep_filename && iter.peek().is_none() {
847 Component::ParentDir => f("up"),
848 Component::Normal(c) => f(c.to_str().unwrap()),
854 /// Attempts to find where an external crate is located, given that we're
855 /// rendering in to the specified source destination.
856 fn extern_location(e: &clean::ExternalCrate, dst: &Path) -> ExternalLocation {
857 // See if there's documentation generated into the local directory
858 let local_location = dst.join(&e.name);
859 if local_location.is_dir() {
863 // Failing that, see if there's an attribute specifying where to find this
866 .filter(|a| a.check_name("html_root_url"))
867 .filter_map(|a| a.value_str())
869 let mut url = url.to_string();
870 if !url.ends_with("/") {
874 }).next().unwrap_or(Unknown) // Well, at least we tried.
877 impl<'a> DocFolder for SourceCollector<'a> {
878 fn fold_item(&mut self, item: clean::Item) -> Option<clean::Item> {
879 // If we're including source files, and we haven't seen this file yet,
880 // then we need to render it out to the filesystem.
881 if self.scx.include_sources
882 // skip all invalid spans
883 && item.source.filename != ""
884 // skip non-local items
885 && item.def_id.is_local()
886 // Macros from other libraries get special filenames which we can
888 && !(item.source.filename.starts_with("<")
889 && item.source.filename.ends_with("macros>")) {
891 // If it turns out that we couldn't read this file, then we probably
892 // can't read any of the files (generating html output from json or
893 // something like that), so just don't include sources for the
894 // entire crate. The other option is maintaining this mapping on a
895 // per-file basis, but that's probably not worth it...
897 .include_sources = match self.emit_source(&item.source.filename) {
900 println!("warning: source code was requested to be rendered, \
901 but processing `{}` had an error: {}",
902 item.source.filename, e);
903 println!(" skipping rendering of source code");
908 self.fold_item_recur(item)
912 impl<'a> SourceCollector<'a> {
913 /// Renders the given filename into its corresponding HTML source file.
914 fn emit_source(&mut self, filename: &str) -> io::Result<()> {
915 let p = PathBuf::from(filename);
916 if self.scx.local_sources.contains_key(&p) {
917 // We've already emitted this source
921 let mut contents = Vec::new();
922 File::open(&p).and_then(|mut f| f.read_to_end(&mut contents))?;
924 let contents = str::from_utf8(&contents).unwrap();
926 // Remove the utf-8 BOM if any
927 let contents = if contents.starts_with("\u{feff}") {
933 // Create the intermediate directories
934 let mut cur = self.dst.clone();
935 let mut root_path = String::from("../../");
936 let mut href = String::new();
937 clean_srcpath(&self.scx.src_root, &p, false, |component| {
939 fs::create_dir_all(&cur).unwrap();
940 root_path.push_str("../");
941 href.push_str(component);
944 let mut fname = p.file_name().expect("source has no filename")
948 href.push_str(&fname.to_string_lossy());
950 let mut w = BufWriter::new(File::create(&cur)?);
951 let title = format!("{} -- source", cur.file_name().unwrap()
953 let desc = format!("Source to the Rust file `{}`.", filename);
954 let page = layout::Page {
957 root_path: &root_path,
959 keywords: BASIC_KEYWORDS,
961 layout::render(&mut w, &self.scx.layout,
962 &page, &(""), &Source(contents),
963 self.scx.css_file_extension.is_some())?;
965 self.scx.local_sources.insert(p, href);
970 impl DocFolder for Cache {
971 fn fold_item(&mut self, item: clean::Item) -> Option<clean::Item> {
972 // If this is a stripped module,
973 // we don't want it or its children in the search index.
974 let orig_stripped_mod = match item.inner {
975 clean::StrippedItem(box clean::ModuleItem(..)) => {
976 mem::replace(&mut self.stripped_mod, true)
978 _ => self.stripped_mod,
981 // Register any generics to their corresponding string. This is used
982 // when pretty-printing types.
983 if let Some(generics) = item.inner.generics() {
984 self.generics(generics);
987 // Propagate a trait method's documentation to all implementors of the
989 if let clean::TraitItem(ref t) = item.inner {
990 self.traits.entry(item.def_id).or_insert_with(|| t.clone());
993 // Collect all the implementors of traits.
994 if let clean::ImplItem(ref i) = item.inner {
995 if let Some(did) = i.trait_.def_id() {
996 self.implementors.entry(did).or_insert(vec![]).push(Implementor {
998 stability: item.stability.clone(),
1004 // Index this method for searching later on.
1005 if let Some(ref s) = item.name {
1006 let (parent, is_inherent_impl_item) = match item.inner {
1007 clean::StrippedItem(..) => ((None, None), false),
1008 clean::AssociatedConstItem(..) |
1009 clean::TypedefItem(_, true) if self.parent_is_trait_impl => {
1010 // skip associated items in trait impls
1011 ((None, None), false)
1013 clean::AssociatedTypeItem(..) |
1014 clean::TyMethodItem(..) |
1015 clean::StructFieldItem(..) |
1016 clean::VariantItem(..) => {
1017 ((Some(*self.parent_stack.last().unwrap()),
1018 Some(&self.stack[..self.stack.len() - 1])),
1021 clean::MethodItem(..) | clean::AssociatedConstItem(..) => {
1022 if self.parent_stack.is_empty() {
1023 ((None, None), false)
1025 let last = self.parent_stack.last().unwrap();
1027 let path = match self.paths.get(&did) {
1028 // The current stack not necessarily has correlation
1029 // for where the type was defined. On the other
1030 // hand, `paths` always has the right
1031 // information if present.
1032 Some(&(ref fqp, ItemType::Trait)) |
1033 Some(&(ref fqp, ItemType::Struct)) |
1034 Some(&(ref fqp, ItemType::Union)) |
1035 Some(&(ref fqp, ItemType::Enum)) =>
1036 Some(&fqp[..fqp.len() - 1]),
1037 Some(..) => Some(&*self.stack),
1040 ((Some(*last), path), true)
1043 _ => ((None, Some(&*self.stack)), false)
1047 (parent, Some(path)) if is_inherent_impl_item || (!self.stripped_mod) => {
1048 debug_assert!(!item.is_stripped());
1050 // A crate has a module at its root, containing all items,
1051 // which should not be indexed. The crate-item itself is
1052 // inserted later on when serializing the search-index.
1053 if item.def_id.index != CRATE_DEF_INDEX {
1054 self.search_index.push(IndexItem {
1056 name: s.to_string(),
1057 path: path.join("::").to_string(),
1058 desc: plain_summary_line(item.doc_value()),
1061 search_type: get_index_search_type(&item),
1065 (Some(parent), None) if is_inherent_impl_item => {
1066 // We have a parent, but we don't know where they're
1067 // defined yet. Wait for later to index this item.
1068 self.orphan_impl_items.push((parent, item.clone()));
1074 // Keep track of the fully qualified path for this item.
1075 let pushed = match item.name {
1076 Some(ref n) if !n.is_empty() => {
1077 self.stack.push(n.to_string());
1084 clean::StructItem(..) | clean::EnumItem(..) |
1085 clean::TypedefItem(..) | clean::TraitItem(..) |
1086 clean::FunctionItem(..) | clean::ModuleItem(..) |
1087 clean::ForeignFunctionItem(..) | clean::ForeignStaticItem(..) |
1088 clean::ConstantItem(..) | clean::StaticItem(..) |
1089 clean::UnionItem(..)
1090 if !self.stripped_mod => {
1091 // Reexported items mean that the same id can show up twice
1092 // in the rustdoc ast that we're looking at. We know,
1093 // however, that a reexported item doesn't show up in the
1094 // `public_items` map, so we can skip inserting into the
1095 // paths map if there was already an entry present and we're
1096 // not a public item.
1098 !self.paths.contains_key(&item.def_id) ||
1099 self.access_levels.is_public(item.def_id)
1101 self.paths.insert(item.def_id,
1102 (self.stack.clone(), item.type_()));
1105 // Link variants to their parent enum because pages aren't emitted
1106 // for each variant.
1107 clean::VariantItem(..) if !self.stripped_mod => {
1108 let mut stack = self.stack.clone();
1110 self.paths.insert(item.def_id, (stack, ItemType::Enum));
1113 clean::PrimitiveItem(..) if item.visibility.is_some() => {
1114 self.paths.insert(item.def_id, (self.stack.clone(),
1121 // Maintain the parent stack
1122 let orig_parent_is_trait_impl = self.parent_is_trait_impl;
1123 let parent_pushed = match item.inner {
1124 clean::TraitItem(..) | clean::EnumItem(..) |
1125 clean::StructItem(..) | clean::UnionItem(..) => {
1126 self.parent_stack.push(item.def_id);
1127 self.parent_is_trait_impl = false;
1130 clean::ImplItem(ref i) => {
1131 self.parent_is_trait_impl = i.trait_.is_some();
1133 clean::ResolvedPath{ did, .. } => {
1134 self.parent_stack.push(did);
1138 let prim_did = t.primitive_type().and_then(|t| {
1139 self.primitive_locations.get(&t).cloned()
1143 self.parent_stack.push(did);
1154 // Once we've recursively found all the generics, hoard off all the
1155 // implementations elsewhere.
1156 let ret = self.fold_item_recur(item).and_then(|item| {
1157 if let clean::Item { inner: clean::ImplItem(_), .. } = item {
1158 // Figure out the id of this impl. This may map to a
1159 // primitive rather than always to a struct/enum.
1160 // Note: matching twice to restrict the lifetime of the `i` borrow.
1161 let did = if let clean::Item { inner: clean::ImplItem(ref i), .. } = item {
1163 clean::ResolvedPath { did, .. } |
1164 clean::BorrowedRef {
1165 type_: box clean::ResolvedPath { did, .. }, ..
1170 t.primitive_type().and_then(|t| {
1171 self.primitive_locations.get(&t).cloned()
1178 if let Some(did) = did {
1179 self.impls.entry(did).or_insert(vec![]).push(Impl {
1189 if pushed { self.stack.pop().unwrap(); }
1190 if parent_pushed { self.parent_stack.pop().unwrap(); }
1191 self.stripped_mod = orig_stripped_mod;
1192 self.parent_is_trait_impl = orig_parent_is_trait_impl;
1198 fn generics(&mut self, generics: &clean::Generics) {
1199 for typ in &generics.type_params {
1200 self.typarams.insert(typ.did, typ.name.clone());
1206 /// String representation of how to get back to the root path of the 'doc/'
1207 /// folder in terms of a relative URL.
1208 fn root_path(&self) -> String {
1209 repeat("../").take(self.current.len()).collect::<String>()
1212 /// Recurse in the directory structure and change the "root path" to make
1213 /// sure it always points to the top (relatively).
1214 fn recurse<T, F>(&mut self, s: String, f: F) -> T where
1215 F: FnOnce(&mut Context) -> T,
1218 panic!("Unexpected empty destination: {:?}", self.current);
1220 let prev = self.dst.clone();
1222 self.current.push(s);
1224 info!("Recursing into {}", self.dst.display());
1228 info!("Recursed; leaving {}", self.dst.display());
1230 // Go back to where we were at
1232 self.current.pop().unwrap();
1237 /// Main method for rendering a crate.
1239 /// This currently isn't parallelized, but it'd be pretty easy to add
1240 /// parallelization to this function.
1241 fn krate(self, mut krate: clean::Crate) -> Result<(), Error> {
1242 let mut item = match krate.module.take() {
1244 None => return Ok(()),
1246 item.name = Some(krate.name);
1248 // Render the crate documentation
1249 let mut work = vec![(self, item)];
1251 while let Some((mut cx, item)) = work.pop() {
1252 cx.item(item, |cx, item| {
1253 work.push((cx.clone(), item))
1259 fn render_item(&self,
1260 writer: &mut io::Write,
1264 // A little unfortunate that this is done like this, but it sure
1265 // does make formatting *a lot* nicer.
1266 CURRENT_LOCATION_KEY.with(|slot| {
1267 *slot.borrow_mut() = self.current.clone();
1270 let mut title = if it.is_primitive() {
1271 // No need to include the namespace for primitive types
1274 self.current.join("::")
1277 if !title.is_empty() {
1278 title.push_str("::");
1280 title.push_str(it.name.as_ref().unwrap());
1282 title.push_str(" - Rust");
1283 let tyname = it.type_().css_class();
1284 let desc = if it.is_crate() {
1285 format!("API documentation for the Rust `{}` crate.",
1286 self.shared.layout.krate)
1288 format!("API documentation for the Rust `{}` {} in crate `{}`.",
1289 it.name.as_ref().unwrap(), tyname, self.shared.layout.krate)
1291 let keywords = make_item_keywords(it);
1292 let page = layout::Page {
1294 root_path: &self.root_path(),
1297 keywords: &keywords,
1302 if !self.render_redirect_pages {
1303 layout::render(writer, &self.shared.layout, &page,
1304 &Sidebar{ cx: self, item: it },
1305 &Item{ cx: self, item: it },
1306 self.shared.css_file_extension.is_some())?;
1308 let mut url = self.root_path();
1309 if let Some(&(ref names, ty)) = cache().paths.get(&it.def_id) {
1310 for name in &names[..names.len() - 1] {
1314 url.push_str(&item_path(ty, names.last().unwrap()));
1315 layout::redirect(writer, &url)?;
1321 /// Non-parallelized version of rendering an item. This will take the input
1322 /// item, render its contents, and then invoke the specified closure with
1323 /// all sub-items which need to be rendered.
1325 /// The rendering driver uses this closure to queue up more work.
1326 fn item<F>(&mut self, item: clean::Item, mut f: F) -> Result<(), Error> where
1327 F: FnMut(&mut Context, clean::Item),
1329 // Stripped modules survive the rustdoc passes (i.e. `strip-private`)
1330 // if they contain impls for public types. These modules can also
1331 // contain items such as publicly reexported structures.
1333 // External crates will provide links to these structures, so
1334 // these modules are recursed into, but not rendered normally
1335 // (a flag on the context).
1336 if !self.render_redirect_pages {
1337 self.render_redirect_pages = item.is_stripped();
1341 // modules are special because they add a namespace. We also need to
1342 // recurse into the items of the module as well.
1343 let name = item.name.as_ref().unwrap().to_string();
1344 let mut item = Some(item);
1345 self.recurse(name, |this| {
1346 let item = item.take().unwrap();
1348 let mut buf = Vec::new();
1349 this.render_item(&mut buf, &item, false).unwrap();
1350 // buf will be empty if the module is stripped and there is no redirect for it
1351 if !buf.is_empty() {
1352 let joint_dst = this.dst.join("index.html");
1353 try_err!(fs::create_dir_all(&this.dst), &this.dst);
1354 let mut dst = try_err!(File::create(&joint_dst), &joint_dst);
1355 try_err!(dst.write_all(&buf), &joint_dst);
1358 let m = match item.inner {
1359 clean::StrippedItem(box clean::ModuleItem(m)) |
1360 clean::ModuleItem(m) => m,
1364 // Render sidebar-items.js used throughout this module.
1365 if !this.render_redirect_pages {
1366 let items = this.build_sidebar_items(&m);
1367 let js_dst = this.dst.join("sidebar-items.js");
1368 let mut js_out = BufWriter::new(try_err!(File::create(&js_dst), &js_dst));
1369 try_err!(write!(&mut js_out, "initSidebarItems({});",
1370 as_json(&items)), &js_dst);
1373 for item in m.items {
1379 } else if item.name.is_some() {
1380 let mut buf = Vec::new();
1381 self.render_item(&mut buf, &item, true).unwrap();
1382 // buf will be empty if the item is stripped and there is no redirect for it
1383 if !buf.is_empty() {
1384 let name = item.name.as_ref().unwrap();
1385 let item_type = item.type_();
1386 let file_name = &item_path(item_type, name);
1387 let joint_dst = self.dst.join(file_name);
1388 try_err!(fs::create_dir_all(&self.dst), &self.dst);
1389 let mut dst = try_err!(File::create(&joint_dst), &joint_dst);
1390 try_err!(dst.write_all(&buf), &joint_dst);
1392 // Redirect from a sane URL using the namespace to Rustdoc's
1393 // URL for the page.
1394 let redir_name = format!("{}.{}.html", name, item_type.name_space());
1395 let redir_dst = self.dst.join(redir_name);
1396 if let Ok(mut redirect_out) = OpenOptions::new().create_new(true)
1399 try_err!(layout::redirect(&mut redirect_out, file_name), &redir_dst);
1402 // If the item is a macro, redirect from the old macro URL (with !)
1403 // to the new one (without).
1404 // FIXME(#35705) remove this redirect.
1405 if item_type == ItemType::Macro {
1406 let redir_name = format!("{}.{}!.html", item_type, name);
1407 let redir_dst = self.dst.join(redir_name);
1408 let mut redirect_out = try_err!(File::create(&redir_dst), &redir_dst);
1409 try_err!(layout::redirect(&mut redirect_out, file_name), &redir_dst);
1416 fn build_sidebar_items(&self, m: &clean::Module) -> BTreeMap<String, Vec<NameDoc>> {
1417 // BTreeMap instead of HashMap to get a sorted output
1418 let mut map = BTreeMap::new();
1419 for item in &m.items {
1420 if item.is_stripped() { continue }
1422 let short = item.type_().css_class();
1423 let myname = match item.name {
1425 Some(ref s) => s.to_string(),
1427 let short = short.to_string();
1428 map.entry(short).or_insert(vec![])
1429 .push((myname, Some(plain_summary_line(item.doc_value()))));
1432 for (_, items) in &mut map {
1440 /// Generate a url appropriate for an `href` attribute back to the source of
1443 /// The url generated, when clicked, will redirect the browser back to the
1444 /// original source code.
1446 /// If `None` is returned, then a source link couldn't be generated. This
1447 /// may happen, for example, with externally inlined items where the source
1448 /// of their crate documentation isn't known.
1449 fn src_href(&self) -> Option<String> {
1450 let mut root = self.cx.root_path();
1452 let cache = cache();
1453 let mut path = String::new();
1454 let (krate, path) = if self.item.def_id.is_local() {
1455 let path = PathBuf::from(&self.item.source.filename);
1456 if let Some(path) = self.cx.shared.local_sources.get(&path) {
1457 (&self.cx.shared.layout.krate, path)
1462 // Macros from other libraries get special filenames which we can
1464 if self.item.source.filename.starts_with("<") &&
1465 self.item.source.filename.ends_with("macros>") {
1469 let (krate, src_root) = match cache.extern_locations.get(&self.item.def_id.krate) {
1470 Some(&(ref name, ref src, Local)) => (name, src),
1471 Some(&(ref name, ref src, Remote(ref s))) => {
1472 root = s.to_string();
1475 Some(&(_, _, Unknown)) | None => return None,
1478 let file = Path::new(&self.item.source.filename);
1479 clean_srcpath(&src_root, file, false, |component| {
1480 path.push_str(component);
1483 let mut fname = file.file_name().expect("source has no filename")
1485 fname.push(".html");
1486 path.push_str(&fname.to_string_lossy());
1490 let lines = if self.item.source.loline == self.item.source.hiline {
1491 format!("{}", self.item.source.loline)
1493 format!("{}-{}", self.item.source.loline, self.item.source.hiline)
1495 Some(format!("{root}src/{krate}/{path}#{lines}",
1503 impl<'a> fmt::Display for Item<'a> {
1504 fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
1505 debug_assert!(!self.item.is_stripped());
1506 // Write the breadcrumb trail header for the top
1507 write!(fmt, "\n<h1 class='fqn'><span class='in-band'>")?;
1508 match self.item.inner {
1509 clean::ModuleItem(ref m) => if m.is_crate {
1510 write!(fmt, "Crate ")?;
1512 write!(fmt, "Module ")?;
1514 clean::FunctionItem(..) | clean::ForeignFunctionItem(..) =>
1515 write!(fmt, "Function ")?,
1516 clean::TraitItem(..) => write!(fmt, "Trait ")?,
1517 clean::StructItem(..) => write!(fmt, "Struct ")?,
1518 clean::UnionItem(..) => write!(fmt, "Union ")?,
1519 clean::EnumItem(..) => write!(fmt, "Enum ")?,
1520 clean::TypedefItem(..) => write!(fmt, "Type Definition ")?,
1521 clean::MacroItem(..) => write!(fmt, "Macro ")?,
1522 clean::PrimitiveItem(..) => write!(fmt, "Primitive Type ")?,
1523 clean::StaticItem(..) | clean::ForeignStaticItem(..) =>
1524 write!(fmt, "Static ")?,
1525 clean::ConstantItem(..) => write!(fmt, "Constant ")?,
1527 // We don't generate pages for any other type.
1531 if !self.item.is_primitive() {
1532 let cur = &self.cx.current;
1533 let amt = if self.item.is_mod() { cur.len() - 1 } else { cur.len() };
1534 for (i, component) in cur.iter().enumerate().take(amt) {
1535 write!(fmt, "<a href='{}index.html'>{}</a>::<wbr>",
1536 repeat("../").take(cur.len() - i - 1)
1537 .collect::<String>(),
1541 write!(fmt, "<a class=\"{}\" href=''>{}</a>",
1542 self.item.type_(), self.item.name.as_ref().unwrap())?;
1544 write!(fmt, "</span>")?; // in-band
1545 write!(fmt, "<span class='out-of-band'>")?;
1546 if let Some(version) = self.item.stable_since() {
1547 write!(fmt, "<span class='since' title='Stable since Rust version {0}'>{0}</span>",
1551 r##"<span id='render-detail'>
1552 <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
1553 [<span class='inner'>−</span>]
1559 // When this item is part of a `pub use` in a downstream crate, the
1560 // [src] link in the downstream documentation will actually come back to
1561 // this page, and this link will be auto-clicked. The `id` attribute is
1562 // used to find the link to auto-click.
1563 if self.cx.shared.include_sources && !self.item.is_primitive() {
1564 if let Some(l) = self.src_href() {
1565 write!(fmt, "<a class='srclink' href='{}' title='{}'>[src]</a>",
1566 l, "goto source code")?;
1570 write!(fmt, "</span>")?; // out-of-band
1572 write!(fmt, "</h1>\n")?;
1574 match self.item.inner {
1575 clean::ModuleItem(ref m) => {
1576 item_module(fmt, self.cx, self.item, &m.items)
1578 clean::FunctionItem(ref f) | clean::ForeignFunctionItem(ref f) =>
1579 item_function(fmt, self.cx, self.item, f),
1580 clean::TraitItem(ref t) => item_trait(fmt, self.cx, self.item, t),
1581 clean::StructItem(ref s) => item_struct(fmt, self.cx, self.item, s),
1582 clean::UnionItem(ref s) => item_union(fmt, self.cx, self.item, s),
1583 clean::EnumItem(ref e) => item_enum(fmt, self.cx, self.item, e),
1584 clean::TypedefItem(ref t, _) => item_typedef(fmt, self.cx, self.item, t),
1585 clean::MacroItem(ref m) => item_macro(fmt, self.cx, self.item, m),
1586 clean::PrimitiveItem(ref p) => item_primitive(fmt, self.cx, self.item, p),
1587 clean::StaticItem(ref i) | clean::ForeignStaticItem(ref i) =>
1588 item_static(fmt, self.cx, self.item, i),
1589 clean::ConstantItem(ref c) => item_constant(fmt, self.cx, self.item, c),
1591 // We don't generate pages for any other type.
1598 fn item_path(ty: ItemType, name: &str) -> String {
1600 ItemType::Module => format!("{}/index.html", name),
1601 _ => format!("{}.{}.html", ty.css_class(), name),
1605 fn full_path(cx: &Context, item: &clean::Item) -> String {
1606 let mut s = cx.current.join("::");
1608 s.push_str(item.name.as_ref().unwrap());
1612 fn shorter<'a>(s: Option<&'a str>) -> String {
1614 Some(s) => s.lines().take_while(|line|{
1615 (*line).chars().any(|chr|{
1616 !chr.is_whitespace()
1618 }).collect::<Vec<_>>().join("\n"),
1619 None => "".to_string()
1624 fn plain_summary_line(s: Option<&str>) -> String {
1625 let line = shorter(s).replace("\n", " ");
1626 markdown::plain_summary_line(&line[..])
1629 fn document(w: &mut fmt::Formatter, cx: &Context, item: &clean::Item) -> fmt::Result {
1630 document_stability(w, cx, item)?;
1631 let prefix = render_assoc_const_value(item);
1632 document_full(w, item, cx.render_type, &prefix)?;
1636 fn document_short(w: &mut fmt::Formatter, item: &clean::Item, link: AssocItemLink,
1637 render_type: RenderType, prefix: &str) -> fmt::Result {
1638 if let Some(s) = item.doc_value() {
1639 let markdown = if s.contains('\n') {
1640 format!("{} [Read more]({})",
1641 &plain_summary_line(Some(s)), naive_assoc_href(item, link))
1643 format!("{}", &plain_summary_line(Some(s)))
1645 write!(w, "<div class='docblock'>{}{}</div>", prefix, Markdown(&markdown, render_type))?;
1646 } else if !prefix.is_empty() {
1647 write!(w, "<div class='docblock'>{}</div>", prefix)?;
1652 fn render_assoc_const_value(item: &clean::Item) -> String {
1654 clean::AssociatedConstItem(ref ty, Some(ref default)) => {
1655 highlight::render_with_highlighting(
1656 &format!("{}: {:#} = {}", item.name.as_ref().unwrap(), ty, default),
1666 fn document_full(w: &mut fmt::Formatter, item: &clean::Item,
1667 render_type: RenderType, prefix: &str) -> fmt::Result {
1668 if let Some(s) = item.doc_value() {
1669 write!(w, "<div class='docblock'>{}{}</div>", prefix, Markdown(s, render_type))?;
1670 } else if !prefix.is_empty() {
1671 write!(w, "<div class='docblock'>{}</div>", prefix)?;
1676 fn document_stability(w: &mut fmt::Formatter, cx: &Context, item: &clean::Item) -> fmt::Result {
1677 let stabilities = short_stability(item, cx, true);
1678 if !stabilities.is_empty() {
1679 write!(w, "<div class='stability'>")?;
1680 for stability in stabilities {
1681 write!(w, "{}", stability)?;
1683 write!(w, "</div>")?;
1688 fn name_key(name: &str) -> (&str, u64, usize) {
1689 // find number at end
1690 let split = name.bytes().rposition(|b| b < b'0' || b'9' < b).map_or(0, |s| s + 1);
1692 // count leading zeroes
1694 name[split..].bytes().position(|b| b != b'0').map_or(name.len(), |extra| split + extra);
1696 // sort leading zeroes last
1697 let num_zeroes = after_zeroes - split;
1699 match name[split..].parse() {
1700 Ok(n) => (&name[..split], n, num_zeroes),
1701 Err(_) => (name, 0, num_zeroes),
1705 fn item_module(w: &mut fmt::Formatter, cx: &Context,
1706 item: &clean::Item, items: &[clean::Item]) -> fmt::Result {
1707 document(w, cx, item)?;
1709 let mut indices = (0..items.len()).filter(|i| {
1710 if let clean::DefaultImplItem(..) = items[*i].inner {
1713 !items[*i].is_stripped()
1714 }).collect::<Vec<usize>>();
1716 // the order of item types in the listing
1717 fn reorder(ty: ItemType) -> u8 {
1719 ItemType::ExternCrate => 0,
1720 ItemType::Import => 1,
1721 ItemType::Primitive => 2,
1722 ItemType::Module => 3,
1723 ItemType::Macro => 4,
1724 ItemType::Struct => 5,
1725 ItemType::Enum => 6,
1726 ItemType::Constant => 7,
1727 ItemType::Static => 8,
1728 ItemType::Trait => 9,
1729 ItemType::Function => 10,
1730 ItemType::Typedef => 12,
1731 ItemType::Union => 13,
1736 fn cmp(i1: &clean::Item, i2: &clean::Item, idx1: usize, idx2: usize) -> Ordering {
1737 let ty1 = i1.type_();
1738 let ty2 = i2.type_();
1740 return (reorder(ty1), idx1).cmp(&(reorder(ty2), idx2))
1742 let s1 = i1.stability.as_ref().map(|s| s.level);
1743 let s2 = i2.stability.as_ref().map(|s| s.level);
1745 (Some(stability::Unstable), Some(stability::Stable)) => return Ordering::Greater,
1746 (Some(stability::Stable), Some(stability::Unstable)) => return Ordering::Less,
1749 let lhs = i1.name.as_ref().map_or("", |s| &**s);
1750 let rhs = i2.name.as_ref().map_or("", |s| &**s);
1751 name_key(lhs).cmp(&name_key(rhs))
1754 indices.sort_by(|&i1, &i2| cmp(&items[i1], &items[i2], i1, i2));
1756 debug!("{:?}", indices);
1757 let mut curty = None;
1758 for &idx in &indices {
1759 let myitem = &items[idx];
1760 if myitem.is_stripped() {
1764 let myty = Some(myitem.type_());
1765 if curty == Some(ItemType::ExternCrate) && myty == Some(ItemType::Import) {
1766 // Put `extern crate` and `use` re-exports in the same section.
1768 } else if myty != curty {
1769 if curty.is_some() {
1770 write!(w, "</table>")?;
1773 let (short, name) = match myty.unwrap() {
1774 ItemType::ExternCrate |
1775 ItemType::Import => ("reexports", "Reexports"),
1776 ItemType::Module => ("modules", "Modules"),
1777 ItemType::Struct => ("structs", "Structs"),
1778 ItemType::Union => ("unions", "Unions"),
1779 ItemType::Enum => ("enums", "Enums"),
1780 ItemType::Function => ("functions", "Functions"),
1781 ItemType::Typedef => ("types", "Type Definitions"),
1782 ItemType::Static => ("statics", "Statics"),
1783 ItemType::Constant => ("constants", "Constants"),
1784 ItemType::Trait => ("traits", "Traits"),
1785 ItemType::Impl => ("impls", "Implementations"),
1786 ItemType::TyMethod => ("tymethods", "Type Methods"),
1787 ItemType::Method => ("methods", "Methods"),
1788 ItemType::StructField => ("fields", "Struct Fields"),
1789 ItemType::Variant => ("variants", "Variants"),
1790 ItemType::Macro => ("macros", "Macros"),
1791 ItemType::Primitive => ("primitives", "Primitive Types"),
1792 ItemType::AssociatedType => ("associated-types", "Associated Types"),
1793 ItemType::AssociatedConst => ("associated-consts", "Associated Constants"),
1795 write!(w, "<h2 id='{id}' class='section-header'>\
1796 <a href=\"#{id}\">{name}</a></h2>\n<table>",
1797 id = derive_id(short.to_owned()), name = name)?;
1800 match myitem.inner {
1801 clean::ExternCrateItem(ref name, ref src) => {
1802 use html::format::HRef;
1806 write!(w, "<tr><td><code>{}extern crate {} as {};",
1807 VisSpace(&myitem.visibility),
1808 HRef::new(myitem.def_id, src),
1812 write!(w, "<tr><td><code>{}extern crate {};",
1813 VisSpace(&myitem.visibility),
1814 HRef::new(myitem.def_id, name))?
1817 write!(w, "</code></td></tr>")?;
1820 clean::ImportItem(ref import) => {
1821 write!(w, "<tr><td><code>{}{}</code></td></tr>",
1822 VisSpace(&myitem.visibility), *import)?;
1826 if myitem.name.is_none() { continue }
1828 let stabilities = short_stability(myitem, cx, false);
1830 let stab_docs = if !stabilities.is_empty() {
1832 .map(|s| format!("[{}]", s))
1833 .collect::<Vec<_>>()
1840 let unsafety_flag = match myitem.inner {
1841 clean::FunctionItem(ref func) | clean::ForeignFunctionItem(ref func)
1842 if func.unsafety == hir::Unsafety::Unsafe => {
1843 "<a title='unsafe function' href='#'><sup>âš </sup></a>"
1848 let doc_value = myitem.doc_value().unwrap_or("");
1850 <tr class='{stab} module-item'>
1851 <td><a class=\"{class}\" href=\"{href}\"
1852 title='{title_type} {title}'>{name}</a>{unsafety_flag}</td>
1853 <td class='docblock-short'>
1857 name = *myitem.name.as_ref().unwrap(),
1858 stab_docs = stab_docs,
1859 docs = if cx.render_type == RenderType::Hoedown {
1861 shorter(Some(&Markdown(doc_value,
1862 RenderType::Hoedown).to_string())))
1864 format!("{}", MarkdownSummaryLine(doc_value))
1866 class = myitem.type_(),
1867 stab = myitem.stability_class().unwrap_or("".to_string()),
1868 unsafety_flag = unsafety_flag,
1869 href = item_path(myitem.type_(), myitem.name.as_ref().unwrap()),
1870 title_type = myitem.type_(),
1871 title = full_path(cx, myitem))?;
1876 if curty.is_some() {
1877 write!(w, "</table>")?;
1882 fn short_stability(item: &clean::Item, cx: &Context, show_reason: bool) -> Vec<String> {
1883 let mut stability = vec![];
1885 if let Some(stab) = item.stability.as_ref() {
1886 let deprecated_reason = if show_reason && !stab.deprecated_reason.is_empty() {
1887 format!(": {}", stab.deprecated_reason)
1891 if !stab.deprecated_since.is_empty() {
1892 let since = if show_reason {
1893 format!(" since {}", Escape(&stab.deprecated_since))
1897 let text = format!("Deprecated{}{}",
1899 MarkdownHtml(&deprecated_reason, cx.render_type));
1900 stability.push(format!("<div class='stab deprecated'>{}</div>", text))
1903 if stab.level == stability::Unstable {
1905 let unstable_extra = match (!stab.feature.is_empty(),
1906 &cx.shared.issue_tracker_base_url,
1908 (true, &Some(ref tracker_url), Some(issue_no)) if issue_no > 0 =>
1909 format!(" (<code>{} </code><a href=\"{}{}\">#{}</a>)",
1910 Escape(&stab.feature), tracker_url, issue_no, issue_no),
1911 (false, &Some(ref tracker_url), Some(issue_no)) if issue_no > 0 =>
1912 format!(" (<a href=\"{}{}\">#{}</a>)", Escape(&tracker_url), issue_no,
1915 format!(" (<code>{}</code>)", Escape(&stab.feature)),
1918 if stab.unstable_reason.is_empty() {
1919 stability.push(format!("<div class='stab unstable'>\
1920 <span class=microscope>🔬</span> \
1921 This is a nightly-only experimental API. {}\
1925 let text = format!("<summary><span class=microscope>🔬</span> \
1926 This is a nightly-only experimental API. {}\
1929 MarkdownHtml(&stab.unstable_reason, cx.render_type));
1930 stability.push(format!("<div class='stab unstable'><details>{}</details></div>",
1934 stability.push(format!("<div class='stab unstable'>Experimental</div>"))
1937 } else if let Some(depr) = item.deprecation.as_ref() {
1938 let note = if show_reason && !depr.note.is_empty() {
1939 format!(": {}", depr.note)
1943 let since = if show_reason && !depr.since.is_empty() {
1944 format!(" since {}", Escape(&depr.since))
1949 let text = format!("Deprecated{}{}", since, MarkdownHtml(¬e, cx.render_type));
1950 stability.push(format!("<div class='stab deprecated'>{}</div>", text))
1956 struct Initializer<'a>(&'a str);
1958 impl<'a> fmt::Display for Initializer<'a> {
1959 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1960 let Initializer(s) = *self;
1961 if s.is_empty() { return Ok(()); }
1962 write!(f, "<code> = </code>")?;
1963 write!(f, "<code>{}</code>", Escape(s))
1967 fn item_constant(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
1968 c: &clean::Constant) -> fmt::Result {
1969 write!(w, "<pre class='rust const'>")?;
1970 render_attributes(w, it)?;
1971 write!(w, "{vis}const \
1972 {name}: {typ}{init}</pre>",
1973 vis = VisSpace(&it.visibility),
1974 name = it.name.as_ref().unwrap(),
1976 init = Initializer(&c.expr))?;
1980 fn item_static(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
1981 s: &clean::Static) -> fmt::Result {
1982 write!(w, "<pre class='rust static'>")?;
1983 render_attributes(w, it)?;
1984 write!(w, "{vis}static {mutability}\
1985 {name}: {typ}{init}</pre>",
1986 vis = VisSpace(&it.visibility),
1987 mutability = MutableSpace(s.mutability),
1988 name = it.name.as_ref().unwrap(),
1990 init = Initializer(&s.expr))?;
1994 fn item_function(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
1995 f: &clean::Function) -> fmt::Result {
1996 // FIXME(#24111): remove when `const_fn` is stabilized
1997 let vis_constness = match UnstableFeatures::from_environment() {
1998 UnstableFeatures::Allow => f.constness,
1999 _ => hir::Constness::NotConst
2001 let name_len = format!("{}{}{}{:#}fn {}{:#}",
2002 VisSpace(&it.visibility),
2003 ConstnessSpace(vis_constness),
2004 UnsafetySpace(f.unsafety),
2006 it.name.as_ref().unwrap(),
2008 write!(w, "<pre class='rust fn'>")?;
2009 render_attributes(w, it)?;
2010 write!(w, "{vis}{constness}{unsafety}{abi}fn \
2011 {name}{generics}{decl}{where_clause}</pre>",
2012 vis = VisSpace(&it.visibility),
2013 constness = ConstnessSpace(vis_constness),
2014 unsafety = UnsafetySpace(f.unsafety),
2015 abi = AbiSpace(f.abi),
2016 name = it.name.as_ref().unwrap(),
2017 generics = f.generics,
2018 where_clause = WhereClause { gens: &f.generics, indent: 0, end_newline: true },
2027 fn item_trait(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
2028 t: &clean::Trait) -> fmt::Result {
2029 let mut bounds = String::new();
2030 let mut bounds_plain = String::new();
2031 if !t.bounds.is_empty() {
2032 if !bounds.is_empty() {
2034 bounds_plain.push(' ');
2036 bounds.push_str(": ");
2037 bounds_plain.push_str(": ");
2038 for (i, p) in t.bounds.iter().enumerate() {
2040 bounds.push_str(" + ");
2041 bounds_plain.push_str(" + ");
2043 bounds.push_str(&format!("{}", *p));
2044 bounds_plain.push_str(&format!("{:#}", *p));
2048 // Output the trait definition
2049 write!(w, "<pre class='rust trait'>")?;
2050 render_attributes(w, it)?;
2051 write!(w, "{}{}trait {}{}{}",
2052 VisSpace(&it.visibility),
2053 UnsafetySpace(t.unsafety),
2054 it.name.as_ref().unwrap(),
2058 if !t.generics.where_predicates.is_empty() {
2059 write!(w, "{}", WhereClause { gens: &t.generics, indent: 0, end_newline: true })?;
2064 let types = t.items.iter().filter(|m| m.is_associated_type()).collect::<Vec<_>>();
2065 let consts = t.items.iter().filter(|m| m.is_associated_const()).collect::<Vec<_>>();
2066 let required = t.items.iter().filter(|m| m.is_ty_method()).collect::<Vec<_>>();
2067 let provided = t.items.iter().filter(|m| m.is_method()).collect::<Vec<_>>();
2069 if t.items.is_empty() {
2070 write!(w, "{{ }}")?;
2072 // FIXME: we should be using a derived_id for the Anchors here
2076 render_assoc_item(w, t, AssocItemLink::Anchor(None), ItemType::Trait)?;
2079 if !types.is_empty() && !consts.is_empty() {
2084 render_assoc_item(w, t, AssocItemLink::Anchor(None), ItemType::Trait)?;
2087 if !consts.is_empty() && !required.is_empty() {
2090 for (pos, m) in required.iter().enumerate() {
2092 render_assoc_item(w, m, AssocItemLink::Anchor(None), ItemType::Trait)?;
2095 if pos < required.len() - 1 {
2096 write!(w, "<div class='item-spacer'></div>")?;
2099 if !required.is_empty() && !provided.is_empty() {
2102 for (pos, m) in provided.iter().enumerate() {
2104 render_assoc_item(w, m, AssocItemLink::Anchor(None), ItemType::Trait)?;
2106 clean::MethodItem(ref inner) if !inner.generics.where_predicates.is_empty() => {
2107 write!(w, ",\n {{ ... }}\n")?;
2110 write!(w, " {{ ... }}\n")?;
2113 if pos < provided.len() - 1 {
2114 write!(w, "<div class='item-spacer'></div>")?;
2119 write!(w, "</pre>")?;
2121 // Trait documentation
2122 document(w, cx, it)?;
2124 fn trait_item(w: &mut fmt::Formatter, cx: &Context, m: &clean::Item, t: &clean::Item)
2126 let name = m.name.as_ref().unwrap();
2127 let item_type = m.type_();
2128 let id = derive_id(format!("{}.{}", item_type, name));
2129 let ns_id = derive_id(format!("{}.{}", name, item_type.name_space()));
2130 write!(w, "<h3 id='{id}' class='method'>\
2131 <span id='{ns_id}' class='invisible'><code>",
2134 render_assoc_item(w, m, AssocItemLink::Anchor(Some(&id)), ItemType::Impl)?;
2135 write!(w, "</code>")?;
2136 render_stability_since(w, m, t)?;
2137 write!(w, "</span></h3>")?;
2138 document(w, cx, m)?;
2142 if !types.is_empty() {
2144 <h2 id='associated-types'>Associated Types</h2>
2145 <div class='methods'>
2148 trait_item(w, cx, *t, it)?;
2150 write!(w, "</div>")?;
2153 if !consts.is_empty() {
2155 <h2 id='associated-const'>Associated Constants</h2>
2156 <div class='methods'>
2159 trait_item(w, cx, *t, it)?;
2161 write!(w, "</div>")?;
2164 // Output the documentation for each function individually
2165 if !required.is_empty() {
2167 <h2 id='required-methods'>Required Methods</h2>
2168 <div class='methods'>
2170 for m in &required {
2171 trait_item(w, cx, *m, it)?;
2173 write!(w, "</div>")?;
2175 if !provided.is_empty() {
2177 <h2 id='provided-methods'>Provided Methods</h2>
2178 <div class='methods'>
2180 for m in &provided {
2181 trait_item(w, cx, *m, it)?;
2183 write!(w, "</div>")?;
2186 // If there are methods directly on this trait object, render them here.
2187 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)?;
2189 let cache = cache();
2191 <h2 id='implementors'>Implementors</h2>
2192 <ul class='item-list' id='implementors-list'>
2194 if let Some(implementors) = cache.implementors.get(&it.def_id) {
2195 // The DefId is for the first Type found with that name. The bool is
2196 // if any Types with the same name but different DefId have been found.
2197 let mut implementor_dups: FxHashMap<&str, (DefId, bool)> = FxHashMap();
2198 for implementor in implementors {
2199 match implementor.impl_.for_ {
2200 clean::ResolvedPath { ref path, did, is_generic: false, .. } |
2201 clean::BorrowedRef {
2202 type_: box clean::ResolvedPath { ref path, did, is_generic: false, .. },
2205 let &mut (prev_did, ref mut has_duplicates) =
2206 implementor_dups.entry(path.last_name()).or_insert((did, false));
2207 if prev_did != did {
2208 *has_duplicates = true;
2215 for implementor in implementors {
2216 write!(w, "<li><code>")?;
2217 // If there's already another implementor that has the same abbridged name, use the
2218 // full path, for example in `std::iter::ExactSizeIterator`
2219 let use_absolute = match implementor.impl_.for_ {
2220 clean::ResolvedPath { ref path, is_generic: false, .. } |
2221 clean::BorrowedRef {
2222 type_: box clean::ResolvedPath { ref path, is_generic: false, .. },
2224 } => implementor_dups[path.last_name()].1,
2227 fmt_impl_for_trait_page(&implementor.impl_, w, use_absolute)?;
2228 writeln!(w, "</code></li>")?;
2231 write!(w, "</ul>")?;
2232 write!(w, r#"<script type="text/javascript" async
2233 src="{root_path}/implementors/{path}/{ty}.{name}.js">
2235 root_path = vec![".."; cx.current.len()].join("/"),
2236 path = if it.def_id.is_local() {
2237 cx.current.join("/")
2239 let (ref path, _) = cache.external_paths[&it.def_id];
2240 path[..path.len() - 1].join("/")
2242 ty = it.type_().css_class(),
2243 name = *it.name.as_ref().unwrap())?;
2247 fn naive_assoc_href(it: &clean::Item, link: AssocItemLink) -> String {
2248 use html::item_type::ItemType::*;
2250 let name = it.name.as_ref().unwrap();
2251 let ty = match it.type_() {
2252 Typedef | AssociatedType => AssociatedType,
2256 let anchor = format!("#{}.{}", ty, name);
2258 AssocItemLink::Anchor(Some(ref id)) => format!("#{}", id),
2259 AssocItemLink::Anchor(None) => anchor,
2260 AssocItemLink::GotoSource(did, _) => {
2261 href(did).map(|p| format!("{}{}", p.0, anchor)).unwrap_or(anchor)
2266 fn assoc_const(w: &mut fmt::Formatter,
2269 _default: Option<&String>,
2270 link: AssocItemLink) -> fmt::Result {
2271 write!(w, "const <a href='{}' class=\"constant\"><b>{}</b></a>: {}",
2272 naive_assoc_href(it, link),
2273 it.name.as_ref().unwrap(),
2278 fn assoc_type(w: &mut fmt::Formatter, it: &clean::Item,
2279 bounds: &Vec<clean::TyParamBound>,
2280 default: Option<&clean::Type>,
2281 link: AssocItemLink) -> fmt::Result {
2282 write!(w, "type <a href='{}' class=\"type\">{}</a>",
2283 naive_assoc_href(it, link),
2284 it.name.as_ref().unwrap())?;
2285 if !bounds.is_empty() {
2286 write!(w, ": {}", TyParamBounds(bounds))?
2288 if let Some(default) = default {
2289 write!(w, " = {}", default)?;
2294 fn render_stability_since_raw<'a>(w: &mut fmt::Formatter,
2295 ver: Option<&'a str>,
2296 containing_ver: Option<&'a str>) -> fmt::Result {
2297 if let Some(v) = ver {
2298 if containing_ver != ver && v.len() > 0 {
2299 write!(w, "<div class='since' title='Stable since Rust version {0}'>{0}</div>",
2306 fn render_stability_since(w: &mut fmt::Formatter,
2308 containing_item: &clean::Item) -> fmt::Result {
2309 render_stability_since_raw(w, item.stable_since(), containing_item.stable_since())
2312 fn render_assoc_item(w: &mut fmt::Formatter,
2314 link: AssocItemLink,
2315 parent: ItemType) -> fmt::Result {
2316 fn method(w: &mut fmt::Formatter,
2318 unsafety: hir::Unsafety,
2319 constness: hir::Constness,
2321 g: &clean::Generics,
2323 link: AssocItemLink,
2326 let name = meth.name.as_ref().unwrap();
2327 let anchor = format!("#{}.{}", meth.type_(), name);
2328 let href = match link {
2329 AssocItemLink::Anchor(Some(ref id)) => format!("#{}", id),
2330 AssocItemLink::Anchor(None) => anchor,
2331 AssocItemLink::GotoSource(did, provided_methods) => {
2332 // We're creating a link from an impl-item to the corresponding
2333 // trait-item and need to map the anchored type accordingly.
2334 let ty = if provided_methods.contains(name) {
2340 href(did).map(|p| format!("{}#{}.{}", p.0, ty, name)).unwrap_or(anchor)
2343 // FIXME(#24111): remove when `const_fn` is stabilized
2344 let vis_constness = if is_nightly_build() {
2347 hir::Constness::NotConst
2349 let mut head_len = format!("{}{}{:#}fn {}{:#}",
2350 ConstnessSpace(vis_constness),
2351 UnsafetySpace(unsafety),
2355 let (indent, end_newline) = if parent == ItemType::Trait {
2361 write!(w, "{}{}{}fn <a href='{href}' class='fnname'>{name}</a>\
2362 {generics}{decl}{where_clause}",
2363 ConstnessSpace(vis_constness),
2364 UnsafetySpace(unsafety),
2374 where_clause = WhereClause {
2377 end_newline: end_newline,
2381 clean::StrippedItem(..) => Ok(()),
2382 clean::TyMethodItem(ref m) => {
2383 method(w, item, m.unsafety, hir::Constness::NotConst,
2384 m.abi, &m.generics, &m.decl, link, parent)
2386 clean::MethodItem(ref m) => {
2387 method(w, item, m.unsafety, m.constness,
2388 m.abi, &m.generics, &m.decl, link, parent)
2390 clean::AssociatedConstItem(ref ty, ref default) => {
2391 assoc_const(w, item, ty, default.as_ref(), link)
2393 clean::AssociatedTypeItem(ref bounds, ref default) => {
2394 assoc_type(w, item, bounds, default.as_ref(), link)
2396 _ => panic!("render_assoc_item called on non-associated-item")
2400 fn item_struct(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
2401 s: &clean::Struct) -> fmt::Result {
2402 write!(w, "<pre class='rust struct'>")?;
2403 render_attributes(w, it)?;
2411 write!(w, "</pre>")?;
2413 document(w, cx, it)?;
2414 let mut fields = s.fields.iter().filter_map(|f| {
2416 clean::StructFieldItem(ref ty) => Some((f, ty)),
2420 if let doctree::Plain = s.struct_type {
2421 if fields.peek().is_some() {
2422 write!(w, "<h2 id='fields' class='fields'>Fields</h2>")?;
2423 for (field, ty) in fields {
2424 let id = derive_id(format!("{}.{}",
2425 ItemType::StructField,
2426 field.name.as_ref().unwrap()));
2427 let ns_id = derive_id(format!("{}.{}",
2428 field.name.as_ref().unwrap(),
2429 ItemType::StructField.name_space()));
2430 write!(w, "<span id='{id}' class=\"{item_type}\">
2431 <span id='{ns_id}' class='invisible'>
2432 <code>{name}: {ty}</code>
2434 item_type = ItemType::StructField,
2437 name = field.name.as_ref().unwrap(),
2439 if let Some(stability_class) = field.stability_class() {
2440 write!(w, "<span class='stab {stab}'></span>",
2441 stab = stability_class)?;
2443 document(w, cx, field)?;
2447 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
2450 fn item_union(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
2451 s: &clean::Union) -> fmt::Result {
2452 write!(w, "<pre class='rust union'>")?;
2453 render_attributes(w, it)?;
2460 write!(w, "</pre>")?;
2462 document(w, cx, it)?;
2463 let mut fields = s.fields.iter().filter_map(|f| {
2465 clean::StructFieldItem(ref ty) => Some((f, ty)),
2469 if fields.peek().is_some() {
2470 write!(w, "<h2 id='fields' class='fields'>Fields</h2>")?;
2471 for (field, ty) in fields {
2472 write!(w, "<span id='{shortty}.{name}' class=\"{shortty}\"><code>{name}: {ty}</code>
2474 shortty = ItemType::StructField,
2475 name = field.name.as_ref().unwrap(),
2477 if let Some(stability_class) = field.stability_class() {
2478 write!(w, "<span class='stab {stab}'></span>",
2479 stab = stability_class)?;
2481 document(w, cx, field)?;
2484 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
2487 fn item_enum(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
2488 e: &clean::Enum) -> fmt::Result {
2489 write!(w, "<pre class='rust enum'>")?;
2490 render_attributes(w, it)?;
2491 write!(w, "{}enum {}{}{}",
2492 VisSpace(&it.visibility),
2493 it.name.as_ref().unwrap(),
2495 WhereClause { gens: &e.generics, indent: 0, end_newline: true })?;
2496 if e.variants.is_empty() && !e.variants_stripped {
2497 write!(w, " {{}}")?;
2499 write!(w, " {{\n")?;
2500 for v in &e.variants {
2502 let name = v.name.as_ref().unwrap();
2504 clean::VariantItem(ref var) => {
2506 clean::VariantKind::CLike => write!(w, "{}", name)?,
2507 clean::VariantKind::Tuple(ref tys) => {
2508 write!(w, "{}(", name)?;
2509 for (i, ty) in tys.iter().enumerate() {
2511 write!(w, ", ")?
2513 write!(w, "{}", *ty)?;
2517 clean::VariantKind::Struct(ref s) => {
2533 if e.variants_stripped {
2534 write!(w, " // some variants omitted\n")?;
2538 write!(w, "</pre>")?;
2540 document(w, cx, it)?;
2541 if !e.variants.is_empty() {
2542 write!(w, "<h2 id='variants' class='variants'>Variants</h2>\n")?;
2543 for variant in &e.variants {
2544 let id = derive_id(format!("{}.{}",
2546 variant.name.as_ref().unwrap()));
2547 let ns_id = derive_id(format!("{}.{}",
2548 variant.name.as_ref().unwrap(),
2549 ItemType::Variant.name_space()));
2550 write!(w, "<span id='{id}' class='variant'>\
2551 <span id='{ns_id}' class='invisible'><code>{name}",
2554 name = variant.name.as_ref().unwrap())?;
2555 if let clean::VariantItem(ref var) = variant.inner {
2556 if let clean::VariantKind::Tuple(ref tys) = var.kind {
2558 for (i, ty) in tys.iter().enumerate() {
2560 write!(w, ", ")?;
2562 write!(w, "{}", *ty)?;
2567 write!(w, "</code></span></span>")?;
2568 document(w, cx, variant)?;
2570 use clean::{Variant, VariantKind};
2571 if let clean::VariantItem(Variant {
2572 kind: VariantKind::Struct(ref s)
2573 }) = variant.inner {
2574 let variant_id = derive_id(format!("{}.{}.fields",
2576 variant.name.as_ref().unwrap()));
2577 write!(w, "<span class='docblock autohide sub-variant' id='{id}'>",
2579 write!(w, "<h3 class='fields'>Fields of <code>{name}</code></h3>\n
2580 <table>", name = variant.name.as_ref().unwrap())?;
2581 for field in &s.fields {
2582 use clean::StructFieldItem;
2583 if let StructFieldItem(ref ty) = field.inner {
2584 let id = derive_id(format!("variant.{}.field.{}",
2585 variant.name.as_ref().unwrap(),
2586 field.name.as_ref().unwrap()));
2587 let ns_id = derive_id(format!("{}.{}.{}.{}",
2588 variant.name.as_ref().unwrap(),
2589 ItemType::Variant.name_space(),
2590 field.name.as_ref().unwrap(),
2591 ItemType::StructField.name_space()));
2592 write!(w, "<tr><td \
2594 <span id='{ns_id}' class='invisible'>\
2595 <code>{f}: {t}</code></span></td><td>",
2598 f = field.name.as_ref().unwrap(),
2600 document(w, cx, field)?;
2601 write!(w, "</td></tr>")?;
2604 write!(w, "</table></span>")?;
2606 render_stability_since(w, variant, it)?;
2609 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)?;
2613 fn render_attribute(attr: &ast::MetaItem) -> Option<String> {
2614 let name = attr.name();
2617 Some(format!("{}", name))
2618 } else if let Some(v) = attr.value_str() {
2619 Some(format!("{} = {:?}", name, v.as_str()))
2620 } else if let Some(values) = attr.meta_item_list() {
2621 let display: Vec<_> = values.iter().filter_map(|attr| {
2622 attr.meta_item().and_then(|mi| render_attribute(mi))
2625 if display.len() > 0 {
2626 Some(format!("{}({})", name, display.join(", ")))
2635 const ATTRIBUTE_WHITELIST: &'static [&'static str] = &[
2642 "unsafe_destructor_blind_to_params"
2645 fn render_attributes(w: &mut fmt::Formatter, it: &clean::Item) -> fmt::Result {
2646 let mut attrs = String::new();
2648 for attr in &it.attrs.other_attrs {
2649 let name = attr.name().unwrap();
2650 if !ATTRIBUTE_WHITELIST.contains(&&*name.as_str()) {
2653 if let Some(s) = render_attribute(&attr.meta().unwrap()) {
2654 attrs.push_str(&format!("#[{}]\n", s));
2657 if attrs.len() > 0 {
2658 write!(w, "<div class=\"docblock attributes\">{}</div>", &attrs)?;
2663 fn render_struct(w: &mut fmt::Formatter, it: &clean::Item,
2664 g: Option<&clean::Generics>,
2665 ty: doctree::StructType,
2666 fields: &[clean::Item],
2668 structhead: bool) -> fmt::Result {
2670 VisSpace(&it.visibility),
2671 if structhead {"struct "} else {""},
2672 it.name.as_ref().unwrap())?;
2673 if let Some(g) = g {
2678 if let Some(g) = g {
2679 write!(w, "{}", WhereClause { gens: g, indent: 0, end_newline: true })?
2681 let mut has_visible_fields = false;
2683 for field in fields {
2684 if let clean::StructFieldItem(ref ty) = field.inner {
2685 write!(w, "\n{} {}{}: {},",
2687 VisSpace(&field.visibility),
2688 field.name.as_ref().unwrap(),
2690 has_visible_fields = true;
2694 if has_visible_fields {
2695 if it.has_stripped_fields().unwrap() {
2696 write!(w, "\n{} // some fields omitted", tab)?;
2698 write!(w, "\n{}", tab)?;
2699 } else if it.has_stripped_fields().unwrap() {
2700 // If there are no visible fields we can just display
2701 // `{ /* fields omitted */ }` to save space.
2702 write!(w, " /* fields omitted */ ")?;
2708 for (i, field) in fields.iter().enumerate() {
2713 clean::StrippedItem(box clean::StructFieldItem(..)) => {
2716 clean::StructFieldItem(ref ty) => {
2717 write!(w, "{}{}", VisSpace(&field.visibility), *ty)?
2723 if let Some(g) = g {
2724 write!(w, "{}", WhereClause { gens: g, indent: 0, end_newline: false })?
2729 // Needed for PhantomData.
2730 if let Some(g) = g {
2731 write!(w, "{}", WhereClause { gens: g, indent: 0, end_newline: false })?
2739 fn render_union(w: &mut fmt::Formatter, it: &clean::Item,
2740 g: Option<&clean::Generics>,
2741 fields: &[clean::Item],
2743 structhead: bool) -> fmt::Result {
2745 VisSpace(&it.visibility),
2746 if structhead {"union "} else {""},
2747 it.name.as_ref().unwrap())?;
2748 if let Some(g) = g {
2749 write!(w, "{}", g)?;
2750 write!(w, "{}", WhereClause { gens: g, indent: 0, end_newline: true })?;
2753 write!(w, " {{\n{}", tab)?;
2754 for field in fields {
2755 if let clean::StructFieldItem(ref ty) = field.inner {
2756 write!(w, " {}{}: {},\n{}",
2757 VisSpace(&field.visibility),
2758 field.name.as_ref().unwrap(),
2764 if it.has_stripped_fields().unwrap() {
2765 write!(w, " // some fields omitted\n{}", tab)?;
2771 #[derive(Copy, Clone)]
2772 enum AssocItemLink<'a> {
2773 Anchor(Option<&'a str>),
2774 GotoSource(DefId, &'a FxHashSet<String>),
2777 impl<'a> AssocItemLink<'a> {
2778 fn anchor(&self, id: &'a String) -> Self {
2780 AssocItemLink::Anchor(_) => { AssocItemLink::Anchor(Some(&id)) },
2781 ref other => *other,
2786 enum AssocItemRender<'a> {
2788 DerefFor { trait_: &'a clean::Type, type_: &'a clean::Type, deref_mut_: bool }
2791 #[derive(Copy, Clone, PartialEq)]
2794 ForDeref { mut_: bool },
2797 fn render_assoc_items(w: &mut fmt::Formatter,
2799 containing_item: &clean::Item,
2801 what: AssocItemRender) -> fmt::Result {
2803 let v = match c.impls.get(&it) {
2805 None => return Ok(()),
2807 let (non_trait, traits): (Vec<_>, _) = v.iter().partition(|i| {
2808 i.inner_impl().trait_.is_none()
2810 if !non_trait.is_empty() {
2811 let render_mode = match what {
2812 AssocItemRender::All => {
2813 write!(w, "<h2 id='methods'>Methods</h2>")?;
2816 AssocItemRender::DerefFor { trait_, type_, deref_mut_ } => {
2817 write!(w, "<h2 id='deref-methods'>Methods from \
2818 {}<Target = {}></h2>", trait_, type_)?;
2819 RenderMode::ForDeref { mut_: deref_mut_ }
2822 for i in &non_trait {
2823 render_impl(w, cx, i, AssocItemLink::Anchor(None), render_mode,
2824 containing_item.stable_since())?;
2827 if let AssocItemRender::DerefFor { .. } = what {
2830 if !traits.is_empty() {
2831 let deref_impl = traits.iter().find(|t| {
2832 t.inner_impl().trait_.def_id() == c.deref_trait_did
2834 if let Some(impl_) = deref_impl {
2835 let has_deref_mut = traits.iter().find(|t| {
2836 t.inner_impl().trait_.def_id() == c.deref_mut_trait_did
2838 render_deref_methods(w, cx, impl_, containing_item, has_deref_mut)?;
2840 write!(w, "<h2 id='implementations'>Trait \
2841 Implementations</h2>")?;
2843 let did = i.trait_did().unwrap();
2844 let assoc_link = AssocItemLink::GotoSource(did, &i.inner_impl().provided_trait_methods);
2845 render_impl(w, cx, i, assoc_link,
2846 RenderMode::Normal, containing_item.stable_since())?;
2852 fn render_deref_methods(w: &mut fmt::Formatter, cx: &Context, impl_: &Impl,
2853 container_item: &clean::Item, deref_mut: bool) -> fmt::Result {
2854 let deref_type = impl_.inner_impl().trait_.as_ref().unwrap();
2855 let target = impl_.inner_impl().items.iter().filter_map(|item| {
2857 clean::TypedefItem(ref t, true) => Some(&t.type_),
2860 }).next().expect("Expected associated type binding");
2861 let what = AssocItemRender::DerefFor { trait_: deref_type, type_: target,
2862 deref_mut_: deref_mut };
2863 if let Some(did) = target.def_id() {
2864 render_assoc_items(w, cx, container_item, did, what)
2866 if let Some(prim) = target.primitive_type() {
2867 if let Some(&did) = cache().primitive_locations.get(&prim) {
2868 render_assoc_items(w, cx, container_item, did, what)?;
2875 fn render_impl(w: &mut fmt::Formatter, cx: &Context, i: &Impl, link: AssocItemLink,
2876 render_mode: RenderMode, outer_version: Option<&str>) -> fmt::Result {
2877 if render_mode == RenderMode::Normal {
2878 write!(w, "<h3 class='impl'><span class='in-band'><code>{}</code>", i.inner_impl())?;
2879 write!(w, "</span><span class='out-of-band'>")?;
2880 let since = i.impl_item.stability.as_ref().map(|s| &s.since[..]);
2881 if let Some(l) = (Item { item: &i.impl_item, cx: cx }).src_href() {
2882 write!(w, "<div class='ghost'></div>")?;
2883 render_stability_since_raw(w, since, outer_version)?;
2884 write!(w, "<a class='srclink' href='{}' title='{}'>[src]</a>",
2885 l, "goto source code")?;
2887 render_stability_since_raw(w, since, outer_version)?;
2889 write!(w, "</span>")?;
2890 write!(w, "</h3>\n")?;
2891 if let Some(ref dox) = i.impl_item.doc_value() {
2892 write!(w, "<div class='docblock'>{}</div>", Markdown(dox, cx.render_type))?;
2896 fn doc_impl_item(w: &mut fmt::Formatter, cx: &Context, item: &clean::Item,
2897 link: AssocItemLink, render_mode: RenderMode,
2898 is_default_item: bool, outer_version: Option<&str>,
2899 trait_: Option<&clean::Trait>) -> fmt::Result {
2900 let item_type = item.type_();
2901 let name = item.name.as_ref().unwrap();
2903 let render_method_item: bool = match render_mode {
2904 RenderMode::Normal => true,
2905 RenderMode::ForDeref { mut_: deref_mut_ } => {
2906 let self_type_opt = match item.inner {
2907 clean::MethodItem(ref method) => method.decl.self_type(),
2908 clean::TyMethodItem(ref method) => method.decl.self_type(),
2912 if let Some(self_ty) = self_type_opt {
2913 let (by_mut_ref, by_box) = match self_ty {
2914 SelfTy::SelfBorrowed(_, mutability) |
2915 SelfTy::SelfExplicit(clean::BorrowedRef { mutability, .. }) => {
2916 (mutability == Mutability::Mutable, false)
2918 SelfTy::SelfExplicit(clean::ResolvedPath { did, .. }) => {
2919 (false, Some(did) == cache().owned_box_did)
2921 _ => (false, false),
2924 (deref_mut_ || !by_mut_ref) && !by_box
2932 clean::MethodItem(..) | clean::TyMethodItem(..) => {
2933 // Only render when the method is not static or we allow static methods
2934 if render_method_item {
2935 let id = derive_id(format!("{}.{}", item_type, name));
2936 let ns_id = derive_id(format!("{}.{}", name, item_type.name_space()));
2937 write!(w, "<h4 id='{}' class=\"{}\">", id, item_type)?;
2938 write!(w, "<span id='{}' class='invisible'>", ns_id)?;
2939 write!(w, "<code>")?;
2940 render_assoc_item(w, item, link.anchor(&id), ItemType::Impl)?;
2941 write!(w, "</code>")?;
2942 render_stability_since_raw(w, item.stable_since(), outer_version)?;
2943 write!(w, "</span></h4>\n")?;
2946 clean::TypedefItem(ref tydef, _) => {
2947 let id = derive_id(format!("{}.{}", ItemType::AssociatedType, name));
2948 let ns_id = derive_id(format!("{}.{}", name, item_type.name_space()));
2949 write!(w, "<h4 id='{}' class=\"{}\">", id, item_type)?;
2950 write!(w, "<span id='{}' class='invisible'><code>", ns_id)?;
2951 assoc_type(w, item, &Vec::new(), Some(&tydef.type_), link.anchor(&id))?;
2952 write!(w, "</code></span></h4>\n")?;
2954 clean::AssociatedConstItem(ref ty, ref default) => {
2955 let id = derive_id(format!("{}.{}", item_type, name));
2956 let ns_id = derive_id(format!("{}.{}", name, item_type.name_space()));
2957 write!(w, "<h4 id='{}' class=\"{}\">", id, item_type)?;
2958 write!(w, "<span id='{}' class='invisible'><code>", ns_id)?;
2959 assoc_const(w, item, ty, default.as_ref(), link.anchor(&id))?;
2960 write!(w, "</code></span></h4>\n")?;
2962 clean::AssociatedTypeItem(ref bounds, ref default) => {
2963 let id = derive_id(format!("{}.{}", item_type, name));
2964 let ns_id = derive_id(format!("{}.{}", name, item_type.name_space()));
2965 write!(w, "<h4 id='{}' class=\"{}\">", id, item_type)?;
2966 write!(w, "<span id='{}' class='invisible'><code>", ns_id)?;
2967 assoc_type(w, item, bounds, default.as_ref(), link.anchor(&id))?;
2968 write!(w, "</code></span></h4>\n")?;
2970 clean::StrippedItem(..) => return Ok(()),
2971 _ => panic!("can't make docs for trait item with name {:?}", item.name)
2974 if render_method_item || render_mode == RenderMode::Normal {
2975 let prefix = render_assoc_const_value(item);
2976 if !is_default_item {
2977 if let Some(t) = trait_ {
2978 // The trait item may have been stripped so we might not
2979 // find any documentation or stability for it.
2980 if let Some(it) = t.items.iter().find(|i| i.name == item.name) {
2981 // We need the stability of the item from the trait
2982 // because impls can't have a stability.
2983 document_stability(w, cx, it)?;
2984 if item.doc_value().is_some() {
2985 document_full(w, item, cx.render_type, &prefix)?;
2987 // In case the item isn't documented,
2988 // provide short documentation from the trait.
2989 document_short(w, it, link, cx.render_type, &prefix)?;
2993 document_stability(w, cx, item)?;
2994 document_full(w, item, cx.render_type, &prefix)?;
2997 document_stability(w, cx, item)?;
2998 document_short(w, item, link, cx.render_type, &prefix)?;
3004 let traits = &cache().traits;
3005 let trait_ = i.trait_did().and_then(|did| traits.get(&did));
3007 write!(w, "<div class='impl-items'>")?;
3008 for trait_item in &i.inner_impl().items {
3009 doc_impl_item(w, cx, trait_item, link, render_mode,
3010 false, outer_version, trait_)?;
3013 fn render_default_items(w: &mut fmt::Formatter,
3017 render_mode: RenderMode,
3018 outer_version: Option<&str>) -> fmt::Result {
3019 for trait_item in &t.items {
3020 let n = trait_item.name.clone();
3021 if i.items.iter().find(|m| m.name == n).is_some() {
3024 let did = i.trait_.as_ref().unwrap().def_id().unwrap();
3025 let assoc_link = AssocItemLink::GotoSource(did, &i.provided_trait_methods);
3027 doc_impl_item(w, cx, trait_item, assoc_link, render_mode, true,
3028 outer_version, None)?;
3033 // If we've implemented a trait, then also emit documentation for all
3034 // default items which weren't overridden in the implementation block.
3035 if let Some(t) = trait_ {
3036 render_default_items(w, cx, t, &i.inner_impl(), render_mode, outer_version)?;
3038 write!(w, "</div>")?;
3042 fn item_typedef(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
3043 t: &clean::Typedef) -> fmt::Result {
3044 write!(w, "<pre class='rust typedef'>")?;
3045 render_attributes(w, it)?;
3046 write!(w, "type {}{}{where_clause} = {type_};</pre>",
3047 it.name.as_ref().unwrap(),
3049 where_clause = WhereClause { gens: &t.generics, indent: 0, end_newline: true },
3052 document(w, cx, it)?;
3054 // Render any items associated directly to this alias, as otherwise they
3055 // won't be visible anywhere in the docs. It would be nice to also show
3056 // associated items from the aliased type (see discussion in #32077), but
3057 // we need #14072 to make sense of the generics.
3058 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
3061 impl<'a> fmt::Display for Sidebar<'a> {
3062 fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
3065 let parentlen = cx.current.len() - if it.is_mod() {1} else {0};
3067 if it.is_struct() || it.is_trait() || it.is_primitive() || it.is_union()
3068 || it.is_enum() || it.is_mod() || it.is_typedef()
3070 write!(fmt, "<p class='location'>")?;
3072 clean::StructItem(..) => write!(fmt, "Struct ")?,
3073 clean::TraitItem(..) => write!(fmt, "Trait ")?,
3074 clean::PrimitiveItem(..) => write!(fmt, "Primitive Type ")?,
3075 clean::UnionItem(..) => write!(fmt, "Union ")?,
3076 clean::EnumItem(..) => write!(fmt, "Enum ")?,
3077 clean::TypedefItem(..) => write!(fmt, "Type Definition ")?,
3078 clean::ModuleItem(..) => if it.is_crate() {
3079 write!(fmt, "Crate ")?;
3081 write!(fmt, "Module ")?;
3085 write!(fmt, "{}", it.name.as_ref().unwrap())?;
3086 write!(fmt, "</p>")?;
3089 clean::StructItem(ref s) => sidebar_struct(fmt, it, s)?,
3090 clean::TraitItem(ref t) => sidebar_trait(fmt, it, t)?,
3091 clean::PrimitiveItem(ref p) => sidebar_primitive(fmt, it, p)?,
3092 clean::UnionItem(ref u) => sidebar_union(fmt, it, u)?,
3093 clean::EnumItem(ref e) => sidebar_enum(fmt, it, e)?,
3094 clean::TypedefItem(ref t, _) => sidebar_typedef(fmt, it, t)?,
3095 clean::ModuleItem(ref m) => sidebar_module(fmt, it, &m.items)?,
3100 // The sidebar is designed to display sibling functions, modules and
3101 // other miscellaneous information. since there are lots of sibling
3102 // items (and that causes quadratic growth in large modules),
3103 // we refactor common parts into a shared JavaScript file per module.
3104 // still, we don't move everything into JS because we want to preserve
3105 // as much HTML as possible in order to allow non-JS-enabled browsers
3106 // to navigate the documentation (though slightly inefficiently).
3108 write!(fmt, "<p class='location'>")?;
3109 for (i, name) in cx.current.iter().take(parentlen).enumerate() {
3111 write!(fmt, "::<wbr>")?;
3113 write!(fmt, "<a href='{}index.html'>{}</a>",
3114 &cx.root_path()[..(cx.current.len() - i - 1) * 3],
3117 write!(fmt, "</p>")?;
3119 // Sidebar refers to the enclosing module, not this module.
3120 let relpath = if it.is_mod() { "../" } else { "" };
3122 "<script>window.sidebarCurrent = {{\
3127 name = it.name.as_ref().map(|x| &x[..]).unwrap_or(""),
3128 ty = it.type_().css_class(),
3131 // There is no sidebar-items.js beyond the crate root path
3132 // FIXME maybe dynamic crate loading can be merged here
3134 write!(fmt, "<script defer src=\"{path}sidebar-items.js\"></script>",
3142 fn sidebar_assoc_items(it: &clean::Item) -> String {
3143 let mut out = String::new();
3145 if let Some(v) = c.impls.get(&it.def_id) {
3146 if v.iter().any(|i| i.inner_impl().trait_.is_none()) {
3147 out.push_str("<li><a href=\"#methods\">Methods</a></li>");
3150 if v.iter().any(|i| i.inner_impl().trait_.is_some()) {
3151 if let Some(impl_) = v.iter()
3152 .filter(|i| i.inner_impl().trait_.is_some())
3153 .find(|i| i.inner_impl().trait_.def_id() == c.deref_trait_did) {
3154 if let Some(target) = impl_.inner_impl().items.iter().filter_map(|item| {
3156 clean::TypedefItem(ref t, true) => Some(&t.type_),
3160 let inner_impl = target.def_id().or(target.primitive_type().and_then(|prim| {
3161 c.primitive_locations.get(&prim).cloned()
3162 })).and_then(|did| c.impls.get(&did));
3163 if inner_impl.is_some() {
3164 out.push_str("<li><a href=\"#deref-methods\">");
3165 out.push_str(&format!("Methods from {:#}<Target={:#}>",
3166 impl_.inner_impl().trait_.as_ref().unwrap(),
3168 out.push_str("</a></li>");
3172 out.push_str("<li><a href=\"#implementations\">Trait Implementations</a></li>");
3179 fn sidebar_struct(fmt: &mut fmt::Formatter, it: &clean::Item,
3180 s: &clean::Struct) -> fmt::Result {
3181 let mut sidebar = String::new();
3184 .any(|f| if let clean::StructFieldItem(..) = f.inner { true } else { false }) {
3185 if let doctree::Plain = s.struct_type {
3186 sidebar.push_str("<li><a href=\"#fields\">Fields</a></li>");
3190 sidebar.push_str(&sidebar_assoc_items(it));
3192 if !sidebar.is_empty() {
3193 write!(fmt, "<div class=\"block items\"><ul>{}</ul></div>", sidebar)?;
3198 fn sidebar_trait(fmt: &mut fmt::Formatter, it: &clean::Item,
3199 t: &clean::Trait) -> fmt::Result {
3200 let mut sidebar = String::new();
3202 let has_types = t.items.iter().any(|m| m.is_associated_type());
3203 let has_consts = t.items.iter().any(|m| m.is_associated_const());
3204 let has_required = t.items.iter().any(|m| m.is_ty_method());
3205 let has_provided = t.items.iter().any(|m| m.is_method());
3208 sidebar.push_str("<li><a href=\"#associated-types\">Associated Types</a></li>");
3211 sidebar.push_str("<li><a href=\"#associated-const\">Associated Constants</a></li>");
3214 sidebar.push_str("<li><a href=\"#required-methods\">Required Methods</a></li>");
3217 sidebar.push_str("<li><a href=\"#provided-methods\">Provided Methods</a></li>");
3220 sidebar.push_str(&sidebar_assoc_items(it));
3222 sidebar.push_str("<li><a href=\"#implementors\">Implementors</a></li>");
3224 write!(fmt, "<div class=\"block items\"><ul>{}</ul></div>", sidebar)
3227 fn sidebar_primitive(fmt: &mut fmt::Formatter, it: &clean::Item,
3228 _p: &clean::PrimitiveType) -> fmt::Result {
3229 let sidebar = sidebar_assoc_items(it);
3231 if !sidebar.is_empty() {
3232 write!(fmt, "<div class=\"block items\"><ul>{}</ul></div>", sidebar)?;
3237 fn sidebar_typedef(fmt: &mut fmt::Formatter, it: &clean::Item,
3238 _t: &clean::Typedef) -> fmt::Result {
3239 let sidebar = sidebar_assoc_items(it);
3241 if !sidebar.is_empty() {
3242 write!(fmt, "<div class=\"block items\"><ul>{}</ul></div>", sidebar)?;
3247 fn sidebar_union(fmt: &mut fmt::Formatter, it: &clean::Item,
3248 u: &clean::Union) -> fmt::Result {
3249 let mut sidebar = String::new();
3252 .any(|f| if let clean::StructFieldItem(..) = f.inner { true } else { false }) {
3253 sidebar.push_str("<li><a href=\"#fields\">Fields</a></li>");
3256 sidebar.push_str(&sidebar_assoc_items(it));
3258 if !sidebar.is_empty() {
3259 write!(fmt, "<div class=\"block items\"><ul>{}</ul></div>", sidebar)?;
3264 fn sidebar_enum(fmt: &mut fmt::Formatter, it: &clean::Item,
3265 e: &clean::Enum) -> fmt::Result {
3266 let mut sidebar = String::new();
3268 if !e.variants.is_empty() {
3269 sidebar.push_str("<li><a href=\"#variants\">Variants</a></li>");
3272 sidebar.push_str(&sidebar_assoc_items(it));
3274 if !sidebar.is_empty() {
3275 write!(fmt, "<div class=\"block items\"><ul>{}</ul></div>", sidebar)?;
3280 fn sidebar_module(fmt: &mut fmt::Formatter, _it: &clean::Item,
3281 items: &[clean::Item]) -> fmt::Result {
3282 let mut sidebar = String::new();
3284 if items.iter().any(|it| it.type_() == ItemType::ExternCrate ||
3285 it.type_() == ItemType::Import) {
3286 sidebar.push_str(&format!("<li><a href=\"#{id}\">{name}</a></li>",
3288 name = "Reexports"));
3291 // ordering taken from item_module, reorder, where it prioritized elements in a certain order
3292 // to print its headings
3293 for &myty in &[ItemType::Primitive, ItemType::Module, ItemType::Macro, ItemType::Struct,
3294 ItemType::Enum, ItemType::Constant, ItemType::Static, ItemType::Trait,
3295 ItemType::Function, ItemType::Typedef, ItemType::Union, ItemType::Impl,
3296 ItemType::TyMethod, ItemType::Method, ItemType::StructField, ItemType::Variant,
3297 ItemType::AssociatedType, ItemType::AssociatedConst] {
3298 if items.iter().any(|it| {
3299 if let clean::DefaultImplItem(..) = it.inner {
3302 !it.is_stripped() && it.type_() == myty
3305 let (short, name) = match myty {
3306 ItemType::ExternCrate |
3307 ItemType::Import => ("reexports", "Reexports"),
3308 ItemType::Module => ("modules", "Modules"),
3309 ItemType::Struct => ("structs", "Structs"),
3310 ItemType::Union => ("unions", "Unions"),
3311 ItemType::Enum => ("enums", "Enums"),
3312 ItemType::Function => ("functions", "Functions"),
3313 ItemType::Typedef => ("types", "Type Definitions"),
3314 ItemType::Static => ("statics", "Statics"),
3315 ItemType::Constant => ("constants", "Constants"),
3316 ItemType::Trait => ("traits", "Traits"),
3317 ItemType::Impl => ("impls", "Implementations"),
3318 ItemType::TyMethod => ("tymethods", "Type Methods"),
3319 ItemType::Method => ("methods", "Methods"),
3320 ItemType::StructField => ("fields", "Struct Fields"),
3321 ItemType::Variant => ("variants", "Variants"),
3322 ItemType::Macro => ("macros", "Macros"),
3323 ItemType::Primitive => ("primitives", "Primitive Types"),
3324 ItemType::AssociatedType => ("associated-types", "Associated Types"),
3325 ItemType::AssociatedConst => ("associated-consts", "Associated Constants"),
3327 sidebar.push_str(&format!("<li><a href=\"#{id}\">{name}</a></li>",
3333 if !sidebar.is_empty() {
3334 write!(fmt, "<div class=\"block items\"><ul>{}</ul></div>", sidebar)?;
3339 impl<'a> fmt::Display for Source<'a> {
3340 fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
3341 let Source(s) = *self;
3342 let lines = s.lines().count();
3344 let mut tmp = lines;
3349 write!(fmt, "<pre class=\"line-numbers\">")?;
3350 for i in 1..lines + 1 {
3351 write!(fmt, "<span id=\"{0}\">{0:1$}</span>\n", i, cols)?;
3353 write!(fmt, "</pre>")?;
3354 write!(fmt, "{}", highlight::render_with_highlighting(s, None, None, None))?;
3359 fn item_macro(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
3360 t: &clean::Macro) -> fmt::Result {
3361 w.write_str(&highlight::render_with_highlighting(&t.source,
3368 fn item_primitive(w: &mut fmt::Formatter, cx: &Context,
3370 _p: &clean::PrimitiveType) -> fmt::Result {
3371 document(w, cx, it)?;
3372 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
3375 const BASIC_KEYWORDS: &'static str = "rust, rustlang, rust-lang";
3377 fn make_item_keywords(it: &clean::Item) -> String {
3378 format!("{}, {}", BASIC_KEYWORDS, it.name.as_ref().unwrap())
3381 fn get_index_search_type(item: &clean::Item) -> Option<IndexItemFunctionType> {
3382 let decl = match item.inner {
3383 clean::FunctionItem(ref f) => &f.decl,
3384 clean::MethodItem(ref m) => &m.decl,
3385 clean::TyMethodItem(ref m) => &m.decl,
3389 let inputs = decl.inputs.values.iter().map(|arg| get_index_type(&arg.type_)).collect();
3390 let output = match decl.output {
3391 clean::FunctionRetTy::Return(ref return_type) => Some(get_index_type(return_type)),
3395 Some(IndexItemFunctionType { inputs: inputs, output: output })
3398 fn get_index_type(clean_type: &clean::Type) -> Type {
3399 Type { name: get_index_type_name(clean_type).map(|s| s.to_ascii_lowercase()) }
3402 fn get_index_type_name(clean_type: &clean::Type) -> Option<String> {
3404 clean::ResolvedPath { ref path, .. } => {
3405 let segments = &path.segments;
3406 Some(segments[segments.len() - 1].name.clone())
3408 clean::Generic(ref s) => Some(s.clone()),
3409 clean::Primitive(ref p) => Some(format!("{:?}", p)),
3410 clean::BorrowedRef { ref type_, .. } => get_index_type_name(type_),
3411 // FIXME: add all from clean::Type.
3416 pub fn cache() -> Arc<Cache> {
3417 CACHE_KEY.with(|c| c.borrow().clone())
3422 fn test_unique_id() {
3423 let input = ["foo", "examples", "examples", "method.into_iter","examples",
3424 "method.into_iter", "foo", "main", "search", "methods",
3425 "examples", "method.into_iter", "assoc_type.Item", "assoc_type.Item"];
3426 let expected = ["foo", "examples", "examples-1", "method.into_iter", "examples-2",
3427 "method.into_iter-1", "foo-1", "main-1", "search-1", "methods-1",
3428 "examples-3", "method.into_iter-2", "assoc_type.Item", "assoc_type.Item-1"];
3431 let actual: Vec<String> = input.iter().map(|s| derive_id(s.to_string())).collect();
3432 assert_eq!(&actual[..], expected);
3441 fn test_name_key() {
3442 assert_eq!(name_key("0"), ("", 0, 1));
3443 assert_eq!(name_key("123"), ("", 123, 0));
3444 assert_eq!(name_key("Fruit"), ("Fruit", 0, 0));
3445 assert_eq!(name_key("Fruit0"), ("Fruit", 0, 1));
3446 assert_eq!(name_key("Fruit0000"), ("Fruit", 0, 4));
3447 assert_eq!(name_key("Fruit01"), ("Fruit", 1, 1));
3448 assert_eq!(name_key("Fruit10"), ("Fruit", 10, 0));
3449 assert_eq!(name_key("Fruit123"), ("Fruit", 123, 0));
3454 fn test_name_sorting() {
3455 let names = ["Apple",
3457 "Fruit", "Fruit0", "Fruit00",
3458 "Fruit1", "Fruit01",
3459 "Fruit2", "Fruit02",
3463 let mut sorted = names.to_owned();
3464 sorted.sort_by_key(|&s| name_key(s));
3465 assert_eq!(names, sorted);