2 html_root_url = "https://doc.rust-lang.org/nightly/",
3 html_playground_url = "https://play.rust-lang.org/"
5 #![feature(rustc_private)]
6 #![feature(arbitrary_self_types)]
7 #![feature(box_patterns)]
8 #![feature(box_syntax)]
9 #![feature(in_band_lifetimes)]
11 #![feature(set_stdio)]
13 #![feature(vec_remove_item)]
14 #![feature(ptr_offset_from)]
15 #![feature(crate_visibility_modifier)]
17 #![feature(drain_filter)]
18 #![feature(never_type)]
19 #![feature(unicode_internals)]
20 #![recursion_limit = "256"]
22 extern crate env_logger;
25 extern crate rustc_data_structures;
26 extern crate rustc_driver;
27 extern crate rustc_error_codes;
28 extern crate rustc_expand;
29 extern crate rustc_feature;
30 extern crate rustc_hir;
31 extern crate rustc_index;
32 extern crate rustc_interface;
33 extern crate rustc_lexer;
34 extern crate rustc_lint;
35 extern crate rustc_metadata;
36 extern crate rustc_parse;
37 extern crate rustc_resolve;
38 extern crate rustc_span as rustc_span;
39 extern crate rustc_target;
40 extern crate rustc_typeck;
42 extern crate test as testing;
45 extern crate rustc_errors as errors;
47 use std::default::Default;
52 use rustc::session::config::{make_crate_type_option, ErrorOutputType, RustcOptGroup};
53 use rustc::session::{early_error, early_warn};
73 crate mod static_files;
85 renderinfo: html::render::RenderInfo,
86 renderopts: config::RenderOptions,
90 let thread_stack_size: usize = if cfg!(target_os = "haiku") {
91 16_000_000 // 16MB on Haiku
93 32_000_000 // 32MB on other platforms
95 rustc_driver::set_sigpipe_handler();
96 env_logger::init_from_env("RUSTDOC_LOG");
97 let res = std::thread::Builder::new()
98 .stack_size(thread_stack_size)
99 .spawn(move || get_args().map(|args| main_args(&args)).unwrap_or(1))
102 .unwrap_or(rustc_driver::EXIT_FAILURE);
106 fn get_args() -> Option<Vec<String>> {
113 ErrorOutputType::default(),
114 &format!("Argument {} is not valid Unicode: {:?}", i, arg),
122 fn stable<F>(name: &'static str, f: F) -> RustcOptGroup
124 F: Fn(&mut getopts::Options) -> &mut getopts::Options + 'static,
126 RustcOptGroup::stable(name, f)
129 fn unstable<F>(name: &'static str, f: F) -> RustcOptGroup
131 F: Fn(&mut getopts::Options) -> &mut getopts::Options + 'static,
133 RustcOptGroup::unstable(name, f)
136 fn opts() -> Vec<RustcOptGroup> {
138 stable("h", |o| o.optflag("h", "help", "show this help message")),
139 stable("V", |o| o.optflag("V", "version", "print rustdoc's version")),
140 stable("v", |o| o.optflag("v", "verbose", "use verbose output")),
142 o.optopt("r", "input-format", "the input type of the specified file", "[rust]")
144 stable("w", |o| o.optopt("w", "output-format", "the output type to write", "[html]")),
145 stable("o", |o| o.optopt("o", "output", "where to place the output", "PATH")),
146 stable("crate-name", |o| {
147 o.optopt("", "crate-name", "specify the name of this crate", "NAME")
149 make_crate_type_option(),
151 o.optmulti("L", "library-path", "directory to add to crate search path", "DIR")
153 stable("cfg", |o| o.optmulti("", "cfg", "pass a --cfg to rustc", "")),
154 stable("extern", |o| o.optmulti("", "extern", "pass an --extern to rustc", "NAME[=PATH]")),
155 unstable("extern-html-root-url", |o| {
156 o.optmulti("", "extern-html-root-url", "base URL to use for dependencies", "NAME=URL")
158 stable("plugin-path", |o| o.optmulti("", "plugin-path", "removed", "DIR")),
160 o.optmulti("C", "codegen", "pass a codegen option to rustc", "OPT[=VALUE]")
162 stable("passes", |o| {
166 "list of passes to also run, you might want \
167 to pass it multiple times; a value of `list` \
168 will print available passes",
172 stable("plugins", |o| o.optmulti("", "plugins", "removed", "PLUGINS")),
173 stable("no-default", |o| o.optflag("", "no-defaults", "don't run the default passes")),
174 stable("document-private-items", |o| {
175 o.optflag("", "document-private-items", "document private items")
177 stable("test", |o| o.optflag("", "test", "run code examples as tests")),
178 stable("test-args", |o| {
179 o.optmulti("", "test-args", "arguments to pass to the test runner", "ARGS")
181 stable("target", |o| o.optopt("", "target", "target triple to document", "TRIPLE")),
182 stable("markdown-css", |o| {
186 "CSS files to include via <link> in a rendered Markdown file",
190 stable("html-in-header", |o| {
194 "files to include inline in the <head> section of a rendered Markdown file \
195 or generated documentation",
199 stable("html-before-content", |o| {
202 "html-before-content",
203 "files to include inline between <body> and the content of a rendered \
204 Markdown file or generated documentation",
208 stable("html-after-content", |o| {
211 "html-after-content",
212 "files to include inline between the content and </body> of a rendered \
213 Markdown file or generated documentation",
217 unstable("markdown-before-content", |o| {
220 "markdown-before-content",
221 "files to include inline between <body> and the content of a rendered \
222 Markdown file or generated documentation",
226 unstable("markdown-after-content", |o| {
229 "markdown-after-content",
230 "files to include inline between the content and </body> of a rendered \
231 Markdown file or generated documentation",
235 stable("markdown-playground-url", |o| {
236 o.optopt("", "markdown-playground-url", "URL to send code snippets to", "URL")
238 stable("markdown-no-toc", |o| {
239 o.optflag("", "markdown-no-toc", "don't include table of contents")
245 "To add some CSS rules with a given file to generate doc with your \
246 own theme. However, your theme might break if the rustdoc's generated HTML \
247 changes, so be careful!",
252 o.optmulti("Z", "", "internal and debugging options (only on nightly build)", "FLAG")
254 stable("sysroot", |o| o.optopt("", "sysroot", "Override the system root", "PATH")),
255 unstable("playground-url", |o| {
259 "URL to send code snippets to, may be reset by --markdown-playground-url \
260 or `#![doc(html_playground_url=...)]`",
264 unstable("display-warnings", |o| {
265 o.optflag("", "display-warnings", "to print code warnings when testing doc")
267 unstable("crate-version", |o| {
268 o.optopt("", "crate-version", "crate version to print into documentation", "VERSION")
270 unstable("sort-modules-by-appearance", |o| {
273 "sort-modules-by-appearance",
274 "sort modules by where they appear in the \
275 program, rather than alphabetically",
278 stable("theme", |o| {
282 "additional themes which will be added to the generated docs",
286 stable("check-theme", |o| {
287 o.optmulti("", "check-theme", "check if given theme is valid", "FILES")
289 unstable("resource-suffix", |o| {
293 "suffix to add to CSS and JavaScript files, e.g., \"light.css\" will become \
294 \"light-suffix.css\"",
298 stable("edition", |o| {
302 "edition to use when compiling rust code (default: 2015)",
306 stable("color", |o| {
310 "Configure coloring of output:
311 auto = colorize, if output goes to a tty (default);
312 always = always colorize output;
313 never = never colorize output",
317 stable("error-format", |o| {
321 "How errors and other messages are produced",
326 o.optopt("", "json", "Configure the structure of JSON diagnostics", "CONFIG")
328 unstable("disable-minification", |o| {
329 o.optflag("", "disable-minification", "Disable minification applied on JS files")
331 stable("warn", |o| o.optmulti("W", "warn", "Set lint warnings", "OPT")),
332 stable("allow", |o| o.optmulti("A", "allow", "Set lint allowed", "OPT")),
333 stable("deny", |o| o.optmulti("D", "deny", "Set lint denied", "OPT")),
334 stable("forbid", |o| o.optmulti("F", "forbid", "Set lint forbidden", "OPT")),
335 stable("cap-lints", |o| {
339 "Set the most restrictive lint level. \
340 More restrictive lints are capped at this \
341 level. By default, it is at `forbid` level.",
345 unstable("index-page", |o| {
346 o.optopt("", "index-page", "Markdown file to be used as index page", "PATH")
348 unstable("enable-index-page", |o| {
349 o.optflag("", "enable-index-page", "To enable generation of the index page")
351 unstable("static-root-path", |o| {
355 "Path string to force loading static files from in output pages. \
356 If not set, uses combinations of '../' to reach the documentation root.",
360 unstable("disable-per-crate-search", |o| {
363 "disable-per-crate-search",
364 "disables generating the crate selector on the search box",
367 unstable("persist-doctests", |o| {
371 "Directory to persist doctest executables into",
375 unstable("generate-redirect-pages", |o| {
378 "generate-redirect-pages",
379 "Generate extra pages to support legacy URLs and tool links",
382 unstable("show-coverage", |o| {
386 "calculate percentage of public items with documentation",
389 unstable("enable-per-target-ignores", |o| {
392 "enable-per-target-ignores",
393 "parse ignore-foo for ignoring doctests on a per-target basis",
396 unstable("runtool", |o| {
401 "The tool to run tests with when building for a different target than host",
404 unstable("runtool-arg", |o| {
409 "One (of possibly many) arguments to pass to the runtool",
412 unstable("test-builder", |o| {
416 "specified the rustc-like binary to use as the test builder",
422 fn usage(argv0: &str) {
423 let mut options = getopts::Options::new();
424 for option in opts() {
425 (option.apply)(&mut options);
427 println!("{}", options.usage(&format!("{} [options] <input>", argv0)));
430 fn main_args(args: &[String]) -> i32 {
431 let mut options = getopts::Options::new();
432 for option in opts() {
433 (option.apply)(&mut options);
435 let matches = match options.parse(&args[1..]) {
438 early_error(ErrorOutputType::default(), &err.to_string());
441 let options = match config::Options::from_matches(&matches) {
443 Err(code) => return code,
445 rustc_interface::interface::default_thread_pool(options.edition, move || main_options(options))
448 fn main_options(options: config::Options) -> i32 {
449 let diag = core::new_handler(options.error_format, None, &options.debugging_options);
451 match (options.should_test, options.markdown_input()) {
452 (true, true) => return markdown::test(options, &diag),
453 (true, false) => return test::run(options),
455 return markdown::render(options.input, options.render_options, &diag, options.edition);
460 // need to move these items separately because we lose them by the time the closure is called,
461 // but we can't crates the Handler ahead of time because it's not Send
462 let diag_opts = (options.error_format, options.edition, options.debugging_options.clone());
463 let show_coverage = options.show_coverage;
464 rust_input(options, move |out| {
466 // if we ran coverage, bail early, we don't need to also generate docs at this point
467 // (also we didn't load in any of the useful passes)
468 return rustc_driver::EXIT_SUCCESS;
471 let Output { krate, renderinfo, renderopts } = out;
472 info!("going to format");
473 let (error_format, edition, debugging_options) = diag_opts;
474 let diag = core::new_handler(error_format, None, &debugging_options);
475 match html::render::run(krate, renderopts, renderinfo, &diag, edition) {
476 Ok(_) => rustc_driver::EXIT_SUCCESS,
478 diag.struct_err(&format!("couldn't generate documentation: {}", e.error))
479 .note(&format!("failed to create or modify \"{}\"", e.file.display()))
481 rustc_driver::EXIT_FAILURE
487 /// Interprets the input file as a rust source file, passing it through the
488 /// compiler all the way through the analysis passes. The rustdoc output is then
489 /// generated from the cleaned AST of the crate.
491 /// This form of input will run all of the plug/cleaning passes
492 fn rust_input<R, F>(options: config::Options, f: F) -> R
495 F: 'static + Send + FnOnce(Output) -> R,
497 // First, parse the crate and extract all relevant information.
498 info!("starting to run rustc");
500 let result = rustc_driver::catch_fatal_errors(move || {
501 let crate_name = options.crate_name.clone();
502 let crate_version = options.crate_version.clone();
503 let (mut krate, renderinfo, renderopts) = core::run_core(options);
505 info!("finished with rustc");
507 if let Some(name) = crate_name {
511 krate.version = crate_version;
513 f(Output { krate, renderinfo, renderopts })
517 Ok(output) => output,
518 Err(_) => panic::resume_unwind(Box::new(errors::FatalErrorMarker)),