1 use std::collections::BTreeMap;
3 use std::path::PathBuf;
7 use rustc::lint::Level;
9 use rustc::session::config::{CrateType, parse_crate_types_from_list};
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, host_triple, ExternEntry};
13 use rustc::session::search_paths::SearchPath;
15 use rustc_target::spec::TargetTriple;
16 use syntax::edition::{Edition, DEFAULT_EDITION};
18 use crate::core::new_handler;
19 use crate::externalfiles::ExternalHtml;
21 use crate::html::{static_files};
22 use crate::html::markdown::{IdMap};
24 use crate::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 /// Whether or not this is a proc-macro crate
37 pub proc_macro_crate: bool,
38 /// How to format errors and warnings.
39 pub error_format: ErrorOutputType,
40 /// Library search paths to hand to the compiler.
41 pub libs: Vec<SearchPath>,
42 /// Library search paths strings to hand to the compiler.
43 pub lib_strs: Vec<String>,
44 /// The list of external crates to link against.
46 /// The list of external crates strings to link against.
47 pub extern_strs: Vec<String>,
48 /// List of `cfg` flags to hand to the compiler. Always includes `rustdoc`.
49 pub cfgs: Vec<String>,
50 /// Codegen options to hand to the compiler.
51 pub codegen_options: CodegenOptions,
52 /// Codegen options strings to hand to the compiler.
53 pub codegen_options_strs: Vec<String>,
54 /// Debugging (`-Z`) options to pass to the compiler.
55 pub debugging_options: DebuggingOptions,
56 /// Debugging (`-Z`) options strings to pass to the compiler.
57 pub debugging_options_strs: Vec<String>,
58 /// The target used to compile the crate against.
59 pub target: TargetTriple,
60 /// Edition used when reading the crate. Defaults to "2015". Also used by default when
61 /// compiling doctests from the crate.
63 /// The path to the sysroot. Used during the compilation process.
64 pub maybe_sysroot: Option<PathBuf>,
65 /// Lint information passed over the command-line.
66 pub lint_opts: Vec<(String, Level)>,
67 /// Whether to ask rustc to describe the lints it knows. Practically speaking, this will not be
68 /// used, since we abort if we have no input file, but it's included for completeness.
69 pub describe_lints: bool,
70 /// What level to cap lints at.
71 pub lint_cap: Option<Level>,
73 // Options specific to running doctests
75 /// Whether we should run doctests instead of generating docs.
76 pub should_test: bool,
77 /// List of arguments to pass to the test harness, if running tests.
78 pub test_args: Vec<String>,
79 /// Optional path to persist the doctest executables to, defaults to a
80 /// temporary directory if not set.
81 pub persist_doctests: Option<PathBuf>,
82 /// Runtool to run doctests with
83 pub runtool: Option<String>,
84 /// Arguments to pass to the runtool
85 pub runtool_args: Vec<String>,
86 /// Whether to allow ignoring doctests on a per-target basis
87 /// For example, using ignore-foo to ignore running the doctest on any target that
88 /// contains "foo" as a substring
89 pub enable_per_target_ignores: bool,
91 /// The path to a rustc-like binary to build tests with. If not set, we
92 /// default to loading from $sysroot/bin/rustc.
93 pub test_builder: Option<PathBuf>,
95 // Options that affect the documentation process
97 /// The selected default set of passes to use.
99 /// Be aware: This option can come both from the CLI and from crate attributes!
100 pub default_passes: DefaultPassOption,
101 /// Any passes manually selected by the user.
103 /// Be aware: This option can come both from the CLI and from crate attributes!
104 pub manual_passes: Vec<String>,
105 /// Whether to display warnings during doc generation or while gathering doctests. By default,
106 /// all non-rustdoc-specific lints are allowed when generating docs.
107 pub display_warnings: bool,
108 /// Whether to run the `calculate-doc-coverage` pass, which counts the number of public items
109 /// with and without documentation.
110 pub show_coverage: bool,
112 // Options that alter generated documentation pages
114 /// Crate version to note on the sidebar of generated docs.
115 pub crate_version: Option<String>,
116 /// Collected options specific to outputting final pages.
117 pub render_options: RenderOptions,
120 impl fmt::Debug for Options {
121 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
122 struct FmtExterns<'a>(&'a Externs);
124 impl<'a> fmt::Debug for FmtExterns<'a> {
125 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
127 .entries(self.0.iter())
132 f.debug_struct("Options")
133 .field("input", &self.input)
134 .field("crate_name", &self.crate_name)
135 .field("proc_macro_crate", &self.proc_macro_crate)
136 .field("error_format", &self.error_format)
137 .field("libs", &self.libs)
138 .field("externs", &FmtExterns(&self.externs))
139 .field("cfgs", &self.cfgs)
140 .field("codegen_options", &"...")
141 .field("debugging_options", &"...")
142 .field("target", &self.target)
143 .field("edition", &self.edition)
144 .field("maybe_sysroot", &self.maybe_sysroot)
145 .field("lint_opts", &self.lint_opts)
146 .field("describe_lints", &self.describe_lints)
147 .field("lint_cap", &self.lint_cap)
148 .field("should_test", &self.should_test)
149 .field("test_args", &self.test_args)
150 .field("persist_doctests", &self.persist_doctests)
151 .field("default_passes", &self.default_passes)
152 .field("manual_passes", &self.manual_passes)
153 .field("display_warnings", &self.display_warnings)
154 .field("show_coverage", &self.show_coverage)
155 .field("crate_version", &self.crate_version)
156 .field("render_options", &self.render_options)
157 .field("runtool", &self.runtool)
158 .field("runtool_args", &self.runtool_args)
159 .field("enable-per-target-ignores", &self.enable_per_target_ignores)
164 /// Configuration options for the HTML page-creation process.
165 #[derive(Clone, Debug)]
166 pub struct RenderOptions {
167 /// Output directory to generate docs into. Defaults to `doc`.
169 /// External files to insert into generated pages.
170 pub external_html: ExternalHtml,
171 /// A pre-populated `IdMap` with the default headings and any headings added by Markdown files
172 /// processed by `external_html`.
174 /// If present, playground URL to use in the "Run" button added to code samples.
176 /// Be aware: This option can come both from the CLI and from crate attributes!
177 pub playground_url: Option<String>,
178 /// Whether to sort modules alphabetically on a module page instead of using declaration order.
179 /// `true` by default.
181 // FIXME(misdreavus): the flag name is `--sort-modules-by-appearance` but the meaning is
182 // inverted once read.
183 pub sort_modules_alphabetically: bool,
184 /// List of themes to extend the docs with. Original argument name is included to assist in
185 /// displaying errors if it fails a theme check.
186 pub themes: Vec<PathBuf>,
187 /// If present, CSS file that contains rules to add to the default CSS.
188 pub extension_css: Option<PathBuf>,
189 /// A map of crate names to the URL to use instead of querying the crate's `html_root_url`.
190 pub extern_html_root_urls: BTreeMap<String, String>,
191 /// If present, suffix added to CSS/JavaScript files when referencing them in generated pages.
192 pub resource_suffix: String,
193 /// Whether to run the static CSS/JavaScript through a minifier when outputting them. `true` by
196 // FIXME(misdreavus): the flag name is `--disable-minification` but the meaning is inverted
198 pub enable_minification: bool,
199 /// Whether to create an index page in the root of the output directory. If this is true but
200 /// `enable_index_page` is None, generate a static listing of crates instead.
201 pub enable_index_page: bool,
202 /// A file to use as the index page at the root of the output directory. Overrides
203 /// `enable_index_page` to be true if set.
204 pub index_page: Option<PathBuf>,
205 /// An optional path to use as the location of static files. If not set, uses combinations of
206 /// `../` to reach the documentation root.
207 pub static_root_path: Option<String>,
209 // Options specific to reading standalone Markdown files
211 /// Whether to generate a table of contents on the output file when reading a standalone
213 pub markdown_no_toc: bool,
214 /// Additional CSS files to link in pages generated from standalone Markdown files.
215 pub markdown_css: Vec<String>,
216 /// If present, playground URL to use in the "Run" button added to code samples generated from
217 /// standalone Markdown files. If not present, `playground_url` is used.
218 pub markdown_playground_url: Option<String>,
219 /// If false, the `select` element to have search filtering by crates on rendered docs
220 /// won't be generated.
221 pub generate_search_filter: bool,
222 /// Option (disabled by default) to generate files used by RLS and some other tools.
223 pub generate_redirect_pages: bool,
227 /// Parses the given command-line for options. If an error message or other early-return has
228 /// been printed, returns `Err` with the exit code.
229 pub fn from_matches(matches: &getopts::Matches) -> Result<Options, i32> {
230 // Check for unstable options.
231 nightly_options::check_nightly_options(&matches, &opts());
233 if matches.opt_present("h") || matches.opt_present("help") {
234 crate::usage("rustdoc");
236 } else if matches.opt_present("version") {
237 rustc_driver::version("rustdoc", &matches);
241 if matches.opt_strs("passes") == ["list"] {
242 println!("Available passes for running rustdoc:");
243 for pass in passes::PASSES {
244 println!("{:>20} - {}", pass.name, pass.description);
246 println!("\nDefault passes for rustdoc:");
247 for pass in passes::DEFAULT_PASSES {
248 println!("{:>20}", pass.name);
250 println!("\nPasses run with `--document-private-items`:");
251 for pass in passes::DEFAULT_PRIVATE_PASSES {
252 println!("{:>20}", pass.name);
255 if nightly_options::is_nightly_build() {
256 println!("\nPasses run with `--show-coverage`:");
257 for pass in passes::DEFAULT_COVERAGE_PASSES {
258 println!("{:>20}", pass.name);
260 println!("\nPasses run with `--show-coverage --document-private-items`:");
261 for pass in passes::PRIVATE_COVERAGE_PASSES {
262 println!("{:>20}", pass.name);
269 let color = session::config::parse_color(&matches);
270 let (json_rendered, _artifacts) = session::config::parse_json(&matches);
271 let error_format = session::config::parse_error_format(&matches, color, json_rendered);
273 let codegen_options = build_codegen_options(matches, error_format);
274 let debugging_options = build_debugging_options(matches, error_format);
276 let diag = new_handler(error_format,
278 debugging_options.treat_err_as_bug,
279 debugging_options.ui_testing);
281 // check for deprecated options
282 check_deprecated_options(&matches, &diag);
284 let to_check = matches.opt_strs("theme-checker");
285 if !to_check.is_empty() {
286 let paths = theme::load_css_paths(static_files::themes::LIGHT.as_bytes());
289 println!("rustdoc: [theme-checker] Starting tests!");
290 for theme_file in to_check.iter() {
291 print!(" - Checking \"{}\"...", theme_file);
292 let (success, differences) = theme::test_theme_against(theme_file, &paths, &diag);
293 if !differences.is_empty() || !success {
296 if !differences.is_empty() {
297 println!("{}", differences.join("\n"));
309 if matches.free.is_empty() {
310 diag.struct_err("missing file operand").emit();
313 if matches.free.len() > 1 {
314 diag.struct_err("too many file operands").emit();
317 let input = PathBuf::from(&matches.free[0]);
319 let libs = matches.opt_strs("L").iter()
320 .map(|s| SearchPath::from_cli_opt(s, error_format))
322 let externs = match parse_externs(&matches) {
325 diag.struct_err(&err).emit();
329 let extern_html_root_urls = match parse_extern_html_roots(&matches) {
332 diag.struct_err(err).emit();
337 let test_args = matches.opt_strs("test-args");
338 let test_args: Vec<String> = test_args.iter()
339 .flat_map(|s| s.split_whitespace())
340 .map(|s| s.to_string())
343 let should_test = matches.opt_present("test");
345 let output = matches.opt_str("o")
346 .map(|s| PathBuf::from(&s))
347 .unwrap_or_else(|| PathBuf::from("doc"));
348 let cfgs = matches.opt_strs("cfg");
350 let extension_css = matches.opt_str("e").map(|s| PathBuf::from(&s));
352 if let Some(ref p) = extension_css {
354 diag.struct_err("option --extend-css argument must be a file").emit();
359 let mut themes = Vec::new();
360 if matches.opt_present("themes") {
361 let paths = theme::load_css_paths(static_files::themes::LIGHT.as_bytes());
363 for (theme_file, theme_s) in matches.opt_strs("themes")
365 .map(|s| (PathBuf::from(&s), s.to_owned())) {
366 if !theme_file.is_file() {
367 diag.struct_err(&format!("invalid file: \"{}\"", theme_s))
368 .help("option --themes arguments must all be files")
372 let (success, ret) = theme::test_theme_against(&theme_file, &paths, &diag);
374 diag.struct_warn(&format!("error loading theme file: \"{}\"", theme_s)).emit();
376 } else if !ret.is_empty() {
377 diag.struct_warn(&format!("theme file \"{}\" is missing CSS rules from the \
378 default theme", theme_s))
379 .warn("the theme may appear incorrect when loaded")
380 .help(&format!("to see what rules are missing, call `rustdoc \
381 --theme-checker \"{}\"`", theme_s))
384 themes.push(theme_file);
388 let edition = if let Some(e) = matches.opt_str("edition") {
392 diag.struct_err("could not parse edition").emit();
400 let mut id_map = html::markdown::IdMap::new();
401 id_map.populate(html::render::initial_ids());
402 let external_html = match ExternalHtml::load(
403 &matches.opt_strs("html-in-header"),
404 &matches.opt_strs("html-before-content"),
405 &matches.opt_strs("html-after-content"),
406 &matches.opt_strs("markdown-before-content"),
407 &matches.opt_strs("markdown-after-content"),
408 &diag, &mut id_map, edition, &None) {
410 None => return Err(3),
413 match matches.opt_str("r").as_ref().map(|s| &**s) {
414 Some("rust") | None => {}
416 diag.struct_err(&format!("unknown input format: {}", s)).emit();
421 match matches.opt_str("w").as_ref().map(|s| &**s) {
422 Some("html") | None => {}
424 diag.struct_err(&format!("unknown output format: {}", s)).emit();
429 let index_page = matches.opt_str("index-page").map(|s| PathBuf::from(&s));
430 if let Some(ref index_page) = index_page {
431 if !index_page.is_file() {
432 diag.struct_err("option `--index-page` argument must be a file").emit();
437 let target = matches.opt_str("target").map_or(
438 TargetTriple::from_triple(host_triple()),
440 if target.ends_with(".json") {
441 TargetTriple::TargetPath(PathBuf::from(target))
443 TargetTriple::TargetTriple(target)
447 let show_coverage = matches.opt_present("show-coverage");
448 let document_private = matches.opt_present("document-private-items");
450 let default_passes = if matches.opt_present("no-defaults") {
451 passes::DefaultPassOption::None
452 } else if show_coverage && document_private {
453 passes::DefaultPassOption::PrivateCoverage
454 } else if show_coverage {
455 passes::DefaultPassOption::Coverage
456 } else if document_private {
457 passes::DefaultPassOption::Private
459 passes::DefaultPassOption::Default
461 let manual_passes = matches.opt_strs("passes");
463 let crate_types = match parse_crate_types_from_list(matches.opt_strs("crate-type")) {
466 diag.struct_err(&format!("unknown crate type: {}", e)).emit();
471 let crate_name = matches.opt_str("crate-name");
472 let proc_macro_crate = crate_types.contains(&CrateType::ProcMacro);
473 let playground_url = matches.opt_str("playground-url");
474 let maybe_sysroot = matches.opt_str("sysroot").map(PathBuf::from);
475 let display_warnings = matches.opt_present("display-warnings");
476 let sort_modules_alphabetically = !matches.opt_present("sort-modules-by-appearance");
477 let resource_suffix = matches.opt_str("resource-suffix").unwrap_or_default();
478 let enable_minification = !matches.opt_present("disable-minification");
479 let markdown_no_toc = matches.opt_present("markdown-no-toc");
480 let markdown_css = matches.opt_strs("markdown-css");
481 let markdown_playground_url = matches.opt_str("markdown-playground-url");
482 let crate_version = matches.opt_str("crate-version");
483 let enable_index_page = matches.opt_present("enable-index-page") || index_page.is_some();
484 let static_root_path = matches.opt_str("static-root-path");
485 let generate_search_filter = !matches.opt_present("disable-per-crate-search");
486 let persist_doctests = matches.opt_str("persist-doctests").map(PathBuf::from);
487 let generate_redirect_pages = matches.opt_present("generate-redirect-pages");
488 let test_builder = matches.opt_str("test-builder").map(PathBuf::from);
489 let codegen_options_strs = matches.opt_strs("C");
490 let debugging_options_strs = matches.opt_strs("Z");
491 let lib_strs = matches.opt_strs("L");
492 let extern_strs = matches.opt_strs("extern");
493 let runtool = matches.opt_str("runtool");
494 let runtool_args = matches.opt_strs("runtool-arg");
495 let enable_per_target_ignores = matches.opt_present("enable-per-target-ignores");
497 let (lint_opts, describe_lints, lint_cap) = get_cmd_lint_options(matches, error_format);
510 codegen_options_strs,
512 debugging_options_strs,
529 enable_per_target_ignores,
531 render_options: RenderOptions {
536 sort_modules_alphabetically,
539 extern_html_root_urls,
547 markdown_playground_url,
548 generate_search_filter,
549 generate_redirect_pages,
554 /// Returns `true` if the file given as `self.input` is a Markdown file.
555 pub fn markdown_input(&self) -> bool {
556 self.input.extension()
557 .map_or(false, |e| e == "md" || e == "markdown")
561 /// Prints deprecation warnings for deprecated options
562 fn check_deprecated_options(matches: &getopts::Matches, diag: &errors::Handler) {
563 let deprecated_flags = [
570 for flag in deprecated_flags.iter() {
571 if matches.opt_present(flag) {
572 let mut err = diag.struct_warn(&format!("the '{}' flag is considered deprecated",
574 err.warn("please see https://github.com/rust-lang/rust/issues/44136");
576 if *flag == "no-defaults" {
577 err.help("you may want to use --document-private-items");
584 let removed_flags = [
589 for &flag in removed_flags.iter() {
590 if matches.opt_present(flag) {
591 diag.struct_warn(&format!("the '{}' flag no longer functions", flag))
592 .warn("see CVE-2018-1000622")
598 /// Extracts `--extern-html-root-url` arguments from `matches` and returns a map of crate names to
599 /// the given URLs. If an `--extern-html-root-url` argument was ill-formed, returns an error
600 /// describing the issue.
601 fn parse_extern_html_roots(
602 matches: &getopts::Matches,
603 ) -> Result<BTreeMap<String, String>, &'static str> {
604 let mut externs = BTreeMap::new();
605 for arg in &matches.opt_strs("extern-html-root-url") {
606 let mut parts = arg.splitn(2, '=');
607 let name = parts.next().ok_or("--extern-html-root-url must not be empty")?;
608 let url = parts.next().ok_or("--extern-html-root-url must be of the form name=url")?;
609 externs.insert(name.to_string(), url.to_string());
615 /// Extracts `--extern CRATE=PATH` arguments from `matches` and
616 /// returns a map mapping crate names to their paths or else an
618 /// Also handles `--extern-private` which for the purposes of rustdoc
619 /// we can treat as `--extern`
620 // FIXME(eddyb) This shouldn't be duplicated with `rustc::session`.
621 fn parse_externs(matches: &getopts::Matches) -> Result<Externs, String> {
622 let mut externs: BTreeMap<_, ExternEntry> = BTreeMap::new();
623 for arg in matches.opt_strs("extern").iter().chain(matches.opt_strs("extern-private").iter()) {
624 let mut parts = arg.splitn(2, '=');
625 let name = parts.next().ok_or("--extern value must not be empty".to_string())?;
626 let location = parts.next().map(|s| s.to_string());
627 let name = name.to_string();
628 // For Rustdoc purposes, we can treat all externs as public
631 .locations.insert(location.clone());
633 Ok(Externs::new(externs))