1 use std::collections::BTreeMap;
2 use std::convert::TryFrom;
5 use std::path::PathBuf;
7 use rustc_data_structures::fx::FxHashMap;
8 use rustc_session::config::{self, parse_crate_types_from_list, parse_externs, CrateType};
9 use rustc_session::config::{
10 build_codegen_options, build_debugging_options, get_cmd_lint_options, host_triple,
13 use rustc_session::config::{CodegenOptions, DebuggingOptions, ErrorOutputType, Externs};
14 use rustc_session::getopts;
15 use rustc_session::lint::Level;
16 use rustc_session::search_paths::SearchPath;
17 use rustc_span::edition::Edition;
18 use rustc_target::spec::TargetTriple;
20 use crate::core::new_handler;
21 use crate::externalfiles::ExternalHtml;
23 use crate::html::markdown::IdMap;
24 use crate::html::render::StylePath;
25 use crate::html::static_files;
27 use crate::passes::{self, Condition, DefaultPassOption};
30 #[derive(Clone, Copy, PartialEq, Eq, Debug)]
31 crate enum OutputFormat {
36 impl Default for OutputFormat {
37 fn default() -> OutputFormat {
43 crate fn is_json(&self) -> bool {
44 matches!(self, OutputFormat::Json)
48 impl TryFrom<&str> for OutputFormat {
51 fn try_from(value: &str) -> Result<Self, Self::Error> {
53 "json" => Ok(OutputFormat::Json),
54 "html" => Ok(OutputFormat::Html),
55 _ => Err(format!("unknown output format `{}`", value)),
60 /// Configuration options for rustdoc.
62 crate struct Options {
63 // Basic options / Options passed directly to rustc
64 /// The crate root or Markdown file to load.
66 /// The name of the crate being documented.
67 crate crate_name: Option<String>,
68 /// Whether or not this is a proc-macro crate
69 crate proc_macro_crate: bool,
70 /// How to format errors and warnings.
71 crate error_format: ErrorOutputType,
72 /// Library search paths to hand to the compiler.
73 crate libs: Vec<SearchPath>,
74 /// Library search paths strings to hand to the compiler.
75 crate lib_strs: Vec<String>,
76 /// The list of external crates to link against.
77 crate externs: Externs,
78 /// The list of external crates strings to link against.
79 crate extern_strs: Vec<String>,
80 /// List of `cfg` flags to hand to the compiler. Always includes `rustdoc`.
81 crate cfgs: Vec<String>,
82 /// Codegen options to hand to the compiler.
83 crate codegen_options: CodegenOptions,
84 /// Codegen options strings to hand to the compiler.
85 crate codegen_options_strs: Vec<String>,
86 /// Debugging (`-Z`) options to pass to the compiler.
87 crate debugging_opts: DebuggingOptions,
88 /// Debugging (`-Z`) options strings to pass to the compiler.
89 crate debugging_opts_strs: Vec<String>,
90 /// The target used to compile the crate against.
91 crate target: TargetTriple,
92 /// Edition used when reading the crate. Defaults to "2015". Also used by default when
93 /// compiling doctests from the crate.
94 crate edition: Edition,
95 /// The path to the sysroot. Used during the compilation process.
96 crate maybe_sysroot: Option<PathBuf>,
97 /// Lint information passed over the command-line.
98 crate lint_opts: Vec<(String, Level)>,
99 /// Whether to ask rustc to describe the lints it knows. Practically speaking, this will not be
100 /// used, since we abort if we have no input file, but it's included for completeness.
101 crate describe_lints: bool,
102 /// What level to cap lints at.
103 crate lint_cap: Option<Level>,
105 // Options specific to running doctests
106 /// Whether we should run doctests instead of generating docs.
107 crate should_test: bool,
108 /// List of arguments to pass to the test harness, if running tests.
109 crate test_args: Vec<String>,
110 /// The working directory in which to run tests.
111 crate test_run_directory: Option<PathBuf>,
112 /// Optional path to persist the doctest executables to, defaults to a
113 /// temporary directory if not set.
114 crate persist_doctests: Option<PathBuf>,
115 /// Runtool to run doctests with
116 crate runtool: Option<String>,
117 /// Arguments to pass to the runtool
118 crate runtool_args: Vec<String>,
119 /// Whether to allow ignoring doctests on a per-target basis
120 /// For example, using ignore-foo to ignore running the doctest on any target that
121 /// contains "foo" as a substring
122 crate enable_per_target_ignores: bool,
124 /// The path to a rustc-like binary to build tests with. If not set, we
125 /// default to loading from `$sysroot/bin/rustc`.
126 crate test_builder: Option<PathBuf>,
128 // Options that affect the documentation process
129 /// The selected default set of passes to use.
131 /// Be aware: This option can come both from the CLI and from crate attributes!
132 crate default_passes: DefaultPassOption,
133 /// Any passes manually selected by the user.
135 /// Be aware: This option can come both from the CLI and from crate attributes!
136 crate manual_passes: Vec<String>,
137 /// Whether to display warnings during doc generation or while gathering doctests. By default,
138 /// all non-rustdoc-specific lints are allowed when generating docs.
139 crate display_warnings: bool,
140 /// Whether to run the `calculate-doc-coverage` pass, which counts the number of public items
141 /// with and without documentation.
142 crate show_coverage: bool,
144 // Options that alter generated documentation pages
145 /// Crate version to note on the sidebar of generated docs.
146 crate crate_version: Option<String>,
147 /// Collected options specific to outputting final pages.
148 crate render_options: RenderOptions,
149 /// The format that we output when rendering.
151 /// Currently used only for the `--show-coverage` option.
152 crate output_format: OutputFormat,
153 /// If this option is set to `true`, rustdoc will only run checks and not generate
155 crate run_check: bool,
158 impl fmt::Debug for Options {
159 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
160 struct FmtExterns<'a>(&'a Externs);
162 impl<'a> fmt::Debug for FmtExterns<'a> {
163 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
164 f.debug_map().entries(self.0.iter()).finish()
168 f.debug_struct("Options")
169 .field("input", &self.input)
170 .field("crate_name", &self.crate_name)
171 .field("proc_macro_crate", &self.proc_macro_crate)
172 .field("error_format", &self.error_format)
173 .field("libs", &self.libs)
174 .field("externs", &FmtExterns(&self.externs))
175 .field("cfgs", &self.cfgs)
176 .field("codegen_options", &"...")
177 .field("debugging_options", &"...")
178 .field("target", &self.target)
179 .field("edition", &self.edition)
180 .field("maybe_sysroot", &self.maybe_sysroot)
181 .field("lint_opts", &self.lint_opts)
182 .field("describe_lints", &self.describe_lints)
183 .field("lint_cap", &self.lint_cap)
184 .field("should_test", &self.should_test)
185 .field("test_args", &self.test_args)
186 .field("test_run_directory", &self.test_run_directory)
187 .field("persist_doctests", &self.persist_doctests)
188 .field("default_passes", &self.default_passes)
189 .field("manual_passes", &self.manual_passes)
190 .field("display_warnings", &self.display_warnings)
191 .field("show_coverage", &self.show_coverage)
192 .field("crate_version", &self.crate_version)
193 .field("render_options", &self.render_options)
194 .field("runtool", &self.runtool)
195 .field("runtool_args", &self.runtool_args)
196 .field("enable-per-target-ignores", &self.enable_per_target_ignores)
197 .field("run_check", &self.run_check)
202 /// Configuration options for the HTML page-creation process.
203 #[derive(Clone, Debug)]
204 crate struct RenderOptions {
205 /// Output directory to generate docs into. Defaults to `doc`.
206 crate output: PathBuf,
207 /// External files to insert into generated pages.
208 crate external_html: ExternalHtml,
209 /// A pre-populated `IdMap` with the default headings and any headings added by Markdown files
210 /// processed by `external_html`.
212 /// If present, playground URL to use in the "Run" button added to code samples.
214 /// Be aware: This option can come both from the CLI and from crate attributes!
215 crate playground_url: Option<String>,
216 /// Whether to sort modules alphabetically on a module page instead of using declaration order.
217 /// `true` by default.
219 // FIXME(misdreavus): the flag name is `--sort-modules-by-appearance` but the meaning is
220 // inverted once read.
221 crate sort_modules_alphabetically: bool,
222 /// List of themes to extend the docs with. Original argument name is included to assist in
223 /// displaying errors if it fails a theme check.
224 crate themes: Vec<StylePath>,
225 /// If present, CSS file that contains rules to add to the default CSS.
226 crate extension_css: Option<PathBuf>,
227 /// A map of crate names to the URL to use instead of querying the crate's `html_root_url`.
228 crate extern_html_root_urls: BTreeMap<String, String>,
229 /// A map of the default settings (values are as for DOM storage API). Keys should lack the
230 /// `rustdoc-` prefix.
231 crate default_settings: FxHashMap<String, String>,
232 /// If present, suffix added to CSS/JavaScript files when referencing them in generated pages.
233 crate resource_suffix: String,
234 /// Whether to run the static CSS/JavaScript through a minifier when outputting them. `true` by
237 // FIXME(misdreavus): the flag name is `--disable-minification` but the meaning is inverted
239 crate enable_minification: bool,
240 /// Whether to create an index page in the root of the output directory. If this is true but
241 /// `enable_index_page` is None, generate a static listing of crates instead.
242 crate enable_index_page: bool,
243 /// A file to use as the index page at the root of the output directory. Overrides
244 /// `enable_index_page` to be true if set.
245 crate index_page: Option<PathBuf>,
246 /// An optional path to use as the location of static files. If not set, uses combinations of
247 /// `../` to reach the documentation root.
248 crate static_root_path: Option<String>,
250 // Options specific to reading standalone Markdown files
251 /// Whether to generate a table of contents on the output file when reading a standalone
253 crate markdown_no_toc: bool,
254 /// Additional CSS files to link in pages generated from standalone Markdown files.
255 crate markdown_css: Vec<String>,
256 /// If present, playground URL to use in the "Run" button added to code samples generated from
257 /// standalone Markdown files. If not present, `playground_url` is used.
258 crate markdown_playground_url: Option<String>,
259 /// If false, the `select` element to have search filtering by crates on rendered docs
260 /// won't be generated.
261 crate generate_search_filter: bool,
262 /// Document items that have lower than `pub` visibility.
263 crate document_private: bool,
264 /// Document items that have `doc(hidden)`.
265 crate document_hidden: bool,
266 /// If `true`, generate a JSON file in the crate folder instead of HTML redirection files.
267 crate generate_redirect_map: bool,
268 crate unstable_features: rustc_feature::UnstableFeatures,
272 /// Parses the given command-line for options. If an error message or other early-return has
273 /// been printed, returns `Err` with the exit code.
274 crate fn from_matches(matches: &getopts::Matches) -> Result<Options, i32> {
275 // Check for unstable options.
276 nightly_options::check_nightly_options(&matches, &opts());
278 if matches.opt_present("h") || matches.opt_present("help") {
279 crate::usage("rustdoc");
281 } else if matches.opt_present("version") {
282 rustc_driver::version("rustdoc", &matches);
286 if matches.opt_strs("passes") == ["list"] {
287 println!("Available passes for running rustdoc:");
288 for pass in passes::PASSES {
289 println!("{:>20} - {}", pass.name, pass.description);
291 println!("\nDefault passes for rustdoc:");
292 for p in passes::DEFAULT_PASSES {
293 print!("{:>20}", p.pass.name);
294 println_condition(p.condition);
297 if nightly_options::match_is_nightly_build(matches) {
298 println!("\nPasses run with `--show-coverage`:");
299 for p in passes::COVERAGE_PASSES {
300 print!("{:>20}", p.pass.name);
301 println_condition(p.condition);
305 fn println_condition(condition: Condition) {
308 Always => println!(),
309 WhenDocumentPrivate => println!(" (when --document-private-items)"),
310 WhenNotDocumentPrivate => println!(" (when not --document-private-items)"),
311 WhenNotDocumentHidden => println!(" (when not --document-hidden-items)"),
318 if matches.opt_strs("print").iter().any(|opt| opt == "unversioned-files") {
319 for file in crate::html::render::FILES_UNVERSIONED.keys() {
320 println!("{}", file);
325 let color = config::parse_color(&matches);
326 let (json_rendered, _artifacts) = config::parse_json(&matches);
327 let error_format = config::parse_error_format(&matches, color, json_rendered);
329 let codegen_options = build_codegen_options(matches, error_format);
330 let debugging_opts = build_debugging_options(matches, error_format);
332 let diag = new_handler(error_format, None, &debugging_opts);
334 // check for deprecated options
335 check_deprecated_options(&matches, &diag);
337 let to_check = matches.opt_strs("check-theme");
338 if !to_check.is_empty() {
339 let paths = theme::load_css_paths(static_files::themes::LIGHT.as_bytes());
342 println!("rustdoc: [check-theme] Starting tests! (Ignoring all other arguments)");
343 for theme_file in to_check.iter() {
344 print!(" - Checking \"{}\"...", theme_file);
345 let (success, differences) = theme::test_theme_against(theme_file, &paths, &diag);
346 if !differences.is_empty() || !success {
349 if !differences.is_empty() {
350 println!("{}", differences.join("\n"));
362 if matches.free.is_empty() {
363 diag.struct_err("missing file operand").emit();
366 if matches.free.len() > 1 {
367 diag.struct_err("too many file operands").emit();
370 let input = PathBuf::from(&matches.free[0]);
375 .map(|s| SearchPath::from_cli_opt(s, error_format))
377 let externs = parse_externs(&matches, &debugging_opts, error_format);
378 let extern_html_root_urls = match parse_extern_html_roots(&matches) {
381 diag.struct_err(err).emit();
386 let default_settings: Vec<Vec<(String, String)>> = vec![
388 .opt_str("default-theme")
392 ("use-system-theme".to_string(), "false".to_string()),
393 ("theme".to_string(), theme.to_string()),
399 .opt_strs("default-setting")
401 .map(|s| match s.split_once('=') {
402 None => (s.clone(), "true".to_string()),
403 Some((k, v)) => (k.to_string(), v.to_string()),
407 let default_settings = default_settings.into_iter().flatten().collect();
409 let test_args = matches.opt_strs("test-args");
410 let test_args: Vec<String> =
411 test_args.iter().flat_map(|s| s.split_whitespace()).map(|s| s.to_string()).collect();
413 let should_test = matches.opt_present("test");
416 matches.opt_str("o").map(|s| PathBuf::from(&s)).unwrap_or_else(|| PathBuf::from("doc"));
417 let cfgs = matches.opt_strs("cfg");
419 let extension_css = matches.opt_str("e").map(|s| PathBuf::from(&s));
421 if let Some(ref p) = extension_css {
423 diag.struct_err("option --extend-css argument must be a file").emit();
428 let mut themes = Vec::new();
429 if matches.opt_present("theme") {
430 let paths = theme::load_css_paths(static_files::themes::LIGHT.as_bytes());
432 for (theme_file, theme_s) in
433 matches.opt_strs("theme").iter().map(|s| (PathBuf::from(&s), s.to_owned()))
435 if !theme_file.is_file() {
436 diag.struct_err(&format!("invalid argument: \"{}\"", theme_s))
437 .help("arguments to --theme must be files")
441 if theme_file.extension() != Some(OsStr::new("css")) {
442 diag.struct_err(&format!("invalid argument: \"{}\"", theme_s)).emit();
445 let (success, ret) = theme::test_theme_against(&theme_file, &paths, &diag);
447 diag.struct_err(&format!("error loading theme file: \"{}\"", theme_s)).emit();
449 } else if !ret.is_empty() {
450 diag.struct_warn(&format!(
451 "theme file \"{}\" is missing CSS rules from the default theme",
454 .warn("the theme may appear incorrect when loaded")
456 "to see what rules are missing, call `rustdoc --check-theme \"{}\"`",
461 themes.push(StylePath { path: theme_file, disabled: true });
465 let edition = config::parse_crate_edition(&matches);
467 let mut id_map = html::markdown::IdMap::new();
468 id_map.populate(&html::render::INITIAL_IDS);
469 let external_html = match ExternalHtml::load(
470 &matches.opt_strs("html-in-header"),
471 &matches.opt_strs("html-before-content"),
472 &matches.opt_strs("html-after-content"),
473 &matches.opt_strs("markdown-before-content"),
474 &matches.opt_strs("markdown-after-content"),
475 nightly_options::match_is_nightly_build(&matches),
482 None => return Err(3),
485 match matches.opt_str("r").as_deref() {
486 Some("rust") | None => {}
488 diag.struct_err(&format!("unknown input format: {}", s)).emit();
493 let index_page = matches.opt_str("index-page").map(|s| PathBuf::from(&s));
494 if let Some(ref index_page) = index_page {
495 if !index_page.is_file() {
496 diag.struct_err("option `--index-page` argument must be a file").emit();
502 matches.opt_str("target").map_or(TargetTriple::from_triple(host_triple()), |target| {
503 if target.ends_with(".json") {
504 TargetTriple::TargetPath(PathBuf::from(target))
506 TargetTriple::TargetTriple(target)
510 let show_coverage = matches.opt_present("show-coverage");
512 let default_passes = if matches.opt_present("no-defaults") {
513 passes::DefaultPassOption::None
514 } else if show_coverage {
515 passes::DefaultPassOption::Coverage
517 passes::DefaultPassOption::Default
519 let manual_passes = matches.opt_strs("passes");
521 let crate_types = match parse_crate_types_from_list(matches.opt_strs("crate-type")) {
524 diag.struct_err(&format!("unknown crate type: {}", e)).emit();
529 let output_format = match matches.opt_str("output-format") {
530 Some(s) => match OutputFormat::try_from(s.as_str()) {
533 && !(show_coverage || nightly_options::match_is_nightly_build(matches))
535 diag.struct_err("json output format isn't supported for doc generation")
538 } else if !out_fmt.is_json() && show_coverage {
540 "html output format isn't supported for the --show-coverage option",
548 diag.struct_err(&e).emit();
552 None => OutputFormat::default(),
554 let crate_name = matches.opt_str("crate-name");
555 let proc_macro_crate = crate_types.contains(&CrateType::ProcMacro);
556 let playground_url = matches.opt_str("playground-url");
557 let maybe_sysroot = matches.opt_str("sysroot").map(PathBuf::from);
558 let display_warnings = matches.opt_present("display-warnings");
559 let sort_modules_alphabetically = !matches.opt_present("sort-modules-by-appearance");
560 let resource_suffix = matches.opt_str("resource-suffix").unwrap_or_default();
561 let enable_minification = !matches.opt_present("disable-minification");
562 let markdown_no_toc = matches.opt_present("markdown-no-toc");
563 let markdown_css = matches.opt_strs("markdown-css");
564 let markdown_playground_url = matches.opt_str("markdown-playground-url");
565 let crate_version = matches.opt_str("crate-version");
566 let enable_index_page = matches.opt_present("enable-index-page") || index_page.is_some();
567 let static_root_path = matches.opt_str("static-root-path");
568 let generate_search_filter = !matches.opt_present("disable-per-crate-search");
569 let test_run_directory = matches.opt_str("test-run-directory").map(PathBuf::from);
570 let persist_doctests = matches.opt_str("persist-doctests").map(PathBuf::from);
571 let test_builder = matches.opt_str("test-builder").map(PathBuf::from);
572 let codegen_options_strs = matches.opt_strs("C");
573 let debugging_opts_strs = matches.opt_strs("Z");
574 let lib_strs = matches.opt_strs("L");
575 let extern_strs = matches.opt_strs("extern");
576 let runtool = matches.opt_str("runtool");
577 let runtool_args = matches.opt_strs("runtool-arg");
578 let enable_per_target_ignores = matches.opt_present("enable-per-target-ignores");
579 let document_private = matches.opt_present("document-private-items");
580 let document_hidden = matches.opt_present("document-hidden-items");
581 let run_check = matches.opt_present("check");
582 let generate_redirect_map = matches.opt_present("generate-redirect-map");
584 let (lint_opts, describe_lints, lint_cap) = get_cmd_lint_options(matches, error_format);
596 codegen_options_strs,
616 enable_per_target_ignores,
619 render_options: RenderOptions {
624 sort_modules_alphabetically,
627 extern_html_root_urls,
636 markdown_playground_url,
637 generate_search_filter,
640 generate_redirect_map,
641 unstable_features: rustc_feature::UnstableFeatures::from_environment(
642 crate_name.as_deref(),
650 /// Returns `true` if the file given as `self.input` is a Markdown file.
651 crate fn markdown_input(&self) -> bool {
652 self.input.extension().map_or(false, |e| e == "md" || e == "markdown")
656 /// Prints deprecation warnings for deprecated options
657 fn check_deprecated_options(matches: &getopts::Matches, diag: &rustc_errors::Handler) {
658 let deprecated_flags = ["input-format", "output-format", "no-defaults", "passes"];
660 for flag in deprecated_flags.iter() {
661 if matches.opt_present(flag) {
662 if *flag == "output-format"
663 && (matches.opt_present("show-coverage")
664 || nightly_options::match_is_nightly_build(matches))
668 let mut err = diag.struct_warn(&format!("the `{}` flag is deprecated", flag));
670 "see issue #44136 <https://github.com/rust-lang/rust/issues/44136> \
671 for more information",
674 if *flag == "no-defaults" {
675 err.help("you may want to use --document-private-items");
682 let removed_flags = ["plugins", "plugin-path"];
684 for &flag in removed_flags.iter() {
685 if matches.opt_present(flag) {
686 diag.struct_warn(&format!("the '{}' flag no longer functions", flag))
687 .warn("see CVE-2018-1000622")
693 /// Extracts `--extern-html-root-url` arguments from `matches` and returns a map of crate names to
694 /// the given URLs. If an `--extern-html-root-url` argument was ill-formed, returns an error
695 /// describing the issue.
696 fn parse_extern_html_roots(
697 matches: &getopts::Matches,
698 ) -> Result<BTreeMap<String, String>, &'static str> {
699 let mut externs = BTreeMap::new();
700 for arg in &matches.opt_strs("extern-html-root-url") {
702 arg.split_once('=').ok_or("--extern-html-root-url must be of the form name=url")?;
703 externs.insert(name.to_string(), url.to_string());