src/librustdoc/markdown.rs

   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.
   4 //
   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.
  10
  11 use std::default::Default;
  12 use std::fs::File;
  13 use std::io::prelude::*;
  14 use std::io;
  15 use std::path::{PathBuf, Path};
  16
  17 use getopts;
  18 use testing;
  19 use rustc::session::search_paths::SearchPaths;
  20 use rustc::session::config::Externs;
  21 use syntax::codemap::DUMMY_SP;
  22
  23 use externalfiles::{ExternalHtml, LoadStringError, load_string};
  24
  25 use html::render::reset_ids;
  26 use html::escape::Escape;
  27 use html::markdown;
  28 use html::markdown::{Markdown, MarkdownWithToc, find_testable_code};
  29 use test::{TestOptions, Collector};
  30
  31 /// Separate any lines at the start of the file that begin with `%`.
  32 fn extract_leading_metadata<'a>(s: &'a str) -> (Vec<&'a str>, &'a str) {
  33     let mut metadata = Vec::new();
  34     let mut count = 0;
  35     for line in s.lines() {
  36         if line.starts_with("%") {
  37             // remove %<whitespace>
  38             metadata.push(line[1..].trim_left());
  39             count += line.len() + 1;
  40         } else {
  41             return (metadata, &s[count..]);
  42         }
  43     }
  44     // if we're here, then all lines were metadata % lines.
  45     (metadata, "")
  46 }
  47
  48 /// Render `input` (e.g. "foo.md") into an HTML file in `output`
  49 /// (e.g. output = "bar" => "bar/foo.html").
  50 pub fn render(input: &str, mut output: PathBuf, matches: &getopts::Matches,
  51               external_html: &ExternalHtml, include_toc: bool) -> isize {
  52     let input_p = Path::new(input);
  53     output.push(input_p.file_stem().unwrap());
  54     output.set_extension("html");
  55
  56     let mut css = String::new();
  57     for name in &matches.opt_strs("markdown-css") {
  58         let s = format!("<link rel=\"stylesheet\" type=\"text/css\" href=\"{}\">\n", name);
  59         css.push_str(&s)
  60     }
  61
  62     let input_str = match load_string(input) {
  63         Ok(s) => s,
  64         Err(LoadStringError::ReadFail) => return 1,
  65         Err(LoadStringError::BadUtf8) => return 2,
  66     };
  67     if let Some(playground) = matches.opt_str("markdown-playground-url").or(
  68                               matches.opt_str("playground-url")) {
  69         markdown::PLAYGROUND.with(|s| { *s.borrow_mut() = Some((None, playground)); });
  70     }
  71
  72     let mut out = match File::create(&output) {
  73         Err(e) => {
  74             let _ = writeln!(&mut io::stderr(),
  75                              "rustdoc: {}: {}",
  76                              output.display(), e);
  77             return 4;
  78         }
  79         Ok(f) => f
  80     };
  81
  82     let (metadata, text) = extract_leading_metadata(&input_str);
  83     if metadata.is_empty() {
  84         let _ = writeln!(
  85             &mut io::stderr(),
  86             "rustdoc: invalid markdown file: expecting initial line with `% ...TITLE...`"
  87         );
  88         return 5;
  89     }
  90     let title = metadata[0];
  91
  92     reset_ids(false);
  93
  94     let rendered = if include_toc {
  95         format!("{}", MarkdownWithToc(text))
  96     } else {
  97         format!("{}", Markdown(text))
  98     };
  99
 100     let err = write!(
 101         &mut out,
 102         r#"<!DOCTYPE html>
 103 <html lang="en">
 104 <head>
 105     <meta charset="utf-8">
 106     <meta name="viewport" content="width=device-width, initial-scale=1.0">
 107     <meta name="generator" content="rustdoc">
 108     <title>{title}</title>
 109
 110     {css}
 111     {in_header}
 112 </head>
 113 <body class="rustdoc">
 114     <!--[if lte IE 8]>
 115     <div class="warning">
 116         This old browser is unsupported and will most likely display funky
 117         things.
 118     </div>
 119     <![endif]-->
 120
 121     {before_content}
 122     <h1 class="title">{title}</h1>
 123     {text}
 124     {after_content}
 125 </body>
 126 </html>"#,
 127         title = Escape(title),
 128         css = css,
 129         in_header = external_html.in_header,
 130         before_content = external_html.before_content,
 131         text = rendered,
 132         after_content = external_html.after_content,
 133         );
 134
 135     match err {
 136         Err(e) => {
 137             let _ = writeln!(&mut io::stderr(),
 138                              "rustdoc: cannot write to `{}`: {}",
 139                              output.display(), e);
 140             6
 141         }
 142         Ok(_) => 0
 143     }
 144 }
 145
 146 /// Run any tests/code examples in the markdown file `input`.
 147 pub fn test(input: &str, cfgs: Vec<String>, libs: SearchPaths, externs: Externs,
 148             mut test_args: Vec<String>, maybe_sysroot: Option<PathBuf>) -> isize {
 149     let input_str = match load_string(input) {
 150         Ok(s) => s,
 151         Err(LoadStringError::ReadFail) => return 1,
 152         Err(LoadStringError::BadUtf8) => return 2,
 153     };
 154
 155     let mut opts = TestOptions::default();
 156     opts.no_crate_inject = true;
 157     let mut collector = Collector::new(input.to_string(), cfgs, libs, externs,
 158                                        true, opts, maybe_sysroot, None,
 159                                        Some(input.to_owned()));
 160     find_testable_code(&input_str, &mut collector, DUMMY_SP);
 161     test_args.insert(0, "rustdoctest".to_string());
 162     testing::test_main(&test_args, collector.tests);
 163     0
 164 }