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 #![cfg_attr(not(stage0), feature(nll))]
20 #![feature(set_stdio)]
21 #![feature(slice_sort_by_cached_key)]
23 #![feature(vec_remove_item)]
24 #![feature(ptr_offset_from)]
25 #![feature(crate_visibility_modifier)]
28 #![recursion_limit="256"]
32 extern crate env_logger;
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;
52 extern crate serialize as rustc_serialize; // used by deriving
54 use errors::ColorConfig;
56 use std::collections::{BTreeMap, BTreeSet};
57 use std::default::Default;
60 use std::path::{Path, PathBuf};
62 use std::sync::mpsc::channel;
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;
99 renderinfo: html::render::RenderInfo,
104 let thread_stack_size: usize = if cfg!(target_os = "haiku") {
105 16_000_000 // 16MB on Haiku
107 32_000_000 // 32MB on other platforms
109 rustc_driver::set_sigpipe_handler();
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)
115 }).unwrap().join().unwrap_or(rustc_driver::EXIT_FAILURE);
116 process::exit(res as i32);
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));
128 fn stable<F>(name: &'static str, f: F) -> RustcOptGroup
129 where F: Fn(&mut getopts::Options) -> &mut getopts::Options + 'static
131 RustcOptGroup::stable(name, f)
134 fn unstable<F>(name: &'static str, f: F) -> RustcOptGroup
135 where F: Fn(&mut getopts::Options) -> &mut getopts::Options + 'static
137 RustcOptGroup::unstable(name, f)
140 fn opts() -> Vec<RustcOptGroup> {
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")),
146 o.optopt("r", "input-format", "the input type of the specified file",
150 o.optopt("w", "output-format", "the output type to write", "[html]")
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")
157 o.optmulti("L", "library-path", "directory to add to crate search path",
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")
164 unstable("extern-html-root-url", |o| {
165 o.optmulti("", "extern-html-root-url",
166 "base URL to use for dependencies", "NAME=URL")
168 stable("plugin-path", |o| {
169 o.optmulti("", "plugin-path", "removed", "DIR")
172 o.optmulti("C", "codegen", "pass a codegen option to rustc", "OPT[=VALUE]")
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",
181 stable("plugins", |o| {
182 o.optmulti("", "plugins", "removed",
185 stable("no-default", |o| {
186 o.optflag("", "no-defaults", "don't run the default passes")
188 stable("document-private-items", |o| {
189 o.optflag("", "document-private-items", "document private items")
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",
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",
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",
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",
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",
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",
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",
232 stable("markdown-playground-url", |o| {
233 o.optopt("", "markdown-playground-url",
234 "URL to send code snippets to", "URL")
236 stable("markdown-no-toc", |o| {
237 o.optflag("", "markdown-no-toc", "don't include table of contents")
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")
247 "internal and debugging options (only on nightly build)", "FLAG")
249 stable("sysroot", |o| {
250 o.optopt("", "sysroot", "Override the system root", "PATH")
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=...)]`",
258 unstable("display-warnings", |o| {
259 o.optflag("", "display-warnings", "to print code warnings when testing doc")
261 unstable("crate-version", |o| {
262 o.optopt("", "crate-version", "crate version to print into documentation", "VERSION")
264 unstable("linker", |o| {
265 o.optopt("", "linker", "linker used for building executable test code", "PATH")
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")
271 unstable("themes", |o| {
272 o.optmulti("", "themes",
273 "additional themes which will be added to the generated docs",
276 unstable("theme-checker", |o| {
277 o.optmulti("", "theme-checker",
278 "check if given theme is valid",
281 unstable("resource-suffix", |o| {
284 "suffix to add to CSS and JavaScript files, e.g. \"light.css\" will become \
285 \"light-suffix.css\"",
288 stable("edition", |o| {
289 o.optopt("", "edition",
290 "edition to use when compiling rust code (default: 2015)",
293 stable("color", |o| {
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",
302 stable("error-format", |o| {
305 "How errors and other messages are produced",
308 unstable("disable-minification", |o| {
310 "disable-minification",
311 "Disable minification applied on JS files")
314 o.optmulti("W", "warn", "Set lint warnings", "OPT")
316 stable("allow", |o| {
317 o.optmulti("A", "allow", "Set lint allowed", "OPT")
320 o.optmulti("D", "deny", "Set lint denied", "OPT")
322 stable("forbid", |o| {
323 o.optmulti("F", "forbid", "Set lint forbidden", "OPT")
325 stable("cap-lints", |o| {
329 "Set the most restrictive lint level. \
330 More restrictive lints are capped at this \
331 level. By default, it is at `forbid` level.",
338 fn usage(argv0: &str) {
339 let mut options = getopts::Options::new();
340 for option in opts() {
341 (option.apply)(&mut options);
343 println!("{}", options.usage(&format!("{} [options] <input>", argv0)));
346 fn main_args(args: &[String]) -> isize {
347 let mut options = getopts::Options::new();
348 for option in opts() {
349 (option.apply)(&mut options);
351 let matches = match options.parse(&args[1..]) {
354 early_error(ErrorOutputType::default(), &err.to_string());
357 // Check for unstable options.
358 nightly_options::check_nightly_options(&matches, &opts());
360 if matches.opt_present("h") || matches.opt_present("help") {
363 } else if matches.opt_present("version") {
364 rustc_driver::version("rustdoc", &matches);
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());
373 println!("\nDefault passes for rustdoc:");
374 for &name in passes::DEFAULT_PASSES {
375 println!("{:>20}", name);
377 println!("\nPasses run with `--document-private-items`:");
378 for &name in passes::DEFAULT_PRIVATE_PASSES {
379 println!("{:>20}", name);
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,
390 early_error(ErrorOutputType::default(),
391 &format!("argument for --color must be `auto`, `always` or `never` \
392 (instead was `{}`)", arg));
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),
402 early_error(ErrorOutputType::default(),
403 &format!("argument for --error-format must be `human`, `json` or \
404 `short` (instead was `{}`)", arg));
408 let diag = core::new_handler(error_format, None);
410 // check for deprecated options
411 check_deprecated_options(&matches, &diag);
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"));
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 {
425 if !differences.is_empty() {
426 println!("{}", differences.join("\n"));
438 if matches.free.is_empty() {
439 diag.struct_err("missing file operand").emit();
442 if matches.free.len() > 1 {
443 diag.struct_err("too many file operands").emit();
446 let input = &matches.free[0];
448 let mut libs = SearchPaths::new();
449 for s in &matches.opt_strs("L") {
450 libs.add_path(s, error_format);
452 let externs = match parse_externs(&matches) {
455 diag.struct_err(&err.to_string()).emit();
459 let extern_urls = match parse_extern_html_roots(&matches) {
462 diag.struct_err(err).emit();
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())
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");
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());
482 if let Some(ref p) = css_file_extension {
484 diag.struct_err("option --extend-css argument must be a file").emit();
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"));
493 for (theme_file, theme_s) in matches.opt_strs("themes")
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();
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")
507 themes.push(theme_file);
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) {
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");
531 let edition = matches.opt_str("edition").unwrap_or("2015".to_string());
532 let edition = match edition.parse() {
535 diag.struct_err("could not parse edition").emit();
540 let cg = build_codegen_options(&matches, ErrorOutputType::default());
542 match (should_test, markdown_input) {
544 return markdown::test(input, cfgs, libs, externs, test_args, maybe_sysroot,
545 display_warnings, linker, edition, cg, &diag)
548 return test::run(Path::new(input), cfgs, libs, externs, test_args, crate_name,
549 maybe_sysroot, display_warnings, linker, edition, cg)
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),
558 let output_format = matches.opt_str("w");
560 let res = acquire_input(PathBuf::from(input), externs, edition, cg, &matches, error_format,
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(),
573 sort_modules_alphabetically,
575 enable_minification, id_map)
576 .expect("failed to generate documentation");
580 diag.struct_err(&format!("unknown output format: {}", s)).emit();
585 res.unwrap_or_else(|s| {
586 diag.struct_err(&format!("input error: {}", s)).emit();
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,
597 matches: &getopts::Matches,
598 error_format: ErrorOutputType,
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))
609 /// Extracts `--extern CRATE=PATH` arguments from `matches` and
610 /// returns a map mapping crate names to their paths or else an
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`"
620 let name = name.to_string();
621 externs.entry(name).or_default().insert(location.to_string());
623 Ok(Externs::new(externs))
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>
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());
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.
647 /// This form of input will run all of the plug/cleaning passes
648 fn rust_input<R, F>(cratefile: PathBuf,
652 matches: &getopts::Matches,
653 error_format: ErrorOutputType,
655 where R: 'static + Send,
656 F: 'static + Send + FnOnce(Output) -> R
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
663 passes::DefaultPassOption::Default
666 let manual_passes = matches.opt_strs("passes");
667 let plugins = matches.opt_strs("plugins");
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());
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))
680 TargetTriple::TargetTriple(target)
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");
688 info!("starting to run rustc");
689 let display_warnings = matches.opt_present("display-warnings");
691 let force_unstable_if_unmarked = matches.opt_strs("Z").iter().any(|x| {
692 *x == "force-unstable-if-unmarked"
695 let (lint_opts, describe_lints, lint_cap) = get_cmd_lint_options(matches, error_format);
697 let (tx, rx) = channel();
699 let result = rustc_driver::monitor(move || syntax::with_globals(move || {
700 use rustc::session::config::Input;
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);
708 info!("finished with rustc");
710 if let Some(name) = crate_name {
714 krate.version = crate_version;
716 if !plugins.is_empty() {
717 eprintln!("WARNING: --plugins no longer functions; see CVE-2018-1000622");
720 if !plugin_path.is_none() {
721 eprintln!("WARNING: --plugin-path no longer functions; see CVE-2018-1000622");
724 info!("Executing passes");
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() {
732 // not a late pass, but still valid so don't report the error
736 error!("unknown pass {}, skipping", *pass);
746 tx.send(f(Output { krate: krate, renderinfo: renderinfo, passes: passes })).unwrap();
750 Ok(()) => rx.recv().unwrap(),
751 Err(_) => panic::resume_unwind(Box::new(errors::FatalErrorMarker)),
755 /// Prints deprecation warnings for deprecated options
756 fn check_deprecated_options(matches: &getopts::Matches, diag: &errors::Handler) {
757 let deprecated_flags = [
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",
768 err.warn("please see https://github.com/rust-lang/rust/issues/44136");
770 if *flag == "no-defaults" {
771 err.help("you may want to use --document-private-items");