2014-01-10 15:05:54 +01:00
|
|
|
// Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
|
2012-12-04 01:48:01 +01:00
|
|
|
// 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.
|
|
|
|
|
|
2014-04-04 01:28:46 +02:00
|
|
|
#![crate_id = "rustdoc#0.11-pre"]
|
2014-03-22 02:05:05 +01:00
|
|
|
#![desc = "rustdoc, the Rust documentation extractor"]
|
|
|
|
|
#![license = "MIT/ASL2"]
|
|
|
|
|
#![crate_type = "dylib"]
|
|
|
|
|
#![crate_type = "rlib"]
|
2012-01-15 23:56:58 +01:00
|
|
|
|
2014-03-22 02:05:05 +01:00
|
|
|
#![feature(globs, struct_variant, managed_boxes, macro_rules, phase)]
|
2013-10-03 03:10:16 +02:00
|
|
|
|
2014-02-14 19:10:06 +01:00
|
|
|
extern crate syntax;
|
|
|
|
|
extern crate rustc;
|
|
|
|
|
extern crate serialize;
|
|
|
|
|
extern crate sync;
|
|
|
|
|
extern crate getopts;
|
|
|
|
|
extern crate collections;
|
2014-02-14 02:49:11 +01:00
|
|
|
extern crate testing = "test";
|
2014-02-20 04:08:12 +01:00
|
|
|
extern crate time;
|
log: Introduce liblog, the old std::logging
This commit moves all logging out of the standard library into an external
crate. This crate is the new crate which is responsible for all logging macros
and logging implementation. A few reasons for this change are:
* The crate map has always been a bit of a code smell among rust programs. It
has difficulty being loaded on almost all platforms, and it's used almost
exclusively for logging and only logging. Removing the crate map is one of the
end goals of this movement.
* The compiler has a fair bit of special support for logging. It has the
__log_level() expression as well as generating a global word per module
specifying the log level. This is unfairly favoring the built-in logging
system, and is much better done purely in libraries instead of the compiler
itself.
* Initialization of logging is much easier to do if there is no reliance on a
magical crate map being available to set module log levels.
* If the logging library can be written outside of the standard library, there's
no reason that it shouldn't be. It's likely that we're not going to build the
highest quality logging library of all time, so third-party libraries should
be able to provide just as high-quality logging systems as the default one
provided in the rust distribution.
With a migration such as this, the change does not come for free. There are some
subtle changes in the behavior of liblog vs the previous logging macros:
* The core change of this migration is that there is no longer a physical
log-level per module. This concept is still emulated (it is quite useful), but
there is now only a global log level, not a local one. This global log level
is a reflection of the maximum of all log levels specified. The previously
generated logging code looked like:
if specified_level <= __module_log_level() {
println!(...)
}
The newly generated code looks like:
if specified_level <= ::log::LOG_LEVEL {
if ::log::module_enabled(module_path!()) {
println!(...)
}
}
Notably, the first layer of checking is still intended to be "super fast" in
that it's just a load of a global word and a compare. The second layer of
checking is executed to determine if the current module does indeed have
logging turned on.
This means that if any module has a debug log level turned on, all modules
with debug log levels get a little bit slower (they all do more expensive
dynamic checks to determine if they're turned on or not).
Semantically, this migration brings no change in this respect, but
runtime-wise, this will have a perf impact on some code.
* A `RUST_LOG=::help` directive will no longer print out a list of all modules
that can be logged. This is because the crate map will no longer specify the
log levels of all modules, so the list of modules is not known. Additionally,
warnings can no longer be provided if a malformed logging directive was
supplied.
The new "hello world" for logging looks like:
#[phase(syntax, link)]
extern crate log;
fn main() {
debug!("Hello, world!");
}
2014-03-09 07:11:44 +01:00
|
|
|
#[phase(syntax, link)]
|
|
|
|
|
extern crate log;
|
2014-02-26 18:58:41 +01:00
|
|
|
extern crate libc;
|
2012-04-06 02:30:26 +02:00
|
|
|
|
2013-10-12 23:40:41 +02:00
|
|
|
use std::local_data;
|
2013-11-11 07:46:32 +01:00
|
|
|
use std::io;
|
2014-01-15 22:25:09 +01:00
|
|
|
use std::io::{File, MemWriter};
|
2013-10-14 03:48:47 +02:00
|
|
|
use std::str;
|
2014-02-21 23:18:39 +01:00
|
|
|
use serialize::{json, Decodable, Encodable};
|
2013-09-22 08:25:48 +02:00
|
|
|
|
|
|
|
|
pub mod clean;
|
|
|
|
|
pub mod core;
|
|
|
|
|
pub mod doctree;
|
2013-03-01 19:44:43 +01:00
|
|
|
pub mod fold;
|
2013-09-22 08:25:48 +02:00
|
|
|
pub mod html {
|
2014-02-20 10:14:51 +01:00
|
|
|
pub mod highlight;
|
2013-09-28 00:12:23 +02:00
|
|
|
pub mod escape;
|
|
|
|
|
pub mod format;
|
2013-09-22 08:25:48 +02:00
|
|
|
pub mod layout;
|
|
|
|
|
pub mod markdown;
|
2013-09-28 00:12:23 +02:00
|
|
|
pub mod render;
|
2014-03-07 15:13:17 +01:00
|
|
|
pub mod toc;
|
2013-09-22 08:25:48 +02:00
|
|
|
}
|
2014-03-07 04:31:41 +01:00
|
|
|
pub mod markdown;
|
2013-09-22 08:25:48 +02:00
|
|
|
pub mod passes;
|
|
|
|
|
pub mod plugins;
|
|
|
|
|
pub mod visit_ast;
|
2013-12-22 20:23:04 +01:00
|
|
|
pub mod test;
|
2014-03-16 09:08:56 +01:00
|
|
|
mod flock;
|
2013-09-22 08:25:48 +02:00
|
|
|
|
2013-10-14 05:37:43 +02:00
|
|
|
pub static SCHEMA_VERSION: &'static str = "0.8.1";
|
2013-09-22 08:25:48 +02:00
|
|
|
|
2013-09-24 01:25:58 +02:00
|
|
|
type Pass = (&'static str, // name
|
2014-02-14 05:23:01 +01:00
|
|
|
fn(clean::Crate) -> plugins::PluginResult, // fn
|
2013-09-24 01:25:58 +02:00
|
|
|
&'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"),
|
2013-09-24 22:55:22 +02:00
|
|
|
("strip-private", passes::strip_private,
|
|
|
|
|
"strips all private items from a crate which cannot be seen externally"),
|
2013-09-24 01:25:58 +02:00
|
|
|
];
|
|
|
|
|
|
|
|
|
|
static DEFAULT_PASSES: &'static [&'static str] = &[
|
2013-09-24 23:09:11 +02:00
|
|
|
"strip-hidden",
|
2013-09-24 22:55:22 +02:00
|
|
|
"strip-private",
|
2013-09-25 01:08:07 +02:00
|
|
|
"collapse-docs",
|
|
|
|
|
"unindent-comments",
|
2013-09-24 01:25:58 +02:00
|
|
|
];
|
|
|
|
|
|
2013-09-22 08:25:48 +02:00
|
|
|
local_data_key!(pub ctxtkey: @core::DocContext)
|
2013-10-12 23:40:41 +02:00
|
|
|
local_data_key!(pub analysiskey: core::CrateAnalysis)
|
2013-09-22 08:25:48 +02:00
|
|
|
|
2014-03-06 00:28:08 +01:00
|
|
|
type Output = (clean::Crate, Vec<plugins::PluginJson> );
|
2012-11-19 02:56:50 +01:00
|
|
|
|
2013-03-01 19:44:43 +01:00
|
|
|
pub fn main() {
|
2013-09-25 01:34:23 +02:00
|
|
|
std::os::set_exit_status(main_args(std::os::args()));
|
2013-09-22 08:25:48 +02:00
|
|
|
}
|
|
|
|
|
|
2014-03-06 00:28:08 +01:00
|
|
|
pub fn opts() -> Vec<getopts::OptGroup> {
|
2014-02-04 04:14:40 +01:00
|
|
|
use getopts::*;
|
2014-03-06 00:28:08 +01:00
|
|
|
vec!(
|
2013-09-30 21:58:18 +02:00
|
|
|
optflag("h", "help", "show this help message"),
|
2014-01-10 19:05:26 +01:00
|
|
|
optflag("", "version", "print rustdoc's version"),
|
2013-09-30 21:58:18 +02:00
|
|
|
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"),
|
2013-09-22 08:25:48 +02:00
|
|
|
optmulti("L", "library-path", "directory to add to crate search path",
|
|
|
|
|
"DIR"),
|
2013-11-25 05:31:21 +01:00
|
|
|
optmulti("", "cfg", "pass a --cfg to rustc", ""),
|
2013-09-22 08:25:48 +02:00
|
|
|
optmulti("", "plugin-path", "directory to load plugins from", "DIR"),
|
2013-09-24 01:25:58 +02:00
|
|
|
optmulti("", "passes", "space separated list of passes to also run, a \
|
|
|
|
|
value of `list` will print available passes",
|
2013-09-22 08:25:48 +02:00
|
|
|
"PASSES"),
|
|
|
|
|
optmulti("", "plugins", "space separated list of plugins to also load",
|
|
|
|
|
"PLUGINS"),
|
2013-09-30 22:28:30 +02:00
|
|
|
optflag("", "no-defaults", "don't run the default passes"),
|
2013-12-22 20:23:04 +01:00
|
|
|
optflag("", "test", "run code examples as tests"),
|
|
|
|
|
optmulti("", "test-args", "arguments to pass to the test runner",
|
|
|
|
|
"ARGS"),
|
2014-03-07 04:31:41 +01:00
|
|
|
optmulti("", "markdown-css", "CSS files to include via <link> in a rendered Markdown file",
|
|
|
|
|
"FILES"),
|
|
|
|
|
optmulti("", "markdown-in-header",
|
|
|
|
|
"files to include inline in the <head> section of a rendered Markdown file",
|
|
|
|
|
"FILES"),
|
|
|
|
|
optmulti("", "markdown-before-content",
|
|
|
|
|
"files to include inline between <body> and the content of a rendered \
|
|
|
|
|
Markdown file",
|
|
|
|
|
"FILES"),
|
|
|
|
|
optmulti("", "markdown-after-content",
|
|
|
|
|
"files to include inline between the content and </body> of a rendered \
|
|
|
|
|
Markdown file",
|
2014-03-06 00:28:08 +01:00
|
|
|
"FILES")
|
|
|
|
|
)
|
2013-09-22 08:25:48 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
pub fn usage(argv0: &str) {
|
2014-03-06 00:28:08 +01:00
|
|
|
println!("{}",
|
|
|
|
|
getopts::usage(format!("{} [options] <input>", argv0),
|
|
|
|
|
opts().as_slice()));
|
2013-08-22 11:41:33 +02:00
|
|
|
}
|
2012-11-19 02:56:50 +01:00
|
|
|
|
2013-09-25 01:34:23 +02:00
|
|
|
pub fn main_args(args: &[~str]) -> int {
|
2014-03-06 00:28:08 +01:00
|
|
|
let matches = match getopts::getopts(args.tail(), opts().as_slice()) {
|
2014-01-10 15:05:54 +01:00
|
|
|
Ok(m) => m,
|
|
|
|
|
Err(err) => {
|
2014-01-09 11:06:55 +01:00
|
|
|
println!("{}", err.to_err_msg());
|
2014-01-10 15:05:54 +01:00
|
|
|
return 1;
|
|
|
|
|
}
|
|
|
|
|
};
|
2013-09-22 08:25:48 +02:00
|
|
|
if matches.opt_present("h") || matches.opt_present("help") {
|
|
|
|
|
usage(args[0]);
|
2013-09-25 01:34:23 +02:00
|
|
|
return 0;
|
2014-01-10 19:05:26 +01:00
|
|
|
} else if matches.opt_present("version") {
|
|
|
|
|
rustc::version(args[0]);
|
|
|
|
|
return 0;
|
2012-11-19 02:56:50 +01:00
|
|
|
}
|
|
|
|
|
|
2013-12-22 20:23:04 +01:00
|
|
|
if matches.free.len() == 0 {
|
2014-01-09 11:06:55 +01:00
|
|
|
println!("expected an input file to act on");
|
2013-12-22 20:23:04 +01:00
|
|
|
return 1;
|
|
|
|
|
} if matches.free.len() > 1 {
|
2014-01-09 11:06:55 +01:00
|
|
|
println!("only one input file may be specified");
|
2013-12-22 20:23:04 +01:00
|
|
|
return 1;
|
|
|
|
|
}
|
2014-03-06 00:28:08 +01:00
|
|
|
let input = matches.free.get(0).as_slice();
|
2013-12-22 20:23:04 +01:00
|
|
|
|
2014-03-06 00:28:08 +01:00
|
|
|
let libs = matches.opt_strs("L").iter().map(|s| Path::new(s.as_slice())).collect();
|
2014-03-07 04:31:41 +01:00
|
|
|
|
|
|
|
|
let test_args = matches.opt_strs("test-args");
|
2014-03-06 00:28:08 +01:00
|
|
|
let test_args: Vec<~str> = test_args.iter()
|
|
|
|
|
.flat_map(|s| s.words())
|
|
|
|
|
.map(|s| s.to_owned())
|
|
|
|
|
.collect();
|
2014-03-07 04:31:41 +01:00
|
|
|
|
|
|
|
|
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));
|
2014-04-02 00:04:42 +02:00
|
|
|
let cfgs = matches.opt_strs("cfg");
|
2014-03-07 04:31:41 +01:00
|
|
|
|
|
|
|
|
match (should_test, markdown_input) {
|
2014-03-06 00:28:08 +01:00
|
|
|
(true, true) => {
|
|
|
|
|
return markdown::test(input,
|
|
|
|
|
libs,
|
|
|
|
|
test_args.move_iter().collect())
|
|
|
|
|
}
|
2014-04-02 00:04:42 +02:00
|
|
|
(true, false) => return test::run(input, cfgs.move_iter().collect(),
|
|
|
|
|
libs, test_args),
|
2014-03-07 04:31:41 +01:00
|
|
|
|
|
|
|
|
(false, true) => return markdown::render(input, output.unwrap_or(Path::new("doc")),
|
|
|
|
|
&matches),
|
|
|
|
|
(false, false) => {}
|
2013-12-22 20:23:04 +01:00
|
|
|
}
|
|
|
|
|
|
2014-03-06 00:28:08 +01:00
|
|
|
if matches.opt_strs("passes").as_slice() == &[~"list"] {
|
2014-01-09 11:06:55 +01:00
|
|
|
println!("Available passes for running rustdoc:");
|
2013-09-24 01:25:58 +02:00
|
|
|
for &(name, _, description) in PASSES.iter() {
|
|
|
|
|
println!("{:>20s} - {}", name, description);
|
|
|
|
|
}
|
2014-01-09 11:06:55 +01:00
|
|
|
println!("{}", "\nDefault passes for rustdoc:"); // FIXME: #9970
|
2013-09-24 01:25:58 +02:00
|
|
|
for &name in DEFAULT_PASSES.iter() {
|
|
|
|
|
println!("{:>20s}", name);
|
|
|
|
|
}
|
2013-09-25 23:28:20 +02:00
|
|
|
return 0;
|
2013-09-24 01:25:58 +02:00
|
|
|
}
|
|
|
|
|
|
2014-02-05 22:15:24 +01:00
|
|
|
let (krate, res) = match acquire_input(input, &matches) {
|
2013-09-30 21:58:18 +02:00
|
|
|
Ok(pair) => pair,
|
|
|
|
|
Err(s) => {
|
|
|
|
|
println!("input error: {}", s);
|
2013-09-25 01:34:23 +02:00
|
|
|
return 1;
|
2013-09-22 08:25:48 +02:00
|
|
|
}
|
2013-09-30 21:58:18 +02:00
|
|
|
};
|
|
|
|
|
|
2013-10-21 22:08:31 +02:00
|
|
|
info!("going to format");
|
2013-09-30 21:58:18 +02:00
|
|
|
let started = time::precise_time_ns();
|
2014-03-07 22:15:50 +01:00
|
|
|
match matches.opt_str("w").as_ref().map(|s| s.as_slice()) {
|
|
|
|
|
Some("html") | None => {
|
2014-02-05 22:15:24 +01:00
|
|
|
match html::render::run(krate, output.unwrap_or(Path::new("doc"))) {
|
2014-01-30 20:30:21 +01:00
|
|
|
Ok(()) => {}
|
|
|
|
|
Err(e) => fail!("failed to generate documentation: {}", e),
|
|
|
|
|
}
|
2013-09-22 08:25:48 +02:00
|
|
|
}
|
2014-03-07 22:15:50 +01:00
|
|
|
Some("json") => {
|
2014-02-05 22:15:24 +01:00
|
|
|
match json_output(krate, res, output.unwrap_or(Path::new("doc.json"))) {
|
2014-01-30 20:30:21 +01:00
|
|
|
Ok(()) => {}
|
|
|
|
|
Err(e) => fail!("failed to write json: {}", e),
|
|
|
|
|
}
|
2013-09-22 08:25:48 +02:00
|
|
|
}
|
2013-09-30 21:58:18 +02:00
|
|
|
Some(s) => {
|
|
|
|
|
println!("unknown output format: {}", s);
|
2013-09-25 01:34:23 +02:00
|
|
|
return 1;
|
2013-09-22 08:25:48 +02:00
|
|
|
}
|
2013-09-30 21:58:18 +02:00
|
|
|
}
|
|
|
|
|
let ended = time::precise_time_ns();
|
2013-10-21 22:08:31 +02:00
|
|
|
info!("Took {:.03f}s", (ended as f64 - started as f64) / 1e9f64);
|
2013-09-30 21:58:18 +02:00
|
|
|
|
|
|
|
|
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.
|
2013-12-22 20:23:04 +01:00
|
|
|
fn acquire_input(input: &str,
|
|
|
|
|
matches: &getopts::Matches) -> Result<Output, ~str> {
|
2014-03-07 22:15:50 +01:00
|
|
|
match matches.opt_str("r").as_ref().map(|s| s.as_slice()) {
|
|
|
|
|
Some("rust") => Ok(rust_input(input, matches)),
|
|
|
|
|
Some("json") => json_input(input),
|
2013-09-30 21:58:18 +02:00
|
|
|
Some(s) => Err("unknown input format: " + s),
|
|
|
|
|
None => {
|
|
|
|
|
if input.ends_with(".json") {
|
|
|
|
|
json_input(input)
|
|
|
|
|
} else {
|
|
|
|
|
Ok(rust_input(input, matches))
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// 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, matches: &getopts::Matches) -> Output {
|
2013-09-30 22:28:30 +02:00
|
|
|
let mut default_passes = !matches.opt_present("no-defaults");
|
2013-09-30 21:58:18 +02:00
|
|
|
let mut passes = matches.opt_strs("passes");
|
|
|
|
|
let mut plugins = matches.opt_strs("plugins");
|
2012-11-19 02:56:50 +01:00
|
|
|
|
2013-09-22 08:25:48 +02:00
|
|
|
// First, parse the crate and extract all relevant information.
|
2014-03-06 00:28:08 +01:00
|
|
|
let libs: Vec<Path> = matches.opt_strs("L")
|
|
|
|
|
.iter()
|
|
|
|
|
.map(|s| Path::new(s.as_slice()))
|
|
|
|
|
.collect();
|
2013-12-04 01:44:16 +01:00
|
|
|
let cfgs = matches.opt_strs("cfg");
|
|
|
|
|
let cr = Path::new(cratefile);
|
2013-10-21 22:08:31 +02:00
|
|
|
info!("starting to run rustc");
|
2014-02-05 22:15:24 +01:00
|
|
|
let (krate, analysis) = std::task::try(proc() {
|
2013-12-04 01:44:16 +01:00
|
|
|
let cr = cr;
|
2014-03-06 00:28:08 +01:00
|
|
|
core::run_core(libs.move_iter().collect(),
|
|
|
|
|
cfgs.move_iter().collect(),
|
|
|
|
|
&cr)
|
2014-01-27 04:13:29 +01:00
|
|
|
}).unwrap();
|
2013-10-21 22:08:31 +02:00
|
|
|
info!("finished with rustc");
|
2013-10-12 23:40:41 +02:00
|
|
|
local_data::set(analysiskey, analysis);
|
2013-09-22 08:25:48 +02:00
|
|
|
|
|
|
|
|
// Process all of the crate attributes, extracting plugin metadata along
|
|
|
|
|
// with the passes which we are supposed to run.
|
2014-02-05 22:15:24 +01:00
|
|
|
match krate.module.get_ref().doc_list() {
|
2013-09-22 08:25:48 +02:00
|
|
|
Some(nested) => {
|
|
|
|
|
for inner in nested.iter() {
|
|
|
|
|
match *inner {
|
2014-03-07 22:15:50 +01:00
|
|
|
clean::Word(ref x) if "no_default_passes" == *x => {
|
2013-09-22 08:25:48 +02:00
|
|
|
default_passes = false;
|
|
|
|
|
}
|
2014-03-07 22:15:50 +01:00
|
|
|
clean::NameValue(ref x, ref value) if "passes" == *x => {
|
2013-11-23 11:18:51 +01:00
|
|
|
for pass in value.words() {
|
2013-09-22 08:25:48 +02:00
|
|
|
passes.push(pass.to_owned());
|
|
|
|
|
}
|
|
|
|
|
}
|
2014-03-07 22:15:50 +01:00
|
|
|
clean::NameValue(ref x, ref value) if "plugins" == *x => {
|
2013-11-23 11:18:51 +01:00
|
|
|
for p in value.words() {
|
2013-09-22 08:25:48 +02:00
|
|
|
plugins.push(p.to_owned());
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
_ => {}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
None => {}
|
|
|
|
|
}
|
|
|
|
|
if default_passes {
|
2013-09-24 01:25:58 +02:00
|
|
|
for name in DEFAULT_PASSES.rev_iter() {
|
|
|
|
|
passes.unshift(name.to_owned());
|
|
|
|
|
}
|
2013-09-22 08:25:48 +02:00
|
|
|
}
|
2012-11-19 02:56:50 +01:00
|
|
|
|
2013-09-22 08:25:48 +02:00
|
|
|
// Load all plugins/passes into a PluginManager
|
2013-12-31 23:50:38 +01:00
|
|
|
let path = matches.opt_str("plugin-path").unwrap_or(~"/tmp/rustdoc/plugins");
|
2013-12-04 04:15:12 +01:00
|
|
|
let mut pm = plugins::PluginManager::new(Path::new(path));
|
2013-09-22 08:25:48 +02:00
|
|
|
for pass in passes.iter() {
|
2013-09-24 01:25:58 +02:00
|
|
|
let plugin = match PASSES.iter().position(|&(p, _, _)| p == *pass) {
|
2014-02-16 12:19:41 +01:00
|
|
|
Some(i) => PASSES[i].val1(),
|
2013-09-24 01:25:58 +02:00
|
|
|
None => {
|
2013-10-21 22:08:31 +02:00
|
|
|
error!("unknown pass {}, skipping", *pass);
|
2013-10-01 23:31:03 +02:00
|
|
|
continue
|
2013-09-24 01:25:58 +02:00
|
|
|
},
|
2013-09-22 08:25:48 +02:00
|
|
|
};
|
|
|
|
|
pm.add_plugin(plugin);
|
|
|
|
|
}
|
2013-10-21 22:08:31 +02:00
|
|
|
info!("loading plugins...");
|
2013-09-22 08:25:48 +02:00
|
|
|
for pname in plugins.move_iter() {
|
|
|
|
|
pm.load_plugin(pname);
|
|
|
|
|
}
|
2012-11-19 02:56:50 +01:00
|
|
|
|
2013-09-22 08:25:48 +02:00
|
|
|
// Run everything!
|
2013-10-21 22:08:31 +02:00
|
|
|
info!("Executing passes/plugins");
|
2014-02-05 22:15:24 +01:00
|
|
|
return pm.run_plugins(krate);
|
2013-09-30 21:58:18 +02:00
|
|
|
}
|
2012-11-19 02:56:50 +01:00
|
|
|
|
2013-09-30 21:58:18 +02:00
|
|
|
/// This input format purely deserializes the json output file. No passes are
|
|
|
|
|
/// run over the deserialized output.
|
|
|
|
|
fn json_input(input: &str) -> Result<Output, ~str> {
|
2013-12-31 02:17:45 +01:00
|
|
|
let mut input = match File::open(&Path::new(input)) {
|
2014-01-30 20:30:21 +01:00
|
|
|
Ok(f) => f,
|
|
|
|
|
Err(e) => return Err(format!("couldn't open {}: {}", input, e)),
|
2013-09-30 21:58:18 +02:00
|
|
|
};
|
2013-12-31 02:17:45 +01:00
|
|
|
match json::from_reader(&mut input) {
|
2013-09-30 21:58:18 +02:00
|
|
|
Err(s) => Err(s.to_str()),
|
|
|
|
|
Ok(json::Object(obj)) => {
|
|
|
|
|
let mut obj = obj;
|
|
|
|
|
// Make sure the schema is what we expect
|
|
|
|
|
match obj.pop(&~"schema") {
|
|
|
|
|
Some(json::String(version)) => {
|
|
|
|
|
if version.as_slice() != SCHEMA_VERSION {
|
|
|
|
|
return Err(format!("sorry, but I only understand \
|
|
|
|
|
version {}", SCHEMA_VERSION))
|
|
|
|
|
}
|
|
|
|
|
}
|
2013-11-28 21:22:53 +01:00
|
|
|
Some(..) => return Err(~"malformed json"),
|
2013-09-30 21:58:18 +02:00
|
|
|
None => return Err(~"expected a schema version"),
|
|
|
|
|
}
|
2014-02-05 22:15:24 +01:00
|
|
|
let krate = match obj.pop(&~"crate") {
|
2013-09-30 21:58:18 +02:00
|
|
|
Some(json) => {
|
2013-12-04 04:18:35 +01:00
|
|
|
let mut d = json::Decoder::new(json);
|
2014-03-29 01:05:46 +01:00
|
|
|
Decodable::decode(&mut d).unwrap()
|
2013-09-30 21:58:18 +02:00
|
|
|
}
|
|
|
|
|
None => return Err(~"malformed json"),
|
|
|
|
|
};
|
2014-01-26 09:43:42 +01:00
|
|
|
// FIXME: this should read from the "plugins" field, but currently
|
2013-09-30 21:58:18 +02:00
|
|
|
// Json doesn't implement decodable...
|
2014-03-06 00:28:08 +01:00
|
|
|
let plugin_output = Vec::new();
|
2014-02-05 22:15:24 +01:00
|
|
|
Ok((krate, plugin_output))
|
2013-09-30 21:58:18 +02:00
|
|
|
}
|
2013-11-28 21:22:53 +01:00
|
|
|
Ok(..) => Err(~"malformed json input: expected an object at the top"),
|
2013-09-22 08:25:48 +02:00
|
|
|
}
|
|
|
|
|
}
|
2012-11-19 02:56:50 +01:00
|
|
|
|
2013-09-30 21:58:18 +02:00
|
|
|
/// Outputs the crate/plugin json as a giant json blob at the specified
|
|
|
|
|
/// destination.
|
2014-03-06 00:28:08 +01:00
|
|
|
fn json_output(krate: clean::Crate, res: Vec<plugins::PluginJson> ,
|
2014-01-30 20:30:21 +01:00
|
|
|
dst: Path) -> io::IoResult<()> {
|
2013-09-22 08:25:48 +02:00
|
|
|
// {
|
|
|
|
|
// "schema": version,
|
|
|
|
|
// "crate": { parsed crate ... },
|
|
|
|
|
// "plugins": { output of plugins ... }
|
|
|
|
|
// }
|
2014-02-03 06:56:49 +01:00
|
|
|
let mut json = ~collections::TreeMap::new();
|
2013-09-30 21:58:18 +02:00
|
|
|
json.insert(~"schema", json::String(SCHEMA_VERSION.to_owned()));
|
2013-09-22 08:25:48 +02:00
|
|
|
let plugins_json = ~res.move_iter().filter_map(|opt| opt).collect();
|
|
|
|
|
|
|
|
|
|
// FIXME #8335: yuck, Rust -> str -> JSON round trip! No way to .encode
|
|
|
|
|
// straight to the Rust JSON representation.
|
2013-10-14 03:48:47 +02:00
|
|
|
let crate_json_str = {
|
2013-11-30 06:26:03 +01:00
|
|
|
let mut w = MemWriter::new();
|
|
|
|
|
{
|
2013-12-04 04:18:35 +01:00
|
|
|
let mut encoder = json::Encoder::new(&mut w as &mut io::Writer);
|
2014-03-29 01:05:46 +01:00
|
|
|
krate.encode(&mut encoder).unwrap();
|
2013-11-30 06:26:03 +01:00
|
|
|
}
|
2014-03-27 06:46:25 +01:00
|
|
|
str::from_utf8(w.unwrap().as_slice()).unwrap().to_owned()
|
2013-09-22 08:25:48 +02:00
|
|
|
};
|
2013-09-30 21:58:18 +02:00
|
|
|
let crate_json = match json::from_str(crate_json_str) {
|
2013-09-22 08:25:48 +02:00
|
|
|
Ok(j) => j,
|
2014-02-17 07:31:05 +01:00
|
|
|
Err(e) => fail!("Rust generated JSON is invalid: {:?}", e)
|
2013-09-22 08:25:48 +02:00
|
|
|
};
|
2012-11-19 02:56:50 +01:00
|
|
|
|
2013-09-22 08:25:48 +02:00
|
|
|
json.insert(~"crate", crate_json);
|
2013-09-30 21:58:18 +02:00
|
|
|
json.insert(~"plugins", json::Object(plugins_json));
|
2013-09-22 08:25:48 +02:00
|
|
|
|
2014-02-19 19:07:49 +01:00
|
|
|
let mut file = try!(File::create(&dst));
|
|
|
|
|
try!(json::Object(json).to_writer(&mut file));
|
2014-01-30 20:30:21 +01:00
|
|
|
Ok(())
|
2012-11-19 02:56:50 +01:00
|
|
|
}
|
