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}
;
20 use rustc
::session
::search_paths
::SearchPaths
;
22 use externalfiles
::ExternalHtml
;
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
= load_or_return
!(input
, 1, 2);
62 let playground
= matches
.opt_str("markdown-playground-url");
63 if playground
.is_some() {
64 markdown
::PLAYGROUND_KRATE
.with(|s
| { *s.borrow_mut() = Some(None); }
);
66 let playground
= playground
.unwrap_or("".to_string());
68 let mut out
= match File
::create(&output
) {
70 let _
= writeln
!(&mut io
::stderr(),
71 "error opening `{}` for writing: {}",
78 let (metadata
, text
) = extract_leading_metadata(&input_str
);
79 if metadata
.is_empty() {
80 let _
= writeln
!(&mut io
::stderr(),
81 "invalid markdown file: expecting initial line with `% ...TITLE...`");
84 let title
= metadata
[0];
88 let rendered
= if include_toc
{
89 format
!("{}", MarkdownWithToc(text
))
91 format
!("{}", Markdown(text
))
99 <meta charset="utf-8">
100 <meta name="viewport" content="width=device-width, initial-scale=1.0">
101 <meta name="generator" content="rustdoc">
102 <title>{title}</title>
107 <body class="rustdoc">
109 <div class="warning">
110 This old browser is unsupported and will most likely display funky
116 <h1 class="title">{title}</h1>
118 <script type="text/javascript">
119 window.playgroundUrl = "{playground}";
124 title
= Escape(title
),
126 in_header
= external_html
.in_header
,
127 before_content
= external_html
.before_content
,
129 after_content
= external_html
.after_content
,
130 playground
= playground
,
135 let _
= writeln
!(&mut io
::stderr(),
136 "error writing to `{}`: {}",
137 output
.display(), e
);
144 /// Run any tests/code examples in the markdown file `input`.
145 pub fn test(input
: &str, cfgs
: Vec
<String
>, libs
: SearchPaths
, externs
: core
::Externs
,
146 mut test_args
: Vec
<String
>) -> isize {
147 let input_str
= load_or_return
!(input
, 1, 2);
149 let mut opts
= TestOptions
::default();
150 opts
.no_crate_inject
= true;
151 let mut collector
= Collector
::new(input
.to_string(), cfgs
, libs
, externs
,
153 find_testable_code(&input_str
, &mut collector
);
154 test_args
.insert(0, "rustdoctest".to_string());
155 testing
::test_main(&test_args
, collector
.tests
);