rust/src/librustdoc/externalfiles.rs

use std::fs;
use std::path::Path;
use std::str;
use errors;
use rustc_feature::UnstableFeatures;
use crate::syntax::edition::Edition;
use crate::html::markdown::{IdMap, ErrorCodes, Markdown, Playground};

#[derive(Clone, Debug)]
pub struct ExternalHtml {
    /// Content that will be included inline in the <head> section of a
    /// rendered Markdown file or generated documentation
    pub in_header: String,
    /// Content that will be included inline between <body> and the content of
    /// a rendered Markdown file or generated documentation
    pub before_content: String,
    /// Content that will be included inline between the content and </body> of
    /// a rendered Markdown file or generated documentation
    pub after_content: String
}

impl ExternalHtml {
    pub fn load(in_header: &[String], before_content: &[String], after_content: &[String],
                md_before_content: &[String], md_after_content: &[String], diag: &errors::Handler,
                id_map: &mut IdMap, edition: Edition, playground: &Option<Playground>)
            -> Option<ExternalHtml> {
        let codes = ErrorCodes::from(UnstableFeatures::from_environment().is_nightly_build());
        let ih = load_external_files(in_header, diag)?;
        let bc = load_external_files(before_content, diag)?;
        let m_bc = load_external_files(md_before_content, diag)?;
        let bc = format!("{}{}", bc, Markdown(&m_bc, &[], id_map,
                                    codes, edition, playground).to_string());
        let ac = load_external_files(after_content, diag)?;
        let m_ac = load_external_files(md_after_content, diag)?;
        let ac = format!("{}{}", ac, Markdown(&m_ac, &[], id_map,
                                    codes, edition, playground).to_string());
        Some(ExternalHtml {
            in_header: ih,
            before_content: bc,
            after_content: ac,
        })
    }
}

pub enum LoadStringError {
    ReadFail,
    BadUtf8,
}

pub fn load_string<P: AsRef<Path>>(file_path: P, diag: &errors::Handler)
    -> Result<String, LoadStringError>
{
    let file_path = file_path.as_ref();
    let contents = match fs::read(file_path) {
        Ok(bytes) => bytes,
        Err(e) => {
            diag.struct_err(&format!("error reading `{}`: {}", file_path.display(), e)).emit();
            return Err(LoadStringError::ReadFail);
        }
    };
    match str::from_utf8(&contents) {
        Ok(s) => Ok(s.to_string()),
        Err(_) => {
            diag.struct_err(&format!("error reading `{}`: not UTF-8", file_path.display())).emit();
            Err(LoadStringError::BadUtf8)
        }
    }
}

fn load_external_files(names: &[String], diag: &errors::Handler) -> Option<String> {
    let mut out = String::new();
    for name in names {
        let s = match load_string(name, diag) {
            Ok(s) => s,
            Err(_) => return None,
        };
        out.push_str(&s);
        out.push('\n');
    }
    Some(out)
}
Use the new fs_read_write functions in rustc internals 2018-01-10 08:58:39 -08:00			`use std::fs;`
Don't construct `PathBuf` ownership if we don't need it. 2016-10-08 16:29:10 -04:00			`use std::path::Path;`
std: Deprecate std::old_io::fs This commit deprecates the majority of std::old_io::fs in favor of std::fs and its new functionality. Some functions remain non-deprecated but are now behind a feature gate called `old_fs`. These functions will be deprecated once suitable replacements have been implemented. The compiler has been migrated to new `std::fs` and `std::path` APIs where appropriate as part of this change. 2015-02-26 21:00:43 -08:00			`use std::str;`
replace error/warning println with structured diag 2018-05-08 13:42:53 -05:00			`use errors;`
move UnstableFeatures -> rustc_feature 2019-11-30 02:50:47 +01:00			`use rustc_feature::UnstableFeatures;`
set the default edition when pre-parsing a doctest 2019-04-17 20:17:12 -05:00			`use crate::syntax::edition::Edition;`
Remove thread-local for playground config 2019-08-10 18:07:07 -04:00			`use crate::html::markdown::{IdMap, ErrorCodes, Markdown, Playground};`
Transition librustdoc to 2018 edition 2019-02-23 16:40:07 +09:00
add Debug impls for the Options structs 2018-11-04 16:39:24 -06:00			`#[derive(Clone, Debug)]`
Add themes option 2018-01-20 22:16:46 +01:00			`pub struct ExternalHtml {`
Add doc comments describing fields on `externalfiles::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`
Allow external html in rustdoc for crates. Updated documentation to reflect md->html. Modularized external file loading. 2014-06-28 03:35:25 -07:00			`pub in_header: String,`
Add doc comments describing fields on `externalfiles::ExternalHtml`. 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`
Allow external html in rustdoc for crates. Updated documentation to reflect md->html. Modularized external file loading. 2014-06-28 03:35:25 -07:00			`pub before_content: String,`
Add doc comments describing fields on `externalfiles::ExternalHtml`. 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`
Allow external html in rustdoc for crates. Updated documentation to reflect md->html. Modularized external file loading. 2014-06-28 03:35:25 -07:00			`pub after_content: String`
			`}`

			`impl ExternalHtml {`
Add markdown-[before\|after]-content options 2017-05-08 14:25:01 +02:00			`pub fn load(in_header: &[String], before_content: &[String], after_content: &[String],`
Remove global derive_id and reset_ids functions Previously these functions relied on TLS but we can instead thread the relevant state through explicitly. 2018-07-22 07:25:00 -06:00			`md_before_content: &[String], md_after_content: &[String], diag: &errors::Handler,`
Remove thread-local for playground config 2019-08-10 18:07:07 -04:00			`id_map: &mut IdMap, edition: Edition, playground: &Option<Playground>)`
Allow external html in rustdoc for crates. Updated documentation to reflect md->html. Modularized external file loading. 2014-06-28 03:35:25 -07:00			`-> Option<ExternalHtml> {`
Further extract error code switch Removes dependency on UnstableFeatures from markdown rendering 2018-07-22 11:10:19 -06:00			`let codes = ErrorCodes::from(UnstableFeatures::from_environment().is_nightly_build());`
Reduce nesting in externalfiles implementation Utilize `?` instead of and_then/map operators 2019-08-10 18:39:50 -04:00			`let ih = load_external_files(in_header, diag)?;`
			`let bc = load_external_files(before_content, diag)?;`
			`let m_bc = load_external_files(md_before_content, diag)?;`
			`let bc = format!("{}{}", bc, Markdown(&m_bc, &[], id_map,`
			`codes, edition, playground).to_string());`
			`let ac = load_external_files(after_content, diag)?;`
			`let m_ac = load_external_files(md_after_content, diag)?;`
			`let ac = format!("{}{}", ac, Markdown(&m_ac, &[], id_map,`
			`codes, edition, playground).to_string());`
			`Some(ExternalHtml {`
			`in_header: ih,`
			`before_content: bc,`
			`after_content: ac,`
			`})`
Allow external html in rustdoc for crates. Updated documentation to reflect md->html. Modularized external file loading. 2014-06-28 03:35:25 -07:00			`}`
			`}`

Refactor away `load_or_return` macro. 2016-10-08 22:55:40 -04:00			`pub enum LoadStringError {`
			`ReadFail,`
			`BadUtf8,`
Allow external html in rustdoc for crates. Updated documentation to reflect md->html. Modularized external file loading. 2014-06-28 03:35:25 -07:00			`}`

replace error/warning println with structured diag 2018-05-08 13:42:53 -05:00			`pub fn load_string<P: AsRef<Path>>(file_path: P, diag: &errors::Handler)`
			`-> Result<String, LoadStringError>`
			`{`
Refactor away `load_or_return` macro. 2016-10-08 22:55:40 -04:00			`let file_path = file_path.as_ref();`
Use the new fs_read_write functions in rustc internals 2018-01-10 08:58:39 -08:00			`let contents = match fs::read(file_path) {`
			`Ok(bytes) => bytes,`
			`Err(e) => {`
replace error/warning println with structured diag 2018-05-08 13:42:53 -05:00			diag.struct_err(&format!("error reading `{}`: {}", file_path.display(), e)).emit();
Use the new fs_read_write functions in rustc internals 2018-01-10 08:58:39 -08:00			`return Err(LoadStringError::ReadFail);`
			`}`
			`};`
Refactor away `load_or_return` macro. 2016-10-08 22:55:40 -04:00			`match str::from_utf8(&contents) {`
			`Ok(s) => Ok(s.to_string()),`
			`Err(_) => {`
replace error/warning println with structured diag 2018-05-08 13:42:53 -05:00			diag.struct_err(&format!("error reading `{}`: not UTF-8", file_path.display())).emit();
Refactor away `load_or_return` macro. 2016-10-08 22:55:40 -04:00			`Err(LoadStringError::BadUtf8)`
Allow external html in rustdoc for crates. Updated documentation to reflect md->html. Modularized external file loading. 2014-06-28 03:35:25 -07:00			`}`
			`}`
			`}`

replace error/warning println with structured diag 2018-05-08 13:42:53 -05:00			`fn load_external_files(names: &[String], diag: &errors::Handler) -> Option<String> {`
Allow external html in rustdoc for crates. Updated documentation to reflect md->html. Modularized external file loading. 2014-06-28 03:35:25 -07:00			`let mut out = String::new();`
`for x in xs.iter()` -> `for x in &xs` 2015-01-31 12:20:46 -05:00			`for name in names {`
replace error/warning println with structured diag 2018-05-08 13:42:53 -05:00			`let s = match load_string(name, diag) {`
Refactor away `load_or_return` macro. 2016-10-08 22:55:40 -04:00			`Ok(s) => s,`
			`Err(_) => return None,`
			`};`
			`out.push_str(&s);`
Deal with the fallout of string stabilization 2014-09-22 08:28:35 -07:00			`out.push('\n');`
Allow external html in rustdoc for crates. Updated documentation to reflect md->html. Modularized external file loading. 2014-06-28 03:35:25 -07:00			`}`
			`Some(out)`
			`}`