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 #![experimental]
  13 #![desc = "rustdoc, the Rust documentation extractor"]
  14 #![license = "MIT/ASL2"]
  15 #![crate_type = "dylib"]
  16 #![crate_type = "rlib"]
  17
  18 #![feature(globs, struct_variant, managed_boxes, macro_rules, phase)]
  19
  20 extern crate arena;
  21 extern crate debug;
  22 extern crate getopts;
  23 extern crate libc;
  24 extern crate rustc;
  25 extern crate serialize;
  26 extern crate syntax;
  27 extern crate "test" as testing;
  28 extern crate time;
  29 #[phase(plugin, link)] extern crate log;
  30
  31 use std::io;
  32 use std::io::{File, MemWriter};
  33 use std::collections::HashMap;
  34 use serialize::{json, Decodable, Encodable};
  35 use externalfiles::ExternalHtml;
  36
  37 // reexported from `clean` so it can be easily updated with the mod itself
  38 pub use clean::SCHEMA_VERSION;
  39
  40 pub mod clean;
  41 pub mod core;
  42 pub mod doctree;
  43 #[macro_escape]
  44 pub mod externalfiles;
  45 pub mod fold;
  46 pub mod html {
  47     pub mod highlight;
  48     pub mod escape;
  49     pub mod item_type;
  50     pub mod format;
  51     pub mod layout;
  52     pub mod markdown;
  53     pub mod render;
  54     pub mod toc;
  55 }
  56 pub mod markdown;
  57 pub mod passes;
  58 pub mod plugins;
  59 pub mod stability_summary;
  60 pub mod visit_ast;
  61 pub mod test;
  62 mod flock;
  63
  64 type Pass = (&'static str,                                      // name
  65              fn(clean::Crate) -> plugins::PluginResult,         // fn
  66              &'static str);                                     // description
  67
  68 static PASSES: &'static [Pass] = &[
  69     ("strip-hidden", passes::strip_hidden,
  70      "strips all doc(hidden) items from the output"),
  71     ("unindent-comments", passes::unindent_comments,
  72      "removes excess indentation on comments in order for markdown to like it"),
  73     ("collapse-docs", passes::collapse_docs,
  74      "concatenates all document attributes into one document attribute"),
  75     ("strip-private", passes::strip_private,
  76      "strips all private items from a crate which cannot be seen externally"),
  77 ];
  78
  79 static DEFAULT_PASSES: &'static [&'static str] = &[
  80     "strip-hidden",
  81     "strip-private",
  82     "collapse-docs",
  83     "unindent-comments",
  84 ];
  85
  86 local_data_key!(pub analysiskey: core::CrateAnalysis)
  87
  88 type Output = (clean::Crate, Vec<plugins::PluginJson> );
  89
  90 pub fn main() {
  91     // Why run rustdoc in a separate task? That's a good question!
  92     //
  93     // We first begin our adventure at the ancient commit of e7c4fb69. In this
  94     // commit it was discovered that the stack limit frobbing on windows ended
  95     // up causing some syscalls to fail. This was worked around manually in the
  96     // relevant location.
  97     //
  98     // Our journey now continues with #13259 where it was discovered that this
  99     // stack limit frobbing has the ability to affect nearly any syscall. Note
 100     // that the key idea here is that there is currently no knowledge as to why
 101     // this is happening or how to preserve it, fun times!
 102     //
 103     // Now we continue along to #16275 where it was discovered that --test on
 104     // windows didn't work at all! Yet curiously rustdoc worked without --test.
 105     // The exact reason that #16275 cropped up is that during the expansion
 106     // phase the compiler attempted to open libstd to read out its macros. This
 107     // invoked the LLVMRustOpenArchive shim which in turned went to LLVM to go
 108     // open a file and read it. Lo and behold this function returned an error!
 109     // It was then discovered that when the same fix mentioned in #13259 was
 110     // applied, the error went away. The plot thickens!
 111     //
 112     // Remember that rustdoc works without --test, which raises the question of
 113     // how because the --test and non --test paths are almost identical. The
 114     // first thing both paths do is parse and expand a crate! It turns out that
 115     // the difference is that --test runs on the *main task* while the normal
 116     // path runs in subtask. It turns out that running --test in a sub task also
 117     // fixes the problem!
 118     //
 119     // So, in summary, it is unknown why this is necessary, what it is
 120     // preventing, or what the actual bug is. In the meantime, this allows
 121     // --test to work on windows, which seems good, right? Fun times.
 122     let (tx, rx) = channel();
 123     spawn(proc() {
 124         std::os::set_exit_status(main_args(std::os::args().as_slice()));
 125         tx.send(());
 126     });
 127
 128     // If the task failed, set an error'd exit status
 129     if rx.recv_opt().is_err() {
 130         std::os::set_exit_status(std::rt::DEFAULT_ERROR_CODE);
 131     }
 132 }
 133
 134 pub fn opts() -> Vec<getopts::OptGroup> {
 135     use getopts::*;
 136     vec!(
 137         optflag("h", "help", "show this help message"),
 138         optflagopt("", "version", "print rustdoc's version", "verbose"),
 139         optopt("r", "input-format", "the input type of the specified file",
 140                "[rust|json]"),
 141         optopt("w", "output-format", "the output type to write",
 142                "[html|json]"),
 143         optopt("o", "output", "where to place the output", "PATH"),
 144         optopt("", "crate-name", "specify the name of this crate", "NAME"),
 145         optmulti("L", "library-path", "directory to add to crate search path",
 146                  "DIR"),
 147         optmulti("", "cfg", "pass a --cfg to rustc", ""),
 148         optmulti("", "extern", "pass an --extern to rustc", "NAME=PATH"),
 149         optmulti("", "plugin-path", "directory to load plugins from", "DIR"),
 150         optmulti("", "passes", "space separated list of passes to also run, a \
 151                                 value of `list` will print available passes",
 152                  "PASSES"),
 153         optmulti("", "plugins", "space separated list of plugins to also load",
 154                  "PLUGINS"),
 155         optflag("", "no-defaults", "don't run the default passes"),
 156         optflag("", "test", "run code examples as tests"),
 157         optmulti("", "test-args", "arguments to pass to the test runner",
 158                  "ARGS"),
 159         optopt("", "target", "target triple to document", "TRIPLE"),
 160         optmulti("", "markdown-css", "CSS files to include via <link> in a rendered Markdown file",
 161                  "FILES"),
 162         optmulti("", "html-in-header",
 163                  "files to include inline in the <head> section of a rendered Markdown file \
 164                  or generated documentation",
 165                  "FILES"),
 166         optmulti("", "html-before-content",
 167                  "files to include inline between <body> and the content of a rendered \
 168                  Markdown file or generated documentation",
 169                  "FILES"),
 170         optmulti("", "html-after-content",
 171                  "files to include inline between the content and </body> of a rendered \
 172                  Markdown file or generated documentation",
 173                  "FILES"),
 174         optopt("", "markdown-playground-url",
 175                "URL to send code snippets to", "URL"),
 176         optflag("", "markdown-no-toc", "don't include table of contents")
 177     )
 178 }
 179
 180 pub fn usage(argv0: &str) {
 181     println!("{}",
 182              getopts::usage(format!("{} [options] <input>", argv0).as_slice(),
 183                             opts().as_slice()));
 184 }
 185
 186 pub fn main_args(args: &[String]) -> int {
 187     let matches = match getopts::getopts(args.tail(), opts().as_slice()) {
 188         Ok(m) => m,
 189         Err(err) => {
 190             println!("{}", err);
 191             return 1;
 192         }
 193     };
 194     if matches.opt_present("h") || matches.opt_present("help") {
 195         usage(args[0].as_slice());
 196         return 0;
 197     } else if matches.opt_present("version") {
 198         match rustc::driver::version("rustdoc", &matches) {
 199             Some(err) => {
 200                 println!("{}", err);
 201                 return 1
 202             },
 203             None => return 0
 204         }
 205     }
 206
 207     if matches.opt_strs("passes").as_slice() == &["list".to_string()] {
 208         println!("Available passes for running rustdoc:");
 209         for &(name, _, description) in PASSES.iter() {
 210             println!("{:>20s} - {}", name, description);
 211         }
 212         println!("{}", "\nDefault passes for rustdoc:"); // FIXME: #9970
 213         for &name in DEFAULT_PASSES.iter() {
 214             println!("{:>20s}", name);
 215         }
 216         return 0;
 217     }
 218
 219     if matches.free.len() == 0 {
 220         println!("expected an input file to act on");
 221         return 1;
 222     } if matches.free.len() > 1 {
 223         println!("only one input file may be specified");
 224         return 1;
 225     }
 226     let input = matches.free[0].as_slice();
 227
 228     let libs = matches.opt_strs("L").iter().map(|s| Path::new(s.as_slice())).collect();
 229     let externs = match parse_externs(&matches) {
 230         Ok(ex) => ex,
 231         Err(err) => {
 232             println!("{}", err);
 233             return 1;
 234         }
 235     };
 236
 237     let test_args = matches.opt_strs("test-args");
 238     let test_args: Vec<String> = test_args.iter()
 239                                           .flat_map(|s| s.as_slice().words())
 240                                           .map(|s| s.to_string())
 241                                           .collect();
 242
 243     let should_test = matches.opt_present("test");
 244     let markdown_input = input.ends_with(".md") || input.ends_with(".markdown");
 245
 246     let output = matches.opt_str("o").map(|s| Path::new(s));
 247     let cfgs = matches.opt_strs("cfg");
 248
 249     let external_html = match ExternalHtml::load(
 250             matches.opt_strs("html-in-header").as_slice(),
 251             matches.opt_strs("html-before-content").as_slice(),
 252             matches.opt_strs("html-after-content").as_slice()) {
 253         Some(eh) => eh,
 254         None => return 3
 255     };
 256     let crate_name = matches.opt_str("crate-name");
 257
 258     match (should_test, markdown_input) {
 259         (true, true) => {
 260             return markdown::test(input, libs, externs, test_args)
 261         }
 262         (true, false) => {
 263             return test::run(input, cfgs, libs, externs, test_args, crate_name)
 264         }
 265         (false, true) => return markdown::render(input, output.unwrap_or(Path::new("doc")),
 266                                                  &matches, &external_html,
 267                                                  !matches.opt_present("markdown-no-toc")),
 268         (false, false) => {}
 269     }
 270
 271     let (krate, res) = match acquire_input(input, externs, &matches) {
 272         Ok(pair) => pair,
 273         Err(s) => {
 274             println!("input error: {}", s);
 275             return 1;
 276         }
 277     };
 278
 279     info!("going to format");
 280     let started = time::precise_time_ns();
 281     match matches.opt_str("w").as_ref().map(|s| s.as_slice()) {
 282         Some("html") | None => {
 283             match html::render::run(krate, &external_html, output.unwrap_or(Path::new("doc"))) {
 284                 Ok(()) => {}
 285                 Err(e) => fail!("failed to generate documentation: {}", e),
 286             }
 287         }
 288         Some("json") => {
 289             match json_output(krate, res, output.unwrap_or(Path::new("doc.json"))) {
 290                 Ok(()) => {}
 291                 Err(e) => fail!("failed to write json: {}", e),
 292             }
 293         }
 294         Some(s) => {
 295             println!("unknown output format: {}", s);
 296             return 1;
 297         }
 298     }
 299     let ended = time::precise_time_ns();
 300     info!("Took {:.03f}s", (ended as f64 - started as f64) / 1e9f64);
 301
 302     return 0;
 303 }
 304
 305 /// Looks inside the command line arguments to extract the relevant input format
 306 /// and files and then generates the necessary rustdoc output for formatting.
 307 fn acquire_input(input: &str,
 308                  externs: core::Externs,
 309                  matches: &getopts::Matches) -> Result<Output, String> {
 310     match matches.opt_str("r").as_ref().map(|s| s.as_slice()) {
 311         Some("rust") => Ok(rust_input(input, externs, matches)),
 312         Some("json") => json_input(input),
 313         Some(s) => Err(format!("unknown input format: {}", s)),
 314         None => {
 315             if input.ends_with(".json") {
 316                 json_input(input)
 317             } else {
 318                 Ok(rust_input(input, externs, matches))
 319             }
 320         }
 321     }
 322 }
 323
 324 /// Extracts `--extern CRATE=PATH` arguments from `matches` and
 325 /// returns a `HashMap` mapping crate names to their paths or else an
 326 /// error message.
 327 fn parse_externs(matches: &getopts::Matches) -> Result<core::Externs, String> {
 328     let mut externs = HashMap::new();
 329     for arg in matches.opt_strs("extern").iter() {
 330         let mut parts = arg.as_slice().splitn(1, '=');
 331         let name = match parts.next() {
 332             Some(s) => s,
 333             None => {
 334                 return Err("--extern value must not be empty".to_string());
 335             }
 336         };
 337         let location = match parts.next() {
 338             Some(s) => s,
 339             None => {
 340                 return Err("--extern value must be of the format `foo=bar`".to_string());
 341             }
 342         };
 343         let locs = externs.find_or_insert(name.to_string(), Vec::new());
 344         locs.push(location.to_string());
 345     }
 346     Ok(externs)
 347 }
 348
 349 /// Interprets the input file as a rust source file, passing it through the
 350 /// compiler all the way through the analysis passes. The rustdoc output is then
 351 /// generated from the cleaned AST of the crate.
 352 ///
 353 /// This form of input will run all of the plug/cleaning passes
 354 fn rust_input(cratefile: &str, externs: core::Externs, matches: &getopts::Matches) -> Output {
 355     let mut default_passes = !matches.opt_present("no-defaults");
 356     let mut passes = matches.opt_strs("passes");
 357     let mut plugins = matches.opt_strs("plugins");
 358
 359     // First, parse the crate and extract all relevant information.
 360     let libs: Vec<Path> = matches.opt_strs("L")
 361                                  .iter()
 362                                  .map(|s| Path::new(s.as_slice()))
 363                                  .collect();
 364     let cfgs = matches.opt_strs("cfg");
 365     let triple = matches.opt_str("target");
 366
 367     let cr = Path::new(cratefile);
 368     info!("starting to run rustc");
 369     let (mut krate, analysis) = std::task::try(proc() {
 370         let cr = cr;
 371         core::run_core(libs, cfgs, externs, &cr, triple)
 372     }).map_err(|boxed_any|format!("{:?}", boxed_any)).unwrap();
 373     info!("finished with rustc");
 374     analysiskey.replace(Some(analysis));
 375
 376     match matches.opt_str("crate-name") {
 377         Some(name) => krate.name = name,
 378         None => {}
 379     }
 380
 381     // Process all of the crate attributes, extracting plugin metadata along
 382     // with the passes which we are supposed to run.
 383     match krate.module.as_ref().unwrap().doc_list() {
 384         Some(nested) => {
 385             for inner in nested.iter() {
 386                 match *inner {
 387                     clean::Word(ref x)
 388                             if "no_default_passes" == x.as_slice() => {
 389                         default_passes = false;
 390                     }
 391                     clean::NameValue(ref x, ref value)
 392                             if "passes" == x.as_slice() => {
 393                         for pass in value.as_slice().words() {
 394                             passes.push(pass.to_string());
 395                         }
 396                     }
 397                     clean::NameValue(ref x, ref value)
 398                             if "plugins" == x.as_slice() => {
 399                         for p in value.as_slice().words() {
 400                             plugins.push(p.to_string());
 401                         }
 402                     }
 403                     _ => {}
 404                 }
 405             }
 406         }
 407         None => {}
 408     }
 409     if default_passes {
 410         for name in DEFAULT_PASSES.iter().rev() {
 411             passes.insert(0, name.to_string());
 412         }
 413     }
 414
 415     // Load all plugins/passes into a PluginManager
 416     let path = matches.opt_str("plugin-path")
 417                       .unwrap_or("/tmp/rustdoc/plugins".to_string());
 418     let mut pm = plugins::PluginManager::new(Path::new(path));
 419     for pass in passes.iter() {
 420         let plugin = match PASSES.iter()
 421                                  .position(|&(p, _, _)| {
 422                                      p == pass.as_slice()
 423                                  }) {
 424             Some(i) => PASSES[i].val1(),
 425             None => {
 426                 error!("unknown pass {}, skipping", *pass);
 427                 continue
 428             },
 429         };
 430         pm.add_plugin(plugin);
 431     }
 432     info!("loading plugins...");
 433     for pname in plugins.into_iter() {
 434         pm.load_plugin(pname);
 435     }
 436
 437     // Run everything!
 438     info!("Executing passes/plugins");
 439     return pm.run_plugins(krate);
 440 }
 441
 442 /// This input format purely deserializes the json output file. No passes are
 443 /// run over the deserialized output.
 444 fn json_input(input: &str) -> Result<Output, String> {
 445     let mut input = match File::open(&Path::new(input)) {
 446         Ok(f) => f,
 447         Err(e) => {
 448             return Err(format!("couldn't open {}: {}", input, e))
 449         }
 450     };
 451     match json::from_reader(&mut input) {
 452         Err(s) => Err(s.to_string()),
 453         Ok(json::Object(obj)) => {
 454             let mut obj = obj;
 455             // Make sure the schema is what we expect
 456             match obj.pop(&"schema".to_string()) {
 457                 Some(json::String(version)) => {
 458                     if version.as_slice() != SCHEMA_VERSION {
 459                         return Err(format!(
 460                                 "sorry, but I only understand version {}",
 461                                 SCHEMA_VERSION))
 462                     }
 463                 }
 464                 Some(..) => return Err("malformed json".to_string()),
 465                 None => return Err("expected a schema version".to_string()),
 466             }
 467             let krate = match obj.pop(&"crate".to_string()) {
 468                 Some(json) => {
 469                     let mut d = json::Decoder::new(json);
 470                     Decodable::decode(&mut d).unwrap()
 471                 }
 472                 None => return Err("malformed json".to_string()),
 473             };
 474             // FIXME: this should read from the "plugins" field, but currently
 475             //      Json doesn't implement decodable...
 476             let plugin_output = Vec::new();
 477             Ok((krate, plugin_output))
 478         }
 479         Ok(..) => {
 480             Err("malformed json input: expected an object at the \
 481                  top".to_string())
 482         }
 483     }
 484 }
 485
 486 /// Outputs the crate/plugin json as a giant json blob at the specified
 487 /// destination.
 488 fn json_output(krate: clean::Crate, res: Vec<plugins::PluginJson> ,
 489                dst: Path) -> io::IoResult<()> {
 490     // {
 491     //   "schema": version,
 492     //   "crate": { parsed crate ... },
 493     //   "plugins": { output of plugins ... }
 494     // }
 495     let mut json = std::collections::TreeMap::new();
 496     json.insert("schema".to_string(), json::String(SCHEMA_VERSION.to_string()));
 497     let plugins_json = res.into_iter()
 498                           .filter_map(|opt| {
 499                               match opt {
 500                                   None => None,
 501                                   Some((string, json)) => {
 502                                       Some((string.to_string(), json))
 503                                   }
 504                               }
 505                           }).collect();
 506
 507     // FIXME #8335: yuck, Rust -> str -> JSON round trip! No way to .encode
 508     // straight to the Rust JSON representation.
 509     let crate_json_str = {
 510         let mut w = MemWriter::new();
 511         {
 512             let mut encoder = json::Encoder::new(&mut w as &mut io::Writer);
 513             krate.encode(&mut encoder).unwrap();
 514         }
 515         String::from_utf8(w.unwrap()).unwrap()
 516     };
 517     let crate_json = match json::from_str(crate_json_str.as_slice()) {
 518         Ok(j) => j,
 519         Err(e) => fail!("Rust generated JSON is invalid: {:?}", e)
 520     };
 521
 522     json.insert("crate".to_string(), crate_json);
 523     json.insert("plugins".to_string(), json::Object(plugins_json));
 524
 525     let mut file = try!(File::create(&dst));
 526     json::Object(json).to_writer(&mut file)
 527 }