1 use std::collections::{BTreeMap, BTreeSet};
3 use std::path::PathBuf;
6 use errors::emitter::ColorConfig;
8 use rustc::lint::Level;
9 use rustc::session::early_error;
10 use rustc::session::config::{CodegenOptions, DebuggingOptions, ErrorOutputType, Externs};
11 use rustc::session::config::{nightly_options, build_codegen_options, build_debugging_options,
12 get_cmd_lint_options};
13 use rustc::session::search_paths::SearchPath;
15 use rustc_target::spec::TargetTriple;
16 use syntax::edition::Edition;
18 use core::new_handler;
19 use externalfiles::ExternalHtml;
21 use html::markdown::IdMap;
22 use html::static_files;
24 use passes::{self, DefaultPassOption};
27 /// Configuration options for rustdoc.
30 // Basic options / Options passed directly to rustc
32 /// The crate root or Markdown file to load.
34 /// The name of the crate being documented.
35 pub crate_name: Option<String>,
36 /// How to format errors and warnings.
37 pub error_format: ErrorOutputType,
38 /// Library search paths to hand to the compiler.
39 pub libs: Vec<SearchPath>,
40 /// The list of external crates to link against.
42 /// List of `cfg` flags to hand to the compiler. Always includes `rustdoc`.
43 pub cfgs: Vec<String>,
44 /// Codegen options to hand to the compiler.
45 pub codegen_options: CodegenOptions,
46 /// Debugging (`-Z`) options to pass to the compiler.
47 pub debugging_options: DebuggingOptions,
48 /// The target used to compile the crate against.
49 pub target: Option<TargetTriple>,
50 /// Edition used when reading the crate. Defaults to "2015". Also used by default when
51 /// compiling doctests from the crate.
53 /// The path to the sysroot. Used during the compilation process.
54 pub maybe_sysroot: Option<PathBuf>,
55 /// Linker to use when building doctests.
56 pub linker: Option<PathBuf>,
57 /// Lint information passed over the command-line.
58 pub lint_opts: Vec<(String, Level)>,
59 /// Whether to ask rustc to describe the lints it knows. Practically speaking, this will not be
60 /// used, since we abort if we have no input file, but it's included for completeness.
61 pub describe_lints: bool,
62 /// What level to cap lints at.
63 pub lint_cap: Option<Level>,
65 // Options specific to running doctests
67 /// Whether we should run doctests instead of generating docs.
68 pub should_test: bool,
69 /// List of arguments to pass to the test harness, if running tests.
70 pub test_args: Vec<String>,
71 /// Optional path to persist the doctest executables to, defaults to a
72 /// temporary directory if not set.
73 pub persist_doctests: Option<PathBuf>,
75 // Options that affect the documentation process
77 /// The selected default set of passes to use.
79 /// Be aware: This option can come both from the CLI and from crate attributes!
80 pub default_passes: DefaultPassOption,
81 /// Any passes manually selected by the user.
83 /// Be aware: This option can come both from the CLI and from crate attributes!
84 pub manual_passes: Vec<String>,
85 /// Whether to display warnings during doc generation or while gathering doctests. By default,
86 /// all non-rustdoc-specific lints are allowed when generating docs.
87 pub display_warnings: bool,
89 // Options that alter generated documentation pages
91 /// Crate version to note on the sidebar of generated docs.
92 pub crate_version: Option<String>,
93 /// Collected options specific to outputting final pages.
94 pub render_options: RenderOptions,
97 impl fmt::Debug for Options {
98 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
99 struct FmtExterns<'a>(&'a Externs);
101 impl<'a> fmt::Debug for FmtExterns<'a> {
102 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
104 .entries(self.0.iter())
109 f.debug_struct("Options")
110 .field("input", &self.input)
111 .field("crate_name", &self.crate_name)
112 .field("error_format", &self.error_format)
113 .field("libs", &self.libs)
114 .field("externs", &FmtExterns(&self.externs))
115 .field("cfgs", &self.cfgs)
116 .field("codegen_options", &"...")
117 .field("debugging_options", &"...")
118 .field("target", &self.target)
119 .field("edition", &self.edition)
120 .field("maybe_sysroot", &self.maybe_sysroot)
121 .field("linker", &self.linker)
122 .field("lint_opts", &self.lint_opts)
123 .field("describe_lints", &self.describe_lints)
124 .field("lint_cap", &self.lint_cap)
125 .field("should_test", &self.should_test)
126 .field("test_args", &self.test_args)
127 .field("persist_doctests", &self.persist_doctests)
128 .field("default_passes", &self.default_passes)
129 .field("manual_passes", &self.manual_passes)
130 .field("display_warnings", &self.display_warnings)
131 .field("crate_version", &self.crate_version)
132 .field("render_options", &self.render_options)
137 /// Configuration options for the HTML page-creation process.
138 #[derive(Clone, Debug)]
139 pub struct RenderOptions {
140 /// Output directory to generate docs into. Defaults to `doc`.
142 /// External files to insert into generated pages.
143 pub external_html: ExternalHtml,
144 /// A pre-populated `IdMap` with the default headings and any headings added by Markdown files
145 /// processed by `external_html`.
147 /// If present, playground URL to use in the "Run" button added to code samples.
149 /// Be aware: This option can come both from the CLI and from crate attributes!
150 pub playground_url: Option<String>,
151 /// Whether to sort modules alphabetically on a module page instead of using declaration order.
152 /// `true` by default.
154 /// FIXME(misdreavus): the flag name is `--sort-modules-by-appearance` but the meaning is
155 /// inverted once read
156 pub sort_modules_alphabetically: bool,
157 /// List of themes to extend the docs with. Original argument name is included to assist in
158 /// displaying errors if it fails a theme check.
159 pub themes: Vec<PathBuf>,
160 /// If present, CSS file that contains rules to add to the default CSS.
161 pub extension_css: Option<PathBuf>,
162 /// A map of crate names to the URL to use instead of querying the crate's `html_root_url`.
163 pub extern_html_root_urls: BTreeMap<String, String>,
164 /// If present, suffix added to CSS/JavaScript files when referencing them in generated pages.
165 pub resource_suffix: String,
166 /// Whether to run the static CSS/JavaScript through a minifier when outputting them. `true` by
169 /// FIXME(misdreavus): the flag name is `--disable-minification` but the meaning is inverted
171 pub enable_minification: bool,
172 /// Whether to create an index page in the root of the output directory. If this is true but
173 /// `enable_index_page` is None, generate a static listing of crates instead.
174 pub enable_index_page: bool,
175 /// A file to use as the index page at the root of the output directory. Overrides
176 /// `enable_index_page` to be true if set.
177 pub index_page: Option<PathBuf>,
178 /// An optional path to use as the location of static files. If not set, uses combinations of
179 /// `../` to reach the documentation root.
180 pub static_root_path: Option<String>,
182 // Options specific to reading standalone Markdown files
184 /// Whether to generate a table of contents on the output file when reading a standalone
186 pub markdown_no_toc: bool,
187 /// Additional CSS files to link in pages generated from standalone Markdown files.
188 pub markdown_css: Vec<String>,
189 /// If present, playground URL to use in the "Run" button added to code samples generated from
190 /// standalone Markdown files. If not present, `playground_url` is used.
191 pub markdown_playground_url: Option<String>,
192 /// If false, the `select` element to have search filtering by crates on rendered docs
193 /// won't be generated.
194 pub generate_search_filter: bool,
198 /// Parses the given command-line for options. If an error message or other early-return has
199 /// been printed, returns `Err` with the exit code.
200 pub fn from_matches(matches: &getopts::Matches) -> Result<Options, isize> {
201 // Check for unstable options.
202 nightly_options::check_nightly_options(&matches, &opts());
204 if matches.opt_present("h") || matches.opt_present("help") {
207 } else if matches.opt_present("version") {
208 rustc_driver::version("rustdoc", &matches);
212 if matches.opt_strs("passes") == ["list"] {
213 println!("Available passes for running rustdoc:");
214 for pass in passes::PASSES {
215 println!("{:>20} - {}", pass.name(), pass.description());
217 println!("\nDefault passes for rustdoc:");
218 for &name in passes::DEFAULT_PASSES {
219 println!("{:>20}", name);
221 println!("\nPasses run with `--document-private-items`:");
222 for &name in passes::DEFAULT_PRIVATE_PASSES {
223 println!("{:>20}", name);
228 let color = match matches.opt_str("color").as_ref().map(|s| &s[..]) {
229 Some("auto") => ColorConfig::Auto,
230 Some("always") => ColorConfig::Always,
231 Some("never") => ColorConfig::Never,
232 None => ColorConfig::Auto,
234 early_error(ErrorOutputType::default(),
235 &format!("argument for --color must be `auto`, `always` or `never` \
236 (instead was `{}`)", arg));
239 let error_format = match matches.opt_str("error-format").as_ref().map(|s| &s[..]) {
240 Some("human") => ErrorOutputType::HumanReadable(color),
241 Some("json") => ErrorOutputType::Json(false),
242 Some("pretty-json") => ErrorOutputType::Json(true),
243 Some("short") => ErrorOutputType::Short(color),
244 None => ErrorOutputType::HumanReadable(color),
246 early_error(ErrorOutputType::default(),
247 &format!("argument for --error-format must be `human`, `json` or \
248 `short` (instead was `{}`)", arg));
252 let codegen_options = build_codegen_options(matches, error_format);
253 let debugging_options = build_debugging_options(matches, error_format);
255 let diag = new_handler(error_format,
257 debugging_options.treat_err_as_bug,
258 debugging_options.ui_testing);
260 // check for deprecated options
261 check_deprecated_options(&matches, &diag);
263 let to_check = matches.opt_strs("theme-checker");
264 if !to_check.is_empty() {
265 let paths = theme::load_css_paths(static_files::themes::LIGHT.as_bytes());
268 println!("rustdoc: [theme-checker] Starting tests!");
269 for theme_file in to_check.iter() {
270 print!(" - Checking \"{}\"...", theme_file);
271 let (success, differences) = theme::test_theme_against(theme_file, &paths, &diag);
272 if !differences.is_empty() || !success {
275 if !differences.is_empty() {
276 println!("{}", differences.join("\n"));
288 if matches.free.is_empty() {
289 diag.struct_err("missing file operand").emit();
292 if matches.free.len() > 1 {
293 diag.struct_err("too many file operands").emit();
296 let input = PathBuf::from(&matches.free[0]);
298 let libs = matches.opt_strs("L").iter()
299 .map(|s| SearchPath::from_cli_opt(s, error_format))
301 let externs = match parse_externs(&matches) {
304 diag.struct_err(&err).emit();
308 let extern_html_root_urls = match parse_extern_html_roots(&matches) {
311 diag.struct_err(err).emit();
316 let test_args = matches.opt_strs("test-args");
317 let test_args: Vec<String> = test_args.iter()
318 .flat_map(|s| s.split_whitespace())
319 .map(|s| s.to_string())
322 let should_test = matches.opt_present("test");
324 let output = matches.opt_str("o")
325 .map(|s| PathBuf::from(&s))
326 .unwrap_or_else(|| PathBuf::from("doc"));
327 let mut cfgs = matches.opt_strs("cfg");
328 cfgs.push("rustdoc".to_string());
330 let extension_css = matches.opt_str("e").map(|s| PathBuf::from(&s));
332 if let Some(ref p) = extension_css {
334 diag.struct_err("option --extend-css argument must be a file").emit();
339 let mut themes = Vec::new();
340 if matches.opt_present("themes") {
341 let paths = theme::load_css_paths(static_files::themes::LIGHT.as_bytes());
343 for (theme_file, theme_s) in matches.opt_strs("themes")
345 .map(|s| (PathBuf::from(&s), s.to_owned())) {
346 if !theme_file.is_file() {
347 diag.struct_err("option --themes arguments must all be files").emit();
350 let (success, ret) = theme::test_theme_against(&theme_file, &paths, &diag);
351 if !success || !ret.is_empty() {
352 diag.struct_err(&format!("invalid theme: \"{}\"", theme_s))
353 .help("check what's wrong with the --theme-checker option")
357 themes.push(theme_file);
361 let mut id_map = html::markdown::IdMap::new();
362 id_map.populate(html::render::initial_ids());
363 let external_html = match ExternalHtml::load(
364 &matches.opt_strs("html-in-header"),
365 &matches.opt_strs("html-before-content"),
366 &matches.opt_strs("html-after-content"),
367 &matches.opt_strs("markdown-before-content"),
368 &matches.opt_strs("markdown-after-content"), &diag, &mut id_map) {
370 None => return Err(3),
373 let edition = matches.opt_str("edition").unwrap_or("2015".to_string());
374 let edition = match edition.parse() {
377 diag.struct_err("could not parse edition").emit();
382 match matches.opt_str("r").as_ref().map(|s| &**s) {
383 Some("rust") | None => {}
385 diag.struct_err(&format!("unknown input format: {}", s)).emit();
390 match matches.opt_str("w").as_ref().map(|s| &**s) {
391 Some("html") | None => {}
393 diag.struct_err(&format!("unknown output format: {}", s)).emit();
398 let index_page = matches.opt_str("index-page").map(|s| PathBuf::from(&s));
399 if let Some(ref index_page) = index_page {
400 if !index_page.is_file() {
401 diag.struct_err("option `--index-page` argument must be a file").emit();
406 let target = matches.opt_str("target").map(|target| {
407 if target.ends_with(".json") {
408 TargetTriple::TargetPath(PathBuf::from(target))
410 TargetTriple::TargetTriple(target)
414 let default_passes = if matches.opt_present("no-defaults") {
415 passes::DefaultPassOption::None
416 } else if matches.opt_present("document-private-items") {
417 passes::DefaultPassOption::Private
419 passes::DefaultPassOption::Default
421 let manual_passes = matches.opt_strs("passes");
423 let crate_name = matches.opt_str("crate-name");
424 let playground_url = matches.opt_str("playground-url");
425 let maybe_sysroot = matches.opt_str("sysroot").map(PathBuf::from);
426 let display_warnings = matches.opt_present("display-warnings");
427 let linker = matches.opt_str("linker").map(PathBuf::from);
428 let sort_modules_alphabetically = !matches.opt_present("sort-modules-by-appearance");
429 let resource_suffix = matches.opt_str("resource-suffix").unwrap_or_default();
430 let enable_minification = !matches.opt_present("disable-minification");
431 let markdown_no_toc = matches.opt_present("markdown-no-toc");
432 let markdown_css = matches.opt_strs("markdown-css");
433 let markdown_playground_url = matches.opt_str("markdown-playground-url");
434 let crate_version = matches.opt_str("crate-version");
435 let enable_index_page = matches.opt_present("enable-index-page") || index_page.is_some();
436 let static_root_path = matches.opt_str("static-root-path");
437 let generate_search_filter = !matches.opt_present("disable-per-crate-search");
438 let persist_doctests = matches.opt_str("persist-doctests").map(PathBuf::from);
440 let (lint_opts, describe_lints, lint_cap) = get_cmd_lint_options(matches, error_format);
465 render_options: RenderOptions {
470 sort_modules_alphabetically,
473 extern_html_root_urls,
481 markdown_playground_url,
482 generate_search_filter,
487 /// Returns whether the file given as `self.input` is a Markdown file.
488 pub fn markdown_input(&self) -> bool {
489 self.input.extension()
490 .map_or(false, |e| e == "md" || e == "markdown")
494 /// Prints deprecation warnings for deprecated options
495 fn check_deprecated_options(matches: &getopts::Matches, diag: &errors::Handler) {
496 let deprecated_flags = [
503 for flag in deprecated_flags.into_iter() {
504 if matches.opt_present(flag) {
505 let mut err = diag.struct_warn(&format!("the '{}' flag is considered deprecated",
507 err.warn("please see https://github.com/rust-lang/rust/issues/44136");
509 if *flag == "no-defaults" {
510 err.help("you may want to use --document-private-items");
517 let removed_flags = [
522 for &flag in removed_flags.iter() {
523 if matches.opt_present(flag) {
524 diag.struct_warn(&format!("the '{}' flag no longer functions", flag))
525 .warn("see CVE-2018-1000622")
531 /// Extracts `--extern-html-root-url` arguments from `matches` and returns a map of crate names to
532 /// the given URLs. If an `--extern-html-root-url` argument was ill-formed, returns an error
533 /// describing the issue.
534 fn parse_extern_html_roots(
535 matches: &getopts::Matches,
536 ) -> Result<BTreeMap<String, String>, &'static str> {
537 let mut externs = BTreeMap::new();
538 for arg in &matches.opt_strs("extern-html-root-url") {
539 let mut parts = arg.splitn(2, '=');
540 let name = parts.next().ok_or("--extern-html-root-url must not be empty")?;
541 let url = parts.next().ok_or("--extern-html-root-url must be of the form name=url")?;
542 externs.insert(name.to_string(), url.to_string());
548 /// Extracts `--extern CRATE=PATH` arguments from `matches` and
549 /// returns a map mapping crate names to their paths or else an
551 // FIXME(eddyb) This shouldn't be duplicated with `rustc::session`.
552 fn parse_externs(matches: &getopts::Matches) -> Result<Externs, String> {
553 let mut externs: BTreeMap<_, BTreeSet<_>> = BTreeMap::new();
554 for arg in &matches.opt_strs("extern") {
555 let mut parts = arg.splitn(2, '=');
556 let name = parts.next().ok_or("--extern value must not be empty".to_string())?;
557 let location = parts.next().map(|s| s.to_string());
558 if location.is_none() && !nightly_options::is_unstable_enabled(matches) {
559 return Err("the `-Z unstable-options` flag must also be passed to \
560 enable `--extern crate_name` without `=path`".to_string());
562 let name = name.to_string();
563 externs.entry(name).or_default().insert(location);
565 Ok(Externs::new(externs))