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 #![crate_name = "rustdoc"]
  12 #![unstable(feature = "rustdoc", issue = "27812")]
  13 #![crate_type = "dylib"]
  14 #![crate_type = "rlib"]
  15 #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
  16        html_favicon_url = "https://doc.rust-lang.org/favicon.ico",
  17        html_root_url = "https://doc.rust-lang.org/nightly/",
  18        html_playground_url = "https://play.rust-lang.org/")]
  19 #![cfg_attr(not(stage0), deny(warnings))]
  20
  21 #![feature(box_patterns)]
  22 #![feature(box_syntax)]
  23 #![feature(libc)]
  24 #![feature(rustc_private)]
  25 #![feature(set_stdio)]
  26 #![feature(slice_patterns)]
  27 #![feature(staged_api)]
  28 #![feature(test)]
  29 #![feature(unicode)]
  30 #![feature(question_mark)]
  31
  32 extern crate arena;
  33 extern crate getopts;
  34 extern crate libc;
  35 extern crate rustc;
  36 extern crate rustc_const_eval;
  37 extern crate rustc_const_math;
  38 extern crate rustc_data_structures;
  39 extern crate rustc_trans;
  40 extern crate rustc_driver;
  41 extern crate rustc_resolve;
  42 extern crate rustc_lint;
  43 extern crate rustc_back;
  44 extern crate rustc_metadata;
  45 extern crate serialize;
  46 #[macro_use] extern crate syntax;
  47 extern crate syntax_pos;
  48 extern crate test as testing;
  49 extern crate rustc_unicode;
  50 #[macro_use] extern crate log;
  51 extern crate rustc_errors as errors;
  52
  53 extern crate serialize as rustc_serialize; // used by deriving
  54
  55 use std::collections::{BTreeMap, BTreeSet};
  56 use std::default::Default;
  57 use std::env;
  58 use std::path::PathBuf;
  59 use std::process;
  60 use std::sync::mpsc::channel;
  61
  62 use externalfiles::ExternalHtml;
  63 use rustc::session::search_paths::SearchPaths;
  64 use rustc::session::config::{ErrorOutputType, RustcOptGroup, nightly_options,
  65                              Externs};
  66
  67 #[macro_use]
  68 pub mod externalfiles;
  69
  70 pub mod clean;
  71 pub mod core;
  72 pub mod doctree;
  73 pub mod fold;
  74 pub mod html {
  75     pub mod highlight;
  76     pub mod escape;
  77     pub mod item_type;
  78     pub mod format;
  79     pub mod layout;
  80     pub mod markdown;
  81     pub mod render;
  82     pub mod toc;
  83 }
  84 pub mod markdown;
  85 pub mod passes;
  86 pub mod plugins;
  87 pub mod visit_ast;
  88 pub mod visit_lib;
  89 pub mod test;
  90
  91 use clean::Attributes;
  92
  93 type Pass = (&'static str,                                      // name
  94              fn(clean::Crate) -> plugins::PluginResult,         // fn
  95              &'static str);                                     // description
  96
  97 const PASSES: &'static [Pass] = &[
  98     ("strip-hidden", passes::strip_hidden,
  99      "strips all doc(hidden) items from the output"),
 100     ("unindent-comments", passes::unindent_comments,
 101      "removes excess indentation on comments in order for markdown to like it"),
 102     ("collapse-docs", passes::collapse_docs,
 103      "concatenates all document attributes into one document attribute"),
 104     ("strip-private", passes::strip_private,
 105      "strips all private items from a crate which cannot be seen externally, \
 106       implies strip-priv-imports"),
 107     ("strip-priv-imports", passes::strip_priv_imports,
 108      "strips all private import statements (`use`, `extern crate`) from a crate"),
 109 ];
 110
 111 const DEFAULT_PASSES: &'static [&'static str] = &[
 112     "strip-hidden",
 113     "strip-private",
 114     "collapse-docs",
 115     "unindent-comments",
 116 ];
 117
 118 struct Output {
 119     krate: clean::Crate,
 120     renderinfo: html::render::RenderInfo,
 121     passes: Vec<String>,
 122 }
 123
 124 pub fn main() {
 125     const STACK_SIZE: usize = 32000000; // 32MB
 126     let res = std::thread::Builder::new().stack_size(STACK_SIZE).spawn(move || {
 127         let s = env::args().collect::<Vec<_>>();
 128         main_args(&s)
 129     }).unwrap().join().unwrap_or(101);
 130     process::exit(res as i32);
 131 }
 132
 133 fn stable(g: getopts::OptGroup) -> RustcOptGroup { RustcOptGroup::stable(g) }
 134 fn unstable(g: getopts::OptGroup) -> RustcOptGroup { RustcOptGroup::unstable(g) }
 135
 136 pub fn opts() -> Vec<RustcOptGroup> {
 137     use getopts::*;
 138     vec!(
 139         stable(optflag("h", "help", "show this help message")),
 140         stable(optflag("V", "version", "print rustdoc's version")),
 141         stable(optflag("v", "verbose", "use verbose output")),
 142         stable(optopt("r", "input-format", "the input type of the specified file",
 143                       "[rust]")),
 144         stable(optopt("w", "output-format", "the output type to write",
 145                       "[html]")),
 146         stable(optopt("o", "output", "where to place the output", "PATH")),
 147         stable(optopt("", "crate-name", "specify the name of this crate", "NAME")),
 148         stable(optmulti("L", "library-path", "directory to add to crate search path",
 149                         "DIR")),
 150         stable(optmulti("", "cfg", "pass a --cfg to rustc", "")),
 151         stable(optmulti("", "extern", "pass an --extern to rustc", "NAME=PATH")),
 152         stable(optmulti("", "plugin-path", "directory to load plugins from", "DIR")),
 153         stable(optmulti("", "passes",
 154                         "list of passes to also run, you might want \
 155                          to pass it multiple times; a value of `list` \
 156                          will print available passes",
 157                         "PASSES")),
 158         stable(optmulti("", "plugins", "space separated list of plugins to also load",
 159                         "PLUGINS")),
 160         stable(optflag("", "no-defaults", "don't run the default passes")),
 161         stable(optflag("", "test", "run code examples as tests")),
 162         stable(optmulti("", "test-args", "arguments to pass to the test runner",
 163                         "ARGS")),
 164         stable(optopt("", "target", "target triple to document", "TRIPLE")),
 165         stable(optmulti("", "markdown-css",
 166                         "CSS files to include via <link> in a rendered Markdown file",
 167                         "FILES")),
 168         stable(optmulti("", "html-in-header",
 169                         "files to include inline in the <head> section of a rendered Markdown file \
 170                          or generated documentation",
 171                         "FILES")),
 172         stable(optmulti("", "html-before-content",
 173                         "files to include inline between <body> and the content of a rendered \
 174                          Markdown file or generated documentation",
 175                         "FILES")),
 176         stable(optmulti("", "html-after-content",
 177                         "files to include inline between the content and </body> of a rendered \
 178                          Markdown file or generated documentation",
 179                         "FILES")),
 180         stable(optopt("", "markdown-playground-url",
 181                       "URL to send code snippets to", "URL")),
 182         stable(optflag("", "markdown-no-toc", "don't include table of contents")),
 183         unstable(optopt("e", "extend-css",
 184                         "to redefine some css rules with a given file to generate doc with your \
 185                          own theme", "PATH")),
 186         unstable(optmulti("Z", "",
 187                           "internal and debugging options (only on nightly build)", "FLAG")),
 188     )
 189 }
 190
 191 pub fn usage(argv0: &str) {
 192     println!("{}",
 193              getopts::usage(&format!("{} [options] <input>", argv0),
 194                             &opts().into_iter()
 195                                    .map(|x| x.opt_group)
 196                                    .collect::<Vec<getopts::OptGroup>>()));
 197 }
 198
 199 pub fn main_args(args: &[String]) -> isize {
 200     let all_groups: Vec<getopts::OptGroup> = opts()
 201                                              .into_iter()
 202                                              .map(|x| x.opt_group)
 203                                              .collect();
 204     let matches = match getopts::getopts(&args[1..], &all_groups) {
 205         Ok(m) => m,
 206         Err(err) => {
 207             println!("{}", err);
 208             return 1;
 209         }
 210     };
 211     // Check for unstable options.
 212     nightly_options::check_nightly_options(&matches, &opts());
 213
 214     if matches.opt_present("h") || matches.opt_present("help") {
 215         usage(&args[0]);
 216         return 0;
 217     } else if matches.opt_present("version") {
 218         rustc_driver::version("rustdoc", &matches);
 219         return 0;
 220     }
 221
 222     if matches.opt_strs("passes") == ["list"] {
 223         println!("Available passes for running rustdoc:");
 224         for &(name, _, description) in PASSES {
 225             println!("{:>20} - {}", name, description);
 226         }
 227         println!("\nDefault passes for rustdoc:");
 228         for &name in DEFAULT_PASSES {
 229             println!("{:>20}", name);
 230         }
 231         return 0;
 232     }
 233
 234     if matches.free.is_empty() {
 235         println!("expected an input file to act on");
 236         return 1;
 237     } if matches.free.len() > 1 {
 238         println!("only one input file may be specified");
 239         return 1;
 240     }
 241     let input = &matches.free[0];
 242
 243     let mut libs = SearchPaths::new();
 244     for s in &matches.opt_strs("L") {
 245         libs.add_path(s, ErrorOutputType::default());
 246     }
 247     let externs = match parse_externs(&matches) {
 248         Ok(ex) => ex,
 249         Err(err) => {
 250             println!("{}", err);
 251             return 1;
 252         }
 253     };
 254
 255     let test_args = matches.opt_strs("test-args");
 256     let test_args: Vec<String> = test_args.iter()
 257                                           .flat_map(|s| s.split_whitespace())
 258                                           .map(|s| s.to_string())
 259                                           .collect();
 260
 261     let should_test = matches.opt_present("test");
 262     let markdown_input = input.ends_with(".md") || input.ends_with(".markdown");
 263
 264     let output = matches.opt_str("o").map(|s| PathBuf::from(&s));
 265     let css_file_extension = matches.opt_str("e").map(|s| PathBuf::from(&s));
 266     let cfgs = matches.opt_strs("cfg");
 267
 268     if let Some(ref p) = css_file_extension {
 269         if !p.is_file() {
 270             println!("{}", "--extend-css option must take a css file as input");
 271             return 1;
 272         }
 273     }
 274
 275     let external_html = match ExternalHtml::load(
 276             &matches.opt_strs("html-in-header"),
 277             &matches.opt_strs("html-before-content"),
 278             &matches.opt_strs("html-after-content")) {
 279         Some(eh) => eh,
 280         None => return 3
 281     };
 282     let crate_name = matches.opt_str("crate-name");
 283
 284     match (should_test, markdown_input) {
 285         (true, true) => {
 286             return markdown::test(input, cfgs, libs, externs, test_args)
 287         }
 288         (true, false) => {
 289             return test::run(input, cfgs, libs, externs, test_args, crate_name)
 290         }
 291         (false, true) => return markdown::render(input,
 292                                                  output.unwrap_or(PathBuf::from("doc")),
 293                                                  &matches, &external_html,
 294                                                  !matches.opt_present("markdown-no-toc")),
 295         (false, false) => {}
 296     }
 297     let out = match acquire_input(input, externs, &matches) {
 298         Ok(out) => out,
 299         Err(s) => {
 300             println!("input error: {}", s);
 301             return 1;
 302         }
 303     };
 304     let Output { krate, passes, renderinfo } = out;
 305     info!("going to format");
 306     match matches.opt_str("w").as_ref().map(|s| &**s) {
 307         Some("html") | None => {
 308             html::render::run(krate, &external_html,
 309                               output.unwrap_or(PathBuf::from("doc")),
 310                               passes.into_iter().collect(),
 311                               css_file_extension,
 312                               renderinfo)
 313                 .expect("failed to generate documentation")
 314         }
 315         Some(s) => {
 316             println!("unknown output format: {}", s);
 317             return 1;
 318         }
 319     }
 320
 321     return 0;
 322 }
 323
 324 /// Looks inside the command line arguments to extract the relevant input format
 325 /// and files and then generates the necessary rustdoc output for formatting.
 326 fn acquire_input(input: &str,
 327                  externs: Externs,
 328                  matches: &getopts::Matches) -> Result<Output, String> {
 329     match matches.opt_str("r").as_ref().map(|s| &**s) {
 330         Some("rust") => Ok(rust_input(input, externs, matches)),
 331         Some(s) => Err(format!("unknown input format: {}", s)),
 332         None => {
 333             Ok(rust_input(input, externs, matches))
 334         }
 335     }
 336 }
 337
 338 /// Extracts `--extern CRATE=PATH` arguments from `matches` and
 339 /// returns a map mapping crate names to their paths or else an
 340 /// error message.
 341 fn parse_externs(matches: &getopts::Matches) -> Result<Externs, String> {
 342     let mut externs = BTreeMap::new();
 343     for arg in &matches.opt_strs("extern") {
 344         let mut parts = arg.splitn(2, '=');
 345         let name = parts.next().ok_or("--extern value must not be empty".to_string())?;
 346         let location = parts.next()
 347                                  .ok_or("--extern value must be of the format `foo=bar`"
 348                                     .to_string())?;
 349         let name = name.to_string();
 350         externs.entry(name).or_insert_with(BTreeSet::new).insert(location.to_string());
 351     }
 352     Ok(Externs::new(externs))
 353 }
 354
 355 /// Interprets the input file as a rust source file, passing it through the
 356 /// compiler all the way through the analysis passes. The rustdoc output is then
 357 /// generated from the cleaned AST of the crate.
 358 ///
 359 /// This form of input will run all of the plug/cleaning passes
 360 fn rust_input(cratefile: &str, externs: Externs, matches: &getopts::Matches) -> Output {
 361     let mut default_passes = !matches.opt_present("no-defaults");
 362     let mut passes = matches.opt_strs("passes");
 363     let mut plugins = matches.opt_strs("plugins");
 364
 365     // First, parse the crate and extract all relevant information.
 366     let mut paths = SearchPaths::new();
 367     for s in &matches.opt_strs("L") {
 368         paths.add_path(s, ErrorOutputType::default());
 369     }
 370     let cfgs = matches.opt_strs("cfg");
 371     let triple = matches.opt_str("target");
 372
 373     let cr = PathBuf::from(cratefile);
 374     info!("starting to run rustc");
 375
 376     let (tx, rx) = channel();
 377     rustc_driver::monitor(move || {
 378         use rustc::session::config::Input;
 379
 380         tx.send(core::run_core(paths, cfgs, externs, Input::File(cr),
 381                                triple)).unwrap();
 382     });
 383     let (mut krate, renderinfo) = rx.recv().unwrap();
 384     info!("finished with rustc");
 385
 386     if let Some(name) = matches.opt_str("crate-name") {
 387         krate.name = name
 388     }
 389
 390     // Process all of the crate attributes, extracting plugin metadata along
 391     // with the passes which we are supposed to run.
 392     for attr in krate.module.as_ref().unwrap().attrs.list("doc") {
 393         match *attr {
 394             clean::Word(ref w) if "no_default_passes" == *w => {
 395                 default_passes = false;
 396             },
 397             clean::NameValue(ref name, ref value) => {
 398                 let sink = match &name[..] {
 399                     "passes" => &mut passes,
 400                     "plugins" => &mut plugins,
 401                     _ => continue,
 402                 };
 403                 for p in value.split_whitespace() {
 404                     sink.push(p.to_string());
 405                 }
 406             }
 407             _ => (),
 408         }
 409     }
 410
 411     if default_passes {
 412         for name in DEFAULT_PASSES.iter().rev() {
 413             passes.insert(0, name.to_string());
 414         }
 415     }
 416
 417     // Load all plugins/passes into a PluginManager
 418     let path = matches.opt_str("plugin-path")
 419                       .unwrap_or("/tmp/rustdoc/plugins".to_string());
 420     let mut pm = plugins::PluginManager::new(PathBuf::from(path));
 421     for pass in &passes {
 422         let plugin = match PASSES.iter()
 423                                  .position(|&(p, _, _)| {
 424                                      p == *pass
 425                                  }) {
 426             Some(i) => PASSES[i].1,
 427             None => {
 428                 error!("unknown pass {}, skipping", *pass);
 429                 continue
 430             },
 431         };
 432         pm.add_plugin(plugin);
 433     }
 434     info!("loading plugins...");
 435     for pname in plugins {
 436         pm.load_plugin(pname);
 437     }
 438
 439     // Run everything!
 440     info!("Executing passes/plugins");
 441     let krate = pm.run_plugins(krate);
 442     Output { krate: krate, renderinfo: renderinfo, passes: passes }
 443 }