diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-17 12:02:58 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-17 12:02:58 +0000 |
| commit | 698f8c2f01ea549d77d7dc3338a12e04c11057b9 (patch) | |
| tree | 173a775858bd501c378080a10dca74132f05bc50 /src/librustdoc/externalfiles.rs | |
| parent | Initial commit. (diff) | |
| download | rustc-698f8c2f01ea549d77d7dc3338a12e04c11057b9.tar.xz rustc-698f8c2f01ea549d77d7dc3338a12e04c11057b9.zip | |
Adding upstream version 1.64.0+dfsg1.upstream/1.64.0+dfsg1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/librustdoc/externalfiles.rs')
| -rw-r--r-- | src/librustdoc/externalfiles.rs | 107 |
1 files changed, 107 insertions, 0 deletions
diff --git a/src/librustdoc/externalfiles.rs b/src/librustdoc/externalfiles.rs new file mode 100644 index 000000000..37fd909c9 --- /dev/null +++ b/src/librustdoc/externalfiles.rs @@ -0,0 +1,107 @@ +use crate::html::markdown::{ErrorCodes, HeadingOffset, 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)] +pub(crate) struct ExternalHtml { + /// Content that will be included inline in the `<head>` section of a + /// rendered Markdown file or generated documentation + pub(crate) in_header: String, + /// Content that will be included inline between `<body>` and the content of + /// a rendered Markdown file or generated documentation + pub(crate) before_content: String, + /// Content that will be included inline between the content and `</body>` of + /// a rendered Markdown file or generated documentation + pub(crate) after_content: String, +} + +impl ExternalHtml { + pub(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_offset: HeadingOffset::H2, + } + .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_offset: HeadingOffset::H2, + } + .into_string() + ); + Some(ExternalHtml { in_header: ih, before_content: bc, after_content: ac }) + } +} + +pub(crate) enum LoadStringError { + ReadFail, + BadUtf8, +} + +pub(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 Ok(s) = load_string(name, diag) else { return None }; + out.push_str(&s); + out.push('\n'); + } + Some(out) +} |