1 #![doc(html_root_url = "https://doc.rust-lang.org/nightly/",
2 html_playground_url = "https://play.rust-lang.org/")]
4 #![feature(rustc_private)]
5 #![feature(arbitrary_self_types)]
6 #![feature(box_patterns)]
7 #![feature(box_syntax)]
8 #![feature(in_band_lifetimes)]
10 #![feature(set_stdio)]
12 #![feature(vec_remove_item)]
13 #![feature(ptr_offset_from)]
14 #![feature(crate_visibility_modifier)]
16 #![feature(drain_filter)]
17 #![feature(never_type)]
18 #![feature(unicode_internals)]
20 #![recursion_limit="256"]
23 extern crate env_logger;
25 extern crate rustc_data_structures;
26 extern crate rustc_driver;
27 extern crate rustc_feature;
28 extern crate rustc_error_codes;
29 extern crate rustc_index;
30 extern crate rustc_resolve;
31 extern crate rustc_lint;
32 extern crate rustc_interface;
33 extern crate rustc_metadata;
34 extern crate rustc_parse;
35 extern crate rustc_target;
36 extern crate rustc_typeck;
37 extern crate rustc_lexer;
39 extern crate syntax_expand;
40 extern crate syntax_pos;
41 extern crate test as testing;
42 #[macro_use] extern crate log;
43 extern crate rustc_errors as errors;
45 use std::default::Default;
50 use rustc::session::{early_warn, early_error};
51 use rustc::session::config::{ErrorOutputType, RustcOptGroup, make_crate_type_option};
70 crate mod static_files;
83 renderinfo: html::render::RenderInfo,
84 renderopts: config::RenderOptions,
88 let thread_stack_size: usize = if cfg!(target_os = "haiku") {
89 16_000_000 // 16MB on Haiku
91 32_000_000 // 32MB on other platforms
93 rustc_driver::set_sigpipe_handler();
94 env_logger::init_from_env("RUSTDOC_LOG");
95 let res = std::thread::Builder::new().stack_size(thread_stack_size).spawn(move || {
96 get_args().map(|args| main_args(&args)).unwrap_or(1)
97 }).unwrap().join().unwrap_or(rustc_driver::EXIT_FAILURE);
101 fn get_args() -> Option<Vec<String>> {
102 env::args_os().enumerate()
103 .map(|(i, arg)| arg.into_string().map_err(|arg| {
104 early_warn(ErrorOutputType::default(),
105 &format!("Argument {} is not valid Unicode: {:?}", i, arg));
110 fn stable<F>(name: &'static str, f: F) -> RustcOptGroup
111 where F: Fn(&mut getopts::Options) -> &mut getopts::Options + 'static
113 RustcOptGroup::stable(name, f)
116 fn unstable<F>(name: &'static str, f: F) -> RustcOptGroup
117 where F: Fn(&mut getopts::Options) -> &mut getopts::Options + 'static
119 RustcOptGroup::unstable(name, f)
122 fn opts() -> Vec<RustcOptGroup> {
124 stable("h", |o| o.optflag("h", "help", "show this help message")),
125 stable("V", |o| o.optflag("V", "version", "print rustdoc's version")),
126 stable("v", |o| o.optflag("v", "verbose", "use verbose output")),
128 o.optopt("r", "input-format", "the input type of the specified file",
132 o.optopt("w", "output-format", "the output type to write", "[html]")
134 stable("o", |o| o.optopt("o", "output", "where to place the output", "PATH")),
135 stable("crate-name", |o| {
136 o.optopt("", "crate-name", "specify the name of this crate", "NAME")
138 make_crate_type_option(),
140 o.optmulti("L", "library-path", "directory to add to crate search path",
143 stable("cfg", |o| o.optmulti("", "cfg", "pass a --cfg to rustc", "")),
144 stable("extern", |o| {
145 o.optmulti("", "extern", "pass an --extern to rustc", "NAME[=PATH]")
147 unstable("extern-html-root-url", |o| {
148 o.optmulti("", "extern-html-root-url",
149 "base URL to use for dependencies", "NAME=URL")
151 stable("plugin-path", |o| {
152 o.optmulti("", "plugin-path", "removed", "DIR")
155 o.optmulti("C", "codegen", "pass a codegen option to rustc", "OPT[=VALUE]")
157 stable("passes", |o| {
158 o.optmulti("", "passes",
159 "list of passes to also run, you might want \
160 to pass it multiple times; a value of `list` \
161 will print available passes",
164 stable("plugins", |o| {
165 o.optmulti("", "plugins", "removed",
168 stable("no-default", |o| {
169 o.optflag("", "no-defaults", "don't run the default passes")
171 stable("document-private-items", |o| {
172 o.optflag("", "document-private-items", "document private items")
174 stable("test", |o| o.optflag("", "test", "run code examples as tests")),
175 stable("test-args", |o| {
176 o.optmulti("", "test-args", "arguments to pass to the test runner",
179 stable("target", |o| o.optopt("", "target", "target triple to document", "TRIPLE")),
180 stable("markdown-css", |o| {
181 o.optmulti("", "markdown-css",
182 "CSS files to include via <link> in a rendered Markdown file",
185 stable("html-in-header", |o| {
186 o.optmulti("", "html-in-header",
187 "files to include inline in the <head> section of a rendered Markdown file \
188 or generated documentation",
191 stable("html-before-content", |o| {
192 o.optmulti("", "html-before-content",
193 "files to include inline between <body> and the content of a rendered \
194 Markdown file or generated documentation",
197 stable("html-after-content", |o| {
198 o.optmulti("", "html-after-content",
199 "files to include inline between the content and </body> of a rendered \
200 Markdown file or generated documentation",
203 unstable("markdown-before-content", |o| {
204 o.optmulti("", "markdown-before-content",
205 "files to include inline between <body> and the content of a rendered \
206 Markdown file or generated documentation",
209 unstable("markdown-after-content", |o| {
210 o.optmulti("", "markdown-after-content",
211 "files to include inline between the content and </body> of a rendered \
212 Markdown file or generated documentation",
215 stable("markdown-playground-url", |o| {
216 o.optopt("", "markdown-playground-url",
217 "URL to send code snippets to", "URL")
219 stable("markdown-no-toc", |o| {
220 o.optflag("", "markdown-no-toc", "don't include table of contents")
223 o.optopt("e", "extend-css",
224 "To add some CSS rules with a given file to generate doc with your \
225 own theme. However, your theme might break if the rustdoc's generated HTML \
226 changes, so be careful!", "PATH")
230 "internal and debugging options (only on nightly build)", "FLAG")
232 stable("sysroot", |o| {
233 o.optopt("", "sysroot", "Override the system root", "PATH")
235 unstable("playground-url", |o| {
236 o.optopt("", "playground-url",
237 "URL to send code snippets to, may be reset by --markdown-playground-url \
238 or `#![doc(html_playground_url=...)]`",
241 unstable("display-warnings", |o| {
242 o.optflag("", "display-warnings", "to print code warnings when testing doc")
244 unstable("crate-version", |o| {
245 o.optopt("", "crate-version", "crate version to print into documentation", "VERSION")
247 unstable("sort-modules-by-appearance", |o| {
248 o.optflag("", "sort-modules-by-appearance", "sort modules by where they appear in the \
249 program, rather than alphabetically")
251 stable("theme", |o| {
252 o.optmulti("", "theme",
253 "additional themes which will be added to the generated docs",
256 stable("check-theme", |o| {
257 o.optmulti("", "check-theme",
258 "check if given theme is valid",
261 unstable("resource-suffix", |o| {
264 "suffix to add to CSS and JavaScript files, e.g., \"light.css\" will become \
265 \"light-suffix.css\"",
268 stable("edition", |o| {
269 o.optopt("", "edition",
270 "edition to use when compiling rust code (default: 2015)",
273 stable("color", |o| {
276 "Configure coloring of output:
277 auto = colorize, if output goes to a tty (default);
278 always = always colorize output;
279 never = never colorize output",
282 stable("error-format", |o| {
285 "How errors and other messages are produced",
291 "Configure the structure of JSON diagnostics",
294 unstable("disable-minification", |o| {
296 "disable-minification",
297 "Disable minification applied on JS files")
300 o.optmulti("W", "warn", "Set lint warnings", "OPT")
302 stable("allow", |o| {
303 o.optmulti("A", "allow", "Set lint allowed", "OPT")
306 o.optmulti("D", "deny", "Set lint denied", "OPT")
308 stable("forbid", |o| {
309 o.optmulti("F", "forbid", "Set lint forbidden", "OPT")
311 stable("cap-lints", |o| {
315 "Set the most restrictive lint level. \
316 More restrictive lints are capped at this \
317 level. By default, it is at `forbid` level.",
321 unstable("index-page", |o| {
324 "Markdown file to be used as index page",
327 unstable("enable-index-page", |o| {
330 "To enable generation of the index page")
332 unstable("static-root-path", |o| {
335 "Path string to force loading static files from in output pages. \
336 If not set, uses combinations of '../' to reach the documentation root.",
339 unstable("disable-per-crate-search", |o| {
341 "disable-per-crate-search",
342 "disables generating the crate selector on the search box")
344 unstable("persist-doctests", |o| {
347 "Directory to persist doctest executables into",
350 unstable("generate-redirect-pages", |o| {
352 "generate-redirect-pages",
353 "Generate extra pages to support legacy URLs and tool links")
355 unstable("show-coverage", |o| {
358 "calculate percentage of public items with documentation")
360 unstable("enable-per-target-ignores", |o| {
362 "enable-per-target-ignores",
363 "parse ignore-foo for ignoring doctests on a per-target basis")
365 unstable("runtool", |o| {
369 "The tool to run tests with when building for a different target than host")
371 unstable("runtool-arg", |o| {
375 "One (of possibly many) arguments to pass to the runtool")
377 unstable("test-builder", |o| {
380 "specified the rustc-like binary to use as the test builder")
385 fn usage(argv0: &str) {
386 let mut options = getopts::Options::new();
387 for option in opts() {
388 (option.apply)(&mut options);
390 println!("{}", options.usage(&format!("{} [options] <input>", argv0)));
393 fn main_args(args: &[String]) -> i32 {
394 let mut options = getopts::Options::new();
395 for option in opts() {
396 (option.apply)(&mut options);
398 let matches = match options.parse(&args[1..]) {
401 early_error(ErrorOutputType::default(), &err.to_string());
404 let options = match config::Options::from_matches(&matches) {
406 Err(code) => return code,
408 rustc_interface::interface::default_thread_pool(options.edition, move || {
409 main_options(options)
413 fn main_options(options: config::Options) -> i32 {
414 let diag = core::new_handler(options.error_format,
416 options.debugging_options.treat_err_as_bug,
417 options.debugging_options.ui_testing);
419 match (options.should_test, options.markdown_input()) {
420 (true, true) => return markdown::test(options, &diag),
421 (true, false) => return test::run(options),
422 (false, true) => return markdown::render(options.input,
423 options.render_options,
429 // need to move these items separately because we lose them by the time the closure is called,
430 // but we can't crates the Handler ahead of time because it's not Send
431 let diag_opts = (options.error_format,
432 options.debugging_options.treat_err_as_bug,
433 options.debugging_options.ui_testing,
435 let show_coverage = options.show_coverage;
436 rust_input(options, move |out| {
438 // if we ran coverage, bail early, we don't need to also generate docs at this point
439 // (also we didn't load in any of the useful passes)
440 return rustc_driver::EXIT_SUCCESS;
443 let Output { krate, renderinfo, renderopts } = out;
444 info!("going to format");
445 let (error_format, treat_err_as_bug, ui_testing, edition) = diag_opts;
446 let diag = core::new_handler(error_format, None, treat_err_as_bug, ui_testing);
447 match html::render::run(
454 Ok(_) => rustc_driver::EXIT_SUCCESS,
456 diag.struct_err(&format!("couldn't generate documentation: {}", e.error))
457 .note(&format!("failed to create or modify \"{}\"", e.file.display()))
459 rustc_driver::EXIT_FAILURE
465 /// Interprets the input file as a rust source file, passing it through the
466 /// compiler all the way through the analysis passes. The rustdoc output is then
467 /// generated from the cleaned AST of the crate.
469 /// This form of input will run all of the plug/cleaning passes
470 fn rust_input<R, F>(options: config::Options, f: F) -> R
471 where R: 'static + Send,
472 F: 'static + Send + FnOnce(Output) -> R
474 // First, parse the crate and extract all relevant information.
475 info!("starting to run rustc");
477 let result = rustc_driver::catch_fatal_errors(move || {
478 let crate_name = options.crate_name.clone();
479 let crate_version = options.crate_version.clone();
480 let (mut krate, renderinfo, renderopts) = core::run_core(options);
482 info!("finished with rustc");
484 if let Some(name) = crate_name {
488 krate.version = crate_version;
498 Ok(output) => output,
499 Err(_) => panic::resume_unwind(Box::new(errors::FatalErrorMarker)),