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