8000 Rustdoc: formatting to buffers by Mark-Simulacrum · Pull Request #64044 · rust-lang/rust · GitHub
[go: up one dir, main page]
Skip to content

Rustdoc: formatting to buffers #64044

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 17 commits into from
Sep 8, 2019
Merged

Rustdoc: formatting to buffers #64044

Changes from 1 commit
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
f35eae9
Add buffer abstraction
Mark-Simulacrum Aug 27, 2019
eebd026
Migrate top-level rendering to Buffer
Mark-Simulacrum Aug 30, 2019
9e52ba9
Create buffers in top-level rendering
Mark-Simulacrum Aug 30, 2019
3657bfc
Remove needless clone of layout
Mark-Simulacrum Aug 30, 2019
57243b7
Move constant parameters to render to Layout struct
Mark-Simulacrum Aug 30, 2019
75528f2
Replace writeln!/write! with push_str
Mark-Simulacrum Aug 31, 2019
04dc72e
Remove unnecessary Buffer in layout::render
Mark-Simulacrum Aug 31, 2019
f8bccb1
Move sidebar to Buffer-printing
Mark-Simulacrum Aug 31, 2019
f4a15ae
Implement Print for FnOnce(&mut Buffer)
Mark-Simulacrum Aug 31, 2019
eefaee1
Delete Sidebar struct in favor of FnOnce impl
Mark-Simulacrum Aug 31, 2019
d5f1470
De-indent all fmt::Display impls for later replacement to functions
Mark-Simulacrum Aug 31, 2019
3f0e77f
layout::render takes Print instead of fmt::Display
Mark-Simulacrum Aug 31, 2019
bb40d5f
Move Source to Buffer
Mark-Simulacrum Aug 31, 2019
17bef30
Settings to function
Mark-Simulacrum Aug 31, 2019
a502e85
AllTypes to function
Mark-Simulacrum Aug 31, 2019
c1c1e86
Item to function
Mark-Simulacrum Aug 31, 2019
02c5c5c
Move to buffers throughout print_item
Mark-Simulacrum Aug 31, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
AllTypes to function
  • Loading branch information
@Mark-Simulacrum
Mark-Simulacrum committed Sep 7, 2019
commit a502e856034bcd4bc38152b3bd74cad792b62c63
62 changes: 30 additions & 32 deletions src/librustdoc/html/render.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1757,48 +1757,46 @@ impl AllTypes {
}
}

fn print_entries(f: &mut fmt::Formatter<'_>, e: &FxHashSet<ItemEntry>, title: &str,
class: &str) -> fmt::Result {
fn print_entries(f: &mut Buffer, e: &FxHashSet<ItemEntry>, title: &str, class: &str) {
if !e.is_empty() {
let mut e: Vec<&ItemEntry> = e.iter().collect();
e.sort();
write!(f, "<h3 id='{}'>{}</h3><ul class='{} docblock'>{}</ul>",
title,
Escape(title),
class,
e.iter().map(|s| format!("<li>{}</li>", s)).collect::<String>())?;
e.iter().map(|s| format!("<li>{}</li>", s)).collect::<String>());
}
Ok(())
}

impl fmt::Display for AllTypes {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f,
"<h1 class='fqn'>\
<span class='out-of-band'>\
<span id='render-detail'>\
<a id=\"toggle-all-docs\" href=\"javascript:void(0)\" title=\"collapse all docs\">\
[<span class='inner'>&#x2212;</span>]\
</a>\
impl AllTypes {
fn print(self, f: &mut Buffer) {
write!(f,
"<h1 class='fqn'>\
<span class='out-of-band'>\
<span id='render-detail'>\
<a id=\"toggle-all-docs\" href=\"javascript:void(0)\" title=\"collapse all docs\">\
[<span class='inner'>&#x2212;</span>]\
</a>\
</span>
</span>
</span>
<span class='in-band'>List of all items</span>\
</h1>")?;
print_entries(f, &self.structs, "Structs", "structs")?;
print_entries(f, &self.enums, "Enums", "enums")?;
print_entries(f, &self.unions, "Unions", "unions")?;
print_entries(f, &self.primitives, "Primitives", "primitives")?;
print_entries(f, &self.traits, "Traits", "traits")?;
print_entries(f, &self.macros, "Macros", "macros")?;
print_entries(f, &self.attributes, "Attribute Macros", "attributes")?;
print_entries(f, &self.derives, "Derive Macros", "derives")?;
print_entries(f, &self.functions, "Functions", "functions")?;
print_entries(f, &self.typedefs, "Typedefs", "typedefs")?;
print_entries(f, &self.trait_aliases, "Trait Aliases", "trait-aliases")?;
print_entries(f, &self.opaque_tys, "Opaque Types", "opaque-types")?;
print_entries(f, &self.statics, "Statics", "statics")?;
print_entries(f, &self.constants, "Constants", "constants")
}
<span class='in-band'>List of all items</span>\
</h1>");
print_entries(f, &self.structs, "Structs", "structs");
print_entries(f, &self.enums, "Enums", "enums");
print_entries(f, &self.unions, "Unions", "unions");
print_entries(f, &self.primitives, "Primitives", "primitives");
print_entries(f, &self.traits, "Traits", "traits");
print_entries(f, &self.macros, "Macros", "macros");
print_entries(f, &self.attributes, "Attribute Macros", "attributes");
print_entries(f, &self.derives, "Derive Macros", "derives");
print_entries(f, &self.functions, "Functions", "functions");
print_entries(f, &self.typedefs, "Typedefs", "typedefs");
print_entries(f, &self.trait_aliases, "Trait Aliases", "trait-aliases");
print_entries(f, &self.opaque_tys, "Opaque Types", "opaque-types");
print_entries(f, &self.statics, "Statics", "statics");
print_entries(f, &self.constants, "Constants", "constants")
}
}

fn settings(root_path: &str, suffix: &str) -> String {
Expand Down Expand Up @@ -1901,7 +1899,7 @@ impl Context {
String::new()
};
let v = layout::render(&self.shared.layout,
&page, sidebar, |buf: &mut Buffer| buf.from_display(all),
&page, sidebar, |buf: &mut Buffer| all.print(buf),
&self.shared.themes);
self.shared.fs.write(&final_file, v.as_bytes())?;

Expand Down
0