7828c3dd28
https://github.com/rust-lang/rfcs/pull/221 The current terminology of "task failure" often causes problems when writing or speaking about code. You often want to talk about the possibility of an operation that returns a Result "failing", but cannot because of the ambiguity with task failure. Instead, you have to speak of "the failing case" or "when the operation does not succeed" or other circumlocutions. Likewise, we use a "Failure" header in rustdoc to describe when operations may fail the task, but it would often be helpful to separate out a section describing the "Err-producing" case. We have been steadily moving away from task failure and toward Result as an error-handling mechanism, so we should optimize our terminology accordingly: Result-producing functions should be easy to describe. To update your code, rename any call to `fail!` to `panic!` instead. Assuming you have not created your own macro named `panic!`, this will work on UNIX based systems: grep -lZR 'fail!' . | xargs -0 -l sed -i -e 's/fail!/panic!/g' You can of course also do this by hand. [breaking-change]
491 lines
18 KiB
Rust
491 lines
18 KiB
Rust
// Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
|
|
// file at the top-level directory of this distribution and at
|
|
// http://rust-lang.org/COPYRIGHT.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
|
|
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
|
|
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
|
|
// option. This file may not be copied, modified, or distributed
|
|
// except according to those terms.
|
|
|
|
#![crate_name = "rustdoc"]
|
|
#![experimental]
|
|
#![desc = "rustdoc, the Rust documentation extractor"]
|
|
#![license = "MIT/ASL2"]
|
|
#![crate_type = "dylib"]
|
|
#![crate_type = "rlib"]
|
|
|
|
#![allow(unknown_features)]
|
|
#![feature(globs, struct_variant, macro_rules, phase, slicing_syntax)]
|
|
|
|
extern crate arena;
|
|
extern crate getopts;
|
|
extern crate libc;
|
|
extern crate rustc;
|
|
extern crate serialize;
|
|
extern crate syntax;
|
|
extern crate "test" as testing;
|
|
extern crate time;
|
|
#[phase(plugin, link)] extern crate log;
|
|
|
|
use std::io;
|
|
use std::io::{File, MemWriter};
|
|
use std::collections::HashMap;
|
|
use std::collections::hashmap::{Occupied, Vacant};
|
|
use serialize::{json, Decodable, Encodable};
|
|
use externalfiles::ExternalHtml;
|
|
|
|
// reexported from `clean` so it can be easily updated with the mod itself
|
|
pub use clean::SCHEMA_VERSION;
|
|
|
|
pub mod clean;
|
|
pub mod core;
|
|
pub mod doctree;
|
|
#[macro_escape]
|
|
pub mod externalfiles;
|
|
pub mod fold;
|
|
pub mod html {
|
|
pub mod highlight;
|
|
pub mod escape;
|
|
pub mod item_type;
|
|
pub mod format;
|
|
pub mod layout;
|
|
pub mod markdown;
|
|
pub mod render;
|
|
pub mod toc;
|
|
}
|
|
pub mod markdown;
|
|
pub mod passes;
|
|
pub mod plugins;
|
|
pub mod stability_summary;
|
|
pub mod visit_ast;
|
|
pub mod test;
|
|
mod flock;
|
|
|
|
type Pass = (&'static str, // name
|
|
fn(clean::Crate) -> plugins::PluginResult, // fn
|
|
&'static str); // description
|
|
|
|
static PASSES: &'static [Pass] = &[
|
|
("strip-hidden", passes::strip_hidden,
|
|
"strips all doc(hidden) items from the output"),
|
|
("unindent-comments", passes::unindent_comments,
|
|
"removes excess indentation on comments in order for markdown to like it"),
|
|
("collapse-docs", passes::collapse_docs,
|
|
"concatenates all document attributes into one document attribute"),
|
|
("strip-private", passes::strip_private,
|
|
"strips all private items from a crate which cannot be seen externally"),
|
|
];
|
|
|
|
static DEFAULT_PASSES: &'static [&'static str] = &[
|
|
"strip-hidden",
|
|
"strip-private",
|
|
"collapse-docs",
|
|
"unindent-comments",
|
|
];
|
|
|
|
local_data_key!(pub analysiskey: core::CrateAnalysis)
|
|
|
|
type Output = (clean::Crate, Vec<plugins::PluginJson> );
|
|
|
|
pub fn main() {
|
|
std::os::set_exit_status(main_args(std::os::args().as_slice()));
|
|
}
|
|
|
|
pub fn opts() -> Vec<getopts::OptGroup> {
|
|
use getopts::*;
|
|
vec!(
|
|
optflag("h", "help", "show this help message"),
|
|
optflagopt("", "version", "print rustdoc's version", "verbose"),
|
|
optopt("r", "input-format", "the input type of the specified file",
|
|
"[rust|json]"),
|
|
optopt("w", "output-format", "the output type to write",
|
|
"[html|json]"),
|
|
optopt("o", "output", "where to place the output", "PATH"),
|
|
optopt("", "crate-name", "specify the name of this crate", "NAME"),
|
|
optmulti("L", "library-path", "directory to add to crate search path",
|
|
"DIR"),
|
|
optmulti("", "cfg", "pass a --cfg to rustc", ""),
|
|
optmulti("", "extern", "pass an --extern to rustc", "NAME=PATH"),
|
|
optmulti("", "plugin-path", "directory to load plugins from", "DIR"),
|
|
optmulti("", "passes", "space separated list of passes to also run, a \
|
|
value of `list` will print available passes",
|
|
"PASSES"),
|
|
optmulti("", "plugins", "space separated list of plugins to also load",
|
|
"PLUGINS"),
|
|
optflag("", "no-defaults", "don't run the default passes"),
|
|
optflag("", "test", "run code examples as tests"),
|
|
optmulti("", "test-args", "arguments to pass to the test runner",
|
|
"ARGS"),
|
|
optopt("", "target", "target triple to document", "TRIPLE"),
|
|
optmulti("", "markdown-css", "CSS files to include via <link> in a rendered Markdown file",
|
|
"FILES"),
|
|
optmulti("", "html-in-header",
|
|
"files to include inline in the <head> section of a rendered Markdown file \
|
|
or generated documentation",
|
|
"FILES"),
|
|
optmulti("", "html-before-content",
|
|
"files to include inline between <body> and the content of a rendered \
|
|
Markdown file or generated documentation",
|
|
"FILES"),
|
|
optmulti("", "html-after-content",
|
|
"files to include inline between the content and </body> of a rendered \
|
|
Markdown file or generated documentation",
|
|
"FILES"),
|
|
optopt("", "markdown-playground-url",
|
|
"URL to send code snippets to", "URL"),
|
|
optflag("", "markdown-no-toc", "don't include table of contents")
|
|
)
|
|
}
|
|
|
|
pub fn usage(argv0: &str) {
|
|
println!("{}",
|
|
getopts::usage(format!("{} [options] <input>", argv0).as_slice(),
|
|
opts().as_slice()));
|
|
}
|
|
|
|
pub fn main_args(args: &[String]) -> int {
|
|
let matches = match getopts::getopts(args.tail(), opts().as_slice()) {
|
|
Ok(m) => m,
|
|
Err(err) => {
|
|
println!("{}", err);
|
|
return 1;
|
|
}
|
|
};
|
|
if matches.opt_present("h") || matches.opt_present("help") {
|
|
usage(args[0].as_slice());
|
|
return 0;
|
|
} else if matches.opt_present("version") {
|
|
match rustc::driver::version("rustdoc", &matches) {
|
|
Some(err) => {
|
|
println!("{}", err);
|
|
return 1
|
|
},
|
|
None => return 0
|
|
}
|
|
}
|
|
|
|
if matches.opt_strs("passes").as_slice() == &["list".to_string()] {
|
|
println!("Available passes for running rustdoc:");
|
|
for &(name, _, description) in PASSES.iter() {
|
|
println!("{:>20s} - {}", name, description);
|
|
}
|
|
println!("{}", "\nDefault passes for rustdoc:"); // FIXME: #9970
|
|
for &name in DEFAULT_PASSES.iter() {
|
|
println!("{:>20s}", name);
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
if matches.free.len() == 0 {
|
|
println!("expected an input file to act on");
|
|
return 1;
|
|
} if matches.free.len() > 1 {
|
|
println!("only one input file may be specified");
|
|
return 1;
|
|
}
|
|
let input = matches.free[0].as_slice();
|
|
|
|
let libs = matches.opt_strs("L").iter().map(|s| Path::new(s.as_slice())).collect();
|
|
let externs = match parse_externs(&matches) {
|
|
Ok(ex) => ex,
|
|
Err(err) => {
|
|
println!("{}", err);
|
|
return 1;
|
|
}
|
|
};
|
|
|
|
let test_args = matches.opt_strs("test-args");
|
|
let test_args: Vec<String> = test_args.iter()
|
|
.flat_map(|s| s.as_slice().words())
|
|
.map(|s| s.to_string())
|
|
.collect();
|
|
|
|
let should_test = matches.opt_present("test");
|
|
let markdown_input = input.ends_with(".md") || input.ends_with(".markdown");
|
|
|
|
let output = matches.opt_str("o").map(|s| Path::new(s));
|
|
let cfgs = matches.opt_strs("cfg");
|
|
|
|
let external_html = match ExternalHtml::load(
|
|
matches.opt_strs("html-in-header").as_slice(),
|
|
matches.opt_strs("html-before-content").as_slice(),
|
|
matches.opt_strs("html-after-content").as_slice()) {
|
|
Some(eh) => eh,
|
|
None => return 3
|
|
};
|
|
let crate_name = matches.opt_str("crate-name");
|
|
|
|
match (should_test, markdown_input) {
|
|
(true, true) => {
|
|
return markdown::test(input, libs, externs, test_args)
|
|
}
|
|
(true, false) => {
|
|
return test::run(input, cfgs, libs, externs, test_args, crate_name)
|
|
}
|
|
(false, true) => return markdown::render(input, output.unwrap_or(Path::new("doc")),
|
|
&matches, &external_html,
|
|
!matches.opt_present("markdown-no-toc")),
|
|
(false, false) => {}
|
|
}
|
|
|
|
let (krate, res) = match acquire_input(input, externs, &matches) {
|
|
Ok(pair) => pair,
|
|
Err(s) => {
|
|
println!("input error: {}", s);
|
|
return 1;
|
|
}
|
|
};
|
|
|
|
info!("going to format");
|
|
let started = time::precise_time_ns();
|
|
match matches.opt_str("w").as_ref().map(|s| s.as_slice()) {
|
|
Some("html") | None => {
|
|
match html::render::run(krate, &external_html, output.unwrap_or(Path::new("doc"))) {
|
|
Ok(()) => {}
|
|
Err(e) => panic!("failed to generate documentation: {}", e),
|
|
}
|
|
}
|
|
Some("json") => {
|
|
match json_output(krate, res, output.unwrap_or(Path::new("doc.json"))) {
|
|
Ok(()) => {}
|
|
Err(e) => panic!("failed to write json: {}", e),
|
|
}
|
|
}
|
|
Some(s) => {
|
|
println!("unknown output format: {}", s);
|
|
return 1;
|
|
}
|
|
}
|
|
let ended = time::precise_time_ns();
|
|
info!("Took {:.03f}s", (ended as f64 - started as f64) / 1e9f64);
|
|
|
|
return 0;
|
|
}
|
|
|
|
/// Looks inside the command line arguments to extract the relevant input format
|
|
/// and files and then generates the necessary rustdoc output for formatting.
|
|
fn acquire_input(input: &str,
|
|
externs: core::Externs,
|
|
matches: &getopts::Matches) -> Result<Output, String> {
|
|
match matches.opt_str("r").as_ref().map(|s| s.as_slice()) {
|
|
Some("rust") => Ok(rust_input(input, externs, matches)),
|
|
Some("json") => json_input(input),
|
|
Some(s) => Err(format!("unknown input format: {}", s)),
|
|
None => {
|
|
if input.ends_with(".json") {
|
|
json_input(input)
|
|
} else {
|
|
Ok(rust_input(input, externs, matches))
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Extracts `--extern CRATE=PATH` arguments from `matches` and
|
|
/// returns a `HashMap` mapping crate names to their paths or else an
|
|
/// error message.
|
|
fn parse_externs(matches: &getopts::Matches) -> Result<core::Externs, String> {
|
|
let mut externs = HashMap::new();
|
|
for arg in matches.opt_strs("extern").iter() {
|
|
let mut parts = arg.as_slice().splitn(1, '=');
|
|
let name = match parts.next() {
|
|
Some(s) => s,
|
|
None => {
|
|
return Err("--extern value must not be empty".to_string());
|
|
}
|
|
};
|
|
let location = match parts.next() {
|
|
Some(s) => s,
|
|
None => {
|
|
return Err("--extern value must be of the format `foo=bar`".to_string());
|
|
}
|
|
};
|
|
let locs = match externs.entry(name.to_string()) {
|
|
Vacant(entry) => entry.set(Vec::with_capacity(1)),
|
|
Occupied(entry) => entry.into_mut(),
|
|
};
|
|
locs.push(location.to_string());
|
|
}
|
|
Ok(externs)
|
|
}
|
|
|
|
/// Interprets the input file as a rust source file, passing it through the
|
|
/// compiler all the way through the analysis passes. The rustdoc output is then
|
|
/// generated from the cleaned AST of the crate.
|
|
///
|
|
/// This form of input will run all of the plug/cleaning passes
|
|
fn rust_input(cratefile: &str, externs: core::Externs, matches: &getopts::Matches) -> Output {
|
|
let mut default_passes = !matches.opt_present("no-defaults");
|
|
let mut passes = matches.opt_strs("passes");
|
|
let mut plugins = matches.opt_strs("plugins");
|
|
|
|
// First, parse the crate and extract all relevant information.
|
|
let libs: Vec<Path> = matches.opt_strs("L")
|
|
.iter()
|
|
.map(|s| Path::new(s.as_slice()))
|
|
.collect();
|
|
let cfgs = matches.opt_strs("cfg");
|
|
let triple = matches.opt_str("target");
|
|
|
|
let cr = Path::new(cratefile);
|
|
info!("starting to run rustc");
|
|
let (mut krate, analysis) = std::task::try(proc() {
|
|
let cr = cr;
|
|
core::run_core(libs, cfgs, externs, &cr, triple)
|
|
}).map_err(|_| "rustc failed").unwrap();
|
|
info!("finished with rustc");
|
|
analysiskey.replace(Some(analysis));
|
|
|
|
match matches.opt_str("crate-name") {
|
|
Some(name) => krate.name = name,
|
|
None => {}
|
|
}
|
|
|
|
// Process all of the crate attributes, extracting plugin metadata along
|
|
// with the passes which we are supposed to run.
|
|
match krate.module.as_ref().unwrap().doc_list() {
|
|
Some(nested) => {
|
|
for inner in nested.iter() {
|
|
match *inner {
|
|
clean::Word(ref x)
|
|
if "no_default_passes" == x.as_slice() => {
|
|
default_passes = false;
|
|
}
|
|
clean::NameValue(ref x, ref value)
|
|
if "passes" == x.as_slice() => {
|
|
for pass in value.as_slice().words() {
|
|
passes.push(pass.to_string());
|
|
}
|
|
}
|
|
clean::NameValue(ref x, ref value)
|
|
if "plugins" == x.as_slice() => {
|
|
for p in value.as_slice().words() {
|
|
plugins.push(p.to_string());
|
|
}
|
|
}
|
|
_ => {}
|
|
}
|
|
}
|
|
}
|
|
None => {}
|
|
}
|
|
if default_passes {
|
|
for name in DEFAULT_PASSES.iter().rev() {
|
|
passes.insert(0, name.to_string());
|
|
}
|
|
}
|
|
|
|
// Load all plugins/passes into a PluginManager
|
|
let path = matches.opt_str("plugin-path")
|
|
.unwrap_or("/tmp/rustdoc/plugins".to_string());
|
|
let mut pm = plugins::PluginManager::new(Path::new(path));
|
|
for pass in passes.iter() {
|
|
let plugin = match PASSES.iter()
|
|
.position(|&(p, _, _)| {
|
|
p == pass.as_slice()
|
|
}) {
|
|
Some(i) => PASSES[i].val1(),
|
|
None => {
|
|
error!("unknown pass {}, skipping", *pass);
|
|
continue
|
|
},
|
|
};
|
|
pm.add_plugin(plugin);
|
|
}
|
|
info!("loading plugins...");
|
|
for pname in plugins.into_iter() {
|
|
pm.load_plugin(pname);
|
|
}
|
|
|
|
// Run everything!
|
|
info!("Executing passes/plugins");
|
|
return pm.run_plugins(krate);
|
|
}
|
|
|
|
/// This input format purely deserializes the json output file. No passes are
|
|
/// run over the deserialized output.
|
|
fn json_input(input: &str) -> Result<Output, String> {
|
|
let mut input = match File::open(&Path::new(input)) {
|
|
Ok(f) => f,
|
|
Err(e) => {
|
|
return Err(format!("couldn't open {}: {}", input, e))
|
|
}
|
|
};
|
|
match json::from_reader(&mut input) {
|
|
Err(s) => Err(s.to_string()),
|
|
Ok(json::Object(obj)) => {
|
|
let mut obj = obj;
|
|
// Make sure the schema is what we expect
|
|
match obj.pop(&"schema".to_string()) {
|
|
Some(json::String(version)) => {
|
|
if version.as_slice() != SCHEMA_VERSION {
|
|
return Err(format!(
|
|
"sorry, but I only understand version {}",
|
|
SCHEMA_VERSION))
|
|
}
|
|
}
|
|
Some(..) => return Err("malformed json".to_string()),
|
|
None => return Err("expected a schema version".to_string()),
|
|
}
|
|
let krate = match obj.pop(&"crate".to_string()) {
|
|
Some(json) => {
|
|
let mut d = json::Decoder::new(json);
|
|
Decodable::decode(&mut d).unwrap()
|
|
}
|
|
None => return Err("malformed json".to_string()),
|
|
};
|
|
// FIXME: this should read from the "plugins" field, but currently
|
|
// Json doesn't implement decodable...
|
|
let plugin_output = Vec::new();
|
|
Ok((krate, plugin_output))
|
|
}
|
|
Ok(..) => {
|
|
Err("malformed json input: expected an object at the \
|
|
top".to_string())
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Outputs the crate/plugin json as a giant json blob at the specified
|
|
/// destination.
|
|
fn json_output(krate: clean::Crate, res: Vec<plugins::PluginJson> ,
|
|
dst: Path) -> io::IoResult<()> {
|
|
// {
|
|
// "schema": version,
|
|
// "crate": { parsed crate ... },
|
|
// "plugins": { output of plugins ... }
|
|
// }
|
|
let mut json = std::collections::TreeMap::new();
|
|
json.insert("schema".to_string(), json::String(SCHEMA_VERSION.to_string()));
|
|
let plugins_json = res.into_iter()
|
|
.filter_map(|opt| {
|
|
match opt {
|
|
None => None,
|
|
Some((string, json)) => {
|
|
Some((string.to_string(), json))
|
|
}
|
|
}
|
|
}).collect();
|
|
|
|
// FIXME #8335: yuck, Rust -> str -> JSON round trip! No way to .encode
|
|
// straight to the Rust JSON representation.
|
|
let crate_json_str = {
|
|
let mut w = MemWriter::new();
|
|
{
|
|
let mut encoder = json::Encoder::new(&mut w as &mut io::Writer);
|
|
krate.encode(&mut encoder).unwrap();
|
|
}
|
|
String::from_utf8(w.unwrap()).unwrap()
|
|
};
|
|
let crate_json = match json::from_str(crate_json_str.as_slice()) {
|
|
Ok(j) => j,
|
|
Err(e) => panic!("Rust generated JSON is invalid: {}", e)
|
|
};
|
|
|
|
json.insert("crate".to_string(), crate_json);
|
|
json.insert("plugins".to_string(), json::Object(plugins_json));
|
|
|
|
let mut file = try!(File::create(&dst));
|
|
json::Object(json).to_writer(&mut file)
|
|
}
|