1use std::{mem, ops::Range, sync::Arc};
2
3use collections::HashSet;
4use gpui::{App, AppContext, Context, Entity};
5use itertools::Itertools;
6use language::{Buffer, BufferSnapshot};
7use rope::Point;
8use text::{Bias, BufferId, OffsetRangeExt, locator::Locator};
9use util::{post_inc, rel_path::RelPath};
10use ztracing::instrument;
11
12use crate::{
13 Anchor, ExcerptId, ExcerptRange, ExpandExcerptDirection, MultiBuffer, build_excerpt_ranges,
14};
15
16#[derive(Debug, Clone)]
17pub struct PathExcerptInsertResult {
18 pub excerpt_ids: Vec<ExcerptId>,
19 pub added_new_excerpt: bool,
20}
21
22#[derive(PartialEq, Eq, Ord, PartialOrd, Clone, Hash, Debug)]
23pub struct PathKey {
24 // Used by the derived PartialOrd & Ord
25 pub sort_prefix: Option<u64>,
26 pub path: Arc<RelPath>,
27}
28
29impl PathKey {
30 pub fn with_sort_prefix(sort_prefix: u64, path: Arc<RelPath>) -> Self {
31 Self {
32 sort_prefix: Some(sort_prefix),
33 path,
34 }
35 }
36
37 pub fn for_buffer(buffer: &Entity<Buffer>, cx: &App) -> Self {
38 if let Some(file) = buffer.read(cx).file() {
39 Self::with_sort_prefix(file.worktree_id(cx).to_proto(), file.path().clone())
40 } else {
41 Self {
42 sort_prefix: None,
43 path: RelPath::unix(&buffer.entity_id().to_string())
44 .unwrap()
45 .into_arc(),
46 }
47 }
48 }
49}
50
51impl MultiBuffer {
52 pub fn paths(&self) -> impl Iterator<Item = &PathKey> + '_ {
53 self.excerpts_by_path.keys()
54 }
55
56 pub fn excerpts_for_path(&self, path: &PathKey) -> impl '_ + Iterator<Item = ExcerptId> {
57 self.excerpts_by_path
58 .get(path)
59 .map(|excerpts| excerpts.as_slice())
60 .unwrap_or_default()
61 .iter()
62 .copied()
63 }
64
65 pub fn path_for_excerpt(&self, excerpt: ExcerptId) -> Option<PathKey> {
66 self.paths_by_excerpt.get(&excerpt).cloned()
67 }
68
69 pub fn remove_excerpts_for_path(&mut self, path: PathKey, cx: &mut Context<Self>) {
70 if let Some(to_remove) = self.excerpts_by_path.remove(&path) {
71 self.remove_excerpts(to_remove, cx)
72 }
73 }
74
75 pub fn buffer_for_path(&self, path: &PathKey, cx: &App) -> Option<Entity<Buffer>> {
76 let excerpt_id = self.excerpts_by_path.get(path)?.first()?;
77 let snapshot = self.read(cx);
78 let excerpt = snapshot.excerpt(*excerpt_id)?;
79 self.buffer(excerpt.buffer_id)
80 }
81
82 pub fn location_for_path(&self, path: &PathKey, cx: &App) -> Option<Anchor> {
83 let excerpt_id = self.excerpts_by_path.get(path)?.first()?;
84 let snapshot = self.read(cx);
85 let excerpt = snapshot.excerpt(*excerpt_id)?;
86 Some(Anchor::in_buffer(excerpt.id, excerpt.range.context.start))
87 }
88
89 /// Sets excerpts, returns `true` if at least one new excerpt was added.
90 #[instrument(skip_all)]
91 pub fn set_excerpts_for_path(
92 &mut self,
93 path: PathKey,
94 buffer: Entity<Buffer>,
95 ranges: impl IntoIterator<Item = Range<Point>>,
96 context_line_count: u32,
97 cx: &mut Context<Self>,
98 ) -> (Vec<Range<Anchor>>, bool) {
99 let buffer_snapshot = buffer.read(cx).snapshot();
100 let excerpt_ranges = build_excerpt_ranges(ranges, context_line_count, &buffer_snapshot);
101
102 let (new, counts) = Self::merge_excerpt_ranges(&excerpt_ranges);
103 self.set_merged_excerpt_ranges_for_path(
104 path,
105 buffer,
106 excerpt_ranges,
107 &buffer_snapshot,
108 new,
109 counts,
110 cx,
111 )
112 }
113
114 pub fn set_excerpt_ranges_for_path(
115 &mut self,
116 path: PathKey,
117 buffer: Entity<Buffer>,
118 buffer_snapshot: &BufferSnapshot,
119 excerpt_ranges: Vec<ExcerptRange<Point>>,
120 cx: &mut Context<Self>,
121 ) -> (Vec<Range<Anchor>>, bool) {
122 let (new, counts) = Self::merge_excerpt_ranges(&excerpt_ranges);
123 self.set_merged_excerpt_ranges_for_path(
124 path,
125 buffer,
126 excerpt_ranges,
127 buffer_snapshot,
128 new,
129 counts,
130 cx,
131 )
132 }
133
134 pub fn set_anchored_excerpts_for_path(
135 &self,
136 path_key: PathKey,
137 buffer: Entity<Buffer>,
138 ranges: Vec<Range<text::Anchor>>,
139 context_line_count: u32,
140 cx: &Context<Self>,
141 ) -> impl Future<Output = Vec<Range<Anchor>>> + use<> {
142 let buffer_snapshot = buffer.read(cx).snapshot();
143 let multi_buffer = cx.weak_entity();
144 let mut app = cx.to_async();
145 async move {
146 let snapshot = buffer_snapshot.clone();
147 let (excerpt_ranges, new, counts) = app
148 .background_spawn(async move {
149 let ranges = ranges.into_iter().map(|range| range.to_point(&snapshot));
150 let excerpt_ranges =
151 build_excerpt_ranges(ranges, context_line_count, &snapshot);
152 let (new, counts) = Self::merge_excerpt_ranges(&excerpt_ranges);
153 (excerpt_ranges, new, counts)
154 })
155 .await;
156
157 multi_buffer
158 .update(&mut app, move |multi_buffer, cx| {
159 let (ranges, _) = multi_buffer.set_merged_excerpt_ranges_for_path(
160 path_key,
161 buffer,
162 excerpt_ranges,
163 &buffer_snapshot,
164 new,
165 counts,
166 cx,
167 );
168 ranges
169 })
170 .ok()
171 .unwrap_or_default()
172 }
173 }
174
175 pub fn remove_excerpts_for_buffer(&mut self, buffer: BufferId, cx: &mut Context<Self>) {
176 self.remove_excerpts(
177 self.excerpts_for_buffer(buffer, cx)
178 .into_iter()
179 .map(|(excerpt, _)| excerpt),
180 cx,
181 );
182 }
183
184 pub(super) fn expand_excerpts_with_paths(
185 &mut self,
186 ids: impl IntoIterator<Item = ExcerptId>,
187 line_count: u32,
188 direction: ExpandExcerptDirection,
189 cx: &mut Context<Self>,
190 ) {
191 let grouped = ids
192 .into_iter()
193 .chunk_by(|id| self.paths_by_excerpt.get(id).cloned())
194 .into_iter()
195 .filter_map(|(k, v)| Some((k?, v.into_iter().collect::<Vec<_>>())))
196 .collect::<Vec<_>>();
197 let snapshot = self.snapshot(cx);
198
199 for (path, ids) in grouped.into_iter() {
200 let Some(excerpt_ids) = self.excerpts_by_path.get(&path) else {
201 continue;
202 };
203
204 let ids_to_expand = HashSet::from_iter(ids);
205 let mut excerpt_id_ = None;
206 let expanded_ranges = excerpt_ids.iter().filter_map(|excerpt_id| {
207 let excerpt = snapshot.excerpt(*excerpt_id)?;
208 let excerpt_id = excerpt.id;
209 if excerpt_id_.is_none() {
210 excerpt_id_ = Some(excerpt_id);
211 }
212
213 let mut context = excerpt.range.context.to_point(&excerpt.buffer);
214 if ids_to_expand.contains(&excerpt_id) {
215 match direction {
216 ExpandExcerptDirection::Up => {
217 context.start.row = context.start.row.saturating_sub(line_count);
218 context.start.column = 0;
219 }
220 ExpandExcerptDirection::Down => {
221 context.end.row =
222 (context.end.row + line_count).min(excerpt.buffer.max_point().row);
223 context.end.column = excerpt.buffer.line_len(context.end.row);
224 }
225 ExpandExcerptDirection::UpAndDown => {
226 context.start.row = context.start.row.saturating_sub(line_count);
227 context.start.column = 0;
228 context.end.row =
229 (context.end.row + line_count).min(excerpt.buffer.max_point().row);
230 context.end.column = excerpt.buffer.line_len(context.end.row);
231 }
232 }
233 }
234
235 Some(ExcerptRange {
236 context,
237 primary: excerpt.range.primary.to_point(&excerpt.buffer),
238 })
239 });
240 let mut merged_ranges: Vec<ExcerptRange<Point>> = Vec::new();
241 for range in expanded_ranges {
242 if let Some(last_range) = merged_ranges.last_mut()
243 && last_range.context.end >= range.context.start
244 {
245 last_range.context.end = range.context.end;
246 continue;
247 }
248 merged_ranges.push(range)
249 }
250 let Some(excerpt_id) = excerpt_id_ else {
251 continue;
252 };
253 let Some(buffer_id) = &snapshot.buffer_id_for_excerpt(excerpt_id) else {
254 continue;
255 };
256
257 let Some(buffer) = self.buffers.get(buffer_id).map(|b| b.buffer.clone()) else {
258 continue;
259 };
260
261 let buffer_snapshot = buffer.read(cx).snapshot();
262 self.update_path_excerpts(path.clone(), buffer, &buffer_snapshot, merged_ranges, cx);
263 }
264 }
265
266 /// Sets excerpts, returns `true` if at least one new excerpt was added.
267 fn set_merged_excerpt_ranges_for_path(
268 &mut self,
269 path: PathKey,
270 buffer: Entity<Buffer>,
271 ranges: Vec<ExcerptRange<Point>>,
272 buffer_snapshot: &BufferSnapshot,
273 new: Vec<ExcerptRange<Point>>,
274 counts: Vec<usize>,
275 cx: &mut Context<Self>,
276 ) -> (Vec<Range<Anchor>>, bool) {
277 let insert_result = self.update_path_excerpts(path, buffer, buffer_snapshot, new, cx);
278
279 let mut result = Vec::new();
280 let mut ranges = ranges.into_iter();
281 for (excerpt_id, range_count) in insert_result
282 .excerpt_ids
283 .into_iter()
284 .zip(counts.into_iter())
285 {
286 for range in ranges.by_ref().take(range_count) {
287 let range = Anchor::range_in_buffer(
288 excerpt_id,
289 buffer_snapshot.anchor_before(&range.primary.start)
290 ..buffer_snapshot.anchor_after(&range.primary.end),
291 );
292 result.push(range)
293 }
294 }
295 (result, insert_result.added_new_excerpt)
296 }
297
298 pub fn update_path_excerpts(
299 &mut self,
300 path: PathKey,
301 buffer: Entity<Buffer>,
302 buffer_snapshot: &BufferSnapshot,
303 new: Vec<ExcerptRange<Point>>,
304 cx: &mut Context<Self>,
305 ) -> PathExcerptInsertResult {
306 let mut insert_after = self
307 .excerpts_by_path
308 .range(..path.clone())
309 .next_back()
310 .and_then(|(_, value)| value.last().copied())
311 .unwrap_or(ExcerptId::min());
312
313 let existing = self
314 .excerpts_by_path
315 .get(&path)
316 .cloned()
317 .unwrap_or_default();
318 let mut new_iter = new.into_iter().peekable();
319 let mut existing_iter = existing.into_iter().peekable();
320
321 let mut excerpt_ids = Vec::new();
322 let mut to_remove = Vec::new();
323 let mut to_insert: Vec<(ExcerptId, ExcerptRange<Point>)> = Vec::new();
324 let mut added_a_new_excerpt = false;
325 let snapshot = self.snapshot(cx);
326
327 let mut next_excerpt_id =
328 if let Some(last_entry) = self.snapshot.get_mut().excerpt_ids.last() {
329 last_entry.id.0 + 1
330 } else {
331 1
332 };
333
334 let mut next_excerpt_id = move || ExcerptId(post_inc(&mut next_excerpt_id));
335
336 let mut excerpts_cursor = snapshot.excerpts.cursor::<Option<&Locator>>(());
337 excerpts_cursor.next();
338
339 loop {
340 let existing = if let Some(&existing_id) = existing_iter.peek() {
341 let locator = snapshot.excerpt_locator_for_id(existing_id);
342 excerpts_cursor.seek_forward(&Some(locator), Bias::Left);
343 if let Some(excerpt) = excerpts_cursor.item() {
344 if excerpt.buffer_id != buffer_snapshot.remote_id() {
345 to_remove.push(existing_id);
346 existing_iter.next();
347 continue;
348 }
349 Some((existing_id, excerpt.range.context.to_point(buffer_snapshot)))
350 } else {
351 None
352 }
353 } else {
354 None
355 };
356
357 let new = new_iter.peek();
358 // Try to merge the next new range or existing excerpt into the last
359 // queued insert.
360 if let Some((last_id, last)) = to_insert.last_mut() {
361 // Next new range overlaps the last queued insert: absorb it by
362 // extending the insert's end.
363 if let Some(new) = new
364 && last.context.end >= new.context.start
365 {
366 last.context.end = last.context.end.max(new.context.end);
367 excerpt_ids.push(*last_id);
368 new_iter.next();
369 continue;
370 }
371 // Next existing excerpt overlaps the last queued insert: absorb
372 // it by extending the insert's end, and record the existing
373 // excerpt as replaced so anchors in it resolve to the new one.
374 if let Some((existing_id, existing_range)) = &existing
375 && last.context.end >= existing_range.start
376 {
377 last.context.end = last.context.end.max(existing_range.end);
378 to_remove.push(*existing_id);
379 self.snapshot
380 .get_mut()
381 .replaced_excerpts
382 .insert(*existing_id, *last_id);
383 existing_iter.next();
384 continue;
385 }
386 }
387
388 match (new, existing) {
389 (None, None) => break,
390
391 // No more new ranges; remove the remaining existing excerpt.
392 (None, Some((existing_id, _))) => {
393 existing_iter.next();
394 to_remove.push(existing_id);
395 }
396
397 // No more existing excerpts; queue the new range for insertion.
398 (Some(_), None) => {
399 added_a_new_excerpt = true;
400 let new_id = next_excerpt_id();
401 excerpt_ids.push(new_id);
402 to_insert.push((new_id, new_iter.next().unwrap()));
403 }
404
405 // Existing excerpt ends before the new range starts, so it
406 // has no corresponding new range and must be removed. Flush
407 // pending inserts and advance `insert_after` past it so that
408 // future inserts receive locators *after* this excerpt's
409 // locator, preserving forward ordering.
410 (Some(new), Some((_, existing_range)))
411 if existing_range.end < new.context.start =>
412 {
413 self.insert_excerpts_with_ids_after(
414 insert_after,
415 buffer.clone(),
416 mem::take(&mut to_insert),
417 cx,
418 );
419 insert_after = existing_iter.next().unwrap();
420 to_remove.push(insert_after);
421 }
422 // New range ends before the existing excerpt starts, so the
423 // new range has no corresponding existing excerpt. Queue it
424 // for insertion at the current `insert_after` position
425 // (before the existing excerpt), which is the correct
426 // spatial ordering.
427 (Some(new), Some((_, existing_range)))
428 if existing_range.start > new.context.end =>
429 {
430 let new_id = next_excerpt_id();
431 excerpt_ids.push(new_id);
432 to_insert.push((new_id, new_iter.next().unwrap()));
433 }
434 // Exact match: keep the existing excerpt in place, flush
435 // any pending inserts before it, and use it as the new
436 // `insert_after` anchor.
437 (Some(new), Some((_, existing_range)))
438 if existing_range.start == new.context.start
439 && existing_range.end == new.context.end =>
440 {
441 self.insert_excerpts_with_ids_after(
442 insert_after,
443 buffer.clone(),
444 mem::take(&mut to_insert),
445 cx,
446 );
447 insert_after = existing_iter.next().unwrap();
448 excerpt_ids.push(insert_after);
449 new_iter.next();
450 }
451
452 // Partial overlap: replace the existing excerpt with a new
453 // one whose range is the union of both, and record the
454 // replacement so that anchors in the old excerpt resolve to
455 // the new one.
456 (Some(_), Some((_, existing_range))) => {
457 let existing_id = existing_iter.next().unwrap();
458 let new_id = next_excerpt_id();
459 self.snapshot
460 .get_mut()
461 .replaced_excerpts
462 .insert(existing_id, new_id);
463 to_remove.push(existing_id);
464 let mut range = new_iter.next().unwrap();
465 range.context.start = range.context.start.min(existing_range.start);
466 range.context.end = range.context.end.max(existing_range.end);
467 excerpt_ids.push(new_id);
468 to_insert.push((new_id, range));
469 }
470 };
471 }
472
473 self.insert_excerpts_with_ids_after(insert_after, buffer, to_insert, cx);
474 // todo(lw): There is a logic bug somewhere that causes the to_remove vector to be not ordered correctly
475 to_remove.sort_by_cached_key(|&id| snapshot.excerpt_locator_for_id(id));
476 self.remove_excerpts(to_remove, cx);
477
478 if excerpt_ids.is_empty() {
479 self.excerpts_by_path.remove(&path);
480 } else {
481 let snapshot = &*self.snapshot.get_mut();
482 let excerpt_ids = excerpt_ids
483 .iter()
484 .dedup()
485 .cloned()
486 // todo(lw): There is a logic bug somewhere that causes excerpt_ids to not necessarily be in order by locator
487 .sorted_by_cached_key(|&id| snapshot.excerpt_locator_for_id(id))
488 .collect();
489 for &excerpt_id in &excerpt_ids {
490 self.paths_by_excerpt.insert(excerpt_id, path.clone());
491 }
492 self.excerpts_by_path.insert(path, excerpt_ids);
493 }
494
495 PathExcerptInsertResult {
496 excerpt_ids,
497 added_new_excerpt: added_a_new_excerpt,
498 }
499 }
500}