src/librustdoc/externalfiles.rs

   1 use std::fs;
   2 use std::path::Path;
   3 use std::str;
   4 use errors;
   5 use syntax::feature_gate::UnstableFeatures;
   6 use html::markdown::{IdMap, ErrorCodes, Markdown};
   7 use std::cell::RefCell;
   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)
  26             -> Option<ExternalHtml> {
  27         let codes = ErrorCodes::from(UnstableFeatures::from_environment().is_nightly_build());
  28         load_external_files(in_header, diag)
  29             .and_then(|ih|
  30                 load_external_files(before_content, diag)
  31                     .map(|bc| (ih, bc))
  32             )
  33             .and_then(|(ih, bc)|
  34                 load_external_files(md_before_content, diag)
  35                     .map(|m_bc| (ih,
  36                             format!("{}{}", bc, Markdown(&m_bc, &[], RefCell::new(id_map), codes))))
  37             )
  38             .and_then(|(ih, bc)|
  39                 load_external_files(after_content, diag)
  40                     .map(|ac| (ih, bc, ac))
  41             )
  42             .and_then(|(ih, bc, ac)|
  43                 load_external_files(md_after_content, diag)
  44                     .map(|m_ac| (ih, bc,
  45                             format!("{}{}", ac, Markdown(&m_ac, &[], RefCell::new(id_map), codes))))
  46             )
  47             .map(|(ih, bc, ac)|
  48                 ExternalHtml {
  49                     in_header: ih,
  50                     before_content: bc,
  51                     after_content: ac,
  52                 }
  53             )
  54     }
  55 }
  56
  57 pub enum LoadStringError {
  58     ReadFail,
  59     BadUtf8,
  60 }
  61
  62 pub fn load_string<P: AsRef<Path>>(file_path: P, diag: &errors::Handler)
  63     -> Result<String, LoadStringError>
  64 {
  65     let file_path = file_path.as_ref();
  66     let contents = match fs::read(file_path) {
  67         Ok(bytes) => bytes,
  68         Err(e) => {
  69             diag.struct_err(&format!("error reading `{}`: {}", file_path.display(), e)).emit();
  70             return Err(LoadStringError::ReadFail);
  71         }
  72     };
  73     match str::from_utf8(&contents) {
  74         Ok(s) => Ok(s.to_string()),
  75         Err(_) => {
  76             diag.struct_err(&format!("error reading `{}`: not UTF-8", file_path.display())).emit();
  77             Err(LoadStringError::BadUtf8)
  78         }
  79     }
  80 }
  81
  82 fn load_external_files(names: &[String], diag: &errors::Handler) -> Option<String> {
  83     let mut out = String::new();
  84     for name in names {
  85         let s = match load_string(name, diag) {
  86             Ok(s) => s,
  87             Err(_) => return None,
  88         };
  89         out.push_str(&s);
  90         out.push('\n');
  91     }
  92     Some(out)
  93 }