1use std::{ops::Range, rc::Rc, sync::Arc};
2
3use gpui::{App, AppContext, Context, Entity};
4use itertools::Itertools;
5use language::{Buffer, BufferSnapshot};
6use rope::Point;
7use sum_tree::{Dimensions, SumTree};
8use text::{Bias, BufferId, Edit, OffsetRangeExt, Patch};
9use util::rel_path::RelPath;
10use ztracing::instrument;
11
12use crate::{
13 Anchor, BufferState, BufferStateSnapshot, DiffChangeKind, Event, Excerpt, ExcerptOffset,
14 ExcerptRange, ExcerptSummary, ExpandExcerptDirection, MultiBuffer, MultiBufferDimension,
15 PathKeyIndex, ToOffset, build_excerpt_ranges,
16};
17
18#[derive(PartialEq, Eq, Ord, PartialOrd, Clone, Hash, Debug)]
19pub struct PathKey {
20 // Used by the derived PartialOrd & Ord
21 pub sort_prefix: Option<u64>,
22 pub path: Arc<RelPath>,
23}
24
25impl PathKey {
26 pub fn min() -> Self {
27 Self {
28 sort_prefix: None,
29 path: RelPath::empty().into_arc(),
30 }
31 }
32
33 pub fn sorted(sort_prefix: u64) -> Self {
34 Self {
35 sort_prefix: Some(sort_prefix),
36 path: RelPath::empty().into_arc(),
37 }
38 }
39 pub fn with_sort_prefix(sort_prefix: u64, path: Arc<RelPath>) -> Self {
40 Self {
41 sort_prefix: Some(sort_prefix),
42 path,
43 }
44 }
45
46 pub fn for_buffer(buffer: &Entity<Buffer>, cx: &App) -> Self {
47 if let Some(file) = buffer.read(cx).file() {
48 Self::with_sort_prefix(file.worktree_id(cx).to_proto(), file.path().clone())
49 } else {
50 Self {
51 sort_prefix: None,
52 path: RelPath::unix(&buffer.entity_id().to_string())
53 .unwrap()
54 .into_arc(),
55 }
56 }
57 }
58}
59
60impl MultiBuffer {
61 pub fn buffer_for_path(&self, path: &PathKey, cx: &App) -> Option<Entity<Buffer>> {
62 let snapshot = self.snapshot(cx);
63 let excerpt = snapshot.excerpts_for_path(path).next()?;
64 self.buffer(excerpt.buffer_id)
65 }
66
67 pub fn location_for_path(&self, path: &PathKey, cx: &App) -> Option<Anchor> {
68 let snapshot = self.snapshot(cx);
69 let excerpt = snapshot.excerpts_for_path(path).next()?;
70 Some(Anchor::in_buffer(
71 excerpt.path_key_index,
72 excerpt.range.context.start,
73 ))
74 }
75
76 pub fn set_excerpts_for_buffer(
77 &mut self,
78 buffer: Entity<Buffer>,
79 ranges: impl IntoIterator<Item = Range<Point>>,
80 context_line_count: u32,
81 cx: &mut Context<Self>,
82 ) -> (Vec<Range<Anchor>>, bool) {
83 let path = PathKey::for_buffer(&buffer, cx);
84 self.set_excerpts_for_path(path, buffer, ranges, context_line_count, cx)
85 }
86
87 /// Sets excerpts, returns `true` if at least one new excerpt was added.
88 #[instrument(skip_all)]
89 pub fn set_excerpts_for_path(
90 &mut self,
91 path: PathKey,
92 buffer: Entity<Buffer>,
93 ranges: impl IntoIterator<Item = Range<Point>>,
94 context_line_count: u32,
95 cx: &mut Context<Self>,
96 ) -> (Vec<Range<Anchor>>, bool) {
97 let buffer_snapshot = buffer.read(cx).snapshot();
98 let ranges: Vec<_> = ranges.into_iter().collect();
99 let excerpt_ranges =
100 build_excerpt_ranges(ranges.clone(), context_line_count, &buffer_snapshot);
101
102 let merged = Self::merge_excerpt_ranges(&excerpt_ranges);
103 let (inserted, path_key_index) =
104 self.set_merged_excerpt_ranges_for_path(path, buffer, &buffer_snapshot, merged, cx);
105 // todo!() move this into the callers that care
106 let anchors = ranges
107 .into_iter()
108 .map(|range| {
109 Anchor::range_in_buffer(path_key_index, buffer_snapshot.anchor_range_around(range))
110 })
111 .collect::<Vec<_>>();
112 (anchors, inserted)
113 }
114
115 pub fn set_excerpt_ranges_for_path(
116 &mut self,
117 path: PathKey,
118 buffer: Entity<Buffer>,
119 buffer_snapshot: &BufferSnapshot,
120 excerpt_ranges: Vec<ExcerptRange<Point>>,
121 cx: &mut Context<Self>,
122 ) -> (Vec<Range<Anchor>>, PathKeyIndex, bool) {
123 let merged = Self::merge_excerpt_ranges(&excerpt_ranges);
124 let (inserted, path_key_index) =
125 self.set_merged_excerpt_ranges_for_path(path, buffer, buffer_snapshot, merged, cx);
126 // todo!() move this into the callers that care
127 let anchors = excerpt_ranges
128 .into_iter()
129 .map(|range| {
130 Anchor::range_in_buffer(
131 path_key_index,
132 buffer_snapshot.anchor_range_around(range.primary),
133 )
134 })
135 .collect::<Vec<_>>();
136 (anchors, path_key_index, inserted)
137 }
138
139 pub fn set_anchored_excerpts_for_path(
140 &self,
141 path_key: PathKey,
142 buffer: Entity<Buffer>,
143 ranges: Vec<Range<text::Anchor>>,
144 context_line_count: u32,
145 cx: &Context<Self>,
146 ) -> impl Future<Output = Vec<Range<Anchor>>> + use<> {
147 let buffer_snapshot = buffer.read(cx).snapshot();
148 let multi_buffer = cx.weak_entity();
149 let mut app = cx.to_async();
150 async move {
151 let snapshot = buffer_snapshot.clone();
152 let (ranges, merged_excerpt_ranges) = app
153 .background_spawn(async move {
154 let point_ranges = ranges.iter().map(|range| range.to_point(&snapshot));
155 let excerpt_ranges =
156 build_excerpt_ranges(point_ranges, context_line_count, &snapshot);
157 let merged = Self::merge_excerpt_ranges(&excerpt_ranges);
158 (ranges, merged)
159 })
160 .await;
161
162 multi_buffer
163 .update(&mut app, move |multi_buffer, cx| {
164 let (_, path_key_index) = multi_buffer.set_merged_excerpt_ranges_for_path(
165 path_key,
166 buffer,
167 &buffer_snapshot,
168 merged_excerpt_ranges,
169 cx,
170 );
171 ranges
172 .into_iter()
173 .map(|range| Anchor::range_in_buffer(path_key_index, range))
174 .collect()
175 })
176 .ok()
177 .unwrap_or_default()
178 }
179 }
180
181 pub(super) fn expand_excerpts_with_paths(
182 &mut self,
183 anchors: impl IntoIterator<Item = Anchor>,
184 line_count: u32,
185 direction: ExpandExcerptDirection,
186 cx: &mut Context<Self>,
187 ) {
188 let snapshot = self.snapshot(cx);
189 let mut sorted_anchors = anchors
190 .into_iter()
191 .filter_map(|anchor| anchor.excerpt_anchor())
192 .collect::<Vec<_>>();
193 sorted_anchors.sort_by(|a, b| a.cmp(b, &snapshot));
194 let buffers = sorted_anchors.into_iter().chunk_by(|anchor| anchor.path);
195 let mut cursor = snapshot.excerpts.cursor::<ExcerptSummary>(());
196
197 for (path_index, excerpt_anchors) in &buffers {
198 let path = snapshot
199 .path_keys_by_index
200 .get(&path_index)
201 .expect("anchor from wrong multibuffer");
202 let Some((buffer, buffer_snapshot)) = cursor
203 .item()
204 .map(|excerpt| (excerpt.buffer(&self), excerpt.buffer_snapshot(&snapshot)))
205 else {
206 continue;
207 };
208
209 let mut excerpt_anchors = excerpt_anchors.peekable();
210 let mut ranges = Vec::new();
211
212 cursor.seek_forward(path, Bias::Left);
213 while let Some(excerpt) = cursor.item()
214 && &excerpt.path_key == path
215 {
216 let mut range = ExcerptRange {
217 context: excerpt.range.context.to_point(buffer_snapshot),
218 primary: excerpt.range.primary.to_point(buffer_snapshot),
219 };
220
221 let mut needs_expand = false;
222 while excerpt_anchors.peek().is_some_and(|anchor| {
223 excerpt
224 .range
225 .contains(&anchor.text_anchor(), buffer_snapshot)
226 }) {
227 needs_expand = true;
228 excerpt_anchors.next();
229 }
230
231 if needs_expand {
232 match direction {
233 ExpandExcerptDirection::Up => {
234 range.context.start.row =
235 range.context.start.row.saturating_sub(line_count);
236 range.context.start.column = 0;
237 }
238 ExpandExcerptDirection::Down => {
239 range.context.end.row = (range.context.end.row + line_count)
240 .min(excerpt.buffer_snapshot(&snapshot).max_point().row);
241 range.context.end.column = excerpt
242 .buffer_snapshot(&snapshot)
243 .line_len(range.context.end.row);
244 }
245 ExpandExcerptDirection::UpAndDown => {
246 range.context.start.row =
247 range.context.start.row.saturating_sub(line_count);
248 range.context.start.column = 0;
249 range.context.end.row = (range.context.end.row + line_count)
250 .min(excerpt.buffer_snapshot(&snapshot).max_point().row);
251 range.context.end.column = excerpt
252 .buffer_snapshot(&snapshot)
253 .line_len(range.context.end.row);
254 }
255 }
256 }
257
258 ranges.push(range);
259 cursor.next();
260 }
261
262 self.set_excerpt_ranges_for_path(path.clone(), buffer, buffer_snapshot, ranges, cx);
263 }
264 }
265
266 /// Sets excerpts, returns `true` if at least one new excerpt was added.
267 pub(crate) fn set_merged_excerpt_ranges_for_path<T>(
268 &mut self,
269 path: PathKey,
270 buffer: Entity<Buffer>,
271 buffer_snapshot: &BufferSnapshot,
272 new: Vec<ExcerptRange<T>>,
273 cx: &mut Context<Self>,
274 ) -> (bool, PathKeyIndex)
275 where
276 T: language::ToOffset,
277 {
278 let anchor_ranges = new
279 .into_iter()
280 .map(|r| ExcerptRange {
281 context: buffer_snapshot.anchor_before(r.context.start)
282 ..buffer_snapshot.anchor_after(r.context.end),
283 primary: buffer_snapshot.anchor_before(r.primary.start)
284 ..buffer_snapshot.anchor_after(r.primary.end),
285 })
286 .collect::<Vec<_>>();
287 self.update_path_excerpts(path, buffer, buffer_snapshot, &anchor_ranges, cx)
288 }
289
290 fn get_or_create_path_key_index(&mut self, path_key: &PathKey) -> PathKeyIndex {
291 let mut snapshot = self.snapshot.borrow_mut();
292 let existing = snapshot
293 .path_keys_by_index
294 .iter()
295 // todo!() perf? (but ExcerptIdMapping was doing this)
296 .find(|(_, existing_path)| existing_path == &path_key)
297 .map(|(index, _)| *index);
298
299 if let Some(existing) = existing {
300 return existing;
301 }
302
303 let index = snapshot
304 .path_keys_by_index
305 .last()
306 .map(|(index, _)| PathKeyIndex(index.0 + 1))
307 .unwrap_or(PathKeyIndex(0));
308 snapshot.path_keys_by_index.insert(index, path_key.clone());
309 index
310 }
311
312 // todo!() re-instate nonshrinking version for project diff / diagnostics
313 pub fn update_path_excerpts<'a>(
314 &mut self,
315 path_key: PathKey,
316 buffer: Entity<Buffer>,
317 buffer_snapshot: &BufferSnapshot,
318 to_insert: &Vec<ExcerptRange<text::Anchor>>,
319 cx: &mut Context<Self>,
320 ) -> (bool, PathKeyIndex) {
321 let path_key_index = self.get_or_create_path_key_index(&path_key);
322 if let Some(old_path_key) = self
323 .snapshot(cx)
324 .path_for_buffer(buffer_snapshot.remote_id())
325 && old_path_key != &path_key
326 {
327 self.remove_excerpts_for_path(old_path_key.clone(), cx);
328 }
329
330 if to_insert.len() == 0 {
331 self.remove_excerpts_for_path(path_key.clone(), cx);
332
333 return (false, path_key_index);
334 }
335 assert_eq!(self.history.transaction_depth(), 0);
336 self.sync_mut(cx);
337
338 let buffer_id = buffer_snapshot.remote_id();
339
340 let mut snapshot = self.snapshot.get_mut();
341 let mut cursor = snapshot
342 .excerpts
343 .cursor::<Dimensions<PathKey, ExcerptOffset>>(());
344 let mut new_excerpts = SumTree::new(());
345
346 let new_ranges = to_insert.clone();
347 let mut to_insert = to_insert.iter().peekable();
348 let mut patch = Patch::empty();
349 let mut added_new_excerpt = false;
350
351 new_excerpts.append(cursor.slice(&path_key, Bias::Left), ());
352
353 // handle the case where the path key used to be associated
354 // with a different buffer by removing its excerpts.
355 if let Some(excerpt) = cursor.item()
356 && excerpt.path_key == path_key
357 && excerpt.buffer_id != buffer_id
358 {
359 let before = cursor.position.1;
360 cursor.seek_forward(&path_key, Bias::Right);
361 let after = cursor.position.1;
362 patch.push(Edit {
363 old: before..after,
364 new: new_excerpts.summary().len()..new_excerpts.summary().len(),
365 });
366 }
367
368 while let Some(excerpt) = cursor.item()
369 && excerpt.path_key == path_key
370 {
371 assert_eq!(excerpt.buffer_id, buffer_id);
372 let Some(next_excerpt) = to_insert.peek() else {
373 break;
374 };
375 if &excerpt.range == *next_excerpt {
376 new_excerpts.push(excerpt.clone(), ());
377 to_insert.next();
378 cursor.next();
379 continue;
380 }
381
382 if excerpt
383 .range
384 .context
385 .start
386 .cmp(&next_excerpt.context.start, &buffer_snapshot)
387 .is_le()
388 {
389 // remove old excerpt
390 let before = cursor.position.1;
391 cursor.next();
392 let after = cursor.position.1;
393 patch.push(Edit {
394 old: before..after,
395 new: new_excerpts.summary().len()..new_excerpts.summary().len(),
396 });
397 } else {
398 // insert new excerpt
399 let next_excerpt = to_insert.next().unwrap();
400 added_new_excerpt = true;
401 let before = new_excerpts.summary().len();
402 new_excerpts.update_last(|excerpt| excerpt.has_trailing_newline = true, ());
403 new_excerpts.push(
404 Excerpt::new(
405 path_key.clone(),
406 path_key_index,
407 &buffer_snapshot,
408 next_excerpt.clone(),
409 to_insert.peek().is_some() || cursor.item().is_some(),
410 ),
411 (),
412 );
413 let after = new_excerpts.summary().len();
414 patch.push_maybe_empty(Edit {
415 old: cursor.position.1..cursor.position.1,
416 new: before..after,
417 });
418 }
419 }
420
421 // remove any further trailing excerpts
422 let before = cursor.position.1;
423 cursor.seek_forward(&path_key, Bias::Right);
424 let after = cursor.position.1;
425 patch.push(Edit {
426 old: before..after,
427 new: new_excerpts.summary().len()..new_excerpts.summary().len(),
428 });
429
430 while let Some(next_excerpt) = to_insert.next() {
431 added_new_excerpt = true;
432 let before = new_excerpts.summary().len();
433 new_excerpts.update_last(|excerpt| excerpt.has_trailing_newline = true, ());
434 new_excerpts.push(
435 Excerpt::new(
436 path_key.clone(),
437 path_key_index,
438 &buffer_snapshot,
439 next_excerpt.clone(),
440 to_insert.peek().is_some() || cursor.item().is_some(),
441 ),
442 (),
443 );
444 let after = new_excerpts.summary().len();
445 patch.push_maybe_empty(Edit {
446 old: cursor.position.1..cursor.position.1,
447 new: before..after,
448 });
449 }
450
451 let suffix = cursor.suffix();
452 let changed_trailing_excerpt = suffix.is_empty();
453 new_excerpts.append(suffix, ());
454 drop(cursor);
455 snapshot.excerpts = new_excerpts;
456 snapshot.buffers.insert(
457 buffer_id,
458 BufferStateSnapshot {
459 path_key: path_key.clone(),
460 buffer_snapshot: buffer_snapshot.clone(),
461 },
462 );
463
464 self.buffers.entry(buffer_id).or_insert_with(|| {
465 self.buffer_changed_since_sync.replace(true);
466 buffer.update(cx, |buffer, _| {
467 buffer.record_changes(Rc::downgrade(&self.buffer_changed_since_sync));
468 });
469 BufferState {
470 _subscriptions: [
471 cx.observe(&buffer, |_, _, cx| cx.notify()),
472 cx.subscribe(&buffer, Self::on_buffer_event),
473 ],
474 buffer: buffer.clone(),
475 }
476 });
477
478 if changed_trailing_excerpt {
479 snapshot.trailing_excerpt_update_count += 1;
480 }
481
482 let edits = Self::sync_diff_transforms(
483 &mut snapshot,
484 dbg!(patch.into_inner()),
485 DiffChangeKind::BufferEdited,
486 );
487 if !edits.is_empty() {
488 self.subscriptions.publish(edits);
489 }
490
491 cx.emit(Event::Edited {
492 edited_buffer: None,
493 });
494 cx.emit(Event::BufferUpdated {
495 buffer,
496 path_key: path_key.clone(),
497 ranges: new_ranges,
498 });
499 cx.notify();
500
501 (added_new_excerpt, path_key_index)
502 }
503
504 pub fn remove_excerpts_for_buffer(&mut self, buffer: BufferId, cx: &mut Context<Self>) {
505 let snapshot = self.sync_mut(cx);
506 let Some(path) = snapshot.path_for_buffer(buffer).cloned() else {
507 return;
508 };
509 self.remove_excerpts_for_path(path, cx);
510 }
511
512 pub fn remove_excerpts_for_path(&mut self, path: PathKey, cx: &mut Context<Self>) {
513 assert_eq!(self.history.transaction_depth(), 0);
514 self.sync_mut(cx);
515
516 let mut snapshot = self.snapshot.get_mut();
517 let mut cursor = snapshot
518 .excerpts
519 .cursor::<Dimensions<PathKey, ExcerptOffset>>(());
520 let mut new_excerpts = SumTree::new(());
521 new_excerpts.append(cursor.slice(&path, Bias::Left), ());
522 let edit_start = cursor.position.1;
523 let mut buffer_id = None;
524 if let Some(excerpt) = cursor.item()
525 && excerpt.path_key == path
526 {
527 buffer_id = Some(excerpt.buffer_id);
528 }
529 cursor.seek(&path, Bias::Right);
530 let edit_end = cursor.position.1;
531 let suffix = cursor.suffix();
532 let changed_trailing_excerpt = suffix.is_empty();
533 new_excerpts.append(suffix, ());
534
535 let edit = Edit {
536 old: edit_start..edit_end,
537 new: edit_start..edit_start,
538 };
539
540 if let Some(buffer_id) = buffer_id {
541 snapshot.buffers.remove(&buffer_id);
542 self.buffers.remove(&buffer_id);
543 cx.emit(Event::BuffersRemoved {
544 removed_buffer_ids: vec![buffer_id],
545 })
546 }
547 drop(cursor);
548 if changed_trailing_excerpt {
549 snapshot.trailing_excerpt_update_count += 1;
550 new_excerpts.update_last(|excerpt| excerpt.has_trailing_newline = false, ())
551 }
552 snapshot.excerpts = new_excerpts;
553
554 let edits =
555 Self::sync_diff_transforms(&mut snapshot, vec![edit], DiffChangeKind::BufferEdited);
556 if !edits.is_empty() {
557 self.subscriptions.publish(edits);
558 }
559
560 cx.emit(Event::Edited {
561 edited_buffer: None,
562 });
563 cx.notify();
564 }
565}