2 use std::io::prelude::*;
3 use std::path::PathBuf;
5 use rustc_feature::UnstableFeatures;
6 use rustc_span::edition::Edition;
7 use rustc_span::source_map::DUMMY_SP;
9 use crate::config::{Options, RenderOptions};
10 use crate::externalfiles::{load_string, LoadStringError};
11 use crate::html::escape::Escape;
12 use crate::html::markdown;
13 use crate::html::markdown::{find_testable_code, ErrorCodes, IdMap, Markdown, MarkdownWithToc};
14 use crate::test::{Collector, TestOptions};
16 /// Separate any lines at the start of the file that begin with `# ` or `%`.
17 fn extract_leading_metadata(s: &str) -> (Vec<&str>, &str) {
18 let mut metadata = Vec::new();
21 for line in s.lines() {
22 if line.starts_with("# ") || line.starts_with("%") {
23 // trim the whitespace after the symbol
24 metadata.push(line[1..].trim_start());
25 count += line.len() + 1;
27 return (metadata, &s[count..]);
31 // if we're here, then all lines were metadata `# ` or `%` lines.
35 /// Render `input` (e.g., "foo.md") into an HTML file in `output`
36 /// (e.g., output = "bar" => "bar/foo.html").
39 options: RenderOptions,
40 diag: &rustc_errors::Handler,
43 let mut output = options.output;
44 output.push(input.file_name().unwrap());
45 output.set_extension("html");
47 let mut css = String::new();
48 for name in &options.markdown_css {
49 let s = format!("<link rel=\"stylesheet\" type=\"text/css\" href=\"{}\">\n", name);
53 let input_str = match load_string(&input, diag) {
55 Err(LoadStringError::ReadFail) => return 1,
56 Err(LoadStringError::BadUtf8) => return 2,
58 let playground_url = options.markdown_playground_url.or(options.playground_url);
59 let playground = playground_url.map(|url| markdown::Playground { crate_name: None, url });
61 let mut out = match File::create(&output) {
63 diag.struct_err(&format!("{}: {}", output.display(), e)).emit();
69 let (metadata, text) = extract_leading_metadata(&input_str);
70 if metadata.is_empty() {
71 diag.struct_err("invalid markdown file: no initial lines starting with `# ` or `%`").emit();
74 let title = metadata[0];
76 let mut ids = IdMap::new();
77 let error_codes = ErrorCodes::from(UnstableFeatures::from_environment().is_nightly_build());
78 let text = if !options.markdown_no_toc {
79 MarkdownWithToc(text, &mut ids, error_codes, edition, &playground).to_string()
81 Markdown(text, &[], &mut ids, error_codes, edition, &playground).to_string()
89 <meta charset="utf-8">
90 <meta name="viewport" content="width=device-width, initial-scale=1.0">
91 <meta name="generator" content="rustdoc">
92 <title>{title}</title>
97 <body class="rustdoc">
100 This old browser is unsupported and will most likely display funky
106 <h1 class="title">{title}</h1>
111 title = Escape(title),
113 in_header = options.external_html.in_header,
114 before_content = options.external_html.before_content,
116 after_content = options.external_html.after_content,
121 diag.struct_err(&format!("cannot write to `{}`: {}", output.display(), e)).emit();
128 /// Runs any tests/code examples in the markdown file `input`.
129 pub fn test(mut options: Options, diag: &rustc_errors::Handler) -> i32 {
130 let input_str = match load_string(&options.input, diag) {
132 Err(LoadStringError::ReadFail) => return 1,
133 Err(LoadStringError::BadUtf8) => return 2,
136 let mut opts = TestOptions::default();
137 opts.no_crate_inject = true;
138 opts.display_warnings = options.display_warnings;
139 let mut collector = Collector::new(
140 options.input.display().to_string(),
146 options.enable_per_target_ignores,
148 collector.set_position(DUMMY_SP);
149 let codes = ErrorCodes::from(UnstableFeatures::from_environment().is_nightly_build());
151 find_testable_code(&input_str, &mut collector, codes, options.enable_per_target_ignores);
153 options.test_args.insert(0, "rustdoctest".to_string());
157 Some(testing::Options::new().display_output(options.display_warnings)),