rust/src/librustdoc/externalfiles.rs

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

use serde::Serialize;

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

impl ExternalHtml {
    crate fn load(
        in_header: &[String],
        before_content: &[String],
        after_content: &[String],
        md_before_content: &[String],
        md_after_content: &[String],
        nightly_build: bool,
        diag: &rustc_errors::Handler,
        id_map: &mut IdMap,
        edition: Edition,
        playground: &Option<Playground>,
    ) -> Option<ExternalHtml> {
        let codes = ErrorCodes::from(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 {
                content: &m_bc,
                links: &[],
                ids: id_map,
                error_codes: codes,
                edition,
                playground,
                heading_level: 1
            }
            .into_string()
        );
        let ac = load_external_files(after_content, diag)?;
        let m_ac = load_external_files(md_after_content, diag)?;
        let ac = format!(
            "{}{}",
            ac,
            Markdown {
                content: &m_ac,
                links: &[],
                ids: id_map,
                error_codes: codes,
                edition,
                playground,
                heading_level: 1
            }
            .into_string()
        );
        Some(ExternalHtml { in_header: ih, before_content: bc, after_content: ac })
    }
}

crate enum LoadStringError {
    ReadFail,
    BadUtf8,
}

crate fn load_string<P: AsRef<Path>>(
    file_path: P,
    diag: &rustc_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: &rustc_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)
}
Format the world 2019-12-22 17:42:04 -05:00			`use crate::html::markdown::{ErrorCodes, IdMap, Markdown, Playground};`
Normalize `syntax::edition` imports. 2020-01-01 19:40:49 +01:00			`use crate::rustc_span::edition::Edition;`
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;`
Transition librustdoc to 2018 edition 2019-02-23 16:40:07 +09:00
Use Tera templates for rustdoc. Replaces a format!() call in layout::render with a template expansion. Introduces a `templates` field in SharedContext so parts of rustdoc can share pre-rendered templates. This currently builds in a copy of the single template available, like with static files. However, future work can make this live-loadable with a perma-unstable flag, to make rustdoc developers' work easier. 2021-06-08 17:19:03 -07:00			`use serde::Serialize;`

			`#[derive(Clone, Debug, Serialize)]`
Make all rustdoc functions and structs crate-private This gives warnings about dead code. 2020-11-14 17:59:58 -05:00			`crate 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`
Make all rustdoc functions and structs crate-private This gives warnings about dead code. 2020-11-14 17:59:58 -05:00			`crate 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`
Make all rustdoc functions and structs crate-private This gives warnings about dead code. 2020-11-14 17:59:58 -05:00			`crate 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`
Make all rustdoc functions and structs crate-private This gives warnings about dead code. 2020-11-14 17:59:58 -05:00			`crate after_content: 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			`}`

			`impl ExternalHtml {`
Make all rustdoc functions and structs crate-private This gives warnings about dead code. 2020-11-14 17:59:58 -05:00			`crate fn load(`
Format the world 2019-12-22 17:42:04 -05:00			`in_header: &[String],`
			`before_content: &[String],`
			`after_content: &[String],`
			`md_before_content: &[String],`
			`md_after_content: &[String],`
Allow making `RUSTC_BOOTSTRAP` conditional on the crate name The main change is that `UnstableOptions::from_environment` now requires an (optional) crate name. If the crate name is unknown (`None`), then the new feature is not available and you still have to use `RUSTC_BOOTSTRAP=1`. In practice this means the feature is only available for `--crate-name`, not for `#![crate_name]`; I'm interested in supporting the second but I'm not sure how. Other major changes: - Added `Session::is_nightly_build()`, which uses the `crate_name` of the session - Added `nightly_options::match_is_nightly_build`, a convenience method for looking up `--crate-name` from CLI arguments. `Session::is_nightly_build()`should be preferred where possible, since it will take into account `#![crate_name]` (I think). - Added `unstable_features` to `rustdoc::RenderOptions` There is a user-facing change here: things like `RUSTC_BOOTSTRAP=0` no longer active nightly features. In practice this shouldn't be a big deal, since `RUSTC_BOOTSTRAP` is the opposite of stable and everyone uses `RUSTC_BOOTSTRAP=1` anyway. - Add tests Check against `Cheat`, not whether nightly features are allowed. Nightly features are always allowed on the nightly channel. - Only call `is_nightly_build()` once within a function - Use booleans consistently for rustc_incremental Sessions can't be passed through threads, so `read_file` couldn't take a session. To be consistent, also take a boolean in `write_file_header`. 2020-10-10 14:27:52 -04:00			`nightly_build: bool,`
nix syntax::errors & prefer rustc_errors over errors 2020-01-09 11:18:47 +01:00			`diag: &rustc_errors::Handler,`
Format the world 2019-12-22 17:42:04 -05:00			`id_map: &mut IdMap,`
			`edition: Edition,`
			`playground: &Option<Playground>,`
			`) -> Option<ExternalHtml> {`
Allow making `RUSTC_BOOTSTRAP` conditional on the crate name The main change is that `UnstableOptions::from_environment` now requires an (optional) crate name. If the crate name is unknown (`None`), then the new feature is not available and you still have to use `RUSTC_BOOTSTRAP=1`. In practice this means the feature is only available for `--crate-name`, not for `#![crate_name]`; I'm interested in supporting the second but I'm not sure how. Other major changes: - Added `Session::is_nightly_build()`, which uses the `crate_name` of the session - Added `nightly_options::match_is_nightly_build`, a convenience method for looking up `--crate-name` from CLI arguments. `Session::is_nightly_build()`should be preferred where possible, since it will take into account `#![crate_name]` (I think). - Added `unstable_features` to `rustdoc::RenderOptions` There is a user-facing change here: things like `RUSTC_BOOTSTRAP=0` no longer active nightly features. In practice this shouldn't be a big deal, since `RUSTC_BOOTSTRAP` is the opposite of stable and everyone uses `RUSTC_BOOTSTRAP=1` anyway. - Add tests Check against `Cheat`, not whether nightly features are allowed. Nightly features are always allowed on the nightly channel. - Only call `is_nightly_build()` once within a function - Use booleans consistently for rustc_incremental Sessions can't be passed through threads, so `read_file` couldn't take a session. To be consistent, also take a boolean in `write_file_header`. 2020-10-10 14:27:52 -04:00			`let codes = ErrorCodes::from(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)?;`
Format the world 2019-12-22 17:42:04 -05:00			`let bc = format!(`
			`"{}{}",`
			`bc,`
Change `Markdown(...)` to `Markdown { ... }` 2021-10-04 21:08:58 -04:00			`Markdown {`
			`content: &m_bc,`
			`links: &[],`
			`ids: id_map,`
			`error_codes: codes,`
			`edition,`
			`playground,`
No need to default offset since we always override it. 2021-10-04 21:28:26 -04:00			`heading_level: 1`
Change `Markdown(...)` to `Markdown { ... }` 2021-10-04 21:08:58 -04:00			`}`
			`.into_string()`
Format the world 2019-12-22 17:42:04 -05:00			`);`
Reduce nesting in externalfiles implementation Utilize `?` instead of and_then/map operators 2019-08-10 18:39:50 -04:00			`let ac = load_external_files(after_content, diag)?;`
			`let m_ac = load_external_files(md_after_content, diag)?;`
Format the world 2019-12-22 17:42:04 -05:00			`let ac = format!(`
			`"{}{}",`
			`ac,`
Change `Markdown(...)` to `Markdown { ... }` 2021-10-04 21:08:58 -04:00			`Markdown {`
			`content: &m_ac,`
			`links: &[],`
			`ids: id_map,`
			`error_codes: codes,`
			`edition,`
			`playground,`
No need to default offset since we always override it. 2021-10-04 21:28:26 -04:00			`heading_level: 1`
Change `Markdown(...)` to `Markdown { ... }` 2021-10-04 21:08:58 -04:00			`}`
			`.into_string()`
Format the world 2019-12-22 17:42:04 -05:00			`);`
			`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			`}`
			`}`

Make all rustdoc functions and structs crate-private This gives warnings about dead code. 2020-11-14 17:59:58 -05:00			`crate enum LoadStringError {`
Refactor away `load_or_return` macro. 2016-10-08 22:55:40 -04:00			`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			`}`

Make all rustdoc functions and structs crate-private This gives warnings about dead code. 2020-11-14 17:59:58 -05:00			`crate fn load_string<P: AsRef<Path>>(`
Format the world 2019-12-22 17:42:04 -05:00			`file_path: P,`
nix syntax::errors & prefer rustc_errors over errors 2020-01-09 11:18:47 +01:00			`diag: &rustc_errors::Handler,`
Format the world 2019-12-22 17:42:04 -05:00			`) -> 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			`}`
			`}`
			`}`

nix syntax::errors & prefer rustc_errors over errors 2020-01-09 11:18:47 +01:00			`fn load_external_files(names: &[String], diag: &rustc_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)`
			`}`