diff --git a/src/formatting.rs b/src/formatting.rs index 38440802ef2ea..9ec887ebbdff1 100644 --- a/src/formatting.rs +++ b/src/formatting.rs @@ -181,8 +181,12 @@ impl<'a, T: FormatHandler + 'a> FormatContext<'a, T> { self.report .add_non_formatted_ranges(visitor.skipped_range.clone()); - self.handler - .handle_formatted_file(path, visitor.buffer.to_owned(), &mut self.report) + self.handler.handle_formatted_file( + self.parse_session.source_map(), + path, + visitor.buffer.to_owned(), + &mut self.report, + ) } } @@ -190,6 +194,7 @@ impl<'a, T: FormatHandler + 'a> FormatContext<'a, T> { trait FormatHandler { fn handle_formatted_file( &mut self, + source_map: &SourceMap, path: FileName, result: String, report: &mut FormatReport, @@ -200,13 +205,14 @@ impl<'b, T: Write + 'b> FormatHandler for Session<'b, T> { // Called for each formatted file. fn handle_formatted_file( &mut self, + source_map: &SourceMap, path: FileName, result: String, report: &mut FormatReport, ) -> Result<(), ErrorKind> { if let Some(ref mut out) = self.out { - match source_file::write_file(&result, &path, out, &self.config) { - Ok(b) if b => report.add_diff(), + match source_file::write_file(Some(source_map), &path, &result, out, &self.config) { + Ok(has_diff) if has_diff => report.add_diff(), Err(e) => { // Create a new error with path_str to help users see which files failed let err_msg = format!("{}: {}", path, e); @@ -299,7 +305,7 @@ impl FormattingError { pub(crate) type FormatErrorMap = HashMap>; -#[derive(Default, Debug)] +#[derive(Default, Debug, PartialEq)] pub(crate) struct ReportedErrors { // Encountered e.g., an IO error. pub(crate) has_operational_errors: bool, @@ -332,25 +338,6 @@ impl ReportedErrors { } } -/// 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(crate) struct ModifiedChunk { - /// The first to be removed from the original text - pub line_number_orig: u32, - /// The number of lines which have been replaced - pub lines_removed: u32, - /// The new lines - pub lines: Vec, -} - -/// Set of changed sections of a file. -#[derive(Debug, PartialEq, Eq)] -pub(crate) struct ModifiedLines { - /// The set of changed chunks. - pub chunks: Vec, -} - #[derive(Clone, Copy, Debug)] enum Timer { Disabled, diff --git a/src/lib.rs b/src/lib.rs index 520a6e66fcd87..53e74210ede76 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -33,6 +33,8 @@ pub use crate::config::{ Range, Verbosity, }; +pub use crate::rustfmt_diff::{ModifiedChunk, ModifiedLines}; + #[macro_use] mod utils; diff --git a/src/rustfmt_diff.rs b/src/rustfmt_diff.rs index c6262dcab15e3..c83eb1080a630 100644 --- a/src/rustfmt_diff.rs +++ b/src/rustfmt_diff.rs @@ -1,4 +1,5 @@ use std::collections::VecDeque; +use std::fmt; use std::io; use std::io::Write; @@ -33,6 +34,116 @@ impl Mismatch { } } +/// 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 { + /// The first to be removed from the original text + pub line_number_orig: u32, + /// The number of lines which have been replaced + pub lines_removed: u32, + /// The new lines + pub lines: Vec, +} + +/// Set of changed sections of a file. +#[derive(Debug, PartialEq, Eq)] +pub struct ModifiedLines { + /// The set of changed chunks. + pub chunks: Vec, +} + +impl From> for ModifiedLines { + fn from(mismatches: Vec) -> ModifiedLines { + let chunks = mismatches.into_iter().map(|mismatch| { + let lines = mismatch.lines.iter(); + let num_removed = lines + .filter(|line| match line { + DiffLine::Resulting(_) => true, + _ => false, + }) + .count(); + + let new_lines = mismatch.lines.into_iter().filter_map(|line| match line { + DiffLine::Context(_) | DiffLine::Resulting(_) => None, + DiffLine::Expected(str) => Some(str), + }); + + ModifiedChunk { + line_number_orig: mismatch.line_number_orig, + lines_removed: num_removed as u32, + lines: new_lines.collect(), + } + }); + + ModifiedLines { + chunks: chunks.collect(), + } + } +} + +// Converts a `Mismatch` into a serialized form, which just includes +// enough information to modify the original file. +// Each section starts with a line with three integers, space separated: +// lineno num_removed num_added +// followed by (`num_added`) lines of added text. The line numbers are +// relative to the original file. +impl fmt::Display for ModifiedLines { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + for chunk in &self.chunks { + writeln!( + f, + "{} {} {}", + chunk.line_number_orig, + chunk.lines_removed, + chunk.lines.iter().count() + )?; + + for line in &chunk.lines { + writeln!(f, "{}", line)?; + } + } + + Ok(()) + } +} + +// Allows to convert `Display`ed `ModifiedLines` back to the structural data. +impl std::str::FromStr for ModifiedLines { + type Err = (); + + fn from_str(s: &str) -> Result { + let mut chunks = vec![]; + + let mut lines = s.lines(); + while let Some(header) = lines.next() { + let mut header = header.split_whitespace(); + let (orig, rem, new_lines) = match (header.next(), header.next(), header.next()) { + (Some(orig), Some(removed), Some(added)) => (orig, removed, added), + _ => return Err(()), + }; + let (orig, rem, new_lines): (u32, u32, usize) = + match (orig.parse(), rem.parse(), new_lines.parse()) { + (Ok(a), Ok(b), Ok(c)) => (a, b, c), + _ => return Err(()), + }; + let lines = lines.by_ref().take(new_lines); + let lines: Vec<_> = lines.map(ToOwned::to_owned).collect(); + if lines.len() != new_lines { + return Err(()); + } + + chunks.push(ModifiedChunk { + line_number_orig: orig, + lines_removed: rem, + lines, + }); + } + + Ok(ModifiedLines { chunks }) + } +} + // This struct handles writing output to stdout and abstracts away the logic // of printing in color, if it's possible in the executing environment. pub struct OutputWriter { @@ -174,49 +285,11 @@ where } } -/// Converts a `Mismatch` into a serialized form, which just includes -/// enough information to modify the original file. -/// Each section starts with a line with three integers, space separated: -/// lineno num_removed num_added -/// followed by (`num_added`) lines of added text. The line numbers are -/// relative to the original file. -pub fn output_modified(mut out: W, diff: Vec) -where - W: Write, -{ - for mismatch in diff { - let (num_removed, num_added) = - mismatch - .lines - .iter() - .fold((0, 0), |(rem, add), line| match *line { - DiffLine::Context(_) => panic!("No Context expected"), - DiffLine::Expected(_) => (rem, add + 1), - DiffLine::Resulting(_) => (rem + 1, add), - }); - // Write a header with enough information to separate the modified lines. - writeln!( - out, - "{} {} {}", - mismatch.line_number_orig, num_removed, num_added - ) - .unwrap(); - - for line in mismatch.lines { - match line { - DiffLine::Context(_) | DiffLine::Resulting(_) => (), - DiffLine::Expected(ref str) => { - writeln!(out, "{}", str).unwrap(); - } - } - } - } -} - #[cfg(test)] mod test { use super::DiffLine::*; use super::{make_diff, Mismatch}; + use super::{ModifiedChunk, ModifiedLines}; #[test] fn diff_simple() { @@ -298,4 +371,35 @@ mod test { }] ); } + + #[test] + fn modified_lines_from_str() { + use std::str::FromStr; + + let src = "1 6 2\nfn some() {}\nfn main() {}\n25 3 1\n struct Test {}"; + let lines = ModifiedLines::from_str(src).unwrap(); + assert_eq!( + lines, + ModifiedLines { + chunks: vec![ + ModifiedChunk { + line_number_orig: 1, + lines_removed: 6, + lines: vec!["fn some() {}".to_owned(), "fn main() {}".to_owned(),] + }, + ModifiedChunk { + line_number_orig: 25, + lines_removed: 3, + lines: vec![" struct Test {}".to_owned()] + } + ] + } + ); + + let src = "1 5 3"; + assert_eq!(ModifiedLines::from_str(src), Err(())); + + let src = "1 5 3\na\nb"; + assert_eq!(ModifiedLines::from_str(src), Err(())); + } } diff --git a/src/source_file.rs b/src/source_file.rs index 07c1e37fbedd7..a779c4dfbe27f 100644 --- a/src/source_file.rs +++ b/src/source_file.rs @@ -1,9 +1,12 @@ use std::fs; use std::io::{self, Write}; +use std::path::Path; + +use syntax::source_map::SourceMap; use crate::checkstyle::output_checkstyle_file; use crate::config::{Config, EmitMode, FileName, Verbosity}; -use crate::rustfmt_diff::{make_diff, output_modified, print_diff}; +use crate::rustfmt_diff::{make_diff, print_diff, ModifiedLines}; #[cfg(test)] use crate::formatting::FileRecord; @@ -26,7 +29,7 @@ where write!(out, "{}", crate::checkstyle::header())?; } for &(ref filename, ref text) in source_file { - write_file(text, filename, out, config)?; + write_file(None, filename, text, out, config)?; } if config.emit_mode() == EmitMode::Checkstyle { write!(out, "{}", crate::checkstyle::footer())?; @@ -36,24 +39,46 @@ where } pub fn write_file( - formatted_text: &str, + source_map: Option<&SourceMap>, filename: &FileName, + formatted_text: &str, out: &mut T, config: &Config, ) -> Result where T: Write, { - let filename_to_path = || match *filename { - FileName::Real(ref path) => path, - _ => panic!("cannot format `{}` and emit to files", filename), + fn ensure_real_path(filename: &FileName) -> &Path { + match *filename { + FileName::Real(ref path) => path, + _ => panic!("cannot format `{}` and emit to files", filename), + } + } + + impl From<&FileName> for syntax_pos::FileName { + fn from(filename: &FileName) -> syntax_pos::FileName { + match filename { + FileName::Real(path) => syntax_pos::FileName::Real(path.to_owned()), + FileName::Stdin => syntax_pos::FileName::Custom("stdin".to_owned()), + } + } + } + + // If parse session is around (cfg(not(test))) then try getting source from + // there instead of hitting the file system. This also supports getting + // original text for `FileName::Stdin`. + let original_text = source_map + .and_then(|x| x.get_source_file(&filename.into())) + .and_then(|x| x.src.as_ref().map(|x| x.to_string())); + let original_text = match original_text { + Some(ori) => ori, + None => fs::read_to_string(ensure_real_path(filename))?, }; match config.emit_mode() { EmitMode::Files if config.make_backup() => { - let filename = filename_to_path(); - let ori = fs::read_to_string(filename)?; - if ori != formatted_text { + let filename = ensure_real_path(filename); + if original_text != formatted_text { // Do a little dance to make writing safer - write to a temp file // rename the original to a .bk, then rename the temp file to the // original. @@ -67,9 +92,9 @@ where } EmitMode::Files => { // Write text directly over original file if there is a diff. - let filename = filename_to_path(); - let ori = fs::read_to_string(filename)?; - if ori != formatted_text { + let filename = ensure_real_path(filename); + + if original_text != formatted_text { fs::write(filename, formatted_text)?; } } @@ -80,27 +105,23 @@ where write!(out, "{}", formatted_text)?; } EmitMode::ModifiedLines => { - let filename = filename_to_path(); - let ori = fs::read_to_string(filename)?; - let mismatch = make_diff(&ori, formatted_text, 0); + let mismatch = make_diff(&original_text, formatted_text, 0); let has_diff = !mismatch.is_empty(); - output_modified(out, mismatch); + write!(out, "{}", ModifiedLines::from(mismatch))?; return Ok(has_diff); } EmitMode::Checkstyle => { - let filename = filename_to_path(); - let ori = fs::read_to_string(filename)?; - let diff = make_diff(&ori, formatted_text, 3); + let filename = ensure_real_path(filename); + + let diff = make_diff(&original_text, formatted_text, 3); output_checkstyle_file(out, filename, diff)?; } EmitMode::Diff => { - let filename = filename_to_path(); - let ori = fs::read_to_string(filename)?; - let mismatch = make_diff(&ori, formatted_text, 3); + let mismatch = make_diff(&original_text, formatted_text, 3); let has_diff = !mismatch.is_empty(); print_diff( mismatch, - |line_num| format!("Diff in {} at line {}:", filename.display(), line_num), + |line_num| format!("Diff in {} at line {}:", filename, line_num), config, ); return Ok(has_diff); diff --git a/src/test/mod.rs b/src/test/mod.rs index 2d1a62ceda591..1992190bb62e2 100644 --- a/src/test/mod.rs +++ b/src/test/mod.rs @@ -8,9 +8,9 @@ use std::path::{Path, PathBuf}; use std::process::{Command, Stdio}; use std::str::Chars; -use crate::config::{Color, Config, EmitMode, FileName, ReportTactic}; -use crate::formatting::{ModifiedChunk, SourceFile}; -use crate::rustfmt_diff::{make_diff, print_diff, DiffLine, Mismatch, OutputWriter}; +use crate::config::{Color, Config, EmitMode, FileName, NewlineStyle, ReportTactic}; +use crate::formatting::{ReportedErrors, SourceFile}; +use crate::rustfmt_diff::{make_diff, print_diff, DiffLine, Mismatch, ModifiedChunk, OutputWriter}; use crate::source_file; use crate::{FormatReport, Input, Session}; @@ -290,6 +290,30 @@ fn stdin_parser_panic_caught() { } } +/// Ensures that `EmitMode::ModifiedLines` works with input from `stdin`. Useful +/// when embedding Rustfmt (e.g. inside RLS). +#[test] +fn stdin_works_with_modified_lines() { + let input = "\nfn\n some( )\n{\n}\nfn main () {}\n"; + let output = "1 6 2\nfn some() {}\nfn main() {}\n"; + + let input = Input::Text(input.to_owned()); + let mut config = Config::default(); + config.set().newline_style(NewlineStyle::Unix); + config.set().emit_mode(EmitMode::ModifiedLines); + let mut buf: Vec = vec![]; + { + let mut session = Session::new(config, Some(&mut buf)); + session.format(input).unwrap(); + let errors = ReportedErrors { + has_diff: true, + ..Default::default() + }; + assert_eq!(session.errors, errors); + } + assert_eq!(buf, output.as_bytes()); +} + #[test] fn stdin_disable_all_formatting_test() { match option_env!("CFG_RELEASE_CHANNEL") {