1use anyhow::Result;
2use buffer_diff::BufferDiff;
3use editor::{MultiBuffer, PathKey, multibuffer_context_lines};
4use gpui::{App, AppContext, AsyncApp, Context, Entity, Subscription, Task};
5use itertools::Itertools;
6use language::{
7 Anchor, Buffer, Capability, LanguageRegistry, OffsetRangeExt as _, Point, TextBuffer,
8};
9use std::{cmp::Reverse, ops::Range, path::Path, sync::Arc};
10use util::ResultExt;
11
12pub enum Diff {
13 Pending(PendingDiff),
14 Finalized(FinalizedDiff),
15}
16
17impl Diff {
18 pub fn finalized(
19 path: String,
20 old_text: Option<String>,
21 new_text: String,
22 language_registry: Arc<LanguageRegistry>,
23 cx: &mut Context<Self>,
24 ) -> Self {
25 let multibuffer = cx.new(|_cx| MultiBuffer::without_headers(Capability::ReadOnly));
26 let new_buffer = cx.new(|cx| Buffer::local(new_text, cx));
27 let base_text = old_text.clone().unwrap_or(String::new()).into();
28 let task = cx.spawn({
29 let multibuffer = multibuffer.clone();
30 let path = path.clone();
31 let buffer = new_buffer.clone();
32 async move |_, cx| {
33 let language = language_registry
34 .load_language_for_file_path(Path::new(&path))
35 .await
36 .log_err();
37
38 buffer.update(cx, |buffer, cx| buffer.set_language(language.clone(), cx))?;
39
40 let diff = build_buffer_diff(
41 old_text.unwrap_or("".into()).into(),
42 &buffer,
43 Some(language_registry.clone()),
44 cx,
45 )
46 .await?;
47
48 multibuffer
49 .update(cx, |multibuffer, cx| {
50 let hunk_ranges = {
51 let buffer = buffer.read(cx);
52 diff.read(cx)
53 .snapshot(cx)
54 .hunks_intersecting_range(
55 Anchor::min_for_buffer(buffer.remote_id())
56 ..Anchor::max_for_buffer(buffer.remote_id()),
57 buffer,
58 )
59 .map(|diff_hunk| diff_hunk.buffer_range.to_point(buffer))
60 .collect::<Vec<_>>()
61 };
62
63 multibuffer.set_excerpts_for_path(
64 PathKey::for_buffer(&buffer, cx),
65 buffer.clone(),
66 hunk_ranges,
67 multibuffer_context_lines(cx),
68 cx,
69 );
70 multibuffer.add_diff(diff, cx);
71 })
72 .log_err();
73
74 anyhow::Ok(())
75 }
76 });
77
78 Self::Finalized(FinalizedDiff {
79 multibuffer,
80 path,
81 base_text,
82 new_buffer,
83 _update_diff: task,
84 })
85 }
86
87 pub fn new(buffer: Entity<Buffer>, cx: &mut Context<Self>) -> Self {
88 let buffer_text_snapshot = buffer.read(cx).text_snapshot();
89 let buffer_diff = cx.new(|cx| {
90 let mut diff = BufferDiff::new_unchanged(&buffer_text_snapshot, cx);
91 let secondary_diff = cx.new(|cx| BufferDiff::new_unchanged(&buffer_text_snapshot, cx));
92 diff.set_secondary_diff(secondary_diff);
93 diff
94 });
95
96 let multibuffer = cx.new(|cx| {
97 let mut multibuffer = MultiBuffer::without_headers(Capability::ReadOnly);
98 multibuffer.add_diff(buffer_diff.clone(), cx);
99 multibuffer
100 });
101
102 Self::Pending(PendingDiff {
103 multibuffer,
104 base_text: Arc::from(buffer_text_snapshot.text().as_str()),
105 _subscription: cx.observe(&buffer, |this, _, cx| {
106 if let Diff::Pending(diff) = this {
107 diff.update(cx);
108 }
109 }),
110 new_buffer: buffer,
111 diff: buffer_diff,
112 revealed_ranges: Vec::new(),
113 update_diff: Task::ready(Ok(())),
114 })
115 }
116
117 pub fn reveal_range(&mut self, range: Range<Anchor>, cx: &mut Context<Self>) {
118 if let Self::Pending(diff) = self {
119 diff.reveal_range(range, cx);
120 }
121 }
122
123 pub fn finalize(&mut self, cx: &mut Context<Self>) {
124 if let Self::Pending(diff) = self {
125 *self = Self::Finalized(diff.finalize(cx));
126 }
127 }
128
129 pub fn multibuffer(&self) -> &Entity<MultiBuffer> {
130 match self {
131 Self::Pending(PendingDiff { multibuffer, .. }) => multibuffer,
132 Self::Finalized(FinalizedDiff { multibuffer, .. }) => multibuffer,
133 }
134 }
135
136 pub fn to_markdown(&self, cx: &App) -> String {
137 let buffer_text = self
138 .multibuffer()
139 .read(cx)
140 .all_buffers()
141 .iter()
142 .map(|buffer| buffer.read(cx).text())
143 .join("\n");
144 let path = match self {
145 Diff::Pending(PendingDiff {
146 new_buffer: buffer, ..
147 }) => buffer
148 .read(cx)
149 .file()
150 .map(|file| file.path().display(file.path_style(cx))),
151 Diff::Finalized(FinalizedDiff { path, .. }) => Some(path.as_str().into()),
152 };
153 format!(
154 "Diff: {}\n```\n{}\n```\n",
155 path.unwrap_or("untitled".into()),
156 buffer_text
157 )
158 }
159
160 pub fn has_revealed_range(&self, cx: &App) -> bool {
161 self.multibuffer().read(cx).paths().next().is_some()
162 }
163
164 pub fn needs_update(&self, old_text: &str, new_text: &str, cx: &App) -> bool {
165 match self {
166 Diff::Pending(PendingDiff {
167 base_text,
168 new_buffer,
169 ..
170 }) => {
171 base_text.as_ref() != old_text
172 || !new_buffer.read(cx).as_rope().chunks().equals_str(new_text)
173 }
174 Diff::Finalized(FinalizedDiff {
175 base_text,
176 new_buffer,
177 ..
178 }) => {
179 base_text.as_ref() != old_text
180 || !new_buffer.read(cx).as_rope().chunks().equals_str(new_text)
181 }
182 }
183 }
184}
185
186pub struct PendingDiff {
187 multibuffer: Entity<MultiBuffer>,
188 base_text: Arc<str>,
189 new_buffer: Entity<Buffer>,
190 diff: Entity<BufferDiff>,
191 revealed_ranges: Vec<Range<Anchor>>,
192 _subscription: Subscription,
193 update_diff: Task<Result<()>>,
194}
195
196impl PendingDiff {
197 pub fn update(&mut self, cx: &mut Context<Diff>) {
198 let buffer = self.new_buffer.clone();
199 let buffer_diff = self.diff.clone();
200 let base_text = self.base_text.clone();
201 self.update_diff = cx.spawn(async move |diff, cx| {
202 let text_snapshot = buffer.read_with(cx, |buffer, _| buffer.text_snapshot())?;
203 let language = buffer.read_with(cx, |buffer, _| buffer.language().cloned())?;
204 let update = buffer_diff
205 .update(cx, |diff, cx| {
206 diff.update_diff(
207 text_snapshot.clone(),
208 Some(base_text.clone()),
209 false,
210 language,
211 cx,
212 )
213 })?
214 .await;
215 buffer_diff.update(cx, |diff, cx| {
216 diff.set_snapshot(update.clone(), &text_snapshot, cx);
217 diff.secondary_diff().unwrap().update(cx, |diff, cx| {
218 diff.set_snapshot(update, &text_snapshot, cx);
219 });
220 })?;
221 diff.update(cx, |diff, cx| {
222 if let Diff::Pending(diff) = diff {
223 diff.update_visible_ranges(cx);
224 }
225 })
226 });
227 }
228
229 pub fn reveal_range(&mut self, range: Range<Anchor>, cx: &mut Context<Diff>) {
230 self.revealed_ranges.push(range);
231 self.update_visible_ranges(cx);
232 }
233
234 fn finalize(&self, cx: &mut Context<Diff>) -> FinalizedDiff {
235 let ranges = self.excerpt_ranges(cx);
236 let base_text = self.base_text.clone();
237 let new_buffer = self.new_buffer.read(cx);
238 let language_registry = new_buffer.language_registry();
239
240 let path = new_buffer
241 .file()
242 .map(|file| file.path().display(file.path_style(cx)))
243 .unwrap_or("untitled".into())
244 .into();
245 let replica_id = new_buffer.replica_id();
246
247 // Replace the buffer in the multibuffer with the snapshot
248 let buffer = cx.new(|cx| {
249 let language = self.new_buffer.read(cx).language().cloned();
250 let buffer = TextBuffer::new_normalized(
251 replica_id,
252 cx.entity_id().as_non_zero_u64().into(),
253 self.new_buffer.read(cx).line_ending(),
254 self.new_buffer.read(cx).as_rope().clone(),
255 );
256 let mut buffer = Buffer::build(buffer, None, Capability::ReadWrite);
257 buffer.set_language(language, cx);
258 buffer
259 });
260
261 let buffer_diff = cx.spawn({
262 let buffer = buffer.clone();
263 async move |_this, cx| {
264 build_buffer_diff(base_text, &buffer, language_registry, cx).await
265 }
266 });
267
268 let update_diff = cx.spawn(async move |this, cx| {
269 let buffer_diff = buffer_diff.await?;
270 this.update(cx, |this, cx| {
271 this.multibuffer().update(cx, |multibuffer, cx| {
272 let path_key = PathKey::for_buffer(&buffer, cx);
273 multibuffer.clear(cx);
274 multibuffer.set_excerpts_for_path(
275 path_key,
276 buffer,
277 ranges,
278 multibuffer_context_lines(cx),
279 cx,
280 );
281 multibuffer.add_diff(buffer_diff.clone(), cx);
282 });
283
284 cx.notify();
285 })
286 });
287
288 FinalizedDiff {
289 path,
290 base_text: self.base_text.clone(),
291 multibuffer: self.multibuffer.clone(),
292 new_buffer: self.new_buffer.clone(),
293 _update_diff: update_diff,
294 }
295 }
296
297 fn update_visible_ranges(&mut self, cx: &mut Context<Diff>) {
298 let ranges = self.excerpt_ranges(cx);
299 self.multibuffer.update(cx, |multibuffer, cx| {
300 multibuffer.set_excerpts_for_path(
301 PathKey::for_buffer(&self.new_buffer, cx),
302 self.new_buffer.clone(),
303 ranges,
304 multibuffer_context_lines(cx),
305 cx,
306 );
307 let end = multibuffer.len(cx);
308 Some(multibuffer.snapshot(cx).offset_to_point(end).row + 1)
309 });
310 cx.notify();
311 }
312
313 fn excerpt_ranges(&self, cx: &App) -> Vec<Range<Point>> {
314 let buffer = self.new_buffer.read(cx);
315 let mut ranges = self
316 .diff
317 .read(cx)
318 .snapshot(cx)
319 .hunks_intersecting_range(
320 Anchor::min_for_buffer(buffer.remote_id())
321 ..Anchor::max_for_buffer(buffer.remote_id()),
322 buffer,
323 )
324 .map(|diff_hunk| diff_hunk.buffer_range.to_point(buffer))
325 .collect::<Vec<_>>();
326 ranges.extend(
327 self.revealed_ranges
328 .iter()
329 .map(|range| range.to_point(buffer)),
330 );
331 ranges.sort_unstable_by_key(|range| (range.start, Reverse(range.end)));
332
333 // Merge adjacent ranges
334 let mut ranges = ranges.into_iter().peekable();
335 let mut merged_ranges = Vec::new();
336 while let Some(mut range) = ranges.next() {
337 while let Some(next_range) = ranges.peek() {
338 if range.end >= next_range.start {
339 range.end = range.end.max(next_range.end);
340 ranges.next();
341 } else {
342 break;
343 }
344 }
345
346 merged_ranges.push(range);
347 }
348 merged_ranges
349 }
350}
351
352pub struct FinalizedDiff {
353 path: String,
354 base_text: Arc<str>,
355 new_buffer: Entity<Buffer>,
356 multibuffer: Entity<MultiBuffer>,
357 _update_diff: Task<Result<()>>,
358}
359
360async fn build_buffer_diff(
361 old_text: Arc<str>,
362 buffer: &Entity<Buffer>,
363 language_registry: Option<Arc<LanguageRegistry>>,
364 cx: &mut AsyncApp,
365) -> Result<Entity<BufferDiff>> {
366 let language = cx.update(|cx| buffer.read(cx).language().cloned())?;
367 let buffer = cx.update(|cx| buffer.read(cx).snapshot())?;
368
369 let secondary_diff = cx.new(|cx| BufferDiff::new(&buffer, cx))?;
370
371 let update = secondary_diff
372 .update(cx, |secondary_diff, cx| {
373 secondary_diff.update_diff(
374 buffer.text.clone(),
375 Some(old_text),
376 true,
377 language.clone(),
378 cx,
379 )
380 })?
381 .await;
382
383 secondary_diff.update(cx, |secondary_diff, cx| {
384 secondary_diff.language_changed(language.clone(), language_registry.clone(), cx);
385 secondary_diff.set_snapshot(update.clone(), &buffer, cx);
386 })?;
387
388 let diff = cx.new(|cx| BufferDiff::new(&buffer, cx))?;
389 diff.update(cx, |diff, cx| {
390 diff.language_changed(language, language_registry, cx);
391 diff.set_snapshot(update.clone(), &buffer, cx);
392 diff.set_secondary_diff(secondary_diff);
393 })?;
394 Ok(diff)
395}
396
397#[cfg(test)]
398mod tests {
399 use gpui::{AppContext as _, TestAppContext};
400 use language::Buffer;
401
402 use crate::Diff;
403
404 #[gpui::test]
405 async fn test_pending_diff(cx: &mut TestAppContext) {
406 let buffer = cx.new(|cx| Buffer::local("hello!", cx));
407 let _diff = cx.new(|cx| Diff::new(buffer.clone(), cx));
408 buffer.update(cx, |buffer, cx| {
409 buffer.set_text("HELLO!", cx);
410 });
411 cx.run_until_parked();
412 }
413}