]> git.lizzy.rs Git - rust.git/blob - src/librustdoc/lib.rs
auto merge of #20980 : richo/rust/final-power, r=alexcrichton
[rust.git] / 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]
13 #![staged_api]
14 #![crate_type = "dylib"]
15 #![crate_type = "rlib"]
16 #![doc(html_logo_url = "http://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
17        html_favicon_url = "http://www.rust-lang.org/favicon.ico",
18        html_root_url = "http://doc.rust-lang.org/nightly/",
19        html_playground_url = "http://play.rust-lang.org/")]
20 #![feature(slicing_syntax)]
21 #![feature(box_syntax)]
22 #![allow(unknown_features)] #![feature(int_uint)]
23
24 extern crate arena;
25 extern crate getopts;
26 extern crate libc;
27 extern crate rustc;
28 extern crate rustc_trans;
29 extern crate rustc_driver;
30 extern crate rustc_resolve;
31 extern crate serialize;
32 extern crate syntax;
33 extern crate "test" as testing;
34 #[macro_use] extern crate log;
35
36 extern crate "serialize" as rustc_serialize; // used by deriving
37
38 use std::cell::RefCell;
39 use std::collections::HashMap;
40 use std::io::File;
41 use std::io;
42 use std::rc::Rc;
43 use externalfiles::ExternalHtml;
44 use serialize::Decodable;
45 use serialize::json::{self, Json};
46 use rustc::session::search_paths::SearchPaths;
47
48 // reexported from `clean` so it can be easily updated with the mod itself
49 pub use clean::SCHEMA_VERSION;
50
51 #[macro_use]
52 pub mod externalfiles;
53
54 pub mod clean;
55 pub mod core;
56 pub mod doctree;
57 pub mod fold;
58 pub mod html {
59     pub mod highlight;
60     pub mod escape;
61     pub mod item_type;
62     pub mod format;
63     pub mod layout;
64     pub mod markdown;
65     pub mod render;
66     pub mod toc;
67 }
68 pub mod markdown;
69 pub mod passes;
70 pub mod plugins;
71 pub mod stability_summary;
72 pub mod visit_ast;
73 pub mod test;
74 mod flock;
75
76 type Pass = (&'static str,                                      // name
77              fn(clean::Crate) -> plugins::PluginResult,         // fn
78              &'static str);                                     // description
79
80 static PASSES: &'static [Pass] = &[
81     ("strip-hidden", passes::strip_hidden,
82      "strips all doc(hidden) items from the output"),
83     ("unindent-comments", passes::unindent_comments,
84      "removes excess indentation on comments in order for markdown to like it"),
85     ("collapse-docs", passes::collapse_docs,
86      "concatenates all document attributes into one document attribute"),
87     ("strip-private", passes::strip_private,
88      "strips all private items from a crate which cannot be seen externally"),
89 ];
90
91 static DEFAULT_PASSES: &'static [&'static str] = &[
92     "strip-hidden",
93     "strip-private",
94     "collapse-docs",
95     "unindent-comments",
96 ];
97
98 thread_local!(pub static ANALYSISKEY: Rc<RefCell<Option<core::CrateAnalysis>>> = {
99     Rc::new(RefCell::new(None))
100 });
101
102 struct Output {
103     krate: clean::Crate,
104     json_plugins: Vec<plugins::PluginJson>,
105     passes: Vec<String>,
106 }
107
108 pub fn main() {
109     static STACK_SIZE: uint = 32000000; // 32MB
110     let res = std::thread::Builder::new().stack_size(STACK_SIZE).scoped(move || {
111         main_args(std::os::args().as_slice())
112     }).join();
113     std::os::set_exit_status(res.map_err(|_| ()).unwrap());
114 }
115
116 pub fn opts() -> Vec<getopts::OptGroup> {
117     use getopts::*;
118     vec!(
119         optflag("h", "help", "show this help message"),
120         optflag("V", "version", "print rustdoc's version"),
121         optflag("v", "verbose", "use verbose output"),
122         optopt("r", "input-format", "the input type of the specified file",
123                "[rust|json]"),
124         optopt("w", "output-format", "the output type to write",
125                "[html|json]"),
126         optopt("o", "output", "where to place the output", "PATH"),
127         optopt("", "crate-name", "specify the name of this crate", "NAME"),
128         optmulti("L", "library-path", "directory to add to crate search path",
129                  "DIR"),
130         optmulti("", "cfg", "pass a --cfg to rustc", ""),
131         optmulti("", "extern", "pass an --extern to rustc", "NAME=PATH"),
132         optmulti("", "plugin-path", "directory to load plugins from", "DIR"),
133         optmulti("", "passes", "space separated list of passes to also run, a \
134                                 value of `list` will print available passes",
135                  "PASSES"),
136         optmulti("", "plugins", "space separated list of plugins to also load",
137                  "PLUGINS"),
138         optflag("", "no-defaults", "don't run the default passes"),
139         optflag("", "test", "run code examples as tests"),
140         optmulti("", "test-args", "arguments to pass to the test runner",
141                  "ARGS"),
142         optopt("", "target", "target triple to document", "TRIPLE"),
143         optmulti("", "markdown-css", "CSS files to include via <link> in a rendered Markdown file",
144                  "FILES"),
145         optmulti("", "html-in-header",
146                  "files to include inline in the <head> section of a rendered Markdown file \
147                  or generated documentation",
148                  "FILES"),
149         optmulti("", "html-before-content",
150                  "files to include inline between <body> and the content of a rendered \
151                  Markdown file or generated documentation",
152                  "FILES"),
153         optmulti("", "html-after-content",
154                  "files to include inline between the content and </body> of a rendered \
155                  Markdown file or generated documentation",
156                  "FILES"),
157         optopt("", "markdown-playground-url",
158                "URL to send code snippets to", "URL"),
159         optflag("", "markdown-no-toc", "don't include table of contents")
160     )
161 }
162
163 pub fn usage(argv0: &str) {
164     println!("{}",
165              getopts::usage(format!("{} [options] <input>", argv0).as_slice(),
166                             opts().as_slice()));
167 }
168
169 pub fn main_args(args: &[String]) -> int {
170     let matches = match getopts::getopts(args.tail(), opts().as_slice()) {
171         Ok(m) => m,
172         Err(err) => {
173             println!("{}", err);
174             return 1;
175         }
176     };
177     if matches.opt_present("h") || matches.opt_present("help") {
178         usage(args[0].as_slice());
179         return 0;
180     } else if matches.opt_present("version") {
181         rustc_driver::version("rustdoc", &matches);
182         return 0;
183     }
184
185     if matches.opt_strs("passes") == ["list"] {
186         println!("Available passes for running rustdoc:");
187         for &(name, _, description) in PASSES.iter() {
188             println!("{:>20} - {}", name, description);
189         }
190         println!("{}", "\nDefault passes for rustdoc:"); // FIXME: #9970
191         for &name in DEFAULT_PASSES.iter() {
192             println!("{:>20}", name);
193         }
194         return 0;
195     }
196
197     if matches.free.len() == 0 {
198         println!("expected an input file to act on");
199         return 1;
200     } if matches.free.len() > 1 {
201         println!("only one input file may be specified");
202         return 1;
203     }
204     let input = matches.free[0].as_slice();
205
206     let mut libs = SearchPaths::new();
207     for s in matches.opt_strs("L").iter() {
208         libs.add_path(s.as_slice());
209     }
210     let externs = match parse_externs(&matches) {
211         Ok(ex) => ex,
212         Err(err) => {
213             println!("{}", err);
214             return 1;
215         }
216     };
217
218     let test_args = matches.opt_strs("test-args");
219     let test_args: Vec<String> = test_args.iter()
220                                           .flat_map(|s| s.as_slice().words())
221                                           .map(|s| s.to_string())
222                                           .collect();
223
224     let should_test = matches.opt_present("test");
225     let markdown_input = input.ends_with(".md") || input.ends_with(".markdown");
226
227     let output = matches.opt_str("o").map(|s| Path::new(s));
228     let cfgs = matches.opt_strs("cfg");
229
230     let external_html = match ExternalHtml::load(
231             matches.opt_strs("html-in-header").as_slice(),
232             matches.opt_strs("html-before-content").as_slice(),
233             matches.opt_strs("html-after-content").as_slice()) {
234         Some(eh) => eh,
235         None => return 3
236     };
237     let crate_name = matches.opt_str("crate-name");
238
239     match (should_test, markdown_input) {
240         (true, true) => {
241             return markdown::test(input, libs, externs, test_args)
242         }
243         (true, false) => {
244             return test::run(input, cfgs, libs, externs, test_args, crate_name)
245         }
246         (false, true) => return markdown::render(input, output.unwrap_or(Path::new("doc")),
247                                                  &matches, &external_html,
248                                                  !matches.opt_present("markdown-no-toc")),
249         (false, false) => {}
250     }
251
252     let out = match acquire_input(input, externs, &matches) {
253         Ok(out) => out,
254         Err(s) => {
255             println!("input error: {}", s);
256             return 1;
257         }
258     };
259     let Output { krate, json_plugins, passes, } = out;
260     info!("going to format");
261     match matches.opt_str("w").as_ref().map(|s| s.as_slice()) {
262         Some("html") | None => {
263             match html::render::run(krate, &external_html, output.unwrap_or(Path::new("doc")),
264                                     passes.into_iter().collect()) {
265                 Ok(()) => {}
266                 Err(e) => panic!("failed to generate documentation: {}", e),
267             }
268         }
269         Some("json") => {
270             match json_output(krate, json_plugins,
271                               output.unwrap_or(Path::new("doc.json"))) {
272                 Ok(()) => {}
273                 Err(e) => panic!("failed to write json: {}", e),
274             }
275         }
276         Some(s) => {
277             println!("unknown output format: {}", s);
278             return 1;
279         }
280     }
281
282     return 0;
283 }
284
285 /// Looks inside the command line arguments to extract the relevant input format
286 /// and files and then generates the necessary rustdoc output for formatting.
287 fn acquire_input(input: &str,
288                  externs: core::Externs,
289                  matches: &getopts::Matches) -> Result<Output, String> {
290     match matches.opt_str("r").as_ref().map(|s| s.as_slice()) {
291         Some("rust") => Ok(rust_input(input, externs, matches)),
292         Some("json") => json_input(input),
293         Some(s) => Err(format!("unknown input format: {}", s)),
294         None => {
295             if input.ends_with(".json") {
296                 json_input(input)
297             } else {
298                 Ok(rust_input(input, externs, matches))
299             }
300         }
301     }
302 }
303
304 /// Extracts `--extern CRATE=PATH` arguments from `matches` and
305 /// returns a `HashMap` mapping crate names to their paths or else an
306 /// error message.
307 fn parse_externs(matches: &getopts::Matches) -> Result<core::Externs, String> {
308     let mut externs = HashMap::new();
309     for arg in matches.opt_strs("extern").iter() {
310         let mut parts = arg.splitn(1, '=');
311         let name = match parts.next() {
312             Some(s) => s,
313             None => {
314                 return Err("--extern value must not be empty".to_string());
315             }
316         };
317         let location = match parts.next() {
318             Some(s) => s,
319             None => {
320                 return Err("--extern value must be of the format `foo=bar`".to_string());
321             }
322         };
323         let name = name.to_string();
324         let locs = externs.entry(name).get().unwrap_or_else(
325             |vacant_entry| vacant_entry.insert(Vec::with_capacity(1)));
326         locs.push(location.to_string());
327     }
328     Ok(externs)
329 }
330
331 /// Interprets the input file as a rust source file, passing it through the
332 /// compiler all the way through the analysis passes. The rustdoc output is then
333 /// generated from the cleaned AST of the crate.
334 ///
335 /// This form of input will run all of the plug/cleaning passes
336 fn rust_input(cratefile: &str, externs: core::Externs, matches: &getopts::Matches) -> Output {
337     let mut default_passes = !matches.opt_present("no-defaults");
338     let mut passes = matches.opt_strs("passes");
339     let mut plugins = matches.opt_strs("plugins");
340
341     // First, parse the crate and extract all relevant information.
342     let mut paths = SearchPaths::new();
343     for s in matches.opt_strs("L").iter() {
344         paths.add_path(s.as_slice());
345     }
346     let cfgs = matches.opt_strs("cfg");
347     let triple = matches.opt_str("target");
348
349     let cr = Path::new(cratefile);
350     info!("starting to run rustc");
351
352     let (mut krate, analysis) = std::thread::Thread::scoped(move |:| {
353         let cr = cr;
354         core::run_core(paths, cfgs, externs, &cr, triple)
355     }).join().map_err(|_| "rustc failed").unwrap();
356     info!("finished with rustc");
357     let mut analysis = Some(analysis);
358     ANALYSISKEY.with(|s| {
359         *s.borrow_mut() = analysis.take();
360     });
361
362     match matches.opt_str("crate-name") {
363         Some(name) => krate.name = name,
364         None => {}
365     }
366
367     // Process all of the crate attributes, extracting plugin metadata along
368     // with the passes which we are supposed to run.
369     match krate.module.as_ref().unwrap().doc_list() {
370         Some(nested) => {
371             for inner in nested.iter() {
372                 match *inner {
373                     clean::Word(ref x)
374                             if "no_default_passes" == *x => {
375                         default_passes = false;
376                     }
377                     clean::NameValue(ref x, ref value)
378                             if "passes" == *x => {
379                         for pass in value.words() {
380                             passes.push(pass.to_string());
381                         }
382                     }
383                     clean::NameValue(ref x, ref value)
384                             if "plugins" == *x => {
385                         for p in value.words() {
386                             plugins.push(p.to_string());
387                         }
388                     }
389                     _ => {}
390                 }
391             }
392         }
393         None => {}
394     }
395     if default_passes {
396         for name in DEFAULT_PASSES.iter().rev() {
397             passes.insert(0, name.to_string());
398         }
399     }
400
401     // Load all plugins/passes into a PluginManager
402     let path = matches.opt_str("plugin-path")
403                       .unwrap_or("/tmp/rustdoc/plugins".to_string());
404     let mut pm = plugins::PluginManager::new(Path::new(path));
405     for pass in passes.iter() {
406         let plugin = match PASSES.iter()
407                                  .position(|&(p, _, _)| {
408                                      p == *pass
409                                  }) {
410             Some(i) => PASSES[i].1,
411             None => {
412                 error!("unknown pass {}, skipping", *pass);
413                 continue
414             },
415         };
416         pm.add_plugin(plugin);
417     }
418     info!("loading plugins...");
419     for pname in plugins.into_iter() {
420         pm.load_plugin(pname);
421     }
422
423     // Run everything!
424     info!("Executing passes/plugins");
425     let (krate, json) = pm.run_plugins(krate);
426     return Output { krate: krate, json_plugins: json, passes: passes, };
427 }
428
429 /// This input format purely deserializes the json output file. No passes are
430 /// run over the deserialized output.
431 fn json_input(input: &str) -> Result<Output, String> {
432     let mut input = match File::open(&Path::new(input)) {
433         Ok(f) => f,
434         Err(e) => {
435             return Err(format!("couldn't open {}: {}", input, e))
436         }
437     };
438     match json::from_reader(&mut input) {
439         Err(s) => Err(format!("{:?}", s)),
440         Ok(Json::Object(obj)) => {
441             let mut obj = obj;
442             // Make sure the schema is what we expect
443             match obj.remove(&"schema".to_string()) {
444                 Some(Json::String(version)) => {
445                     if version != SCHEMA_VERSION {
446                         return Err(format!(
447                                 "sorry, but I only understand version {}",
448                                 SCHEMA_VERSION))
449                     }
450                 }
451                 Some(..) => return Err("malformed json".to_string()),
452                 None => return Err("expected a schema version".to_string()),
453             }
454             let krate = match obj.remove(&"crate".to_string()) {
455                 Some(json) => {
456                     let mut d = json::Decoder::new(json);
457                     Decodable::decode(&mut d).unwrap()
458                 }
459                 None => return Err("malformed json".to_string()),
460             };
461             // FIXME: this should read from the "plugins" field, but currently
462             //      Json doesn't implement decodable...
463             let plugin_output = Vec::new();
464             Ok(Output { krate: krate, json_plugins: plugin_output, passes: Vec::new(), })
465         }
466         Ok(..) => {
467             Err("malformed json input: expected an object at the \
468                  top".to_string())
469         }
470     }
471 }
472
473 /// Outputs the crate/plugin json as a giant json blob at the specified
474 /// destination.
475 fn json_output(krate: clean::Crate, res: Vec<plugins::PluginJson> ,
476                dst: Path) -> io::IoResult<()> {
477     // {
478     //   "schema": version,
479     //   "crate": { parsed crate ... },
480     //   "plugins": { output of plugins ... }
481     // }
482     let mut json = std::collections::BTreeMap::new();
483     json.insert("schema".to_string(), Json::String(SCHEMA_VERSION.to_string()));
484     let plugins_json = res.into_iter()
485                           .filter_map(|opt| {
486                               match opt {
487                                   None => None,
488                                   Some((string, json)) => {
489                                       Some((string.to_string(), json))
490                                   }
491                               }
492                           }).collect();
493
494     // FIXME #8335: yuck, Rust -> str -> JSON round trip! No way to .encode
495     // straight to the Rust JSON representation.
496     let crate_json_str = format!("{}", json::as_json(&krate));
497     let crate_json = match json::from_str(crate_json_str.as_slice()) {
498         Ok(j) => j,
499         Err(e) => panic!("Rust generated JSON is invalid: {:?}", e)
500     };
501
502     json.insert("crate".to_string(), crate_json);
503     json.insert("plugins".to_string(), Json::Object(plugins_json));
504
505     let mut file = try!(File::create(&dst));
506     write!(&mut file, "{}", Json::Object(json))
507 }