1use super::{
2 fold_map::FoldBufferRows,
3 tab_map::{self, TabEdit, TabPoint, TabSnapshot},
4 TextHighlights,
5};
6use crate::MultiBufferSnapshot;
7use gpui::{
8 fonts::{FontId, HighlightStyle},
9 text_layout::LineWrapper,
10 AppContext, Entity, ModelContext, ModelHandle, Task,
11};
12use language::{Chunk, Point};
13use lazy_static::lazy_static;
14use smol::future::yield_now;
15use std::{cmp, collections::VecDeque, mem, ops::Range, time::Duration};
16use sum_tree::{Bias, Cursor, SumTree};
17use text::Patch;
18
19pub use super::tab_map::TextSummary;
20pub type WrapEdit = text::Edit<u32>;
21
22pub struct WrapMap {
23 snapshot: WrapSnapshot,
24 pending_edits: VecDeque<(TabSnapshot, Vec<TabEdit>)>,
25 interpolated_edits: Patch<u32>,
26 edits_since_sync: Patch<u32>,
27 wrap_width: Option<f32>,
28 background_task: Option<Task<()>>,
29 font: (FontId, f32),
30}
31
32impl Entity for WrapMap {
33 type Event = ();
34}
35
36#[derive(Clone)]
37pub struct WrapSnapshot {
38 tab_snapshot: TabSnapshot,
39 transforms: SumTree<Transform>,
40 interpolated: bool,
41}
42
43#[derive(Clone, Debug, Default, Eq, PartialEq)]
44struct Transform {
45 summary: TransformSummary,
46 display_text: Option<&'static str>,
47}
48
49#[derive(Clone, Debug, Default, Eq, PartialEq)]
50struct TransformSummary {
51 input: TextSummary,
52 output: TextSummary,
53}
54
55#[derive(Copy, Clone, Debug, Default, Eq, Ord, PartialOrd, PartialEq)]
56pub struct WrapPoint(pub Point);
57
58pub struct WrapChunks<'a> {
59 input_chunks: tab_map::TabChunks<'a>,
60 input_chunk: Chunk<'a>,
61 output_position: WrapPoint,
62 max_output_row: u32,
63 transforms: Cursor<'a, Transform, (WrapPoint, TabPoint)>,
64}
65
66#[derive(Clone)]
67pub struct WrapBufferRows<'a> {
68 input_buffer_rows: FoldBufferRows<'a>,
69 input_buffer_row: Option<u32>,
70 output_row: u32,
71 soft_wrapped: bool,
72 max_output_row: u32,
73 transforms: Cursor<'a, Transform, (WrapPoint, TabPoint)>,
74}
75
76impl WrapMap {
77 pub fn new(
78 tab_snapshot: TabSnapshot,
79 font_id: FontId,
80 font_size: f32,
81 wrap_width: Option<f32>,
82 cx: &mut AppContext,
83 ) -> (ModelHandle<Self>, WrapSnapshot) {
84 let handle = cx.add_model(|cx| {
85 let mut this = Self {
86 font: (font_id, font_size),
87 wrap_width: None,
88 pending_edits: Default::default(),
89 interpolated_edits: Default::default(),
90 edits_since_sync: Default::default(),
91 snapshot: WrapSnapshot::new(tab_snapshot),
92 background_task: None,
93 };
94 this.set_wrap_width(wrap_width, cx);
95 mem::take(&mut this.edits_since_sync);
96 this
97 });
98 let snapshot = handle.read(cx).snapshot.clone();
99 (handle, snapshot)
100 }
101
102 #[cfg(test)]
103 pub fn is_rewrapping(&self) -> bool {
104 self.background_task.is_some()
105 }
106
107 pub fn sync(
108 &mut self,
109 tab_snapshot: TabSnapshot,
110 edits: Vec<TabEdit>,
111 cx: &mut ModelContext<Self>,
112 ) -> (WrapSnapshot, Patch<u32>) {
113 if self.wrap_width.is_some() {
114 self.pending_edits.push_back((tab_snapshot, edits));
115 self.flush_edits(cx);
116 } else {
117 self.edits_since_sync = self
118 .edits_since_sync
119 .compose(&self.snapshot.interpolate(tab_snapshot, &edits));
120 self.snapshot.interpolated = false;
121 }
122
123 (self.snapshot.clone(), mem::take(&mut self.edits_since_sync))
124 }
125
126 pub fn set_font(
127 &mut self,
128 font_id: FontId,
129 font_size: f32,
130 cx: &mut ModelContext<Self>,
131 ) -> bool {
132 if (font_id, font_size) != self.font {
133 self.font = (font_id, font_size);
134 self.rewrap(cx);
135 true
136 } else {
137 false
138 }
139 }
140
141 pub fn set_wrap_width(&mut self, wrap_width: Option<f32>, cx: &mut ModelContext<Self>) -> bool {
142 if wrap_width == self.wrap_width {
143 return false;
144 }
145
146 self.wrap_width = wrap_width;
147 self.rewrap(cx);
148 true
149 }
150
151 fn rewrap(&mut self, cx: &mut ModelContext<Self>) {
152 self.background_task.take();
153 self.interpolated_edits.clear();
154 self.pending_edits.clear();
155
156 if let Some(wrap_width) = self.wrap_width {
157 let mut new_snapshot = self.snapshot.clone();
158 let font_cache = cx.font_cache().clone();
159 let (font_id, font_size) = self.font;
160 let task = cx.background().spawn(async move {
161 let mut line_wrapper = font_cache.line_wrapper(font_id, font_size);
162 let tab_snapshot = new_snapshot.tab_snapshot.clone();
163 let range = TabPoint::zero()..tab_snapshot.max_point();
164 let edits = new_snapshot
165 .update(
166 tab_snapshot,
167 &[TabEdit {
168 old: range.clone(),
169 new: range.clone(),
170 }],
171 wrap_width,
172 &mut line_wrapper,
173 )
174 .await;
175 (new_snapshot, edits)
176 });
177
178 match cx
179 .background()
180 .block_with_timeout(Duration::from_millis(5), task)
181 {
182 Ok((snapshot, edits)) => {
183 self.snapshot = snapshot;
184 self.edits_since_sync = self.edits_since_sync.compose(&edits);
185 cx.notify();
186 }
187 Err(wrap_task) => {
188 self.background_task = Some(cx.spawn(|this, mut cx| async move {
189 let (snapshot, edits) = wrap_task.await;
190 this.update(&mut cx, |this, cx| {
191 this.snapshot = snapshot;
192 this.edits_since_sync = this
193 .edits_since_sync
194 .compose(mem::take(&mut this.interpolated_edits).invert())
195 .compose(&edits);
196 this.background_task = None;
197 this.flush_edits(cx);
198 cx.notify();
199 });
200 }));
201 }
202 }
203 } else {
204 let old_rows = self.snapshot.transforms.summary().output.lines.row + 1;
205 self.snapshot.transforms = SumTree::new();
206 let summary = self.snapshot.tab_snapshot.text_summary();
207 if !summary.lines.is_zero() {
208 self.snapshot
209 .transforms
210 .push(Transform::isomorphic(summary), &());
211 }
212 let new_rows = self.snapshot.transforms.summary().output.lines.row + 1;
213 self.snapshot.interpolated = false;
214 self.edits_since_sync = self.edits_since_sync.compose(&Patch::new(vec![WrapEdit {
215 old: 0..old_rows,
216 new: 0..new_rows,
217 }]));
218 }
219 }
220
221 fn flush_edits(&mut self, cx: &mut ModelContext<Self>) {
222 if !self.snapshot.interpolated {
223 let mut to_remove_len = 0;
224 for (tab_snapshot, _) in &self.pending_edits {
225 if tab_snapshot.version <= self.snapshot.tab_snapshot.version {
226 to_remove_len += 1;
227 } else {
228 break;
229 }
230 }
231 self.pending_edits.drain(..to_remove_len);
232 }
233
234 if self.pending_edits.is_empty() {
235 return;
236 }
237
238 if let Some(wrap_width) = self.wrap_width {
239 if self.background_task.is_none() {
240 let pending_edits = self.pending_edits.clone();
241 let mut snapshot = self.snapshot.clone();
242 let font_cache = cx.font_cache().clone();
243 let (font_id, font_size) = self.font;
244 let update_task = cx.background().spawn(async move {
245 let mut line_wrapper = font_cache.line_wrapper(font_id, font_size);
246
247 let mut edits = Patch::default();
248 for (tab_snapshot, tab_edits) in pending_edits {
249 let wrap_edits = snapshot
250 .update(tab_snapshot, &tab_edits, wrap_width, &mut line_wrapper)
251 .await;
252 edits = edits.compose(&wrap_edits);
253 }
254 (snapshot, edits)
255 });
256
257 match cx
258 .background()
259 .block_with_timeout(Duration::from_millis(1), update_task)
260 {
261 Ok((snapshot, output_edits)) => {
262 self.snapshot = snapshot;
263 self.edits_since_sync = self.edits_since_sync.compose(&output_edits);
264 }
265 Err(update_task) => {
266 self.background_task = Some(cx.spawn(|this, mut cx| async move {
267 let (snapshot, edits) = update_task.await;
268 this.update(&mut cx, |this, cx| {
269 this.snapshot = snapshot;
270 this.edits_since_sync = this
271 .edits_since_sync
272 .compose(mem::take(&mut this.interpolated_edits).invert())
273 .compose(&edits);
274 this.background_task = None;
275 this.flush_edits(cx);
276 cx.notify();
277 });
278 }));
279 }
280 }
281 }
282 }
283
284 let was_interpolated = self.snapshot.interpolated;
285 let mut to_remove_len = 0;
286 for (tab_snapshot, edits) in &self.pending_edits {
287 if tab_snapshot.version <= self.snapshot.tab_snapshot.version {
288 to_remove_len += 1;
289 } else {
290 let interpolated_edits = self.snapshot.interpolate(tab_snapshot.clone(), edits);
291 self.edits_since_sync = self.edits_since_sync.compose(&interpolated_edits);
292 self.interpolated_edits = self.interpolated_edits.compose(&interpolated_edits);
293 }
294 }
295
296 if !was_interpolated {
297 self.pending_edits.drain(..to_remove_len);
298 }
299 }
300}
301
302impl WrapSnapshot {
303 fn new(tab_snapshot: TabSnapshot) -> Self {
304 let mut transforms = SumTree::new();
305 let extent = tab_snapshot.text_summary();
306 if !extent.lines.is_zero() {
307 transforms.push(Transform::isomorphic(extent), &());
308 }
309 Self {
310 transforms,
311 tab_snapshot,
312 interpolated: true,
313 }
314 }
315
316 pub fn buffer_snapshot(&self) -> &MultiBufferSnapshot {
317 self.tab_snapshot.buffer_snapshot()
318 }
319
320 fn interpolate(&mut self, new_tab_snapshot: TabSnapshot, tab_edits: &[TabEdit]) -> Patch<u32> {
321 let mut new_transforms;
322 if tab_edits.is_empty() {
323 new_transforms = self.transforms.clone();
324 } else {
325 let mut old_cursor = self.transforms.cursor::<TabPoint>();
326
327 let mut tab_edits_iter = tab_edits.iter().peekable();
328 new_transforms =
329 old_cursor.slice(&tab_edits_iter.peek().unwrap().old.start, Bias::Right, &());
330
331 while let Some(edit) = tab_edits_iter.next() {
332 if edit.new.start > TabPoint::from(new_transforms.summary().input.lines) {
333 let summary = new_tab_snapshot.text_summary_for_range(
334 TabPoint::from(new_transforms.summary().input.lines)..edit.new.start,
335 );
336 new_transforms.push_or_extend(Transform::isomorphic(summary));
337 }
338
339 if !edit.new.is_empty() {
340 new_transforms.push_or_extend(Transform::isomorphic(
341 new_tab_snapshot.text_summary_for_range(edit.new.clone()),
342 ));
343 }
344
345 old_cursor.seek_forward(&edit.old.end, Bias::Right, &());
346 if let Some(next_edit) = tab_edits_iter.peek() {
347 if next_edit.old.start > old_cursor.end(&()) {
348 if old_cursor.end(&()) > edit.old.end {
349 let summary = self
350 .tab_snapshot
351 .text_summary_for_range(edit.old.end..old_cursor.end(&()));
352 new_transforms.push_or_extend(Transform::isomorphic(summary));
353 }
354
355 old_cursor.next(&());
356 new_transforms.append(
357 old_cursor.slice(&next_edit.old.start, Bias::Right, &()),
358 &(),
359 );
360 }
361 } else {
362 if old_cursor.end(&()) > edit.old.end {
363 let summary = self
364 .tab_snapshot
365 .text_summary_for_range(edit.old.end..old_cursor.end(&()));
366 new_transforms.push_or_extend(Transform::isomorphic(summary));
367 }
368 old_cursor.next(&());
369 new_transforms.append(old_cursor.suffix(&()), &());
370 }
371 }
372 }
373
374 let old_snapshot = mem::replace(
375 self,
376 WrapSnapshot {
377 tab_snapshot: new_tab_snapshot,
378 transforms: new_transforms,
379 interpolated: true,
380 },
381 );
382 self.check_invariants();
383 old_snapshot.compute_edits(tab_edits, self)
384 }
385
386 async fn update(
387 &mut self,
388 new_tab_snapshot: TabSnapshot,
389 tab_edits: &[TabEdit],
390 wrap_width: f32,
391 line_wrapper: &mut LineWrapper,
392 ) -> Patch<u32> {
393 #[derive(Debug)]
394 struct RowEdit {
395 old_rows: Range<u32>,
396 new_rows: Range<u32>,
397 }
398
399 let mut tab_edits_iter = tab_edits.iter().peekable();
400 let mut row_edits = Vec::new();
401 while let Some(edit) = tab_edits_iter.next() {
402 let mut row_edit = RowEdit {
403 old_rows: edit.old.start.row()..edit.old.end.row() + 1,
404 new_rows: edit.new.start.row()..edit.new.end.row() + 1,
405 };
406
407 while let Some(next_edit) = tab_edits_iter.peek() {
408 if next_edit.old.start.row() <= row_edit.old_rows.end {
409 row_edit.old_rows.end = next_edit.old.end.row() + 1;
410 row_edit.new_rows.end = next_edit.new.end.row() + 1;
411 tab_edits_iter.next();
412 } else {
413 break;
414 }
415 }
416
417 row_edits.push(row_edit);
418 }
419
420 let mut new_transforms;
421 if row_edits.is_empty() {
422 new_transforms = self.transforms.clone();
423 } else {
424 let mut row_edits = row_edits.into_iter().peekable();
425 let mut old_cursor = self.transforms.cursor::<TabPoint>();
426
427 new_transforms = old_cursor.slice(
428 &TabPoint::new(row_edits.peek().unwrap().old_rows.start, 0),
429 Bias::Right,
430 &(),
431 );
432
433 while let Some(edit) = row_edits.next() {
434 if edit.new_rows.start > new_transforms.summary().input.lines.row {
435 let summary = new_tab_snapshot.text_summary_for_range(
436 TabPoint(new_transforms.summary().input.lines)
437 ..TabPoint::new(edit.new_rows.start, 0),
438 );
439 new_transforms.push_or_extend(Transform::isomorphic(summary));
440 }
441
442 let mut line = String::new();
443 let mut remaining = None;
444 let mut chunks = new_tab_snapshot.chunks(
445 TabPoint::new(edit.new_rows.start, 0)..new_tab_snapshot.max_point(),
446 false,
447 None,
448 None,
449 None,
450 );
451 let mut edit_transforms = Vec::<Transform>::new();
452 for _ in edit.new_rows.start..edit.new_rows.end {
453 while let Some(chunk) =
454 remaining.take().or_else(|| chunks.next().map(|c| c.text))
455 {
456 if let Some(ix) = chunk.find('\n') {
457 line.push_str(&chunk[..ix + 1]);
458 remaining = Some(&chunk[ix + 1..]);
459 break;
460 } else {
461 line.push_str(chunk)
462 }
463 }
464
465 if line.is_empty() {
466 break;
467 }
468
469 let mut prev_boundary_ix = 0;
470 for boundary in line_wrapper.wrap_line(&line, wrap_width) {
471 let wrapped = &line[prev_boundary_ix..boundary.ix];
472 push_isomorphic(&mut edit_transforms, TextSummary::from(wrapped));
473 edit_transforms.push(Transform::wrap(boundary.next_indent));
474 prev_boundary_ix = boundary.ix;
475 }
476
477 if prev_boundary_ix < line.len() {
478 push_isomorphic(
479 &mut edit_transforms,
480 TextSummary::from(&line[prev_boundary_ix..]),
481 );
482 }
483
484 line.clear();
485 yield_now().await;
486 }
487
488 let mut edit_transforms = edit_transforms.into_iter();
489 if let Some(transform) = edit_transforms.next() {
490 new_transforms.push_or_extend(transform);
491 }
492 new_transforms.extend(edit_transforms, &());
493
494 old_cursor.seek_forward(&TabPoint::new(edit.old_rows.end, 0), Bias::Right, &());
495 if let Some(next_edit) = row_edits.peek() {
496 if next_edit.old_rows.start > old_cursor.end(&()).row() {
497 if old_cursor.end(&()) > TabPoint::new(edit.old_rows.end, 0) {
498 let summary = self.tab_snapshot.text_summary_for_range(
499 TabPoint::new(edit.old_rows.end, 0)..old_cursor.end(&()),
500 );
501 new_transforms.push_or_extend(Transform::isomorphic(summary));
502 }
503 old_cursor.next(&());
504 new_transforms.append(
505 old_cursor.slice(
506 &TabPoint::new(next_edit.old_rows.start, 0),
507 Bias::Right,
508 &(),
509 ),
510 &(),
511 );
512 }
513 } else {
514 if old_cursor.end(&()) > TabPoint::new(edit.old_rows.end, 0) {
515 let summary = self.tab_snapshot.text_summary_for_range(
516 TabPoint::new(edit.old_rows.end, 0)..old_cursor.end(&()),
517 );
518 new_transforms.push_or_extend(Transform::isomorphic(summary));
519 }
520 old_cursor.next(&());
521 new_transforms.append(old_cursor.suffix(&()), &());
522 }
523 }
524 }
525
526 let old_snapshot = mem::replace(
527 self,
528 WrapSnapshot {
529 tab_snapshot: new_tab_snapshot,
530 transforms: new_transforms,
531 interpolated: false,
532 },
533 );
534 self.check_invariants();
535 old_snapshot.compute_edits(tab_edits, self)
536 }
537
538 fn compute_edits(&self, tab_edits: &[TabEdit], new_snapshot: &WrapSnapshot) -> Patch<u32> {
539 let mut wrap_edits = Vec::new();
540 let mut old_cursor = self.transforms.cursor::<TransformSummary>();
541 let mut new_cursor = new_snapshot.transforms.cursor::<TransformSummary>();
542 for mut tab_edit in tab_edits.iter().cloned() {
543 tab_edit.old.start.0.column = 0;
544 tab_edit.old.end.0 += Point::new(1, 0);
545 tab_edit.new.start.0.column = 0;
546 tab_edit.new.end.0 += Point::new(1, 0);
547
548 old_cursor.seek(&tab_edit.old.start, Bias::Right, &());
549 let mut old_start = old_cursor.start().output.lines;
550 old_start += tab_edit.old.start.0 - old_cursor.start().input.lines;
551
552 old_cursor.seek(&tab_edit.old.end, Bias::Right, &());
553 let mut old_end = old_cursor.start().output.lines;
554 old_end += tab_edit.old.end.0 - old_cursor.start().input.lines;
555
556 new_cursor.seek(&tab_edit.new.start, Bias::Right, &());
557 let mut new_start = new_cursor.start().output.lines;
558 new_start += tab_edit.new.start.0 - new_cursor.start().input.lines;
559
560 new_cursor.seek(&tab_edit.new.end, Bias::Right, &());
561 let mut new_end = new_cursor.start().output.lines;
562 new_end += tab_edit.new.end.0 - new_cursor.start().input.lines;
563
564 wrap_edits.push(WrapEdit {
565 old: old_start.row..old_end.row,
566 new: new_start.row..new_end.row,
567 });
568 }
569
570 consolidate_wrap_edits(&mut wrap_edits);
571 Patch::new(wrap_edits)
572 }
573
574 pub fn chunks<'a>(
575 &'a self,
576 rows: Range<u32>,
577 language_aware: bool,
578 text_highlights: Option<&'a TextHighlights>,
579 hint_highlight_style: Option<HighlightStyle>,
580 suggestion_highlight_style: Option<HighlightStyle>,
581 ) -> WrapChunks<'a> {
582 let output_start = WrapPoint::new(rows.start, 0);
583 let output_end = WrapPoint::new(rows.end, 0);
584 let mut transforms = self.transforms.cursor::<(WrapPoint, TabPoint)>();
585 transforms.seek(&output_start, Bias::Right, &());
586 let mut input_start = TabPoint(transforms.start().1 .0);
587 if transforms.item().map_or(false, |t| t.is_isomorphic()) {
588 input_start.0 += output_start.0 - transforms.start().0 .0;
589 }
590 let input_end = self
591 .to_tab_point(output_end)
592 .min(self.tab_snapshot.max_point());
593 WrapChunks {
594 input_chunks: self.tab_snapshot.chunks(
595 input_start..input_end,
596 language_aware,
597 text_highlights,
598 hint_highlight_style,
599 suggestion_highlight_style,
600 ),
601 input_chunk: Default::default(),
602 output_position: output_start,
603 max_output_row: rows.end,
604 transforms,
605 }
606 }
607
608 pub fn max_point(&self) -> WrapPoint {
609 WrapPoint(self.transforms.summary().output.lines)
610 }
611
612 pub fn line_len(&self, row: u32) -> u32 {
613 let mut cursor = self.transforms.cursor::<(WrapPoint, TabPoint)>();
614 cursor.seek(&WrapPoint::new(row + 1, 0), Bias::Left, &());
615 if cursor
616 .item()
617 .map_or(false, |transform| transform.is_isomorphic())
618 {
619 let overshoot = row - cursor.start().0.row();
620 let tab_row = cursor.start().1.row() + overshoot;
621 let tab_line_len = self.tab_snapshot.line_len(tab_row);
622 if overshoot == 0 {
623 cursor.start().0.column() + (tab_line_len - cursor.start().1.column())
624 } else {
625 tab_line_len
626 }
627 } else {
628 cursor.start().0.column()
629 }
630 }
631
632 pub fn soft_wrap_indent(&self, row: u32) -> Option<u32> {
633 let mut cursor = self.transforms.cursor::<WrapPoint>();
634 cursor.seek(&WrapPoint::new(row + 1, 0), Bias::Right, &());
635 cursor.item().and_then(|transform| {
636 if transform.is_isomorphic() {
637 None
638 } else {
639 Some(transform.summary.output.lines.column)
640 }
641 })
642 }
643
644 pub fn longest_row(&self) -> u32 {
645 self.transforms.summary().output.longest_row
646 }
647
648 pub fn buffer_rows(&self, start_row: u32) -> WrapBufferRows {
649 let mut transforms = self.transforms.cursor::<(WrapPoint, TabPoint)>();
650 transforms.seek(&WrapPoint::new(start_row, 0), Bias::Left, &());
651 let mut input_row = transforms.start().1.row();
652 if transforms.item().map_or(false, |t| t.is_isomorphic()) {
653 input_row += start_row - transforms.start().0.row();
654 }
655 let soft_wrapped = transforms.item().map_or(false, |t| !t.is_isomorphic());
656 let mut input_buffer_rows = self.tab_snapshot.buffer_rows(input_row);
657 let input_buffer_row = input_buffer_rows.next().unwrap();
658 WrapBufferRows {
659 transforms,
660 input_buffer_row,
661 input_buffer_rows,
662 output_row: start_row,
663 soft_wrapped,
664 max_output_row: self.max_point().row(),
665 }
666 }
667
668 pub fn to_tab_point(&self, point: WrapPoint) -> TabPoint {
669 let mut cursor = self.transforms.cursor::<(WrapPoint, TabPoint)>();
670 cursor.seek(&point, Bias::Right, &());
671 let mut tab_point = cursor.start().1 .0;
672 if cursor.item().map_or(false, |t| t.is_isomorphic()) {
673 tab_point += point.0 - cursor.start().0 .0;
674 }
675 TabPoint(tab_point)
676 }
677
678 pub fn to_point(&self, point: WrapPoint, bias: Bias) -> Point {
679 self.tab_snapshot.to_point(self.to_tab_point(point), bias)
680 }
681
682 pub fn make_wrap_point(&self, point: Point, bias: Bias) -> WrapPoint {
683 self.tab_point_to_wrap_point(self.tab_snapshot.make_tab_point(point, bias))
684 }
685
686 pub fn tab_point_to_wrap_point(&self, point: TabPoint) -> WrapPoint {
687 let mut cursor = self.transforms.cursor::<(TabPoint, WrapPoint)>();
688 cursor.seek(&point, Bias::Right, &());
689 WrapPoint(cursor.start().1 .0 + (point.0 - cursor.start().0 .0))
690 }
691
692 pub fn clip_point(&self, mut point: WrapPoint, bias: Bias) -> WrapPoint {
693 if bias == Bias::Left {
694 let mut cursor = self.transforms.cursor::<WrapPoint>();
695 cursor.seek(&point, Bias::Right, &());
696 if cursor.item().map_or(false, |t| !t.is_isomorphic()) {
697 point = *cursor.start();
698 *point.column_mut() -= 1;
699 }
700 }
701
702 self.tab_point_to_wrap_point(self.tab_snapshot.clip_point(self.to_tab_point(point), bias))
703 }
704
705 pub fn prev_row_boundary(&self, mut point: WrapPoint) -> u32 {
706 if self.transforms.is_empty() {
707 return 0;
708 }
709
710 *point.column_mut() = 0;
711
712 let mut cursor = self.transforms.cursor::<(WrapPoint, TabPoint)>();
713 cursor.seek(&point, Bias::Right, &());
714 if cursor.item().is_none() {
715 cursor.prev(&());
716 }
717
718 while let Some(transform) = cursor.item() {
719 if transform.is_isomorphic() && cursor.start().1.column() == 0 {
720 return cmp::min(cursor.end(&()).0.row(), point.row());
721 } else {
722 cursor.prev(&());
723 }
724 }
725
726 unreachable!()
727 }
728
729 pub fn next_row_boundary(&self, mut point: WrapPoint) -> Option<u32> {
730 point.0 += Point::new(1, 0);
731
732 let mut cursor = self.transforms.cursor::<(WrapPoint, TabPoint)>();
733 cursor.seek(&point, Bias::Right, &());
734 while let Some(transform) = cursor.item() {
735 if transform.is_isomorphic() && cursor.start().1.column() == 0 {
736 return Some(cmp::max(cursor.start().0.row(), point.row()));
737 } else {
738 cursor.next(&());
739 }
740 }
741
742 None
743 }
744
745 fn check_invariants(&self) {
746 #[cfg(test)]
747 {
748 assert_eq!(
749 TabPoint::from(self.transforms.summary().input.lines),
750 self.tab_snapshot.max_point()
751 );
752
753 {
754 let mut transforms = self.transforms.cursor::<()>().peekable();
755 while let Some(transform) = transforms.next() {
756 if let Some(next_transform) = transforms.peek() {
757 assert!(transform.is_isomorphic() != next_transform.is_isomorphic());
758 }
759 }
760 }
761
762 let text = language::Rope::from(self.text().as_str());
763 let mut input_buffer_rows = self.tab_snapshot.buffer_rows(0);
764 let mut expected_buffer_rows = Vec::new();
765 let mut prev_tab_row = 0;
766 for display_row in 0..=self.max_point().row() {
767 let tab_point = self.to_tab_point(WrapPoint::new(display_row, 0));
768 if tab_point.row() == prev_tab_row && display_row != 0 {
769 expected_buffer_rows.push(None);
770 } else {
771 expected_buffer_rows.push(input_buffer_rows.next().unwrap());
772 }
773
774 prev_tab_row = tab_point.row();
775 assert_eq!(self.line_len(display_row), text.line_len(display_row));
776 }
777
778 for start_display_row in 0..expected_buffer_rows.len() {
779 assert_eq!(
780 self.buffer_rows(start_display_row as u32)
781 .collect::<Vec<_>>(),
782 &expected_buffer_rows[start_display_row..],
783 "invalid buffer_rows({}..)",
784 start_display_row
785 );
786 }
787 }
788 }
789}
790
791impl<'a> Iterator for WrapChunks<'a> {
792 type Item = Chunk<'a>;
793
794 fn next(&mut self) -> Option<Self::Item> {
795 if self.output_position.row() >= self.max_output_row {
796 return None;
797 }
798
799 let transform = self.transforms.item()?;
800 if let Some(display_text) = transform.display_text {
801 let mut start_ix = 0;
802 let mut end_ix = display_text.len();
803 let mut summary = transform.summary.output.lines;
804
805 if self.output_position > self.transforms.start().0 {
806 // Exclude newline starting prior to the desired row.
807 start_ix = 1;
808 summary.row = 0;
809 } else if self.output_position.row() + 1 >= self.max_output_row {
810 // Exclude soft indentation ending after the desired row.
811 end_ix = 1;
812 summary.column = 0;
813 }
814
815 self.output_position.0 += summary;
816 self.transforms.next(&());
817 return Some(Chunk {
818 text: &display_text[start_ix..end_ix],
819 ..self.input_chunk
820 });
821 }
822
823 if self.input_chunk.text.is_empty() {
824 self.input_chunk = self.input_chunks.next().unwrap();
825 }
826
827 let mut input_len = 0;
828 let transform_end = self.transforms.end(&()).0;
829 for c in self.input_chunk.text.chars() {
830 let char_len = c.len_utf8();
831 input_len += char_len;
832 if c == '\n' {
833 *self.output_position.row_mut() += 1;
834 *self.output_position.column_mut() = 0;
835 } else {
836 *self.output_position.column_mut() += char_len as u32;
837 }
838
839 if self.output_position >= transform_end {
840 self.transforms.next(&());
841 break;
842 }
843 }
844
845 let (prefix, suffix) = self.input_chunk.text.split_at(input_len);
846 self.input_chunk.text = suffix;
847 Some(Chunk {
848 text: prefix,
849 ..self.input_chunk
850 })
851 }
852}
853
854impl<'a> Iterator for WrapBufferRows<'a> {
855 type Item = Option<u32>;
856
857 fn next(&mut self) -> Option<Self::Item> {
858 if self.output_row > self.max_output_row {
859 return None;
860 }
861
862 let buffer_row = self.input_buffer_row;
863 let soft_wrapped = self.soft_wrapped;
864
865 self.output_row += 1;
866 self.transforms
867 .seek_forward(&WrapPoint::new(self.output_row, 0), Bias::Left, &());
868 if self.transforms.item().map_or(false, |t| t.is_isomorphic()) {
869 self.input_buffer_row = self.input_buffer_rows.next().unwrap();
870 self.soft_wrapped = false;
871 } else {
872 self.soft_wrapped = true;
873 }
874
875 Some(if soft_wrapped { None } else { buffer_row })
876 }
877}
878
879impl Transform {
880 fn isomorphic(summary: TextSummary) -> Self {
881 #[cfg(test)]
882 assert!(!summary.lines.is_zero());
883
884 Self {
885 summary: TransformSummary {
886 input: summary.clone(),
887 output: summary,
888 },
889 display_text: None,
890 }
891 }
892
893 fn wrap(indent: u32) -> Self {
894 lazy_static! {
895 static ref WRAP_TEXT: String = {
896 let mut wrap_text = String::new();
897 wrap_text.push('\n');
898 wrap_text.extend((0..LineWrapper::MAX_INDENT as usize).map(|_| ' '));
899 wrap_text
900 };
901 }
902
903 Self {
904 summary: TransformSummary {
905 input: TextSummary::default(),
906 output: TextSummary {
907 lines: Point::new(1, indent),
908 first_line_chars: 0,
909 last_line_chars: indent,
910 longest_row: 1,
911 longest_row_chars: indent,
912 },
913 },
914 display_text: Some(&WRAP_TEXT[..1 + indent as usize]),
915 }
916 }
917
918 fn is_isomorphic(&self) -> bool {
919 self.display_text.is_none()
920 }
921}
922
923impl sum_tree::Item for Transform {
924 type Summary = TransformSummary;
925
926 fn summary(&self) -> Self::Summary {
927 self.summary.clone()
928 }
929}
930
931fn push_isomorphic(transforms: &mut Vec<Transform>, summary: TextSummary) {
932 if let Some(last_transform) = transforms.last_mut() {
933 if last_transform.is_isomorphic() {
934 last_transform.summary.input += &summary;
935 last_transform.summary.output += &summary;
936 return;
937 }
938 }
939 transforms.push(Transform::isomorphic(summary));
940}
941
942trait SumTreeExt {
943 fn push_or_extend(&mut self, transform: Transform);
944}
945
946impl SumTreeExt for SumTree<Transform> {
947 fn push_or_extend(&mut self, transform: Transform) {
948 let mut transform = Some(transform);
949 self.update_last(
950 |last_transform| {
951 if last_transform.is_isomorphic() && transform.as_ref().unwrap().is_isomorphic() {
952 let transform = transform.take().unwrap();
953 last_transform.summary.input += &transform.summary.input;
954 last_transform.summary.output += &transform.summary.output;
955 }
956 },
957 &(),
958 );
959
960 if let Some(transform) = transform {
961 self.push(transform, &());
962 }
963 }
964}
965
966impl WrapPoint {
967 pub fn new(row: u32, column: u32) -> Self {
968 Self(Point::new(row, column))
969 }
970
971 pub fn row(self) -> u32 {
972 self.0.row
973 }
974
975 pub fn row_mut(&mut self) -> &mut u32 {
976 &mut self.0.row
977 }
978
979 pub fn column(self) -> u32 {
980 self.0.column
981 }
982
983 pub fn column_mut(&mut self) -> &mut u32 {
984 &mut self.0.column
985 }
986}
987
988impl sum_tree::Summary for TransformSummary {
989 type Context = ();
990
991 fn add_summary(&mut self, other: &Self, _: &()) {
992 self.input += &other.input;
993 self.output += &other.output;
994 }
995}
996
997impl<'a> sum_tree::Dimension<'a, TransformSummary> for TabPoint {
998 fn add_summary(&mut self, summary: &'a TransformSummary, _: &()) {
999 self.0 += summary.input.lines;
1000 }
1001}
1002
1003impl<'a> sum_tree::SeekTarget<'a, TransformSummary, TransformSummary> for TabPoint {
1004 fn cmp(&self, cursor_location: &TransformSummary, _: &()) -> std::cmp::Ordering {
1005 Ord::cmp(&self.0, &cursor_location.input.lines)
1006 }
1007}
1008
1009impl<'a> sum_tree::Dimension<'a, TransformSummary> for WrapPoint {
1010 fn add_summary(&mut self, summary: &'a TransformSummary, _: &()) {
1011 self.0 += summary.output.lines;
1012 }
1013}
1014
1015fn consolidate_wrap_edits(edits: &mut Vec<WrapEdit>) {
1016 let mut i = 1;
1017 while i < edits.len() {
1018 let edit = edits[i].clone();
1019 let prev_edit = &mut edits[i - 1];
1020 if prev_edit.old.end >= edit.old.start {
1021 prev_edit.old.end = edit.old.end;
1022 prev_edit.new.end = edit.new.end;
1023 edits.remove(i);
1024 continue;
1025 }
1026 i += 1;
1027 }
1028}
1029
1030#[cfg(test)]
1031mod tests {
1032 use super::*;
1033 use crate::{
1034 display_map::{fold_map::FoldMap, inlay_map::InlayMap, tab_map::TabMap},
1035 MultiBuffer,
1036 };
1037 use gpui::test::observe;
1038 use rand::prelude::*;
1039 use settings::SettingsStore;
1040 use smol::stream::StreamExt;
1041 use std::{cmp, env, num::NonZeroU32};
1042 use text::Rope;
1043
1044 #[gpui::test(iterations = 100)]
1045 async fn test_random_wraps(cx: &mut gpui::TestAppContext, mut rng: StdRng) {
1046 init_test(cx);
1047
1048 cx.foreground().set_block_on_ticks(0..=50);
1049 let operations = env::var("OPERATIONS")
1050 .map(|i| i.parse().expect("invalid `OPERATIONS` variable"))
1051 .unwrap_or(10);
1052
1053 let font_cache = cx.font_cache().clone();
1054 let font_system = cx.platform().fonts();
1055 let mut wrap_width = if rng.gen_bool(0.1) {
1056 None
1057 } else {
1058 Some(rng.gen_range(0.0..=1000.0))
1059 };
1060 let tab_size = NonZeroU32::new(rng.gen_range(1..=4)).unwrap();
1061 let family_id = font_cache
1062 .load_family(&["Helvetica"], &Default::default())
1063 .unwrap();
1064 let font_id = font_cache
1065 .select_font(family_id, &Default::default())
1066 .unwrap();
1067 let font_size = 14.0;
1068
1069 log::info!("Tab size: {}", tab_size);
1070 log::info!("Wrap width: {:?}", wrap_width);
1071
1072 let buffer = cx.update(|cx| {
1073 if rng.gen() {
1074 MultiBuffer::build_random(&mut rng, cx)
1075 } else {
1076 let len = rng.gen_range(0..10);
1077 let text = util::RandomCharIter::new(&mut rng)
1078 .take(len)
1079 .collect::<String>();
1080 MultiBuffer::build_simple(&text, cx)
1081 }
1082 });
1083 let mut buffer_snapshot = buffer.read_with(cx, |buffer, cx| buffer.snapshot(cx));
1084 log::info!("Buffer text: {:?}", buffer_snapshot.text());
1085 let (mut inlay_map, inlay_snapshot) = InlayMap::new(buffer_snapshot.clone());
1086 log::info!("InlayMap text: {:?}", inlay_snapshot.text());
1087 let (mut fold_map, fold_snapshot) = FoldMap::new(inlay_snapshot.clone());
1088 log::info!("FoldMap text: {:?}", fold_snapshot.text());
1089 let (mut tab_map, _) = TabMap::new(fold_snapshot.clone(), tab_size);
1090 let tabs_snapshot = tab_map.set_max_expansion_column(32);
1091 log::info!("TabMap text: {:?}", tabs_snapshot.text());
1092
1093 let mut line_wrapper = LineWrapper::new(font_id, font_size, font_system);
1094 let unwrapped_text = tabs_snapshot.text();
1095 let expected_text = wrap_text(&unwrapped_text, wrap_width, &mut line_wrapper);
1096
1097 let (wrap_map, _) =
1098 cx.update(|cx| WrapMap::new(tabs_snapshot.clone(), font_id, font_size, wrap_width, cx));
1099 let mut notifications = observe(&wrap_map, cx);
1100
1101 if wrap_map.read_with(cx, |map, _| map.is_rewrapping()) {
1102 notifications.next().await.unwrap();
1103 }
1104
1105 let (initial_snapshot, _) = wrap_map.update(cx, |map, cx| {
1106 assert!(!map.is_rewrapping());
1107 map.sync(tabs_snapshot.clone(), Vec::new(), cx)
1108 });
1109
1110 let actual_text = initial_snapshot.text();
1111 assert_eq!(
1112 actual_text, expected_text,
1113 "unwrapped text is: {:?}",
1114 unwrapped_text
1115 );
1116 log::info!("Wrapped text: {:?}", actual_text);
1117
1118 let mut next_inlay_id = 0;
1119 let mut edits = Vec::new();
1120 for _i in 0..operations {
1121 log::info!("{} ==============================================", _i);
1122
1123 let mut buffer_edits = Vec::new();
1124 match rng.gen_range(0..=100) {
1125 0..=19 => {
1126 wrap_width = if rng.gen_bool(0.2) {
1127 None
1128 } else {
1129 Some(rng.gen_range(0.0..=1000.0))
1130 };
1131 log::info!("Setting wrap width to {:?}", wrap_width);
1132 wrap_map.update(cx, |map, cx| map.set_wrap_width(wrap_width, cx));
1133 }
1134 20..=39 => {
1135 for (fold_snapshot, fold_edits) in fold_map.randomly_mutate(&mut rng) {
1136 let (tabs_snapshot, tab_edits) =
1137 tab_map.sync(fold_snapshot, fold_edits, tab_size);
1138 let (mut snapshot, wrap_edits) =
1139 wrap_map.update(cx, |map, cx| map.sync(tabs_snapshot, tab_edits, cx));
1140 snapshot.check_invariants();
1141 snapshot.verify_chunks(&mut rng);
1142 edits.push((snapshot, wrap_edits));
1143 }
1144 }
1145 40..=59 => {
1146 let (inlay_snapshot, inlay_edits) =
1147 inlay_map.randomly_mutate(&mut next_inlay_id, &mut rng);
1148 let (fold_snapshot, fold_edits) = fold_map.read(inlay_snapshot, inlay_edits);
1149 let (tabs_snapshot, tab_edits) =
1150 tab_map.sync(fold_snapshot, fold_edits, tab_size);
1151 let (mut snapshot, wrap_edits) =
1152 wrap_map.update(cx, |map, cx| map.sync(tabs_snapshot, tab_edits, cx));
1153 snapshot.check_invariants();
1154 snapshot.verify_chunks(&mut rng);
1155 edits.push((snapshot, wrap_edits));
1156 }
1157 _ => {
1158 buffer.update(cx, |buffer, cx| {
1159 let subscription = buffer.subscribe();
1160 let edit_count = rng.gen_range(1..=5);
1161 buffer.randomly_mutate(&mut rng, edit_count, cx);
1162 buffer_snapshot = buffer.snapshot(cx);
1163 buffer_edits.extend(subscription.consume());
1164 });
1165 }
1166 }
1167
1168 log::info!("Buffer text: {:?}", buffer_snapshot.text());
1169 let (inlay_snapshot, inlay_edits) =
1170 inlay_map.sync(buffer_snapshot.clone(), buffer_edits);
1171 log::info!("InlayMap text: {:?}", inlay_snapshot.text());
1172 let (fold_snapshot, fold_edits) = fold_map.read(inlay_snapshot, inlay_edits);
1173 log::info!("FoldMap text: {:?}", fold_snapshot.text());
1174 let (tabs_snapshot, tab_edits) = tab_map.sync(fold_snapshot, fold_edits, tab_size);
1175 log::info!("TabMap text: {:?}", tabs_snapshot.text());
1176
1177 let unwrapped_text = tabs_snapshot.text();
1178 let expected_text = wrap_text(&unwrapped_text, wrap_width, &mut line_wrapper);
1179 let (mut snapshot, wrap_edits) =
1180 wrap_map.update(cx, |map, cx| map.sync(tabs_snapshot.clone(), tab_edits, cx));
1181 snapshot.check_invariants();
1182 snapshot.verify_chunks(&mut rng);
1183 edits.push((snapshot, wrap_edits));
1184
1185 if wrap_map.read_with(cx, |map, _| map.is_rewrapping()) && rng.gen_bool(0.4) {
1186 log::info!("Waiting for wrapping to finish");
1187 while wrap_map.read_with(cx, |map, _| map.is_rewrapping()) {
1188 notifications.next().await.unwrap();
1189 }
1190 wrap_map.read_with(cx, |map, _| assert!(map.pending_edits.is_empty()));
1191 }
1192
1193 if !wrap_map.read_with(cx, |map, _| map.is_rewrapping()) {
1194 let (mut wrapped_snapshot, wrap_edits) =
1195 wrap_map.update(cx, |map, cx| map.sync(tabs_snapshot, Vec::new(), cx));
1196 let actual_text = wrapped_snapshot.text();
1197 let actual_longest_row = wrapped_snapshot.longest_row();
1198 log::info!("Wrapping finished: {:?}", actual_text);
1199 wrapped_snapshot.check_invariants();
1200 wrapped_snapshot.verify_chunks(&mut rng);
1201 edits.push((wrapped_snapshot.clone(), wrap_edits));
1202 assert_eq!(
1203 actual_text, expected_text,
1204 "unwrapped text is: {:?}",
1205 unwrapped_text
1206 );
1207
1208 let mut summary = TextSummary::default();
1209 for (ix, item) in wrapped_snapshot
1210 .transforms
1211 .items(&())
1212 .into_iter()
1213 .enumerate()
1214 {
1215 summary += &item.summary.output;
1216 log::info!("{} summary: {:?}", ix, item.summary.output,);
1217 }
1218
1219 if tab_size.get() == 1
1220 || !wrapped_snapshot
1221 .tab_snapshot
1222 .fold_snapshot
1223 .text()
1224 .contains('\t')
1225 {
1226 let mut expected_longest_rows = Vec::new();
1227 let mut longest_line_len = -1;
1228 for (row, line) in expected_text.split('\n').enumerate() {
1229 let line_char_count = line.chars().count() as isize;
1230 if line_char_count > longest_line_len {
1231 expected_longest_rows.clear();
1232 longest_line_len = line_char_count;
1233 }
1234 if line_char_count >= longest_line_len {
1235 expected_longest_rows.push(row as u32);
1236 }
1237 }
1238
1239 assert!(
1240 expected_longest_rows.contains(&actual_longest_row),
1241 "incorrect longest row {}. expected {:?} with length {}",
1242 actual_longest_row,
1243 expected_longest_rows,
1244 longest_line_len,
1245 )
1246 }
1247 }
1248 }
1249
1250 let mut initial_text = Rope::from(initial_snapshot.text().as_str());
1251 for (snapshot, patch) in edits {
1252 let snapshot_text = Rope::from(snapshot.text().as_str());
1253 for edit in &patch {
1254 let old_start = initial_text.point_to_offset(Point::new(edit.new.start, 0));
1255 let old_end = initial_text.point_to_offset(cmp::min(
1256 Point::new(edit.new.start + edit.old.len() as u32, 0),
1257 initial_text.max_point(),
1258 ));
1259 let new_start = snapshot_text.point_to_offset(Point::new(edit.new.start, 0));
1260 let new_end = snapshot_text.point_to_offset(cmp::min(
1261 Point::new(edit.new.end, 0),
1262 snapshot_text.max_point(),
1263 ));
1264 let new_text = snapshot_text
1265 .chunks_in_range(new_start..new_end)
1266 .collect::<String>();
1267
1268 initial_text.replace(old_start..old_end, &new_text);
1269 }
1270 assert_eq!(initial_text.to_string(), snapshot_text.to_string());
1271 }
1272
1273 if wrap_map.read_with(cx, |map, _| map.is_rewrapping()) {
1274 log::info!("Waiting for wrapping to finish");
1275 while wrap_map.read_with(cx, |map, _| map.is_rewrapping()) {
1276 notifications.next().await.unwrap();
1277 }
1278 }
1279 wrap_map.read_with(cx, |map, _| assert!(map.pending_edits.is_empty()));
1280 }
1281
1282 fn init_test(cx: &mut gpui::TestAppContext) {
1283 cx.foreground().forbid_parking();
1284 cx.update(|cx| {
1285 cx.set_global(SettingsStore::test(cx));
1286 theme::init((), cx);
1287 });
1288 }
1289
1290 fn wrap_text(
1291 unwrapped_text: &str,
1292 wrap_width: Option<f32>,
1293 line_wrapper: &mut LineWrapper,
1294 ) -> String {
1295 if let Some(wrap_width) = wrap_width {
1296 let mut wrapped_text = String::new();
1297 for (row, line) in unwrapped_text.split('\n').enumerate() {
1298 if row > 0 {
1299 wrapped_text.push('\n')
1300 }
1301
1302 let mut prev_ix = 0;
1303 for boundary in line_wrapper.wrap_line(line, wrap_width) {
1304 wrapped_text.push_str(&line[prev_ix..boundary.ix]);
1305 wrapped_text.push('\n');
1306 wrapped_text.push_str(&" ".repeat(boundary.next_indent as usize));
1307 prev_ix = boundary.ix;
1308 }
1309 wrapped_text.push_str(&line[prev_ix..]);
1310 }
1311 wrapped_text
1312 } else {
1313 unwrapped_text.to_string()
1314 }
1315 }
1316
1317 impl WrapSnapshot {
1318 pub fn text(&self) -> String {
1319 self.text_chunks(0).collect()
1320 }
1321
1322 pub fn text_chunks(&self, wrap_row: u32) -> impl Iterator<Item = &str> {
1323 self.chunks(
1324 wrap_row..self.max_point().row() + 1,
1325 false,
1326 None,
1327 None,
1328 None,
1329 )
1330 .map(|h| h.text)
1331 }
1332
1333 fn verify_chunks(&mut self, rng: &mut impl Rng) {
1334 for _ in 0..5 {
1335 let mut end_row = rng.gen_range(0..=self.max_point().row());
1336 let start_row = rng.gen_range(0..=end_row);
1337 end_row += 1;
1338
1339 let mut expected_text = self.text_chunks(start_row).collect::<String>();
1340 if expected_text.ends_with('\n') {
1341 expected_text.push('\n');
1342 }
1343 let mut expected_text = expected_text
1344 .lines()
1345 .take((end_row - start_row) as usize)
1346 .collect::<Vec<_>>()
1347 .join("\n");
1348 if end_row <= self.max_point().row() {
1349 expected_text.push('\n');
1350 }
1351
1352 let actual_text = self
1353 .chunks(start_row..end_row, true, None, None, None)
1354 .map(|c| c.text)
1355 .collect::<String>();
1356 assert_eq!(
1357 expected_text,
1358 actual_text,
1359 "chunks != highlighted_chunks for rows {:?}",
1360 start_row..end_row
1361 );
1362 }
1363 }
1364 }
1365}