// option. This file may not be copied, modified, or distributed
// except according to those terms.
-#![crate_id = "rustdoc#0.11.0-pre"]
+#![crate_name = "rustdoc"]
#![experimental]
#![desc = "rustdoc, the Rust documentation extractor"]
#![license = "MIT/ASL2"]
use std::str;
use std::gc::Gc;
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 markdown;
pub mod passes;
pub mod plugins;
+pub mod stability_summary;
pub mod visit_ast;
pub mod test;
mod flock;
type Output = (clean::Crate, Vec<plugins::PluginJson> );
pub fn main() {
- std::os::set_exit_status(main_args(std::os::args().iter()
- .map(|x| x.to_string())
- .collect::<Vec<_>>()
- .as_slice()));
+ 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"),
- optflag("", "version", "print rustdoc's version"),
+ 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",
"ARGS"),
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",
+ optmulti("", "html-in-header",
+ "files to include inline in the <head> section of a rendered Markdown file \
+ or generated documentation",
"FILES"),
- optmulti("", "markdown-before-content",
+ optmulti("", "html-before-content",
"files to include inline between <body> and the content of a rendered \
- Markdown file",
+ Markdown file or generated documentation",
"FILES"),
- optmulti("", "markdown-after-content",
+ optmulti("", "html-after-content",
"files to include inline between the content and </body> of a rendered \
- Markdown file",
+ Markdown file or generated documentation",
"FILES"),
optopt("", "markdown-playground-url",
"URL to send code snippets to", "URL")
usage(args[0].as_slice());
return 0;
} else if matches.opt_present("version") {
- rustc::driver::version("rustdoc");
- return 0;
+ match rustc::driver::version("rustdoc", &matches) {
+ Some(err) => {
+ println!("{}", err);
+ return 1
+ },
+ None => return 0
+ }
}
if matches.free.len() == 0 {
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
+ };
+
match (should_test, markdown_input) {
(true, true) => {
- return markdown::test(input,
- libs,
- test_args.move_iter().collect())
+ return markdown::test(input, libs, test_args)
}
(true, false) => {
- return test::run(input,
- cfgs.move_iter()
- .map(|x| x.to_string())
- .collect(),
- libs,
- test_args)
+ return test::run(input, cfgs, libs, test_args)
}
(false, true) => return markdown::render(input, output.unwrap_or(Path::new("doc")),
- &matches),
+ &matches, &external_html),
(false, false) => {}
}
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, output.unwrap_or(Path::new("doc"))) {
+ match html::render::run(krate, &external_html, output.unwrap_or(Path::new("doc"))) {
Ok(()) => {}
Err(e) => fail!("failed to generate documentation: {}", e),
}
fn rust_input(cratefile: &str, 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")
- .move_iter()
- .map(|x| x.to_string())
- .collect::<Vec<_>>();
+ let mut plugins = matches.opt_strs("plugins");
// First, parse the crate and extract all relevant information.
let libs: Vec<Path> = matches.opt_strs("L")
let (krate, analysis) = std::task::try(proc() {
let cr = cr;
core::run_core(libs.move_iter().map(|x| x.clone()).collect(),
- cfgs.move_iter().map(|x| x.to_string()).collect(),
+ cfgs,
&cr)
}).map_err(|boxed_any|format!("{:?}", boxed_any)).unwrap();
info!("finished with rustc");
}
};
match json::from_reader(&mut input) {
- Err(s) => Err(s.to_str()),
+ Err(s) => Err(s.to_string()),
Ok(json::Object(obj)) => {
let mut obj = obj;
// Make sure the schema is what we expect
// "crate": { parsed crate ... },
// "plugins": { output of plugins ... }
// }
- let mut json = box std::collections::TreeMap::new();
- json.insert("schema".to_string(),
- json::String(SCHEMA_VERSION.to_string()));
- let plugins_json = box res.move_iter()
- .filter_map(|opt| {
- match opt {
- None => None,
- Some((string, json)) => {
- Some((string.to_string(), json))
- }
+ let mut json = std::collections::TreeMap::new();
+ json.insert("schema".to_string(), json::String(SCHEMA_VERSION.to_string()));
+ let plugins_json = res.move_iter()
+ .filter_map(|opt| {
+ match opt {
+ None => None,
+ Some((string, json)) => {
+ Some((string.to_string(), json))
}
- }).collect();
+ }
+ }).collect();
// FIXME #8335: yuck, Rust -> str -> JSON round trip! No way to .encode
// straight to the Rust JSON representation.
let mut encoder = json::Encoder::new(&mut w as &mut io::Writer);
krate.encode(&mut encoder).unwrap();
}
- str::from_utf8(w.unwrap().as_slice()).unwrap().to_string()
+ str::from_utf8_owned(w.unwrap()).unwrap()
};
let crate_json = match json::from_str(crate_json_str.as_slice()) {
Ok(j) => j,
json.insert("plugins".to_string(), json::Object(plugins_json));
let mut file = try!(File::create(&dst));
- try!(json::Object(json).to_writer(&mut file));
- Ok(())
+ json::Object(json).to_writer(&mut file)
}
projects / rust.git / blobdiff