1 // Copyright 2015 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.
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.
11 #![feature(rustc_private, rustdoc)]
15 extern crate serialize as rustc_serialize;
17 use std::collections::BTreeMap;
18 use std::fs::{read_dir, File};
19 use std::io::{Read, Write};
21 use std::error::Error;
23 use syntax::diagnostics::metadata::{get_metadata_dir, ErrorMetadataMap};
25 use rustdoc::html::markdown::Markdown;
26 use rustc_serialize::json;
28 /// Load all the metadata files from `metadata_dir` into an in-memory map.
29 fn load_all_errors(metadata_dir: &Path) -> Result<ErrorMetadataMap, Box<Error>> {
30 let mut all_errors = BTreeMap::new();
32 for entry in try!(read_dir(metadata_dir)) {
33 let path = try!(entry).path();
35 let mut metadata_str = String::new();
37 File::open(&path).and_then(|mut f|
38 f.read_to_string(&mut metadata_str))
41 let some_errors: ErrorMetadataMap = try!(json::decode(&metadata_str));
43 for (err_code, info) in some_errors {
44 all_errors.insert(err_code, info);
51 /// Output an HTML page for the errors in `err_map` to `output_path`.
52 fn render_error_page(err_map: &ErrorMetadataMap, output_path: &Path) -> Result<(), Box<Error>> {
53 let mut output_file = try!(File::create(output_path));
55 try!(write!(&mut output_file,
59 <title>Rust Compiler Error Index</title>
60 <meta charset="utf-8">
61 <!-- Include rust.css after main.css so its rules take priority. -->
62 <link rel="stylesheet" type="text/css" href="main.css"/>
63 <link rel="stylesheet" type="text/css" href="rust.css"/>
74 try!(write!(&mut output_file, "<h1>Rust Compiler Error Index</h1>\n"));
76 for (err_code, info) in err_map {
77 // Enclose each error in a div so they can be shown/hidden en masse.
78 let desc_desc = match info.description {
79 Some(_) => "error-described",
80 None => "error-undescribed"
82 let use_desc = match info.use_site {
83 Some(_) => "error-used",
84 None => "error-unused"
86 try!(write!(&mut output_file, "<div class=\"{} {}\">", desc_desc, use_desc));
88 // Error title (with self-link).
89 try!(write!(&mut output_file,
90 "<h2 id=\"{0}\" class=\"section-header\"><a href=\"#{0}\">{0}</a></h2>\n",
94 // Description rendered as markdown.
95 match info.description {
96 Some(ref desc) => try!(write!(&mut output_file, "{}", Markdown(desc))),
97 None => try!(write!(&mut output_file, "<p>No description.</p>\n"))
100 try!(write!(&mut output_file, "</div>\n"));
103 try!(write!(&mut output_file, "</body>\n</html>"));
108 fn main_with_result() -> Result<(), Box<Error>> {
109 let metadata_dir = get_metadata_dir();
110 let err_map = try!(load_all_errors(&metadata_dir));
111 try!(render_error_page(&err_map, Path::new("doc/error-index.html")));
116 if let Err(e) = main_with_result() {
117 panic!("{}", e.description());