1use super::TextHighlights;
2use crate::{
3 multi_buffer::MultiBufferRows, Anchor, AnchorRangeExt, MultiBufferChunks, MultiBufferSnapshot,
4 ToOffset,
5};
6use collections::BTreeMap;
7use gpui::fonts::HighlightStyle;
8use language::{Chunk, Edit, Point, PointUtf16, TextSummary};
9use parking_lot::Mutex;
10use std::{
11 any::TypeId,
12 cmp::{self, Ordering},
13 iter::{self, Peekable},
14 ops::{Range, Sub},
15 sync::atomic::{AtomicUsize, Ordering::SeqCst},
16 vec,
17};
18use sum_tree::{Bias, Cursor, FilterCursor, SumTree};
19
20#[derive(Copy, Clone, Debug, Default, Eq, Ord, PartialOrd, PartialEq)]
21pub struct FoldPoint(pub super::Point);
22
23impl FoldPoint {
24 pub fn new(row: u32, column: u32) -> Self {
25 Self(super::Point::new(row, column))
26 }
27
28 pub fn row(self) -> u32 {
29 self.0.row
30 }
31
32 pub fn column(self) -> u32 {
33 self.0.column
34 }
35
36 pub fn row_mut(&mut self) -> &mut u32 {
37 &mut self.0.row
38 }
39
40 pub fn column_mut(&mut self) -> &mut u32 {
41 &mut self.0.column
42 }
43
44 pub fn to_buffer_point(&self, snapshot: &FoldSnapshot) -> Point {
45 let mut cursor = snapshot.transforms.cursor::<(FoldPoint, Point)>();
46 cursor.seek(self, Bias::Right, &());
47 let overshoot = self.0 - cursor.start().0 .0;
48 cursor.start().1 + overshoot
49 }
50
51 pub fn to_buffer_offset(&self, snapshot: &FoldSnapshot) -> usize {
52 let mut cursor = snapshot.transforms.cursor::<(FoldPoint, Point)>();
53 cursor.seek(self, Bias::Right, &());
54 let overshoot = self.0 - cursor.start().0 .0;
55 snapshot
56 .buffer_snapshot
57 .point_to_offset(cursor.start().1 + overshoot)
58 }
59
60 pub fn to_offset(&self, snapshot: &FoldSnapshot) -> FoldOffset {
61 let mut cursor = snapshot
62 .transforms
63 .cursor::<(FoldPoint, TransformSummary)>();
64 cursor.seek(self, Bias::Right, &());
65 let overshoot = self.0 - cursor.start().1.output.lines;
66 let mut offset = cursor.start().1.output.bytes;
67 if !overshoot.is_zero() {
68 let transform = cursor.item().expect("display point out of range");
69 assert!(transform.output_text.is_none());
70 let end_buffer_offset = snapshot
71 .buffer_snapshot
72 .point_to_offset(cursor.start().1.input.lines + overshoot);
73 offset += end_buffer_offset - cursor.start().1.input.bytes;
74 }
75 FoldOffset(offset)
76 }
77}
78
79impl<'a> sum_tree::Dimension<'a, TransformSummary> for FoldPoint {
80 fn add_summary(&mut self, summary: &'a TransformSummary, _: &()) {
81 self.0 += &summary.output.lines;
82 }
83}
84
85pub struct FoldMapWriter<'a>(&'a mut FoldMap);
86
87impl<'a> FoldMapWriter<'a> {
88 pub fn fold<T: ToOffset>(
89 &mut self,
90 ranges: impl IntoIterator<Item = Range<T>>,
91 ) -> (FoldSnapshot, Vec<FoldEdit>) {
92 let mut edits = Vec::new();
93 let mut folds = Vec::new();
94 let buffer = self.0.buffer.lock().clone();
95 for range in ranges.into_iter() {
96 let range = range.start.to_offset(&buffer)..range.end.to_offset(&buffer);
97
98 // Ignore any empty ranges.
99 if range.start == range.end {
100 continue;
101 }
102
103 // For now, ignore any ranges that span an excerpt boundary.
104 let fold = Fold(buffer.anchor_after(range.start)..buffer.anchor_before(range.end));
105 if fold.0.start.excerpt_id() != fold.0.end.excerpt_id() {
106 continue;
107 }
108
109 folds.push(fold);
110 edits.push(text::Edit {
111 old: range.clone(),
112 new: range,
113 });
114 }
115
116 folds.sort_unstable_by(|a, b| sum_tree::SeekTarget::cmp(a, b, &buffer));
117
118 self.0.folds = {
119 let mut new_tree = SumTree::new();
120 let mut cursor = self.0.folds.cursor::<Fold>();
121 for fold in folds {
122 new_tree.push_tree(cursor.slice(&fold, Bias::Right, &buffer), &buffer);
123 new_tree.push(fold, &buffer);
124 }
125 new_tree.push_tree(cursor.suffix(&buffer), &buffer);
126 new_tree
127 };
128
129 consolidate_buffer_edits(&mut edits);
130 let edits = self.0.sync(buffer.clone(), edits);
131 let snapshot = FoldSnapshot {
132 transforms: self.0.transforms.lock().clone(),
133 folds: self.0.folds.clone(),
134 buffer_snapshot: buffer,
135 version: self.0.version.load(SeqCst),
136 };
137 (snapshot, edits)
138 }
139
140 pub fn unfold<T: ToOffset>(
141 &mut self,
142 ranges: impl IntoIterator<Item = Range<T>>,
143 inclusive: bool,
144 ) -> (FoldSnapshot, Vec<FoldEdit>) {
145 let mut edits = Vec::new();
146 let mut fold_ixs_to_delete = Vec::new();
147 let buffer = self.0.buffer.lock().clone();
148 for range in ranges.into_iter() {
149 // Remove intersecting folds and add their ranges to edits that are passed to sync.
150 let mut folds_cursor = intersecting_folds(&buffer, &self.0.folds, range, inclusive);
151 while let Some(fold) = folds_cursor.item() {
152 let offset_range = fold.0.start.to_offset(&buffer)..fold.0.end.to_offset(&buffer);
153 if offset_range.end > offset_range.start {
154 edits.push(text::Edit {
155 old: offset_range.clone(),
156 new: offset_range,
157 });
158 }
159 fold_ixs_to_delete.push(*folds_cursor.start());
160 folds_cursor.next(&buffer);
161 }
162 }
163
164 fold_ixs_to_delete.sort_unstable();
165 fold_ixs_to_delete.dedup();
166
167 self.0.folds = {
168 let mut cursor = self.0.folds.cursor::<usize>();
169 let mut folds = SumTree::new();
170 for fold_ix in fold_ixs_to_delete {
171 folds.push_tree(cursor.slice(&fold_ix, Bias::Right, &buffer), &buffer);
172 cursor.next(&buffer);
173 }
174 folds.push_tree(cursor.suffix(&buffer), &buffer);
175 folds
176 };
177
178 consolidate_buffer_edits(&mut edits);
179 let edits = self.0.sync(buffer.clone(), edits);
180 let snapshot = FoldSnapshot {
181 transforms: self.0.transforms.lock().clone(),
182 folds: self.0.folds.clone(),
183 buffer_snapshot: buffer,
184 version: self.0.version.load(SeqCst),
185 };
186 (snapshot, edits)
187 }
188}
189
190pub struct FoldMap {
191 buffer: Mutex<MultiBufferSnapshot>,
192 transforms: Mutex<SumTree<Transform>>,
193 folds: SumTree<Fold>,
194 version: AtomicUsize,
195}
196
197impl FoldMap {
198 pub fn new(buffer: MultiBufferSnapshot) -> (Self, FoldSnapshot) {
199 let this = Self {
200 buffer: Mutex::new(buffer.clone()),
201 folds: Default::default(),
202 transforms: Mutex::new(SumTree::from_item(
203 Transform {
204 summary: TransformSummary {
205 input: buffer.text_summary(),
206 output: buffer.text_summary(),
207 },
208 output_text: None,
209 },
210 &(),
211 )),
212 version: Default::default(),
213 };
214
215 let snapshot = FoldSnapshot {
216 transforms: this.transforms.lock().clone(),
217 folds: this.folds.clone(),
218 buffer_snapshot: this.buffer.lock().clone(),
219 version: this.version.load(SeqCst),
220 };
221 (this, snapshot)
222 }
223
224 pub fn read(
225 &self,
226 buffer: MultiBufferSnapshot,
227 edits: Vec<Edit<usize>>,
228 ) -> (FoldSnapshot, Vec<FoldEdit>) {
229 let edits = self.sync(buffer, edits);
230 self.check_invariants();
231 let snapshot = FoldSnapshot {
232 transforms: self.transforms.lock().clone(),
233 folds: self.folds.clone(),
234 buffer_snapshot: self.buffer.lock().clone(),
235 version: self.version.load(SeqCst),
236 };
237 (snapshot, edits)
238 }
239
240 pub fn write(
241 &mut self,
242 buffer: MultiBufferSnapshot,
243 edits: Vec<Edit<usize>>,
244 ) -> (FoldMapWriter, FoldSnapshot, Vec<FoldEdit>) {
245 let (snapshot, edits) = self.read(buffer, edits);
246 (FoldMapWriter(self), snapshot, edits)
247 }
248
249 fn check_invariants(&self) {
250 if cfg!(test) {
251 assert_eq!(
252 self.transforms.lock().summary().input.bytes,
253 self.buffer.lock().len(),
254 "transform tree does not match buffer's length"
255 );
256
257 let mut folds = self.folds.iter().peekable();
258 while let Some(fold) = folds.next() {
259 if let Some(next_fold) = folds.peek() {
260 let comparison = fold.0.cmp(&next_fold.0, &self.buffer.lock());
261 assert!(comparison.is_le());
262 }
263 }
264 }
265 }
266
267 fn sync(
268 &self,
269 new_buffer: MultiBufferSnapshot,
270 buffer_edits: Vec<text::Edit<usize>>,
271 ) -> Vec<FoldEdit> {
272 if buffer_edits.is_empty() {
273 let mut buffer = self.buffer.lock();
274 if buffer.parse_count() != new_buffer.parse_count()
275 || buffer.diagnostics_update_count() != new_buffer.diagnostics_update_count()
276 || buffer.trailing_excerpt_update_count()
277 != new_buffer.trailing_excerpt_update_count()
278 {
279 self.version.fetch_add(1, SeqCst);
280 }
281 *buffer = new_buffer;
282 Vec::new()
283 } else {
284 let mut buffer_edits_iter = buffer_edits.iter().cloned().peekable();
285
286 let mut new_transforms = SumTree::new();
287 let mut transforms = self.transforms.lock();
288 let mut cursor = transforms.cursor::<usize>();
289 cursor.seek(&0, Bias::Right, &());
290
291 while let Some(mut edit) = buffer_edits_iter.next() {
292 new_transforms.push_tree(cursor.slice(&edit.old.start, Bias::Left, &()), &());
293 edit.new.start -= edit.old.start - cursor.start();
294 edit.old.start = *cursor.start();
295
296 cursor.seek(&edit.old.end, Bias::Right, &());
297 cursor.next(&());
298
299 let mut delta = edit.new.len() as isize - edit.old.len() as isize;
300 loop {
301 edit.old.end = *cursor.start();
302
303 if let Some(next_edit) = buffer_edits_iter.peek() {
304 if next_edit.old.start > edit.old.end {
305 break;
306 }
307
308 let next_edit = buffer_edits_iter.next().unwrap();
309 delta += next_edit.new.len() as isize - next_edit.old.len() as isize;
310
311 if next_edit.old.end >= edit.old.end {
312 edit.old.end = next_edit.old.end;
313 cursor.seek(&edit.old.end, Bias::Right, &());
314 cursor.next(&());
315 }
316 } else {
317 break;
318 }
319 }
320
321 edit.new.end = ((edit.new.start + edit.old.len()) as isize + delta) as usize;
322
323 let anchor = new_buffer.anchor_before(edit.new.start);
324 let mut folds_cursor = self.folds.cursor::<Fold>();
325 folds_cursor.seek(&Fold(anchor..Anchor::max()), Bias::Left, &new_buffer);
326
327 let mut folds = iter::from_fn({
328 let buffer = &new_buffer;
329 move || {
330 let item = folds_cursor
331 .item()
332 .map(|f| f.0.start.to_offset(buffer)..f.0.end.to_offset(buffer));
333 folds_cursor.next(buffer);
334 item
335 }
336 })
337 .peekable();
338
339 while folds.peek().map_or(false, |fold| fold.start < edit.new.end) {
340 let mut fold = folds.next().unwrap();
341 let sum = new_transforms.summary();
342
343 assert!(fold.start >= sum.input.bytes);
344
345 while folds
346 .peek()
347 .map_or(false, |next_fold| next_fold.start <= fold.end)
348 {
349 let next_fold = folds.next().unwrap();
350 if next_fold.end > fold.end {
351 fold.end = next_fold.end;
352 }
353 }
354
355 if fold.start > sum.input.bytes {
356 let text_summary = new_buffer
357 .text_summary_for_range::<TextSummary, _>(sum.input.bytes..fold.start);
358 new_transforms.push(
359 Transform {
360 summary: TransformSummary {
361 output: text_summary.clone(),
362 input: text_summary,
363 },
364 output_text: None,
365 },
366 &(),
367 );
368 }
369
370 if fold.end > fold.start {
371 let output_text = "…";
372 let chars = output_text.chars().count() as u32;
373 let lines = Point::new(0, output_text.len() as u32);
374 let lines_utf16 =
375 PointUtf16::new(0, output_text.encode_utf16().count() as u32);
376 new_transforms.push(
377 Transform {
378 summary: TransformSummary {
379 output: TextSummary {
380 bytes: output_text.len(),
381 lines,
382 lines_utf16,
383 first_line_chars: chars,
384 last_line_chars: chars,
385 longest_row: 0,
386 longest_row_chars: chars,
387 },
388 input: new_buffer.text_summary_for_range(fold.start..fold.end),
389 },
390 output_text: Some(output_text),
391 },
392 &(),
393 );
394 }
395 }
396
397 let sum = new_transforms.summary();
398 if sum.input.bytes < edit.new.end {
399 let text_summary = new_buffer
400 .text_summary_for_range::<TextSummary, _>(sum.input.bytes..edit.new.end);
401 new_transforms.push(
402 Transform {
403 summary: TransformSummary {
404 output: text_summary.clone(),
405 input: text_summary,
406 },
407 output_text: None,
408 },
409 &(),
410 );
411 }
412 }
413
414 new_transforms.push_tree(cursor.suffix(&()), &());
415 if new_transforms.is_empty() {
416 let text_summary = new_buffer.text_summary();
417 new_transforms.push(
418 Transform {
419 summary: TransformSummary {
420 output: text_summary.clone(),
421 input: text_summary,
422 },
423 output_text: None,
424 },
425 &(),
426 );
427 }
428
429 drop(cursor);
430
431 let mut fold_edits = Vec::with_capacity(buffer_edits.len());
432 {
433 let mut old_transforms = transforms.cursor::<(usize, FoldOffset)>();
434 let mut new_transforms = new_transforms.cursor::<(usize, FoldOffset)>();
435
436 for mut edit in buffer_edits {
437 old_transforms.seek(&edit.old.start, Bias::Left, &());
438 if old_transforms.item().map_or(false, |t| t.is_fold()) {
439 edit.old.start = old_transforms.start().0;
440 }
441 let old_start =
442 old_transforms.start().1 .0 + (edit.old.start - old_transforms.start().0);
443
444 old_transforms.seek_forward(&edit.old.end, Bias::Right, &());
445 if old_transforms.item().map_or(false, |t| t.is_fold()) {
446 old_transforms.next(&());
447 edit.old.end = old_transforms.start().0;
448 }
449 let old_end =
450 old_transforms.start().1 .0 + (edit.old.end - old_transforms.start().0);
451
452 new_transforms.seek(&edit.new.start, Bias::Left, &());
453 if new_transforms.item().map_or(false, |t| t.is_fold()) {
454 edit.new.start = new_transforms.start().0;
455 }
456 let new_start =
457 new_transforms.start().1 .0 + (edit.new.start - new_transforms.start().0);
458
459 new_transforms.seek_forward(&edit.new.end, Bias::Right, &());
460 if new_transforms.item().map_or(false, |t| t.is_fold()) {
461 new_transforms.next(&());
462 edit.new.end = new_transforms.start().0;
463 }
464 let new_end =
465 new_transforms.start().1 .0 + (edit.new.end - new_transforms.start().0);
466
467 fold_edits.push(FoldEdit {
468 old: FoldOffset(old_start)..FoldOffset(old_end),
469 new: FoldOffset(new_start)..FoldOffset(new_end),
470 });
471 }
472
473 consolidate_fold_edits(&mut fold_edits);
474 }
475
476 *transforms = new_transforms;
477 *self.buffer.lock() = new_buffer;
478 self.version.fetch_add(1, SeqCst);
479 fold_edits
480 }
481 }
482}
483
484#[derive(Clone)]
485pub struct FoldSnapshot {
486 transforms: SumTree<Transform>,
487 folds: SumTree<Fold>,
488 buffer_snapshot: MultiBufferSnapshot,
489 pub version: usize,
490}
491
492impl FoldSnapshot {
493 pub fn buffer_snapshot(&self) -> &MultiBufferSnapshot {
494 &self.buffer_snapshot
495 }
496
497 #[cfg(test)]
498 pub fn text(&self) -> String {
499 self.chunks(FoldOffset(0)..self.len(), false, None)
500 .map(|c| c.text)
501 .collect()
502 }
503
504 #[cfg(test)]
505 pub fn fold_count(&self) -> usize {
506 self.folds.items(&self.buffer_snapshot).len()
507 }
508
509 pub fn text_summary_for_range(&self, range: Range<FoldPoint>) -> TextSummary {
510 let mut summary = TextSummary::default();
511
512 let mut cursor = self.transforms.cursor::<(FoldPoint, Point)>();
513 cursor.seek(&range.start, Bias::Right, &());
514 if let Some(transform) = cursor.item() {
515 let start_in_transform = range.start.0 - cursor.start().0 .0;
516 let end_in_transform = cmp::min(range.end, cursor.end(&()).0).0 - cursor.start().0 .0;
517 if let Some(output_text) = transform.output_text {
518 summary = TextSummary::from(
519 &output_text
520 [start_in_transform.column as usize..end_in_transform.column as usize],
521 );
522 } else {
523 let buffer_start = cursor.start().1 + start_in_transform;
524 let buffer_end = cursor.start().1 + end_in_transform;
525 summary = self
526 .buffer_snapshot
527 .text_summary_for_range(buffer_start..buffer_end);
528 }
529 }
530
531 if range.end > cursor.end(&()).0 {
532 cursor.next(&());
533 summary += &cursor
534 .summary::<_, TransformSummary>(&range.end, Bias::Right, &())
535 .output;
536 if let Some(transform) = cursor.item() {
537 let end_in_transform = range.end.0 - cursor.start().0 .0;
538 if let Some(output_text) = transform.output_text {
539 summary += TextSummary::from(&output_text[..end_in_transform.column as usize]);
540 } else {
541 let buffer_start = cursor.start().1;
542 let buffer_end = cursor.start().1 + end_in_transform;
543 summary += self
544 .buffer_snapshot
545 .text_summary_for_range::<TextSummary, _>(buffer_start..buffer_end);
546 }
547 }
548 }
549
550 summary
551 }
552
553 pub fn to_fold_point(&self, point: Point, bias: Bias) -> FoldPoint {
554 let mut cursor = self.transforms.cursor::<(Point, FoldPoint)>();
555 cursor.seek(&point, Bias::Right, &());
556 if cursor.item().map_or(false, |t| t.is_fold()) {
557 if bias == Bias::Left || point == cursor.start().0 {
558 cursor.start().1
559 } else {
560 cursor.end(&()).1
561 }
562 } else {
563 let overshoot = point - cursor.start().0;
564 FoldPoint(cmp::min(
565 cursor.start().1 .0 + overshoot,
566 cursor.end(&()).1 .0,
567 ))
568 }
569 }
570
571 pub fn len(&self) -> FoldOffset {
572 FoldOffset(self.transforms.summary().output.bytes)
573 }
574
575 pub fn line_len(&self, row: u32) -> u32 {
576 let line_start = FoldPoint::new(row, 0).to_offset(self).0;
577 let line_end = if row >= self.max_point().row() {
578 self.len().0
579 } else {
580 FoldPoint::new(row + 1, 0).to_offset(self).0 - 1
581 };
582 (line_end - line_start) as u32
583 }
584
585 pub fn buffer_rows(&self, start_row: u32) -> FoldBufferRows {
586 if start_row > self.transforms.summary().output.lines.row {
587 panic!("invalid display row {}", start_row);
588 }
589
590 let fold_point = FoldPoint::new(start_row, 0);
591 let mut cursor = self.transforms.cursor::<(FoldPoint, Point)>();
592 cursor.seek(&fold_point, Bias::Left, &());
593
594 let overshoot = fold_point.0 - cursor.start().0 .0;
595 let buffer_point = cursor.start().1 + overshoot;
596 let input_buffer_rows = self.buffer_snapshot.buffer_rows(buffer_point.row);
597
598 FoldBufferRows {
599 fold_point,
600 input_buffer_rows,
601 cursor,
602 }
603 }
604
605 pub fn max_point(&self) -> FoldPoint {
606 FoldPoint(self.transforms.summary().output.lines)
607 }
608
609 #[cfg(test)]
610 pub fn longest_row(&self) -> u32 {
611 self.transforms.summary().output.longest_row
612 }
613
614 pub fn folds_in_range<'a, T>(
615 &'a self,
616 range: Range<T>,
617 ) -> impl Iterator<Item = &'a Range<Anchor>>
618 where
619 T: ToOffset,
620 {
621 let mut folds = intersecting_folds(&self.buffer_snapshot, &self.folds, range, false);
622 iter::from_fn(move || {
623 let item = folds.item().map(|f| &f.0);
624 folds.next(&self.buffer_snapshot);
625 item
626 })
627 }
628
629 pub fn intersects_fold<T>(&self, offset: T) -> bool
630 where
631 T: ToOffset,
632 {
633 let offset = offset.to_offset(&self.buffer_snapshot);
634 let mut cursor = self.transforms.cursor::<usize>();
635 cursor.seek(&offset, Bias::Right, &());
636 cursor.item().map_or(false, |t| t.output_text.is_some())
637 }
638
639 pub fn is_line_folded(&self, output_row: u32) -> bool {
640 let mut cursor = self.transforms.cursor::<FoldPoint>();
641 cursor.seek(&FoldPoint::new(output_row, 0), Bias::Right, &());
642 while let Some(transform) = cursor.item() {
643 if transform.output_text.is_some() {
644 return true;
645 }
646 if cursor.end(&()).row() == output_row {
647 cursor.next(&())
648 } else {
649 break;
650 }
651 }
652 false
653 }
654
655 pub fn chars_at(&self, start: FoldPoint) -> impl '_ + Iterator<Item = char> {
656 let start = start.to_offset(self);
657 self.chunks(start..self.len(), false, None)
658 .flat_map(|chunk| chunk.text.chars())
659 }
660
661 pub fn chunks<'a>(
662 &'a self,
663 range: Range<FoldOffset>,
664 language_aware: bool,
665 text_highlights: Option<&'a TextHighlights>,
666 ) -> FoldChunks<'a> {
667 let mut highlight_endpoints = Vec::new();
668 let mut transform_cursor = self.transforms.cursor::<(FoldOffset, usize)>();
669
670 let buffer_end = {
671 transform_cursor.seek(&range.end, Bias::Right, &());
672 let overshoot = range.end.0 - transform_cursor.start().0 .0;
673 transform_cursor.start().1 + overshoot
674 };
675
676 let buffer_start = {
677 transform_cursor.seek(&range.start, Bias::Right, &());
678 let overshoot = range.start.0 - transform_cursor.start().0 .0;
679 transform_cursor.start().1 + overshoot
680 };
681
682 if let Some(text_highlights) = text_highlights {
683 if !text_highlights.is_empty() {
684 while transform_cursor.start().0 < range.end {
685 if !transform_cursor.item().unwrap().is_fold() {
686 let transform_start = self
687 .buffer_snapshot
688 .anchor_after(cmp::max(buffer_start, transform_cursor.start().1));
689
690 let transform_end = {
691 let overshoot = range.end.0 - transform_cursor.start().0 .0;
692 self.buffer_snapshot.anchor_before(cmp::min(
693 transform_cursor.end(&()).1,
694 transform_cursor.start().1 + overshoot,
695 ))
696 };
697
698 for (tag, highlights) in text_highlights.iter() {
699 let style = highlights.0;
700 let ranges = &highlights.1;
701
702 let start_ix = match ranges.binary_search_by(|probe| {
703 let cmp = probe.end.cmp(&transform_start, &self.buffer_snapshot());
704 if cmp.is_gt() {
705 Ordering::Greater
706 } else {
707 Ordering::Less
708 }
709 }) {
710 Ok(i) | Err(i) => i,
711 };
712 for range in &ranges[start_ix..] {
713 if range
714 .start
715 .cmp(&transform_end, &self.buffer_snapshot)
716 .is_ge()
717 {
718 break;
719 }
720
721 highlight_endpoints.push(HighlightEndpoint {
722 offset: range.start.to_offset(&self.buffer_snapshot),
723 is_start: true,
724 tag: *tag,
725 style,
726 });
727 highlight_endpoints.push(HighlightEndpoint {
728 offset: range.end.to_offset(&self.buffer_snapshot),
729 is_start: false,
730 tag: *tag,
731 style,
732 });
733 }
734 }
735 }
736
737 transform_cursor.next(&());
738 }
739 highlight_endpoints.sort();
740 transform_cursor.seek(&range.start, Bias::Right, &());
741 }
742 }
743
744 FoldChunks {
745 transform_cursor,
746 buffer_chunks: self
747 .buffer_snapshot
748 .chunks(buffer_start..buffer_end, language_aware),
749 buffer_chunk: None,
750 buffer_offset: buffer_start,
751 output_offset: range.start.0,
752 max_output_offset: range.end.0,
753 highlight_endpoints: highlight_endpoints.into_iter().peekable(),
754 active_highlights: Default::default(),
755 }
756 }
757
758 #[cfg(test)]
759 pub fn clip_offset(&self, offset: FoldOffset, bias: Bias) -> FoldOffset {
760 let mut cursor = self.transforms.cursor::<(FoldOffset, usize)>();
761 cursor.seek(&offset, Bias::Right, &());
762 if let Some(transform) = cursor.item() {
763 let transform_start = cursor.start().0 .0;
764 if transform.output_text.is_some() {
765 if offset.0 == transform_start || matches!(bias, Bias::Left) {
766 FoldOffset(transform_start)
767 } else {
768 FoldOffset(cursor.end(&()).0 .0)
769 }
770 } else {
771 let overshoot = offset.0 - transform_start;
772 let buffer_offset = cursor.start().1 + overshoot;
773 let clipped_buffer_offset = self.buffer_snapshot.clip_offset(buffer_offset, bias);
774 FoldOffset(
775 (offset.0 as isize + (clipped_buffer_offset as isize - buffer_offset as isize))
776 as usize,
777 )
778 }
779 } else {
780 FoldOffset(self.transforms.summary().output.bytes)
781 }
782 }
783
784 pub fn clip_point(&self, point: FoldPoint, bias: Bias) -> FoldPoint {
785 let mut cursor = self.transforms.cursor::<(FoldPoint, Point)>();
786 cursor.seek(&point, Bias::Right, &());
787 if let Some(transform) = cursor.item() {
788 let transform_start = cursor.start().0 .0;
789 if transform.output_text.is_some() {
790 if point.0 == transform_start || matches!(bias, Bias::Left) {
791 FoldPoint(transform_start)
792 } else {
793 FoldPoint(cursor.end(&()).0 .0)
794 }
795 } else {
796 let overshoot = point.0 - transform_start;
797 let buffer_position = cursor.start().1 + overshoot;
798 let clipped_buffer_position =
799 self.buffer_snapshot.clip_point(buffer_position, bias);
800 FoldPoint(cursor.start().0 .0 + (clipped_buffer_position - cursor.start().1))
801 }
802 } else {
803 FoldPoint(self.transforms.summary().output.lines)
804 }
805 }
806}
807
808fn intersecting_folds<'a, T>(
809 buffer: &'a MultiBufferSnapshot,
810 folds: &'a SumTree<Fold>,
811 range: Range<T>,
812 inclusive: bool,
813) -> FilterCursor<'a, impl 'a + FnMut(&FoldSummary) -> bool, Fold, usize>
814where
815 T: ToOffset,
816{
817 let start = buffer.anchor_before(range.start.to_offset(buffer));
818 let end = buffer.anchor_after(range.end.to_offset(buffer));
819 let mut cursor = folds.filter::<_, usize>(move |summary| {
820 let start_cmp = start.cmp(&summary.max_end, buffer);
821 let end_cmp = end.cmp(&summary.min_start, buffer);
822
823 if inclusive {
824 start_cmp <= Ordering::Equal && end_cmp >= Ordering::Equal
825 } else {
826 start_cmp == Ordering::Less && end_cmp == Ordering::Greater
827 }
828 });
829 cursor.next(buffer);
830 cursor
831}
832
833fn consolidate_buffer_edits(edits: &mut Vec<text::Edit<usize>>) {
834 edits.sort_unstable_by(|a, b| {
835 a.old
836 .start
837 .cmp(&b.old.start)
838 .then_with(|| b.old.end.cmp(&a.old.end))
839 });
840
841 let mut i = 1;
842 while i < edits.len() {
843 let edit = edits[i].clone();
844 let prev_edit = &mut edits[i - 1];
845 if prev_edit.old.end >= edit.old.start {
846 prev_edit.old.end = prev_edit.old.end.max(edit.old.end);
847 prev_edit.new.start = prev_edit.new.start.min(edit.new.start);
848 prev_edit.new.end = prev_edit.new.end.max(edit.new.end);
849 edits.remove(i);
850 continue;
851 }
852 i += 1;
853 }
854}
855
856fn consolidate_fold_edits(edits: &mut Vec<FoldEdit>) {
857 edits.sort_unstable_by(|a, b| {
858 a.old
859 .start
860 .cmp(&b.old.start)
861 .then_with(|| b.old.end.cmp(&a.old.end))
862 });
863
864 let mut i = 1;
865 while i < edits.len() {
866 let edit = edits[i].clone();
867 let prev_edit = &mut edits[i - 1];
868 if prev_edit.old.end >= edit.old.start {
869 prev_edit.old.end = prev_edit.old.end.max(edit.old.end);
870 prev_edit.new.start = prev_edit.new.start.min(edit.new.start);
871 prev_edit.new.end = prev_edit.new.end.max(edit.new.end);
872 edits.remove(i);
873 continue;
874 }
875 i += 1;
876 }
877}
878
879#[derive(Clone, Debug, Default, Eq, PartialEq)]
880struct Transform {
881 summary: TransformSummary,
882 output_text: Option<&'static str>,
883}
884
885impl Transform {
886 fn is_fold(&self) -> bool {
887 self.output_text.is_some()
888 }
889}
890
891#[derive(Clone, Debug, Default, Eq, PartialEq)]
892struct TransformSummary {
893 output: TextSummary,
894 input: TextSummary,
895}
896
897impl sum_tree::Item for Transform {
898 type Summary = TransformSummary;
899
900 fn summary(&self) -> Self::Summary {
901 self.summary.clone()
902 }
903}
904
905impl sum_tree::Summary for TransformSummary {
906 type Context = ();
907
908 fn add_summary(&mut self, other: &Self, _: &()) {
909 self.input += &other.input;
910 self.output += &other.output;
911 }
912}
913
914#[derive(Clone, Debug)]
915struct Fold(Range<Anchor>);
916
917impl Default for Fold {
918 fn default() -> Self {
919 Self(Anchor::min()..Anchor::max())
920 }
921}
922
923impl sum_tree::Item for Fold {
924 type Summary = FoldSummary;
925
926 fn summary(&self) -> Self::Summary {
927 FoldSummary {
928 start: self.0.start.clone(),
929 end: self.0.end.clone(),
930 min_start: self.0.start.clone(),
931 max_end: self.0.end.clone(),
932 count: 1,
933 }
934 }
935}
936
937#[derive(Clone, Debug)]
938struct FoldSummary {
939 start: Anchor,
940 end: Anchor,
941 min_start: Anchor,
942 max_end: Anchor,
943 count: usize,
944}
945
946impl Default for FoldSummary {
947 fn default() -> Self {
948 Self {
949 start: Anchor::min(),
950 end: Anchor::max(),
951 min_start: Anchor::max(),
952 max_end: Anchor::min(),
953 count: 0,
954 }
955 }
956}
957
958impl sum_tree::Summary for FoldSummary {
959 type Context = MultiBufferSnapshot;
960
961 fn add_summary(&mut self, other: &Self, buffer: &MultiBufferSnapshot) {
962 if other.min_start.cmp(&self.min_start, buffer) == Ordering::Less {
963 self.min_start = other.min_start.clone();
964 }
965 if other.max_end.cmp(&self.max_end, buffer) == Ordering::Greater {
966 self.max_end = other.max_end.clone();
967 }
968
969 #[cfg(debug_assertions)]
970 {
971 let start_comparison = self.start.cmp(&other.start, buffer);
972 assert!(start_comparison <= Ordering::Equal);
973 if start_comparison == Ordering::Equal {
974 assert!(self.end.cmp(&other.end, buffer) >= Ordering::Equal);
975 }
976 }
977
978 self.start = other.start.clone();
979 self.end = other.end.clone();
980 self.count += other.count;
981 }
982}
983
984impl<'a> sum_tree::Dimension<'a, FoldSummary> for Fold {
985 fn add_summary(&mut self, summary: &'a FoldSummary, _: &MultiBufferSnapshot) {
986 self.0.start = summary.start.clone();
987 self.0.end = summary.end.clone();
988 }
989}
990
991impl<'a> sum_tree::SeekTarget<'a, FoldSummary, Fold> for Fold {
992 fn cmp(&self, other: &Self, buffer: &MultiBufferSnapshot) -> Ordering {
993 self.0.cmp(&other.0, buffer)
994 }
995}
996
997impl<'a> sum_tree::Dimension<'a, FoldSummary> for usize {
998 fn add_summary(&mut self, summary: &'a FoldSummary, _: &MultiBufferSnapshot) {
999 *self += summary.count;
1000 }
1001}
1002
1003pub struct FoldBufferRows<'a> {
1004 cursor: Cursor<'a, Transform, (FoldPoint, Point)>,
1005 input_buffer_rows: MultiBufferRows<'a>,
1006 fold_point: FoldPoint,
1007}
1008
1009impl<'a> Iterator for FoldBufferRows<'a> {
1010 type Item = Option<u32>;
1011
1012 fn next(&mut self) -> Option<Self::Item> {
1013 let mut traversed_fold = false;
1014 while self.fold_point > self.cursor.end(&()).0 {
1015 self.cursor.next(&());
1016 traversed_fold = true;
1017 if self.cursor.item().is_none() {
1018 break;
1019 }
1020 }
1021
1022 if self.cursor.item().is_some() {
1023 if traversed_fold {
1024 self.input_buffer_rows.seek(self.cursor.start().1.row);
1025 self.input_buffer_rows.next();
1026 }
1027 *self.fold_point.row_mut() += 1;
1028 self.input_buffer_rows.next()
1029 } else {
1030 None
1031 }
1032 }
1033}
1034
1035pub struct FoldChunks<'a> {
1036 transform_cursor: Cursor<'a, Transform, (FoldOffset, usize)>,
1037 buffer_chunks: MultiBufferChunks<'a>,
1038 buffer_chunk: Option<(usize, Chunk<'a>)>,
1039 buffer_offset: usize,
1040 output_offset: usize,
1041 max_output_offset: usize,
1042 highlight_endpoints: Peekable<vec::IntoIter<HighlightEndpoint>>,
1043 active_highlights: BTreeMap<Option<TypeId>, HighlightStyle>,
1044}
1045
1046impl<'a> Iterator for FoldChunks<'a> {
1047 type Item = Chunk<'a>;
1048
1049 fn next(&mut self) -> Option<Self::Item> {
1050 if self.output_offset >= self.max_output_offset {
1051 return None;
1052 }
1053
1054 let transform = if let Some(item) = self.transform_cursor.item() {
1055 item
1056 } else {
1057 return None;
1058 };
1059
1060 // If we're in a fold, then return the fold's display text and
1061 // advance the transform and buffer cursors to the end of the fold.
1062 if let Some(output_text) = transform.output_text {
1063 self.buffer_chunk.take();
1064 self.buffer_offset += transform.summary.input.bytes;
1065 self.buffer_chunks.seek(self.buffer_offset);
1066
1067 while self.buffer_offset >= self.transform_cursor.end(&()).1
1068 && self.transform_cursor.item().is_some()
1069 {
1070 self.transform_cursor.next(&());
1071 }
1072
1073 self.output_offset += output_text.len();
1074 return Some(Chunk {
1075 text: output_text,
1076 syntax_highlight_id: None,
1077 highlight_style: None,
1078 diagnostic_severity: None,
1079 is_unnecessary: false,
1080 });
1081 }
1082
1083 let mut next_highlight_endpoint = usize::MAX;
1084 while let Some(endpoint) = self.highlight_endpoints.peek().copied() {
1085 if endpoint.offset <= self.buffer_offset {
1086 if endpoint.is_start {
1087 self.active_highlights.insert(endpoint.tag, endpoint.style);
1088 } else {
1089 self.active_highlights.remove(&endpoint.tag);
1090 }
1091 self.highlight_endpoints.next();
1092 } else {
1093 next_highlight_endpoint = endpoint.offset;
1094 break;
1095 }
1096 }
1097
1098 // Retrieve a chunk from the current location in the buffer.
1099 if self.buffer_chunk.is_none() {
1100 let chunk_offset = self.buffer_chunks.offset();
1101 self.buffer_chunk = self.buffer_chunks.next().map(|chunk| (chunk_offset, chunk));
1102 }
1103
1104 // Otherwise, take a chunk from the buffer's text.
1105 if let Some((buffer_chunk_start, mut chunk)) = self.buffer_chunk {
1106 let buffer_chunk_end = buffer_chunk_start + chunk.text.len();
1107 let transform_end = self.transform_cursor.end(&()).1;
1108 let chunk_end = buffer_chunk_end
1109 .min(transform_end)
1110 .min(next_highlight_endpoint);
1111
1112 chunk.text = &chunk.text
1113 [self.buffer_offset - buffer_chunk_start..chunk_end - buffer_chunk_start];
1114
1115 if !self.active_highlights.is_empty() {
1116 let mut highlight_style = HighlightStyle::default();
1117 for active_highlight in self.active_highlights.values() {
1118 highlight_style.highlight(*active_highlight);
1119 }
1120 chunk.highlight_style = Some(highlight_style);
1121 }
1122
1123 if chunk_end == transform_end {
1124 self.transform_cursor.next(&());
1125 } else if chunk_end == buffer_chunk_end {
1126 self.buffer_chunk.take();
1127 }
1128
1129 self.buffer_offset = chunk_end;
1130 self.output_offset += chunk.text.len();
1131 return Some(chunk);
1132 }
1133
1134 None
1135 }
1136}
1137
1138#[derive(Copy, Clone, Eq, PartialEq)]
1139struct HighlightEndpoint {
1140 offset: usize,
1141 is_start: bool,
1142 tag: Option<TypeId>,
1143 style: HighlightStyle,
1144}
1145
1146impl PartialOrd for HighlightEndpoint {
1147 fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
1148 Some(self.cmp(other))
1149 }
1150}
1151
1152impl Ord for HighlightEndpoint {
1153 fn cmp(&self, other: &Self) -> Ordering {
1154 self.offset
1155 .cmp(&other.offset)
1156 .then_with(|| other.is_start.cmp(&self.is_start))
1157 }
1158}
1159
1160#[derive(Copy, Clone, Debug, Default, Eq, Ord, PartialOrd, PartialEq)]
1161pub struct FoldOffset(pub usize);
1162
1163impl FoldOffset {
1164 pub fn to_point(&self, snapshot: &FoldSnapshot) -> FoldPoint {
1165 let mut cursor = snapshot
1166 .transforms
1167 .cursor::<(FoldOffset, TransformSummary)>();
1168 cursor.seek(self, Bias::Right, &());
1169 let overshoot = if cursor.item().map_or(true, |t| t.is_fold()) {
1170 Point::new(0, (self.0 - cursor.start().0 .0) as u32)
1171 } else {
1172 let buffer_offset = cursor.start().1.input.bytes + self.0 - cursor.start().0 .0;
1173 let buffer_point = snapshot.buffer_snapshot.offset_to_point(buffer_offset);
1174 buffer_point - cursor.start().1.input.lines
1175 };
1176 FoldPoint(cursor.start().1.output.lines + overshoot)
1177 }
1178}
1179
1180impl Sub for FoldOffset {
1181 type Output = Self;
1182
1183 fn sub(self, rhs: Self) -> Self::Output {
1184 Self(self.0 - rhs.0)
1185 }
1186}
1187
1188impl<'a> sum_tree::Dimension<'a, TransformSummary> for FoldOffset {
1189 fn add_summary(&mut self, summary: &'a TransformSummary, _: &()) {
1190 self.0 += &summary.output.bytes;
1191 }
1192}
1193
1194impl<'a> sum_tree::Dimension<'a, TransformSummary> for Point {
1195 fn add_summary(&mut self, summary: &'a TransformSummary, _: &()) {
1196 *self += &summary.input.lines;
1197 }
1198}
1199
1200impl<'a> sum_tree::Dimension<'a, TransformSummary> for usize {
1201 fn add_summary(&mut self, summary: &'a TransformSummary, _: &()) {
1202 *self += &summary.input.bytes;
1203 }
1204}
1205
1206pub type FoldEdit = Edit<FoldOffset>;
1207
1208#[cfg(test)]
1209mod tests {
1210 use super::*;
1211 use crate::{MultiBuffer, ToPoint};
1212 use rand::prelude::*;
1213 use std::{cmp::Reverse, env, mem, sync::Arc};
1214 use sum_tree::TreeMap;
1215 use text::RandomCharIter;
1216 use util::test::sample_text;
1217 use Bias::{Left, Right};
1218
1219 #[gpui::test]
1220 fn test_basic_folds(cx: &mut gpui::MutableAppContext) {
1221 let buffer = MultiBuffer::build_simple(&sample_text(5, 6, 'a'), cx);
1222 let subscription = buffer.update(cx, |buffer, _| buffer.subscribe());
1223 let buffer_snapshot = buffer.read(cx).snapshot(cx);
1224 let mut map = FoldMap::new(buffer_snapshot.clone()).0;
1225
1226 let (mut writer, _, _) = map.write(buffer_snapshot.clone(), vec![]);
1227 let (snapshot2, edits) = writer.fold(vec![
1228 Point::new(0, 2)..Point::new(2, 2),
1229 Point::new(2, 4)..Point::new(4, 1),
1230 ]);
1231 assert_eq!(snapshot2.text(), "aa…cc…eeeee");
1232 assert_eq!(
1233 edits,
1234 &[
1235 FoldEdit {
1236 old: FoldOffset(2)..FoldOffset(16),
1237 new: FoldOffset(2)..FoldOffset(5),
1238 },
1239 FoldEdit {
1240 old: FoldOffset(18)..FoldOffset(29),
1241 new: FoldOffset(7)..FoldOffset(10)
1242 },
1243 ]
1244 );
1245
1246 let buffer_snapshot = buffer.update(cx, |buffer, cx| {
1247 buffer.edit(
1248 vec![
1249 Point::new(0, 0)..Point::new(0, 1),
1250 Point::new(2, 3)..Point::new(2, 3),
1251 ],
1252 "123",
1253 cx,
1254 );
1255 buffer.snapshot(cx)
1256 });
1257 let (snapshot3, edits) =
1258 map.read(buffer_snapshot.clone(), subscription.consume().into_inner());
1259 assert_eq!(snapshot3.text(), "123a…c123c…eeeee");
1260 assert_eq!(
1261 edits,
1262 &[
1263 FoldEdit {
1264 old: FoldOffset(0)..FoldOffset(1),
1265 new: FoldOffset(0)..FoldOffset(3),
1266 },
1267 FoldEdit {
1268 old: FoldOffset(6)..FoldOffset(6),
1269 new: FoldOffset(8)..FoldOffset(11),
1270 },
1271 ]
1272 );
1273
1274 let buffer_snapshot = buffer.update(cx, |buffer, cx| {
1275 buffer.edit(vec![Point::new(2, 6)..Point::new(4, 3)], "456", cx);
1276 buffer.snapshot(cx)
1277 });
1278 let (snapshot4, _) = map.read(buffer_snapshot.clone(), subscription.consume().into_inner());
1279 assert_eq!(snapshot4.text(), "123a…c123456eee");
1280
1281 let (mut writer, _, _) = map.write(buffer_snapshot.clone(), vec![]);
1282 writer.unfold(Some(Point::new(0, 4)..Point::new(0, 4)), false);
1283 let (snapshot5, _) = map.read(buffer_snapshot.clone(), vec![]);
1284 assert_eq!(snapshot5.text(), "123a…c123456eee");
1285
1286 let (mut writer, _, _) = map.write(buffer_snapshot.clone(), vec![]);
1287 writer.unfold(Some(Point::new(0, 4)..Point::new(0, 4)), true);
1288 let (snapshot6, _) = map.read(buffer_snapshot.clone(), vec![]);
1289 assert_eq!(snapshot6.text(), "123aaaaa\nbbbbbb\nccc123456eee");
1290 }
1291
1292 #[gpui::test]
1293 fn test_adjacent_folds(cx: &mut gpui::MutableAppContext) {
1294 let buffer = MultiBuffer::build_simple("abcdefghijkl", cx);
1295 let subscription = buffer.update(cx, |buffer, _| buffer.subscribe());
1296 let buffer_snapshot = buffer.read(cx).snapshot(cx);
1297
1298 {
1299 let mut map = FoldMap::new(buffer_snapshot.clone()).0;
1300
1301 let (mut writer, _, _) = map.write(buffer_snapshot.clone(), vec![]);
1302 writer.fold(vec![5..8]);
1303 let (snapshot, _) = map.read(buffer_snapshot.clone(), vec![]);
1304 assert_eq!(snapshot.text(), "abcde…ijkl");
1305
1306 // Create an fold adjacent to the start of the first fold.
1307 let (mut writer, _, _) = map.write(buffer_snapshot.clone(), vec![]);
1308 writer.fold(vec![0..1, 2..5]);
1309 let (snapshot, _) = map.read(buffer_snapshot.clone(), vec![]);
1310 assert_eq!(snapshot.text(), "…b…ijkl");
1311
1312 // Create an fold adjacent to the end of the first fold.
1313 let (mut writer, _, _) = map.write(buffer_snapshot.clone(), vec![]);
1314 writer.fold(vec![11..11, 8..10]);
1315 let (snapshot, _) = map.read(buffer_snapshot.clone(), vec![]);
1316 assert_eq!(snapshot.text(), "…b…kl");
1317 }
1318
1319 {
1320 let mut map = FoldMap::new(buffer_snapshot.clone()).0;
1321
1322 // Create two adjacent folds.
1323 let (mut writer, _, _) = map.write(buffer_snapshot.clone(), vec![]);
1324 writer.fold(vec![0..2, 2..5]);
1325 let (snapshot, _) = map.read(buffer_snapshot.clone(), vec![]);
1326 assert_eq!(snapshot.text(), "…fghijkl");
1327
1328 // Edit within one of the folds.
1329 let buffer_snapshot = buffer.update(cx, |buffer, cx| {
1330 buffer.edit(vec![0..1], "12345", cx);
1331 buffer.snapshot(cx)
1332 });
1333 let (snapshot, _) =
1334 map.read(buffer_snapshot.clone(), subscription.consume().into_inner());
1335 assert_eq!(snapshot.text(), "12345…fghijkl");
1336 }
1337 }
1338
1339 #[gpui::test]
1340 fn test_overlapping_folds(cx: &mut gpui::MutableAppContext) {
1341 let buffer = MultiBuffer::build_simple(&sample_text(5, 6, 'a'), cx);
1342 let buffer_snapshot = buffer.read(cx).snapshot(cx);
1343 let mut map = FoldMap::new(buffer_snapshot.clone()).0;
1344 let (mut writer, _, _) = map.write(buffer_snapshot.clone(), vec![]);
1345 writer.fold(vec![
1346 Point::new(0, 2)..Point::new(2, 2),
1347 Point::new(0, 4)..Point::new(1, 0),
1348 Point::new(1, 2)..Point::new(3, 2),
1349 Point::new(3, 1)..Point::new(4, 1),
1350 ]);
1351 let (snapshot, _) = map.read(buffer_snapshot.clone(), vec![]);
1352 assert_eq!(snapshot.text(), "aa…eeeee");
1353 }
1354
1355 #[gpui::test]
1356 fn test_merging_folds_via_edit(cx: &mut gpui::MutableAppContext) {
1357 let buffer = MultiBuffer::build_simple(&sample_text(5, 6, 'a'), cx);
1358 let subscription = buffer.update(cx, |buffer, _| buffer.subscribe());
1359 let buffer_snapshot = buffer.read(cx).snapshot(cx);
1360 let mut map = FoldMap::new(buffer_snapshot.clone()).0;
1361
1362 let (mut writer, _, _) = map.write(buffer_snapshot.clone(), vec![]);
1363 writer.fold(vec![
1364 Point::new(0, 2)..Point::new(2, 2),
1365 Point::new(3, 1)..Point::new(4, 1),
1366 ]);
1367 let (snapshot, _) = map.read(buffer_snapshot.clone(), vec![]);
1368 assert_eq!(snapshot.text(), "aa…cccc\nd…eeeee");
1369
1370 let buffer_snapshot = buffer.update(cx, |buffer, cx| {
1371 buffer.edit(Some(Point::new(2, 2)..Point::new(3, 1)), "", cx);
1372 buffer.snapshot(cx)
1373 });
1374 let (snapshot, _) = map.read(buffer_snapshot.clone(), subscription.consume().into_inner());
1375 assert_eq!(snapshot.text(), "aa…eeeee");
1376 }
1377
1378 #[gpui::test]
1379 fn test_folds_in_range(cx: &mut gpui::MutableAppContext) {
1380 let buffer = MultiBuffer::build_simple(&sample_text(5, 6, 'a'), cx);
1381 let buffer_snapshot = buffer.read(cx).snapshot(cx);
1382 let mut map = FoldMap::new(buffer_snapshot.clone()).0;
1383
1384 let (mut writer, _, _) = map.write(buffer_snapshot.clone(), vec![]);
1385 writer.fold(vec![
1386 Point::new(0, 2)..Point::new(2, 2),
1387 Point::new(0, 4)..Point::new(1, 0),
1388 Point::new(1, 2)..Point::new(3, 2),
1389 Point::new(3, 1)..Point::new(4, 1),
1390 ]);
1391 let (snapshot, _) = map.read(buffer_snapshot.clone(), vec![]);
1392 let fold_ranges = snapshot
1393 .folds_in_range(Point::new(1, 0)..Point::new(1, 3))
1394 .map(|fold| fold.start.to_point(&buffer_snapshot)..fold.end.to_point(&buffer_snapshot))
1395 .collect::<Vec<_>>();
1396 assert_eq!(
1397 fold_ranges,
1398 vec![
1399 Point::new(0, 2)..Point::new(2, 2),
1400 Point::new(1, 2)..Point::new(3, 2)
1401 ]
1402 );
1403 }
1404
1405 #[gpui::test(iterations = 100)]
1406 fn test_random_folds(cx: &mut gpui::MutableAppContext, mut rng: StdRng) {
1407 let operations = env::var("OPERATIONS")
1408 .map(|i| i.parse().expect("invalid `OPERATIONS` variable"))
1409 .unwrap_or(10);
1410
1411 let len = rng.gen_range(0..10);
1412 let text = RandomCharIter::new(&mut rng).take(len).collect::<String>();
1413 let buffer = if rng.gen() {
1414 MultiBuffer::build_simple(&text, cx)
1415 } else {
1416 MultiBuffer::build_random(&mut rng, cx)
1417 };
1418 let mut buffer_snapshot = buffer.read(cx).snapshot(cx);
1419 let mut map = FoldMap::new(buffer_snapshot.clone()).0;
1420
1421 let (mut initial_snapshot, _) = map.read(buffer_snapshot.clone(), vec![]);
1422 let mut snapshot_edits = Vec::new();
1423
1424 let mut highlights = TreeMap::default();
1425 let highlight_count = rng.gen_range(0_usize..10);
1426 let mut highlight_ranges = (0..highlight_count)
1427 .map(|_| buffer_snapshot.random_byte_range(0, &mut rng))
1428 .collect::<Vec<_>>();
1429 highlight_ranges.sort_by_key(|range| (range.start, Reverse(range.end)));
1430 log::info!("highlighting ranges {:?}", highlight_ranges);
1431 let highlight_ranges = highlight_ranges
1432 .into_iter()
1433 .map(|range| {
1434 buffer_snapshot.anchor_before(range.start)..buffer_snapshot.anchor_after(range.end)
1435 })
1436 .collect::<Vec<_>>();
1437
1438 highlights.insert(
1439 Some(TypeId::of::<()>()),
1440 Arc::new((HighlightStyle::default(), highlight_ranges)),
1441 );
1442
1443 for _ in 0..operations {
1444 log::info!("text: {:?}", buffer_snapshot.text());
1445 let mut buffer_edits = Vec::new();
1446 match rng.gen_range(0..=100) {
1447 0..=59 => {
1448 snapshot_edits.extend(map.randomly_mutate(&mut rng));
1449 }
1450 _ => buffer.update(cx, |buffer, cx| {
1451 let subscription = buffer.subscribe();
1452 let edit_count = rng.gen_range(1..=5);
1453 buffer.randomly_mutate(&mut rng, edit_count, cx);
1454 buffer_snapshot = buffer.snapshot(cx);
1455 let edits = subscription.consume().into_inner();
1456 log::info!("editing {:?}", edits);
1457 buffer_edits.extend(edits);
1458 }),
1459 };
1460
1461 let (snapshot, edits) = map.read(buffer_snapshot.clone(), buffer_edits);
1462 snapshot_edits.push((snapshot.clone(), edits));
1463
1464 let mut expected_text: String = buffer_snapshot.text().to_string();
1465 for fold_range in map.merged_fold_ranges().into_iter().rev() {
1466 expected_text.replace_range(fold_range.start..fold_range.end, "…");
1467 }
1468
1469 assert_eq!(snapshot.text(), expected_text);
1470 log::info!(
1471 "fold text {:?} ({} lines)",
1472 expected_text,
1473 expected_text.matches('\n').count() + 1
1474 );
1475
1476 let mut prev_row = 0;
1477 let mut expected_buffer_rows = Vec::new();
1478 for fold_range in map.merged_fold_ranges().into_iter() {
1479 let fold_start = buffer_snapshot.offset_to_point(fold_range.start).row;
1480 let fold_end = buffer_snapshot.offset_to_point(fold_range.end).row;
1481 expected_buffer_rows.extend(
1482 buffer_snapshot
1483 .buffer_rows(prev_row)
1484 .take((1 + fold_start - prev_row) as usize),
1485 );
1486 prev_row = 1 + fold_end;
1487 }
1488 expected_buffer_rows.extend(buffer_snapshot.buffer_rows(prev_row));
1489
1490 assert_eq!(
1491 expected_buffer_rows.len(),
1492 expected_text.matches('\n').count() + 1,
1493 "wrong expected buffer rows {:?}. text: {:?}",
1494 expected_buffer_rows,
1495 expected_text
1496 );
1497
1498 for (output_row, line) in expected_text.lines().enumerate() {
1499 let line_len = snapshot.line_len(output_row as u32);
1500 assert_eq!(line_len, line.len() as u32);
1501 }
1502
1503 let longest_row = snapshot.longest_row();
1504 let longest_char_column = expected_text
1505 .split('\n')
1506 .nth(longest_row as usize)
1507 .unwrap()
1508 .chars()
1509 .count();
1510 let mut fold_point = FoldPoint::new(0, 0);
1511 let mut fold_offset = FoldOffset(0);
1512 let mut char_column = 0;
1513 for c in expected_text.chars() {
1514 let buffer_point = fold_point.to_buffer_point(&snapshot);
1515 let buffer_offset = buffer_point.to_offset(&buffer_snapshot);
1516 assert_eq!(
1517 snapshot.to_fold_point(buffer_point, Right),
1518 fold_point,
1519 "{:?} -> fold point",
1520 buffer_point,
1521 );
1522 assert_eq!(
1523 fold_point.to_buffer_offset(&snapshot),
1524 buffer_offset,
1525 "fold_point.to_buffer_offset({:?})",
1526 fold_point,
1527 );
1528 assert_eq!(
1529 fold_point.to_offset(&snapshot),
1530 fold_offset,
1531 "fold_point.to_offset({:?})",
1532 fold_point,
1533 );
1534
1535 if c == '\n' {
1536 *fold_point.row_mut() += 1;
1537 *fold_point.column_mut() = 0;
1538 char_column = 0;
1539 } else {
1540 *fold_point.column_mut() += c.len_utf8() as u32;
1541 char_column += 1;
1542 }
1543 fold_offset.0 += c.len_utf8();
1544 if char_column > longest_char_column {
1545 panic!(
1546 "invalid longest row {:?} (chars {}), found row {:?} (chars: {})",
1547 longest_row,
1548 longest_char_column,
1549 fold_point.row(),
1550 char_column
1551 );
1552 }
1553 }
1554
1555 for _ in 0..5 {
1556 let mut start = snapshot
1557 .clip_offset(FoldOffset(rng.gen_range(0..=snapshot.len().0)), Bias::Left);
1558 let mut end = snapshot
1559 .clip_offset(FoldOffset(rng.gen_range(0..=snapshot.len().0)), Bias::Right);
1560 if start > end {
1561 mem::swap(&mut start, &mut end);
1562 }
1563
1564 let text = &expected_text[start.0..end.0];
1565 assert_eq!(
1566 snapshot
1567 .chunks(start..end, false, Some(&highlights))
1568 .map(|c| c.text)
1569 .collect::<String>(),
1570 text,
1571 );
1572 }
1573
1574 let mut fold_row = 0;
1575 while fold_row < expected_buffer_rows.len() as u32 {
1576 fold_row = snapshot
1577 .clip_point(FoldPoint::new(fold_row, 0), Bias::Right)
1578 .row();
1579 assert_eq!(
1580 snapshot.buffer_rows(fold_row).collect::<Vec<_>>(),
1581 expected_buffer_rows[(fold_row as usize)..],
1582 "wrong buffer rows starting at fold row {}",
1583 fold_row,
1584 );
1585 fold_row += 1;
1586 }
1587
1588 for fold_range in map.merged_fold_ranges() {
1589 let fold_point =
1590 snapshot.to_fold_point(fold_range.start.to_point(&buffer_snapshot), Right);
1591 assert!(snapshot.is_line_folded(fold_point.row()));
1592 }
1593
1594 for _ in 0..5 {
1595 let end =
1596 buffer_snapshot.clip_offset(rng.gen_range(0..=buffer_snapshot.len()), Right);
1597 let start = buffer_snapshot.clip_offset(rng.gen_range(0..=end), Left);
1598 let expected_folds = map
1599 .folds
1600 .items(&buffer_snapshot)
1601 .into_iter()
1602 .filter(|fold| {
1603 let start = buffer_snapshot.anchor_before(start);
1604 let end = buffer_snapshot.anchor_after(end);
1605 start.cmp(&fold.0.end, &buffer_snapshot) == Ordering::Less
1606 && end.cmp(&fold.0.start, &buffer_snapshot) == Ordering::Greater
1607 })
1608 .map(|fold| fold.0)
1609 .collect::<Vec<_>>();
1610
1611 assert_eq!(
1612 snapshot
1613 .folds_in_range(start..end)
1614 .cloned()
1615 .collect::<Vec<_>>(),
1616 expected_folds
1617 );
1618 }
1619
1620 let text = snapshot.text();
1621 for _ in 0..5 {
1622 let start_row = rng.gen_range(0..=snapshot.max_point().row());
1623 let start_column = rng.gen_range(0..=snapshot.line_len(start_row));
1624 let end_row = rng.gen_range(0..=snapshot.max_point().row());
1625 let end_column = rng.gen_range(0..=snapshot.line_len(end_row));
1626 let mut start =
1627 snapshot.clip_point(FoldPoint::new(start_row, start_column), Bias::Left);
1628 let mut end = snapshot.clip_point(FoldPoint::new(end_row, end_column), Bias::Right);
1629 if start > end {
1630 mem::swap(&mut start, &mut end);
1631 }
1632
1633 let lines = start..end;
1634 let bytes = start.to_offset(&snapshot)..end.to_offset(&snapshot);
1635 assert_eq!(
1636 snapshot.text_summary_for_range(lines),
1637 TextSummary::from(&text[bytes.start.0..bytes.end.0])
1638 )
1639 }
1640
1641 let mut text = initial_snapshot.text();
1642 for (snapshot, edits) in snapshot_edits.drain(..) {
1643 let new_text = snapshot.text();
1644 for edit in edits {
1645 let old_bytes = edit.new.start.0..edit.new.start.0 + edit.old_len().0;
1646 let new_bytes = edit.new.start.0..edit.new.end.0;
1647 text.replace_range(old_bytes, &new_text[new_bytes]);
1648 }
1649
1650 assert_eq!(text, new_text);
1651 initial_snapshot = snapshot;
1652 }
1653 }
1654 }
1655
1656 #[gpui::test]
1657 fn test_buffer_rows(cx: &mut gpui::MutableAppContext) {
1658 let text = sample_text(6, 6, 'a') + "\n";
1659 let buffer = MultiBuffer::build_simple(&text, cx);
1660
1661 let buffer_snapshot = buffer.read(cx).snapshot(cx);
1662 let mut map = FoldMap::new(buffer_snapshot.clone()).0;
1663
1664 let (mut writer, _, _) = map.write(buffer_snapshot.clone(), vec![]);
1665 writer.fold(vec![
1666 Point::new(0, 2)..Point::new(2, 2),
1667 Point::new(3, 1)..Point::new(4, 1),
1668 ]);
1669
1670 let (snapshot, _) = map.read(buffer_snapshot.clone(), vec![]);
1671 assert_eq!(snapshot.text(), "aa…cccc\nd…eeeee\nffffff\n");
1672 assert_eq!(
1673 snapshot.buffer_rows(0).collect::<Vec<_>>(),
1674 [Some(0), Some(3), Some(5), Some(6)]
1675 );
1676 assert_eq!(snapshot.buffer_rows(3).collect::<Vec<_>>(), [Some(6)]);
1677 }
1678
1679 impl FoldMap {
1680 fn merged_fold_ranges(&self) -> Vec<Range<usize>> {
1681 let buffer = self.buffer.lock().clone();
1682 let mut folds = self.folds.items(&buffer);
1683 // Ensure sorting doesn't change how folds get merged and displayed.
1684 folds.sort_by(|a, b| a.0.cmp(&b.0, &buffer));
1685 let mut fold_ranges = folds
1686 .iter()
1687 .map(|fold| fold.0.start.to_offset(&buffer)..fold.0.end.to_offset(&buffer))
1688 .peekable();
1689
1690 let mut merged_ranges = Vec::new();
1691 while let Some(mut fold_range) = fold_ranges.next() {
1692 while let Some(next_range) = fold_ranges.peek() {
1693 if fold_range.end >= next_range.start {
1694 if next_range.end > fold_range.end {
1695 fold_range.end = next_range.end;
1696 }
1697 fold_ranges.next();
1698 } else {
1699 break;
1700 }
1701 }
1702 if fold_range.end > fold_range.start {
1703 merged_ranges.push(fold_range);
1704 }
1705 }
1706 merged_ranges
1707 }
1708
1709 pub fn randomly_mutate(
1710 &mut self,
1711 rng: &mut impl Rng,
1712 ) -> Vec<(FoldSnapshot, Vec<FoldEdit>)> {
1713 let mut snapshot_edits = Vec::new();
1714 match rng.gen_range(0..=100) {
1715 0..=39 if !self.folds.is_empty() => {
1716 let buffer = self.buffer.lock().clone();
1717 let mut to_unfold = Vec::new();
1718 for _ in 0..rng.gen_range(1..=3) {
1719 let end = buffer.clip_offset(rng.gen_range(0..=buffer.len()), Right);
1720 let start = buffer.clip_offset(rng.gen_range(0..=end), Left);
1721 to_unfold.push(start..end);
1722 }
1723 log::info!("unfolding {:?}", to_unfold);
1724 let (mut writer, snapshot, edits) = self.write(buffer, vec![]);
1725 snapshot_edits.push((snapshot, edits));
1726 let (snapshot, edits) = writer.fold(to_unfold);
1727 snapshot_edits.push((snapshot, edits));
1728 }
1729 _ => {
1730 let buffer = self.buffer.lock().clone();
1731 let mut to_fold = Vec::new();
1732 for _ in 0..rng.gen_range(1..=2) {
1733 let end = buffer.clip_offset(rng.gen_range(0..=buffer.len()), Right);
1734 let start = buffer.clip_offset(rng.gen_range(0..=end), Left);
1735 to_fold.push(start..end);
1736 }
1737 log::info!("folding {:?}", to_fold);
1738 let (mut writer, snapshot, edits) = self.write(buffer, vec![]);
1739 snapshot_edits.push((snapshot, edits));
1740 let (snapshot, edits) = writer.fold(to_fold);
1741 snapshot_edits.push((snapshot, edits));
1742 }
1743 }
1744 snapshot_edits
1745 }
1746 }
1747}