Merge pull request #3240 from Xanewok/parser-panic

[rust.git] / src / checkstyle.rs

diff --git a/src/checkstyle.rs b/src/checkstyle.rs
index 3fc117904c718ebf3cd2bdc716e2b0bf993bf9df..e252e71f8298482cc592a0215939d0982f3ef86e 100644 (file)
--- a/src/checkstyle.rs
+++ b/src/checkstyle.rs
@@ -7,56 +7,56 @@
 // <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 rustfmt_diff::{Mismatch, DiffLine};
+
 use std::io::{self, Write};
-use config::WriteMode;
+use std::path::Path;
 
+use rustfmt_diff::{DiffLine, Mismatch};
 
-pub fn output_header<T>(out: &mut T, mode: WriteMode) -> Result<(), io::Error>
-    where T: Write
-{
-    if mode == WriteMode::Checkstyle {
-        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\">");
-        try!(write!(out, "{}", xml_heading));
-    }
-    Ok(())
+/// 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
 }
 
-pub fn output_footer<T>(out: &mut T, mode: WriteMode) -> Result<(), io::Error>
-    where T: Write
-{
-    if mode == WriteMode::Checkstyle {
-        let mut xml_tail = String::new();
-        xml_tail.push_str("</checkstyle>");
-        try!(write!(out, "{}", xml_tail));
-    }
-    Ok(())
+/// 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: &str,
-                                 diff: Vec<Mismatch>)
-                                 -> Result<(), io::Error>
-    where T: Write
+pub fn output_checkstyle_file<T>(
+    mut writer: T,
+    filename: &Path,
+    diff: Vec<Mismatch>,
+) -> Result<(), io::Error>
+where
+    T: Write,
 {
-    try!(write!(writer, "<file name=\"{}\">", filename));
+    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);
-                try!(write!(writer,
-                            "<error line=\"{}\" severity=\"warning\" message=\"Should be `{}`\" \
-                             />",
-                            mismatch.line_number,
-                            message));
+                write!(
+                    writer,
+                    "<error line=\"{}\" severity=\"warning\" message=\"Should be `{}`\" \
+                     />",
+                    mismatch.line_number, message
+                )?;
             }
         }
     }
-    try!(write!(writer, "</file>"));
+    write!(writer, "</file>")?;
     Ok(())
 }