1 // Copyright 2014 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 use std::default::Default;
13 use std::io::prelude::*;
15 use std::path::{PathBuf, Path};
19 use rustc::session::search_paths::SearchPaths;
20 use rustc::session::config::Externs;
22 use externalfiles::{ExternalHtml, LoadStringError, load_string};
24 use html::render::reset_ids;
25 use html::escape::Escape;
27 use html::markdown::{Markdown, MarkdownWithToc, find_testable_code};
28 use test::{TestOptions, Collector};
30 /// Separate any lines at the start of the file that begin with `%`.
31 fn extract_leading_metadata<'a>(s: &'a str) -> (Vec<&'a str>, &'a str) {
32 let mut metadata = Vec::new();
34 for line in s.lines() {
35 if line.starts_with("%") {
36 // remove %<whitespace>
37 metadata.push(line[1..].trim_left());
38 count += line.len() + 1;
40 return (metadata, &s[count..]);
43 // if we're here, then all lines were metadata % lines.
47 /// Render `input` (e.g. "foo.md") into an HTML file in `output`
48 /// (e.g. output = "bar" => "bar/foo.html").
49 pub fn render(input: &str, mut output: PathBuf, matches: &getopts::Matches,
50 external_html: &ExternalHtml, include_toc: bool) -> isize {
51 let input_p = Path::new(input);
52 output.push(input_p.file_stem().unwrap());
53 output.set_extension("html");
55 let mut css = String::new();
56 for name in &matches.opt_strs("markdown-css") {
57 let s = format!("<link rel=\"stylesheet\" type=\"text/css\" href=\"{}\">\n", name);
61 let input_str = match load_string(input) {
63 Err(LoadStringError::ReadFail) => return 1,
64 Err(LoadStringError::BadUtf8) => return 2,
66 if let Some(playground) = matches.opt_str("markdown-playground-url").or(
67 matches.opt_str("playground-url")) {
68 markdown::PLAYGROUND.with(|s| { *s.borrow_mut() = Some((None, playground)); });
71 let mut out = match File::create(&output) {
73 let _ = writeln!(&mut io::stderr(),
81 let (metadata, text) = extract_leading_metadata(&input_str);
82 if metadata.is_empty() {
85 "rustdoc: invalid markdown file: expecting initial line with `% ...TITLE...`"
89 let title = metadata[0];
93 let rendered = if include_toc {
94 format!("{}", MarkdownWithToc(text))
96 format!("{}", Markdown(text))
104 <meta charset="utf-8">
105 <meta name="viewport" content="width=device-width, initial-scale=1.0">
106 <meta name="generator" content="rustdoc">
107 <title>{title}</title>
112 <body class="rustdoc">
114 <div class="warning">
115 This old browser is unsupported and will most likely display funky
121 <h1 class="title">{title}</h1>
126 title = Escape(title),
128 in_header = external_html.in_header,
129 before_content = external_html.before_content,
131 after_content = external_html.after_content,
136 let _ = writeln!(&mut io::stderr(),
137 "rustdoc: cannot write to `{}`: {}",
138 output.display(), e);
145 /// Run any tests/code examples in the markdown file `input`.
146 pub fn test(input: &str, cfgs: Vec<String>, libs: SearchPaths, externs: Externs,
147 mut test_args: Vec<String>, maybe_sysroot: Option<PathBuf>) -> isize {
148 let input_str = match load_string(input) {
150 Err(LoadStringError::ReadFail) => return 1,
151 Err(LoadStringError::BadUtf8) => return 2,
154 let mut opts = TestOptions::default();
155 opts.no_crate_inject = true;
156 let mut collector = Collector::new(input.to_string(), cfgs, libs, externs,
157 true, opts, maybe_sysroot, "input".to_string(),
159 find_testable_code(&input_str, &mut collector, 0);
160 test_args.insert(0, "rustdoctest".to_string());
161 testing::test_main(&test_args, collector.tests);