src/librustdoc/lib.rs

   1 // Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
  12        html_favicon_url = "https://doc.rust-lang.org/favicon.ico",
  13        html_root_url = "https://doc.rust-lang.org/nightly/",
  14        html_playground_url = "https://play.rust-lang.org/")]
  15
  16 #![feature(rustc_private)]
  17 #![feature(box_patterns)]
  18 #![feature(box_syntax)]
  19 #![cfg_attr(not(stage0), feature(nll))]
  20 #![feature(set_stdio)]
  21 #![feature(slice_sort_by_cached_key)]
  22 #![feature(test)]
  23 #![feature(vec_remove_item)]
  24 #![feature(ptr_offset_from)]
  25 #![feature(crate_visibility_modifier)]
  26 #![feature(const_fn)]
  27
  28 #![recursion_limit="256"]
  29
  30 extern crate arena;
  31 extern crate getopts;
  32 extern crate env_logger;
  33 extern crate rustc;
  34 extern crate rustc_data_structures;
  35 extern crate rustc_codegen_utils;
  36 extern crate rustc_driver;
  37 extern crate rustc_resolve;
  38 extern crate rustc_lint;
  39 extern crate rustc_metadata;
  40 extern crate rustc_target;
  41 extern crate rustc_typeck;
  42 extern crate serialize;
  43 #[macro_use] extern crate syntax;
  44 extern crate syntax_pos;
  45 extern crate test as testing;
  46 #[macro_use] extern crate log;
  47 extern crate rustc_errors as errors;
  48 extern crate pulldown_cmark;
  49 extern crate tempfile;
  50 extern crate minifier;
  51
  52 extern crate serialize as rustc_serialize; // used by deriving
  53
  54 use errors::ColorConfig;
  55
  56 use std::collections::{BTreeMap, BTreeSet};
  57 use std::default::Default;
  58 use std::env;
  59 use std::panic;
  60 use std::path::{Path, PathBuf};
  61 use std::process;
  62 use std::sync::mpsc::channel;
  63
  64 use syntax::edition::Edition;
  65 use externalfiles::ExternalHtml;
  66 use rustc::session::{early_warn, early_error};
  67 use rustc::session::search_paths::SearchPaths;
  68 use rustc::session::config::{ErrorOutputType, RustcOptGroup, Externs, CodegenOptions};
  69 use rustc::session::config::{nightly_options, build_codegen_options};
  70 use rustc_target::spec::TargetTriple;
  71 use rustc::session::config::get_cmd_lint_options;
  72
  73 #[macro_use]
  74 mod externalfiles;
  75
  76 mod clean;
  77 mod core;
  78 mod doctree;
  79 mod fold;
  80 pub mod html {
  81     crate mod highlight;
  82     crate mod escape;
  83     crate mod item_type;
  84     crate mod format;
  85     crate mod layout;
  86     pub mod markdown;
  87     crate mod render;
  88     crate mod toc;
  89 }
  90 mod markdown;
  91 mod passes;
  92 mod visit_ast;
  93 mod visit_lib;
  94 mod test;
  95 mod theme;
  96
  97 struct Output {
  98     krate: clean::Crate,
  99     renderinfo: html::render::RenderInfo,
 100     passes: Vec<String>,
 101 }
 102
 103 pub fn main() {
 104     let thread_stack_size: usize = if cfg!(target_os = "haiku") {
 105         16_000_000 // 16MB on Haiku
 106     } else {
 107         32_000_000 // 32MB on other platforms
 108     };
 109     rustc_driver::set_sigpipe_handler();
 110     env_logger::init();
 111     let res = std::thread::Builder::new().stack_size(thread_stack_size).spawn(move || {
 112         syntax::with_globals(move || {
 113             get_args().map(|args| main_args(&args)).unwrap_or(1)
 114         })
 115     }).unwrap().join().unwrap_or(rustc_driver::EXIT_FAILURE);
 116     process::exit(res as i32);
 117 }
 118
 119 fn get_args() -> Option<Vec<String>> {
 120     env::args_os().enumerate()
 121         .map(|(i, arg)| arg.into_string().map_err(|arg| {
 122              early_warn(ErrorOutputType::default(),
 123                         &format!("Argument {} is not valid Unicode: {:?}", i, arg));
 124         }).ok())
 125         .collect()
 126 }
 127
 128 fn stable<F>(name: &'static str, f: F) -> RustcOptGroup
 129     where F: Fn(&mut getopts::Options) -> &mut getopts::Options + 'static
 130 {
 131     RustcOptGroup::stable(name, f)
 132 }
 133
 134 fn unstable<F>(name: &'static str, f: F) -> RustcOptGroup
 135     where F: Fn(&mut getopts::Options) -> &mut getopts::Options + 'static
 136 {
 137     RustcOptGroup::unstable(name, f)
 138 }
 139
 140 fn opts() -> Vec<RustcOptGroup> {
 141     vec![
 142         stable("h", |o| o.optflag("h", "help", "show this help message")),
 143         stable("V", |o| o.optflag("V", "version", "print rustdoc's version")),
 144         stable("v", |o| o.optflag("v", "verbose", "use verbose output")),
 145         stable("r", |o| {
 146             o.optopt("r", "input-format", "the input type of the specified file",
 147                      "[rust]")
 148         }),
 149         stable("w", |o| {
 150             o.optopt("w", "output-format", "the output type to write", "[html]")
 151         }),
 152         stable("o", |o| o.optopt("o", "output", "where to place the output", "PATH")),
 153         stable("crate-name", |o| {
 154             o.optopt("", "crate-name", "specify the name of this crate", "NAME")
 155         }),
 156         stable("L", |o| {
 157             o.optmulti("L", "library-path", "directory to add to crate search path",
 158                        "DIR")
 159         }),
 160         stable("cfg", |o| o.optmulti("", "cfg", "pass a --cfg to rustc", "")),
 161         stable("extern", |o| {
 162             o.optmulti("", "extern", "pass an --extern to rustc", "NAME=PATH")
 163         }),
 164         unstable("extern-html-root-url", |o| {
 165             o.optmulti("", "extern-html-root-url",
 166                        "base URL to use for dependencies", "NAME=URL")
 167         }),
 168         stable("plugin-path", |o| {
 169             o.optmulti("", "plugin-path", "removed", "DIR")
 170         }),
 171         stable("C", |o| {
 172             o.optmulti("C", "codegen", "pass a codegen option to rustc", "OPT[=VALUE]")
 173         }),
 174         stable("passes", |o| {
 175             o.optmulti("", "passes",
 176                        "list of passes to also run, you might want \
 177                         to pass it multiple times; a value of `list` \
 178                         will print available passes",
 179                        "PASSES")
 180         }),
 181         stable("plugins", |o| {
 182             o.optmulti("", "plugins", "removed",
 183                        "PLUGINS")
 184         }),
 185         stable("no-default", |o| {
 186             o.optflag("", "no-defaults", "don't run the default passes")
 187         }),
 188         stable("document-private-items", |o| {
 189             o.optflag("", "document-private-items", "document private items")
 190         }),
 191         stable("test", |o| o.optflag("", "test", "run code examples as tests")),
 192         stable("test-args", |o| {
 193             o.optmulti("", "test-args", "arguments to pass to the test runner",
 194                        "ARGS")
 195         }),
 196         stable("target", |o| o.optopt("", "target", "target triple to document", "TRIPLE")),
 197         stable("markdown-css", |o| {
 198             o.optmulti("", "markdown-css",
 199                        "CSS files to include via <link> in a rendered Markdown file",
 200                        "FILES")
 201         }),
 202         stable("html-in-header", |o|  {
 203             o.optmulti("", "html-in-header",
 204                        "files to include inline in the <head> section of a rendered Markdown file \
 205                         or generated documentation",
 206                        "FILES")
 207         }),
 208         stable("html-before-content", |o| {
 209             o.optmulti("", "html-before-content",
 210                        "files to include inline between <body> and the content of a rendered \
 211                         Markdown file or generated documentation",
 212                        "FILES")
 213         }),
 214         stable("html-after-content", |o| {
 215             o.optmulti("", "html-after-content",
 216                        "files to include inline between the content and </body> of a rendered \
 217                         Markdown file or generated documentation",
 218                        "FILES")
 219         }),
 220         unstable("markdown-before-content", |o| {
 221             o.optmulti("", "markdown-before-content",
 222                        "files to include inline between <body> and the content of a rendered \
 223                         Markdown file or generated documentation",
 224                        "FILES")
 225         }),
 226         unstable("markdown-after-content", |o| {
 227             o.optmulti("", "markdown-after-content",
 228                        "files to include inline between the content and </body> of a rendered \
 229                         Markdown file or generated documentation",
 230                        "FILES")
 231         }),
 232         stable("markdown-playground-url", |o| {
 233             o.optopt("", "markdown-playground-url",
 234                      "URL to send code snippets to", "URL")
 235         }),
 236         stable("markdown-no-toc", |o| {
 237             o.optflag("", "markdown-no-toc", "don't include table of contents")
 238         }),
 239         stable("e", |o| {
 240             o.optopt("e", "extend-css",
 241                      "To add some CSS rules with a given file to generate doc with your \
 242                       own theme. However, your theme might break if the rustdoc's generated HTML \
 243                       changes, so be careful!", "PATH")
 244         }),
 245         unstable("Z", |o| {
 246             o.optmulti("Z", "",
 247                        "internal and debugging options (only on nightly build)", "FLAG")
 248         }),
 249         stable("sysroot", |o| {
 250             o.optopt("", "sysroot", "Override the system root", "PATH")
 251         }),
 252         unstable("playground-url", |o| {
 253             o.optopt("", "playground-url",
 254                      "URL to send code snippets to, may be reset by --markdown-playground-url \
 255                       or `#![doc(html_playground_url=...)]`",
 256                      "URL")
 257         }),
 258         unstable("display-warnings", |o| {
 259             o.optflag("", "display-warnings", "to print code warnings when testing doc")
 260         }),
 261         unstable("crate-version", |o| {
 262             o.optopt("", "crate-version", "crate version to print into documentation", "VERSION")
 263         }),
 264         unstable("linker", |o| {
 265             o.optopt("", "linker", "linker used for building executable test code", "PATH")
 266         }),
 267         unstable("sort-modules-by-appearance", |o| {
 268             o.optflag("", "sort-modules-by-appearance", "sort modules by where they appear in the \
 269                                                          program, rather than alphabetically")
 270         }),
 271         unstable("themes", |o| {
 272             o.optmulti("", "themes",
 273                        "additional themes which will be added to the generated docs",
 274                        "FILES")
 275         }),
 276         unstable("theme-checker", |o| {
 277             o.optmulti("", "theme-checker",
 278                        "check if given theme is valid",
 279                        "FILES")
 280         }),
 281         unstable("resource-suffix", |o| {
 282             o.optopt("",
 283                      "resource-suffix",
 284                      "suffix to add to CSS and JavaScript files, e.g. \"light.css\" will become \
 285                       \"light-suffix.css\"",
 286                      "PATH")
 287         }),
 288         stable("edition", |o| {
 289             o.optopt("", "edition",
 290                      "edition to use when compiling rust code (default: 2015)",
 291                      "EDITION")
 292         }),
 293         stable("color", |o| {
 294             o.optopt("",
 295                      "color",
 296                      "Configure coloring of output:
 297                                           auto   = colorize, if output goes to a tty (default);
 298                                           always = always colorize output;
 299                                           never  = never colorize output",
 300                      "auto|always|never")
 301         }),
 302         stable("error-format", |o| {
 303             o.optopt("",
 304                      "error-format",
 305                      "How errors and other messages are produced",
 306                      "human|json|short")
 307         }),
 308         unstable("disable-minification", |o| {
 309              o.optflag("",
 310                        "disable-minification",
 311                        "Disable minification applied on JS files")
 312         }),
 313         stable("warn", |o| {
 314             o.optmulti("W", "warn", "Set lint warnings", "OPT")
 315         }),
 316         stable("allow", |o| {
 317             o.optmulti("A", "allow", "Set lint allowed", "OPT")
 318         }),
 319         stable("deny", |o| {
 320             o.optmulti("D", "deny", "Set lint denied", "OPT")
 321         }),
 322         stable("forbid", |o| {
 323             o.optmulti("F", "forbid", "Set lint forbidden", "OPT")
 324         }),
 325         stable("cap-lints", |o| {
 326             o.optmulti(
 327                 "",
 328                 "cap-lints",
 329                 "Set the most restrictive lint level. \
 330                  More restrictive lints are capped at this \
 331                  level. By default, it is at `forbid` level.",
 332                 "LEVEL",
 333             )
 334         }),
 335     ]
 336 }
 337
 338 fn usage(argv0: &str) {
 339     let mut options = getopts::Options::new();
 340     for option in opts() {
 341         (option.apply)(&mut options);
 342     }
 343     println!("{}", options.usage(&format!("{} [options] <input>", argv0)));
 344 }
 345
 346 fn main_args(args: &[String]) -> isize {
 347     let mut options = getopts::Options::new();
 348     for option in opts() {
 349         (option.apply)(&mut options);
 350     }
 351     let matches = match options.parse(&args[1..]) {
 352         Ok(m) => m,
 353         Err(err) => {
 354             early_error(ErrorOutputType::default(), &err.to_string());
 355         }
 356     };
 357     // Check for unstable options.
 358     nightly_options::check_nightly_options(&matches, &opts());
 359
 360     if matches.opt_present("h") || matches.opt_present("help") {
 361         usage("rustdoc");
 362         return 0;
 363     } else if matches.opt_present("version") {
 364         rustc_driver::version("rustdoc", &matches);
 365         return 0;
 366     }
 367
 368     if matches.opt_strs("passes") == ["list"] {
 369         println!("Available passes for running rustdoc:");
 370         for pass in passes::PASSES {
 371             println!("{:>20} - {}", pass.name(), pass.description());
 372         }
 373         println!("\nDefault passes for rustdoc:");
 374         for &name in passes::DEFAULT_PASSES {
 375             println!("{:>20}", name);
 376         }
 377         println!("\nPasses run with `--document-private-items`:");
 378         for &name in passes::DEFAULT_PRIVATE_PASSES {
 379             println!("{:>20}", name);
 380         }
 381         return 0;
 382     }
 383
 384     let color = match matches.opt_str("color").as_ref().map(|s| &s[..]) {
 385         Some("auto") => ColorConfig::Auto,
 386         Some("always") => ColorConfig::Always,
 387         Some("never") => ColorConfig::Never,
 388         None => ColorConfig::Auto,
 389         Some(arg) => {
 390             early_error(ErrorOutputType::default(),
 391                         &format!("argument for --color must be `auto`, `always` or `never` \
 392                                   (instead was `{}`)", arg));
 393         }
 394     };
 395     let error_format = match matches.opt_str("error-format").as_ref().map(|s| &s[..]) {
 396         Some("human") => ErrorOutputType::HumanReadable(color),
 397         Some("json") => ErrorOutputType::Json(false),
 398         Some("pretty-json") => ErrorOutputType::Json(true),
 399         Some("short") => ErrorOutputType::Short(color),
 400         None => ErrorOutputType::HumanReadable(color),
 401         Some(arg) => {
 402             early_error(ErrorOutputType::default(),
 403                         &format!("argument for --error-format must be `human`, `json` or \
 404                                   `short` (instead was `{}`)", arg));
 405         }
 406     };
 407
 408     let diag = core::new_handler(error_format, None);
 409
 410     // check for deprecated options
 411     check_deprecated_options(&matches, &diag);
 412
 413     let to_check = matches.opt_strs("theme-checker");
 414     if !to_check.is_empty() {
 415         let paths = theme::load_css_paths(include_bytes!("html/static/themes/light.css"));
 416         let mut errors = 0;
 417
 418         println!("rustdoc: [theme-checker] Starting tests!");
 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 1;
 434         }
 435         return 0;
 436     }
 437
 438     if matches.free.is_empty() {
 439         diag.struct_err("missing file operand").emit();
 440         return 1;
 441     }
 442     if matches.free.len() > 1 {
 443         diag.struct_err("too many file operands").emit();
 444         return 1;
 445     }
 446     let input = &matches.free[0];
 447
 448     let mut libs = SearchPaths::new();
 449     for s in &matches.opt_strs("L") {
 450         libs.add_path(s, error_format);
 451     }
 452     let externs = match parse_externs(&matches) {
 453         Ok(ex) => ex,
 454         Err(err) => {
 455             diag.struct_err(&err.to_string()).emit();
 456             return 1;
 457         }
 458     };
 459     let extern_urls = match parse_extern_html_roots(&matches) {
 460         Ok(ex) => ex,
 461         Err(err) => {
 462             diag.struct_err(err).emit();
 463             return 1;
 464         }
 465     };
 466
 467     let test_args = matches.opt_strs("test-args");
 468     let test_args: Vec<String> = test_args.iter()
 469                                           .flat_map(|s| s.split_whitespace())
 470                                           .map(|s| s.to_string())
 471                                           .collect();
 472
 473     let should_test = matches.opt_present("test");
 474     let markdown_input = Path::new(input).extension()
 475         .map_or(false, |e| e == "md" || e == "markdown");
 476
 477     let output = matches.opt_str("o").map(|s| PathBuf::from(&s));
 478     let css_file_extension = matches.opt_str("e").map(|s| PathBuf::from(&s));
 479     let mut cfgs = matches.opt_strs("cfg");
 480     cfgs.push("rustdoc".to_string());
 481
 482     if let Some(ref p) = css_file_extension {
 483         if !p.is_file() {
 484             diag.struct_err("option --extend-css argument must be a file").emit();
 485             return 1;
 486         }
 487     }
 488
 489     let mut themes = Vec::new();
 490     if matches.opt_present("themes") {
 491         let paths = theme::load_css_paths(include_bytes!("html/static/themes/light.css"));
 492
 493         for (theme_file, theme_s) in matches.opt_strs("themes")
 494                                             .iter()
 495                                             .map(|s| (PathBuf::from(&s), s.to_owned())) {
 496             if !theme_file.is_file() {
 497                 diag.struct_err("option --themes arguments must all be files").emit();
 498                 return 1;
 499             }
 500             let (success, ret) = theme::test_theme_against(&theme_file, &paths, &diag);
 501             if !success || !ret.is_empty() {
 502                 diag.struct_err(&format!("invalid theme: \"{}\"", theme_s))
 503                     .help("check what's wrong with the --theme-checker option")
 504                     .emit();
 505                 return 1;
 506             }
 507             themes.push(theme_file);
 508         }
 509     }
 510
 511     let mut id_map = html::markdown::IdMap::new();
 512     id_map.populate(html::render::initial_ids());
 513     let external_html = match ExternalHtml::load(
 514             &matches.opt_strs("html-in-header"),
 515             &matches.opt_strs("html-before-content"),
 516             &matches.opt_strs("html-after-content"),
 517             &matches.opt_strs("markdown-before-content"),
 518             &matches.opt_strs("markdown-after-content"), &diag, &mut id_map) {
 519         Some(eh) => eh,
 520         None => return 3,
 521     };
 522     let crate_name = matches.opt_str("crate-name");
 523     let playground_url = matches.opt_str("playground-url");
 524     let maybe_sysroot = matches.opt_str("sysroot").map(PathBuf::from);
 525     let display_warnings = matches.opt_present("display-warnings");
 526     let linker = matches.opt_str("linker").map(PathBuf::from);
 527     let sort_modules_alphabetically = !matches.opt_present("sort-modules-by-appearance");
 528     let resource_suffix = matches.opt_str("resource-suffix");
 529     let enable_minification = !matches.opt_present("disable-minification");
 530
 531     let edition = matches.opt_str("edition").unwrap_or("2015".to_string());
 532     let edition = match edition.parse() {
 533         Ok(e) => e,
 534         Err(_) => {
 535             diag.struct_err("could not parse edition").emit();
 536             return 1;
 537         }
 538     };
 539
 540     let cg = build_codegen_options(&matches, ErrorOutputType::default());
 541
 542     match (should_test, markdown_input) {
 543         (true, true) => {
 544             return markdown::test(input, cfgs, libs, externs, test_args, maybe_sysroot,
 545                                   display_warnings, linker, edition, cg, &diag)
 546         }
 547         (true, false) => {
 548             return test::run(Path::new(input), cfgs, libs, externs, test_args, crate_name,
 549                              maybe_sysroot, display_warnings, linker, edition, cg)
 550         }
 551         (false, true) => return markdown::render(Path::new(input),
 552                                                  output.unwrap_or(PathBuf::from("doc")),
 553                                                  &matches, &external_html,
 554                                                  !matches.opt_present("markdown-no-toc"), &diag),
 555         (false, false) => {}
 556     }
 557
 558     let output_format = matches.opt_str("w");
 559
 560     let res = acquire_input(PathBuf::from(input), externs, edition, cg, &matches, error_format,
 561                             move |out| {
 562         let Output { krate, passes, renderinfo } = out;
 563         let diag = core::new_handler(error_format, None);
 564         info!("going to format");
 565         match output_format.as_ref().map(|s| &**s) {
 566             Some("html") | None => {
 567                 html::render::run(krate, extern_urls, &external_html, playground_url,
 568                                   output.unwrap_or(PathBuf::from("doc")),
 569                                   resource_suffix.unwrap_or(String::new()),
 570                                   passes.into_iter().collect(),
 571                                   css_file_extension,
 572                                   renderinfo,
 573                                   sort_modules_alphabetically,
 574                                   themes,
 575                                   enable_minification, id_map)
 576                     .expect("failed to generate documentation");
 577                 0
 578             }
 579             Some(s) => {
 580                 diag.struct_err(&format!("unknown output format: {}", s)).emit();
 581                 1
 582             }
 583         }
 584     });
 585     res.unwrap_or_else(|s| {
 586         diag.struct_err(&format!("input error: {}", s)).emit();
 587         1
 588     })
 589 }
 590
 591 /// Looks inside the command line arguments to extract the relevant input format
 592 /// and files and then generates the necessary rustdoc output for formatting.
 593 fn acquire_input<R, F>(input: PathBuf,
 594                        externs: Externs,
 595                        edition: Edition,
 596                        cg: CodegenOptions,
 597                        matches: &getopts::Matches,
 598                        error_format: ErrorOutputType,
 599                        f: F)
 600                        -> Result<R, String>
 601 where R: 'static + Send, F: 'static + Send + FnOnce(Output) -> R {
 602     match matches.opt_str("r").as_ref().map(|s| &**s) {
 603         Some("rust") => Ok(rust_input(input, externs, edition, cg, matches, error_format, f)),
 604         Some(s) => Err(format!("unknown input format: {}", s)),
 605         None => Ok(rust_input(input, externs, edition, cg, matches, error_format, f))
 606     }
 607 }
 608
 609 /// Extracts `--extern CRATE=PATH` arguments from `matches` and
 610 /// returns a map mapping crate names to their paths or else an
 611 /// error message.
 612 fn parse_externs(matches: &getopts::Matches) -> Result<Externs, String> {
 613     let mut externs: BTreeMap<_, BTreeSet<_>> = BTreeMap::new();
 614     for arg in &matches.opt_strs("extern") {
 615         let mut parts = arg.splitn(2, '=');
 616         let name = parts.next().ok_or("--extern value must not be empty".to_string())?;
 617         let location = parts.next()
 618                                  .ok_or("--extern value must be of the format `foo=bar`"
 619                                     .to_string())?;
 620         let name = name.to_string();
 621         externs.entry(name).or_default().insert(location.to_string());
 622     }
 623     Ok(Externs::new(externs))
 624 }
 625
 626 /// Extracts `--extern-html-root-url` arguments from `matches` and returns a map of crate names to
 627 /// the given URLs. If an `--extern-html-root-url` argument was ill-formed, returns an error
 628 /// describing the issue.
 629 fn parse_extern_html_roots(matches: &getopts::Matches)
 630     -> Result<BTreeMap<String, String>, &'static str>
 631 {
 632     let mut externs = BTreeMap::new();
 633     for arg in &matches.opt_strs("extern-html-root-url") {
 634         let mut parts = arg.splitn(2, '=');
 635         let name = parts.next().ok_or("--extern-html-root-url must not be empty")?;
 636         let url = parts.next().ok_or("--extern-html-root-url must be of the form name=url")?;
 637         externs.insert(name.to_string(), url.to_string());
 638     }
 639
 640     Ok(externs)
 641 }
 642
 643 /// Interprets the input file as a rust source file, passing it through the
 644 /// compiler all the way through the analysis passes. The rustdoc output is then
 645 /// generated from the cleaned AST of the crate.
 646 ///
 647 /// This form of input will run all of the plug/cleaning passes
 648 fn rust_input<R, F>(cratefile: PathBuf,
 649                     externs: Externs,
 650                     edition: Edition,
 651                     cg: CodegenOptions,
 652                     matches: &getopts::Matches,
 653                     error_format: ErrorOutputType,
 654                     f: F) -> R
 655 where R: 'static + Send,
 656       F: 'static + Send + FnOnce(Output) -> R
 657 {
 658     let default_passes = if matches.opt_present("no-defaults") {
 659         passes::DefaultPassOption::None
 660     } else if matches.opt_present("document-private-items") {
 661         passes::DefaultPassOption::Private
 662     } else {
 663         passes::DefaultPassOption::Default
 664     };
 665
 666     let manual_passes = matches.opt_strs("passes");
 667     let plugins = matches.opt_strs("plugins");
 668
 669     // First, parse the crate and extract all relevant information.
 670     let mut paths = SearchPaths::new();
 671     for s in &matches.opt_strs("L") {
 672         paths.add_path(s, ErrorOutputType::default());
 673     }
 674     let mut cfgs = matches.opt_strs("cfg");
 675     cfgs.push("rustdoc".to_string());
 676     let triple = matches.opt_str("target").map(|target| {
 677         if target.ends_with(".json") {
 678             TargetTriple::TargetPath(PathBuf::from(target))
 679         } else {
 680             TargetTriple::TargetTriple(target)
 681         }
 682     });
 683     let maybe_sysroot = matches.opt_str("sysroot").map(PathBuf::from);
 684     let crate_name = matches.opt_str("crate-name");
 685     let crate_version = matches.opt_str("crate-version");
 686     let plugin_path = matches.opt_str("plugin-path");
 687
 688     info!("starting to run rustc");
 689     let display_warnings = matches.opt_present("display-warnings");
 690
 691     let force_unstable_if_unmarked = matches.opt_strs("Z").iter().any(|x| {
 692         *x == "force-unstable-if-unmarked"
 693     });
 694
 695     let (lint_opts, describe_lints, lint_cap) = get_cmd_lint_options(matches, error_format);
 696
 697     let (tx, rx) = channel();
 698
 699     let result = rustc_driver::monitor(move || syntax::with_globals(move || {
 700         use rustc::session::config::Input;
 701
 702         let (mut krate, renderinfo, passes) =
 703             core::run_core(paths, cfgs, externs, Input::File(cratefile), triple, maybe_sysroot,
 704                            display_warnings, crate_name.clone(),
 705                            force_unstable_if_unmarked, edition, cg, error_format,
 706                            lint_opts, lint_cap, describe_lints, manual_passes, default_passes);
 707
 708         info!("finished with rustc");
 709
 710         if let Some(name) = crate_name {
 711             krate.name = name
 712         }
 713
 714         krate.version = crate_version;
 715
 716         if !plugins.is_empty() {
 717             eprintln!("WARNING: --plugins no longer functions; see CVE-2018-1000622");
 718         }
 719
 720         if !plugin_path.is_none() {
 721             eprintln!("WARNING: --plugin-path no longer functions; see CVE-2018-1000622");
 722         }
 723
 724         info!("Executing passes");
 725
 726         for pass in &passes {
 727             // determine if we know about this pass
 728             let pass = match passes::find_pass(pass) {
 729                 Some(pass) => if let Some(pass) = pass.late_fn() {
 730                     pass
 731                 } else {
 732                     // not a late pass, but still valid so don't report the error
 733                     continue
 734                 }
 735                 None => {
 736                     error!("unknown pass {}, skipping", *pass);
 737
 738                     continue
 739                 },
 740             };
 741
 742             // run it
 743             krate = pass(krate);
 744         }
 745
 746         tx.send(f(Output { krate: krate, renderinfo: renderinfo, passes: passes })).unwrap();
 747     }));
 748
 749     match result {
 750         Ok(()) => rx.recv().unwrap(),
 751         Err(_) => panic::resume_unwind(Box::new(errors::FatalErrorMarker)),
 752     }
 753 }
 754
 755 /// Prints deprecation warnings for deprecated options
 756 fn check_deprecated_options(matches: &getopts::Matches, diag: &errors::Handler) {
 757     let deprecated_flags = [
 758        "input-format",
 759        "output-format",
 760        "no-defaults",
 761        "passes",
 762     ];
 763
 764     for flag in deprecated_flags.into_iter() {
 765         if matches.opt_present(flag) {
 766             let mut err = diag.struct_warn(&format!("the '{}' flag is considered deprecated",
 767                                                     flag));
 768             err.warn("please see https://github.com/rust-lang/rust/issues/44136");
 769
 770             if *flag == "no-defaults" {
 771                 err.help("you may want to use --document-private-items");
 772             }
 773
 774             err.emit();
 775         }
 776     }
 777 }