1 #![feature(rustc_private)]
3 extern crate env_logger;
5 extern crate serialize as rustc_serialize;
7 use std::collections::BTreeMap;
10 use std::fs::{self, read_dir, File};
13 use std::path::PathBuf;
14 use std::cell::RefCell;
16 use syntax::edition::DEFAULT_EDITION;
17 use syntax::diagnostics::metadata::{get_metadata_dir, ErrorMetadataMap, ErrorMetadata};
19 use rustdoc::html::markdown::{Markdown, IdMap, ErrorCodes, PLAYGROUND};
20 use rustc_serialize::json;
24 Markdown(MarkdownFormatter),
29 fn from(format: &str, resource_suffix: &str) -> OutputFormat {
30 match &*format.to_lowercase() {
31 "html" => OutputFormat::HTML(HTMLFormatter(RefCell::new(IdMap::new()),
32 resource_suffix.to_owned())),
33 "markdown" => OutputFormat::Markdown(MarkdownFormatter),
34 s => OutputFormat::Unknown(s.to_owned()),
40 fn header(&self, output: &mut dyn Write) -> Result<(), Box<dyn Error>>;
41 fn title(&self, output: &mut dyn Write) -> Result<(), Box<dyn Error>>;
42 fn error_code_block(&self, output: &mut dyn Write, info: &ErrorMetadata,
43 err_code: &str) -> Result<(), Box<dyn Error>>;
44 fn footer(&self, output: &mut dyn Write) -> Result<(), Box<dyn Error>>;
47 struct HTMLFormatter(RefCell<IdMap>, String);
48 struct MarkdownFormatter;
50 impl Formatter for HTMLFormatter {
51 fn header(&self, output: &mut dyn Write) -> Result<(), Box<dyn Error>> {
52 write!(output, r##"<!DOCTYPE html>
55 <title>Rust Compiler Error Index</title>
56 <meta charset="utf-8">
57 <!-- Include rust.css after light.css so its rules take priority. -->
58 <link rel="stylesheet" type="text/css" href="light{suffix}.css"/>
59 <link rel="stylesheet" type="text/css" href="rust.css"/>
71 fn title(&self, output: &mut dyn Write) -> Result<(), Box<dyn Error>> {
72 write!(output, "<h1>Rust Compiler Error Index</h1>\n")?;
76 fn error_code_block(&self, output: &mut dyn Write, info: &ErrorMetadata,
77 err_code: &str) -> Result<(), Box<dyn Error>> {
78 // Enclose each error in a div so they can be shown/hidden en masse.
79 let desc_desc = match info.description {
80 Some(_) => "error-described",
81 None => "error-undescribed",
83 let use_desc = match info.use_site {
84 Some(_) => "error-used",
85 None => "error-unused",
87 write!(output, "<div class=\"{} {}\">", desc_desc, use_desc)?;
89 // Error title (with self-link).
91 "<h2 id=\"{0}\" class=\"section-header\"><a href=\"#{0}\">{0}</a></h2>\n",
94 // Description rendered as markdown.
95 match info.description {
97 let mut id_map = self.0.borrow_mut();
99 Markdown(desc, &[], RefCell::new(&mut id_map),
100 ErrorCodes::Yes, DEFAULT_EDITION))?
102 None => write!(output, "<p>No description.</p>\n")?,
105 write!(output, "</div>\n")?;
109 fn footer(&self, output: &mut dyn Write) -> Result<(), Box<dyn Error>> {
110 write!(output, r##"<script>
111 function onEach(arr, func) {{
112 if (arr && arr.length > 0 && func) {{
113 for (var i = 0; i < arr.length; i++) {{
119 function hasClass(elem, className) {{
120 if (elem && className && elem.className) {{
121 var elemClass = elem.className;
122 var start = elemClass.indexOf(className);
125 }} else if (elemClass.length === className.length) {{
128 if (start > 0 && elemClass[start - 1] !== ' ') {{
131 var end = start + className.length;
132 if (end < elemClass.length && elemClass[end] !== ' ') {{
137 if (start > 0 && elemClass[start - 1] !== ' ') {{
140 var end = start + className.length;
141 if (end < elemClass.length && elemClass[end] !== ' ') {{
149 onEach(document.getElementsByClassName('rust-example-rendered'), function(e) {{
150 if (hasClass(e, 'compile_fail')) {{
151 e.addEventListener("mouseover", function(event) {{
152 e.previousElementSibling.childNodes[0].style.color = '#f00';
154 e.addEventListener("mouseout", function(event) {{
155 e.previousElementSibling.childNodes[0].style.color = '';
157 }} else if (hasClass(e, 'ignore')) {{
158 e.addEventListener("mouseover", function(event) {{
159 e.previousElementSibling.childNodes[0].style.color = '#ff9200';
161 e.addEventListener("mouseout", function(event) {{
162 e.previousElementSibling.childNodes[0].style.color = '';
173 impl Formatter for MarkdownFormatter {
174 #[allow(unused_variables)]
175 fn header(&self, output: &mut dyn Write) -> Result<(), Box<dyn Error>> {
179 fn title(&self, output: &mut dyn Write) -> Result<(), Box<dyn Error>> {
180 write!(output, "# Rust Compiler Error Index\n")?;
184 fn error_code_block(&self, output: &mut dyn Write, info: &ErrorMetadata,
185 err_code: &str) -> Result<(), Box<dyn Error>> {
186 Ok(match info.description {
187 Some(ref desc) => write!(output, "## {}\n{}\n", err_code, desc)?,
192 #[allow(unused_variables)]
193 fn footer(&self, output: &mut dyn Write) -> Result<(), Box<dyn Error>> {
198 /// Loads all the metadata files from `metadata_dir` into an in-memory map.
199 fn load_all_errors(metadata_dir: &Path) -> Result<ErrorMetadataMap, Box<dyn Error>> {
200 let mut all_errors = BTreeMap::new();
202 for entry in read_dir(metadata_dir)? {
203 let path = entry?.path();
205 let metadata_str = fs::read_to_string(&path)?;
207 let some_errors: ErrorMetadataMap = json::decode(&metadata_str)?;
209 for (err_code, info) in some_errors {
210 all_errors.insert(err_code, info);
217 /// Output an HTML page for the errors in `err_map` to `output_path`.
218 fn render_error_page<T: Formatter>(err_map: &ErrorMetadataMap, output_path: &Path,
219 formatter: T) -> Result<(), Box<dyn Error>> {
220 let mut output_file = File::create(output_path)?;
222 formatter.header(&mut output_file)?;
223 formatter.title(&mut output_file)?;
225 for (err_code, info) in err_map {
226 formatter.error_code_block(&mut output_file, info, err_code)?;
229 formatter.footer(&mut output_file)
232 fn main_with_result(format: OutputFormat, dst: &Path) -> Result<(), Box<dyn Error>> {
233 let build_arch = env::var("CFG_BUILD")?;
234 let metadata_dir = get_metadata_dir(&build_arch);
235 let err_map = load_all_errors(&metadata_dir)?;
237 OutputFormat::Unknown(s) => panic!("Unknown output format: {}", s),
238 OutputFormat::HTML(h) => render_error_page(&err_map, dst, h)?,
239 OutputFormat::Markdown(m) => render_error_page(&err_map, dst, m)?,
244 fn parse_args() -> (OutputFormat, PathBuf) {
245 let mut args = env::args().skip(1);
246 let format = args.next();
247 let dst = args.next();
248 let resource_suffix = args.next().unwrap_or_else(String::new);
249 let format = format.map(|a| OutputFormat::from(&a, &resource_suffix))
250 .unwrap_or(OutputFormat::from("html", &resource_suffix));
251 let dst = dst.map(PathBuf::from).unwrap_or_else(|| {
253 OutputFormat::HTML(..) => PathBuf::from("doc/error-index.html"),
254 OutputFormat::Markdown(..) => PathBuf::from("doc/error-index.md"),
255 OutputFormat::Unknown(..) => PathBuf::from("<nul>"),
263 PLAYGROUND.with(|slot| {
264 *slot.borrow_mut() = Some((None, String::from("https://play.rust-lang.org/")));
266 let (format, dst) = parse_args();
267 let result = syntax::with_default_globals(move || {
268 main_with_result(format, &dst)
270 if let Err(e) = result {
271 panic!("{}", e.description());