// Copyright 2014 The Rust Project Developers. See the COPYRIGHT // file at the top-level directory of this distribution and at // http://rust-lang.org/COPYRIGHT. // // Licensed under the Apache License, Version 2.0 or the MIT license // , at your // option. This file may not be copied, modified, or distributed // except according to those terms. //! Implementation of the `build` subcommand, used to compile a book. use std::os; use std::env; use std::old_io; use std::old_io::{fs, File, BufferedWriter, TempDir, IoResult}; use subcommand::Subcommand; use term::Term; use error::{Error, CliResult, CommandResult}; use book; use book::{Book, BookItem}; use css; use javascript; use rustdoc; struct Build; pub fn parse_cmd(name: &str) -> Option> { if name == "build" { Some(box Build as Box) } else { None } } fn write_toc(book: &Book, path_to_root: &Path, out: &mut Writer) -> IoResult<()> { fn walk_items(items: &[BookItem], section: &str, path_to_root: &Path, out: &mut Writer) -> IoResult<()> { for (i, item) in items.iter().enumerate() { try!(walk_item(item, &format!("{}{}.", section, i + 1)[], path_to_root, out)); } Ok(()) } fn walk_item(item: &BookItem, section: &str, path_to_root: &Path, out: &mut Writer) -> IoResult<()> { try!(writeln!(out, "
  • {} {}", path_to_root.join(item.path.with_extension("html")).display(), section, item.title)); if !item.children.is_empty() { try!(writeln!(out, "
      ")); let _ = walk_items(&item.children[], section, path_to_root, out); try!(writeln!(out, "
    ")); } try!(writeln!(out, "
  • ")); Ok(()) } try!(writeln!(out, "
    ")); try!(writeln!(out, "
      ")); try!(walk_items(&book.chapters[], "", path_to_root, out)); try!(writeln!(out, "
    ")); try!(writeln!(out, "
    ")); Ok(()) } fn render(book: &Book, tgt: &Path) -> CliResult<()> { let tmp = try!(TempDir::new("rust-book")); for (section, item) in book.iter() { println!("{} {}", section, item.title); let out_path = tgt.join(item.path.dirname()); let src; if env::args().len() < 3 { src = os::getcwd().unwrap().clone(); } else { src = Path::new(env::args().nth(2).unwrap().clone()); } // preprocess the markdown, rerouting markdown references to html references let markdown_data = try!(File::open(&src.join(&item.path)).read_to_string()); let preprocessed_path = tmp.path().join(item.path.filename().unwrap()); { let urls = markdown_data.replace(".md)", ".html)"); try!(File::create(&preprocessed_path) .write_str(&urls[])); } // write the prelude to a temporary HTML file for rustdoc inclusion let prelude = tmp.path().join("prelude.html"); { let mut toc = BufferedWriter::new(try!(File::create(&prelude))); try!(writeln!(&mut toc, r#""#)); let _ = write_toc(book, &item.path_to_root, &mut toc); try!(writeln!(&mut toc, "
    ")); try!(writeln!(&mut toc, "
    ")); } // write the postlude to a temporary HTML file for rustdoc inclusion let postlude = tmp.path().join("postlude.html"); { let mut toc = BufferedWriter::new(try!(File::create(&postlude))); try!(toc.write_str(javascript::JAVASCRIPT)); try!(writeln!(&mut toc, "
    ")); } try!(fs::mkdir_recursive(&out_path, old_io::USER_DIR)); let rustdoc_args: &[String] = &[ "".to_string(), preprocessed_path.display().to_string(), format!("-o{}", out_path.display()), format!("--html-before-content={}", prelude.display()), format!("--html-after-content={}", postlude.display()), format!("--markdown-css={}", item.path_to_root.join("rust-book.css").display()), "--markdown-no-toc".to_string(), ]; let output_result = rustdoc::main_args(rustdoc_args); if output_result != 0 { let message = format!("Could not execute `rustdoc` with {:?}: {}", rustdoc_args, output_result); return Err(box message as Box); } } // create index.html from the root README try!(fs::copy(&tgt.join("README.html"), &tgt.join("index.html"))); Ok(()) } impl Subcommand for Build { fn parse_args(&mut self, _: &[String]) -> CliResult<()> { Ok(()) } fn usage(&self) {} fn execute(&mut self, term: &mut Term) -> CommandResult<()> { let cwd = os::getcwd().unwrap(); let src; let tgt; if env::args().len() < 3 { src = cwd.clone(); } else { src = Path::new(env::args().nth(2).unwrap().clone()); } if env::args().len() < 4 { tgt = cwd.join("_book"); } else { tgt = Path::new(env::args().nth(3).unwrap().clone()); } try!(fs::mkdir(&tgt, old_io::USER_DIR)); try!(File::create(&tgt.join("rust-book.css")).write_str(css::STYLE)); let summary = try!(File::open(&src.join("SUMMARY.md"))); match book::parse_summary(summary, &src) { Ok(book) => { // execute rustdoc on the whole book render(&book, &tgt) } Err(errors) => { let n = errors.len(); for err in errors { term.err(&format!("error: {}", err)[]); } Err(box format!("{} errors occurred", n) as Box) } } } }