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_id = "rustdoc#0.11.0"] // NOTE: remove after stage0
  12 #![crate_name = "rustdoc"]
  13 #![experimental]
  14 #![desc = "rustdoc, the Rust documentation extractor"]
  15 #![license = "MIT/ASL2"]
  16 #![crate_type = "dylib"]
  17 #![crate_type = "rlib"]
  18 #![allow(unused_attribute)] // NOTE: remove after stage0
  19
  20 #![feature(globs, struct_variant, managed_boxes, macro_rules, phase)]
  21
  22 extern crate debug;
  23 extern crate getopts;
  24 extern crate libc;
  25 extern crate rustc;
  26 extern crate serialize;
  27 extern crate syntax;
  28 extern crate testing = "test";
  29 extern crate time;
  30 #[phase(plugin, link)] extern crate log;
  31
  32 use std::io;
  33 use std::io::{File, MemWriter};
  34 use std::str;
  35 use std::gc::Gc;
  36 use serialize::{json, Decodable, Encodable};
  37 use externalfiles::ExternalHtml;
  38
  39 // reexported from `clean` so it can be easily updated with the mod itself
  40 pub use clean::SCHEMA_VERSION;
  41
  42 pub mod clean;
  43 pub mod core;
  44 pub mod doctree;
  45 #[macro_escape]
  46 pub mod externalfiles;
  47 pub mod fold;
  48 pub mod html {
  49     pub mod highlight;
  50     pub mod escape;
  51     pub mod item_type;
  52     pub mod format;
  53     pub mod layout;
  54     pub mod markdown;
  55     pub mod render;
  56     pub mod toc;
  57 }
  58 pub mod markdown;
  59 pub mod passes;
  60 pub mod plugins;
  61 pub mod visit_ast;
  62 pub mod test;
  63 mod flock;
  64
  65 type Pass = (&'static str,                                      // name
  66              fn(clean::Crate) -> plugins::PluginResult,         // fn
  67              &'static str);                                     // description
  68
  69 static PASSES: &'static [Pass] = &[
  70     ("strip-hidden", passes::strip_hidden,
  71      "strips all doc(hidden) items from the output"),
  72     ("unindent-comments", passes::unindent_comments,
  73      "removes excess indentation on comments in order for markdown to like it"),
  74     ("collapse-docs", passes::collapse_docs,
  75      "concatenates all document attributes into one document attribute"),
  76     ("strip-private", passes::strip_private,
  77      "strips all private items from a crate which cannot be seen externally"),
  78 ];
  79
  80 static DEFAULT_PASSES: &'static [&'static str] = &[
  81     "strip-hidden",
  82     "strip-private",
  83     "collapse-docs",
  84     "unindent-comments",
  85 ];
  86
  87 local_data_key!(pub ctxtkey: Gc<core::DocContext>)
  88 local_data_key!(pub analysiskey: core::CrateAnalysis)
  89
  90 type Output = (clean::Crate, Vec<plugins::PluginJson> );
  91
  92 pub fn main() {
  93     std::os::set_exit_status(main_args(std::os::args().as_slice()));
  94 }
  95
  96 pub fn opts() -> Vec<getopts::OptGroup> {
  97     use getopts::*;
  98     vec!(
  99         optflag("h", "help", "show this help message"),
 100         optflagopt("", "version", "print rustdoc's version", "verbose"),
 101         optopt("r", "input-format", "the input type of the specified file",
 102                "[rust|json]"),
 103         optopt("w", "output-format", "the output type to write",
 104                "[html|json]"),
 105         optopt("o", "output", "where to place the output", "PATH"),
 106         optmulti("L", "library-path", "directory to add to crate search path",
 107                  "DIR"),
 108         optmulti("", "cfg", "pass a --cfg to rustc", ""),
 109         optmulti("", "plugin-path", "directory to load plugins from", "DIR"),
 110         optmulti("", "passes", "space separated list of passes to also run, a \
 111                                 value of `list` will print available passes",
 112                  "PASSES"),
 113         optmulti("", "plugins", "space separated list of plugins to also load",
 114                  "PLUGINS"),
 115         optflag("", "no-defaults", "don't run the default passes"),
 116         optflag("", "test", "run code examples as tests"),
 117         optmulti("", "test-args", "arguments to pass to the test runner",
 118                  "ARGS"),
 119         optmulti("", "markdown-css", "CSS files to include via <link> in a rendered Markdown file",
 120                  "FILES"),
 121         optmulti("", "html-in-header",
 122                  "files to include inline in the <head> section of a rendered Markdown file \
 123                  or generated documentation",
 124                  "FILES"),
 125         optmulti("", "html-before-content",
 126                  "files to include inline between <body> and the content of a rendered \
 127                  Markdown file or generated documentation",
 128                  "FILES"),
 129         optmulti("", "html-after-content",
 130                  "files to include inline between the content and </body> of a rendered \
 131                  Markdown file or generated documentation",
 132                  "FILES"),
 133         optopt("", "markdown-playground-url",
 134                "URL to send code snippets to", "URL")
 135     )
 136 }
 137
 138 pub fn usage(argv0: &str) {
 139     println!("{}",
 140              getopts::usage(format!("{} [options] <input>", argv0).as_slice(),
 141                             opts().as_slice()));
 142 }
 143
 144 pub fn main_args(args: &[String]) -> int {
 145     let matches = match getopts::getopts(args.tail(), opts().as_slice()) {
 146         Ok(m) => m,
 147         Err(err) => {
 148             println!("{}", err);
 149             return 1;
 150         }
 151     };
 152     if matches.opt_present("h") || matches.opt_present("help") {
 153         usage(args[0].as_slice());
 154         return 0;
 155     } else if matches.opt_present("version") {
 156         match rustc::driver::version("rustdoc", &matches) {
 157             Some(err) => {
 158                 println!("{}", err);
 159                 return 1
 160             },
 161             None => return 0
 162         }
 163     }
 164
 165     if matches.free.len() == 0 {
 166         println!("expected an input file to act on");
 167         return 1;
 168     } if matches.free.len() > 1 {
 169         println!("only one input file may be specified");
 170         return 1;
 171     }
 172     let input = matches.free.get(0).as_slice();
 173
 174     let libs = matches.opt_strs("L").iter().map(|s| Path::new(s.as_slice())).collect();
 175
 176     let test_args = matches.opt_strs("test-args");
 177     let test_args: Vec<String> = test_args.iter()
 178                                           .flat_map(|s| s.as_slice().words())
 179                                           .map(|s| s.to_string())
 180                                           .collect();
 181
 182     let should_test = matches.opt_present("test");
 183     let markdown_input = input.ends_with(".md") || input.ends_with(".markdown");
 184
 185     let output = matches.opt_str("o").map(|s| Path::new(s));
 186     let cfgs = matches.opt_strs("cfg");
 187
 188     let external_html = match ExternalHtml::load(
 189             matches.opt_strs("html-in-header").as_slice(),
 190             matches.opt_strs("html-before-content").as_slice(),
 191             matches.opt_strs("html-after-content").as_slice()) {
 192         Some(eh) => eh,
 193         None => return 3
 194     };
 195
 196     match (should_test, markdown_input) {
 197         (true, true) => {
 198             return markdown::test(input, libs, test_args)
 199         }
 200         (true, false) => {
 201             return test::run(input, cfgs, libs, test_args)
 202         }
 203         (false, true) => return markdown::render(input, output.unwrap_or(Path::new("doc")),
 204                                                  &matches, &external_html),
 205         (false, false) => {}
 206     }
 207
 208     if matches.opt_strs("passes").as_slice() == &["list".to_string()] {
 209         println!("Available passes for running rustdoc:");
 210         for &(name, _, description) in PASSES.iter() {
 211             println!("{:>20s} - {}", name, description);
 212         }
 213         println!("{}", "\nDefault passes for rustdoc:"); // FIXME: #9970
 214         for &name in DEFAULT_PASSES.iter() {
 215             println!("{:>20s}", name);
 216         }
 217         return 0;
 218     }
 219
 220     let (krate, res) = match acquire_input(input, &matches) {
 221         Ok(pair) => pair,
 222         Err(s) => {
 223             println!("input error: {}", s);
 224             return 1;
 225         }
 226     };
 227
 228     info!("going to format");
 229     let started = time::precise_time_ns();
 230     match matches.opt_str("w").as_ref().map(|s| s.as_slice()) {
 231         Some("html") | None => {
 232             match html::render::run(krate, &external_html, output.unwrap_or(Path::new("doc"))) {
 233                 Ok(()) => {}
 234                 Err(e) => fail!("failed to generate documentation: {}", e),
 235             }
 236         }
 237         Some("json") => {
 238             match json_output(krate, res, output.unwrap_or(Path::new("doc.json"))) {
 239                 Ok(()) => {}
 240                 Err(e) => fail!("failed to write json: {}", e),
 241             }
 242         }
 243         Some(s) => {
 244             println!("unknown output format: {}", s);
 245             return 1;
 246         }
 247     }
 248     let ended = time::precise_time_ns();
 249     info!("Took {:.03f}s", (ended as f64 - started as f64) / 1e9f64);
 250
 251     return 0;
 252 }
 253
 254 /// Looks inside the command line arguments to extract the relevant input format
 255 /// and files and then generates the necessary rustdoc output for formatting.
 256 fn acquire_input(input: &str,
 257                  matches: &getopts::Matches) -> Result<Output, String> {
 258     match matches.opt_str("r").as_ref().map(|s| s.as_slice()) {
 259         Some("rust") => Ok(rust_input(input, matches)),
 260         Some("json") => json_input(input),
 261         Some(s) => Err(format!("unknown input format: {}", s)),
 262         None => {
 263             if input.ends_with(".json") {
 264                 json_input(input)
 265             } else {
 266                 Ok(rust_input(input, matches))
 267             }
 268         }
 269     }
 270 }
 271
 272 /// Interprets the input file as a rust source file, passing it through the
 273 /// compiler all the way through the analysis passes. The rustdoc output is then
 274 /// generated from the cleaned AST of the crate.
 275 ///
 276 /// This form of input will run all of the plug/cleaning passes
 277 fn rust_input(cratefile: &str, matches: &getopts::Matches) -> Output {
 278     let mut default_passes = !matches.opt_present("no-defaults");
 279     let mut passes = matches.opt_strs("passes");
 280     let mut plugins = matches.opt_strs("plugins");
 281
 282     // First, parse the crate and extract all relevant information.
 283     let libs: Vec<Path> = matches.opt_strs("L")
 284                                  .iter()
 285                                  .map(|s| Path::new(s.as_slice()))
 286                                  .collect();
 287     let cfgs = matches.opt_strs("cfg");
 288     let cr = Path::new(cratefile);
 289     info!("starting to run rustc");
 290     let (krate, analysis) = std::task::try(proc() {
 291         let cr = cr;
 292         core::run_core(libs.move_iter().map(|x| x.clone()).collect(),
 293                        cfgs,
 294                        &cr)
 295     }).map_err(|boxed_any|format!("{:?}", boxed_any)).unwrap();
 296     info!("finished with rustc");
 297     analysiskey.replace(Some(analysis));
 298
 299     // Process all of the crate attributes, extracting plugin metadata along
 300     // with the passes which we are supposed to run.
 301     match krate.module.get_ref().doc_list() {
 302         Some(nested) => {
 303             for inner in nested.iter() {
 304                 match *inner {
 305                     clean::Word(ref x)
 306                             if "no_default_passes" == x.as_slice() => {
 307                         default_passes = false;
 308                     }
 309                     clean::NameValue(ref x, ref value)
 310                             if "passes" == x.as_slice() => {
 311                         for pass in value.as_slice().words() {
 312                             passes.push(pass.to_string());
 313                         }
 314                     }
 315                     clean::NameValue(ref x, ref value)
 316                             if "plugins" == x.as_slice() => {
 317                         for p in value.as_slice().words() {
 318                             plugins.push(p.to_string());
 319                         }
 320                     }
 321                     _ => {}
 322                 }
 323             }
 324         }
 325         None => {}
 326     }
 327     if default_passes {
 328         for name in DEFAULT_PASSES.iter().rev() {
 329             passes.unshift(name.to_string());
 330         }
 331     }
 332
 333     // Load all plugins/passes into a PluginManager
 334     let path = matches.opt_str("plugin-path")
 335                       .unwrap_or("/tmp/rustdoc/plugins".to_string());
 336     let mut pm = plugins::PluginManager::new(Path::new(path));
 337     for pass in passes.iter() {
 338         let plugin = match PASSES.iter()
 339                                  .position(|&(p, _, _)| {
 340                                      p == pass.as_slice()
 341                                  }) {
 342             Some(i) => PASSES[i].val1(),
 343             None => {
 344                 error!("unknown pass {}, skipping", *pass);
 345                 continue
 346             },
 347         };
 348         pm.add_plugin(plugin);
 349     }
 350     info!("loading plugins...");
 351     for pname in plugins.move_iter() {
 352         pm.load_plugin(pname);
 353     }
 354
 355     // Run everything!
 356     info!("Executing passes/plugins");
 357     return pm.run_plugins(krate);
 358 }
 359
 360 /// This input format purely deserializes the json output file. No passes are
 361 /// run over the deserialized output.
 362 fn json_input(input: &str) -> Result<Output, String> {
 363     let mut input = match File::open(&Path::new(input)) {
 364         Ok(f) => f,
 365         Err(e) => {
 366             return Err(format!("couldn't open {}: {}", input, e))
 367         }
 368     };
 369     match json::from_reader(&mut input) {
 370         Err(s) => Err(s.to_str()),
 371         Ok(json::Object(obj)) => {
 372             let mut obj = obj;
 373             // Make sure the schema is what we expect
 374             match obj.pop(&"schema".to_string()) {
 375                 Some(json::String(version)) => {
 376                     if version.as_slice() != SCHEMA_VERSION {
 377                         return Err(format!(
 378                                 "sorry, but I only understand version {}",
 379                                 SCHEMA_VERSION))
 380                     }
 381                 }
 382                 Some(..) => return Err("malformed json".to_string()),
 383                 None => return Err("expected a schema version".to_string()),
 384             }
 385             let krate = match obj.pop(&"crate".to_string()) {
 386                 Some(json) => {
 387                     let mut d = json::Decoder::new(json);
 388                     Decodable::decode(&mut d).unwrap()
 389                 }
 390                 None => return Err("malformed json".to_string()),
 391             };
 392             // FIXME: this should read from the "plugins" field, but currently
 393             //      Json doesn't implement decodable...
 394             let plugin_output = Vec::new();
 395             Ok((krate, plugin_output))
 396         }
 397         Ok(..) => {
 398             Err("malformed json input: expected an object at the \
 399                  top".to_string())
 400         }
 401     }
 402 }
 403
 404 /// Outputs the crate/plugin json as a giant json blob at the specified
 405 /// destination.
 406 fn json_output(krate: clean::Crate, res: Vec<plugins::PluginJson> ,
 407                dst: Path) -> io::IoResult<()> {
 408     // {
 409     //   "schema": version,
 410     //   "crate": { parsed crate ... },
 411     //   "plugins": { output of plugins ... }
 412     // }
 413     let mut json = std::collections::TreeMap::new();
 414     json.insert("schema".to_string(), json::String(SCHEMA_VERSION.to_string()));
 415     let plugins_json = res.move_iter()
 416                           .filter_map(|opt| {
 417                               match opt {
 418                                   None => None,
 419                                   Some((string, json)) => {
 420                                       Some((string.to_string(), json))
 421                                   }
 422                               }
 423                           }).collect();
 424
 425     // FIXME #8335: yuck, Rust -> str -> JSON round trip! No way to .encode
 426     // straight to the Rust JSON representation.
 427     let crate_json_str = {
 428         let mut w = MemWriter::new();
 429         {
 430             let mut encoder = json::Encoder::new(&mut w as &mut io::Writer);
 431             krate.encode(&mut encoder).unwrap();
 432         }
 433         str::from_utf8_owned(w.unwrap()).unwrap()
 434     };
 435     let crate_json = match json::from_str(crate_json_str.as_slice()) {
 436         Ok(j) => j,
 437         Err(e) => fail!("Rust generated JSON is invalid: {:?}", e)
 438     };
 439
 440     json.insert("crate".to_string(), crate_json);
 441     json.insert("plugins".to_string(), json::Object(plugins_json));
 442
 443     let mut file = try!(File::create(&dst));
 444     json::Object(json).to_writer(&mut file)
 445 }