Expose ModifiedLines and implement parsing data from the string output

This moves `Modified{Chunks,Lines}` from `src/formatting.rs` to
`src/rustfmt_diff.rs` and reexports it in `src/lib.rs`.

With this, a conversion from `Vec<Mismatch>` to `ModifiedLines` was implemented
and now this implements complementary `Display` and `FromStr`, which
simplified the previously used `output_modified` function and which allows to
parse the raw data emitted with `EmitMode::ModifiedLines`.
This commit is contained in:
Igor Matuszewski 2019-03-01 19:20:57 +01:00
parent 0437bf7a7d
commit b3c28dba83
5 changed files with 150 additions and 63 deletions

View File

@ -338,25 +338,6 @@ pub fn add(&mut self, other: &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<String>,
}
/// Set of changed sections of a file.
#[derive(Debug, PartialEq, Eq)]
pub(crate) struct ModifiedLines {
/// The set of changed chunks.
pub chunks: Vec<ModifiedChunk>,
}
#[derive(Clone, Copy, Debug)]
enum Timer {
Disabled,

View File

@ -33,7 +33,7 @@
Range, Verbosity,
};
pub use crate::rustfmt_diff::make_diff;
pub use crate::rustfmt_diff::{ModifiedChunk, ModifiedLines};
#[macro_use]
mod utils;

View File

@ -1,4 +1,5 @@
use std::collections::VecDeque;
use std::fmt;
use std::io;
use std::io::Write;
@ -33,6 +34,118 @@ fn new(line_number: u32, line_number_orig: u32) -> 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<String>,
}
/// Set of changed sections of a file.
#[derive(Debug, PartialEq, Eq)]
pub struct ModifiedLines {
/// The set of changed chunks.
pub chunks: Vec<ModifiedChunk>,
}
impl From<Vec<Mismatch>> for ModifiedLines {
fn from(mismatches: Vec<Mismatch>) -> 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<ModifiedLines, ()> {
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(()),
};
eprintln!("{} {} {}", orig, rem, new_lines);
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(()),
};
eprintln!("{} {} {}", orig, rem, new_lines);
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 +287,11 @@ pub fn print_diff<F>(diff: Vec<Mismatch>, get_section_title: F, config: &Config)
}
}
/// 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<W>(mut out: W, diff: Vec<Mismatch>)
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 +373,35 @@ fn diff_trailing_newline() {
}]
);
}
#[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(()));
}
}

View File

@ -6,7 +6,7 @@
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;
@ -107,7 +107,7 @@ fn from(filename: &FileName) -> syntax_pos::FileName {
EmitMode::ModifiedLines => {
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 => {

View File

@ -9,8 +9,8 @@
use std::str::Chars;
use crate::config::{Color, Config, EmitMode, FileName, ReportTactic};
use crate::formatting::{ModifiedChunk, ReportedErrors, SourceFile};
use crate::rustfmt_diff::{make_diff, print_diff, DiffLine, Mismatch, OutputWriter};
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};