src/librustdoc/config.rs

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