src/librustdoc/externalfiles.rs

   1 use std::fs;
   2 use std::path::Path;
   3 use std::str;
   4 use errors;
   5 use rustc_feature::UnstableFeatures;
   6 use crate::syntax::edition::Edition;
   7 use crate::html::markdown::{IdMap, ErrorCodes, Markdown, Playground};
   8
   9 #[derive(Clone, Debug)]
  10 pub struct ExternalHtml {
  11     /// Content that will be included inline in the <head> section of a
  12     /// rendered Markdown file or generated documentation
  13     pub in_header: String,
  14     /// Content that will be included inline between <body> and the content of
  15     /// a rendered Markdown file or generated documentation
  16     pub before_content: String,
  17     /// Content that will be included inline between the content and </body> of
  18     /// a rendered Markdown file or generated documentation
  19     pub after_content: String
  20 }
  21
  22 impl ExternalHtml {
  23     pub fn load(in_header: &[String], before_content: &[String], after_content: &[String],
  24                 md_before_content: &[String], md_after_content: &[String], diag: &errors::Handler,
  25                 id_map: &mut IdMap, edition: Edition, playground: &Option<Playground>)
  26             -> Option<ExternalHtml> {
  27         let codes = ErrorCodes::from(UnstableFeatures::from_environment().is_nightly_build());
  28         let ih = load_external_files(in_header, diag)?;
  29         let bc = load_external_files(before_content, diag)?;
  30         let m_bc = load_external_files(md_before_content, diag)?;
  31         let bc = format!("{}{}", bc, Markdown(&m_bc, &[], id_map,
  32                                     codes, edition, playground).to_string());
  33         let ac = load_external_files(after_content, diag)?;
  34         let m_ac = load_external_files(md_after_content, diag)?;
  35         let ac = format!("{}{}", ac, Markdown(&m_ac, &[], id_map,
  36                                     codes, edition, playground).to_string());
  37         Some(ExternalHtml {
  38             in_header: ih,
  39             before_content: bc,
  40             after_content: ac,
  41         })
  42     }
  43 }
  44
  45 pub enum LoadStringError {
  46     ReadFail,
  47     BadUtf8,
  48 }
  49
  50 pub fn load_string<P: AsRef<Path>>(file_path: P, diag: &errors::Handler)
  51     -> Result<String, LoadStringError>
  52 {
  53     let file_path = file_path.as_ref();
  54     let contents = match fs::read(file_path) {
  55         Ok(bytes) => bytes,
  56         Err(e) => {
  57             diag.struct_err(&format!("error reading `{}`: {}", file_path.display(), e)).emit();
  58             return Err(LoadStringError::ReadFail);
  59         }
  60     };
  61     match str::from_utf8(&contents) {
  62         Ok(s) => Ok(s.to_string()),
  63         Err(_) => {
  64             diag.struct_err(&format!("error reading `{}`: not UTF-8", file_path.display())).emit();
  65             Err(LoadStringError::BadUtf8)
  66         }
  67     }
  68 }
  69
  70 fn load_external_files(names: &[String], diag: &errors::Handler) -> Option<String> {
  71     let mut out = String::new();
  72     for name in names {
  73         let s = match load_string(name, diag) {
  74             Ok(s) => s,
  75             Err(_) => return None,
  76         };
  77         out.push_str(&s);
  78         out.push('\n');
  79     }
  80     Some(out)
  81 }