1use super::{
2 fold_map,
3 line_wrapper::LineWrapper,
4 tab_map::{self, Edit as TabEdit, Snapshot as TabSnapshot, TabPoint, TextSummary},
5};
6use crate::{
7 editor::Point,
8 settings::StyleId,
9 sum_tree::{self, Cursor, SumTree},
10 util::Bias,
11 Settings,
12};
13use gpui::{Entity, ModelContext, Task};
14use lazy_static::lazy_static;
15use smol::future::yield_now;
16use std::{collections::VecDeque, ops::Range, time::Duration};
17
18pub struct WrapMap {
19 snapshot: Snapshot,
20 pending_edits: VecDeque<(TabSnapshot, Vec<TabEdit>)>,
21 wrap_width: Option<f32>,
22 background_task: Option<Task<()>>,
23 settings: Settings,
24}
25
26impl Entity for WrapMap {
27 type Event = ();
28}
29
30#[derive(Clone)]
31pub struct Snapshot {
32 tab_snapshot: TabSnapshot,
33 transforms: SumTree<Transform>,
34 interpolated: bool,
35}
36
37#[derive(Clone, Debug, Default, Eq, PartialEq)]
38struct Transform {
39 summary: TransformSummary,
40 display_text: Option<&'static str>,
41}
42
43#[derive(Clone, Debug, Default, Eq, PartialEq)]
44struct TransformSummary {
45 input: TextSummary,
46 output: TextSummary,
47}
48
49#[derive(Copy, Clone, Debug, Default, Eq, Ord, PartialOrd, PartialEq)]
50pub struct WrapPoint(super::Point);
51
52pub struct Chunks<'a> {
53 input_chunks: tab_map::Chunks<'a>,
54 input_chunk: &'a str,
55 output_position: WrapPoint,
56 transforms: Cursor<'a, Transform, WrapPoint, TabPoint>,
57}
58
59pub struct HighlightedChunks<'a> {
60 input_chunks: tab_map::HighlightedChunks<'a>,
61 input_chunk: &'a str,
62 style_id: StyleId,
63 output_position: WrapPoint,
64 max_output_row: u32,
65 transforms: Cursor<'a, Transform, WrapPoint, TabPoint>,
66}
67
68pub struct BufferRows<'a> {
69 input_buffer_rows: fold_map::BufferRows<'a>,
70 input_buffer_row: u32,
71 output_row: u32,
72 soft_wrapped: bool,
73 max_output_row: u32,
74 transforms: Cursor<'a, Transform, WrapPoint, TabPoint>,
75}
76
77impl WrapMap {
78 pub fn new(
79 tab_snapshot: TabSnapshot,
80 settings: Settings,
81 wrap_width: Option<f32>,
82 cx: &mut ModelContext<Self>,
83 ) -> Self {
84 let mut this = Self {
85 background_task: None,
86 wrap_width: None,
87 pending_edits: Default::default(),
88 snapshot: Snapshot::new(tab_snapshot),
89 settings,
90 };
91 this.set_wrap_width(wrap_width, cx);
92 this
93 }
94
95 #[cfg(test)]
96 pub fn is_rewrapping(&self) -> bool {
97 self.background_task.is_some()
98 }
99
100 pub fn sync(
101 &mut self,
102 tab_snapshot: TabSnapshot,
103 edits: Vec<TabEdit>,
104 cx: &mut ModelContext<Self>,
105 ) -> Snapshot {
106 self.pending_edits.push_back((tab_snapshot, edits));
107 self.flush_edits(cx);
108 self.snapshot.clone()
109 }
110
111 pub fn set_wrap_width(&mut self, wrap_width: Option<f32>, cx: &mut ModelContext<Self>) -> bool {
112 if wrap_width == self.wrap_width {
113 return false;
114 }
115
116 self.wrap_width = wrap_width;
117 self.background_task.take();
118
119 if let Some(wrap_width) = wrap_width {
120 let mut new_snapshot = self.snapshot.clone();
121 let font_system = cx.platform().fonts();
122 let font_cache = cx.font_cache().clone();
123 let settings = self.settings.clone();
124 let task = cx.background().spawn(async move {
125 let mut line_wrapper =
126 LineWrapper::thread_local(font_system, &font_cache, settings);
127 let tab_snapshot = new_snapshot.tab_snapshot.clone();
128 let range = TabPoint::zero()..tab_snapshot.max_point();
129 new_snapshot
130 .update(
131 tab_snapshot,
132 &[TabEdit {
133 old_lines: range.clone(),
134 new_lines: range.clone(),
135 }],
136 wrap_width,
137 &mut line_wrapper,
138 )
139 .await;
140 new_snapshot
141 });
142
143 match cx
144 .background()
145 .block_with_timeout(Duration::from_millis(5), task)
146 {
147 Ok(snapshot) => {
148 self.snapshot = snapshot;
149 }
150 Err(wrap_task) => {
151 self.background_task = Some(cx.spawn(|this, mut cx| async move {
152 let snapshot = wrap_task.await;
153 this.update(&mut cx, |this, cx| {
154 this.snapshot = snapshot;
155 this.background_task = None;
156 this.flush_edits(cx);
157 cx.notify();
158 });
159 }));
160 }
161 }
162 } else {
163 self.snapshot.transforms = SumTree::new();
164 let summary = self.snapshot.tab_snapshot.text_summary();
165 if !summary.lines.is_zero() {
166 self.snapshot
167 .transforms
168 .push(Transform::isomorphic(summary), &());
169 }
170 }
171
172 true
173 }
174
175 fn flush_edits(&mut self, cx: &mut ModelContext<Self>) {
176 if !self.snapshot.interpolated {
177 let mut to_remove_len = 0;
178 for (tab_snapshot, _) in &self.pending_edits {
179 if tab_snapshot.version() <= self.snapshot.tab_snapshot.version() {
180 to_remove_len += 1;
181 } else {
182 break;
183 }
184 }
185 self.pending_edits.drain(..to_remove_len);
186 }
187
188 if self.pending_edits.is_empty() {
189 return;
190 }
191
192 if let Some(wrap_width) = self.wrap_width {
193 if self.background_task.is_none() {
194 let pending_edits = self.pending_edits.clone();
195 let mut snapshot = self.snapshot.clone();
196 let font_system = cx.platform().fonts();
197 let font_cache = cx.font_cache().clone();
198 let settings = self.settings.clone();
199 let update_task = cx.background().spawn(async move {
200 let mut line_wrapper =
201 LineWrapper::thread_local(font_system, &font_cache, settings);
202 for (tab_snapshot, edits) in pending_edits {
203 snapshot
204 .update(tab_snapshot, &edits, wrap_width, &mut line_wrapper)
205 .await;
206 }
207 snapshot
208 });
209
210 match cx
211 .background()
212 .block_with_timeout(Duration::from_micros(500), update_task)
213 {
214 Ok(snapshot) => {
215 self.snapshot = snapshot;
216 }
217 Err(update_task) => {
218 self.background_task = Some(cx.spawn(|this, mut cx| async move {
219 let snapshot = update_task.await;
220 this.update(&mut cx, |this, cx| {
221 this.snapshot = snapshot;
222 this.background_task = None;
223 this.flush_edits(cx);
224 cx.notify();
225 });
226 }));
227 }
228 }
229 }
230 }
231
232 let was_interpolated = self.snapshot.interpolated;
233 let mut to_remove_len = 0;
234 for (tab_snapshot, edits) in &self.pending_edits {
235 if tab_snapshot.version() <= self.snapshot.tab_snapshot.version() {
236 to_remove_len += 1;
237 } else {
238 self.snapshot.interpolate(tab_snapshot.clone(), &edits);
239 }
240 }
241
242 if !was_interpolated {
243 self.pending_edits.drain(..to_remove_len);
244 }
245 }
246}
247
248impl Snapshot {
249 fn new(tab_snapshot: TabSnapshot) -> Self {
250 let mut transforms = SumTree::new();
251 let extent = tab_snapshot.text_summary();
252 if !extent.lines.is_zero() {
253 transforms.push(Transform::isomorphic(extent), &());
254 }
255 Self {
256 transforms,
257 tab_snapshot,
258 interpolated: true,
259 }
260 }
261
262 fn interpolate(&mut self, new_tab_snapshot: TabSnapshot, edits: &[TabEdit]) {
263 let mut new_transforms;
264 if edits.is_empty() {
265 new_transforms = self.transforms.clone();
266 } else {
267 let mut old_cursor = self.transforms.cursor::<TabPoint, ()>();
268 let mut edits = edits.into_iter().peekable();
269 new_transforms =
270 old_cursor.slice(&edits.peek().unwrap().old_lines.start, Bias::Right, &());
271
272 while let Some(edit) = edits.next() {
273 if edit.new_lines.start > TabPoint::from(new_transforms.summary().input.lines) {
274 let summary = new_tab_snapshot.text_summary_for_range(
275 TabPoint::from(new_transforms.summary().input.lines)..edit.new_lines.start,
276 );
277 new_transforms.push_or_extend(Transform::isomorphic(summary));
278 }
279
280 if !edit.new_lines.is_empty() {
281 new_transforms.push_or_extend(Transform::isomorphic(
282 new_tab_snapshot.text_summary_for_range(edit.new_lines.clone()),
283 ));
284 }
285
286 old_cursor.seek_forward(&edit.old_lines.end, Bias::Right, &());
287 if let Some(next_edit) = edits.peek() {
288 if next_edit.old_lines.start > old_cursor.seek_end(&()) {
289 if old_cursor.seek_end(&()) > edit.old_lines.end {
290 let summary = self.tab_snapshot.text_summary_for_range(
291 edit.old_lines.end..old_cursor.seek_end(&()),
292 );
293 new_transforms.push_or_extend(Transform::isomorphic(summary));
294 }
295 old_cursor.next(&());
296 new_transforms.push_tree(
297 old_cursor.slice(&next_edit.old_lines.start, Bias::Right, &()),
298 &(),
299 );
300 }
301 } else {
302 if old_cursor.seek_end(&()) > edit.old_lines.end {
303 let summary = self
304 .tab_snapshot
305 .text_summary_for_range(edit.old_lines.end..old_cursor.seek_end(&()));
306 new_transforms.push_or_extend(Transform::isomorphic(summary));
307 }
308 old_cursor.next(&());
309 new_transforms.push_tree(old_cursor.suffix(&()), &());
310 }
311 }
312 }
313
314 self.transforms = new_transforms;
315 self.tab_snapshot = new_tab_snapshot;
316 self.interpolated = true;
317 self.check_invariants();
318 }
319
320 async fn update(
321 &mut self,
322 new_tab_snapshot: TabSnapshot,
323 edits: &[TabEdit],
324 wrap_width: f32,
325 line_wrapper: &mut LineWrapper,
326 ) {
327 #[derive(Debug)]
328 struct RowEdit {
329 old_rows: Range<u32>,
330 new_rows: Range<u32>,
331 }
332
333 let mut edits = edits.into_iter().peekable();
334 let mut row_edits = Vec::new();
335 while let Some(edit) = edits.next() {
336 let mut row_edit = RowEdit {
337 old_rows: edit.old_lines.start.row()..edit.old_lines.end.row() + 1,
338 new_rows: edit.new_lines.start.row()..edit.new_lines.end.row() + 1,
339 };
340
341 while let Some(next_edit) = edits.peek() {
342 if next_edit.old_lines.start.row() <= row_edit.old_rows.end {
343 row_edit.old_rows.end = next_edit.old_lines.end.row() + 1;
344 row_edit.new_rows.end = next_edit.new_lines.end.row() + 1;
345 edits.next();
346 } else {
347 break;
348 }
349 }
350
351 row_edits.push(row_edit);
352 }
353
354 let mut new_transforms;
355 if row_edits.is_empty() {
356 new_transforms = self.transforms.clone();
357 } else {
358 let mut row_edits = row_edits.into_iter().peekable();
359 let mut old_cursor = self.transforms.cursor::<TabPoint, ()>();
360
361 new_transforms = old_cursor.slice(
362 &TabPoint::new(row_edits.peek().unwrap().old_rows.start, 0),
363 Bias::Right,
364 &(),
365 );
366
367 while let Some(edit) = row_edits.next() {
368 if edit.new_rows.start > new_transforms.summary().input.lines.row {
369 let summary = new_tab_snapshot.text_summary_for_range(
370 TabPoint::new(new_transforms.summary().input.lines.row, 0)
371 ..TabPoint::new(edit.new_rows.start, 0),
372 );
373 new_transforms.push_or_extend(Transform::isomorphic(summary));
374 }
375
376 let mut line = String::new();
377 let mut remaining = None;
378 let mut chunks = new_tab_snapshot.chunks_at(TabPoint::new(edit.new_rows.start, 0));
379 let mut edit_transforms = Vec::<Transform>::new();
380 for _ in edit.new_rows.start..edit.new_rows.end {
381 while let Some(chunk) = remaining.take().or_else(|| chunks.next()) {
382 if let Some(ix) = chunk.find('\n') {
383 line.push_str(&chunk[..ix + 1]);
384 remaining = Some(&chunk[ix + 1..]);
385 break;
386 } else {
387 line.push_str(chunk)
388 }
389 }
390
391 if line.is_empty() {
392 break;
393 }
394
395 let mut prev_boundary_ix = 0;
396 for boundary in line_wrapper.wrap_line(&line, wrap_width) {
397 let wrapped = &line[prev_boundary_ix..boundary.ix];
398 push_isomorphic(&mut edit_transforms, TextSummary::from(wrapped));
399 edit_transforms.push(Transform::wrap(boundary.next_indent));
400 prev_boundary_ix = boundary.ix;
401 }
402
403 if prev_boundary_ix < line.len() {
404 push_isomorphic(
405 &mut edit_transforms,
406 TextSummary::from(&line[prev_boundary_ix..]),
407 );
408 }
409
410 line.clear();
411 yield_now().await;
412 }
413
414 let mut edit_transforms = edit_transforms.into_iter();
415 if let Some(transform) = edit_transforms.next() {
416 new_transforms.push_or_extend(transform);
417 }
418 new_transforms.extend(edit_transforms, &());
419
420 old_cursor.seek_forward(&TabPoint::new(edit.old_rows.end, 0), Bias::Right, &());
421 if let Some(next_edit) = row_edits.peek() {
422 if next_edit.old_rows.start > old_cursor.seek_end(&()).row() {
423 if old_cursor.seek_end(&()) > TabPoint::new(edit.old_rows.end, 0) {
424 let summary = self.tab_snapshot.text_summary_for_range(
425 TabPoint::new(edit.old_rows.end, 0)..old_cursor.seek_end(&()),
426 );
427 new_transforms.push_or_extend(Transform::isomorphic(summary));
428 }
429 old_cursor.next(&());
430 new_transforms.push_tree(
431 old_cursor.slice(
432 &TabPoint::new(next_edit.old_rows.start, 0),
433 Bias::Right,
434 &(),
435 ),
436 &(),
437 );
438 }
439 } else {
440 if old_cursor.seek_end(&()) > TabPoint::new(edit.old_rows.end, 0) {
441 let summary = self.tab_snapshot.text_summary_for_range(
442 TabPoint::new(edit.old_rows.end, 0)..old_cursor.seek_end(&()),
443 );
444 new_transforms.push_or_extend(Transform::isomorphic(summary));
445 }
446 old_cursor.next(&());
447 new_transforms.push_tree(old_cursor.suffix(&()), &());
448 }
449 }
450 }
451
452 self.transforms = new_transforms;
453 self.tab_snapshot = new_tab_snapshot;
454 self.interpolated = false;
455 self.check_invariants();
456 }
457
458 pub fn chunks_at(&self, wrap_row: u32) -> Chunks {
459 let point = WrapPoint::new(wrap_row, 0);
460 let mut transforms = self.transforms.cursor::<WrapPoint, TabPoint>();
461 transforms.seek(&point, Bias::Right, &());
462 let mut input_position = TabPoint(transforms.sum_start().0);
463 if transforms.item().map_or(false, |t| t.is_isomorphic()) {
464 input_position.0 += point.0 - transforms.seek_start().0;
465 }
466 let input_chunks = self.tab_snapshot.chunks_at(input_position);
467 Chunks {
468 input_chunks,
469 transforms,
470 output_position: point,
471 input_chunk: "",
472 }
473 }
474
475 pub fn highlighted_chunks_for_rows(&mut self, rows: Range<u32>) -> HighlightedChunks {
476 let output_start = WrapPoint::new(rows.start, 0);
477 let output_end = WrapPoint::new(rows.end, 0);
478 let mut transforms = self.transforms.cursor::<WrapPoint, TabPoint>();
479 transforms.seek(&output_start, Bias::Right, &());
480 let mut input_start = TabPoint(transforms.sum_start().0);
481 if transforms.item().map_or(false, |t| t.is_isomorphic()) {
482 input_start.0 += output_start.0 - transforms.seek_start().0;
483 }
484 let input_end = self
485 .to_tab_point(output_end)
486 .min(self.tab_snapshot.max_point());
487 HighlightedChunks {
488 input_chunks: self.tab_snapshot.highlighted_chunks(input_start..input_end),
489 input_chunk: "",
490 style_id: StyleId::default(),
491 output_position: output_start,
492 max_output_row: rows.end,
493 transforms,
494 }
495 }
496
497 pub fn max_point(&self) -> WrapPoint {
498 self.to_wrap_point(self.tab_snapshot.max_point(), Bias::Right)
499 }
500
501 pub fn line_len(&self, row: u32) -> u32 {
502 let mut len = 0;
503 for chunk in self.chunks_at(row) {
504 if let Some(newline_ix) = chunk.find('\n') {
505 len += newline_ix;
506 break;
507 } else {
508 len += chunk.len();
509 }
510 }
511 len as u32
512 }
513
514 pub fn longest_row(&self) -> u32 {
515 self.transforms.summary().output.longest_row
516 }
517
518 pub fn buffer_rows(&self, start_row: u32) -> BufferRows {
519 let mut transforms = self.transforms.cursor::<WrapPoint, TabPoint>();
520 transforms.seek(&WrapPoint::new(start_row, 0), Bias::Left, &());
521 let mut input_row = transforms.sum_start().row();
522 let soft_wrapped;
523 if transforms.item().map_or(false, |t| t.is_isomorphic()) {
524 input_row += start_row - transforms.seek_start().row();
525 soft_wrapped = false;
526 } else {
527 soft_wrapped = true;
528 }
529 let mut input_buffer_rows = self.tab_snapshot.buffer_rows(input_row);
530 let input_buffer_row = input_buffer_rows.next().unwrap();
531 BufferRows {
532 transforms,
533 input_buffer_row,
534 input_buffer_rows,
535 output_row: start_row,
536 soft_wrapped,
537 max_output_row: self.max_point().row(),
538 }
539 }
540
541 pub fn to_tab_point(&self, point: WrapPoint) -> TabPoint {
542 let mut cursor = self.transforms.cursor::<WrapPoint, TabPoint>();
543 cursor.seek(&point, Bias::Right, &());
544 let mut tab_point = cursor.sum_start().0;
545 if cursor.item().map_or(false, |t| t.is_isomorphic()) {
546 tab_point += point.0 - cursor.seek_start().0;
547 }
548 TabPoint(tab_point)
549 }
550
551 pub fn to_wrap_point(&self, point: TabPoint, bias: Bias) -> WrapPoint {
552 let mut cursor = self.transforms.cursor::<TabPoint, WrapPoint>();
553 cursor.seek(&point, bias, &());
554 WrapPoint(cursor.sum_start().0 + (point.0 - cursor.seek_start().0))
555 }
556
557 pub fn clip_point(&self, mut point: WrapPoint, bias: Bias) -> WrapPoint {
558 if bias == Bias::Left {
559 let mut cursor = self.transforms.cursor::<WrapPoint, ()>();
560 cursor.seek(&point, Bias::Right, &());
561 if cursor.item().map_or(false, |t| !t.is_isomorphic()) {
562 point = *cursor.seek_start();
563 *point.column_mut() -= 1;
564 }
565 }
566
567 self.to_wrap_point(
568 self.tab_snapshot.clip_point(self.to_tab_point(point), bias),
569 bias,
570 )
571 }
572
573 fn check_invariants(&self) {
574 #[cfg(test)]
575 {
576 assert_eq!(
577 TabPoint::from(self.transforms.summary().input.lines),
578 self.tab_snapshot.max_point()
579 );
580
581 {
582 let mut transforms = self.transforms.cursor::<(), ()>().peekable();
583 while let Some(transform) = transforms.next() {
584 if let Some(next_transform) = transforms.peek() {
585 assert!(transform.is_isomorphic() != next_transform.is_isomorphic());
586 }
587 }
588 }
589
590 let mut expected_buffer_rows = Vec::new();
591 let mut buffer_row = 0;
592 let mut prev_tab_row = 0;
593 for display_row in 0..=self.max_point().row() {
594 let tab_point = self.to_tab_point(WrapPoint::new(display_row, 0));
595 if tab_point.row() != prev_tab_row {
596 let fold_point = self.tab_snapshot.to_fold_point(tab_point, Bias::Left).0;
597 let buffer_point = fold_point.to_buffer_point(&self.tab_snapshot.fold_snapshot);
598 buffer_row = buffer_point.row;
599 prev_tab_row = tab_point.row();
600 }
601 expected_buffer_rows.push(buffer_row);
602 }
603
604 for start_display_row in 0..expected_buffer_rows.len() {
605 assert_eq!(
606 self.buffer_rows(start_display_row as u32)
607 .map(|(row, _)| row)
608 .collect::<Vec<_>>(),
609 &expected_buffer_rows[start_display_row..],
610 "invalid buffer_rows({}..)",
611 start_display_row
612 );
613 }
614 }
615 }
616}
617
618impl<'a> Iterator for Chunks<'a> {
619 type Item = &'a str;
620
621 fn next(&mut self) -> Option<Self::Item> {
622 let transform = self.transforms.item()?;
623 if let Some(display_text) = transform.display_text {
624 if self.output_position > *self.transforms.seek_start() {
625 self.output_position.0.column += transform.summary.output.lines.column;
626 self.transforms.next(&());
627 return Some(&display_text[1..]);
628 } else {
629 self.output_position.0 += transform.summary.output.lines;
630 self.transforms.next(&());
631 return Some(display_text);
632 }
633 }
634
635 if self.input_chunk.is_empty() {
636 self.input_chunk = self.input_chunks.next().unwrap();
637 }
638
639 let mut input_len = 0;
640 let transform_end = self.transforms.seek_end(&());
641 for c in self.input_chunk.chars() {
642 let char_len = c.len_utf8();
643 input_len += char_len;
644 if c == '\n' {
645 *self.output_position.row_mut() += 1;
646 *self.output_position.column_mut() = 0;
647 } else {
648 *self.output_position.column_mut() += char_len as u32;
649 }
650
651 if self.output_position >= transform_end {
652 self.transforms.next(&());
653 break;
654 }
655 }
656
657 let (prefix, suffix) = self.input_chunk.split_at(input_len);
658 self.input_chunk = suffix;
659 Some(prefix)
660 }
661}
662
663impl<'a> Iterator for HighlightedChunks<'a> {
664 type Item = (&'a str, StyleId);
665
666 fn next(&mut self) -> Option<Self::Item> {
667 if self.output_position.row() >= self.max_output_row {
668 return None;
669 }
670
671 let transform = self.transforms.item()?;
672 if let Some(display_text) = transform.display_text {
673 let mut start_ix = 0;
674 let mut end_ix = display_text.len();
675 let mut summary = transform.summary.output.lines;
676
677 if self.output_position > *self.transforms.seek_start() {
678 // Exclude newline starting prior to the desired row.
679 start_ix = 1;
680 summary.row = 0;
681 } else if self.output_position.row() + 1 >= self.max_output_row {
682 // Exclude soft indentation ending after the desired row.
683 end_ix = 1;
684 summary.column = 0;
685 }
686
687 self.output_position.0 += summary;
688 self.transforms.next(&());
689 return Some((&display_text[start_ix..end_ix], self.style_id));
690 }
691
692 if self.input_chunk.is_empty() {
693 let (chunk, style_id) = self.input_chunks.next().unwrap();
694 self.input_chunk = chunk;
695 self.style_id = style_id;
696 }
697
698 let mut input_len = 0;
699 let transform_end = self.transforms.seek_end(&());
700 for c in self.input_chunk.chars() {
701 let char_len = c.len_utf8();
702 input_len += char_len;
703 if c == '\n' {
704 *self.output_position.row_mut() += 1;
705 *self.output_position.column_mut() = 0;
706 } else {
707 *self.output_position.column_mut() += char_len as u32;
708 }
709
710 if self.output_position >= transform_end {
711 self.transforms.next(&());
712 break;
713 }
714 }
715
716 let (prefix, suffix) = self.input_chunk.split_at(input_len);
717 self.input_chunk = suffix;
718 Some((prefix, self.style_id))
719 }
720}
721
722impl<'a> Iterator for BufferRows<'a> {
723 type Item = (u32, bool);
724
725 fn next(&mut self) -> Option<Self::Item> {
726 if self.output_row > self.max_output_row {
727 return None;
728 }
729
730 let buffer_row = self.input_buffer_row;
731 let soft_wrapped = self.soft_wrapped;
732
733 self.output_row += 1;
734 self.transforms
735 .seek_forward(&WrapPoint::new(self.output_row, 0), Bias::Left, &());
736 if self.transforms.item().map_or(false, |t| t.is_isomorphic()) {
737 self.input_buffer_row = self.input_buffer_rows.next().unwrap();
738 self.soft_wrapped = false;
739 } else {
740 self.soft_wrapped = true;
741 }
742
743 Some((buffer_row, soft_wrapped))
744 }
745}
746
747impl Transform {
748 fn isomorphic(summary: TextSummary) -> Self {
749 #[cfg(test)]
750 assert!(!summary.lines.is_zero());
751
752 Self {
753 summary: TransformSummary {
754 input: summary.clone(),
755 output: summary,
756 },
757 display_text: None,
758 }
759 }
760
761 fn wrap(indent: u32) -> Self {
762 lazy_static! {
763 static ref WRAP_TEXT: String = {
764 let mut wrap_text = String::new();
765 wrap_text.push('\n');
766 wrap_text.extend((0..LineWrapper::MAX_INDENT as usize).map(|_| ' '));
767 wrap_text
768 };
769 }
770
771 Self {
772 summary: TransformSummary {
773 input: TextSummary::default(),
774 output: TextSummary {
775 lines: Point::new(1, indent),
776 first_line_chars: 0,
777 last_line_chars: indent,
778 longest_row: 1,
779 longest_row_chars: indent,
780 },
781 },
782 display_text: Some(&WRAP_TEXT[..1 + indent as usize]),
783 }
784 }
785
786 fn is_isomorphic(&self) -> bool {
787 self.display_text.is_none()
788 }
789}
790
791impl sum_tree::Item for Transform {
792 type Summary = TransformSummary;
793
794 fn summary(&self) -> Self::Summary {
795 self.summary.clone()
796 }
797}
798
799fn push_isomorphic(transforms: &mut Vec<Transform>, summary: TextSummary) {
800 if let Some(last_transform) = transforms.last_mut() {
801 if last_transform.is_isomorphic() {
802 last_transform.summary.input += &summary;
803 last_transform.summary.output += &summary;
804 return;
805 }
806 }
807 transforms.push(Transform::isomorphic(summary));
808}
809
810impl SumTree<Transform> {
811 pub fn push_or_extend(&mut self, transform: Transform) {
812 let mut transform = Some(transform);
813 self.update_last(
814 |last_transform| {
815 if last_transform.is_isomorphic() && transform.as_ref().unwrap().is_isomorphic() {
816 let transform = transform.take().unwrap();
817 last_transform.summary.input += &transform.summary.input;
818 last_transform.summary.output += &transform.summary.output;
819 }
820 },
821 &(),
822 );
823
824 if let Some(transform) = transform {
825 self.push(transform, &());
826 }
827 }
828}
829
830impl WrapPoint {
831 pub fn new(row: u32, column: u32) -> Self {
832 Self(super::Point::new(row, column))
833 }
834
835 pub fn row(self) -> u32 {
836 self.0.row
837 }
838
839 pub fn column(self) -> u32 {
840 self.0.column
841 }
842
843 pub fn row_mut(&mut self) -> &mut u32 {
844 &mut self.0.row
845 }
846
847 pub fn column_mut(&mut self) -> &mut u32 {
848 &mut self.0.column
849 }
850}
851
852impl sum_tree::Summary for TransformSummary {
853 type Context = ();
854
855 fn add_summary(&mut self, other: &Self, _: &()) {
856 self.input += &other.input;
857 self.output += &other.output;
858 }
859}
860
861impl<'a> sum_tree::Dimension<'a, TransformSummary> for TabPoint {
862 fn add_summary(&mut self, summary: &'a TransformSummary, _: &()) {
863 self.0 += summary.input.lines;
864 }
865}
866
867impl<'a> sum_tree::Dimension<'a, TransformSummary> for WrapPoint {
868 fn add_summary(&mut self, summary: &'a TransformSummary, _: &()) {
869 self.0 += summary.output.lines;
870 }
871}
872
873#[cfg(test)]
874mod tests {
875 use super::*;
876 use crate::{
877 editor::{
878 display_map::{fold_map::FoldMap, tab_map::TabMap},
879 Buffer,
880 },
881 test::Observer,
882 util::RandomCharIter,
883 };
884 use rand::prelude::*;
885 use std::env;
886
887 #[gpui::test(iterations = 100)]
888 async fn test_random_wraps(mut cx: gpui::TestAppContext, mut rng: StdRng) {
889 cx.foreground().set_block_on_ticks(0..=50);
890 cx.foreground().forbid_parking();
891 let operations = env::var("OPERATIONS")
892 .map(|i| i.parse().expect("invalid `OPERATIONS` variable"))
893 .unwrap_or(10);
894
895 let font_cache = cx.font_cache().clone();
896 let font_system = cx.platform().fonts();
897 let mut wrap_width = if rng.gen_bool(0.1) {
898 None
899 } else {
900 Some(rng.gen_range(0.0..=1000.0))
901 };
902 let settings = Settings {
903 tab_size: rng.gen_range(1..=4),
904 buffer_font_family: font_cache.load_family(&["Helvetica"]).unwrap(),
905 buffer_font_size: 14.0,
906 ..Settings::new(&font_cache).unwrap()
907 };
908 log::info!("Tab size: {}", settings.tab_size);
909 log::info!("Wrap width: {:?}", wrap_width);
910
911 let buffer = cx.add_model(|cx| {
912 let len = rng.gen_range(0..10);
913 let text = RandomCharIter::new(&mut rng).take(len).collect::<String>();
914 Buffer::new(0, text, cx)
915 });
916 let (mut fold_map, folds_snapshot) = cx.read(|cx| FoldMap::new(buffer.clone(), cx));
917 let (tab_map, tabs_snapshot) = TabMap::new(folds_snapshot.clone(), settings.tab_size);
918 log::info!(
919 "Unwrapped text (no folds): {:?}",
920 buffer.read_with(&cx, |buf, _| buf.text())
921 );
922 log::info!(
923 "Unwrapped text (unexpanded tabs): {:?}",
924 folds_snapshot.text()
925 );
926 log::info!("Unwrapped text (expanded tabs): {:?}", tabs_snapshot.text());
927 let wrap_map = cx
928 .add_model(|cx| WrapMap::new(tabs_snapshot.clone(), settings.clone(), wrap_width, cx));
929 let (_observer, notifications) = Observer::new(&wrap_map, &mut cx);
930
931 let mut line_wrapper = LineWrapper::new(font_system, &font_cache, settings);
932 let unwrapped_text = tabs_snapshot.text();
933 let expected_text = wrap_text(&unwrapped_text, wrap_width, &mut line_wrapper);
934
935 if wrap_map.read_with(&cx, |map, _| map.is_rewrapping()) {
936 notifications.recv().await.unwrap();
937 }
938
939 let snapshot = wrap_map.update(&mut cx, |map, cx| map.sync(tabs_snapshot, Vec::new(), cx));
940 let actual_text = snapshot.text();
941 assert_eq!(
942 actual_text, expected_text,
943 "unwrapped text is: {:?}",
944 unwrapped_text
945 );
946 log::info!("Wrapped text: {:?}", actual_text);
947
948 for _i in 0..operations {
949 match rng.gen_range(0..=100) {
950 0..=19 => {
951 wrap_width = if rng.gen_bool(0.2) {
952 None
953 } else {
954 Some(rng.gen_range(0.0..=1000.0))
955 };
956 log::info!("Setting wrap width to {:?}", wrap_width);
957 wrap_map.update(&mut cx, |map, cx| map.set_wrap_width(wrap_width, cx));
958 }
959 20..=39 => {
960 for (folds_snapshot, edits) in
961 cx.read(|cx| fold_map.randomly_mutate(&mut rng, cx))
962 {
963 let (tabs_snapshot, edits) = tab_map.sync(folds_snapshot, edits);
964 let mut snapshot =
965 wrap_map.update(&mut cx, |map, cx| map.sync(tabs_snapshot, edits, cx));
966 snapshot.check_invariants();
967 snapshot.verify_chunks(&mut rng);
968 }
969 }
970 _ => {
971 buffer.update(&mut cx, |buffer, cx| buffer.randomly_mutate(&mut rng, cx));
972 }
973 }
974
975 log::info!(
976 "Unwrapped text (no folds): {:?}",
977 buffer.read_with(&cx, |buf, _| buf.text())
978 );
979 let (folds_snapshot, edits) = cx.read(|cx| fold_map.read(cx));
980 log::info!(
981 "Unwrapped text (unexpanded tabs): {:?}",
982 folds_snapshot.text()
983 );
984 let (tabs_snapshot, edits) = tab_map.sync(folds_snapshot, edits);
985 log::info!("Unwrapped text (expanded tabs): {:?}", tabs_snapshot.text());
986
987 let unwrapped_text = tabs_snapshot.text();
988 let expected_text = wrap_text(&unwrapped_text, wrap_width, &mut line_wrapper);
989 let mut snapshot = wrap_map.update(&mut cx, |map, cx| {
990 map.sync(tabs_snapshot.clone(), edits, cx)
991 });
992 snapshot.check_invariants();
993 snapshot.verify_chunks(&mut rng);
994
995 if wrap_map.read_with(&cx, |map, _| map.is_rewrapping()) && rng.gen_bool(0.4) {
996 log::info!("Waiting for wrapping to finish");
997 while wrap_map.read_with(&cx, |map, _| map.is_rewrapping()) {
998 notifications.recv().await.unwrap();
999 }
1000 }
1001
1002 if !wrap_map.read_with(&cx, |map, _| map.is_rewrapping()) {
1003 let mut wrapped_snapshot =
1004 wrap_map.update(&mut cx, |map, cx| map.sync(tabs_snapshot, Vec::new(), cx));
1005 let actual_text = wrapped_snapshot.text();
1006 log::info!("Wrapping finished: {:?}", actual_text);
1007 wrapped_snapshot.check_invariants();
1008 wrapped_snapshot.verify_chunks(&mut rng);
1009 assert_eq!(
1010 actual_text, expected_text,
1011 "unwrapped text is: {:?}",
1012 unwrapped_text
1013 );
1014 }
1015 }
1016 }
1017
1018 fn wrap_text(
1019 unwrapped_text: &str,
1020 wrap_width: Option<f32>,
1021 line_wrapper: &mut LineWrapper,
1022 ) -> String {
1023 if let Some(wrap_width) = wrap_width {
1024 let mut wrapped_text = String::new();
1025 for (row, line) in unwrapped_text.split('\n').enumerate() {
1026 if row > 0 {
1027 wrapped_text.push('\n')
1028 }
1029
1030 let mut prev_ix = 0;
1031 for boundary in line_wrapper.wrap_line(line, wrap_width) {
1032 wrapped_text.push_str(&line[prev_ix..boundary.ix]);
1033 wrapped_text.push('\n');
1034 wrapped_text.push_str(&" ".repeat(boundary.next_indent as usize));
1035 prev_ix = boundary.ix;
1036 }
1037 wrapped_text.push_str(&line[prev_ix..]);
1038 }
1039 wrapped_text
1040 } else {
1041 unwrapped_text.to_string()
1042 }
1043 }
1044
1045 impl Snapshot {
1046 fn text(&self) -> String {
1047 self.chunks_at(0).collect()
1048 }
1049
1050 fn verify_chunks(&mut self, rng: &mut impl Rng) {
1051 for _ in 0..5 {
1052 let mut end_row = rng.gen_range(0..=self.max_point().row());
1053 let start_row = rng.gen_range(0..=end_row);
1054 end_row += 1;
1055
1056 let mut expected_text = self.chunks_at(start_row).collect::<String>();
1057 if expected_text.ends_with("\n") {
1058 expected_text.push('\n');
1059 }
1060 let mut expected_text = expected_text
1061 .lines()
1062 .take((end_row - start_row) as usize)
1063 .collect::<Vec<_>>()
1064 .join("\n");
1065 if end_row <= self.max_point().row() {
1066 expected_text.push('\n');
1067 }
1068
1069 let actual_text = self
1070 .highlighted_chunks_for_rows(start_row..end_row)
1071 .map(|c| c.0)
1072 .collect::<String>();
1073 assert_eq!(
1074 expected_text,
1075 actual_text,
1076 "chunks != highlighted_chunks for rows {:?}",
1077 start_row..end_row
1078 );
1079 }
1080 }
1081 }
1082}