1use std::ops::Range;
2
3use sum_tree::SumTree;
4use text::{Anchor, BufferSnapshot, OffsetRangeExt, Point};
5
6pub use git2 as libgit;
7use libgit::{DiffLineType as GitDiffLineType, DiffOptions as GitOptions, Patch as GitPatch};
8
9#[derive(Debug, Clone, Copy, PartialEq, Eq)]
10pub enum DiffHunkStatus {
11 Added,
12 Modified,
13 Removed,
14}
15
16#[derive(Debug, Clone, PartialEq, Eq)]
17pub struct DiffHunk<T> {
18 pub buffer_range: Range<T>,
19 pub head_byte_range: Range<usize>,
20}
21
22impl DiffHunk<u32> {
23 pub fn status(&self) -> DiffHunkStatus {
24 if self.head_byte_range.is_empty() {
25 DiffHunkStatus::Added
26 } else if self.buffer_range.is_empty() {
27 DiffHunkStatus::Removed
28 } else {
29 DiffHunkStatus::Modified
30 }
31 }
32}
33
34impl sum_tree::Item for DiffHunk<Anchor> {
35 type Summary = DiffHunkSummary;
36
37 fn summary(&self) -> Self::Summary {
38 DiffHunkSummary {
39 buffer_range: self.buffer_range.clone(),
40 }
41 }
42}
43
44#[derive(Debug, Default, Clone)]
45pub struct DiffHunkSummary {
46 buffer_range: Range<Anchor>,
47}
48
49impl sum_tree::Summary for DiffHunkSummary {
50 type Context = text::BufferSnapshot;
51
52 fn add_summary(&mut self, other: &Self, buffer: &Self::Context) {
53 self.buffer_range.start = self
54 .buffer_range
55 .start
56 .min(&other.buffer_range.start, buffer);
57 self.buffer_range.end = self.buffer_range.end.max(&other.buffer_range.end, buffer);
58 }
59}
60
61#[derive(Clone)]
62pub struct BufferDiff {
63 last_buffer_version: Option<clock::Global>,
64 tree: SumTree<DiffHunk<Anchor>>,
65}
66
67impl BufferDiff {
68 pub fn new() -> BufferDiff {
69 BufferDiff {
70 last_buffer_version: None,
71 tree: SumTree::new(),
72 }
73 }
74
75 pub fn hunks_in_range<'a>(
76 &'a self,
77 query_row_range: Range<u32>,
78 buffer: &'a BufferSnapshot,
79 ) -> impl 'a + Iterator<Item = DiffHunk<u32>> {
80 let start = buffer.anchor_before(Point::new(query_row_range.start, 0));
81 let end = buffer.anchor_after(Point::new(query_row_range.end, 0));
82
83 let mut cursor = self.tree.filter::<_, DiffHunkSummary>(move |summary| {
84 let before_start = summary.buffer_range.end.cmp(&start, buffer).is_lt();
85 let after_end = summary.buffer_range.start.cmp(&end, buffer).is_gt();
86 !before_start && !after_end
87 });
88
89 std::iter::from_fn(move || {
90 cursor.next(buffer);
91 let hunk = cursor.item()?;
92
93 let range = hunk.buffer_range.to_point(buffer);
94 let end_row = if range.end.column > 0 {
95 range.end.row + 1
96 } else {
97 range.end.row
98 };
99
100 Some(DiffHunk {
101 buffer_range: range.start.row..end_row,
102 head_byte_range: hunk.head_byte_range.clone(),
103 })
104 })
105 }
106
107 pub fn clear(&mut self, buffer: &text::BufferSnapshot) {
108 self.last_buffer_version = Some(buffer.version().clone());
109 self.tree = SumTree::new();
110 }
111
112 pub fn needs_update(&self, buffer: &text::BufferSnapshot) -> bool {
113 match &self.last_buffer_version {
114 Some(last) => buffer.version().changed_since(last),
115 None => true,
116 }
117 }
118
119 pub async fn update(&mut self, diff_base: &str, buffer: &text::BufferSnapshot) {
120 let mut tree = SumTree::new();
121
122 let buffer_text = buffer.as_rope().to_string();
123 let patch = Self::diff(&diff_base, &buffer_text);
124
125 if let Some(patch) = patch {
126 let mut divergence = 0;
127 for hunk_index in 0..patch.num_hunks() {
128 let hunk = Self::process_patch_hunk(&patch, hunk_index, buffer, &mut divergence);
129 tree.push(hunk, buffer);
130 }
131 }
132
133 self.tree = tree;
134 self.last_buffer_version = Some(buffer.version().clone());
135 }
136
137 #[cfg(test)]
138 fn hunks<'a>(&'a self, text: &'a BufferSnapshot) -> impl 'a + Iterator<Item = DiffHunk<u32>> {
139 self.hunks_in_range(0..u32::MAX, text)
140 }
141
142 fn diff<'a>(head: &'a str, current: &'a str) -> Option<GitPatch<'a>> {
143 let mut options = GitOptions::default();
144 options.context_lines(0);
145
146 let patch = GitPatch::from_buffers(
147 head.as_bytes(),
148 None,
149 current.as_bytes(),
150 None,
151 Some(&mut options),
152 );
153
154 match patch {
155 Ok(patch) => Some(patch),
156
157 Err(err) => {
158 log::error!("`GitPatch::from_buffers` failed: {}", err);
159 None
160 }
161 }
162 }
163
164 fn process_patch_hunk<'a>(
165 patch: &GitPatch<'a>,
166 hunk_index: usize,
167 buffer: &text::BufferSnapshot,
168 buffer_row_divergence: &mut i64,
169 ) -> DiffHunk<Anchor> {
170 let line_item_count = patch.num_lines_in_hunk(hunk_index).unwrap();
171 assert!(line_item_count > 0);
172
173 let mut first_deletion_buffer_row: Option<u32> = None;
174 let mut buffer_row_range: Option<Range<u32>> = None;
175 let mut head_byte_range: Option<Range<usize>> = None;
176
177 for line_index in 0..line_item_count {
178 let line = patch.line_in_hunk(hunk_index, line_index).unwrap();
179 let kind = line.origin_value();
180 let content_offset = line.content_offset() as isize;
181 let content_len = line.content().len() as isize;
182
183 if kind == GitDiffLineType::Addition {
184 *buffer_row_divergence += 1;
185 let row = line.new_lineno().unwrap().saturating_sub(1);
186
187 match &mut buffer_row_range {
188 Some(buffer_row_range) => buffer_row_range.end = row + 1,
189 None => buffer_row_range = Some(row..row + 1),
190 }
191 }
192
193 if kind == GitDiffLineType::Deletion {
194 *buffer_row_divergence -= 1;
195 let end = content_offset + content_len;
196
197 match &mut head_byte_range {
198 Some(head_byte_range) => head_byte_range.end = end as usize,
199 None => head_byte_range = Some(content_offset as usize..end as usize),
200 }
201
202 if first_deletion_buffer_row.is_none() {
203 let old_row = line.old_lineno().unwrap().saturating_sub(1);
204 let row = old_row as i64 + *buffer_row_divergence;
205 first_deletion_buffer_row = Some(row as u32);
206 }
207 }
208 }
209
210 //unwrap_or deletion without addition
211 let buffer_row_range = buffer_row_range.unwrap_or_else(|| {
212 //we cannot have an addition-less hunk without deletion(s) or else there would be no hunk
213 let row = first_deletion_buffer_row.unwrap();
214 row..row
215 });
216
217 //unwrap_or addition without deletion
218 let head_byte_range = head_byte_range.unwrap_or(0..0);
219
220 let start = Point::new(buffer_row_range.start, 0);
221 let end = Point::new(buffer_row_range.end, 0);
222 let buffer_range = buffer.anchor_before(start)..buffer.anchor_before(end);
223 DiffHunk {
224 buffer_range,
225 head_byte_range,
226 }
227 }
228}
229
230/// Range (crossing new lines), old, new
231#[cfg(any(test, feature = "test-support"))]
232#[track_caller]
233pub fn assert_hunks<Iter>(
234 diff_hunks: Iter,
235 buffer: &BufferSnapshot,
236 diff_base: &str,
237 expected_hunks: &[(Range<u32>, &str, &str)],
238) where
239 Iter: Iterator<Item = DiffHunk<u32>>,
240{
241 let actual_hunks = diff_hunks
242 .map(|hunk| {
243 (
244 hunk.buffer_range.clone(),
245 &diff_base[hunk.head_byte_range],
246 buffer
247 .text_for_range(
248 Point::new(hunk.buffer_range.start, 0)
249 ..Point::new(hunk.buffer_range.end, 0),
250 )
251 .collect::<String>(),
252 )
253 })
254 .collect::<Vec<_>>();
255
256 let expected_hunks: Vec<_> = expected_hunks
257 .iter()
258 .map(|(r, s, h)| (r.clone(), *s, h.to_string()))
259 .collect();
260
261 assert_eq!(actual_hunks, expected_hunks);
262}
263
264#[cfg(test)]
265mod tests {
266 use super::*;
267 use text::Buffer;
268 use unindent::Unindent as _;
269
270 #[test]
271 fn test_buffer_diff_simple() {
272 let diff_base = "
273 one
274 two
275 three
276 "
277 .unindent();
278
279 let buffer_text = "
280 one
281 HELLO
282 three
283 "
284 .unindent();
285
286 let mut buffer = Buffer::new(0, 0, buffer_text);
287 let mut diff = BufferDiff::new();
288 smol::block_on(diff.update(&diff_base, &buffer));
289 assert_hunks(
290 diff.hunks(&buffer),
291 &buffer,
292 &diff_base,
293 &[(1..2, "two\n", "HELLO\n")],
294 );
295
296 buffer.edit([(0..0, "point five\n")]);
297 smol::block_on(diff.update(&diff_base, &buffer));
298 assert_hunks(
299 diff.hunks(&buffer),
300 &buffer,
301 &diff_base,
302 &[(0..1, "", "point five\n"), (2..3, "two\n", "HELLO\n")],
303 );
304
305 diff.clear(&buffer);
306 assert_hunks(diff.hunks(&buffer), &buffer, &diff_base, &[]);
307 }
308
309 #[test]
310 fn test_buffer_diff_range() {
311 let diff_base = "
312 one
313 two
314 three
315 four
316 five
317 six
318 seven
319 eight
320 nine
321 ten
322 "
323 .unindent();
324
325 let buffer_text = "
326 A
327 one
328 B
329 two
330 C
331 three
332 HELLO
333 four
334 five
335 SIXTEEN
336 seven
337 eight
338 WORLD
339 nine
340
341 ten
342
343 "
344 .unindent();
345
346 let buffer = Buffer::new(0, 0, buffer_text);
347 let mut diff = BufferDiff::new();
348 smol::block_on(diff.update(&diff_base, &buffer));
349 assert_eq!(diff.hunks(&buffer).count(), 8);
350
351 assert_hunks(
352 diff.hunks_in_range(7..12, &buffer),
353 &buffer,
354 &diff_base,
355 &[
356 (6..7, "", "HELLO\n"),
357 (9..10, "six\n", "SIXTEEN\n"),
358 (12..13, "", "WORLD\n"),
359 ],
360 );
361 }
362}