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, 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>>, 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, 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_range_around(r.context),
282 primary: buffer_snapshot.anchor_range_around(r.primary),
283 })
284 .collect::<Vec<_>>();
285 self.update_path_excerpts(path, buffer, buffer_snapshot, &anchor_ranges, cx)
286 }
287
288 fn get_or_create_path_key_index(&mut self, path_key: &PathKey) -> PathKeyIndex {
289 let mut snapshot = self.snapshot.borrow_mut();
290 let existing = snapshot
291 .path_keys_by_index
292 .iter()
293 // todo!() perf? (but ExcerptIdMapping was doing this)
294 .find(|(_, existing_path)| existing_path == &path_key)
295 .map(|(index, _)| *index);
296
297 if let Some(existing) = existing {
298 return existing;
299 }
300
301 let index = snapshot
302 .path_keys_by_index
303 .last()
304 .map(|(index, _)| PathKeyIndex(index.0 + 1))
305 .unwrap_or(PathKeyIndex(0));
306 snapshot.path_keys_by_index.insert(index, path_key.clone());
307 index
308 }
309
310 // todo!() re-instate nonshrinking version for project diff / diagnostics
311 pub fn update_path_excerpts<'a>(
312 &mut self,
313 path_key: PathKey,
314 buffer: Entity<Buffer>,
315 buffer_snapshot: &BufferSnapshot,
316 to_insert: &Vec<ExcerptRange<text::Anchor>>,
317 cx: &mut Context<Self>,
318 ) -> (bool, PathKeyIndex) {
319 let path_key_index = self.get_or_create_path_key_index(&path_key);
320 if let Some(old_path_key) = self
321 .snapshot(cx)
322 .path_for_buffer(buffer_snapshot.remote_id())
323 && old_path_key != &path_key
324 {
325 self.remove_excerpts_for_path(old_path_key.clone(), cx);
326 }
327
328 if to_insert.len() == 0 {
329 self.remove_excerpts_for_path(path_key.clone(), cx);
330
331 return (false, path_key_index);
332 }
333 assert_eq!(self.history.transaction_depth(), 0);
334 self.sync_mut(cx);
335
336 let buffer_id = buffer_snapshot.remote_id();
337
338 self.buffers.entry(buffer_id).or_insert_with(|| {
339 self.buffer_changed_since_sync.replace(true);
340 buffer.update(cx, |buffer, _| {
341 buffer.record_changes(Rc::downgrade(&self.buffer_changed_since_sync));
342 });
343 BufferState {
344 _subscriptions: [
345 cx.observe(&buffer, |_, _, cx| cx.notify()),
346 cx.subscribe(&buffer, Self::on_buffer_event),
347 ],
348 buffer: buffer.clone(),
349 }
350 });
351
352 let mut snapshot = self.snapshot.get_mut();
353 let mut cursor = snapshot
354 .excerpts
355 .cursor::<Dimensions<PathKey, ExcerptOffset>>(());
356 let mut new_excerpts = SumTree::new(());
357
358 let mut to_insert = to_insert.iter().peekable();
359 let mut patch = Patch::empty();
360 let mut added_new_excerpt = false;
361
362 new_excerpts.append(cursor.slice(&path_key, Bias::Left), ());
363
364 // handle the case where the path key used to be associated
365 // with a different buffer by removing its excerpts.
366 if let Some(excerpt) = cursor.item()
367 && excerpt.path_key == path_key
368 && excerpt.buffer_id != buffer_id
369 {
370 let before = cursor.position.1;
371 cursor.seek_forward(&path_key, Bias::Right);
372 let after = cursor.position.1;
373 patch.push(Edit {
374 old: before..after,
375 new: new_excerpts.summary().len()..new_excerpts.summary().len(),
376 });
377 }
378
379 while let Some(excerpt) = cursor.item()
380 && excerpt.path_key == path_key
381 {
382 assert_eq!(excerpt.buffer_id, buffer_id);
383 let Some(next_excerpt) = to_insert.peek() else {
384 break;
385 };
386 if &excerpt.range == *next_excerpt {
387 new_excerpts.push(excerpt.clone(), ());
388 to_insert.next();
389 cursor.next();
390 continue;
391 }
392
393 if excerpt
394 .range
395 .context
396 .start
397 .cmp(&next_excerpt.context.start, &buffer_snapshot)
398 .is_le()
399 {
400 // remove old excerpt
401 let before = cursor.position.1;
402 cursor.next();
403 let after = cursor.position.1;
404 patch.push(Edit {
405 old: before..after,
406 new: new_excerpts.summary().len()..new_excerpts.summary().len(),
407 });
408 } else {
409 // insert new excerpt
410 let next_excerpt = to_insert.next().unwrap();
411 added_new_excerpt = true;
412 let before = new_excerpts.summary().len();
413 new_excerpts.push(
414 Excerpt::new(
415 path_key.clone(),
416 path_key_index,
417 &buffer_snapshot,
418 next_excerpt.clone(),
419 to_insert.peek().is_some(),
420 ),
421 (),
422 );
423 let after = new_excerpts.summary().len();
424 patch.push(Edit {
425 old: cursor.position.1..cursor.position.1,
426 new: before..after,
427 });
428 }
429 }
430
431 // remove any further trailing excerpts
432 let before = cursor.position.1;
433 cursor.seek_forward(&path_key, Bias::Right);
434 let after = cursor.position.1;
435 patch.push(Edit {
436 old: before..after,
437 new: new_excerpts.summary().len()..new_excerpts.summary().len(),
438 });
439
440 let suffix = cursor.suffix();
441 let changed_trailing_excerpt = suffix.is_empty();
442 new_excerpts.append(suffix, ());
443 drop(cursor);
444 snapshot.excerpts = new_excerpts;
445 snapshot.buffers.insert(
446 buffer_id,
447 BufferStateSnapshot {
448 path_key: path_key.clone(),
449 buffer_snapshot: buffer_snapshot.clone(),
450 },
451 );
452 if changed_trailing_excerpt {
453 snapshot.trailing_excerpt_update_count += 1;
454 }
455
456 let edits = Self::sync_diff_transforms(
457 &mut snapshot,
458 patch.into_inner(),
459 DiffChangeKind::BufferEdited,
460 );
461 if !edits.is_empty() {
462 self.subscriptions.publish(edits);
463 }
464
465 cx.emit(Event::Edited {
466 edited_buffer: None,
467 });
468 cx.emit(Event::BufferUpdated {
469 buffer,
470 path_key: path_key.clone(),
471 ranges: to_insert.map(|range| range.context.clone()).collect(),
472 });
473 cx.notify();
474
475 (added_new_excerpt, path_key_index)
476 }
477
478 pub fn remove_excerpts_for_path(&mut self, path: PathKey, cx: &mut Context<Self>) {
479 assert_eq!(self.history.transaction_depth(), 0);
480 self.sync_mut(cx);
481
482 let mut snapshot = self.snapshot.get_mut();
483 let mut cursor = snapshot
484 .excerpts
485 .cursor::<Dimensions<PathKey, ExcerptOffset>>(());
486 let mut new_excerpts = SumTree::new(());
487 new_excerpts.append(cursor.slice(&path, Bias::Left), ());
488 let edit_start = cursor.position.1;
489 let mut buffer_id = None;
490 if let Some(excerpt) = cursor.item()
491 && excerpt.path_key == path
492 {
493 buffer_id = Some(excerpt.buffer_id);
494 }
495 cursor.seek(&path, Bias::Right);
496 let edit_end = cursor.position.1;
497 let suffix = cursor.suffix();
498 let changed_trailing_excerpt = suffix.is_empty();
499 new_excerpts.append(suffix, ());
500
501 let edit = Edit {
502 old: edit_start..edit_end,
503 new: edit_start..edit_start,
504 };
505
506 if let Some(buffer_id) = buffer_id {
507 snapshot.buffers.remove(&buffer_id);
508 self.buffers.remove(&buffer_id);
509 cx.emit(Event::BuffersRemoved {
510 removed_buffer_ids: vec![buffer_id],
511 })
512 }
513 drop(cursor);
514 snapshot.excerpts = new_excerpts;
515 if changed_trailing_excerpt {
516 snapshot.trailing_excerpt_update_count += 1;
517 }
518
519 let edits =
520 Self::sync_diff_transforms(&mut snapshot, vec![edit], DiffChangeKind::BufferEdited);
521 if !edits.is_empty() {
522 self.subscriptions.publish(edits);
523 }
524
525 cx.emit(Event::Edited {
526 edited_buffer: None,
527 });
528 cx.notify();
529 }
530}