1 use std::collections::BTreeMap;
2 use std::convert::TryFrom;
3 use std::ffi::OsStr;
4 use std::fmt;
5 use std::path::PathBuf;
6 use std::str::FromStr;
7
8 use rustc_data_structures::fx::FxHashMap;
9 use rustc_session::config::{
10 self, parse_crate_types_from_list, parse_externs, parse_target_triple, CrateType,
11 };
12 use rustc_session::config::{get_cmd_lint_options, nightly_options};
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;
19
20 use crate::core::new_handler;
21 use crate::externalfiles::ExternalHtml;
22 use crate::html;
23 use crate::html::markdown::IdMap;
24 use crate::html::render::StylePath;
25 use crate::html::static_files;
26 use crate::opts;
27 use crate::passes::{self, Condition, DefaultPassOption};
28 use crate::scrape_examples::{AllCallLocations, ScrapeExamplesOptions};
29 use crate::theme;
30
31 #[derive(Clone, Copy, PartialEq, Eq, Debug)]
32 crate enum OutputFormat {
33 Json,
34 Html,
35 }
36
37 impl Default for OutputFormat {
default() -> OutputFormat38 fn default() -> OutputFormat {
39 OutputFormat::Html
40 }
41 }
42
43 impl OutputFormat {
is_json(&self) -> bool44 crate fn is_json(&self) -> bool {
45 matches!(self, OutputFormat::Json)
46 }
47 }
48
49 impl TryFrom<&str> for OutputFormat {
50 type Error = String;
51
try_from(value: &str) -> Result<Self, Self::Error>52 fn try_from(value: &str) -> Result<Self, Self::Error> {
53 match value {
54 "json" => Ok(OutputFormat::Json),
55 "html" => Ok(OutputFormat::Html),
56 _ => Err(format!("unknown output format `{}`", value)),
57 }
58 }
59 }
60
61 /// Configuration options for rustdoc.
62 #[derive(Clone)]
63 crate struct Options {
64 // Basic options / Options passed directly to rustc
65 /// The crate root or Markdown file to load.
66 crate input: PathBuf,
67 /// The name of the crate being documented.
68 crate crate_name: Option<String>,
69 /// Whether or not this is a proc-macro crate
70 crate proc_macro_crate: bool,
71 /// How to format errors and warnings.
72 crate error_format: ErrorOutputType,
73 /// Library search paths to hand to the compiler.
74 crate libs: Vec<SearchPath>,
75 /// Library search paths strings to hand to the compiler.
76 crate lib_strs: Vec<String>,
77 /// The list of external crates to link against.
78 crate externs: Externs,
79 /// The list of external crates strings to link against.
80 crate extern_strs: Vec<String>,
81 /// List of `cfg` flags to hand to the compiler. Always includes `rustdoc`.
82 crate cfgs: Vec<String>,
83 /// Codegen options to hand to the compiler.
84 crate codegen_options: CodegenOptions,
85 /// Codegen options strings to hand to the compiler.
86 crate codegen_options_strs: Vec<String>,
87 /// Debugging (`-Z`) options to pass to the compiler.
88 crate debugging_opts: DebuggingOptions,
89 /// Debugging (`-Z`) options strings to pass to the compiler.
90 crate debugging_opts_strs: Vec<String>,
91 /// The target used to compile the crate against.
92 crate target: TargetTriple,
93 /// Edition used when reading the crate. Defaults to "2015". Also used by default when
94 /// compiling doctests from the crate.
95 crate edition: Edition,
96 /// The path to the sysroot. Used during the compilation process.
97 crate maybe_sysroot: Option<PathBuf>,
98 /// Lint information passed over the command-line.
99 crate lint_opts: Vec<(String, Level)>,
100 /// Whether to ask rustc to describe the lints it knows.
101 crate describe_lints: bool,
102 /// What level to cap lints at.
103 crate lint_cap: Option<Level>,
104
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,
123 /// Do not run doctests, compile them if should_test is active.
124 crate no_run: bool,
125
126 /// The path to a rustc-like binary to build tests with. If not set, we
127 /// default to loading from `$sysroot/bin/rustc`.
128 crate test_builder: Option<PathBuf>,
129
130 // Options that affect the documentation process
131 /// The selected default set of passes to use.
132 ///
133 /// Be aware: This option can come both from the CLI and from crate attributes!
134 crate default_passes: DefaultPassOption,
135 /// Any passes manually selected by the user.
136 ///
137 /// Be aware: This option can come both from the CLI and from crate attributes!
138 crate manual_passes: Vec<String>,
139 /// Whether to run the `calculate-doc-coverage` pass, which counts the number of public items
140 /// with and without documentation.
141 crate show_coverage: bool,
142
143 // Options that alter generated documentation pages
144 /// Crate version to note on the sidebar of generated docs.
145 crate crate_version: Option<String>,
146 /// Collected options specific to outputting final pages.
147 crate render_options: RenderOptions,
148 /// The format that we output when rendering.
149 ///
150 /// Currently used only for the `--show-coverage` option.
151 crate output_format: OutputFormat,
152 /// If this option is set to `true`, rustdoc will only run checks and not generate
153 /// documentation.
154 crate run_check: bool,
155 /// Whether doctests should emit unused externs
156 crate json_unused_externs: bool,
157 /// Whether to skip capturing stdout and stderr of tests.
158 crate nocapture: bool,
159
160 /// Configuration for scraping examples from the current crate. If this option is Some(..) then
161 /// the compiler will scrape examples and not generate documentation.
162 crate scrape_examples_options: Option<ScrapeExamplesOptions>,
163 }
164
165 impl fmt::Debug for Options {
fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result166 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
167 struct FmtExterns<'a>(&'a Externs);
168
169 impl<'a> fmt::Debug for FmtExterns<'a> {
170 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
171 f.debug_map().entries(self.0.iter()).finish()
172 }
173 }
174
175 f.debug_struct("Options")
176 .field("input", &self.input)
177 .field("crate_name", &self.crate_name)
178 .field("proc_macro_crate", &self.proc_macro_crate)
179 .field("error_format", &self.error_format)
180 .field("libs", &self.libs)
181 .field("externs", &FmtExterns(&self.externs))
182 .field("cfgs", &self.cfgs)
183 .field("codegen_options", &"...")
184 .field("debugging_options", &"...")
185 .field("target", &self.target)
186 .field("edition", &self.edition)
187 .field("maybe_sysroot", &self.maybe_sysroot)
188 .field("lint_opts", &self.lint_opts)
189 .field("describe_lints", &self.describe_lints)
190 .field("lint_cap", &self.lint_cap)
191 .field("should_test", &self.should_test)
192 .field("test_args", &self.test_args)
193 .field("test_run_directory", &self.test_run_directory)
194 .field("persist_doctests", &self.persist_doctests)
195 .field("default_passes", &self.default_passes)
196 .field("manual_passes", &self.manual_passes)
197 .field("show_coverage", &self.show_coverage)
198 .field("crate_version", &self.crate_version)
199 .field("render_options", &self.render_options)
200 .field("runtool", &self.runtool)
201 .field("runtool_args", &self.runtool_args)
202 .field("enable-per-target-ignores", &self.enable_per_target_ignores)
203 .field("run_check", &self.run_check)
204 .field("no_run", &self.no_run)
205 .field("nocapture", &self.nocapture)
206 .field("scrape_examples_options", &self.scrape_examples_options)
207 .finish()
208 }
209 }
210
211 /// Configuration options for the HTML page-creation process.
212 #[derive(Clone, Debug)]
213 crate struct RenderOptions {
214 /// Output directory to generate docs into. Defaults to `doc`.
215 crate output: PathBuf,
216 /// External files to insert into generated pages.
217 crate external_html: ExternalHtml,
218 /// A pre-populated `IdMap` with the default headings and any headings added by Markdown files
219 /// processed by `external_html`.
220 crate id_map: IdMap,
221 /// If present, playground URL to use in the "Run" button added to code samples.
222 ///
223 /// Be aware: This option can come both from the CLI and from crate attributes!
224 crate playground_url: Option<String>,
225 /// Whether to sort modules alphabetically on a module page instead of using declaration order.
226 /// `true` by default.
227 //
228 // FIXME(misdreavus): the flag name is `--sort-modules-by-appearance` but the meaning is
229 // inverted once read.
230 crate sort_modules_alphabetically: bool,
231 /// List of themes to extend the docs with. Original argument name is included to assist in
232 /// displaying errors if it fails a theme check.
233 crate themes: Vec<StylePath>,
234 /// If present, CSS file that contains rules to add to the default CSS.
235 crate extension_css: Option<PathBuf>,
236 /// A map of crate names to the URL to use instead of querying the crate's `html_root_url`.
237 crate extern_html_root_urls: BTreeMap<String, String>,
238 /// Whether to give precedence to `html_root_url` or `--exten-html-root-url`.
239 crate extern_html_root_takes_precedence: bool,
240 /// A map of the default settings (values are as for DOM storage API). Keys should lack the
241 /// `rustdoc-` prefix.
242 crate default_settings: FxHashMap<String, String>,
243 /// If present, suffix added to CSS/JavaScript files when referencing them in generated pages.
244 crate resource_suffix: String,
245 /// Whether to run the static CSS/JavaScript through a minifier when outputting them. `true` by
246 /// default.
247 //
248 // FIXME(misdreavus): the flag name is `--disable-minification` but the meaning is inverted
249 // once read.
250 crate enable_minification: bool,
251 /// Whether to create an index page in the root of the output directory. If this is true but
252 /// `enable_index_page` is None, generate a static listing of crates instead.
253 crate enable_index_page: bool,
254 /// A file to use as the index page at the root of the output directory. Overrides
255 /// `enable_index_page` to be true if set.
256 crate index_page: Option<PathBuf>,
257 /// An optional path to use as the location of static files. If not set, uses combinations of
258 /// `../` to reach the documentation root.
259 crate static_root_path: Option<String>,
260
261 // Options specific to reading standalone Markdown files
262 /// Whether to generate a table of contents on the output file when reading a standalone
263 /// Markdown file.
264 crate markdown_no_toc: bool,
265 /// Additional CSS files to link in pages generated from standalone Markdown files.
266 crate markdown_css: Vec<String>,
267 /// If present, playground URL to use in the "Run" button added to code samples generated from
268 /// standalone Markdown files. If not present, `playground_url` is used.
269 crate markdown_playground_url: Option<String>,
270 /// If false, the `select` element to have search filtering by crates on rendered docs
271 /// won't be generated.
272 crate generate_search_filter: bool,
273 /// Document items that have lower than `pub` visibility.
274 crate document_private: bool,
275 /// Document items that have `doc(hidden)`.
276 crate document_hidden: bool,
277 /// If `true`, generate a JSON file in the crate folder instead of HTML redirection files.
278 crate generate_redirect_map: bool,
279 /// Show the memory layout of types in the docs.
280 crate show_type_layout: bool,
281 crate unstable_features: rustc_feature::UnstableFeatures,
282 crate emit: Vec<EmitType>,
283 /// If `true`, HTML source pages will generate links for items to their definition.
284 crate generate_link_to_definition: bool,
285 crate call_locations: AllCallLocations,
286 }
287
288 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
289 crate enum EmitType {
290 Unversioned,
291 Toolchain,
292 InvocationSpecific,
293 }
294
295 impl FromStr for EmitType {
296 type Err = ();
297
from_str(s: &str) -> Result<Self, Self::Err>298 fn from_str(s: &str) -> Result<Self, Self::Err> {
299 use EmitType::*;
300 match s {
301 "unversioned-shared-resources" => Ok(Unversioned),
302 "toolchain-shared-resources" => Ok(Toolchain),
303 "invocation-specific" => Ok(InvocationSpecific),
304 _ => Err(()),
305 }
306 }
307 }
308
309 impl RenderOptions {
should_emit_crate(&self) -> bool310 crate fn should_emit_crate(&self) -> bool {
311 self.emit.is_empty() || self.emit.contains(&EmitType::InvocationSpecific)
312 }
313 }
314
315 impl Options {
316 /// Parses the given command-line for options. If an error message or other early-return has
317 /// been printed, returns `Err` with the exit code.
from_matches(matches: &getopts::Matches) -> Result<Options, i32>318 crate fn from_matches(matches: &getopts::Matches) -> Result<Options, i32> {
319 // Check for unstable options.
320 nightly_options::check_nightly_options(matches, &opts());
321
322 if matches.opt_present("h") || matches.opt_present("help") {
323 crate::usage("rustdoc");
324 return Err(0);
325 } else if matches.opt_present("version") {
326 rustc_driver::version("rustdoc", matches);
327 return Err(0);
328 }
329
330 if matches.opt_strs("passes") == ["list"] {
331 println!("Available passes for running rustdoc:");
332 for pass in passes::PASSES {
333 println!("{:>20} - {}", pass.name, pass.description);
334 }
335 println!("\nDefault passes for rustdoc:");
336 for p in passes::DEFAULT_PASSES {
337 print!("{:>20}", p.pass.name);
338 println_condition(p.condition);
339 }
340
341 if nightly_options::match_is_nightly_build(matches) {
342 println!("\nPasses run with `--show-coverage`:");
343 for p in passes::COVERAGE_PASSES {
344 print!("{:>20}", p.pass.name);
345 println_condition(p.condition);
346 }
347 }
348
349 fn println_condition(condition: Condition) {
350 use Condition::*;
351 match condition {
352 Always => println!(),
353 WhenDocumentPrivate => println!(" (when --document-private-items)"),
354 WhenNotDocumentPrivate => println!(" (when not --document-private-items)"),
355 WhenNotDocumentHidden => println!(" (when not --document-hidden-items)"),
356 }
357 }
358
359 return Err(0);
360 }
361
362 let color = config::parse_color(matches);
363 let config::JsonConfig { json_rendered, json_unused_externs, .. } =
364 config::parse_json(matches);
365 let error_format = config::parse_error_format(matches, color, json_rendered);
366
367 let codegen_options = CodegenOptions::build(matches, error_format);
368 let debugging_opts = DebuggingOptions::build(matches, error_format);
369
370 let diag = new_handler(error_format, None, &debugging_opts);
371
372 // check for deprecated options
373 check_deprecated_options(matches, &diag);
374
375 let mut emit = Vec::new();
376 for list in matches.opt_strs("emit") {
377 for kind in list.split(',') {
378 match kind.parse() {
379 Ok(kind) => emit.push(kind),
380 Err(()) => {
381 diag.err(&format!("unrecognized emission type: {}", kind));
382 return Err(1);
383 }
384 }
385 }
386 }
387
388 // check for `--output-format=json`
389 if !matches!(matches.opt_str("output-format").as_deref(), None | Some("html"))
390 && !matches.opt_present("show-coverage")
391 && !nightly_options::is_unstable_enabled(matches)
392 {
393 rustc_session::early_error(
394 error_format,
395 "the -Z unstable-options flag must be passed to enable --output-format for documentation generation (see https://github.com/rust-lang/rust/issues/76578)",
396 );
397 }
398
399 let to_check = matches.opt_strs("check-theme");
400 if !to_check.is_empty() {
401 let paths = theme::load_css_paths(static_files::themes::LIGHT.as_bytes());
402 let mut errors = 0;
403
404 println!("rustdoc: [check-theme] Starting tests! (Ignoring all other arguments)");
405 for theme_file in to_check.iter() {
406 print!(" - Checking \"{}\"...", theme_file);
407 let (success, differences) = theme::test_theme_against(theme_file, &paths, &diag);
408 if !differences.is_empty() || !success {
409 println!(" FAILED");
410 errors += 1;
411 if !differences.is_empty() {
412 println!("{}", differences.join("\n"));
413 }
414 } else {
415 println!(" OK");
416 }
417 }
418 if errors != 0 {
419 return Err(1);
420 }
421 return Err(0);
422 }
423
424 if matches.free.is_empty() {
425 diag.struct_err("missing file operand").emit();
426 return Err(1);
427 }
428 if matches.free.len() > 1 {
429 diag.struct_err("too many file operands").emit();
430 return Err(1);
431 }
432 let input = PathBuf::from(&matches.free[0]);
433
434 let libs = matches
435 .opt_strs("L")
436 .iter()
437 .map(|s| SearchPath::from_cli_opt(s, error_format))
438 .collect();
439 let externs = parse_externs(matches, &debugging_opts, error_format);
440 let extern_html_root_urls = match parse_extern_html_roots(matches) {
441 Ok(ex) => ex,
442 Err(err) => {
443 diag.struct_err(err).emit();
444 return Err(1);
445 }
446 };
447
448 let default_settings: Vec<Vec<(String, String)>> = vec![
449 matches
450 .opt_str("default-theme")
451 .iter()
452 .map(|theme| {
453 vec![
454 ("use-system-theme".to_string(), "false".to_string()),
455 ("theme".to_string(), theme.to_string()),
456 ]
457 })
458 .flatten()
459 .collect(),
460 matches
461 .opt_strs("default-setting")
462 .iter()
463 .map(|s| match s.split_once('=') {
464 None => (s.clone(), "true".to_string()),
465 Some((k, v)) => (k.to_string(), v.to_string()),
466 })
467 .collect(),
468 ];
469 let default_settings = default_settings
470 .into_iter()
471 .flatten()
472 .map(
473 // The keys here become part of `data-` attribute names in the generated HTML. The
474 // browser does a strange mapping when converting them into attributes on the
475 // `dataset` property on the DOM HTML Node:
476 // https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/dataset
477 //
478 // The original key values we have are the same as the DOM storage API keys and the
479 // command line options, so contain `-`. Our Javascript needs to be able to look
480 // these values up both in `dataset` and in the storage API, so it needs to be able
481 // to convert the names back and forth. Despite doing this kebab-case to
482 // StudlyCaps transformation automatically, the JS DOM API does not provide a
483 // mechanism for doing the just transformation on a string. So we want to avoid
484 // the StudlyCaps representation in the `dataset` property.
485 //
486 // We solve this by replacing all the `-`s with `_`s. We do that here, when we
487 // generate the `data-` attributes, and in the JS, when we look them up. (See
488 // `getSettingValue` in `storage.js.`) Converting `-` to `_` is simple in JS.
489 //
490 // The values will be HTML-escaped by the default Tera escaping.
491 |(k, v)| (k.replace('-', "_"), v),
492 )
493 .collect();
494
495 let test_args = matches.opt_strs("test-args");
496 let test_args: Vec<String> =
497 test_args.iter().flat_map(|s| s.split_whitespace()).map(|s| s.to_string()).collect();
498
499 let should_test = matches.opt_present("test");
500 let no_run = matches.opt_present("no-run");
501
502 if !should_test && no_run {
503 diag.err("the `--test` flag must be passed to enable `--no-run`");
504 return Err(1);
505 }
506
507 let output =
508 matches.opt_str("o").map(|s| PathBuf::from(&s)).unwrap_or_else(|| PathBuf::from("doc"));
509 let cfgs = matches.opt_strs("cfg");
510
511 let extension_css = matches.opt_str("e").map(|s| PathBuf::from(&s));
512
513 if let Some(ref p) = extension_css {
514 if !p.is_file() {
515 diag.struct_err("option --extend-css argument must be a file").emit();
516 return Err(1);
517 }
518 }
519
520 let mut themes = Vec::new();
521 if matches.opt_present("theme") {
522 let paths = theme::load_css_paths(static_files::themes::LIGHT.as_bytes());
523
524 for (theme_file, theme_s) in
525 matches.opt_strs("theme").iter().map(|s| (PathBuf::from(&s), s.to_owned()))
526 {
527 if !theme_file.is_file() {
528 diag.struct_err(&format!("invalid argument: \"{}\"", theme_s))
529 .help("arguments to --theme must be files")
530 .emit();
531 return Err(1);
532 }
533 if theme_file.extension() != Some(OsStr::new("css")) {
534 diag.struct_err(&format!("invalid argument: \"{}\"", theme_s))
535 .help("arguments to --theme must have a .css extension")
536 .emit();
537 return Err(1);
538 }
539 let (success, ret) = theme::test_theme_against(&theme_file, &paths, &diag);
540 if !success {
541 diag.struct_err(&format!("error loading theme file: \"{}\"", theme_s)).emit();
542 return Err(1);
543 } else if !ret.is_empty() {
544 diag.struct_warn(&format!(
545 "theme file \"{}\" is missing CSS rules from the default theme",
546 theme_s
547 ))
548 .warn("the theme may appear incorrect when loaded")
549 .help(&format!(
550 "to see what rules are missing, call `rustdoc --check-theme \"{}\"`",
551 theme_s
552 ))
553 .emit();
554 }
555 themes.push(StylePath { path: theme_file, disabled: true });
556 }
557 }
558
559 let edition = config::parse_crate_edition(matches);
560
561 let mut id_map = html::markdown::IdMap::new();
562 let external_html = match ExternalHtml::load(
563 &matches.opt_strs("html-in-header"),
564 &matches.opt_strs("html-before-content"),
565 &matches.opt_strs("html-after-content"),
566 &matches.opt_strs("markdown-before-content"),
567 &matches.opt_strs("markdown-after-content"),
568 nightly_options::match_is_nightly_build(matches),
569 &diag,
570 &mut id_map,
571 edition,
572 &None,
573 ) {
574 Some(eh) => eh,
575 None => return Err(3),
576 };
577
578 match matches.opt_str("r").as_deref() {
579 Some("rust") | None => {}
580 Some(s) => {
581 diag.struct_err(&format!("unknown input format: {}", s)).emit();
582 return Err(1);
583 }
584 }
585
586 let index_page = matches.opt_str("index-page").map(|s| PathBuf::from(&s));
587 if let Some(ref index_page) = index_page {
588 if !index_page.is_file() {
589 diag.struct_err("option `--index-page` argument must be a file").emit();
590 return Err(1);
591 }
592 }
593
594 let target = parse_target_triple(matches, error_format);
595
596 let show_coverage = matches.opt_present("show-coverage");
597
598 let default_passes = if matches.opt_present("no-defaults") {
599 passes::DefaultPassOption::None
600 } else if show_coverage {
601 passes::DefaultPassOption::Coverage
602 } else {
603 passes::DefaultPassOption::Default
604 };
605 let manual_passes = matches.opt_strs("passes");
606
607 let crate_types = match parse_crate_types_from_list(matches.opt_strs("crate-type")) {
608 Ok(types) => types,
609 Err(e) => {
610 diag.struct_err(&format!("unknown crate type: {}", e)).emit();
611 return Err(1);
612 }
613 };
614
615 let output_format = match matches.opt_str("output-format") {
616 Some(s) => match OutputFormat::try_from(s.as_str()) {
617 Ok(out_fmt) => {
618 if !out_fmt.is_json() && show_coverage {
619 diag.struct_err(
620 "html output format isn't supported for the --show-coverage option",
621 )
622 .emit();
623 return Err(1);
624 }
625 out_fmt
626 }
627 Err(e) => {
628 diag.struct_err(&e).emit();
629 return Err(1);
630 }
631 },
632 None => OutputFormat::default(),
633 };
634 let crate_name = matches.opt_str("crate-name");
635 let proc_macro_crate = crate_types.contains(&CrateType::ProcMacro);
636 let playground_url = matches.opt_str("playground-url");
637 let maybe_sysroot = matches.opt_str("sysroot").map(PathBuf::from);
638 let sort_modules_alphabetically = !matches.opt_present("sort-modules-by-appearance");
639 let resource_suffix = matches.opt_str("resource-suffix").unwrap_or_default();
640 let enable_minification = !matches.opt_present("disable-minification");
641 let markdown_no_toc = matches.opt_present("markdown-no-toc");
642 let markdown_css = matches.opt_strs("markdown-css");
643 let markdown_playground_url = matches.opt_str("markdown-playground-url");
644 let crate_version = matches.opt_str("crate-version");
645 let enable_index_page = matches.opt_present("enable-index-page") || index_page.is_some();
646 let static_root_path = matches.opt_str("static-root-path");
647 let generate_search_filter = !matches.opt_present("disable-per-crate-search");
648 let test_run_directory = matches.opt_str("test-run-directory").map(PathBuf::from);
649 let persist_doctests = matches.opt_str("persist-doctests").map(PathBuf::from);
650 let test_builder = matches.opt_str("test-builder").map(PathBuf::from);
651 let codegen_options_strs = matches.opt_strs("C");
652 let debugging_opts_strs = matches.opt_strs("Z");
653 let lib_strs = matches.opt_strs("L");
654 let extern_strs = matches.opt_strs("extern");
655 let runtool = matches.opt_str("runtool");
656 let runtool_args = matches.opt_strs("runtool-arg");
657 let enable_per_target_ignores = matches.opt_present("enable-per-target-ignores");
658 let document_private = matches.opt_present("document-private-items");
659 let document_hidden = matches.opt_present("document-hidden-items");
660 let run_check = matches.opt_present("check");
661 let generate_redirect_map = matches.opt_present("generate-redirect-map");
662 let show_type_layout = matches.opt_present("show-type-layout");
663 let nocapture = matches.opt_present("nocapture");
664 let generate_link_to_definition = matches.opt_present("generate-link-to-definition");
665 let extern_html_root_takes_precedence =
666 matches.opt_present("extern-html-root-takes-precedence");
667
668 if generate_link_to_definition && (show_coverage || output_format != OutputFormat::Html) {
669 diag.struct_err(
670 "--generate-link-to-definition option can only be used with HTML output format",
671 )
672 .emit();
673 return Err(1);
674 }
675
676 let scrape_examples_options = ScrapeExamplesOptions::new(&matches, &diag)?;
677 let with_examples = matches.opt_strs("with-examples");
678 let call_locations = crate::scrape_examples::load_call_locations(with_examples, &diag)?;
679
680 let (lint_opts, describe_lints, lint_cap) = get_cmd_lint_options(matches, error_format);
681
682 Ok(Options {
683 input,
684 proc_macro_crate,
685 error_format,
686 libs,
687 lib_strs,
688 externs,
689 extern_strs,
690 cfgs,
691 codegen_options,
692 codegen_options_strs,
693 debugging_opts,
694 debugging_opts_strs,
695 target,
696 edition,
697 maybe_sysroot,
698 lint_opts,
699 describe_lints,
700 lint_cap,
701 should_test,
702 test_args,
703 default_passes,
704 manual_passes,
705 show_coverage,
706 crate_version,
707 test_run_directory,
708 persist_doctests,
709 runtool,
710 runtool_args,
711 enable_per_target_ignores,
712 test_builder,
713 run_check,
714 no_run,
715 nocapture,
716 render_options: RenderOptions {
717 output,
718 external_html,
719 id_map,
720 playground_url,
721 sort_modules_alphabetically,
722 themes,
723 extension_css,
724 extern_html_root_urls,
725 extern_html_root_takes_precedence,
726 default_settings,
727 resource_suffix,
728 enable_minification,
729 enable_index_page,
730 index_page,
731 static_root_path,
732 markdown_no_toc,
733 markdown_css,
734 markdown_playground_url,
735 generate_search_filter,
736 document_private,
737 document_hidden,
738 generate_redirect_map,
739 show_type_layout,
740 unstable_features: rustc_feature::UnstableFeatures::from_environment(
741 crate_name.as_deref(),
742 ),
743 emit,
744 generate_link_to_definition,
745 call_locations,
746 },
747 crate_name,
748 output_format,
749 json_unused_externs,
750 scrape_examples_options,
751 })
752 }
753
754 /// Returns `true` if the file given as `self.input` is a Markdown file.
markdown_input(&self) -> bool755 crate fn markdown_input(&self) -> bool {
756 self.input.extension().map_or(false, |e| e == "md" || e == "markdown")
757 }
758 }
759
760 /// Prints deprecation warnings for deprecated options
check_deprecated_options(matches: &getopts::Matches, diag: &rustc_errors::Handler)761 fn check_deprecated_options(matches: &getopts::Matches, diag: &rustc_errors::Handler) {
762 let deprecated_flags = ["input-format", "no-defaults", "passes"];
763
764 for flag in deprecated_flags.iter() {
765 if matches.opt_present(flag) {
766 let mut err = diag.struct_warn(&format!("the `{}` flag is deprecated", flag));
767 err.note(
768 "see issue #44136 <https://github.com/rust-lang/rust/issues/44136> \
769 for more information",
770 );
771
772 if *flag == "no-defaults" {
773 err.help("you may want to use --document-private-items");
774 }
775
776 err.emit();
777 }
778 }
779
780 let removed_flags = ["plugins", "plugin-path"];
781
782 for &flag in removed_flags.iter() {
783 if matches.opt_present(flag) {
784 diag.struct_warn(&format!("the '{}' flag no longer functions", flag))
785 .warn("see CVE-2018-1000622")
786 .emit();
787 }
788 }
789 }
790
791 /// Extracts `--extern-html-root-url` arguments from `matches` and returns a map of crate names to
792 /// the given URLs. If an `--extern-html-root-url` argument was ill-formed, returns an error
793 /// describing the issue.
parse_extern_html_roots( matches: &getopts::Matches, ) -> Result<BTreeMap<String, String>, &'static str>794 fn parse_extern_html_roots(
795 matches: &getopts::Matches,
796 ) -> Result<BTreeMap<String, String>, &'static str> {
797 let mut externs = BTreeMap::new();
798 for arg in &matches.opt_strs("extern-html-root-url") {
799 let (name, url) =
800 arg.split_once('=').ok_or("--extern-html-root-url must be of the form name=url")?;
801 externs.insert(name.to_string(), url.to_string());
802 }
803 Ok(externs)
804 }
805