rust/src/librustdoc/config.rs

380 lines
11 KiB
Rust
Raw Normal View History

// Copyright 2012 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 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
use core::prelude::*;
use core::cell::Cell;
use core::run;
use core::run::ProgramOutput;
use core::result::Result;
2013-05-19 11:17:49 -07:00
use extra::getopts;
/// The type of document to output
#[deriving(Eq)]
2012-11-19 18:00:12 -08:00
pub enum OutputFormat {
/// Markdown
2012-11-19 18:00:12 -08:00
pub Markdown,
/// HTML, via markdown and pandoc
2012-11-19 18:00:12 -08:00
pub PandocHtml
}
/// How to organize the output
#[deriving(Eq)]
2012-11-19 18:00:12 -08:00
pub enum OutputStyle {
/// All in a single document
2012-11-19 18:00:12 -08:00
pub DocPerCrate,
/// Each module in its own document
2012-11-19 18:00:12 -08:00
pub DocPerMod
}
/// The configuration for a rustdoc session
pub struct Config {
input_crate: Path,
output_dir: Path,
2012-09-18 16:48:40 -07:00
output_format: OutputFormat,
output_style: OutputStyle,
2012-08-20 12:23:37 -07:00
pandoc_cmd: Option<~str>
}
impl Clone for Config {
fn clone(&self) -> Config { copy *self }
}
fn opt_output_dir() -> ~str { ~"output-dir" }
fn opt_output_format() -> ~str { ~"output-format" }
fn opt_output_style() -> ~str { ~"output-style" }
fn opt_pandoc_cmd() -> ~str { ~"pandoc-cmd" }
fn opt_help() -> ~str { ~"h" }
2012-08-11 10:08:42 -04:00
fn opts() -> ~[(getopts::Opt, ~str)] {
~[
(getopts::optopt(opt_output_dir()),
~"--output-dir <val> put documents here"),
(getopts::optopt(opt_output_format()),
~"--output-format <val> either 'markdown' or 'html'"),
(getopts::optopt(opt_output_style()),
~"--output-style <val> either 'doc-per-crate' or 'doc-per-mod'"),
(getopts::optopt(opt_pandoc_cmd()),
~"--pandoc-cmd <val> the command for running pandoc"),
2012-02-28 21:27:38 -08:00
(getopts::optflag(opt_help()),
~"-h print help")
]
}
2012-11-19 18:00:12 -08:00
pub fn usage() {
use core::io::println;
2012-02-28 21:27:38 -08:00
println("Usage: rustdoc [options] <cratefile>\n");
println("Options:\n");
2012-06-30 16:19:07 -07:00
for opts().each |opt| {
2012-08-22 17:24:52 -07:00
println(fmt!(" %s", opt.second()));
2012-02-28 21:27:38 -08:00
}
println("");
2012-02-28 21:27:38 -08:00
}
2012-11-19 18:00:12 -08:00
pub fn default_config(input_crate: &Path) -> Config {
Config {
2013-01-30 13:14:35 -08:00
input_crate: copy *input_crate,
output_dir: Path("."),
2012-09-18 16:48:40 -07:00
output_format: PandocHtml,
output_style: DocPerMod,
2012-08-20 12:23:37 -07:00
pandoc_cmd: None
}
}
type Process = ~fn((&str), (&[~str])) -> ProgramOutput;
pub fn mock_program_output(_prog: &str, _args: &[~str]) -> ProgramOutput {
ProgramOutput {
status: 0,
out: ~"",
err: ~""
}
}
pub fn program_output(prog: &str, args: &[~str]) -> ProgramOutput {
run::program_output(prog, args)
2013-01-30 19:45:39 -08:00
}
2012-11-21 11:25:01 -08:00
pub fn parse_config(args: &[~str]) -> Result<Config, ~str> {
2013-01-30 19:45:39 -08:00
parse_config_(args, program_output)
}
pub fn parse_config_(
2012-11-19 18:48:46 -08:00
args: &[~str],
program_output: Process
2012-09-18 16:48:40 -07:00
) -> Result<Config, ~str> {
let args = args.tail();
let opts = vec::unzip(opts()).first();
2012-08-06 12:34:08 -07:00
match getopts::getopts(args, opts) {
2013-03-03 11:44:11 -08:00
Ok(matches) => {
if matches.free.len() == 1 {
2013-03-03 11:44:11 -08:00
let input_crate = Path(*matches.free.head());
2013-02-15 00:37:08 -08:00
config_from_opts(&input_crate, &matches, program_output)
} else if matches.free.is_empty() {
2013-03-03 11:44:11 -08:00
Err(~"no crates specified")
} else {
2013-03-03 11:44:11 -08:00
Err(~"multiple crates specified")
}
}
2013-03-03 11:44:11 -08:00
Err(f) => {
Err(getopts::fail_str(f))
}
}
}
fn config_from_opts(
input_crate: &Path,
matches: &getopts::Matches,
program_output: Process
2012-09-18 16:48:40 -07:00
) -> Result<Config, ~str> {
let config = default_config(input_crate);
2012-08-26 16:54:31 -07:00
let result = result::Ok(config);
2012-06-30 16:19:07 -07:00
let result = do result::chain(result) |config| {
let output_dir = getopts::opt_maybe_str(matches, opt_output_dir());
let output_dir = output_dir.map(|s| Path(*s));
result::Ok(Config {
2013-01-30 13:14:35 -08:00
output_dir: output_dir.get_or_default(copy config.output_dir),
2012-09-04 13:29:32 -07:00
.. config
})
};
2012-06-30 16:19:07 -07:00
let result = do result::chain(result) |config| {
let output_format = getopts::opt_maybe_str(
matches, opt_output_format());
2013-01-30 13:14:35 -08:00
do output_format.map_default(result::Ok(copy config))
2012-06-30 16:19:07 -07:00
|output_format| {
do result::chain(parse_output_format(*output_format))
2012-06-30 16:19:07 -07:00
|output_format| {
result::Ok(Config {
2012-09-04 13:29:32 -07:00
output_format: output_format,
2013-01-30 13:14:35 -08:00
.. copy config
})
}
}
};
2012-06-30 16:19:07 -07:00
let result = do result::chain(result) |config| {
let output_style =
getopts::opt_maybe_str(matches, opt_output_style());
2013-01-30 13:14:35 -08:00
do output_style.map_default(result::Ok(copy config))
2012-06-30 16:19:07 -07:00
|output_style| {
do result::chain(parse_output_style(*output_style))
2012-06-30 16:19:07 -07:00
|output_style| {
result::Ok(Config {
2012-09-04 13:29:32 -07:00
output_style: output_style,
2013-01-30 13:14:35 -08:00
.. copy config
})
}
}
};
2013-02-15 00:37:08 -08:00
let program_output = Cell(program_output);
2012-06-30 16:19:07 -07:00
let result = do result::chain(result) |config| {
let pandoc_cmd = getopts::opt_maybe_str(matches, opt_pandoc_cmd());
let pandoc_cmd = maybe_find_pandoc(
2013-02-15 00:37:08 -08:00
&config, pandoc_cmd, program_output.take());
2012-06-30 16:19:07 -07:00
do result::chain(pandoc_cmd) |pandoc_cmd| {
result::Ok(Config {
2012-09-04 13:29:32 -07:00
pandoc_cmd: pandoc_cmd,
2013-01-30 13:14:35 -08:00
.. copy config
})
}
};
2012-08-01 17:30:05 -07:00
return result;
}
2012-11-19 18:48:46 -08:00
fn parse_output_format(output_format: &str) -> Result<OutputFormat, ~str> {
match output_format.to_str() {
2012-09-18 16:48:40 -07:00
~"markdown" => result::Ok(Markdown),
~"html" => result::Ok(PandocHtml),
2012-08-26 16:54:31 -07:00
_ => result::Err(fmt!("unknown output format '%s'", output_format))
}
}
2012-11-19 18:48:46 -08:00
fn parse_output_style(output_style: &str) -> Result<OutputStyle, ~str> {
match output_style.to_str() {
2012-09-18 16:48:40 -07:00
~"doc-per-crate" => result::Ok(DocPerCrate),
~"doc-per-mod" => result::Ok(DocPerMod),
2012-08-26 16:54:31 -07:00
_ => result::Err(fmt!("unknown output style '%s'", output_style))
}
}
pub fn maybe_find_pandoc(
2012-11-19 18:48:46 -08:00
config: &Config,
2013-01-30 19:32:36 -08:00
maybe_pandoc_cmd: Option<~str>,
program_output: Process
2012-08-26 16:54:31 -07:00
) -> Result<Option<~str>, ~str> {
2012-09-18 16:48:40 -07:00
if config.output_format != PandocHtml {
2012-08-26 16:54:31 -07:00
return result::Ok(maybe_pandoc_cmd);
}
2012-08-06 12:34:08 -07:00
let possible_pandocs = match maybe_pandoc_cmd {
2012-08-20 12:23:37 -07:00
Some(pandoc_cmd) => ~[pandoc_cmd],
None => {
2012-08-06 12:34:08 -07:00
~[~"pandoc"] + match os::homedir() {
2012-08-20 12:23:37 -07:00
Some(dir) => {
~[dir.push_rel(&Path(".cabal/bin/pandoc")).to_str()]
2012-03-07 19:22:02 -08:00
}
2012-08-20 12:23:37 -07:00
None => ~[]
2012-03-07 19:22:02 -08:00
}
}
};
2012-06-30 16:19:07 -07:00
let pandoc = do vec::find(possible_pandocs) |pandoc| {
let output = program_output(*pandoc, [~"--version"]);
2012-09-27 22:20:47 -07:00
debug!("testing pandoc cmd %s: %?", *pandoc, output);
output.status == 0
};
2012-09-21 19:37:57 -07:00
if pandoc.is_some() {
2012-08-26 16:54:31 -07:00
result::Ok(pandoc)
} else {
2012-08-26 16:54:31 -07:00
result::Err(~"couldn't find pandoc")
}
}
#[cfg(test)]
mod test {
use core::prelude::*;
use config::*;
use core::run::ProgramOutput;
fn parse_config(args: &[~str]) -> Result<Config, ~str> {
parse_config_(args, mock_program_output)
}
#[test]
fn should_find_pandoc() {
let config = Config {
output_format: PandocHtml,
.. default_config(&Path("test"))
};
let mock_program_output: ~fn(&str, &[~str]) -> ProgramOutput = |_, _| {
ProgramOutput { status: 0, out: ~"pandoc 1.8.2.1", err: ~"" }
};
let result = maybe_find_pandoc(&config, None, mock_program_output);
assert!(result == result::Ok(Some(~"pandoc")));
}
#[test]
fn should_error_with_no_pandoc() {
let config = Config {
output_format: PandocHtml,
.. default_config(&Path("test"))
};
let mock_program_output: ~fn(&str, &[~str]) -> ProgramOutput = |_, _| {
ProgramOutput { status: 1, out: ~"", err: ~"" }
};
let result = maybe_find_pandoc(&config, None, mock_program_output);
assert!(result == result::Err(~"couldn't find pandoc"));
}
#[test]
fn should_error_with_no_crates() {
2013-05-23 09:39:38 -07:00
let config = parse_config([~"rustdoc"]);
assert!(config.get_err() == ~"no crates specified");
}
#[test]
fn should_error_with_multiple_crates() {
let config =
2013-05-23 09:39:38 -07:00
parse_config([~"rustdoc", ~"crate1.rc", ~"crate2.rc"]);
assert!(config.get_err() == ~"multiple crates specified");
}
#[test]
fn should_set_output_dir_to_cwd_if_not_provided() {
2013-05-23 09:39:38 -07:00
let config = parse_config([~"rustdoc", ~"crate.rc"]);
assert!(config.get().output_dir == Path("."));
}
#[test]
fn should_set_output_dir_if_provided() {
2013-05-23 09:39:38 -07:00
let config = parse_config([
~"rustdoc", ~"crate.rc", ~"--output-dir", ~"snuggles"
]);
assert!(config.get().output_dir == Path("snuggles"));
}
#[test]
fn should_set_output_format_to_pandoc_html_if_not_provided() {
2013-05-23 09:39:38 -07:00
let config = parse_config([~"rustdoc", ~"crate.rc"]);
assert!(config.get().output_format == PandocHtml);
}
#[test]
fn should_set_output_format_to_markdown_if_requested() {
2013-05-23 09:39:38 -07:00
let config = parse_config([
~"rustdoc", ~"crate.rc", ~"--output-format", ~"markdown"
]);
assert!(config.get().output_format == Markdown);
}
#[test]
fn should_set_output_format_to_pandoc_html_if_requested() {
2013-05-23 09:39:38 -07:00
let config = parse_config([
~"rustdoc", ~"crate.rc", ~"--output-format", ~"html"
]);
assert!(config.get().output_format == PandocHtml);
}
#[test]
fn should_error_on_bogus_format() {
2013-05-23 09:39:38 -07:00
let config = parse_config([
~"rustdoc", ~"crate.rc", ~"--output-format", ~"bogus"
]);
assert!(config.get_err() == ~"unknown output format 'bogus'");
}
#[test]
fn should_set_output_style_to_doc_per_mod_by_default() {
2013-05-23 09:39:38 -07:00
let config = parse_config([~"rustdoc", ~"crate.rc"]);
assert!(config.get().output_style == DocPerMod);
}
#[test]
fn should_set_output_style_to_one_doc_if_requested() {
2013-05-23 09:39:38 -07:00
let config = parse_config([
~"rustdoc", ~"crate.rc", ~"--output-style", ~"doc-per-crate"
]);
assert!(config.get().output_style == DocPerCrate);
}
#[test]
fn should_set_output_style_to_doc_per_mod_if_requested() {
2013-05-23 09:39:38 -07:00
let config = parse_config([
~"rustdoc", ~"crate.rc", ~"--output-style", ~"doc-per-mod"
]);
assert!(config.get().output_style == DocPerMod);
}
#[test]
fn should_error_on_bogus_output_style() {
2013-05-23 09:39:38 -07:00
let config = parse_config([
~"rustdoc", ~"crate.rc", ~"--output-style", ~"bogus"
]);
assert!(config.get_err() == ~"unknown output style 'bogus'");
}
#[test]
fn should_set_pandoc_command_if_requested() {
2013-05-23 09:39:38 -07:00
let config = parse_config([
~"rustdoc", ~"crate.rc", ~"--pandoc-cmd", ~"panda-bear-doc"
]);
assert!(config.get().pandoc_cmd == Some(~"panda-bear-doc"));
}
#[test]
fn should_set_pandoc_command_when_using_pandoc() {
2013-05-23 09:39:38 -07:00
let config = parse_config([~"rustdoc", ~"crate.rc"]);
assert!(config.get().pandoc_cmd == Some(~"pandoc"));
}
2013-04-26 12:24:15 -04:00
}