79 lines
2.4 KiB
Rust
79 lines
2.4 KiB
Rust
// Copyright 2015 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.
|
|
|
|
use std::io::{self, Write};
|
|
use std::path::Path;
|
|
|
|
use rustfmt_diff::{DiffLine, Mismatch};
|
|
|
|
/// The checkstyle header - should be emitted before the output of Rustfmt.
|
|
///
|
|
/// Note that emitting checkstyle output is not stable and may removed in a
|
|
/// future version of Rustfmt.
|
|
pub fn header() -> String {
|
|
let mut xml_heading = String::new();
|
|
xml_heading.push_str("<?xml version=\"1.0\" encoding=\"utf-8\"?>");
|
|
xml_heading.push_str("\n");
|
|
xml_heading.push_str("<checkstyle version=\"4.3\">");
|
|
xml_heading
|
|
}
|
|
|
|
/// The checkstyle footer - should be emitted after the output of Rustfmt.
|
|
///
|
|
/// Note that emitting checkstyle output is not stable and may removed in a
|
|
/// future version of Rustfmt.
|
|
pub fn footer() -> String {
|
|
"</checkstyle>\n".to_owned()
|
|
}
|
|
|
|
pub fn output_checkstyle_file<T>(
|
|
mut writer: T,
|
|
filename: &Path,
|
|
diff: Vec<Mismatch>,
|
|
) -> Result<(), io::Error>
|
|
where
|
|
T: Write,
|
|
{
|
|
write!(writer, "<file name=\"{}\">", filename.display())?;
|
|
for mismatch in diff {
|
|
for line in mismatch.lines {
|
|
// Do nothing with `DiffLine::Context` and `DiffLine::Resulting`.
|
|
if let DiffLine::Expected(ref str) = line {
|
|
let message = xml_escape_str(str);
|
|
write!(
|
|
writer,
|
|
"<error line=\"{}\" severity=\"warning\" message=\"Should be `{}`\" \
|
|
/>",
|
|
mismatch.line_number, message
|
|
)?;
|
|
}
|
|
}
|
|
}
|
|
write!(writer, "</file>")?;
|
|
Ok(())
|
|
}
|
|
|
|
// Convert special characters into XML entities.
|
|
// This is needed for checkstyle output.
|
|
fn xml_escape_str(string: &str) -> String {
|
|
let mut out = String::new();
|
|
for c in string.chars() {
|
|
match c {
|
|
'<' => out.push_str("<"),
|
|
'>' => out.push_str(">"),
|
|
'"' => out.push_str("""),
|
|
'\'' => out.push_str("'"),
|
|
'&' => out.push_str("&"),
|
|
_ => out.push(c),
|
|
}
|
|
}
|
|
out
|
|
}
|