2014-06-28 03:35:25 -07:00
|
|
|
// Copyright 2014 The Rust Project Developers. See the COPYRIGHT
|
|
|
|
|
// file at the top-level directory of this distribution and at
|
|
|
|
|
// http://rust-lang.org/COPYRIGHT.
|
|
|
|
|
//
|
|
|
|
|
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
|
|
|
|
|
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
|
|
|
|
|
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
|
|
|
|
|
// option. This file may not be copied, modified, or distributed
|
|
|
|
|
// except according to those terms.
|
|
|
|
|
|
2015-02-26 21:00:43 -08:00
|
|
|
use std::fs::File;
|
|
|
|
|
use std::io::prelude::*;
|
2016-10-08 16:29:10 -04:00
|
|
|
use std::path::Path;
|
2015-02-26 21:00:43 -08:00
|
|
|
use std::str;
|
2017-05-08 14:25:01 +02:00
|
|
|
use html::markdown::{Markdown, RenderType};
|
2014-06-28 03:35:25 -07:00
|
|
|
|
2015-01-03 22:54:18 -05:00
|
|
|
#[derive(Clone)]
|
2014-06-28 03:35:25 -07:00
|
|
|
pub struct ExternalHtml{
|
2016-10-08 17:34:13 -04:00
|
|
|
/// Content that will be included inline in the <head> section of a
|
|
|
|
|
/// rendered Markdown file or generated documentation
|
2014-06-28 03:35:25 -07:00
|
|
|
pub in_header: String,
|
2016-10-08 17:34:13 -04:00
|
|
|
/// Content that will be included inline between <body> and the content of
|
|
|
|
|
/// a rendered Markdown file or generated documentation
|
2014-06-28 03:35:25 -07:00
|
|
|
pub before_content: String,
|
2016-10-08 17:34:13 -04:00
|
|
|
/// Content that will be included inline between the content and </body> of
|
|
|
|
|
/// a rendered Markdown file or generated documentation
|
2014-06-28 03:35:25 -07:00
|
|
|
pub after_content: String
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
impl ExternalHtml {
|
2017-05-08 14:25:01 +02:00
|
|
|
pub fn load(in_header: &[String], before_content: &[String], after_content: &[String],
|
|
|
|
|
md_before_content: &[String], md_after_content: &[String], render: RenderType)
|
2014-06-28 03:35:25 -07:00
|
|
|
-> Option<ExternalHtml> {
|
2016-10-08 23:53:57 -04:00
|
|
|
load_external_files(in_header)
|
|
|
|
|
.and_then(|ih|
|
|
|
|
|
load_external_files(before_content)
|
|
|
|
|
.map(|bc| (ih, bc))
|
|
|
|
|
)
|
2017-05-08 14:25:01 +02:00
|
|
|
.and_then(|(ih, bc)|
|
|
|
|
|
load_external_files(md_before_content)
|
|
|
|
|
.map(|m_bc| (ih, format!("{}{}", bc, Markdown(&m_bc, render))))
|
|
|
|
|
)
|
2016-10-08 23:53:57 -04:00
|
|
|
.and_then(|(ih, bc)|
|
|
|
|
|
load_external_files(after_content)
|
|
|
|
|
.map(|ac| (ih, bc, ac))
|
|
|
|
|
)
|
2017-05-08 14:25:01 +02:00
|
|
|
.and_then(|(ih, bc, ac)|
|
|
|
|
|
load_external_files(md_after_content)
|
|
|
|
|
.map(|m_ac| (ih, bc, format!("{}{}", ac, Markdown(&m_ac, render))))
|
|
|
|
|
)
|
2016-10-08 23:53:57 -04:00
|
|
|
.map(|(ih, bc, ac)|
|
|
|
|
|
ExternalHtml {
|
|
|
|
|
in_header: ih,
|
|
|
|
|
before_content: bc,
|
|
|
|
|
after_content: ac,
|
|
|
|
|
}
|
|
|
|
|
)
|
2014-06-28 03:35:25 -07:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2016-10-08 22:55:40 -04:00
|
|
|
pub enum LoadStringError {
|
|
|
|
|
ReadFail,
|
|
|
|
|
BadUtf8,
|
2014-06-28 03:35:25 -07:00
|
|
|
}
|
|
|
|
|
|
2016-10-08 22:55:40 -04:00
|
|
|
pub fn load_string<P: AsRef<Path>>(file_path: P) -> Result<String, LoadStringError> {
|
|
|
|
|
let file_path = file_path.as_ref();
|
|
|
|
|
let mut contents = vec![];
|
|
|
|
|
let result = File::open(file_path)
|
|
|
|
|
.and_then(|mut f| f.read_to_end(&mut contents));
|
|
|
|
|
if let Err(e) = result {
|
2017-09-25 00:14:56 -04:00
|
|
|
eprintln!("error reading `{}`: {}", file_path.display(), e);
|
2016-10-08 22:55:40 -04:00
|
|
|
return Err(LoadStringError::ReadFail);
|
|
|
|
|
}
|
|
|
|
|
match str::from_utf8(&contents) {
|
|
|
|
|
Ok(s) => Ok(s.to_string()),
|
|
|
|
|
Err(_) => {
|
2017-09-25 00:14:56 -04:00
|
|
|
eprintln!("error reading `{}`: not UTF-8", file_path.display());
|
2016-10-08 22:55:40 -04:00
|
|
|
Err(LoadStringError::BadUtf8)
|
2014-06-28 03:35:25 -07:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2016-10-09 00:15:42 -04:00
|
|
|
fn load_external_files(names: &[String]) -> Option<String> {
|
2014-06-28 03:35:25 -07:00
|
|
|
let mut out = String::new();
|
2015-01-31 12:20:46 -05:00
|
|
|
for name in names {
|
2016-10-08 22:55:40 -04:00
|
|
|
let s = match load_string(name) {
|
|
|
|
|
Ok(s) => s,
|
|
|
|
|
Err(_) => return None,
|
|
|
|
|
};
|
|
|
|
|
out.push_str(&s);
|
2014-09-22 08:28:35 -07:00
|
|
|
out.push('\n');
|
2014-06-28 03:35:25 -07:00
|
|
|
}
|
|
|
|
|
Some(out)
|
|
|
|
|
}
|
