src/librustdoc/lib.rs

   1 #![doc(
   2     html_root_url = "https://doc.rust-lang.org/nightly/",
   3     html_playground_url = "https://play.rust-lang.org/"
   4 )]
   5 #![feature(rustc_private)]
   6 #![feature(array_methods)]
   7 #![feature(box_patterns)]
   8 #![feature(box_syntax)]
   9 #![feature(in_band_lifetimes)]
  10 #![feature(nll)]
  11 #![feature(test)]
  12 #![feature(crate_visibility_modifier)]
  13 #![feature(never_type)]
  14 #![feature(once_cell)]
  15 #![feature(type_ascription)]
  16 #![feature(iter_intersperse)]
  17 #![recursion_limit = "256"]
  18 #![warn(rustc::internal)]
  19
  20 #[macro_use]
  21 extern crate lazy_static;
  22 #[macro_use]
  23 extern crate tracing;
  24
  25 // N.B. these need `extern crate` even in 2018 edition
  26 // because they're loaded implicitly from the sysroot.
  27 // The reason they're loaded from the sysroot is because
  28 // the rustdoc artifacts aren't stored in rustc's cargo target directory.
  29 // So if `rustc` was specified in Cargo.toml, this would spuriously rebuild crates.
  30 //
  31 // Dependencies listed in Cargo.toml do not need `extern crate`.
  32
  33 extern crate rustc_ast;
  34 extern crate rustc_ast_pretty;
  35 extern crate rustc_attr;
  36 extern crate rustc_data_structures;
  37 extern crate rustc_driver;
  38 extern crate rustc_errors;
  39 extern crate rustc_expand;
  40 extern crate rustc_feature;
  41 extern crate rustc_hir;
  42 extern crate rustc_hir_pretty;
  43 extern crate rustc_index;
  44 extern crate rustc_infer;
  45 extern crate rustc_interface;
  46 extern crate rustc_lexer;
  47 extern crate rustc_lint;
  48 extern crate rustc_lint_defs;
  49 extern crate rustc_metadata;
  50 extern crate rustc_middle;
  51 extern crate rustc_mir;
  52 extern crate rustc_parse;
  53 extern crate rustc_passes;
  54 extern crate rustc_resolve;
  55 extern crate rustc_session;
  56 extern crate rustc_span;
  57 extern crate rustc_target;
  58 extern crate rustc_trait_selection;
  59 extern crate rustc_typeck;
  60 extern crate test;
  61
  62 #[cfg(feature = "jemalloc")]
  63 extern crate tikv_jemalloc_sys;
  64 #[cfg(feature = "jemalloc")]
  65 use tikv_jemalloc_sys as jemalloc_sys;
  66 #[cfg(feature = "jemalloc")]
  67 extern crate tikv_jemallocator;
  68 #[cfg(feature = "jemalloc")]
  69 use tikv_jemallocator as jemallocator;
  70
  71 use std::default::Default;
  72 use std::env;
  73 use std::process;
  74
  75 use rustc_driver::{abort_on_err, describe_lints};
  76 use rustc_errors::ErrorReported;
  77 use rustc_interface::interface;
  78 use rustc_middle::ty::TyCtxt;
  79 use rustc_session::config::{make_crate_type_option, ErrorOutputType, RustcOptGroup};
  80 use rustc_session::getopts;
  81 use rustc_session::{early_error, early_warn};
  82
  83 use crate::clean::utils::DOC_RUST_LANG_ORG_CHANNEL;
  84
  85 /// A macro to create a FxHashMap.
  86 ///
  87 /// Example:
  88 ///
  89 /// ```
  90 /// let letters = map!{"a" => "b", "c" => "d"};
  91 /// ```
  92 ///
  93 /// Trailing commas are allowed.
  94 /// Commas between elements are required (even if the expression is a block).
  95 macro_rules! map {
  96     ($( $key: expr => $val: expr ),* $(,)*) => {{
  97         let mut map = ::rustc_data_structures::fx::FxHashMap::default();
  98         $( map.insert($key, $val); )*
  99         map
 100     }}
 101 }
 102
 103 #[macro_use]
 104 mod externalfiles;
 105
 106 mod clean;
 107 mod config;
 108 mod core;
 109 mod docfs;
 110 mod doctree;
 111 #[macro_use]
 112 mod error;
 113 mod doctest;
 114 mod fold;
 115 mod formats;
 116 // used by the error-index generator, so it needs to be public
 117 pub mod html;
 118 mod json;
 119 crate mod lint;
 120 mod markdown;
 121 mod passes;
 122 mod theme;
 123 mod visit_ast;
 124 mod visit_lib;
 125
 126 // See docs in https://github.com/rust-lang/rust/blob/master/compiler/rustc/src/main.rs
 127 // about jemallocator
 128 #[cfg(feature = "jemalloc")]
 129 #[global_allocator]
 130 static ALLOC: jemallocator::Jemalloc = jemallocator::Jemalloc;
 131
 132 pub fn main() {
 133     // See docs in https://github.com/rust-lang/rust/blob/master/compiler/rustc/src/main.rs
 134     // about jemalloc-sys
 135     #[cfg(feature = "jemalloc")]
 136     {
 137         use std::os::raw::{c_int, c_void};
 138
 139         #[used]
 140         static _F1: unsafe extern "C" fn(usize, usize) -> *mut c_void = jemalloc_sys::calloc;
 141         #[used]
 142         static _F2: unsafe extern "C" fn(*mut *mut c_void, usize, usize) -> c_int =
 143             jemalloc_sys::posix_memalign;
 144         #[used]
 145         static _F3: unsafe extern "C" fn(usize, usize) -> *mut c_void = jemalloc_sys::aligned_alloc;
 146         #[used]
 147         static _F4: unsafe extern "C" fn(usize) -> *mut c_void = jemalloc_sys::malloc;
 148         #[used]
 149         static _F5: unsafe extern "C" fn(*mut c_void, usize) -> *mut c_void = jemalloc_sys::realloc;
 150         #[used]
 151         static _F6: unsafe extern "C" fn(*mut c_void) = jemalloc_sys::free;
 152
 153         // On OSX, jemalloc doesn't directly override malloc/free, but instead
 154         // registers itself with the allocator's zone APIs in a ctor. However,
 155         // the linker doesn't seem to consider ctors as "used" when statically
 156         // linking, so we need to explicitly depend on the function.
 157         #[cfg(target_os = "macos")]
 158         {
 159             extern "C" {
 160                 fn _rjem_je_zone_register();
 161             }
 162
 163             #[used]
 164             static _F7: unsafe extern "C" fn() = _rjem_je_zone_register;
 165         }
 166     }
 167
 168     rustc_driver::set_sigpipe_handler();
 169     rustc_driver::install_ice_hook();
 170
 171     // When using CI artifacts (with `download_stage1 = true`), tracing is unconditionally built
 172     // with `--features=static_max_level_info`, which disables almost all rustdoc logging. To avoid
 173     // this, compile our own version of `tracing` that logs all levels.
 174     // NOTE: this compiles both versions of tracing unconditionally, because
 175     // - The compile time hit is not that bad, especially compared to rustdoc's incremental times, and
 176     // - Otherwise, there's no warning that logging is being ignored when `download_stage1 = true`.
 177     // NOTE: The reason this doesn't show double logging when `download_stage1 = false` and
 178     // `debug_logging = true` is because all rustc logging goes to its version of tracing (the one
 179     // in the sysroot), and all of rustdoc's logging goes to its version (the one in Cargo.toml).
 180     init_logging();
 181     rustc_driver::init_env_logger("RUSTDOC_LOG");
 182
 183     let exit_code = rustc_driver::catch_with_exit_code(|| match get_args() {
 184         Some(args) => main_args(&args),
 185         _ => Err(ErrorReported),
 186     });
 187     process::exit(exit_code);
 188 }
 189
 190 fn init_logging() {
 191     use std::io;
 192
 193     // FIXME remove these and use winapi 0.3 instead
 194     // Duplicates: bootstrap/compile.rs, librustc_errors/emitter.rs, rustc_driver/lib.rs
 195     #[cfg(unix)]
 196     fn stdout_isatty() -> bool {
 197         extern crate libc;
 198         unsafe { libc::isatty(libc::STDOUT_FILENO) != 0 }
 199     }
 200
 201     #[cfg(windows)]
 202     fn stdout_isatty() -> bool {
 203         extern crate winapi;
 204         use winapi::um::consoleapi::GetConsoleMode;
 205         use winapi::um::processenv::GetStdHandle;
 206         use winapi::um::winbase::STD_OUTPUT_HANDLE;
 207
 208         unsafe {
 209             let handle = GetStdHandle(STD_OUTPUT_HANDLE);
 210             let mut out = 0;
 211             GetConsoleMode(handle, &mut out) != 0
 212         }
 213     }
 214
 215     let color_logs = match std::env::var("RUSTDOC_LOG_COLOR") {
 216         Ok(value) => match value.as_ref() {
 217             "always" => true,
 218             "never" => false,
 219             "auto" => stdout_isatty(),
 220             _ => early_error(
 221                 ErrorOutputType::default(),
 222                 &format!(
 223                     "invalid log color value '{}': expected one of always, never, or auto",
 224                     value
 225                 ),
 226             ),
 227         },
 228         Err(std::env::VarError::NotPresent) => stdout_isatty(),
 229         Err(std::env::VarError::NotUnicode(_value)) => early_error(
 230             ErrorOutputType::default(),
 231             "non-Unicode log color value: expected one of always, never, or auto",
 232         ),
 233     };
 234     let filter = tracing_subscriber::EnvFilter::from_env("RUSTDOC_LOG");
 235     let layer = tracing_tree::HierarchicalLayer::default()
 236         .with_writer(io::stderr)
 237         .with_indent_lines(true)
 238         .with_ansi(color_logs)
 239         .with_targets(true)
 240         .with_wraparound(10)
 241         .with_verbose_exit(true)
 242         .with_verbose_entry(true)
 243         .with_indent_amount(2);
 244     #[cfg(parallel_compiler)]
 245     let layer = layer.with_thread_ids(true).with_thread_names(true);
 246
 247     use tracing_subscriber::layer::SubscriberExt;
 248     let subscriber = tracing_subscriber::Registry::default().with(filter).with(layer);
 249     tracing::subscriber::set_global_default(subscriber).unwrap();
 250 }
 251
 252 fn get_args() -> Option<Vec<String>> {
 253     env::args_os()
 254         .enumerate()
 255         .map(|(i, arg)| {
 256             arg.into_string()
 257                 .map_err(|arg| {
 258                     early_warn(
 259                         ErrorOutputType::default(),
 260                         &format!("Argument {} is not valid Unicode: {:?}", i, arg),
 261                     );
 262                 })
 263                 .ok()
 264         })
 265         .collect()
 266 }
 267
 268 fn opts() -> Vec<RustcOptGroup> {
 269     let stable: fn(_, fn(&mut getopts::Options) -> &mut _) -> _ = RustcOptGroup::stable;
 270     let unstable: fn(_, fn(&mut getopts::Options) -> &mut _) -> _ = RustcOptGroup::unstable;
 271     vec![
 272         stable("h", |o| o.optflagmulti("h", "help", "show this help message")),
 273         stable("V", |o| o.optflagmulti("V", "version", "print rustdoc's version")),
 274         stable("v", |o| o.optflagmulti("v", "verbose", "use verbose output")),
 275         stable("r", |o| {
 276             o.optopt("r", "input-format", "the input type of the specified file", "[rust]")
 277         }),
 278         stable("w", |o| o.optopt("w", "output-format", "the output type to write", "[html]")),
 279         stable("o", |o| o.optopt("o", "output", "where to place the output", "PATH")),
 280         stable("crate-name", |o| {
 281             o.optopt("", "crate-name", "specify the name of this crate", "NAME")
 282         }),
 283         make_crate_type_option(),
 284         stable("L", |o| {
 285             o.optmulti("L", "library-path", "directory to add to crate search path", "DIR")
 286         }),
 287         stable("cfg", |o| o.optmulti("", "cfg", "pass a --cfg to rustc", "")),
 288         stable("extern", |o| o.optmulti("", "extern", "pass an --extern to rustc", "NAME[=PATH]")),
 289         unstable("extern-html-root-url", |o| {
 290             o.optmulti(
 291                 "",
 292                 "extern-html-root-url",
 293                 "base URL to use for dependencies; for example, \
 294                  \"std=/doc\" links std::vec::Vec to /doc/std/vec/struct.Vec.html",
 295                 "NAME=URL",
 296             )
 297         }),
 298         stable("plugin-path", |o| o.optmulti("", "plugin-path", "removed", "DIR")),
 299         stable("C", |o| {
 300             o.optmulti("C", "codegen", "pass a codegen option to rustc", "OPT[=VALUE]")
 301         }),
 302         stable("passes", |o| {
 303             o.optmulti(
 304                 "",
 305                 "passes",
 306                 "list of passes to also run, you might want to pass it multiple times; a value of \
 307                  `list` will print available passes",
 308                 "PASSES",
 309             )
 310         }),
 311         stable("plugins", |o| o.optmulti("", "plugins", "removed", "PLUGINS")),
 312         stable("no-default", |o| o.optflagmulti("", "no-defaults", "don't run the default passes")),
 313         stable("document-private-items", |o| {
 314             o.optflagmulti("", "document-private-items", "document private items")
 315         }),
 316         unstable("document-hidden-items", |o| {
 317             o.optflagmulti("", "document-hidden-items", "document items that have doc(hidden)")
 318         }),
 319         stable("test", |o| o.optflagmulti("", "test", "run code examples as tests")),
 320         stable("test-args", |o| {
 321             o.optmulti("", "test-args", "arguments to pass to the test runner", "ARGS")
 322         }),
 323         unstable("test-run-directory", |o| {
 324             o.optopt(
 325                 "",
 326                 "test-run-directory",
 327                 "The working directory in which to run tests",
 328                 "PATH",
 329             )
 330         }),
 331         stable("target", |o| o.optopt("", "target", "target triple to document", "TRIPLE")),
 332         stable("markdown-css", |o| {
 333             o.optmulti(
 334                 "",
 335                 "markdown-css",
 336                 "CSS files to include via <link> in a rendered Markdown file",
 337                 "FILES",
 338             )
 339         }),
 340         stable("html-in-header", |o| {
 341             o.optmulti(
 342                 "",
 343                 "html-in-header",
 344                 "files to include inline in the <head> section of a rendered Markdown file \
 345                  or generated documentation",
 346                 "FILES",
 347             )
 348         }),
 349         stable("html-before-content", |o| {
 350             o.optmulti(
 351                 "",
 352                 "html-before-content",
 353                 "files to include inline between <body> and the content of a rendered \
 354                  Markdown file or generated documentation",
 355                 "FILES",
 356             )
 357         }),
 358         stable("html-after-content", |o| {
 359             o.optmulti(
 360                 "",
 361                 "html-after-content",
 362                 "files to include inline between the content and </body> of a rendered \
 363                  Markdown file or generated documentation",
 364                 "FILES",
 365             )
 366         }),
 367         unstable("markdown-before-content", |o| {
 368             o.optmulti(
 369                 "",
 370                 "markdown-before-content",
 371                 "files to include inline between <body> and the content of a rendered \
 372                  Markdown file or generated documentation",
 373                 "FILES",
 374             )
 375         }),
 376         unstable("markdown-after-content", |o| {
 377             o.optmulti(
 378                 "",
 379                 "markdown-after-content",
 380                 "files to include inline between the content and </body> of a rendered \
 381                  Markdown file or generated documentation",
 382                 "FILES",
 383             )
 384         }),
 385         stable("markdown-playground-url", |o| {
 386             o.optopt("", "markdown-playground-url", "URL to send code snippets to", "URL")
 387         }),
 388         stable("markdown-no-toc", |o| {
 389             o.optflagmulti("", "markdown-no-toc", "don't include table of contents")
 390         }),
 391         stable("e", |o| {
 392             o.optopt(
 393                 "e",
 394                 "extend-css",
 395                 "To add some CSS rules with a given file to generate doc with your \
 396                  own theme. However, your theme might break if the rustdoc's generated HTML \
 397                  changes, so be careful!",
 398                 "PATH",
 399             )
 400         }),
 401         unstable("Z", |o| {
 402             o.optmulti("Z", "", "internal and debugging options (only on nightly build)", "FLAG")
 403         }),
 404         stable("sysroot", |o| o.optopt("", "sysroot", "Override the system root", "PATH")),
 405         unstable("playground-url", |o| {
 406             o.optopt(
 407                 "",
 408                 "playground-url",
 409                 "URL to send code snippets to, may be reset by --markdown-playground-url \
 410                  or `#![doc(html_playground_url=...)]`",
 411                 "URL",
 412             )
 413         }),
 414         unstable("display-warnings", |o| {
 415             o.optflagmulti("", "display-warnings", "to print code warnings when testing doc")
 416         }),
 417         stable("crate-version", |o| {
 418             o.optopt("", "crate-version", "crate version to print into documentation", "VERSION")
 419         }),
 420         unstable("sort-modules-by-appearance", |o| {
 421             o.optflagmulti(
 422                 "",
 423                 "sort-modules-by-appearance",
 424                 "sort modules by where they appear in the program, rather than alphabetically",
 425             )
 426         }),
 427         stable("default-theme", |o| {
 428             o.optopt(
 429                 "",
 430                 "default-theme",
 431                 "Set the default theme. THEME should be the theme name, generally lowercase. \
 432                  If an unknown default theme is specified, the builtin default is used. \
 433                  The set of themes, and the rustdoc built-in default, are not stable.",
 434                 "THEME",
 435             )
 436         }),
 437         unstable("default-setting", |o| {
 438             o.optmulti(
 439                 "",
 440                 "default-setting",
 441                 "Default value for a rustdoc setting (used when \"rustdoc-SETTING\" is absent \
 442                  from web browser Local Storage). If VALUE is not supplied, \"true\" is used. \
 443                  Supported SETTINGs and VALUEs are not documented and not stable.",
 444                 "SETTING[=VALUE]",
 445             )
 446         }),
 447         stable("theme", |o| {
 448             o.optmulti(
 449                 "",
 450                 "theme",
 451                 "additional themes which will be added to the generated docs",
 452                 "FILES",
 453             )
 454         }),
 455         stable("check-theme", |o| {
 456             o.optmulti("", "check-theme", "check if given theme is valid", "FILES")
 457         }),
 458         unstable("resource-suffix", |o| {
 459             o.optopt(
 460                 "",
 461                 "resource-suffix",
 462                 "suffix to add to CSS and JavaScript files, e.g., \"light.css\" will become \
 463                  \"light-suffix.css\"",
 464                 "PATH",
 465             )
 466         }),
 467         stable("edition", |o| {
 468             o.optopt(
 469                 "",
 470                 "edition",
 471                 "edition to use when compiling rust code (default: 2015)",
 472                 "EDITION",
 473             )
 474         }),
 475         stable("color", |o| {
 476             o.optopt(
 477                 "",
 478                 "color",
 479                 "Configure coloring of output:
 480                                           auto   = colorize, if output goes to a tty (default);
 481                                           always = always colorize output;
 482                                           never  = never colorize output",
 483                 "auto|always|never",
 484             )
 485         }),
 486         stable("error-format", |o| {
 487             o.optopt(
 488                 "",
 489                 "error-format",
 490                 "How errors and other messages are produced",
 491                 "human|json|short",
 492             )
 493         }),
 494         stable("json", |o| {
 495             o.optopt("", "json", "Configure the structure of JSON diagnostics", "CONFIG")
 496         }),
 497         unstable("disable-minification", |o| {
 498             o.optflagmulti("", "disable-minification", "Disable minification applied on JS files")
 499         }),
 500         stable("warn", |o| o.optmulti("W", "warn", "Set lint warnings", "OPT")),
 501         stable("allow", |o| o.optmulti("A", "allow", "Set lint allowed", "OPT")),
 502         stable("deny", |o| o.optmulti("D", "deny", "Set lint denied", "OPT")),
 503         stable("forbid", |o| o.optmulti("F", "forbid", "Set lint forbidden", "OPT")),
 504         stable("cap-lints", |o| {
 505             o.optmulti(
 506                 "",
 507                 "cap-lints",
 508                 "Set the most restrictive lint level. \
 509                  More restrictive lints are capped at this \
 510                  level. By default, it is at `forbid` level.",
 511                 "LEVEL",
 512             )
 513         }),
 514         unstable("force-warn", |o| {
 515             o.optopt(
 516                 "",
 517                 "force-warn",
 518                 "Lints that will warn even if allowed somewhere else",
 519                 "LINTS",
 520             )
 521         }),
 522         unstable("index-page", |o| {
 523             o.optopt("", "index-page", "Markdown file to be used as index page", "PATH")
 524         }),
 525         unstable("enable-index-page", |o| {
 526             o.optflagmulti("", "enable-index-page", "To enable generation of the index page")
 527         }),
 528         unstable("static-root-path", |o| {
 529             o.optopt(
 530                 "",
 531                 "static-root-path",
 532                 "Path string to force loading static files from in output pages. \
 533                  If not set, uses combinations of '../' to reach the documentation root.",
 534                 "PATH",
 535             )
 536         }),
 537         unstable("disable-per-crate-search", |o| {
 538             o.optflagmulti(
 539                 "",
 540                 "disable-per-crate-search",
 541                 "disables generating the crate selector on the search box",
 542             )
 543         }),
 544         unstable("persist-doctests", |o| {
 545             o.optopt(
 546                 "",
 547                 "persist-doctests",
 548                 "Directory to persist doctest executables into",
 549                 "PATH",
 550             )
 551         }),
 552         unstable("show-coverage", |o| {
 553             o.optflagmulti(
 554                 "",
 555                 "show-coverage",
 556                 "calculate percentage of public items with documentation",
 557             )
 558         }),
 559         unstable("enable-per-target-ignores", |o| {
 560             o.optflagmulti(
 561                 "",
 562                 "enable-per-target-ignores",
 563                 "parse ignore-foo for ignoring doctests on a per-target basis",
 564             )
 565         }),
 566         unstable("runtool", |o| {
 567             o.optopt(
 568                 "",
 569                 "runtool",
 570                 "",
 571                 "The tool to run tests with when building for a different target than host",
 572             )
 573         }),
 574         unstable("runtool-arg", |o| {
 575             o.optmulti(
 576                 "",
 577                 "runtool-arg",
 578                 "",
 579                 "One (of possibly many) arguments to pass to the runtool",
 580             )
 581         }),
 582         unstable("test-builder", |o| {
 583             o.optopt("", "test-builder", "The rustc-like binary to use as the test builder", "PATH")
 584         }),
 585         unstable("check", |o| o.optflagmulti("", "check", "Run rustdoc checks")),
 586         unstable("generate-redirect-map", |o| {
 587             o.optflagmulti(
 588                 "",
 589                 "generate-redirect-map",
 590                 "Generate JSON file at the top level instead of generating HTML redirection files",
 591             )
 592         }),
 593         unstable("emit", |o| {
 594             o.optmulti(
 595                 "",
 596                 "emit",
 597                 "Comma separated list of types of output for rustdoc to emit",
 598                 "[unversioned-shared-resources,toolchain-shared-resources,invocation-specific]",
 599             )
 600         }),
 601         unstable("no-run", |o| {
 602             o.optflagmulti("", "no-run", "Compile doctests without running them")
 603         }),
 604         unstable("show-type-layout", |o| {
 605             o.optflagmulti("", "show-type-layout", "Include the memory layout of types in the docs")
 606         }),
 607         unstable("nocapture", |o| {
 608             o.optflag("", "nocapture", "Don't capture stdout and stderr of tests")
 609         }),
 610         unstable("generate-link-to-definition", |o| {
 611             o.optflag(
 612                 "",
 613                 "generate-link-to-definition",
 614                 "Make the identifiers in the HTML source code pages navigable",
 615             )
 616         }),
 617     ]
 618 }
 619
 620 fn usage(argv0: &str) {
 621     let mut options = getopts::Options::new();
 622     for option in opts() {
 623         (option.apply)(&mut options);
 624     }
 625     println!("{}", options.usage(&format!("{} [options] <input>", argv0)));
 626     println!("    @path               Read newline separated options from `path`\n");
 627     println!(
 628         "More information available at {}/rustdoc/what-is-rustdoc.html",
 629         DOC_RUST_LANG_ORG_CHANNEL
 630     );
 631 }
 632
 633 /// A result type used by several functions under `main()`.
 634 type MainResult = Result<(), ErrorReported>;
 635
 636 fn main_args(at_args: &[String]) -> MainResult {
 637     let args = rustc_driver::args::arg_expand_all(at_args);
 638
 639     let mut options = getopts::Options::new();
 640     for option in opts() {
 641         (option.apply)(&mut options);
 642     }
 643     let matches = match options.parse(&args[1..]) {
 644         Ok(m) => m,
 645         Err(err) => {
 646             early_error(ErrorOutputType::default(), &err.to_string());
 647         }
 648     };
 649
 650     // Note that we discard any distinction between different non-zero exit
 651     // codes from `from_matches` here.
 652     let options = match config::Options::from_matches(&matches) {
 653         Ok(opts) => opts,
 654         Err(code) => return if code == 0 { Ok(()) } else { Err(ErrorReported) },
 655     };
 656     rustc_interface::util::setup_callbacks_and_run_in_thread_pool_with_globals(
 657         options.edition,
 658         1, // this runs single-threaded, even in a parallel compiler
 659         &None,
 660         move || main_options(options),
 661     )
 662 }
 663
 664 fn wrap_return(diag: &rustc_errors::Handler, res: Result<(), String>) -> MainResult {
 665     match res {
 666         Ok(()) => Ok(()),
 667         Err(err) => {
 668             diag.struct_err(&err).emit();
 669             Err(ErrorReported)
 670         }
 671     }
 672 }
 673
 674 fn run_renderer<'tcx, T: formats::FormatRenderer<'tcx>>(
 675     krate: clean::Crate,
 676     renderopts: config::RenderOptions,
 677     cache: formats::cache::Cache,
 678     tcx: TyCtxt<'tcx>,
 679 ) -> MainResult {
 680     match formats::run_format::<T>(krate, renderopts, cache, tcx) {
 681         Ok(_) => Ok(()),
 682         Err(e) => {
 683             let mut msg =
 684                 tcx.sess.struct_err(&format!("couldn't generate documentation: {}", e.error));
 685             let file = e.file.display().to_string();
 686             if file.is_empty() {
 687                 msg.emit()
 688             } else {
 689                 msg.note(&format!("failed to create or modify \"{}\"", file)).emit()
 690             }
 691             Err(ErrorReported)
 692         }
 693     }
 694 }
 695
 696 fn main_options(options: config::Options) -> MainResult {
 697     let diag = core::new_handler(options.error_format, None, &options.debugging_opts);
 698
 699     match (options.should_test, options.markdown_input()) {
 700         (true, true) => return wrap_return(&diag, markdown::test(options)),
 701         (true, false) => return doctest::run(options),
 702         (false, true) => {
 703             return wrap_return(
 704                 &diag,
 705                 markdown::render(&options.input, options.render_options, options.edition),
 706             );
 707         }
 708         (false, false) => {}
 709     }
 710
 711     // need to move these items separately because we lose them by the time the closure is called,
 712     // but we can't create the Handler ahead of time because it's not Send
 713     let show_coverage = options.show_coverage;
 714     let run_check = options.run_check;
 715
 716     // First, parse the crate and extract all relevant information.
 717     info!("starting to run rustc");
 718
 719     // Interpret the input file as a rust source file, passing it through the
 720     // compiler all the way through the analysis passes. The rustdoc output is
 721     // then generated from the cleaned AST of the crate. This runs all the
 722     // plug/cleaning passes.
 723     let crate_version = options.crate_version.clone();
 724
 725     let default_passes = options.default_passes;
 726     let output_format = options.output_format;
 727     // FIXME: fix this clone (especially render_options)
 728     let externs = options.externs.clone();
 729     let manual_passes = options.manual_passes.clone();
 730     let render_options = options.render_options.clone();
 731     let config = core::create_config(options);
 732
 733     interface::create_compiler_and_run(config, |compiler| {
 734         compiler.enter(|queries| {
 735             let sess = compiler.session();
 736
 737             if sess.opts.describe_lints {
 738                 let (_, lint_store) = &*queries.register_plugins()?.peek();
 739                 describe_lints(sess, lint_store, true);
 740                 return Ok(());
 741             }
 742
 743             // We need to hold on to the complete resolver, so we cause everything to be
 744             // cloned for the analysis passes to use. Suboptimal, but necessary in the
 745             // current architecture.
 746             let resolver = core::create_resolver(externs, queries, &sess);
 747
 748             if sess.has_errors() {
 749                 sess.fatal("Compilation failed, aborting rustdoc");
 750             }
 751
 752             let mut global_ctxt = abort_on_err(queries.global_ctxt(), sess).peek_mut();
 753
 754             global_ctxt.enter(|tcx| {
 755                 let (krate, render_opts, mut cache) = sess.time("run_global_ctxt", || {
 756                     core::run_global_ctxt(
 757                         tcx,
 758                         resolver,
 759                         default_passes,
 760                         manual_passes,
 761                         render_options,
 762                         output_format,
 763                     )
 764                 });
 765                 info!("finished with rustc");
 766
 767                 cache.crate_version = crate_version;
 768
 769                 if show_coverage {
 770                     // if we ran coverage, bail early, we don't need to also generate docs at this point
 771                     // (also we didn't load in any of the useful passes)
 772                     return Ok(());
 773                 } else if run_check {
 774                     // Since we're in "check" mode, no need to generate anything beyond this point.
 775                     return Ok(());
 776                 }
 777
 778                 info!("going to format");
 779                 match output_format {
 780                     config::OutputFormat::Html => sess.time("render_html", || {
 781                         run_renderer::<html::render::Context<'_>>(krate, render_opts, cache, tcx)
 782                     }),
 783                     config::OutputFormat::Json => sess.time("render_json", || {
 784                         run_renderer::<json::JsonRenderer<'_>>(krate, render_opts, cache, tcx)
 785                     }),
 786                 }
 787             })
 788         })
 789     })
 790 }