]> git.lizzy.rs Git - rust.git/blobdiff - src/lib.rs
Trigger an internal error if we skip formatting due to a lost comment
[rust.git] / src / lib.rs
index 77589038c66908947161a5c26a03dec5427940ca..820134c2085d4e6efaf50ddfefbf03282d4a2f47 100644 (file)
@@ -8,67 +8,75 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
-#![feature(custom_attribute)]
+#![feature(tool_attributes)]
 #![feature(decl_macro)]
-// FIXME(cramertj) remove after match_default_bindings merges
-#![allow(stable_features)]
-#![feature(match_default_bindings)]
+#![allow(unused_attributes)]
 #![feature(type_ascription)]
+#![feature(unicode_internals)]
+#![feature(extern_prelude)]
 
 #[macro_use]
 extern crate derive_new;
 extern crate diff;
+extern crate failure;
+extern crate isatty;
 extern crate itertools;
+#[cfg(test)]
+#[macro_use]
+extern crate lazy_static;
 #[macro_use]
 extern crate log;
 extern crate regex;
+extern crate rustc_target;
 extern crate serde;
 #[macro_use]
 extern crate serde_derive;
 extern crate serde_json;
 extern crate syntax;
-extern crate term;
+extern crate syntax_pos;
 extern crate toml;
 extern crate unicode_segmentation;
 
+use std::cell::RefCell;
 use std::collections::HashMap;
 use std::fmt;
-use std::io::{self, stdout, BufRead, Write};
-use std::iter::repeat;
+use std::io::{self, Write};
 use std::panic::{catch_unwind, AssertUnwindSafe};
 use std::path::PathBuf;
 use std::rc::Rc;
 use std::time::Duration;
 
 use syntax::ast;
-pub use syntax::codemap::FileName;
-use syntax::codemap::{CodeMap, FilePathMapping};
+use syntax::codemap::{CodeMap, FilePathMapping, Span};
 use syntax::errors::emitter::{ColorConfig, EmitterWriter};
 use syntax::errors::{DiagnosticBuilder, Handler};
 use syntax::parse::{self, ParseSess};
 
-use checkstyle::{output_footer, output_header};
-use comment::{CharClasses, FullCodeCharKind};
+use comment::{CharClasses, FullCodeCharKind, LineClasses};
+use failure::Fail;
 use issues::{BadIssueSeeker, Issue};
 use shape::Indent;
-use utils::use_colored_tty;
 use visitor::{FmtVisitor, SnippetProvider};
 
-pub use config::Config;
+pub use checkstyle::{footer as checkstyle_footer, header as checkstyle_header};
 pub use config::summary::Summary;
+pub use config::{
+    load_config, CliOptions, Color, Config, EmitMode, FileLines, FileName, NewlineStyle, Range,
+    Verbosity,
+};
 
 #[macro_use]
 mod utils;
 
 mod attr;
 mod chains;
-mod checkstyle;
+pub(crate) mod checkstyle;
 mod closures;
-pub mod codemap;
+pub(crate) mod codemap;
 mod comment;
-pub mod config;
+pub(crate) mod config;
 mod expr;
-pub mod filemap;
+pub(crate) mod filemap;
 mod imports;
 mod issues;
 mod items;
 mod macros;
 mod matches;
 mod missed_spans;
-pub mod modules;
+pub(crate) mod modules;
 mod overflow;
+mod pairs;
 mod patterns;
 mod reorder;
 mod rewrite;
-pub mod rustfmt_diff;
+pub(crate) mod rustfmt_diff;
 mod shape;
 mod spanned;
 mod string;
+#[cfg(test)]
+mod test;
 mod types;
 mod vertical;
-pub mod visitor;
-
-const STDIN: &str = "<stdin>";
+pub(crate) mod visitor;
 
 // A map of the files of a crate, with their new content
-pub type FileMap = Vec<FileRecord>;
+pub(crate) type FileMap = Vec<FileRecord>;
 
-pub type FileRecord = (FileName, String);
+pub(crate) type FileRecord = (FileName, String);
 
-#[derive(Clone, Copy)]
+/// The various errors that can occur during formatting. Note that not all of
+/// these can currently be propagated to clients.
+#[derive(Fail, Debug)]
 pub enum ErrorKind {
-    // Line has exceeded character limit (found, maximum)
+    /// Line has exceeded character limit (found, maximum).
+    #[fail(
+        display = "line formatted, but exceeded maximum width \
+                   (maximum: {} (see `max_width` option), found: {})",
+        _0,
+        _1
+    )]
     LineOverflow(usize, usize),
-    // Line ends in whitespace
+    /// Line ends in whitespace.
+    #[fail(display = "left behind trailing whitespace")]
     TrailingWhitespace,
-    // TO-DO or FIX-ME item without an issue number
+    /// TODO or FIXME item without an issue number.
+    #[fail(display = "found {}", _0)]
     BadIssue(Issue),
-    // License check has failed
+    /// License check has failed.
+    #[fail(display = "license check failed")]
     LicenseCheck,
+    /// Used deprecated skip attribute.
+    #[fail(display = "`rustfmt_skip` is deprecated; use `rustfmt::skip`")]
+    DeprecatedAttr,
+    /// Used a rustfmt:: attribute other than skip.
+    #[fail(display = "invalid attribute")]
+    BadAttr,
+    /// An io error during reading or writing.
+    #[fail(display = "io error: {}", _0)]
+    IoError(io::Error),
+    /// Parse error occured when parsing the Input.
+    #[fail(display = "parse error")]
+    ParseError,
+    /// The user mandated a version and the current version of Rustfmt does not
+    /// satisfy that requirement.
+    #[fail(display = "version mismatch")]
+    VersionMismatch,
+    /// If we had formatted the given node, then we would have lost a comment.
+    #[fail(display = "not formatted because a comment would be lost")]
+    LostComment,
 }
 
-impl fmt::Display for ErrorKind {
-    fn fmt(&self, fmt: &mut fmt::Formatter) -> Result<(), fmt::Error> {
-        match *self {
-            ErrorKind::LineOverflow(found, maximum) => write!(
-                fmt,
-                "line exceeded maximum width (maximum: {}, found: {})",
-                maximum, found
-            ),
-            ErrorKind::TrailingWhitespace => write!(fmt, "left behind trailing whitespace"),
-            ErrorKind::BadIssue(issue) => write!(fmt, "found {}", issue),
-            ErrorKind::LicenseCheck => write!(fmt, "license check failed"),
+impl ErrorKind {
+    fn is_comment(&self) -> bool {
+        match self {
+            ErrorKind::LostComment => true,
+            _ => false,
         }
     }
 }
 
-// Formatting errors that are identified *after* rustfmt has run.
-pub struct FormattingError {
+impl From<io::Error> for ErrorKind {
+    fn from(e: io::Error) -> ErrorKind {
+        ErrorKind::IoError(e)
+    }
+}
+
+struct FormattingError {
     line: usize,
     kind: ErrorKind,
     is_comment: bool,
@@ -133,12 +171,32 @@ pub struct FormattingError {
 }
 
 impl FormattingError {
+    fn from_span(span: &Span, codemap: &CodeMap, kind: ErrorKind) -> FormattingError {
+        FormattingError {
+            line: codemap.lookup_char_pos(span.lo()).line,
+            is_comment: kind.is_comment(),
+            kind,
+            is_string: false,
+            line_buffer: codemap
+                .span_to_lines(*span)
+                .ok()
+                .and_then(|fl| {
+                    fl.file
+                        .get_line(fl.lines[0].line_index)
+                        .map(|l| l.into_owned())
+                })
+                .unwrap_or_else(|| String::new()),
+        }
+    }
     fn msg_prefix(&self) -> &str {
         match self.kind {
             ErrorKind::LineOverflow(..)
             | ErrorKind::TrailingWhitespace
-            | ErrorKind::LicenseCheck => "error:",
-            ErrorKind::BadIssue(_) => "WARNING:",
+            | ErrorKind::IoError(_)
+            | ErrorKind::ParseError
+            | ErrorKind::LostComment => "internal error:",
+            ErrorKind::LicenseCheck | ErrorKind::BadAttr | ErrorKind::VersionMismatch => "error:",
+            ErrorKind::BadIssue(_) | ErrorKind::DeprecatedAttr => "warning:",
         }
     }
 
@@ -152,11 +210,15 @@ fn msg_suffix(&self) -> &str {
     }
 
     // (space, target)
-    pub fn format_len(&self) -> (usize, usize) {
+    fn format_len(&self) -> (usize, usize) {
         match self.kind {
             ErrorKind::LineOverflow(found, max) => (max, found - max),
-            ErrorKind::TrailingWhitespace => {
-                let trailing_ws_start = self.line_buffer
+            ErrorKind::TrailingWhitespace
+            | ErrorKind::DeprecatedAttr
+            | ErrorKind::BadAttr
+            | ErrorKind::LostComment => {
+                let trailing_ws_start = self
+                    .line_buffer
                     .rfind(|c: char| !c.is_whitespace())
                     .map(|pos| pos + 1)
                     .unwrap_or(0);
@@ -170,37 +232,86 @@ pub fn format_len(&self) -> (usize, usize) {
     }
 }
 
+/// Reports on any issues that occurred during a run of Rustfmt.
+///
+/// Can be reported to the user via its `Display` implementation of `print_fancy`.
+#[derive(Clone)]
 pub struct FormatReport {
     // Maps stringified file paths to their associated formatting errors.
-    file_error_map: HashMap<FileName, Vec<FormattingError>>,
+    internal: Rc<RefCell<(FormatErrorMap, ReportedErrors)>>,
+}
+
+type FormatErrorMap = HashMap<FileName, Vec<FormattingError>>;
+
+#[derive(Default, Debug)]
+struct ReportedErrors {
+    has_operational_errors: bool,
+    has_check_errors: bool,
 }
 
 impl FormatReport {
     fn new() -> FormatReport {
         FormatReport {
-            file_error_map: HashMap::new(),
+            internal: Rc::new(RefCell::new((HashMap::new(), ReportedErrors::default()))),
         }
     }
 
-    pub fn warning_count(&self) -> usize {
-        self.file_error_map
+    fn append(&self, f: FileName, mut v: Vec<FormattingError>) {
+        self.track_errors(&v);
+        self.internal
+            .borrow_mut()
+            .0
+            .entry(f)
+            .and_modify(|fe| fe.append(&mut v))
+            .or_insert(v);
+    }
+
+    fn track_errors(&self, new_errors: &[FormattingError]) {
+        let errs = &mut self.internal.borrow_mut().1;
+        if errs.has_operational_errors && errs.has_check_errors {
+            return;
+        }
+        for err in new_errors {
+            match err.kind {
+                ErrorKind::LineOverflow(..) | ErrorKind::TrailingWhitespace => {
+                    errs.has_operational_errors = true;
+                }
+                ErrorKind::BadIssue(_)
+                | ErrorKind::LicenseCheck
+                | ErrorKind::DeprecatedAttr
+                | ErrorKind::BadAttr
+                | ErrorKind::VersionMismatch => {
+                    errs.has_check_errors = true;
+                }
+                _ => {}
+            }
+        }
+    }
+
+    fn warning_count(&self) -> usize {
+        self.internal
+            .borrow()
+            .0
             .iter()
             .map(|(_, errors)| errors.len())
             .sum()
     }
 
+    /// Whether any warnings or errors are present in the report.
     pub fn has_warnings(&self) -> bool {
         self.warning_count() > 0
     }
 
-    pub fn print_warnings_fancy(
+    /// Print the report to a terminal using colours and potentially other
+    /// fancy output.
+    pub fn fancy_print(
         &self,
         mut t: Box<term::Terminal<Output = io::Stderr>>,
     ) -> Result<(), term::Error> {
-        for (file, errors) in &self.file_error_map {
+        for (file, errors) in &self.internal.borrow().0 {
             for error in errors {
                 let prefix_space_len = error.line.to_string().len();
-                let prefix_spaces: String = repeat(" ").take(1 + prefix_space_len).collect();
+                let prefix_spaces = " ".repeat(1 + prefix_space_len);
 
                 // First line: the overview of error
                 t.fg(term::color::RED)?;
@@ -208,12 +319,12 @@ pub fn print_warnings_fancy(
                 write!(t, "{} ", error.msg_prefix())?;
                 t.reset()?;
                 t.attr(term::Attr::Bold)?;
-                write!(t, "{}\n", error.kind)?;
+                writeln!(t, "{}", error.kind)?;
 
                 // Second line: file info
                 write!(t, "{}--> ", &prefix_spaces[1..])?;
                 t.reset()?;
-                write!(t, "{}:{}\n", file, error.line)?;
+                writeln!(t, "{}:{}", file, error.line)?;
 
                 // Third to fifth lines: show the line which triggered error, if available.
                 if !error.line_buffer.is_empty() {
@@ -221,11 +332,11 @@ pub fn print_warnings_fancy(
                     t.attr(term::Attr::Bold)?;
                     write!(t, "{}|\n{} | ", prefix_spaces, error.line)?;
                     t.reset()?;
-                    write!(t, "{}\n", error.line_buffer)?;
+                    writeln!(t, "{}", error.line_buffer)?;
                     t.attr(term::Attr::Bold)?;
                     write!(t, "{}| ", prefix_spaces)?;
                     t.fg(term::color::RED)?;
-                    write!(t, "{}\n", target_str(space_len, target_len))?;
+                    writeln!(t, "{}", target_str(space_len, target_len))?;
                     t.reset()?;
                 }
 
@@ -235,15 +346,15 @@ pub fn print_warnings_fancy(
                     t.attr(term::Attr::Bold)?;
                     write!(t, "{}= note: ", prefix_spaces)?;
                     t.reset()?;
-                    write!(t, "{}\n", error.msg_suffix())?;
+                    writeln!(t, "{}", error.msg_suffix())?;
                 } else {
-                    write!(t, "\n")?;
+                    writeln!(t)?;
                 }
                 t.reset()?;
             }
         }
 
-        if !self.file_error_map.is_empty() {
+        if !self.internal.borrow().0.is_empty() {
             t.attr(term::Attr::Bold)?;
             write!(t, "warning: ")?;
             t.reset()?;
@@ -259,18 +370,18 @@ pub fn print_warnings_fancy(
 }
 
 fn target_str(space_len: usize, target_len: usize) -> String {
-    let empty_line: String = repeat(" ").take(space_len).collect();
-    let overflowed: String = repeat("^").take(target_len).collect();
+    let empty_line = " ".repeat(space_len);
+    let overflowed = "^".repeat(target_len);
     empty_line + &overflowed
 }
 
 impl fmt::Display for FormatReport {
     // Prints all the formatting errors.
     fn fmt(&self, fmt: &mut fmt::Formatter) -> Result<(), fmt::Error> {
-        for (file, errors) in &self.file_error_map {
+        for (file, errors) in &self.internal.borrow().0 {
             for error in errors {
                 let prefix_space_len = error.line.to_string().len();
-                let prefix_spaces: String = repeat(" ").take(1 + prefix_space_len).collect();
+                let prefix_spaces = " ".repeat(1 + prefix_space_len);
 
                 let error_line_buffer = if error.line_buffer.is_empty() {
                     String::from(" ")
@@ -295,9 +406,9 @@ fn fmt(&self, fmt: &mut fmt::Formatter) -> Result<(), fmt::Error> {
                     format!("{}note= ", prefix_spaces)
                 };
 
-                write!(
+                writeln!(
                     fmt,
-                    "{}\n{}\n{}\n{}{}\n",
+                    "{}\n{}\n{}\n{}{}",
                     error_info,
                     file_info,
                     error_line_buffer,
@@ -306,10 +417,10 @@ fn fmt(&self, fmt: &mut fmt::Formatter) -> Result<(), fmt::Error> {
                 )?;
             }
         }
-        if !self.file_error_map.is_empty() {
-            write!(
+        if !self.internal.borrow().0.is_empty() {
+            writeln!(
                 fmt,
-                "warning: rustfmt may have failed to format. See previous {} errors.\n",
+                "warning: rustfmt may have failed to format. See previous {} errors.",
                 self.warning_count(),
             )?;
         }
@@ -321,7 +432,7 @@ fn should_emit_verbose<F>(path: &FileName, config: &Config, f: F)
 where
     F: Fn(),
 {
-    if config.verbose() && path.to_string() != STDIN {
+    if config.verbose() == Verbosity::Verbose && path != &FileName::Stdin {
         f();
     }
 }
@@ -332,18 +443,18 @@ fn format_ast<F>(
     parse_session: &mut ParseSess,
     main_file: &FileName,
     config: &Config,
+    report: FormatReport,
     mut after_file: F,
-) -> Result<(FileMap, bool), io::Error>
+) -> Result<(FileMap, bool, bool), io::Error>
 where
-    F: FnMut(&FileName, &mut String, &[(usize, usize)]) -> Result<bool, io::Error>,
+    F: FnMut(&FileName, &mut String, &[(usize, usize)], &FormatReport) -> Result<bool, io::Error>,
 {
     let mut result = FileMap::new();
     // diff mode: check if any files are differing
     let mut has_diff = false;
+    let mut has_macro_rewrite_failure = false;
 
-    // We always skip children for the "Plain" write mode, since there is
-    // nothing to distinguish the nested module contents.
-    let skip_children = config.skip_children() || config.write_mode() == config::WriteMode::Plain;
+    let skip_children = config.skip_children();
     for (path, module) in modules::list_files(krate, parse_session.codemap())? {
         if (skip_children && path != *main_file) || config.ignore().skip_file(&path) {
             continue;
@@ -355,7 +466,8 @@ fn format_ast<F>(
             .file;
         let big_snippet = filemap.src.as_ref().unwrap();
         let snippet_provider = SnippetProvider::new(filemap.start_pos, big_snippet);
-        let mut visitor = FmtVisitor::from_codemap(parse_session, config, &snippet_provider);
+        let mut visitor =
+            FmtVisitor::from_codemap(parse_session, config, &snippet_provider, report.clone());
         // Format inner attributes if available.
         if !krate.attrs.is_empty() && path == *main_file {
             visitor.skip_empty_lines(filemap.end_pos);
@@ -372,11 +484,10 @@ fn format_ast<F>(
 
         debug_assert_eq!(
             visitor.line_number,
-            ::utils::count_newlines(&format!("{}", visitor.buffer))
+            ::utils::count_newlines(&visitor.buffer)
         );
 
-        let filename = path.clone();
-        has_diff |= match after_file(&filename, &mut visitor.buffer, &visitor.skipped_range) {
+        has_diff |= match after_file(&path, &mut visitor.buffer, &visitor.skipped_range, &report) {
             Ok(result) => result,
             Err(e) => {
                 // Create a new error with path_str to help users see which files failed
@@ -385,13 +496,15 @@ fn format_ast<F>(
             }
         };
 
-        result.push((filename, visitor.buffer));
+        has_macro_rewrite_failure |= visitor.macro_rewrite_failure;
+
+        result.push((path.clone(), visitor.buffer));
     }
 
-    Ok((result, has_diff))
+    Ok((result, has_diff, has_macro_rewrite_failure))
 }
 
-/// Returns true if the line with the given line number was skipped by `#[rustfmt_skip]`.
+/// Returns true if the line with the given line number was skipped by `#[rustfmt::skip]`.
 fn is_skipped_line(line_number: usize, skipped_range: &[(usize, usize)]) -> bool {
     skipped_range
         .iter()
@@ -402,9 +515,9 @@ fn should_report_error(
     config: &Config,
     char_kind: FullCodeCharKind,
     is_string: bool,
-    error_kind: ErrorKind,
+    error_kind: &ErrorKind,
 ) -> bool {
-    let allow_error_report = if char_kind.is_comment() || is_string {
+    let allow_error_report = if char_kind.is_comment() || is_string || error_kind.is_comment() {
         config.error_on_unformatted()
     } else {
         true
@@ -412,7 +525,7 @@ fn should_report_error(
 
     match error_kind {
         ErrorKind::LineOverflow(..) => config.error_on_line_overflow() && allow_error_report,
-        ErrorKind::TrailingWhitespace => allow_error_report,
+        ErrorKind::TrailingWhitespace | ErrorKind::LostComment => allow_error_report,
         _ => true,
     }
 }
@@ -424,10 +537,9 @@ fn format_lines(
     name: &FileName,
     skipped_range: &[(usize, usize)],
     config: &Config,
-    report: &mut FormatReport,
+    report: &FormatReport,
 ) {
-    let mut trims = vec![];
-    let mut last_wspace: Option<usize> = None;
+    let mut last_was_space = false;
     let mut line_len = 0;
     let mut cur_line = 1;
     let mut newline_count = 0;
@@ -452,7 +564,7 @@ fn format_lines(
     }
 
     // Iterate over the chars in the file map.
-    for (kind, (b, c)) in CharClasses::new(text.chars().enumerate()) {
+    for (kind, c) in CharClasses::new(text.chars()) {
         if c == '\r' {
             continue;
         }
@@ -473,17 +585,26 @@ fn format_lines(
         if c == '\n' {
             if format_line {
                 // Check for (and record) trailing whitespace.
-                if let Some(..) = last_wspace {
-                    if should_report_error(config, kind, is_string, ErrorKind::TrailingWhitespace) {
-                        trims.push((cur_line, kind, line_buffer.clone()));
+                if last_was_space {
+                    if should_report_error(config, kind, is_string, &ErrorKind::TrailingWhitespace)
+                        && !is_skipped_line(cur_line, skipped_range)
+                    {
+                        errors.push(FormattingError {
+                            line: cur_line,
+                            kind: ErrorKind::TrailingWhitespace,
+                            is_comment: kind.is_comment(),
+                            is_string: kind.is_string(),
+                            line_buffer: line_buffer.clone(),
+                        });
                     }
                     line_len -= 1;
                 }
 
                 // Check for any line width errors we couldn't correct.
                 let error_kind = ErrorKind::LineOverflow(line_len, config.max_width());
-                if line_len > config.max_width() && !is_skipped_line(cur_line, skipped_range)
-                    && should_report_error(config, kind, is_string, error_kind)
+                if line_len > config.max_width()
+                    && !is_skipped_line(cur_line, skipped_range)
+                    && should_report_error(config, kind, is_string, &error_kind)
                 {
                     errors.push(FormattingError {
                         line: cur_line,
@@ -499,19 +620,13 @@ fn format_lines(
             cur_line += 1;
             format_line = config.file_lines().contains_line(name, cur_line);
             newline_count += 1;
-            last_wspace = None;
+            last_was_space = false;
             line_buffer.clear();
             is_string = false;
         } else {
             newline_count = 0;
             line_len += if c == '\t' { config.tab_spaces() } else { 1 };
-            if c.is_whitespace() {
-                if last_wspace.is_none() {
-                    last_wspace = Some(b);
-                }
-            } else {
-                last_wspace = None;
-            }
+            last_was_space = c.is_whitespace();
             line_buffer.push(c);
             if kind.is_string() {
                 is_string = true;
@@ -525,19 +640,7 @@ fn format_lines(
         text.truncate(line);
     }
 
-    for &(l, kind, ref b) in &trims {
-        if !is_skipped_line(l, skipped_range) {
-            errors.push(FormattingError {
-                line: l,
-                kind: ErrorKind::TrailingWhitespace,
-                is_comment: kind.is_comment(),
-                is_string: kind.is_string(),
-                line_buffer: b.clone(),
-            });
-        }
-    }
-
-    report.file_error_map.insert(name.clone(), errors);
+    report.append(name.clone(), errors);
 }
 
 fn parse_input<'sess>(
@@ -549,7 +652,7 @@ fn parse_input<'sess>(
         Input::File(file) => parse::new_parser_from_file(parse_session, &file),
         Input::Text(text) => parse::new_parser_from_source_str(
             parse_session,
-            FileName::Custom("stdin".to_owned()),
+            syntax::codemap::FileName::Custom("stdin".to_owned()),
             text,
         ),
     };
@@ -588,14 +691,16 @@ enum ParseError<'sess> {
 
 /// Format the given snippet. The snippet is expected to be *complete* code.
 /// When we cannot parse the given snippet, this function returns `None`.
-pub fn format_snippet(snippet: &str, config: &Config) -> Option<String> {
+fn format_snippet(snippet: &str, config: &Config) -> Option<String> {
     let mut out: Vec<u8> = Vec::with_capacity(snippet.len() * 2);
     let input = Input::Text(snippet.into());
     let mut config = config.clone();
-    config.set().write_mode(config::WriteMode::Plain);
+    config.set().emit_mode(config::EmitMode::Stdout);
+    config.set().verbose(Verbosity::Quiet);
     config.set().hide_parse_errors(true);
     match format_input(input, &config, Some(&mut out)) {
         // `format_input()` returns an empty string on parsing error.
+        Ok((summary, _)) if summary.has_macro_formatting_failure() => None,
         Ok(..) if out.is_empty() && !snippet.is_empty() => None,
         Ok(..) => String::from_utf8(out).ok(),
         Err(..) => None,
@@ -606,34 +711,54 @@ pub fn format_snippet(snippet: &str, config: &Config) -> Option<String> {
 
 fn enclose_in_main_block(s: &str, config: &Config) -> String {
     let indent = Indent::from_width(config, config.tab_spaces());
-    FN_MAIN_PREFIX.to_owned() + &indent.to_string(config)
-        + &s.lines()
-            .collect::<Vec<_>>()
-            .join(&indent.to_string_with_newline(config)) + "\n}"
+    let mut result = String::with_capacity(s.len() * 2);
+    result.push_str(FN_MAIN_PREFIX);
+    let mut need_indent = true;
+    for (kind, line) in LineClasses::new(s) {
+        if need_indent {
+            result.push_str(&indent.to_string(config));
+        }
+        result.push_str(&line);
+        result.push('\n');
+        need_indent = !kind.is_string() || line.ends_with('\\');
+    }
+    result.push('}');
+    result
 }
 
 /// Format the given code block. Mainly targeted for code block in comment.
 /// The code block may be incomplete (i.e. parser may be unable to parse it).
 /// To avoid panic in parser, we wrap the code block with a dummy function.
 /// The returned code block does *not* end with newline.
-pub fn format_code_block(code_snippet: &str, config: &Config) -> Option<String> {
+fn format_code_block(code_snippet: &str, config: &Config) -> Option<String> {
     // Wrap the given code block with `fn main()` if it does not have one.
     let snippet = enclose_in_main_block(code_snippet, config);
     let mut result = String::with_capacity(snippet.len());
     let mut is_first = true;
 
+    // While formatting the code, ignore the config's newline style setting and always use "\n"
+    // instead of "\r\n" for the newline characters. This is okay because the output here is
+    // not directly outputted by rustfmt command, but used by the comment formatter's input.
+    // We have output-file-wide "\n" ==> "\r\n" conversion proccess after here if it's necessary.
+    let mut config_with_unix_newline = config.clone();
+    config_with_unix_newline
+        .set()
+        .newline_style(NewlineStyle::Unix);
+    let formatted = format_snippet(&snippet, &config_with_unix_newline)?;
+
     // Trim "fn main() {" on the first line and "}" on the last line,
     // then unindent the whole code block.
-    let formatted = format_snippet(&snippet, config)?;
-    // 2 = "}\n"
-    let block_len = formatted.len().checked_sub(2).unwrap_or(0);
-    for line in formatted[FN_MAIN_PREFIX.len()..block_len].lines() {
+    let block_len = formatted.rfind('}').unwrap_or(formatted.len());
+    let mut is_indented = true;
+    for (kind, ref line) in LineClasses::new(&formatted[FN_MAIN_PREFIX.len()..block_len]) {
         if !is_first {
             result.push('\n');
         } else {
             is_first = false;
         }
-        let trimmed_line = if line.len() > config.max_width() {
+        let trimmed_line = if !is_indented {
+            line
+        } else if line.len() > config.max_width() {
             // If there are lines that are larger than max width, we cannot tell
             // whether we have succeeded but have some comments or strings that
             // are too long, or we have failed to format code block. We will be
@@ -656,29 +781,43 @@ pub fn format_code_block(code_snippet: &str, config: &Config) -> Option<String>
             line
         };
         result.push_str(trimmed_line);
+        is_indented = !kind.is_string() || line.ends_with('\\');
     }
     Some(result)
 }
 
+#[derive(Debug)]
+pub enum Input {
+    File(PathBuf),
+    Text(String),
+}
+
+/// The main entry point for Rustfmt. Formats the given input according to the
+/// given config. `out` is only necessary if required by the configuration.
 pub fn format_input<T: Write>(
     input: Input,
     config: &Config,
     out: Option<&mut T>,
-) -> Result<(Summary, FileMap, FormatReport), (io::Error, Summary)> {
-    syntax::with_globals(|| format_input_inner(input, config, out))
+) -> Result<(Summary, FormatReport), (ErrorKind, Summary)> {
+    if !config.version_meets_requirement() {
+        return Err((ErrorKind::VersionMismatch, Summary::default()));
+    }
+
+    syntax::with_globals(|| format_input_inner(input, config, out)).map(|tup| (tup.0, tup.2))
 }
 
 fn format_input_inner<T: Write>(
     input: Input,
     config: &Config,
     mut out: Option<&mut T>,
-) -> Result<(Summary, FileMap, FormatReport), (io::Error, Summary)> {
+) -> Result<(Summary, FileMap, FormatReport), (ErrorKind, Summary)> {
+    syntax_pos::hygiene::set_default_edition(config.edition().to_libsyntax_pos_edition());
     let mut summary = Summary::default();
     if config.disable_all_formatting() {
         // When the input is from stdin, echo back the input.
         if let Input::Text(ref buf) = input {
             if let Err(e) = io::stdout().write_all(buf.as_bytes()) {
-                return Err((e, summary));
+                return Err((From::from(e), summary));
             }
         }
         return Ok((summary, FileMap::new(), FormatReport::new()));
@@ -706,7 +845,7 @@ fn format_input_inner<T: Write>(
 
     let main_file = match input {
         Input::File(ref file) => FileName::Real(file.clone()),
-        Input::Text(..) => FileName::Custom("stdin".to_owned()),
+        Input::Text(..) => FileName::Stdin,
     };
 
     let krate = match parse_input(input, &parse_session, config) {
@@ -725,7 +864,7 @@ fn format_input_inner<T: Write>(
                 ParseError::Recovered => {}
             }
             summary.add_parsing_error();
-            return Ok((summary, FileMap::new(), FormatReport::new()));
+            return Err((ErrorKind::ParseError, summary));
         }
     };
 
@@ -740,19 +879,21 @@ fn format_input_inner<T: Write>(
     ));
     parse_session.span_diagnostic = Handler::with_emitter(true, false, silent_emitter);
 
-    let mut report = FormatReport::new();
+    let report = FormatReport::new();
 
     let format_result = format_ast(
         &krate,
         &mut parse_session,
         &main_file,
         config,
-        |file_name, file, skipped_range| {
+        report.clone(),
+        |file_name, file, skipped_range, report| {
             // For some reason, the codemap does not include terminating
             // newlines so we must add one on for each file. This is sad.
             filemap::append_newline(file);
 
-            format_lines(file, file_name, skipped_range, config, &mut report);
+            format_lines(file, file_name, skipped_range, config, report);
+            replace_with_system_newlines(file, config);
 
             if let Some(ref mut out) = out {
                 return filemap::write_file(file, file_name, out, config);
@@ -775,8 +916,18 @@ fn duration_to_f32(d: Duration) -> f32 {
         )
     });
 
+    {
+        let report_errs = &report.internal.borrow().1;
+        if report_errs.has_check_errors {
+            summary.add_check_error();
+        }
+        if report_errs.has_operational_errors {
+            summary.add_operational_error();
+        }
+    }
+
     match format_result {
-        Ok((file_map, has_diff)) => {
+        Ok((file_map, has_diff, has_macro_rewrite_failure)) => {
             if report.has_warnings() {
                 summary.add_formatting_error();
             }
@@ -785,16 +936,48 @@ fn duration_to_f32(d: Duration) -> f32 {
                 summary.add_diff();
             }
 
+            if has_macro_rewrite_failure {
+                summary.add_macro_foramt_failure();
+            }
+
             Ok((summary, file_map, report))
         }
-        Err(e) => Err((e, summary)),
+        Err(e) => Err((From::from(e), summary)),
+    }
+}
+
+fn replace_with_system_newlines(text: &mut String, config: &Config) -> () {
+    let style = if config.newline_style() == NewlineStyle::Native {
+        if cfg!(windows) {
+            NewlineStyle::Windows
+        } else {
+            NewlineStyle::Unix
+        }
+    } else {
+        config.newline_style()
+    };
+
+    match style {
+        NewlineStyle::Unix => return,
+        NewlineStyle::Windows => {
+            let mut transformed = String::with_capacity(text.capacity());
+            for c in text.chars() {
+                match c {
+                    '\n' => transformed.push_str("\r\n"),
+                    '\r' => continue,
+                    c => transformed.push(c),
+                }
+            }
+            *text = transformed;
+        }
+        NewlineStyle::Native => unreachable!(),
     }
 }
 
 /// A single span of changed lines, with 0 or more removed lines
 /// and a vector of 0 or more inserted lines.
 #[derive(Debug, PartialEq, Eq)]
-pub struct ModifiedChunk {
+struct ModifiedChunk {
     /// The first to be removed from the original text
     pub line_number_orig: u32,
     /// The number of lines which have been replaced
@@ -805,34 +988,25 @@ pub struct ModifiedChunk {
 
 /// Set of changed sections of a file.
 #[derive(Debug, PartialEq, Eq)]
-pub struct ModifiedLines {
+struct ModifiedLines {
     /// The set of changed chunks.
     pub chunks: Vec<ModifiedChunk>,
 }
 
-/// The successful result of formatting via `get_modified_lines()`.
-pub struct ModifiedLinesResult {
-    /// The high level summary details
-    pub summary: Summary,
-    /// The result Filemap
-    pub filemap: FileMap,
-    /// Map of formatting errors
-    pub report: FormatReport,
-    /// The sets of updated lines.
-    pub modified_lines: ModifiedLines,
-}
-
 /// Format a file and return a `ModifiedLines` data structure describing
 /// the changed ranges of lines.
-pub fn get_modified_lines(
+#[cfg(test)]
+fn get_modified_lines(
     input: Input,
     config: &Config,
-) -> Result<ModifiedLinesResult, (io::Error, Summary)> {
+) -> Result<ModifiedLines, (ErrorKind, Summary)> {
+    use std::io::BufRead;
+
     let mut data = Vec::new();
 
     let mut config = config.clone();
-    config.set().write_mode(config::WriteMode::Modified);
-    let (summary, filemap, report) = format_input(input, &config, Some(&mut data))?;
+    config.set().emit_mode(config::EmitMode::ModifiedLines);
+    format_input(input, &config, Some(&mut data))?;
 
     let mut lines = data.lines();
     let mut chunks = Vec::new();
@@ -856,54 +1030,11 @@ pub fn get_modified_lines(
             lines: added_lines,
         });
     }
-    Ok(ModifiedLinesResult {
-        summary,
-        filemap,
-        report,
-        modified_lines: ModifiedLines { chunks },
-    })
-}
-
-#[derive(Debug)]
-pub enum Input {
-    File(PathBuf),
-    Text(String),
-}
-
-pub fn run(input: Input, config: &Config) -> Summary {
-    let out = &mut stdout();
-    output_header(out, config.write_mode()).ok();
-    match format_input(input, config, Some(out)) {
-        Ok((summary, _, report)) => {
-            output_footer(out, config.write_mode()).ok();
-
-            if report.has_warnings() {
-                match term::stderr() {
-                    Some(ref t)
-                        if use_colored_tty(config.color()) && t.supports_color()
-                            && t.supports_attr(term::Attr::Bold) =>
-                    {
-                        match report.print_warnings_fancy(term::stderr().unwrap()) {
-                            Ok(..) => (),
-                            Err(..) => panic!("Unable to write to stderr: {}", report),
-                        }
-                    }
-                    _ => msg!("{}", report),
-                }
-            }
-
-            summary
-        }
-        Err((msg, mut summary)) => {
-            msg!("Error writing files: {}", msg);
-            summary.add_operational_error();
-            summary
-        }
-    }
+    Ok(ModifiedLines { chunks })
 }
 
 #[cfg(test)]
-mod test {
+mod unit_tests {
     use super::{format_code_block, format_snippet, Config};
 
     #[test]
@@ -926,15 +1057,20 @@ fn test_format_inner<F>(formatter: F, input: &str, expected: &str) -> bool
     #[test]
     fn test_format_snippet() {
         let snippet = "fn main() { println!(\"hello, world\"); }";
+        #[cfg(not(windows))]
         let expected = "fn main() {\n    \
                         println!(\"hello, world\");\n\
                         }\n";
+        #[cfg(windows)]
+        let expected = "fn main() {\r\n    \
+                        println!(\"hello, world\");\r\n\
+                        }\r\n";
         assert!(test_format_inner(format_snippet, snippet, expected));
     }
 
     #[test]
     fn test_format_code_block_fail() {
-        #[rustfmt_skip]
+        #[rustfmt::skip]
         let code_block = "this_line_is_100_characters_long_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx(x, y, z);";
         assert!(format_code_block(code_block, &Config::default()).is_none());
     }