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 #![deny(warnings)]
  16
  17 #![feature(ascii_ctype)]
  18 #![feature(rustc_private)]
  19 #![feature(box_patterns)]
  20 #![feature(box_syntax)]
  21 #![feature(fs_read_write)]
  22 #![feature(libc)]
  23 #![feature(set_stdio)]
  24 #![feature(slice_patterns)]
  25 #![feature(test)]
  26 #![feature(unicode)]
  27 #![feature(vec_remove_item)]
  28
  29 extern crate arena;
  30 extern crate getopts;
  31 extern crate env_logger;
  32 extern crate html_diff;
  33 extern crate libc;
  34 extern crate rustc;
  35 extern crate rustc_data_structures;
  36 extern crate rustc_const_math;
  37 extern crate rustc_trans;
  38 extern crate rustc_driver;
  39 extern crate rustc_resolve;
  40 extern crate rustc_lint;
  41 extern crate rustc_back;
  42 extern crate rustc_metadata;
  43 extern crate rustc_typeck;
  44 extern crate serialize;
  45 #[macro_use] extern crate syntax;
  46 extern crate syntax_pos;
  47 extern crate test as testing;
  48 extern crate std_unicode;
  49 #[macro_use] extern crate log;
  50 extern crate rustc_errors as errors;
  51 extern crate pulldown_cmark;
  52 extern crate tempdir;
  53
  54 extern crate serialize as rustc_serialize; // used by deriving
  55
  56 use std::collections::{BTreeMap, BTreeSet};
  57 use std::default::Default;
  58 use std::env;
  59 use std::fmt::Display;
  60 use std::io;
  61 use std::io::Write;
  62 use std::path::{Path, PathBuf};
  63 use std::process;
  64 use std::sync::mpsc::channel;
  65
  66 use externalfiles::ExternalHtml;
  67 use rustc::session::search_paths::SearchPaths;
  68 use rustc::session::config::{ErrorOutputType, RustcOptGroup, nightly_options,
  69                              Externs};
  70
  71 #[macro_use]
  72 pub mod externalfiles;
  73
  74 pub mod clean;
  75 pub mod core;
  76 pub mod doctree;
  77 pub mod fold;
  78 pub mod html {
  79     pub mod highlight;
  80     pub mod escape;
  81     pub mod item_type;
  82     pub mod format;
  83     pub mod layout;
  84     pub mod markdown;
  85     pub mod render;
  86     pub mod toc;
  87 }
  88 pub mod markdown;
  89 pub mod passes;
  90 pub mod plugins;
  91 pub mod visit_ast;
  92 pub mod visit_lib;
  93 pub mod test;
  94
  95 use clean::AttributesExt;
  96
  97 use html::markdown::RenderType;
  98
  99 struct Output {
 100     krate: clean::Crate,
 101     renderinfo: html::render::RenderInfo,
 102     passes: Vec<String>,
 103 }
 104
 105 pub fn main() {
 106     const STACK_SIZE: usize = 32_000_000; // 32MB
 107     env_logger::init().unwrap();
 108     let res = std::thread::Builder::new().stack_size(STACK_SIZE).spawn(move || {
 109         get_args().map(|args| main_args(&args)).unwrap_or(1)
 110     }).unwrap().join().unwrap_or(101);
 111     process::exit(res as i32);
 112 }
 113
 114 fn get_args() -> Option<Vec<String>> {
 115     env::args_os().enumerate()
 116         .map(|(i, arg)| arg.into_string().map_err(|arg| {
 117              print_error(format!("Argument {} is not valid Unicode: {:?}", i, arg));
 118         }).ok())
 119         .collect()
 120 }
 121
 122 fn stable<F>(name: &'static str, f: F) -> RustcOptGroup
 123     where F: Fn(&mut getopts::Options) -> &mut getopts::Options + 'static
 124 {
 125     RustcOptGroup::stable(name, f)
 126 }
 127
 128 fn unstable<F>(name: &'static str, f: F) -> RustcOptGroup
 129     where F: Fn(&mut getopts::Options) -> &mut getopts::Options + 'static
 130 {
 131     RustcOptGroup::unstable(name, f)
 132 }
 133
 134 pub fn opts() -> Vec<RustcOptGroup> {
 135     vec![
 136         stable("h", |o| o.optflag("h", "help", "show this help message")),
 137         stable("V", |o| o.optflag("V", "version", "print rustdoc's version")),
 138         stable("v", |o| o.optflag("v", "verbose", "use verbose output")),
 139         stable("r", |o| {
 140             o.optopt("r", "input-format", "the input type of the specified file",
 141                      "[rust]")
 142         }),
 143         stable("w", |o| {
 144             o.optopt("w", "output-format", "the output type to write", "[html]")
 145         }),
 146         stable("o", |o| o.optopt("o", "output", "where to place the output", "PATH")),
 147         stable("crate-name", |o| {
 148             o.optopt("", "crate-name", "specify the name of this crate", "NAME")
 149         }),
 150         stable("L", |o| {
 151             o.optmulti("L", "library-path", "directory to add to crate search path",
 152                        "DIR")
 153         }),
 154         stable("cfg", |o| o.optmulti("", "cfg", "pass a --cfg to rustc", "")),
 155         stable("extern", |o| {
 156             o.optmulti("", "extern", "pass an --extern to rustc", "NAME=PATH")
 157         }),
 158         stable("plugin-path", |o| {
 159             o.optmulti("", "plugin-path", "directory to load plugins from", "DIR")
 160         }),
 161         stable("passes", |o| {
 162             o.optmulti("", "passes",
 163                        "list of passes to also run, you might want \
 164                         to pass it multiple times; a value of `list` \
 165                         will print available passes",
 166                        "PASSES")
 167         }),
 168         stable("plugins", |o| {
 169             o.optmulti("", "plugins", "space separated list of plugins to also load",
 170                        "PLUGINS")
 171         }),
 172         stable("no-default", |o| {
 173             o.optflag("", "no-defaults", "don't run the default passes")
 174         }),
 175         stable("document-private-items", |o| {
 176             o.optflag("", "document-private-items", "document private items")
 177         }),
 178         stable("test", |o| o.optflag("", "test", "run code examples as tests")),
 179         stable("test-args", |o| {
 180             o.optmulti("", "test-args", "arguments to pass to the test runner",
 181                        "ARGS")
 182         }),
 183         stable("target", |o| o.optopt("", "target", "target triple to document", "TRIPLE")),
 184         stable("markdown-css", |o| {
 185             o.optmulti("", "markdown-css",
 186                        "CSS files to include via <link> in a rendered Markdown file",
 187                        "FILES")
 188         }),
 189         stable("html-in-header", |o|  {
 190             o.optmulti("", "html-in-header",
 191                        "files to include inline in the <head> section of a rendered Markdown file \
 192                         or generated documentation",
 193                        "FILES")
 194         }),
 195         stable("html-before-content", |o| {
 196             o.optmulti("", "html-before-content",
 197                        "files to include inline between <body> and the content of a rendered \
 198                         Markdown file or generated documentation",
 199                        "FILES")
 200         }),
 201         stable("html-after-content", |o| {
 202             o.optmulti("", "html-after-content",
 203                        "files to include inline between the content and </body> of a rendered \
 204                         Markdown file or generated documentation",
 205                        "FILES")
 206         }),
 207         unstable("markdown-before-content", |o| {
 208             o.optmulti("", "markdown-before-content",
 209                        "files to include inline between <body> and the content of a rendered \
 210                         Markdown file or generated documentation",
 211                        "FILES")
 212         }),
 213         unstable("markdown-after-content", |o| {
 214             o.optmulti("", "markdown-after-content",
 215                        "files to include inline between the content and </body> of a rendered \
 216                         Markdown file or generated documentation",
 217                        "FILES")
 218         }),
 219         stable("markdown-playground-url", |o| {
 220             o.optopt("", "markdown-playground-url",
 221                      "URL to send code snippets to", "URL")
 222         }),
 223         stable("markdown-no-toc", |o| {
 224             o.optflag("", "markdown-no-toc", "don't include table of contents")
 225         }),
 226         stable("e", |o| {
 227             o.optopt("e", "extend-css",
 228                      "To add some CSS rules with a given file to generate doc with your \
 229                       own theme. However, your theme might break if the rustdoc's generated HTML \
 230                       changes, so be careful!", "PATH")
 231         }),
 232         unstable("Z", |o| {
 233             o.optmulti("Z", "",
 234                        "internal and debugging options (only on nightly build)", "FLAG")
 235         }),
 236         stable("sysroot", |o| {
 237             o.optopt("", "sysroot", "Override the system root", "PATH")
 238         }),
 239         unstable("playground-url", |o| {
 240             o.optopt("", "playground-url",
 241                      "URL to send code snippets to, may be reset by --markdown-playground-url \
 242                       or `#![doc(html_playground_url=...)]`",
 243                      "URL")
 244         }),
 245         unstable("enable-commonmark", |o| {
 246             o.optflag("", "enable-commonmark", "to enable commonmark doc rendering/testing")
 247         }),
 248         unstable("display-warnings", |o| {
 249             o.optflag("", "display-warnings", "to print code warnings when testing doc")
 250         }),
 251         unstable("crate-version", |o| {
 252             o.optopt("", "crate-version", "crate version to print into documentation", "VERSION")
 253         }),
 254         unstable("linker", |o| {
 255             o.optopt("", "linker", "linker used for building executable test code", "PATH")
 256         }),
 257         unstable("sort-modules-by-appearance", |o| {
 258             o.optflag("", "sort-modules-by-appearance", "sort modules by where they appear in the \
 259                                                          program, rather than alphabetically")
 260         }),
 261         unstable("deny-render-differences", |o| {
 262             o.optflag("", "deny-render-differences", "abort doc runs when markdown rendering \
 263                                                       differences are found")
 264         }),
 265     ]
 266 }
 267
 268 pub fn usage(argv0: &str) {
 269     let mut options = getopts::Options::new();
 270     for option in opts() {
 271         (option.apply)(&mut options);
 272     }
 273     println!("{}", options.usage(&format!("{} [options] <input>", argv0)));
 274 }
 275
 276 pub fn main_args(args: &[String]) -> isize {
 277     let mut options = getopts::Options::new();
 278     for option in opts() {
 279         (option.apply)(&mut options);
 280     }
 281     let matches = match options.parse(&args[1..]) {
 282         Ok(m) => m,
 283         Err(err) => {
 284             print_error(err);
 285             return 1;
 286         }
 287     };
 288     // Check for unstable options.
 289     nightly_options::check_nightly_options(&matches, &opts());
 290
 291     // check for deprecated options
 292     check_deprecated_options(&matches);
 293
 294     if matches.opt_present("h") || matches.opt_present("help") {
 295         usage("rustdoc");
 296         return 0;
 297     } else if matches.opt_present("version") {
 298         rustc_driver::version("rustdoc", &matches);
 299         return 0;
 300     }
 301
 302     if matches.opt_strs("passes") == ["list"] {
 303         println!("Available passes for running rustdoc:");
 304         for &(name, _, description) in passes::PASSES {
 305             println!("{:>20} - {}", name, description);
 306         }
 307         println!("\nDefault passes for rustdoc:");
 308         for &name in passes::DEFAULT_PASSES {
 309             println!("{:>20}", name);
 310         }
 311         return 0;
 312     }
 313
 314     if matches.free.is_empty() {
 315         print_error("missing file operand");
 316         return 1;
 317     }
 318     if matches.free.len() > 1 {
 319         print_error("too many file operands");
 320         return 1;
 321     }
 322     let input = &matches.free[0];
 323
 324     let mut libs = SearchPaths::new();
 325     for s in &matches.opt_strs("L") {
 326         libs.add_path(s, ErrorOutputType::default());
 327     }
 328     let externs = match parse_externs(&matches) {
 329         Ok(ex) => ex,
 330         Err(err) => {
 331             print_error(err);
 332             return 1;
 333         }
 334     };
 335
 336     let test_args = matches.opt_strs("test-args");
 337     let test_args: Vec<String> = test_args.iter()
 338                                           .flat_map(|s| s.split_whitespace())
 339                                           .map(|s| s.to_string())
 340                                           .collect();
 341
 342     let should_test = matches.opt_present("test");
 343     let markdown_input = Path::new(input).extension()
 344         .map_or(false, |e| e == "md" || e == "markdown");
 345
 346     let output = matches.opt_str("o").map(|s| PathBuf::from(&s));
 347     let css_file_extension = matches.opt_str("e").map(|s| PathBuf::from(&s));
 348     let cfgs = matches.opt_strs("cfg");
 349
 350     let render_type = if matches.opt_present("enable-commonmark") {
 351         RenderType::Pulldown
 352     } else {
 353         RenderType::Hoedown
 354     };
 355
 356     if let Some(ref p) = css_file_extension {
 357         if !p.is_file() {
 358             writeln!(
 359                 &mut io::stderr(),
 360                 "rustdoc: option --extend-css argument must be a file."
 361             ).unwrap();
 362             return 1;
 363         }
 364     }
 365
 366     let external_html = match ExternalHtml::load(
 367             &matches.opt_strs("html-in-header"),
 368             &matches.opt_strs("html-before-content"),
 369             &matches.opt_strs("html-after-content"),
 370             &matches.opt_strs("markdown-before-content"),
 371             &matches.opt_strs("markdown-after-content"),
 372             render_type) {
 373         Some(eh) => eh,
 374         None => return 3,
 375     };
 376     let crate_name = matches.opt_str("crate-name");
 377     let playground_url = matches.opt_str("playground-url");
 378     let maybe_sysroot = matches.opt_str("sysroot").map(PathBuf::from);
 379     let display_warnings = matches.opt_present("display-warnings");
 380     let linker = matches.opt_str("linker").map(PathBuf::from);
 381     let sort_modules_alphabetically = !matches.opt_present("sort-modules-by-appearance");
 382
 383     match (should_test, markdown_input) {
 384         (true, true) => {
 385             return markdown::test(input, cfgs, libs, externs, test_args, maybe_sysroot,
 386                                   render_type, display_warnings, linker)
 387         }
 388         (true, false) => {
 389             return test::run(Path::new(input), cfgs, libs, externs, test_args, crate_name,
 390                              maybe_sysroot, render_type, display_warnings, linker)
 391         }
 392         (false, true) => return markdown::render(Path::new(input),
 393                                                  output.unwrap_or(PathBuf::from("doc")),
 394                                                  &matches, &external_html,
 395                                                  !matches.opt_present("markdown-no-toc"),
 396                                                  render_type),
 397         (false, false) => {}
 398     }
 399
 400     let output_format = matches.opt_str("w");
 401     let deny_render_differences = matches.opt_present("deny-render-differences");
 402     let res = acquire_input(PathBuf::from(input), externs, &matches, move |out| {
 403         let Output { krate, passes, renderinfo } = out;
 404         info!("going to format");
 405         match output_format.as_ref().map(|s| &**s) {
 406             Some("html") | None => {
 407                 html::render::run(krate, &external_html, playground_url,
 408                                   output.unwrap_or(PathBuf::from("doc")),
 409                                   passes.into_iter().collect(),
 410                                   css_file_extension,
 411                                   renderinfo,
 412                                   render_type,
 413                                   sort_modules_alphabetically,
 414                                   deny_render_differences)
 415                     .expect("failed to generate documentation");
 416                 0
 417             }
 418             Some(s) => {
 419                 print_error(format!("unknown output format: {}", s));
 420                 1
 421             }
 422         }
 423     });
 424     res.unwrap_or_else(|s| {
 425         print_error(format!("input error: {}", s));
 426         1
 427     })
 428 }
 429
 430 /// Prints an uniformized error message on the standard error output
 431 fn print_error<T>(error_message: T) where T: Display {
 432     writeln!(
 433         &mut io::stderr(),
 434         "rustdoc: {}\nTry 'rustdoc --help' for more information.",
 435         error_message
 436     ).unwrap();
 437 }
 438
 439 /// Looks inside the command line arguments to extract the relevant input format
 440 /// and files and then generates the necessary rustdoc output for formatting.
 441 fn acquire_input<R, F>(input: PathBuf,
 442                        externs: Externs,
 443                        matches: &getopts::Matches,
 444                        f: F)
 445                        -> Result<R, String>
 446 where R: 'static + Send, F: 'static + Send + FnOnce(Output) -> R {
 447     match matches.opt_str("r").as_ref().map(|s| &**s) {
 448         Some("rust") => Ok(rust_input(input, externs, matches, f)),
 449         Some(s) => Err(format!("unknown input format: {}", s)),
 450         None => Ok(rust_input(input, externs, matches, f))
 451     }
 452 }
 453
 454 /// Extracts `--extern CRATE=PATH` arguments from `matches` and
 455 /// returns a map mapping crate names to their paths or else an
 456 /// error message.
 457 fn parse_externs(matches: &getopts::Matches) -> Result<Externs, String> {
 458     let mut externs = BTreeMap::new();
 459     for arg in &matches.opt_strs("extern") {
 460         let mut parts = arg.splitn(2, '=');
 461         let name = parts.next().ok_or("--extern value must not be empty".to_string())?;
 462         let location = parts.next()
 463                                  .ok_or("--extern value must be of the format `foo=bar`"
 464                                     .to_string())?;
 465         let name = name.to_string();
 466         externs.entry(name).or_insert_with(BTreeSet::new).insert(location.to_string());
 467     }
 468     Ok(Externs::new(externs))
 469 }
 470
 471 /// Interprets the input file as a rust source file, passing it through the
 472 /// compiler all the way through the analysis passes. The rustdoc output is then
 473 /// generated from the cleaned AST of the crate.
 474 ///
 475 /// This form of input will run all of the plug/cleaning passes
 476 fn rust_input<R, F>(cratefile: PathBuf, externs: Externs, matches: &getopts::Matches, f: F) -> R
 477 where R: 'static + Send, F: 'static + Send + FnOnce(Output) -> R {
 478     let mut default_passes = !matches.opt_present("no-defaults");
 479     let mut passes = matches.opt_strs("passes");
 480     let mut plugins = matches.opt_strs("plugins");
 481
 482     // We hardcode in the passes here, as this is a new flag and we
 483     // are generally deprecating passes.
 484     if matches.opt_present("document-private-items") {
 485         default_passes = false;
 486
 487         passes = vec![
 488             String::from("collapse-docs"),
 489             String::from("unindent-comments"),
 490         ];
 491     }
 492
 493     // First, parse the crate and extract all relevant information.
 494     let mut paths = SearchPaths::new();
 495     for s in &matches.opt_strs("L") {
 496         paths.add_path(s, ErrorOutputType::default());
 497     }
 498     let cfgs = matches.opt_strs("cfg");
 499     let triple = matches.opt_str("target");
 500     let maybe_sysroot = matches.opt_str("sysroot").map(PathBuf::from);
 501     let crate_name = matches.opt_str("crate-name");
 502     let crate_version = matches.opt_str("crate-version");
 503     let plugin_path = matches.opt_str("plugin-path");
 504
 505     info!("starting to run rustc");
 506     let display_warnings = matches.opt_present("display-warnings");
 507
 508     let force_unstable_if_unmarked = matches.opt_strs("Z").iter().any(|x| {
 509         *x == "force-unstable-if-unmarked"
 510     });
 511
 512     let (tx, rx) = channel();
 513     rustc_driver::monitor(move || {
 514         use rustc::session::config::Input;
 515
 516         let (mut krate, renderinfo) =
 517             core::run_core(paths, cfgs, externs, Input::File(cratefile), triple, maybe_sysroot,
 518                            display_warnings, force_unstable_if_unmarked);
 519
 520         info!("finished with rustc");
 521
 522         if let Some(name) = crate_name {
 523             krate.name = name
 524         }
 525
 526         krate.version = crate_version;
 527
 528         // Process all of the crate attributes, extracting plugin metadata along
 529         // with the passes which we are supposed to run.
 530         for attr in krate.module.as_ref().unwrap().attrs.lists("doc") {
 531             let name = attr.name().map(|s| s.as_str());
 532             let name = name.as_ref().map(|s| &s[..]);
 533             if attr.is_word() {
 534                 if name == Some("no_default_passes") {
 535                     default_passes = false;
 536                 }
 537             } else if let Some(value) = attr.value_str() {
 538                 let sink = match name {
 539                     Some("passes") => &mut passes,
 540                     Some("plugins") => &mut plugins,
 541                     _ => continue,
 542                 };
 543                 for p in value.as_str().split_whitespace() {
 544                     sink.push(p.to_string());
 545                 }
 546             }
 547         }
 548
 549         if default_passes {
 550             for name in passes::DEFAULT_PASSES.iter().rev() {
 551                 passes.insert(0, name.to_string());
 552             }
 553         }
 554
 555         // Load all plugins/passes into a PluginManager
 556         let path = plugin_path.unwrap_or("/tmp/rustdoc/plugins".to_string());
 557         let mut pm = plugins::PluginManager::new(PathBuf::from(path));
 558         for pass in &passes {
 559             let plugin = match passes::PASSES.iter()
 560                                              .position(|&(p, ..)| {
 561                                                  p == *pass
 562                                              }) {
 563                 Some(i) => passes::PASSES[i].1,
 564                 None => {
 565                     error!("unknown pass {}, skipping", *pass);
 566                     continue
 567                 },
 568             };
 569             pm.add_plugin(plugin);
 570         }
 571         info!("loading plugins...");
 572         for pname in plugins {
 573             pm.load_plugin(pname);
 574         }
 575
 576         // Run everything!
 577         info!("Executing passes/plugins");
 578         let krate = pm.run_plugins(krate);
 579
 580         tx.send(f(Output { krate: krate, renderinfo: renderinfo, passes: passes })).unwrap();
 581     });
 582     rx.recv().unwrap()
 583 }
 584
 585 /// Prints deprecation warnings for deprecated options
 586 fn check_deprecated_options(matches: &getopts::Matches) {
 587     let deprecated_flags = [
 588        "input-format",
 589        "output-format",
 590        "plugin-path",
 591        "plugins",
 592        "no-defaults",
 593        "passes",
 594     ];
 595
 596     for flag in deprecated_flags.into_iter() {
 597         if matches.opt_present(flag) {
 598             eprintln!("WARNING: the '{}' flag is considered deprecated", flag);
 599             eprintln!("WARNING: please see https://github.com/rust-lang/rust/issues/44136");
 600         }
 601     }
 602
 603     if matches.opt_present("no-defaults") {
 604         eprintln!("WARNING: (you may want to use --document-private-items)");
 605     }
 606 }