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.
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.
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/")]
16 #![feature(rustc_private)]
17 #![feature(box_patterns)]
18 #![feature(box_syntax)]
19 #![feature(iterator_find_map)]
20 #![cfg_attr(not(stage0), feature(nll))]
21 #![feature(set_stdio)]
22 #![feature(slice_sort_by_cached_key)]
24 #![feature(vec_remove_item)]
25 #![feature(ptr_offset_from)]
26 #![feature(crate_visibility_modifier)]
29 #![recursion_limit="256"]
33 extern crate env_logger;
35 extern crate rustc_data_structures;
36 extern crate rustc_codegen_utils;
37 extern crate rustc_driver;
38 extern crate rustc_resolve;
39 extern crate rustc_lint;
40 extern crate rustc_metadata;
41 extern crate rustc_target;
42 extern crate rustc_typeck;
43 extern crate serialize;
44 #[macro_use] extern crate syntax;
45 extern crate syntax_pos;
46 extern crate test as testing;
47 #[macro_use] extern crate log;
48 extern crate rustc_errors as errors;
49 extern crate pulldown_cmark;
50 extern crate tempfile;
51 extern crate minifier;
53 extern crate serialize as rustc_serialize; // used by deriving
55 use errors::ColorConfig;
57 use std::collections::{BTreeMap, BTreeSet};
58 use std::default::Default;
61 use std::path::{Path, PathBuf};
63 use std::sync::mpsc::channel;
65 use syntax::edition::Edition;
66 use externalfiles::ExternalHtml;
67 use rustc::session::{early_warn, early_error};
68 use rustc::session::search_paths::SearchPaths;
69 use rustc::session::config::{ErrorOutputType, RustcOptGroup, Externs, CodegenOptions};
70 use rustc::session::config::{nightly_options, build_codegen_options};
71 use rustc_target::spec::TargetTriple;
72 use rustc::session::config::get_cmd_lint_options;
100 renderinfo: html::render::RenderInfo,
105 let thread_stack_size: usize = if cfg!(target_os = "haiku") {
106 16_000_000 // 16MB on Haiku
108 32_000_000 // 32MB on other platforms
110 rustc_driver::set_sigpipe_handler();
112 let res = std::thread::Builder::new().stack_size(thread_stack_size).spawn(move || {
113 syntax::with_globals(move || {
114 get_args().map(|args| main_args(&args)).unwrap_or(1)
116 }).unwrap().join().unwrap_or(rustc_driver::EXIT_FAILURE);
117 process::exit(res as i32);
120 fn get_args() -> Option<Vec<String>> {
121 env::args_os().enumerate()
122 .map(|(i, arg)| arg.into_string().map_err(|arg| {
123 early_warn(ErrorOutputType::default(),
124 &format!("Argument {} is not valid Unicode: {:?}", i, arg));
129 fn stable<F>(name: &'static str, f: F) -> RustcOptGroup
130 where F: Fn(&mut getopts::Options) -> &mut getopts::Options + 'static
132 RustcOptGroup::stable(name, f)
135 fn unstable<F>(name: &'static str, f: F) -> RustcOptGroup
136 where F: Fn(&mut getopts::Options) -> &mut getopts::Options + 'static
138 RustcOptGroup::unstable(name, f)
141 fn opts() -> Vec<RustcOptGroup> {
143 stable("h", |o| o.optflag("h", "help", "show this help message")),
144 stable("V", |o| o.optflag("V", "version", "print rustdoc's version")),
145 stable("v", |o| o.optflag("v", "verbose", "use verbose output")),
147 o.optopt("r", "input-format", "the input type of the specified file",
151 o.optopt("w", "output-format", "the output type to write", "[html]")
153 stable("o", |o| o.optopt("o", "output", "where to place the output", "PATH")),
154 stable("crate-name", |o| {
155 o.optopt("", "crate-name", "specify the name of this crate", "NAME")
158 o.optmulti("L", "library-path", "directory to add to crate search path",
161 stable("cfg", |o| o.optmulti("", "cfg", "pass a --cfg to rustc", "")),
162 stable("extern", |o| {
163 o.optmulti("", "extern", "pass an --extern to rustc", "NAME=PATH")
165 stable("plugin-path", |o| {
166 o.optmulti("", "plugin-path", "removed", "DIR")
169 o.optmulti("C", "codegen", "pass a codegen option to rustc", "OPT[=VALUE]")
171 stable("passes", |o| {
172 o.optmulti("", "passes",
173 "list of passes to also run, you might want \
174 to pass it multiple times; a value of `list` \
175 will print available passes",
178 stable("plugins", |o| {
179 o.optmulti("", "plugins", "removed",
182 stable("no-default", |o| {
183 o.optflag("", "no-defaults", "don't run the default passes")
185 stable("document-private-items", |o| {
186 o.optflag("", "document-private-items", "document private items")
188 stable("test", |o| o.optflag("", "test", "run code examples as tests")),
189 stable("test-args", |o| {
190 o.optmulti("", "test-args", "arguments to pass to the test runner",
193 stable("target", |o| o.optopt("", "target", "target triple to document", "TRIPLE")),
194 stable("markdown-css", |o| {
195 o.optmulti("", "markdown-css",
196 "CSS files to include via <link> in a rendered Markdown file",
199 stable("html-in-header", |o| {
200 o.optmulti("", "html-in-header",
201 "files to include inline in the <head> section of a rendered Markdown file \
202 or generated documentation",
205 stable("html-before-content", |o| {
206 o.optmulti("", "html-before-content",
207 "files to include inline between <body> and the content of a rendered \
208 Markdown file or generated documentation",
211 stable("html-after-content", |o| {
212 o.optmulti("", "html-after-content",
213 "files to include inline between the content and </body> of a rendered \
214 Markdown file or generated documentation",
217 unstable("markdown-before-content", |o| {
218 o.optmulti("", "markdown-before-content",
219 "files to include inline between <body> and the content of a rendered \
220 Markdown file or generated documentation",
223 unstable("markdown-after-content", |o| {
224 o.optmulti("", "markdown-after-content",
225 "files to include inline between the content and </body> of a rendered \
226 Markdown file or generated documentation",
229 stable("markdown-playground-url", |o| {
230 o.optopt("", "markdown-playground-url",
231 "URL to send code snippets to", "URL")
233 stable("markdown-no-toc", |o| {
234 o.optflag("", "markdown-no-toc", "don't include table of contents")
237 o.optopt("e", "extend-css",
238 "To add some CSS rules with a given file to generate doc with your \
239 own theme. However, your theme might break if the rustdoc's generated HTML \
240 changes, so be careful!", "PATH")
244 "internal and debugging options (only on nightly build)", "FLAG")
246 stable("sysroot", |o| {
247 o.optopt("", "sysroot", "Override the system root", "PATH")
249 unstable("playground-url", |o| {
250 o.optopt("", "playground-url",
251 "URL to send code snippets to, may be reset by --markdown-playground-url \
252 or `#![doc(html_playground_url=...)]`",
255 unstable("display-warnings", |o| {
256 o.optflag("", "display-warnings", "to print code warnings when testing doc")
258 unstable("crate-version", |o| {
259 o.optopt("", "crate-version", "crate version to print into documentation", "VERSION")
261 unstable("linker", |o| {
262 o.optopt("", "linker", "linker used for building executable test code", "PATH")
264 unstable("sort-modules-by-appearance", |o| {
265 o.optflag("", "sort-modules-by-appearance", "sort modules by where they appear in the \
266 program, rather than alphabetically")
268 unstable("themes", |o| {
269 o.optmulti("", "themes",
270 "additional themes which will be added to the generated docs",
273 unstable("theme-checker", |o| {
274 o.optmulti("", "theme-checker",
275 "check if given theme is valid",
278 unstable("resource-suffix", |o| {
281 "suffix to add to CSS and JavaScript files, e.g. \"light.css\" will become \
282 \"light-suffix.css\"",
285 unstable("edition", |o| {
286 o.optopt("", "edition",
287 "edition to use when compiling rust code (default: 2015)",
290 stable("color", |o| {
293 "Configure coloring of output:
294 auto = colorize, if output goes to a tty (default);
295 always = always colorize output;
296 never = never colorize output",
299 stable("error-format", |o| {
302 "How errors and other messages are produced",
305 unstable("disable-minification", |o| {
307 "disable-minification",
308 "Disable minification applied on JS files")
311 o.optmulti("W", "warn", "Set lint warnings", "OPT")
313 stable("allow", |o| {
314 o.optmulti("A", "allow", "Set lint allowed", "OPT")
317 o.optmulti("D", "deny", "Set lint denied", "OPT")
319 stable("forbid", |o| {
320 o.optmulti("F", "forbid", "Set lint forbidden", "OPT")
322 stable("cap-lints", |o| {
326 "Set the most restrictive lint level. \
327 More restrictive lints are capped at this \
328 level. By default, it is at `forbid` level.",
335 fn usage(argv0: &str) {
336 let mut options = getopts::Options::new();
337 for option in opts() {
338 (option.apply)(&mut options);
340 println!("{}", options.usage(&format!("{} [options] <input>", argv0)));
343 fn main_args(args: &[String]) -> isize {
344 let mut options = getopts::Options::new();
345 for option in opts() {
346 (option.apply)(&mut options);
348 let matches = match options.parse(&args[1..]) {
351 early_error(ErrorOutputType::default(), &err.to_string());
354 // Check for unstable options.
355 nightly_options::check_nightly_options(&matches, &opts());
357 if matches.opt_present("h") || matches.opt_present("help") {
360 } else if matches.opt_present("version") {
361 rustc_driver::version("rustdoc", &matches);
365 if matches.opt_strs("passes") == ["list"] {
366 println!("Available passes for running rustdoc:");
367 for pass in passes::PASSES {
368 println!("{:>20} - {}", pass.name(), pass.description());
370 println!("\nDefault passes for rustdoc:");
371 for &name in passes::DEFAULT_PASSES {
372 println!("{:>20}", name);
374 println!("\nPasses run with `--document-private-items`:");
375 for &name in passes::DEFAULT_PRIVATE_PASSES {
376 println!("{:>20}", name);
381 let color = match matches.opt_str("color").as_ref().map(|s| &s[..]) {
382 Some("auto") => ColorConfig::Auto,
383 Some("always") => ColorConfig::Always,
384 Some("never") => ColorConfig::Never,
385 None => ColorConfig::Auto,
387 early_error(ErrorOutputType::default(),
388 &format!("argument for --color must be `auto`, `always` or `never` \
389 (instead was `{}`)", arg));
392 let error_format = match matches.opt_str("error-format").as_ref().map(|s| &s[..]) {
393 Some("human") => ErrorOutputType::HumanReadable(color),
394 Some("json") => ErrorOutputType::Json(false),
395 Some("pretty-json") => ErrorOutputType::Json(true),
396 Some("short") => ErrorOutputType::Short(color),
397 None => ErrorOutputType::HumanReadable(color),
399 early_error(ErrorOutputType::default(),
400 &format!("argument for --error-format must be `human`, `json` or \
401 `short` (instead was `{}`)", arg));
405 let diag = core::new_handler(error_format, None);
407 // check for deprecated options
408 check_deprecated_options(&matches, &diag);
410 let to_check = matches.opt_strs("theme-checker");
411 if !to_check.is_empty() {
412 let paths = theme::load_css_paths(include_bytes!("html/static/themes/light.css"));
415 println!("rustdoc: [theme-checker] Starting tests!");
416 for theme_file in to_check.iter() {
417 print!(" - Checking \"{}\"...", theme_file);
418 let (success, differences) = theme::test_theme_against(theme_file, &paths, &diag);
419 if !differences.is_empty() || !success {
422 if !differences.is_empty() {
423 println!("{}", differences.join("\n"));
435 if matches.free.is_empty() {
436 diag.struct_err("missing file operand").emit();
439 if matches.free.len() > 1 {
440 diag.struct_err("too many file operands").emit();
443 let input = &matches.free[0];
445 let mut libs = SearchPaths::new();
446 for s in &matches.opt_strs("L") {
447 libs.add_path(s, error_format);
449 let externs = match parse_externs(&matches) {
452 diag.struct_err(&err.to_string()).emit();
457 let test_args = matches.opt_strs("test-args");
458 let test_args: Vec<String> = test_args.iter()
459 .flat_map(|s| s.split_whitespace())
460 .map(|s| s.to_string())
463 let should_test = matches.opt_present("test");
464 let markdown_input = Path::new(input).extension()
465 .map_or(false, |e| e == "md" || e == "markdown");
467 let output = matches.opt_str("o").map(|s| PathBuf::from(&s));
468 let css_file_extension = matches.opt_str("e").map(|s| PathBuf::from(&s));
469 let cfgs = matches.opt_strs("cfg");
471 if let Some(ref p) = css_file_extension {
473 diag.struct_err("option --extend-css argument must be a file").emit();
478 let mut themes = Vec::new();
479 if matches.opt_present("themes") {
480 let paths = theme::load_css_paths(include_bytes!("html/static/themes/light.css"));
482 for (theme_file, theme_s) in matches.opt_strs("themes")
484 .map(|s| (PathBuf::from(&s), s.to_owned())) {
485 if !theme_file.is_file() {
486 diag.struct_err("option --themes arguments must all be files").emit();
489 let (success, ret) = theme::test_theme_against(&theme_file, &paths, &diag);
490 if !success || !ret.is_empty() {
491 diag.struct_err(&format!("invalid theme: \"{}\"", theme_s))
492 .help("check what's wrong with the --theme-checker option")
496 themes.push(theme_file);
500 let mut id_map = html::markdown::IdMap::new();
501 id_map.populate(html::render::initial_ids());
502 let external_html = match ExternalHtml::load(
503 &matches.opt_strs("html-in-header"),
504 &matches.opt_strs("html-before-content"),
505 &matches.opt_strs("html-after-content"),
506 &matches.opt_strs("markdown-before-content"),
507 &matches.opt_strs("markdown-after-content"), &diag, &mut id_map) {
511 let crate_name = matches.opt_str("crate-name");
512 let playground_url = matches.opt_str("playground-url");
513 let maybe_sysroot = matches.opt_str("sysroot").map(PathBuf::from);
514 let display_warnings = matches.opt_present("display-warnings");
515 let linker = matches.opt_str("linker").map(PathBuf::from);
516 let sort_modules_alphabetically = !matches.opt_present("sort-modules-by-appearance");
517 let resource_suffix = matches.opt_str("resource-suffix");
518 let enable_minification = !matches.opt_present("disable-minification");
520 let edition = matches.opt_str("edition").unwrap_or("2015".to_string());
521 let edition = match edition.parse() {
524 diag.struct_err("could not parse edition").emit();
529 let cg = build_codegen_options(&matches, ErrorOutputType::default());
531 match (should_test, markdown_input) {
533 return markdown::test(input, cfgs, libs, externs, test_args, maybe_sysroot,
534 display_warnings, linker, edition, cg, &diag)
537 return test::run(Path::new(input), cfgs, libs, externs, test_args, crate_name,
538 maybe_sysroot, display_warnings, linker, edition, cg)
540 (false, true) => return markdown::render(Path::new(input),
541 output.unwrap_or(PathBuf::from("doc")),
542 &matches, &external_html,
543 !matches.opt_present("markdown-no-toc"), &diag),
547 let output_format = matches.opt_str("w");
549 let res = acquire_input(PathBuf::from(input), externs, edition, cg, &matches, error_format,
551 let Output { krate, passes, renderinfo } = out;
552 let diag = core::new_handler(error_format, None);
553 info!("going to format");
554 match output_format.as_ref().map(|s| &**s) {
555 Some("html") | None => {
556 html::render::run(krate, &external_html, playground_url,
557 output.unwrap_or(PathBuf::from("doc")),
558 resource_suffix.unwrap_or(String::new()),
559 passes.into_iter().collect(),
562 sort_modules_alphabetically,
564 enable_minification, id_map)
565 .expect("failed to generate documentation");
569 diag.struct_err(&format!("unknown output format: {}", s)).emit();
574 res.unwrap_or_else(|s| {
575 diag.struct_err(&format!("input error: {}", s)).emit();
580 /// Looks inside the command line arguments to extract the relevant input format
581 /// and files and then generates the necessary rustdoc output for formatting.
582 fn acquire_input<R, F>(input: PathBuf,
586 matches: &getopts::Matches,
587 error_format: ErrorOutputType,
590 where R: 'static + Send, F: 'static + Send + FnOnce(Output) -> R {
591 match matches.opt_str("r").as_ref().map(|s| &**s) {
592 Some("rust") => Ok(rust_input(input, externs, edition, cg, matches, error_format, f)),
593 Some(s) => Err(format!("unknown input format: {}", s)),
594 None => Ok(rust_input(input, externs, edition, cg, matches, error_format, f))
598 /// Extracts `--extern CRATE=PATH` arguments from `matches` and
599 /// returns a map mapping crate names to their paths or else an
601 fn parse_externs(matches: &getopts::Matches) -> Result<Externs, String> {
602 let mut externs = BTreeMap::new();
603 for arg in &matches.opt_strs("extern") {
604 let mut parts = arg.splitn(2, '=');
605 let name = parts.next().ok_or("--extern value must not be empty".to_string())?;
606 let location = parts.next()
607 .ok_or("--extern value must be of the format `foo=bar`"
609 let name = name.to_string();
610 externs.entry(name).or_insert_with(BTreeSet::new).insert(location.to_string());
612 Ok(Externs::new(externs))
615 /// Interprets the input file as a rust source file, passing it through the
616 /// compiler all the way through the analysis passes. The rustdoc output is then
617 /// generated from the cleaned AST of the crate.
619 /// This form of input will run all of the plug/cleaning passes
620 fn rust_input<R, F>(cratefile: PathBuf,
624 matches: &getopts::Matches,
625 error_format: ErrorOutputType,
627 where R: 'static + Send,
628 F: 'static + Send + FnOnce(Output) -> R
630 let default_passes = if matches.opt_present("no-defaults") {
631 passes::DefaultPassOption::None
632 } else if matches.opt_present("document-private-items") {
633 passes::DefaultPassOption::Private
635 passes::DefaultPassOption::Default
638 let manual_passes = matches.opt_strs("passes");
639 let plugins = matches.opt_strs("plugins");
641 // First, parse the crate and extract all relevant information.
642 let mut paths = SearchPaths::new();
643 for s in &matches.opt_strs("L") {
644 paths.add_path(s, ErrorOutputType::default());
646 let cfgs = matches.opt_strs("cfg");
647 let triple = matches.opt_str("target").map(|target| {
648 if target.ends_with(".json") {
649 TargetTriple::TargetPath(PathBuf::from(target))
651 TargetTriple::TargetTriple(target)
654 let maybe_sysroot = matches.opt_str("sysroot").map(PathBuf::from);
655 let crate_name = matches.opt_str("crate-name");
656 let crate_version = matches.opt_str("crate-version");
657 let plugin_path = matches.opt_str("plugin-path");
659 info!("starting to run rustc");
660 let display_warnings = matches.opt_present("display-warnings");
662 let force_unstable_if_unmarked = matches.opt_strs("Z").iter().any(|x| {
663 *x == "force-unstable-if-unmarked"
666 let (lint_opts, describe_lints, lint_cap) = get_cmd_lint_options(matches, error_format);
668 let (tx, rx) = channel();
670 let result = rustc_driver::monitor(move || syntax::with_globals(move || {
671 use rustc::session::config::Input;
673 let (mut krate, renderinfo, passes) =
674 core::run_core(paths, cfgs, externs, Input::File(cratefile), triple, maybe_sysroot,
675 display_warnings, crate_name.clone(),
676 force_unstable_if_unmarked, edition, cg, error_format,
677 lint_opts, lint_cap, describe_lints, manual_passes, default_passes);
679 info!("finished with rustc");
681 if let Some(name) = crate_name {
685 krate.version = crate_version;
687 if !plugins.is_empty() {
688 eprintln!("WARNING: --plugins no longer functions; see CVE-2018-1000622");
691 if !plugin_path.is_none() {
692 eprintln!("WARNING: --plugin-path no longer functions; see CVE-2018-1000622");
695 info!("Executing passes");
697 for pass in &passes {
698 // determine if we know about this pass
699 let pass = match passes::find_pass(pass) {
700 Some(pass) => if let Some(pass) = pass.late_fn() {
703 // not a late pass, but still valid so don't report the error
707 error!("unknown pass {}, skipping", *pass);
717 tx.send(f(Output { krate: krate, renderinfo: renderinfo, passes: passes })).unwrap();
721 Ok(()) => rx.recv().unwrap(),
722 Err(_) => panic::resume_unwind(Box::new(errors::FatalErrorMarker)),
726 /// Prints deprecation warnings for deprecated options
727 fn check_deprecated_options(matches: &getopts::Matches, diag: &errors::Handler) {
728 let deprecated_flags = [
735 for flag in deprecated_flags.into_iter() {
736 if matches.opt_present(flag) {
737 let mut err = diag.struct_warn(&format!("the '{}' flag is considered deprecated",
739 err.warn("please see https://github.com/rust-lang/rust/issues/44136");
741 if *flag == "no-defaults" {
742 err.help("you may want to use --document-private-items");