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