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