From a40b758cd8995131f1cdcddb8e1924ca0679ff1f Mon Sep 17 00:00:00 2001 From: Guillaume Gomez Date: Sat, 29 Sep 2018 16:40:37 +0200 Subject: [PATCH] Use markdown::render instead of using pulldown_cmark directly --- src/bootstrap/builder.rs | 6 ++--- src/bootstrap/doc.rs | 9 ++++--- src/librustdoc/html/render.rs | 50 +++++++++++++++-------------------- src/librustdoc/lib.rs | 27 ++++++++++--------- src/librustdoc/markdown.rs | 2 +- 5 files changed, 45 insertions(+), 49 deletions(-) diff --git a/src/bootstrap/builder.rs b/src/bootstrap/builder.rs index aa4e44df2ef..58a6e992bc7 100644 --- a/src/bootstrap/builder.rs +++ b/src/bootstrap/builder.rs @@ -714,7 +714,7 @@ pub fn cargo( "build" => self.cargo_out(compiler, mode, target), // This is the intended out directory for crate documentation. - "doc" => self.crate_doc_out(target), + "doc" | "rustdoc" => self.crate_doc_out(target), _ => self.stage_out(compiler, mode), }; @@ -743,7 +743,7 @@ pub fn cargo( _ => compile::librustc_stamp(self, cmp, target), }; - if cmd == "doc" { + if cmd == "doc" || cmd == "rustdoc" { if mode == Mode::Rustc || mode == Mode::ToolRustc || mode == Mode::Codegen { // This is the intended out directory for compiler documentation. my_out = self.compiler_doc_out(target); @@ -883,7 +883,7 @@ pub fn cargo( .env("RUSTDOC", self.out.join("bootstrap/debug/rustdoc")) .env( "RUSTDOC_REAL", - if cmd == "doc" || (cmd == "test" && want_rustdoc) { + if cmd == "doc" || cmd == "rustdoc" || (cmd == "test" && want_rustdoc) { self.rustdoc(compiler.host) } else { PathBuf::from("/path/to/nowhere/rustdoc/not/required") diff --git a/src/bootstrap/doc.rs b/src/bootstrap/doc.rs index 99185e4ca5b..89ef75de36a 100644 --- a/src/bootstrap/doc.rs +++ b/src/bootstrap/doc.rs @@ -405,6 +405,7 @@ fn run(self, builder: &Builder) { cmd.arg("--html-after-content").arg(&footer) .arg("--html-before-content").arg(&version_info) .arg("--html-in-header").arg(&favicon) + .arg("--markdown-no-toc") .arg("--index-page").arg(&builder.src.join("src/doc/index.md")) .arg("--markdown-playground-url") .arg("https://play.rust-lang.org/") @@ -412,8 +413,7 @@ fn run(self, builder: &Builder) { .arg(&path); if filename == "not_found.md" { - cmd.arg("--markdown-no-toc") - .arg("--markdown-css") + cmd.arg("--markdown-css") .arg("https://doc.rust-lang.org/rust.css"); } else { cmd.arg("--markdown-css").arg("rust.css"); @@ -481,6 +481,7 @@ fn run(self, builder: &Builder) { // will also directly handle merging. let my_out = builder.crate_doc_out(target); t!(symlink_dir_force(&builder.config, &my_out, &out_dir)); + t!(fs::copy(builder.src.join("src/doc/rust.css"), out.join("rust.css"))); let run_cargo_rustdoc_for = |package: &str| { let mut cargo = builder.cargo(compiler, Mode::Std, target, "rustdoc"); @@ -495,7 +496,9 @@ fn run(self, builder: &Builder) { // FIXME: Cargo should probably do this itself. t!(fs::create_dir_all(out_dir.join(package))); cargo.arg("--") - .arg("index-page").arg(&builder.src.join("src/doc/index.md")); + .arg("--markdown-css").arg("rust.css") + .arg("--markdown-no-toc") + .arg("--index-page").arg(&builder.src.join("src/doc/index.md")); builder.run(&mut cargo); builder.cp_r(&my_out, &out); diff --git a/src/librustdoc/html/render.rs b/src/librustdoc/html/render.rs index 6436189bbf1..cab88fead28 100644 --- a/src/librustdoc/html/render.rs +++ b/src/librustdoc/html/render.rs @@ -54,6 +54,9 @@ use externalfiles::ExternalHtml; +use errors; +use getopts; + use serialize::json::{ToJson, Json, as_json}; use syntax::ast; use syntax::ext::base::MacroKind; @@ -80,8 +83,6 @@ use minifier; -use pulldown_cmark; - /// A pair of name and its optional document. pub type NameDoc = (String, Option); @@ -508,6 +509,8 @@ pub fn run(mut krate: clean::Crate, id_map: IdMap, enable_index_page: bool, index_page: Option, + matches: &getopts::Matches, + diag: &errors::Handler, ) -> Result<(), Error> { let src_root = match krate.src { FileName::Real(ref p) => match p.parent() { @@ -675,7 +678,7 @@ pub fn run(mut krate: clean::Crate, CACHE_KEY.with(|v| *v.borrow_mut() = cache.clone()); CURRENT_LOCATION_KEY.with(|s| s.borrow_mut().clear()); - write_shared(&cx, &krate, &*cache, index, enable_minification)?; + write_shared(&cx, &krate, &*cache, index, enable_minification, matches, diag)?; // And finally render the whole crate's documentation cx.krate(krate) @@ -751,11 +754,15 @@ fn build_index(krate: &clean::Crate, cache: &mut Cache) -> String { Json::Object(crate_data)) } -fn write_shared(cx: &Context, - krate: &clean::Crate, - cache: &Cache, - search_index: String, - enable_minification: bool) -> Result<(), Error> { +fn write_shared( + cx: &Context, + krate: &clean::Crate, + cache: &Cache, + search_index: String, + enable_minification: bool, + matches: &getopts::Matches, + diag: &errors::Handler, +) -> Result<(), Error> { // Write out the shared files. Note that these are shared among all rustdoc // docs placed in the output directory, so this needs to be a synchronized // operation with respect to all other rustdocs running around. @@ -983,30 +990,15 @@ fn show_item(item: &IndexItem, krate: &str) -> String { } try_err!(writeln!(&mut w, "initSearch(searchIndex);"), &dst); -<<<<<<< HEAD - if cx.disable_index_page == false { - let dst = cx.dst.join("index.html"); -======= if cx.enable_index_page == true { ->>>>>>> a2642cf... f if let Some(ref index_page) = cx.index_page { - let mut content = Vec::with_capacity(100000); - - let mut f = try_err!(File::open(&index_page), &index_page); - try_err!(f.read_to_end(&mut content), &index_page); - let content = match String::from_utf8(content) { - Ok(c) => c, - Err(_) => return Err(Error::new( - io::Error::new( - io::ErrorKind::Other, "invalid markdown"), - &index_page)), - }; - let parser = pulldown_cmark::Parser::new(&content); - let mut html_buf = String::new(); - pulldown_cmark::html::push_html(&mut html_buf, parser); - let mut f = try_err!(File::create(&dst), &dst); - try_err!(f.write_all(html_buf.as_bytes()), &dst); + ::markdown::render(index_page, + cx.dst.clone(), + &matches, &(*cx.shared).layout.external_html, + !matches.opt_present("markdown-no-toc"), + diag); } else { + let dst = cx.dst.join("index.html"); let mut w = BufWriter::new(try_err!(File::create(&dst), &dst)); let page = layout::Page { title: "Index of crates", diff --git a/src/librustdoc/lib.rs b/src/librustdoc/lib.rs index cb9fb94db7c..a86f71ce319 100644 --- a/src/librustdoc/lib.rs +++ b/src/librustdoc/lib.rs @@ -462,7 +462,7 @@ fn main_args(args: &[String]) -> isize { diag.struct_err("too many file operands").emit(); return 1; } - let input = &matches.free[0]; + let input = matches.free[0].clone(); let mut libs = SearchPaths::new(); for s in &matches.opt_strs("L") { @@ -490,7 +490,7 @@ fn main_args(args: &[String]) -> isize { .collect(); let should_test = matches.opt_present("test"); - let markdown_input = Path::new(input).extension() + let markdown_input = Path::new(&input).extension() .map_or(false, |e| e == "md" || e == "markdown"); let output = matches.opt_str("o").map(|s| PathBuf::from(&s)); @@ -568,14 +568,14 @@ fn main_args(args: &[String]) -> isize { match (should_test, markdown_input) { (true, true) => { - return markdown::test(input, cfgs, libs, externs, test_args, maybe_sysroot, + return markdown::test(&input, cfgs, libs, externs, test_args, maybe_sysroot, display_warnings, linker, edition, cg, &diag) } (true, false) => { - return test::run(Path::new(input), cfgs, libs, externs, test_args, crate_name, + return test::run(Path::new(&input), cfgs, libs, externs, test_args, crate_name, maybe_sysroot, display_warnings, linker, edition, cg) } - (false, true) => return markdown::render(Path::new(input), + (false, true) => return markdown::render(Path::new(&input), output.unwrap_or(PathBuf::from("doc")), &matches, &external_html, !matches.opt_present("markdown-no-toc"), &diag), @@ -584,8 +584,8 @@ fn main_args(args: &[String]) -> isize { let output_format = matches.opt_str("w"); - let res = acquire_input(PathBuf::from(input), externs, edition, cg, &matches, error_format, - move |out| { + let res = acquire_input(PathBuf::from(input), externs, edition, cg, matches, error_format, + move |out, matches| { let Output { krate, passes, renderinfo } = out; let diag = core::new_handler(error_format, None, treat_err_as_bug, ui_testing); info!("going to format"); @@ -624,11 +624,11 @@ fn acquire_input(input: PathBuf, externs: Externs, edition: Edition, cg: CodegenOptions, - matches: &getopts::Matches, + matches: getopts::Matches, error_format: ErrorOutputType, f: F) -> Result -where R: 'static + Send, F: 'static + Send + FnOnce(Output) -> R { +where R: 'static + Send, F: 'static + Send + FnOnce(Output, &getopts::Matches) -> R { match matches.opt_str("r").as_ref().map(|s| &**s) { Some("rust") => Ok(rust_input(input, externs, edition, cg, matches, error_format, f)), Some(s) => Err(format!("unknown input format: {}", s)), @@ -682,11 +682,11 @@ fn rust_input(cratefile: PathBuf, externs: Externs, edition: Edition, cg: CodegenOptions, - matches: &getopts::Matches, + matches: getopts::Matches, error_format: ErrorOutputType, f: F) -> R where R: 'static + Send, - F: 'static + Send + FnOnce(Output) -> R + F: 'static + Send + FnOnce(Output, &getopts::Matches) -> R { let default_passes = if matches.opt_present("no-defaults") { passes::DefaultPassOption::None @@ -731,7 +731,7 @@ fn rust_input(cratefile: PathBuf, *x == "ui-testing" }); - let (lint_opts, describe_lints, lint_cap) = get_cmd_lint_options(matches, error_format); + let (lint_opts, describe_lints, lint_cap) = get_cmd_lint_options(&matches, error_format); let (tx, rx) = channel(); @@ -783,7 +783,8 @@ fn rust_input(cratefile: PathBuf, krate = pass(krate); } - tx.send(f(Output { krate: krate, renderinfo: renderinfo, passes: passes })).unwrap(); + tx.send(f(Output { krate: krate, renderinfo: renderinfo, passes: passes }, + &matches)).unwrap(); })); match result { diff --git a/src/librustdoc/markdown.rs b/src/librustdoc/markdown.rs index a3ae953e6ee..0084c0f8592 100644 --- a/src/librustdoc/markdown.rs +++ b/src/librustdoc/markdown.rs @@ -77,7 +77,7 @@ pub fn render(input: &Path, mut output: PathBuf, matches: &getopts::Matches, diag.struct_err(&format!("{}: {}", output.display(), e)).emit(); return 4; } - Ok(f) => f + Ok(f) => f, }; let (metadata, text) = extract_leading_metadata(&input_str); -- 2.44.0