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