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 }
 280
 281 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
 282 crate enum EmitType {
 283     Unversioned,
 284     Toolchain,
 285     InvocationSpecific,
 286 }
 287
 288 impl FromStr for EmitType {
 289     type Err = ();
 290
 291     fn from_str(s: &str) -> Result<Self, Self::Err> {
 292         use EmitType::*;
 293         match s {
 294             "unversioned-shared-resources" => Ok(Unversioned),
 295             "toolchain-shared-resources" => Ok(Toolchain),
 296             "invocation-specific" => Ok(InvocationSpecific),
 297             _ => Err(()),
 298         }
 299     }
 300 }
 301
 302 impl RenderOptions {
 303     crate fn should_emit_crate(&self) -> bool {
 304         self.emit.is_empty() || self.emit.contains(&EmitType::InvocationSpecific)
 305     }
 306 }
 307
 308 impl Options {
 309     /// Parses the given command-line for options. If an error message or other early-return has
 310     /// been printed, returns `Err` with the exit code.
 311     crate fn from_matches(matches: &getopts::Matches) -> Result<Options, i32> {
 312         // Check for unstable options.
 313         nightly_options::check_nightly_options(&matches, &opts());
 314
 315         if matches.opt_present("h") || matches.opt_present("help") {
 316             crate::usage("rustdoc");
 317             return Err(0);
 318         } else if matches.opt_present("version") {
 319             rustc_driver::version("rustdoc", &matches);
 320             return Err(0);
 321         }
 322
 323         if matches.opt_strs("passes") == ["list"] {
 324             println!("Available passes for running rustdoc:");
 325             for pass in passes::PASSES {
 326                 println!("{:>20} - {}", pass.name, pass.description);
 327             }
 328             println!("\nDefault passes for rustdoc:");
 329             for p in passes::DEFAULT_PASSES {
 330                 print!("{:>20}", p.pass.name);
 331                 println_condition(p.condition);
 332             }
 333
 334             if nightly_options::match_is_nightly_build(matches) {
 335                 println!("\nPasses run with `--show-coverage`:");
 336                 for p in passes::COVERAGE_PASSES {
 337                     print!("{:>20}", p.pass.name);
 338                     println_condition(p.condition);
 339                 }
 340             }
 341
 342             fn println_condition(condition: Condition) {
 343                 use Condition::*;
 344                 match condition {
 345                     Always => println!(),
 346                     WhenDocumentPrivate => println!("  (when --document-private-items)"),
 347                     WhenNotDocumentPrivate => println!("  (when not --document-private-items)"),
 348                     WhenNotDocumentHidden => println!("  (when not --document-hidden-items)"),
 349                 }
 350             }
 351
 352             return Err(0);
 353         }
 354
 355         let color = config::parse_color(&matches);
 356         let config::JsonConfig { json_rendered, json_unused_externs, .. } =
 357             config::parse_json(&matches);
 358         let error_format = config::parse_error_format(&matches, color, json_rendered);
 359
 360         let codegen_options = CodegenOptions::build(matches, error_format);
 361         let debugging_opts = DebuggingOptions::build(matches, error_format);
 362
 363         let diag = new_handler(error_format, None, &debugging_opts);
 364
 365         // check for deprecated options
 366         check_deprecated_options(&matches, &diag);
 367
 368         let mut emit = Vec::new();
 369         for list in matches.opt_strs("emit") {
 370             for kind in list.split(',') {
 371                 match kind.parse() {
 372                     Ok(kind) => emit.push(kind),
 373                     Err(()) => {
 374                         diag.err(&format!("unrecognized emission type: {}", kind));
 375                         return Err(1);
 376                     }
 377                 }
 378             }
 379         }
 380
 381         // check for `--output-format=json`
 382         if !matches!(matches.opt_str("output-format").as_deref(), None | Some("html"))
 383             && !matches.opt_present("show-coverage")
 384             && !nightly_options::is_unstable_enabled(matches)
 385         {
 386             rustc_session::early_error(
 387                 error_format,
 388                 "the -Z unstable-options flag must be passed to enable --output-format for documentation generation (see https://github.com/rust-lang/rust/issues/76578)",
 389             );
 390         }
 391
 392         let to_check = matches.opt_strs("check-theme");
 393         if !to_check.is_empty() {
 394             let paths = theme::load_css_paths(static_files::themes::LIGHT.as_bytes());
 395             let mut errors = 0;
 396
 397             println!("rustdoc: [check-theme] Starting tests! (Ignoring all other arguments)");
 398             for theme_file in to_check.iter() {
 399                 print!(" - Checking \"{}\"...", theme_file);
 400                 let (success, differences) = theme::test_theme_against(theme_file, &paths, &diag);
 401                 if !differences.is_empty() || !success {
 402                     println!(" FAILED");
 403                     errors += 1;
 404                     if !differences.is_empty() {
 405                         println!("{}", differences.join("\n"));
 406                     }
 407                 } else {
 408                     println!(" OK");
 409                 }
 410             }
 411             if errors != 0 {
 412                 return Err(1);
 413             }
 414             return Err(0);
 415         }
 416
 417         if matches.free.is_empty() {
 418             diag.struct_err("missing file operand").emit();
 419             return Err(1);
 420         }
 421         if matches.free.len() > 1 {
 422             diag.struct_err("too many file operands").emit();
 423             return Err(1);
 424         }
 425         let input = PathBuf::from(&matches.free[0]);
 426
 427         let libs = matches
 428             .opt_strs("L")
 429             .iter()
 430             .map(|s| SearchPath::from_cli_opt(s, error_format))
 431             .collect();
 432         let externs = parse_externs(&matches, &debugging_opts, error_format);
 433         let extern_html_root_urls = match parse_extern_html_roots(&matches) {
 434             Ok(ex) => ex,
 435             Err(err) => {
 436                 diag.struct_err(err).emit();
 437                 return Err(1);
 438             }
 439         };
 440
 441         let default_settings: Vec<Vec<(String, String)>> = vec![
 442             matches
 443                 .opt_str("default-theme")
 444                 .iter()
 445                 .map(|theme| {
 446                     vec![
 447                         ("use-system-theme".to_string(), "false".to_string()),
 448                         ("theme".to_string(), theme.to_string()),
 449                     ]
 450                 })
 451                 .flatten()
 452                 .collect(),
 453             matches
 454                 .opt_strs("default-setting")
 455                 .iter()
 456                 .map(|s| match s.split_once('=') {
 457                     None => (s.clone(), "true".to_string()),
 458                     Some((k, v)) => (k.to_string(), v.to_string()),
 459                 })
 460                 .collect(),
 461         ];
 462         let default_settings = default_settings
 463             .into_iter()
 464             .flatten()
 465             .map(
 466                 // The keys here become part of `data-` attribute names in the generated HTML.  The
 467                 // browser does a strange mapping when converting them into attributes on the
 468                 // `dataset` property on the DOM HTML Node:
 469                 //   https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/dataset
 470                 //
 471                 // The original key values we have are the same as the DOM storage API keys and the
 472                 // command line options, so contain `-`.  Our Javascript needs to be able to look
 473                 // these values up both in `dataset` and in the storage API, so it needs to be able
 474                 // to convert the names back and forth.  Despite doing this kebab-case to
 475                 // StudlyCaps transformation automatically, the JS DOM API does not provide a
 476                 // mechanism for doing the just transformation on a string.  So we want to avoid
 477                 // the StudlyCaps representation in the `dataset` property.
 478                 //
 479                 // We solve this by replacing all the `-`s with `_`s.  We do that here, when we
 480                 // generate the `data-` attributes, and in the JS, when we look them up.  (See
 481                 // `getSettingValue` in `storage.js.`) Converting `-` to `_` is simple in JS.
 482                 //
 483                 // The values will be HTML-escaped by the default Tera escaping.
 484                 |(k, v)| (k.replace('-', "_"), v),
 485             )
 486             .collect();
 487
 488         let test_args = matches.opt_strs("test-args");
 489         let test_args: Vec<String> =
 490             test_args.iter().flat_map(|s| s.split_whitespace()).map(|s| s.to_string()).collect();
 491
 492         let should_test = matches.opt_present("test");
 493         let no_run = matches.opt_present("no-run");
 494
 495         if !should_test && no_run {
 496             diag.err("the `--test` flag must be passed to enable `--no-run`");
 497             return Err(1);
 498         }
 499
 500         let output =
 501             matches.opt_str("o").map(|s| PathBuf::from(&s)).unwrap_or_else(|| PathBuf::from("doc"));
 502         let cfgs = matches.opt_strs("cfg");
 503
 504         let extension_css = matches.opt_str("e").map(|s| PathBuf::from(&s));
 505
 506         if let Some(ref p) = extension_css {
 507             if !p.is_file() {
 508                 diag.struct_err("option --extend-css argument must be a file").emit();
 509                 return Err(1);
 510             }
 511         }
 512
 513         let mut themes = Vec::new();
 514         if matches.opt_present("theme") {
 515             let paths = theme::load_css_paths(static_files::themes::LIGHT.as_bytes());
 516
 517             for (theme_file, theme_s) in
 518                 matches.opt_strs("theme").iter().map(|s| (PathBuf::from(&s), s.to_owned()))
 519             {
 520                 if !theme_file.is_file() {
 521                     diag.struct_err(&format!("invalid argument: \"{}\"", theme_s))
 522                         .help("arguments to --theme must be files")
 523                         .emit();
 524                     return Err(1);
 525                 }
 526                 if theme_file.extension() != Some(OsStr::new("css")) {
 527                     diag.struct_err(&format!("invalid argument: \"{}\"", theme_s))
 528                         .help("arguments to --theme must have a .css extension")
 529                         .emit();
 530                     return Err(1);
 531                 }
 532                 let (success, ret) = theme::test_theme_against(&theme_file, &paths, &diag);
 533                 if !success {
 534                     diag.struct_err(&format!("error loading theme file: \"{}\"", theme_s)).emit();
 535                     return Err(1);
 536                 } else if !ret.is_empty() {
 537                     diag.struct_warn(&format!(
 538                         "theme file \"{}\" is missing CSS rules from the default theme",
 539                         theme_s
 540                     ))
 541                     .warn("the theme may appear incorrect when loaded")
 542                     .help(&format!(
 543                         "to see what rules are missing, call `rustdoc --check-theme \"{}\"`",
 544                         theme_s
 545                     ))
 546                     .emit();
 547                 }
 548                 themes.push(StylePath { path: theme_file, disabled: true });
 549             }
 550         }
 551
 552         let edition = config::parse_crate_edition(&matches);
 553
 554         let mut id_map = html::markdown::IdMap::new();
 555         let external_html = match ExternalHtml::load(
 556             &matches.opt_strs("html-in-header"),
 557             &matches.opt_strs("html-before-content"),
 558             &matches.opt_strs("html-after-content"),
 559             &matches.opt_strs("markdown-before-content"),
 560             &matches.opt_strs("markdown-after-content"),
 561             nightly_options::match_is_nightly_build(&matches),
 562             &diag,
 563             &mut id_map,
 564             edition,
 565             &None,
 566         ) {
 567             Some(eh) => eh,
 568             None => return Err(3),
 569         };
 570
 571         match matches.opt_str("r").as_deref() {
 572             Some("rust") | None => {}
 573             Some(s) => {
 574                 diag.struct_err(&format!("unknown input format: {}", s)).emit();
 575                 return Err(1);
 576             }
 577         }
 578
 579         let index_page = matches.opt_str("index-page").map(|s| PathBuf::from(&s));
 580         if let Some(ref index_page) = index_page {
 581             if !index_page.is_file() {
 582                 diag.struct_err("option `--index-page` argument must be a file").emit();
 583                 return Err(1);
 584             }
 585         }
 586
 587         let target = parse_target_triple(matches, error_format);
 588
 589         let show_coverage = matches.opt_present("show-coverage");
 590
 591         let default_passes = if matches.opt_present("no-defaults") {
 592             passes::DefaultPassOption::None
 593         } else if show_coverage {
 594             passes::DefaultPassOption::Coverage
 595         } else {
 596             passes::DefaultPassOption::Default
 597         };
 598         let manual_passes = matches.opt_strs("passes");
 599
 600         let crate_types = match parse_crate_types_from_list(matches.opt_strs("crate-type")) {
 601             Ok(types) => types,
 602             Err(e) => {
 603                 diag.struct_err(&format!("unknown crate type: {}", e)).emit();
 604                 return Err(1);
 605             }
 606         };
 607
 608         let output_format = match matches.opt_str("output-format") {
 609             Some(s) => match OutputFormat::try_from(s.as_str()) {
 610                 Ok(out_fmt) => {
 611                     if !out_fmt.is_json() && show_coverage {
 612                         diag.struct_err(
 613                             "html output format isn't supported for the --show-coverage option",
 614                         )
 615                         .emit();
 616                         return Err(1);
 617                     }
 618                     out_fmt
 619                 }
 620                 Err(e) => {
 621                     diag.struct_err(&e).emit();
 622                     return Err(1);
 623                 }
 624             },
 625             None => OutputFormat::default(),
 626         };
 627         let crate_name = matches.opt_str("crate-name");
 628         let proc_macro_crate = crate_types.contains(&CrateType::ProcMacro);
 629         let playground_url = matches.opt_str("playground-url");
 630         let maybe_sysroot = matches.opt_str("sysroot").map(PathBuf::from);
 631         let display_warnings = matches.opt_present("display-warnings");
 632         let sort_modules_alphabetically = !matches.opt_present("sort-modules-by-appearance");
 633         let resource_suffix = matches.opt_str("resource-suffix").unwrap_or_default();
 634         let enable_minification = !matches.opt_present("disable-minification");
 635         let markdown_no_toc = matches.opt_present("markdown-no-toc");
 636         let markdown_css = matches.opt_strs("markdown-css");
 637         let markdown_playground_url = matches.opt_str("markdown-playground-url");
 638         let crate_version = matches.opt_str("crate-version");
 639         let enable_index_page = matches.opt_present("enable-index-page") || index_page.is_some();
 640         let static_root_path = matches.opt_str("static-root-path");
 641         let generate_search_filter = !matches.opt_present("disable-per-crate-search");
 642         let test_run_directory = matches.opt_str("test-run-directory").map(PathBuf::from);
 643         let persist_doctests = matches.opt_str("persist-doctests").map(PathBuf::from);
 644         let test_builder = matches.opt_str("test-builder").map(PathBuf::from);
 645         let codegen_options_strs = matches.opt_strs("C");
 646         let debugging_opts_strs = matches.opt_strs("Z");
 647         let lib_strs = matches.opt_strs("L");
 648         let extern_strs = matches.opt_strs("extern");
 649         let runtool = matches.opt_str("runtool");
 650         let runtool_args = matches.opt_strs("runtool-arg");
 651         let enable_per_target_ignores = matches.opt_present("enable-per-target-ignores");
 652         let document_private = matches.opt_present("document-private-items");
 653         let document_hidden = matches.opt_present("document-hidden-items");
 654         let run_check = matches.opt_present("check");
 655         let generate_redirect_map = matches.opt_present("generate-redirect-map");
 656         let show_type_layout = matches.opt_present("show-type-layout");
 657         let nocapture = matches.opt_present("nocapture");
 658
 659         let (lint_opts, describe_lints, lint_cap) =
 660             get_cmd_lint_options(matches, error_format, &debugging_opts);
 661
 662         Ok(Options {
 663             input,
 664             proc_macro_crate,
 665             error_format,
 666             libs,
 667             lib_strs,
 668             externs,
 669             extern_strs,
 670             cfgs,
 671             codegen_options,
 672             codegen_options_strs,
 673             debugging_opts,
 674             debugging_opts_strs,
 675             target,
 676             edition,
 677             maybe_sysroot,
 678             lint_opts,
 679             describe_lints,
 680             lint_cap,
 681             should_test,
 682             test_args,
 683             default_passes,
 684             manual_passes,
 685             display_warnings,
 686             show_coverage,
 687             crate_version,
 688             test_run_directory,
 689             persist_doctests,
 690             runtool,
 691             runtool_args,
 692             enable_per_target_ignores,
 693             test_builder,
 694             run_check,
 695             no_run,
 696             nocapture,
 697             render_options: RenderOptions {
 698                 output,
 699                 external_html,
 700                 id_map,
 701                 playground_url,
 702                 sort_modules_alphabetically,
 703                 themes,
 704                 extension_css,
 705                 extern_html_root_urls,
 706                 default_settings,
 707                 resource_suffix,
 708                 enable_minification,
 709                 enable_index_page,
 710                 index_page,
 711                 static_root_path,
 712                 markdown_no_toc,
 713                 markdown_css,
 714                 markdown_playground_url,
 715                 generate_search_filter,
 716                 document_private,
 717                 document_hidden,
 718                 generate_redirect_map,
 719                 show_type_layout,
 720                 unstable_features: rustc_feature::UnstableFeatures::from_environment(
 721                     crate_name.as_deref(),
 722                 ),
 723                 emit,
 724             },
 725             crate_name,
 726             output_format,
 727             json_unused_externs,
 728         })
 729     }
 730
 731     /// Returns `true` if the file given as `self.input` is a Markdown file.
 732     crate fn markdown_input(&self) -> bool {
 733         self.input.extension().map_or(false, |e| e == "md" || e == "markdown")
 734     }
 735 }
 736
 737 /// Prints deprecation warnings for deprecated options
 738 fn check_deprecated_options(matches: &getopts::Matches, diag: &rustc_errors::Handler) {
 739     let deprecated_flags = ["input-format", "no-defaults", "passes"];
 740
 741     for flag in deprecated_flags.iter() {
 742         if matches.opt_present(flag) {
 743             let mut err = diag.struct_warn(&format!("the `{}` flag is deprecated", flag));
 744             err.note(
 745                 "see issue #44136 <https://github.com/rust-lang/rust/issues/44136> \
 746                  for more information",
 747             );
 748
 749             if *flag == "no-defaults" {
 750                 err.help("you may want to use --document-private-items");
 751             }
 752
 753             err.emit();
 754         }
 755     }
 756
 757     let removed_flags = ["plugins", "plugin-path"];
 758
 759     for &flag in removed_flags.iter() {
 760         if matches.opt_present(flag) {
 761             diag.struct_warn(&format!("the '{}' flag no longer functions", flag))
 762                 .warn("see CVE-2018-1000622")
 763                 .emit();
 764         }
 765     }
 766 }
 767
 768 /// Extracts `--extern-html-root-url` arguments from `matches` and returns a map of crate names to
 769 /// the given URLs. If an `--extern-html-root-url` argument was ill-formed, returns an error
 770 /// describing the issue.
 771 fn parse_extern_html_roots(
 772     matches: &getopts::Matches,
 773 ) -> Result<BTreeMap<String, String>, &'static str> {
 774     let mut externs = BTreeMap::new();
 775     for arg in &matches.opt_strs("extern-html-root-url") {
 776         let (name, url) =
 777             arg.split_once('=').ok_or("--extern-html-root-url must be of the form name=url")?;
 778         externs.insert(name.to_string(), url.to_string());
 779     }
 780     Ok(externs)
 781 }