bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

parse command-line into a central Options struct

Browse source
This commit is contained in:
QuietMisdreavus 2018-10-30 08:47:54 -05:00
parent e53a5ffd6b
commit f5f496efd0
3 changed files with 528 additions and 300 deletions
Download patch file Download diff file Expand all files Collapse all files

336
src/librustdoc/lib.rs
View file

@ -53,22 +53,17 @@ extern crate parking_lot;
extern crate serialize as rustc_serialize; // used by deriving
use errors::ColorConfig;
use std::collections::{BTreeMap, BTreeSet};
use std::default::Default;
use std::env;
use std::panic;
use std::path::{Path, PathBuf};
use std::path::PathBuf;
use std::process;
use std::sync::mpsc::channel;
use syntax::edition::Edition;
use externalfiles::ExternalHtml;
use rustc::session::{early_warn, early_error};
use rustc::session::search_paths::SearchPaths;
use rustc::session::config::{ErrorOutputType, RustcOptGroup, Externs, CodegenOptions};
use rustc::session::config::{nightly_options, build_codegen_options};
use rustc_target::spec::TargetTriple;
use rustc::session::config::get_cmd_lint_options;
@ -76,6 +71,7 @@ use rustc::session::config::get_cmd_lint_options;
mod externalfiles;
mod clean;
mod config;
mod core;
mod doctree;
mod fold;
@ -367,250 +363,55 @@ fn main_args(args: &[String]) -> isize {
early_error(ErrorOutputType::default(), &err.to_string());
}
};
// Check for unstable options.
nightly_options::check_nightly_options(&matches, &opts());
if matches.opt_present("h") || matches.opt_present("help") {
usage("rustdoc");
return 0;
} else if matches.opt_present("version") {
rustc_driver::version("rustdoc", &matches);
return 0;
}
if matches.opt_strs("passes") == ["list"] {
println!("Available passes for running rustdoc:");
for pass in passes::PASSES {
println!("{:>20} - {}", pass.name(), pass.description());
}
println!("\nDefault passes for rustdoc:");
for &name in passes::DEFAULT_PASSES {
println!("{:>20}", name);
}
println!("\nPasses run with `--document-private-items`:");
for &name in passes::DEFAULT_PRIVATE_PASSES {
println!("{:>20}", name);
}
return 0;
}
let color = match matches.opt_str("color").as_ref().map(|s| &s[..]) {
Some("auto") => ColorConfig::Auto,
Some("always") => ColorConfig::Always,
Some("never") => ColorConfig::Never,
None => ColorConfig::Auto,
Some(arg) => {
early_error(ErrorOutputType::default(),
&format!("argument for --color must be `auto`, `always` or `never` \
(instead was `{}`)", arg));
}
};
let error_format = match matches.opt_str("error-format").as_ref().map(|s| &s[..]) {
Some("human") => ErrorOutputType::HumanReadable(color),
Some("json") => ErrorOutputType::Json(false),
Some("pretty-json") => ErrorOutputType::Json(true),
Some("short") => ErrorOutputType::Short(color),
None => ErrorOutputType::HumanReadable(color),
Some(arg) => {
early_error(ErrorOutputType::default(),
&format!("argument for --error-format must be `human`, `json` or \
`short` (instead was `{}`)", arg));
}
};
let treat_err_as_bug = matches.opt_strs("Z").iter().any(|x| {
*x == "treat-err-as-bug"
});
let ui_testing = matches.opt_strs("Z").iter().any(|x| {
*x == "ui-testing"
});
let diag = core::new_handler(error_format, None, treat_err_as_bug, ui_testing);
// check for deprecated options
check_deprecated_options(&matches, &diag);
let to_check = matches.opt_strs("theme-checker");
if !to_check.is_empty() {
let paths = theme::load_css_paths(include_bytes!("html/static/themes/light.css"));
let mut errors = 0;
println!("rustdoc: [theme-checker] Starting tests!");
for theme_file in to_check.iter() {
print!(" - Checking \"{}\"...", theme_file);
let (success, differences) = theme::test_theme_against(theme_file, &paths, &diag);
if !differences.is_empty() || !success {
println!(" FAILED");
errors += 1;
if !differences.is_empty() {
println!("{}", differences.join("\n"));
}
} else {
println!(" OK");
}
}
if errors != 0 {
return 1;
}
return 0;
}
if matches.free.is_empty() {
diag.struct_err("missing file operand").emit();
return 1;
}
if matches.free.len() > 1 {
diag.struct_err("too many file operands").emit();
return 1;
}
let input = matches.free[0].clone();
let mut libs = SearchPaths::new();
for s in &matches.opt_strs("L") {
libs.add_path(s, error_format);
}
let externs = match parse_externs(&matches) {
Ok(ex) => ex,
Err(err) => {
diag.struct_err(&err).emit();
return 1;
}
};
let extern_urls = match parse_extern_html_roots(&matches) {
Ok(ex) => ex,
Err(err) => {
diag.struct_err(err).emit();
return 1;
}
let options = match config::Options::from_matches(&matches) {
Ok(opts) => opts,
Err(code) => return code,
};
let test_args = matches.opt_strs("test-args");
let test_args: Vec<String> = test_args.iter()
.flat_map(|s| s.split_whitespace())
.map(|s| s.to_string())
.collect();
let diag = core::new_handler(options.error_format,
None,
options.debugging_options.treat_err_as_bug,
options.debugging_options.ui_testing);
let should_test = matches.opt_present("test");
let markdown_input = Path::new(&input).extension()
.map_or(false, |e| e == "md" || e == "markdown");
let output = matches.opt_str("o").map(|s| PathBuf::from(&s));
let css_file_extension = matches.opt_str("e").map(|s| PathBuf::from(&s));
let mut cfgs = matches.opt_strs("cfg");
cfgs.push("rustdoc".to_string());
if let Some(ref p) = css_file_extension {
if !p.is_file() {
diag.struct_err("option --extend-css argument must be a file").emit();
return 1;
}
}
let mut themes = Vec::new();
if matches.opt_present("themes") {
let paths = theme::load_css_paths(include_bytes!("html/static/themes/light.css"));
for (theme_file, theme_s) in matches.opt_strs("themes")
.iter()
.map(|s| (PathBuf::from(&s), s.to_owned())) {
if !theme_file.is_file() {
diag.struct_err("option --themes arguments must all be files").emit();
return 1;
}
let (success, ret) = theme::test_theme_against(&theme_file, &paths, &diag);
if !success || !ret.is_empty() {
diag.struct_err(&format!("invalid theme: \"{}\"", theme_s))
.help("check what's wrong with the --theme-checker option")
.emit();
return 1;
}
themes.push(theme_file);
}
}
let mut id_map = html::markdown::IdMap::new();
id_map.populate(html::render::initial_ids());
let external_html = match ExternalHtml::load(
&matches.opt_strs("html-in-header"),
&matches.opt_strs("html-before-content"),
&matches.opt_strs("html-after-content"),
&matches.opt_strs("markdown-before-content"),
&matches.opt_strs("markdown-after-content"), &diag, &mut id_map) {
Some(eh) => eh,
None => return 3,
};
let crate_name = matches.opt_str("crate-name");
let playground_url = matches.opt_str("playground-url");
let maybe_sysroot = matches.opt_str("sysroot").map(PathBuf::from);
let display_warnings = matches.opt_present("display-warnings");
let linker = matches.opt_str("linker").map(PathBuf::from);
let sort_modules_alphabetically = !matches.opt_present("sort-modules-by-appearance");
let resource_suffix = matches.opt_str("resource-suffix");
let index_page = matches.opt_str("index-page").map(|s| PathBuf::from(&s));
let enable_index_page = matches.opt_present("enable-index-page") || index_page.is_some();
let enable_minification = !matches.opt_present("disable-minification");
let edition = matches.opt_str("edition").unwrap_or("2015".to_string());
let edition = match edition.parse() {
Ok(e) => e,
Err(_) => {
diag.struct_err("could not parse edition").emit();
return 1;
}
};
if let Some(ref index_page) = index_page {
if !index_page.is_file() {
diag.struct_err("option `--index-page` argument must be a file").emit();
return 1;
}
}
let cg = build_codegen_options(&matches, ErrorOutputType::default());
match (should_test, markdown_input) {
match (options.should_test, options.markdown_input()) {
(true, true) => {
return markdown::test(&input, cfgs, libs, externs, test_args, maybe_sysroot,
display_warnings, linker, edition, cg, &diag)
return markdown::test(&options.input, options.cfgs, options.libs, options.externs,
options.test_args, options.maybe_sysroot,
options.display_warnings, options.linker, options.edition,
options.codegen_options, &diag)
}
(true, false) => {
return test::run(Path::new(&input), cfgs, libs, externs, test_args, crate_name,
maybe_sysroot, display_warnings, linker, edition, cg)
return test::run(&options.input, options.cfgs, options.libs, options.externs,
options.test_args, options.crate_name, options.maybe_sysroot,
options.display_warnings, options.linker, options.edition,
options.codegen_options)
}
(false, true) => return markdown::render(Path::new(&input),
output.unwrap_or(PathBuf::from("doc")),
&matches, &external_html,
!matches.opt_present("markdown-no-toc"), &diag),
(false, true) => return markdown::render(&options.input, options.output,
&matches,
&options.external_html,
!options.markdown_no_toc, &diag),
(false, false) => {}
}
let output_format = matches.opt_str("w");
let res = acquire_input(PathBuf::from(input), externs, edition, cg, matches, error_format,
let res = acquire_input(options.input.clone(), options.externs.clone(), options.edition,
options.codegen_options.clone(), matches, options.error_format,
move |out, matches| {
let Output { krate, passes, renderinfo } = out;
let diag = core::new_handler(error_format, None, treat_err_as_bug, ui_testing);
info!("going to format");
match output_format.as_ref().map(|s| &**s) {
Some("html") | None => {
html::render::run(krate, extern_urls, &external_html, playground_url,
output.unwrap_or(PathBuf::from("doc")),
resource_suffix.unwrap_or(String::new()),
passes.into_iter().collect(),
css_file_extension,
renderinfo,
sort_modules_alphabetically,
themes,
enable_minification, id_map,
enable_index_page, index_page,
&matches,
&diag)
.expect("failed to generate documentation");
0
}
Some(s) => {
diag.struct_err(&format!("unknown output format: {}", s)).emit();
1
}
}
html::render::run(krate, options.extern_html_root_urls, &options.external_html, options.playground_url,
options.output,
options.resource_suffix,
passes.into_iter().collect(),
options.extension_css,
renderinfo,
options.sort_modules_alphabetically,
options.themes,
options.enable_minification, options.id_map,
options.enable_index_page, options.index_page,
&matches,
&diag)
.expect("failed to generate documentation");
0
});
res.unwrap_or_else(|s| {
diag.struct_err(&format!("input error: {}", s)).emit();
@ -636,43 +437,6 @@ where R: 'static + Send, F: 'static + Send + FnOnce(Output, &getopts::Matches) -
}
}
/// Extracts `--extern CRATE=PATH` arguments from `matches` and
/// returns a map mapping crate names to their paths or else an
/// error message.
// FIXME(eddyb) This shouldn't be duplicated with `rustc::session`.
fn parse_externs(matches: &getopts::Matches) -> Result<Externs, String> {
let mut externs: BTreeMap<_, BTreeSet<_>> = BTreeMap::new();
for arg in &matches.opt_strs("extern") {
let mut parts = arg.splitn(2, '=');
let name = parts.next().ok_or("--extern value must not be empty".to_string())?;
let location = parts.next().map(|s| s.to_string());
if location.is_none() && !nightly_options::is_unstable_enabled(matches) {
return Err("the `-Z unstable-options` flag must also be passed to \
enable `--extern crate_name` without `=path`".to_string());
}
let name = name.to_string();
externs.entry(name).or_default().insert(location);
}
Ok(Externs::new(externs))
}
/// Extracts `--extern-html-root-url` arguments from `matches` and returns a map of crate names to
/// the given URLs. If an `--extern-html-root-url` argument was ill-formed, returns an error
/// describing the issue.
fn parse_extern_html_roots(matches: &getopts::Matches)
-> Result<BTreeMap<String, String>, &'static str>
{
let mut externs = BTreeMap::new();
for arg in &matches.opt_strs("extern-html-root-url") {
let mut parts = arg.splitn(2, '=');
let name = parts.next().ok_or("--extern-html-root-url must not be empty")?;
let url = parts.next().ok_or("--extern-html-root-url must be of the form name=url")?;
externs.insert(name.to_string(), url.to_string());
}
Ok(externs)
}
/// Interprets the input file as a rust source file, passing it through the
/// compiler all the way through the analysis passes. The rustdoc output is then
/// generated from the cleaned AST of the crate.
@ -792,27 +556,3 @@ where R: 'static + Send,
Err(_) => panic::resume_unwind(Box::new(errors::FatalErrorMarker)),
}
}
/// Prints deprecation warnings for deprecated options
fn check_deprecated_options(matches: &getopts::Matches, diag: &errors::Handler) {
let deprecated_flags = [
"input-format",
"output-format",
"no-defaults",
"passes",
];
for flag in deprecated_flags.into_iter() {
if matches.opt_present(flag) {
let mut err = diag.struct_warn(&format!("the '{}' flag is considered deprecated",
flag));
err.warn("please see https://github.com/rust-lang/rust/issues/44136");
if *flag == "no-defaults" {
err.help("you may want to use --document-private-items");
}
err.emit();
}
}
}