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