1use super::{
2 wrap_map::{self, WrapEdit, WrapPoint, WrapSnapshot},
3 TextHighlights,
4};
5use crate::{Anchor, Editor, ExcerptId, ExcerptRange, ToPoint as _};
6use collections::{Bound, HashMap, HashSet};
7use gpui::{fonts::HighlightStyle, AnyElement, ViewContext};
8use language::{BufferSnapshot, Chunk, Patch, Point};
9use parking_lot::Mutex;
10use std::{
11 cell::RefCell,
12 cmp::{self, Ordering},
13 fmt::Debug,
14 ops::{Deref, DerefMut, Range},
15 sync::{
16 atomic::{AtomicUsize, Ordering::SeqCst},
17 Arc,
18 },
19};
20use sum_tree::{Bias, SumTree};
21use text::Edit;
22
23const NEWLINES: &[u8] = &[b'\n'; u8::MAX as usize];
24
25pub struct BlockMap {
26 next_block_id: AtomicUsize,
27 wrap_snapshot: RefCell<WrapSnapshot>,
28 blocks: Vec<Arc<Block>>,
29 transforms: RefCell<SumTree<Transform>>,
30 buffer_header_height: u8,
31 excerpt_header_height: u8,
32}
33
34pub struct BlockMapWriter<'a>(&'a mut BlockMap);
35
36pub struct BlockSnapshot {
37 wrap_snapshot: WrapSnapshot,
38 transforms: SumTree<Transform>,
39}
40
41#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
42pub struct BlockId(usize);
43
44#[derive(Copy, Clone, Debug, Default, Eq, Ord, PartialOrd, PartialEq)]
45pub struct BlockPoint(pub Point);
46
47#[derive(Copy, Clone, Debug, Default, Eq, Ord, PartialOrd, PartialEq)]
48struct BlockRow(u32);
49
50#[derive(Copy, Clone, Debug, Default, Eq, Ord, PartialOrd, PartialEq)]
51struct WrapRow(u32);
52
53pub type RenderBlock = Arc<dyn Fn(&mut BlockContext) -> AnyElement<Editor>>;
54
55pub struct Block {
56 id: BlockId,
57 position: Anchor,
58 height: u8,
59 style: BlockStyle,
60 render: Mutex<RenderBlock>,
61 disposition: BlockDisposition,
62}
63
64#[derive(Clone)]
65pub struct BlockProperties<P>
66where
67 P: Clone,
68{
69 pub position: P,
70 pub height: u8,
71 pub style: BlockStyle,
72 pub render: Arc<dyn Fn(&mut BlockContext) -> AnyElement<Editor>>,
73 pub disposition: BlockDisposition,
74}
75
76#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd)]
77pub enum BlockStyle {
78 Fixed,
79 Flex,
80 Sticky,
81}
82
83pub struct BlockContext<'a, 'b, 'c> {
84 pub view_context: &'c mut ViewContext<'a, 'b, Editor>,
85 pub anchor_x: f32,
86 pub scroll_x: f32,
87 pub gutter_width: f32,
88 pub gutter_padding: f32,
89 pub em_width: f32,
90 pub line_height: f32,
91 pub block_id: usize,
92}
93
94#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord)]
95pub enum BlockDisposition {
96 Above,
97 Below,
98}
99
100#[derive(Clone, Debug)]
101struct Transform {
102 summary: TransformSummary,
103 block: Option<TransformBlock>,
104}
105
106#[allow(clippy::large_enum_variant)]
107#[derive(Clone)]
108pub enum TransformBlock {
109 Custom(Arc<Block>),
110 ExcerptHeader {
111 id: ExcerptId,
112 buffer: BufferSnapshot,
113 range: ExcerptRange<text::Anchor>,
114 height: u8,
115 starts_new_buffer: bool,
116 },
117}
118
119impl TransformBlock {
120 fn disposition(&self) -> BlockDisposition {
121 match self {
122 TransformBlock::Custom(block) => block.disposition,
123 TransformBlock::ExcerptHeader { .. } => BlockDisposition::Above,
124 }
125 }
126
127 pub fn height(&self) -> u8 {
128 match self {
129 TransformBlock::Custom(block) => block.height,
130 TransformBlock::ExcerptHeader { height, .. } => *height,
131 }
132 }
133}
134
135impl Debug for TransformBlock {
136 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
137 match self {
138 Self::Custom(block) => f.debug_struct("Custom").field("block", block).finish(),
139 Self::ExcerptHeader { buffer, .. } => f
140 .debug_struct("ExcerptHeader")
141 .field("path", &buffer.file().map(|f| f.path()))
142 .finish(),
143 }
144 }
145}
146
147#[derive(Clone, Debug, Default)]
148struct TransformSummary {
149 input_rows: u32,
150 output_rows: u32,
151}
152
153pub struct BlockChunks<'a> {
154 transforms: sum_tree::Cursor<'a, Transform, (BlockRow, WrapRow)>,
155 input_chunks: wrap_map::WrapChunks<'a>,
156 input_chunk: Chunk<'a>,
157 output_row: u32,
158 max_output_row: u32,
159}
160
161#[derive(Clone)]
162pub struct BlockBufferRows<'a> {
163 transforms: sum_tree::Cursor<'a, Transform, (BlockRow, WrapRow)>,
164 input_buffer_rows: wrap_map::WrapBufferRows<'a>,
165 output_row: u32,
166 started: bool,
167}
168
169impl BlockMap {
170 pub fn new(
171 wrap_snapshot: WrapSnapshot,
172 buffer_header_height: u8,
173 excerpt_header_height: u8,
174 ) -> Self {
175 let row_count = wrap_snapshot.max_point().row() + 1;
176 let map = Self {
177 next_block_id: AtomicUsize::new(0),
178 blocks: Vec::new(),
179 transforms: RefCell::new(SumTree::from_item(Transform::isomorphic(row_count), &())),
180 wrap_snapshot: RefCell::new(wrap_snapshot.clone()),
181 buffer_header_height,
182 excerpt_header_height,
183 };
184 map.sync(
185 &wrap_snapshot,
186 Patch::new(vec![Edit {
187 old: 0..row_count,
188 new: 0..row_count,
189 }]),
190 );
191 map
192 }
193
194 pub fn read(&self, wrap_snapshot: WrapSnapshot, edits: Patch<u32>) -> BlockSnapshot {
195 self.sync(&wrap_snapshot, edits);
196 *self.wrap_snapshot.borrow_mut() = wrap_snapshot.clone();
197 BlockSnapshot {
198 wrap_snapshot,
199 transforms: self.transforms.borrow().clone(),
200 }
201 }
202
203 pub fn write(&mut self, wrap_snapshot: WrapSnapshot, edits: Patch<u32>) -> BlockMapWriter {
204 self.sync(&wrap_snapshot, edits);
205 *self.wrap_snapshot.borrow_mut() = wrap_snapshot;
206 BlockMapWriter(self)
207 }
208
209 fn sync(&self, wrap_snapshot: &WrapSnapshot, mut edits: Patch<u32>) {
210 let buffer = wrap_snapshot.buffer_snapshot();
211
212 // Handle changing the last excerpt if it is empty.
213 if buffer.trailing_excerpt_update_count()
214 != self
215 .wrap_snapshot
216 .borrow()
217 .buffer_snapshot()
218 .trailing_excerpt_update_count()
219 {
220 let max_point = wrap_snapshot.max_point();
221 let edit_start = wrap_snapshot.prev_row_boundary(max_point);
222 let edit_end = max_point.row() + 1;
223 edits = edits.compose([WrapEdit {
224 old: edit_start..edit_end,
225 new: edit_start..edit_end,
226 }]);
227 }
228
229 let edits = edits.into_inner();
230 if edits.is_empty() {
231 return;
232 }
233
234 let mut transforms = self.transforms.borrow_mut();
235 let mut new_transforms = SumTree::new();
236 let old_row_count = transforms.summary().input_rows;
237 let new_row_count = wrap_snapshot.max_point().row() + 1;
238 let mut cursor = transforms.cursor::<WrapRow>();
239 let mut last_block_ix = 0;
240 let mut blocks_in_edit = Vec::new();
241 let mut edits = edits.into_iter().peekable();
242
243 while let Some(edit) = edits.next() {
244 // Preserve any old transforms that precede this edit.
245 let old_start = WrapRow(edit.old.start);
246 let new_start = WrapRow(edit.new.start);
247 new_transforms.append(cursor.slice(&old_start, Bias::Left, &()), &());
248 if let Some(transform) = cursor.item() {
249 if transform.is_isomorphic() && old_start == cursor.end(&()) {
250 new_transforms.push(transform.clone(), &());
251 cursor.next(&());
252 while let Some(transform) = cursor.item() {
253 if transform
254 .block
255 .as_ref()
256 .map_or(false, |b| b.disposition().is_below())
257 {
258 new_transforms.push(transform.clone(), &());
259 cursor.next(&());
260 } else {
261 break;
262 }
263 }
264 }
265 }
266
267 // Preserve any portion of an old transform that precedes this edit.
268 let extent_before_edit = old_start.0 - cursor.start().0;
269 push_isomorphic(&mut new_transforms, extent_before_edit);
270
271 // Skip over any old transforms that intersect this edit.
272 let mut old_end = WrapRow(edit.old.end);
273 let mut new_end = WrapRow(edit.new.end);
274 cursor.seek(&old_end, Bias::Left, &());
275 cursor.next(&());
276 if old_end == *cursor.start() {
277 while let Some(transform) = cursor.item() {
278 if transform
279 .block
280 .as_ref()
281 .map_or(false, |b| b.disposition().is_below())
282 {
283 cursor.next(&());
284 } else {
285 break;
286 }
287 }
288 }
289
290 // Combine this edit with any subsequent edits that intersect the same transform.
291 while let Some(next_edit) = edits.peek() {
292 if next_edit.old.start <= cursor.start().0 {
293 old_end = WrapRow(next_edit.old.end);
294 new_end = WrapRow(next_edit.new.end);
295 cursor.seek(&old_end, Bias::Left, &());
296 cursor.next(&());
297 if old_end == *cursor.start() {
298 while let Some(transform) = cursor.item() {
299 if transform
300 .block
301 .as_ref()
302 .map_or(false, |b| b.disposition().is_below())
303 {
304 cursor.next(&());
305 } else {
306 break;
307 }
308 }
309 }
310 edits.next();
311 } else {
312 break;
313 }
314 }
315
316 // Find the blocks within this edited region.
317 let new_buffer_start =
318 wrap_snapshot.to_point(WrapPoint::new(new_start.0, 0), Bias::Left);
319 let start_bound = Bound::Included(new_buffer_start);
320 let start_block_ix = match self.blocks[last_block_ix..].binary_search_by(|probe| {
321 probe
322 .position
323 .to_point(buffer)
324 .cmp(&new_buffer_start)
325 .then(Ordering::Greater)
326 }) {
327 Ok(ix) | Err(ix) => last_block_ix + ix,
328 };
329
330 let end_bound;
331 let end_block_ix = if new_end.0 > wrap_snapshot.max_point().row() {
332 end_bound = Bound::Unbounded;
333 self.blocks.len()
334 } else {
335 let new_buffer_end =
336 wrap_snapshot.to_point(WrapPoint::new(new_end.0, 0), Bias::Left);
337 end_bound = Bound::Excluded(new_buffer_end);
338 match self.blocks[start_block_ix..].binary_search_by(|probe| {
339 probe
340 .position
341 .to_point(buffer)
342 .cmp(&new_buffer_end)
343 .then(Ordering::Greater)
344 }) {
345 Ok(ix) | Err(ix) => start_block_ix + ix,
346 }
347 };
348 last_block_ix = end_block_ix;
349
350 debug_assert!(blocks_in_edit.is_empty());
351 blocks_in_edit.extend(
352 self.blocks[start_block_ix..end_block_ix]
353 .iter()
354 .map(|block| {
355 let mut position = block.position.to_point(buffer);
356 match block.disposition {
357 BlockDisposition::Above => position.column = 0,
358 BlockDisposition::Below => {
359 position.column = buffer.line_len(position.row)
360 }
361 }
362 let position = wrap_snapshot.make_wrap_point(position, Bias::Left);
363 (position.row(), TransformBlock::Custom(block.clone()))
364 }),
365 );
366 blocks_in_edit.extend(
367 buffer
368 .excerpt_boundaries_in_range((start_bound, end_bound))
369 .map(|excerpt_boundary| {
370 (
371 wrap_snapshot
372 .make_wrap_point(Point::new(excerpt_boundary.row, 0), Bias::Left)
373 .row(),
374 TransformBlock::ExcerptHeader {
375 id: excerpt_boundary.id,
376 buffer: excerpt_boundary.buffer,
377 range: excerpt_boundary.range,
378 height: if excerpt_boundary.starts_new_buffer {
379 self.buffer_header_height
380 } else {
381 self.excerpt_header_height
382 },
383 starts_new_buffer: excerpt_boundary.starts_new_buffer,
384 },
385 )
386 }),
387 );
388
389 // Place excerpt headers above custom blocks on the same row.
390 blocks_in_edit.sort_unstable_by(|(row_a, block_a), (row_b, block_b)| {
391 row_a.cmp(row_b).then_with(|| match (block_a, block_b) {
392 (
393 TransformBlock::ExcerptHeader { .. },
394 TransformBlock::ExcerptHeader { .. },
395 ) => Ordering::Equal,
396 (TransformBlock::ExcerptHeader { .. }, _) => Ordering::Less,
397 (_, TransformBlock::ExcerptHeader { .. }) => Ordering::Greater,
398 (TransformBlock::Custom(block_a), TransformBlock::Custom(block_b)) => block_a
399 .disposition
400 .cmp(&block_b.disposition)
401 .then_with(|| block_a.id.cmp(&block_b.id)),
402 })
403 });
404
405 // For each of these blocks, insert a new isomorphic transform preceding the block,
406 // and then insert the block itself.
407 for (block_row, block) in blocks_in_edit.drain(..) {
408 let insertion_row = match block.disposition() {
409 BlockDisposition::Above => block_row,
410 BlockDisposition::Below => block_row + 1,
411 };
412 let extent_before_block = insertion_row - new_transforms.summary().input_rows;
413 push_isomorphic(&mut new_transforms, extent_before_block);
414 new_transforms.push(Transform::block(block), &());
415 }
416
417 old_end = WrapRow(old_end.0.min(old_row_count));
418 new_end = WrapRow(new_end.0.min(new_row_count));
419
420 // Insert an isomorphic transform after the final block.
421 let extent_after_last_block = new_end.0 - new_transforms.summary().input_rows;
422 push_isomorphic(&mut new_transforms, extent_after_last_block);
423
424 // Preserve any portion of the old transform after this edit.
425 let extent_after_edit = cursor.start().0 - old_end.0;
426 push_isomorphic(&mut new_transforms, extent_after_edit);
427 }
428
429 new_transforms.append(cursor.suffix(&()), &());
430 debug_assert_eq!(
431 new_transforms.summary().input_rows,
432 wrap_snapshot.max_point().row() + 1
433 );
434
435 drop(cursor);
436 *transforms = new_transforms;
437 }
438
439 pub fn replace(&mut self, mut renderers: HashMap<BlockId, RenderBlock>) {
440 for block in &self.blocks {
441 if let Some(render) = renderers.remove(&block.id) {
442 *block.render.lock() = render;
443 }
444 }
445 }
446}
447
448fn push_isomorphic(tree: &mut SumTree<Transform>, rows: u32) {
449 if rows == 0 {
450 return;
451 }
452
453 let mut extent = Some(rows);
454 tree.update_last(
455 |last_transform| {
456 if last_transform.is_isomorphic() {
457 let extent = extent.take().unwrap();
458 last_transform.summary.input_rows += extent;
459 last_transform.summary.output_rows += extent;
460 }
461 },
462 &(),
463 );
464 if let Some(extent) = extent {
465 tree.push(Transform::isomorphic(extent), &());
466 }
467}
468
469impl BlockPoint {
470 pub fn new(row: u32, column: u32) -> Self {
471 Self(Point::new(row, column))
472 }
473}
474
475impl Deref for BlockPoint {
476 type Target = Point;
477
478 fn deref(&self) -> &Self::Target {
479 &self.0
480 }
481}
482
483impl std::ops::DerefMut for BlockPoint {
484 fn deref_mut(&mut self) -> &mut Self::Target {
485 &mut self.0
486 }
487}
488
489impl<'a> BlockMapWriter<'a> {
490 pub fn insert(
491 &mut self,
492 blocks: impl IntoIterator<Item = BlockProperties<Anchor>>,
493 ) -> Vec<BlockId> {
494 let mut ids = Vec::new();
495 let mut edits = Patch::default();
496 let wrap_snapshot = &*self.0.wrap_snapshot.borrow();
497 let buffer = wrap_snapshot.buffer_snapshot();
498
499 for block in blocks {
500 let id = BlockId(self.0.next_block_id.fetch_add(1, SeqCst));
501 ids.push(id);
502
503 let position = block.position;
504 let point = position.to_point(buffer);
505 let wrap_row = wrap_snapshot
506 .make_wrap_point(Point::new(point.row, 0), Bias::Left)
507 .row();
508 let start_row = wrap_snapshot.prev_row_boundary(WrapPoint::new(wrap_row, 0));
509 let end_row = wrap_snapshot
510 .next_row_boundary(WrapPoint::new(wrap_row, 0))
511 .unwrap_or(wrap_snapshot.max_point().row() + 1);
512
513 let block_ix = match self
514 .0
515 .blocks
516 .binary_search_by(|probe| probe.position.cmp(&position, buffer))
517 {
518 Ok(ix) | Err(ix) => ix,
519 };
520 self.0.blocks.insert(
521 block_ix,
522 Arc::new(Block {
523 id,
524 position,
525 height: block.height,
526 render: Mutex::new(block.render),
527 disposition: block.disposition,
528 style: block.style,
529 }),
530 );
531
532 edits = edits.compose([Edit {
533 old: start_row..end_row,
534 new: start_row..end_row,
535 }]);
536 }
537
538 self.0.sync(wrap_snapshot, edits);
539 ids
540 }
541
542 pub fn remove(&mut self, block_ids: HashSet<BlockId>) {
543 let wrap_snapshot = &*self.0.wrap_snapshot.borrow();
544 let buffer = wrap_snapshot.buffer_snapshot();
545 let mut edits = Patch::default();
546 let mut last_block_buffer_row = None;
547 self.0.blocks.retain(|block| {
548 if block_ids.contains(&block.id) {
549 let buffer_row = block.position.to_point(buffer).row;
550 if last_block_buffer_row != Some(buffer_row) {
551 last_block_buffer_row = Some(buffer_row);
552 let wrap_row = wrap_snapshot
553 .make_wrap_point(Point::new(buffer_row, 0), Bias::Left)
554 .row();
555 let start_row = wrap_snapshot.prev_row_boundary(WrapPoint::new(wrap_row, 0));
556 let end_row = wrap_snapshot
557 .next_row_boundary(WrapPoint::new(wrap_row, 0))
558 .unwrap_or(wrap_snapshot.max_point().row() + 1);
559 edits.push(Edit {
560 old: start_row..end_row,
561 new: start_row..end_row,
562 })
563 }
564 false
565 } else {
566 true
567 }
568 });
569 self.0.sync(wrap_snapshot, edits);
570 }
571}
572
573impl BlockSnapshot {
574 #[cfg(test)]
575 pub fn text(&self) -> String {
576 self.chunks(0..self.transforms.summary().output_rows, false, None, None)
577 .map(|chunk| chunk.text)
578 .collect()
579 }
580
581 pub fn chunks<'a>(
582 &'a self,
583 rows: Range<u32>,
584 language_aware: bool,
585 text_highlights: Option<&'a TextHighlights>,
586 suggestion_highlight: Option<HighlightStyle>,
587 ) -> BlockChunks<'a> {
588 let max_output_row = cmp::min(rows.end, self.transforms.summary().output_rows);
589 let mut cursor = self.transforms.cursor::<(BlockRow, WrapRow)>();
590 let input_end = {
591 cursor.seek(&BlockRow(rows.end), Bias::Right, &());
592 let overshoot = if cursor
593 .item()
594 .map_or(false, |transform| transform.is_isomorphic())
595 {
596 rows.end - cursor.start().0 .0
597 } else {
598 0
599 };
600 cursor.start().1 .0 + overshoot
601 };
602 let input_start = {
603 cursor.seek(&BlockRow(rows.start), Bias::Right, &());
604 let overshoot = if cursor
605 .item()
606 .map_or(false, |transform| transform.is_isomorphic())
607 {
608 rows.start - cursor.start().0 .0
609 } else {
610 0
611 };
612 cursor.start().1 .0 + overshoot
613 };
614 BlockChunks {
615 input_chunks: self.wrap_snapshot.chunks(
616 input_start..input_end,
617 language_aware,
618 text_highlights,
619 suggestion_highlight,
620 ),
621 input_chunk: Default::default(),
622 transforms: cursor,
623 output_row: rows.start,
624 max_output_row,
625 }
626 }
627
628 pub fn buffer_rows(&self, start_row: u32) -> BlockBufferRows {
629 let mut cursor = self.transforms.cursor::<(BlockRow, WrapRow)>();
630 cursor.seek(&BlockRow(start_row), Bias::Right, &());
631 let (output_start, input_start) = cursor.start();
632 let overshoot = if cursor.item().map_or(false, |t| t.is_isomorphic()) {
633 start_row - output_start.0
634 } else {
635 0
636 };
637 let input_start_row = input_start.0 + overshoot;
638 BlockBufferRows {
639 transforms: cursor,
640 input_buffer_rows: self.wrap_snapshot.buffer_rows(input_start_row),
641 output_row: start_row,
642 started: false,
643 }
644 }
645
646 pub fn blocks_in_range(
647 &self,
648 rows: Range<u32>,
649 ) -> impl Iterator<Item = (u32, &TransformBlock)> {
650 let mut cursor = self.transforms.cursor::<BlockRow>();
651 cursor.seek(&BlockRow(rows.start), Bias::Right, &());
652 std::iter::from_fn(move || {
653 while let Some(transform) = cursor.item() {
654 let start_row = cursor.start().0;
655 if start_row >= rows.end {
656 break;
657 }
658 if let Some(block) = &transform.block {
659 cursor.next(&());
660 return Some((start_row, block));
661 } else {
662 cursor.next(&());
663 }
664 }
665 None
666 })
667 }
668
669 pub fn max_point(&self) -> BlockPoint {
670 let row = self.transforms.summary().output_rows - 1;
671 BlockPoint::new(row, self.line_len(row))
672 }
673
674 pub fn longest_row(&self) -> u32 {
675 let input_row = self.wrap_snapshot.longest_row();
676 self.to_block_point(WrapPoint::new(input_row, 0)).row
677 }
678
679 pub fn line_len(&self, row: u32) -> u32 {
680 let mut cursor = self.transforms.cursor::<(BlockRow, WrapRow)>();
681 cursor.seek(&BlockRow(row), Bias::Right, &());
682 if let Some(transform) = cursor.item() {
683 let (output_start, input_start) = cursor.start();
684 let overshoot = row - output_start.0;
685 if transform.block.is_some() {
686 0
687 } else {
688 self.wrap_snapshot.line_len(input_start.0 + overshoot)
689 }
690 } else {
691 panic!("row out of range");
692 }
693 }
694
695 pub fn is_block_line(&self, row: u32) -> bool {
696 let mut cursor = self.transforms.cursor::<(BlockRow, WrapRow)>();
697 cursor.seek(&BlockRow(row), Bias::Right, &());
698 cursor.item().map_or(false, |t| t.block.is_some())
699 }
700
701 pub fn clip_point(&self, point: BlockPoint, bias: Bias) -> BlockPoint {
702 let mut cursor = self.transforms.cursor::<(BlockRow, WrapRow)>();
703 cursor.seek(&BlockRow(point.row), Bias::Right, &());
704
705 let max_input_row = WrapRow(self.transforms.summary().input_rows);
706 let mut search_left =
707 (bias == Bias::Left && cursor.start().1 .0 > 0) || cursor.end(&()).1 == max_input_row;
708 let mut reversed = false;
709
710 loop {
711 if let Some(transform) = cursor.item() {
712 if transform.is_isomorphic() {
713 let (output_start_row, input_start_row) = cursor.start();
714 let (output_end_row, input_end_row) = cursor.end(&());
715 let output_start = Point::new(output_start_row.0, 0);
716 let input_start = Point::new(input_start_row.0, 0);
717 let input_end = Point::new(input_end_row.0, 0);
718 let input_point = if point.row >= output_end_row.0 {
719 let line_len = self.wrap_snapshot.line_len(input_end_row.0 - 1);
720 self.wrap_snapshot
721 .clip_point(WrapPoint::new(input_end_row.0 - 1, line_len), bias)
722 } else {
723 let output_overshoot = point.0.saturating_sub(output_start);
724 self.wrap_snapshot
725 .clip_point(WrapPoint(input_start + output_overshoot), bias)
726 };
727
728 if (input_start..input_end).contains(&input_point.0) {
729 let input_overshoot = input_point.0.saturating_sub(input_start);
730 return BlockPoint(output_start + input_overshoot);
731 }
732 }
733
734 if search_left {
735 cursor.prev(&());
736 } else {
737 cursor.next(&());
738 }
739 } else if reversed {
740 return self.max_point();
741 } else {
742 reversed = true;
743 search_left = !search_left;
744 cursor.seek(&BlockRow(point.row), Bias::Right, &());
745 }
746 }
747 }
748
749 pub fn to_block_point(&self, wrap_point: WrapPoint) -> BlockPoint {
750 let mut cursor = self.transforms.cursor::<(WrapRow, BlockRow)>();
751 cursor.seek(&WrapRow(wrap_point.row()), Bias::Right, &());
752 if let Some(transform) = cursor.item() {
753 debug_assert!(transform.is_isomorphic());
754 } else {
755 return self.max_point();
756 }
757
758 let (input_start_row, output_start_row) = cursor.start();
759 let input_start = Point::new(input_start_row.0, 0);
760 let output_start = Point::new(output_start_row.0, 0);
761 let input_overshoot = wrap_point.0 - input_start;
762 BlockPoint(output_start + input_overshoot)
763 }
764
765 pub fn to_wrap_point(&self, block_point: BlockPoint) -> WrapPoint {
766 let mut cursor = self.transforms.cursor::<(BlockRow, WrapRow)>();
767 cursor.seek(&BlockRow(block_point.row), Bias::Right, &());
768 if let Some(transform) = cursor.item() {
769 match transform.block.as_ref().map(|b| b.disposition()) {
770 Some(BlockDisposition::Above) => WrapPoint::new(cursor.start().1 .0, 0),
771 Some(BlockDisposition::Below) => {
772 let wrap_row = cursor.start().1 .0 - 1;
773 WrapPoint::new(wrap_row, self.wrap_snapshot.line_len(wrap_row))
774 }
775 None => {
776 let overshoot = block_point.row - cursor.start().0 .0;
777 let wrap_row = cursor.start().1 .0 + overshoot;
778 WrapPoint::new(wrap_row, block_point.column)
779 }
780 }
781 } else {
782 self.wrap_snapshot.max_point()
783 }
784 }
785}
786
787impl Transform {
788 fn isomorphic(rows: u32) -> Self {
789 Self {
790 summary: TransformSummary {
791 input_rows: rows,
792 output_rows: rows,
793 },
794 block: None,
795 }
796 }
797
798 fn block(block: TransformBlock) -> Self {
799 Self {
800 summary: TransformSummary {
801 input_rows: 0,
802 output_rows: block.height() as u32,
803 },
804 block: Some(block),
805 }
806 }
807
808 fn is_isomorphic(&self) -> bool {
809 self.block.is_none()
810 }
811}
812
813impl<'a> Iterator for BlockChunks<'a> {
814 type Item = Chunk<'a>;
815
816 fn next(&mut self) -> Option<Self::Item> {
817 if self.output_row >= self.max_output_row {
818 return None;
819 }
820
821 let transform = self.transforms.item()?;
822 if transform.block.is_some() {
823 let block_start = self.transforms.start().0 .0;
824 let mut block_end = self.transforms.end(&()).0 .0;
825 self.transforms.next(&());
826 if self.transforms.item().is_none() {
827 block_end -= 1;
828 }
829
830 let start_in_block = self.output_row - block_start;
831 let end_in_block = cmp::min(self.max_output_row, block_end) - block_start;
832 let line_count = end_in_block - start_in_block;
833 self.output_row += line_count;
834
835 return Some(Chunk {
836 text: unsafe { std::str::from_utf8_unchecked(&NEWLINES[..line_count as usize]) },
837 ..Default::default()
838 });
839 }
840
841 if self.input_chunk.text.is_empty() {
842 if let Some(input_chunk) = self.input_chunks.next() {
843 self.input_chunk = input_chunk;
844 } else {
845 self.output_row += 1;
846 if self.output_row < self.max_output_row {
847 self.transforms.next(&());
848 return Some(Chunk {
849 text: "\n",
850 ..Default::default()
851 });
852 } else {
853 return None;
854 }
855 }
856 }
857
858 let transform_end = self.transforms.end(&()).0 .0;
859 let (prefix_rows, prefix_bytes) =
860 offset_for_row(self.input_chunk.text, transform_end - self.output_row);
861 self.output_row += prefix_rows;
862 let (prefix, suffix) = self.input_chunk.text.split_at(prefix_bytes);
863 self.input_chunk.text = suffix;
864 if self.output_row == transform_end {
865 self.transforms.next(&());
866 }
867
868 Some(Chunk {
869 text: prefix,
870 ..self.input_chunk
871 })
872 }
873}
874
875impl<'a> Iterator for BlockBufferRows<'a> {
876 type Item = Option<u32>;
877
878 fn next(&mut self) -> Option<Self::Item> {
879 if self.started {
880 self.output_row += 1;
881 } else {
882 self.started = true;
883 }
884
885 if self.output_row >= self.transforms.end(&()).0 .0 {
886 self.transforms.next(&());
887 }
888
889 let transform = self.transforms.item()?;
890 if transform.block.is_some() {
891 Some(None)
892 } else {
893 Some(self.input_buffer_rows.next().unwrap())
894 }
895 }
896}
897
898impl sum_tree::Item for Transform {
899 type Summary = TransformSummary;
900
901 fn summary(&self) -> Self::Summary {
902 self.summary.clone()
903 }
904}
905
906impl sum_tree::Summary for TransformSummary {
907 type Context = ();
908
909 fn add_summary(&mut self, summary: &Self, _: &()) {
910 self.input_rows += summary.input_rows;
911 self.output_rows += summary.output_rows;
912 }
913}
914
915impl<'a> sum_tree::Dimension<'a, TransformSummary> for WrapRow {
916 fn add_summary(&mut self, summary: &'a TransformSummary, _: &()) {
917 self.0 += summary.input_rows;
918 }
919}
920
921impl<'a> sum_tree::Dimension<'a, TransformSummary> for BlockRow {
922 fn add_summary(&mut self, summary: &'a TransformSummary, _: &()) {
923 self.0 += summary.output_rows;
924 }
925}
926
927impl BlockDisposition {
928 fn is_below(&self) -> bool {
929 matches!(self, BlockDisposition::Below)
930 }
931}
932
933impl<'a, 'b, 'c> Deref for BlockContext<'a, 'b, 'c> {
934 type Target = ViewContext<'a, 'b, Editor>;
935
936 fn deref(&self) -> &Self::Target {
937 self.view_context
938 }
939}
940
941impl DerefMut for BlockContext<'_, '_, '_> {
942 fn deref_mut(&mut self) -> &mut Self::Target {
943 self.view_context
944 }
945}
946
947impl Block {
948 pub fn render(&self, cx: &mut BlockContext) -> AnyElement<Editor> {
949 self.render.lock()(cx)
950 }
951
952 pub fn position(&self) -> &Anchor {
953 &self.position
954 }
955
956 pub fn style(&self) -> BlockStyle {
957 self.style
958 }
959}
960
961impl Debug for Block {
962 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
963 f.debug_struct("Block")
964 .field("id", &self.id)
965 .field("position", &self.position)
966 .field("disposition", &self.disposition)
967 .finish()
968 }
969}
970
971// Count the number of bytes prior to a target point. If the string doesn't contain the target
972// point, return its total extent. Otherwise return the target point itself.
973fn offset_for_row(s: &str, target: u32) -> (u32, usize) {
974 let mut row = 0;
975 let mut offset = 0;
976 for (ix, line) in s.split('\n').enumerate() {
977 if ix > 0 {
978 row += 1;
979 offset += 1;
980 }
981 if row >= target {
982 break;
983 }
984 offset += line.len() as usize;
985 }
986 (row, offset)
987}
988
989#[cfg(test)]
990mod tests {
991 use super::*;
992 use crate::display_map::inlay_map::InlayMap;
993 use crate::display_map::suggestion_map::SuggestionMap;
994 use crate::display_map::{fold_map::FoldMap, tab_map::TabMap, wrap_map::WrapMap};
995 use crate::multi_buffer::MultiBuffer;
996 use gpui::{elements::Empty, Element};
997 use rand::prelude::*;
998 use settings::SettingsStore;
999 use std::env;
1000 use util::RandomCharIter;
1001
1002 #[gpui::test]
1003 fn test_offset_for_row() {
1004 assert_eq!(offset_for_row("", 0), (0, 0));
1005 assert_eq!(offset_for_row("", 1), (0, 0));
1006 assert_eq!(offset_for_row("abcd", 0), (0, 0));
1007 assert_eq!(offset_for_row("abcd", 1), (0, 4));
1008 assert_eq!(offset_for_row("\n", 0), (0, 0));
1009 assert_eq!(offset_for_row("\n", 1), (1, 1));
1010 assert_eq!(offset_for_row("abc\ndef\nghi", 0), (0, 0));
1011 assert_eq!(offset_for_row("abc\ndef\nghi", 1), (1, 4));
1012 assert_eq!(offset_for_row("abc\ndef\nghi", 2), (2, 8));
1013 assert_eq!(offset_for_row("abc\ndef\nghi", 3), (2, 11));
1014 }
1015
1016 #[gpui::test]
1017 fn test_basic_blocks(cx: &mut gpui::AppContext) {
1018 init_test(cx);
1019
1020 let family_id = cx
1021 .font_cache()
1022 .load_family(&["Helvetica"], &Default::default())
1023 .unwrap();
1024 let font_id = cx
1025 .font_cache()
1026 .select_font(family_id, &Default::default())
1027 .unwrap();
1028
1029 let text = "aaa\nbbb\nccc\nddd";
1030
1031 let buffer = MultiBuffer::build_simple(text, cx);
1032 let buffer_snapshot = buffer.read(cx).snapshot(cx);
1033 let subscription = buffer.update(cx, |buffer, _| buffer.subscribe());
1034 let (fold_map, fold_snapshot) = FoldMap::new(buffer_snapshot.clone());
1035 let (suggestion_map, suggestion_snapshot) = SuggestionMap::new(fold_snapshot);
1036 let (inlay_map, inlay_snapshot) = InlayMap::new(suggestion_snapshot);
1037 let (tab_map, tab_snapshot) = TabMap::new(inlay_snapshot, 1.try_into().unwrap());
1038 let (wrap_map, wraps_snapshot) = WrapMap::new(tab_snapshot, font_id, 14.0, None, cx);
1039 let mut block_map = BlockMap::new(wraps_snapshot.clone(), 1, 1);
1040
1041 let mut writer = block_map.write(wraps_snapshot.clone(), Default::default());
1042 let block_ids = writer.insert(vec![
1043 BlockProperties {
1044 style: BlockStyle::Fixed,
1045 position: buffer_snapshot.anchor_after(Point::new(1, 0)),
1046 height: 1,
1047 disposition: BlockDisposition::Above,
1048 render: Arc::new(|_| Empty::new().into_any_named("block 1")),
1049 },
1050 BlockProperties {
1051 style: BlockStyle::Fixed,
1052 position: buffer_snapshot.anchor_after(Point::new(1, 2)),
1053 height: 2,
1054 disposition: BlockDisposition::Above,
1055 render: Arc::new(|_| Empty::new().into_any_named("block 2")),
1056 },
1057 BlockProperties {
1058 style: BlockStyle::Fixed,
1059 position: buffer_snapshot.anchor_after(Point::new(3, 3)),
1060 height: 3,
1061 disposition: BlockDisposition::Below,
1062 render: Arc::new(|_| Empty::new().into_any_named("block 3")),
1063 },
1064 ]);
1065
1066 let snapshot = block_map.read(wraps_snapshot, Default::default());
1067 assert_eq!(snapshot.text(), "aaa\n\n\n\nbbb\nccc\nddd\n\n\n");
1068
1069 let blocks = snapshot
1070 .blocks_in_range(0..8)
1071 .map(|(start_row, block)| {
1072 let block = block.as_custom().unwrap();
1073 (start_row..start_row + block.height as u32, block.id)
1074 })
1075 .collect::<Vec<_>>();
1076
1077 // When multiple blocks are on the same line, the newer blocks appear first.
1078 assert_eq!(
1079 blocks,
1080 &[
1081 (1..2, block_ids[0]),
1082 (2..4, block_ids[1]),
1083 (7..10, block_ids[2]),
1084 ]
1085 );
1086
1087 assert_eq!(
1088 snapshot.to_block_point(WrapPoint::new(0, 3)),
1089 BlockPoint::new(0, 3)
1090 );
1091 assert_eq!(
1092 snapshot.to_block_point(WrapPoint::new(1, 0)),
1093 BlockPoint::new(4, 0)
1094 );
1095 assert_eq!(
1096 snapshot.to_block_point(WrapPoint::new(3, 3)),
1097 BlockPoint::new(6, 3)
1098 );
1099
1100 assert_eq!(
1101 snapshot.to_wrap_point(BlockPoint::new(0, 3)),
1102 WrapPoint::new(0, 3)
1103 );
1104 assert_eq!(
1105 snapshot.to_wrap_point(BlockPoint::new(1, 0)),
1106 WrapPoint::new(1, 0)
1107 );
1108 assert_eq!(
1109 snapshot.to_wrap_point(BlockPoint::new(3, 0)),
1110 WrapPoint::new(1, 0)
1111 );
1112 assert_eq!(
1113 snapshot.to_wrap_point(BlockPoint::new(7, 0)),
1114 WrapPoint::new(3, 3)
1115 );
1116
1117 assert_eq!(
1118 snapshot.clip_point(BlockPoint::new(1, 0), Bias::Left),
1119 BlockPoint::new(0, 3)
1120 );
1121 assert_eq!(
1122 snapshot.clip_point(BlockPoint::new(1, 0), Bias::Right),
1123 BlockPoint::new(4, 0)
1124 );
1125 assert_eq!(
1126 snapshot.clip_point(BlockPoint::new(1, 1), Bias::Left),
1127 BlockPoint::new(0, 3)
1128 );
1129 assert_eq!(
1130 snapshot.clip_point(BlockPoint::new(1, 1), Bias::Right),
1131 BlockPoint::new(4, 0)
1132 );
1133 assert_eq!(
1134 snapshot.clip_point(BlockPoint::new(4, 0), Bias::Left),
1135 BlockPoint::new(4, 0)
1136 );
1137 assert_eq!(
1138 snapshot.clip_point(BlockPoint::new(4, 0), Bias::Right),
1139 BlockPoint::new(4, 0)
1140 );
1141 assert_eq!(
1142 snapshot.clip_point(BlockPoint::new(6, 3), Bias::Left),
1143 BlockPoint::new(6, 3)
1144 );
1145 assert_eq!(
1146 snapshot.clip_point(BlockPoint::new(6, 3), Bias::Right),
1147 BlockPoint::new(6, 3)
1148 );
1149 assert_eq!(
1150 snapshot.clip_point(BlockPoint::new(7, 0), Bias::Left),
1151 BlockPoint::new(6, 3)
1152 );
1153 assert_eq!(
1154 snapshot.clip_point(BlockPoint::new(7, 0), Bias::Right),
1155 BlockPoint::new(6, 3)
1156 );
1157
1158 assert_eq!(
1159 snapshot.buffer_rows(0).collect::<Vec<_>>(),
1160 &[
1161 Some(0),
1162 None,
1163 None,
1164 None,
1165 Some(1),
1166 Some(2),
1167 Some(3),
1168 None,
1169 None,
1170 None
1171 ]
1172 );
1173
1174 // Insert a line break, separating two block decorations into separate lines.
1175 let buffer_snapshot = buffer.update(cx, |buffer, cx| {
1176 buffer.edit([(Point::new(1, 1)..Point::new(1, 1), "!!!\n")], None, cx);
1177 buffer.snapshot(cx)
1178 });
1179
1180 let (fold_snapshot, fold_edits) =
1181 fold_map.read(buffer_snapshot, subscription.consume().into_inner());
1182 let (suggestion_snapshot, suggestion_edits) =
1183 suggestion_map.sync(fold_snapshot, fold_edits);
1184 let (inlay_snapshot, inlay_edits) = inlay_map.sync(suggestion_snapshot, suggestion_edits);
1185 let (tab_snapshot, tab_edits) =
1186 tab_map.sync(inlay_snapshot, inlay_edits, 4.try_into().unwrap());
1187 let (wraps_snapshot, wrap_edits) = wrap_map.update(cx, |wrap_map, cx| {
1188 wrap_map.sync(tab_snapshot, tab_edits, cx)
1189 });
1190 let snapshot = block_map.read(wraps_snapshot, wrap_edits);
1191 assert_eq!(snapshot.text(), "aaa\n\nb!!!\n\n\nbb\nccc\nddd\n\n\n");
1192 }
1193
1194 #[gpui::test]
1195 fn test_blocks_on_wrapped_lines(cx: &mut gpui::AppContext) {
1196 init_test(cx);
1197
1198 let family_id = cx
1199 .font_cache()
1200 .load_family(&["Helvetica"], &Default::default())
1201 .unwrap();
1202 let font_id = cx
1203 .font_cache()
1204 .select_font(family_id, &Default::default())
1205 .unwrap();
1206
1207 let text = "one two three\nfour five six\nseven eight";
1208
1209 let buffer = MultiBuffer::build_simple(text, cx);
1210 let buffer_snapshot = buffer.read(cx).snapshot(cx);
1211 let (_, fold_snapshot) = FoldMap::new(buffer_snapshot.clone());
1212 let (_, suggestion_snapshot) = SuggestionMap::new(fold_snapshot);
1213 let (_, inlay_snapshot) = InlayMap::new(suggestion_snapshot);
1214 let (_, tab_snapshot) = TabMap::new(inlay_snapshot, 4.try_into().unwrap());
1215 let (_, wraps_snapshot) = WrapMap::new(tab_snapshot, font_id, 14.0, Some(60.), cx);
1216 let mut block_map = BlockMap::new(wraps_snapshot.clone(), 1, 1);
1217
1218 let mut writer = block_map.write(wraps_snapshot.clone(), Default::default());
1219 writer.insert(vec![
1220 BlockProperties {
1221 style: BlockStyle::Fixed,
1222 position: buffer_snapshot.anchor_after(Point::new(1, 12)),
1223 disposition: BlockDisposition::Above,
1224 render: Arc::new(|_| Empty::new().into_any_named("block 1")),
1225 height: 1,
1226 },
1227 BlockProperties {
1228 style: BlockStyle::Fixed,
1229 position: buffer_snapshot.anchor_after(Point::new(1, 1)),
1230 disposition: BlockDisposition::Below,
1231 render: Arc::new(|_| Empty::new().into_any_named("block 2")),
1232 height: 1,
1233 },
1234 ]);
1235
1236 // Blocks with an 'above' disposition go above their corresponding buffer line.
1237 // Blocks with a 'below' disposition go below their corresponding buffer line.
1238 let snapshot = block_map.read(wraps_snapshot, Default::default());
1239 assert_eq!(
1240 snapshot.text(),
1241 "one two \nthree\n\nfour five \nsix\n\nseven \neight"
1242 );
1243 }
1244
1245 #[gpui::test(iterations = 100)]
1246 fn test_random_blocks(cx: &mut gpui::AppContext, mut rng: StdRng) {
1247 init_test(cx);
1248
1249 let operations = env::var("OPERATIONS")
1250 .map(|i| i.parse().expect("invalid `OPERATIONS` variable"))
1251 .unwrap_or(10);
1252
1253 let wrap_width = if rng.gen_bool(0.2) {
1254 None
1255 } else {
1256 Some(rng.gen_range(0.0..=100.0))
1257 };
1258 let tab_size = 1.try_into().unwrap();
1259 let family_id = cx
1260 .font_cache()
1261 .load_family(&["Helvetica"], &Default::default())
1262 .unwrap();
1263 let font_id = cx
1264 .font_cache()
1265 .select_font(family_id, &Default::default())
1266 .unwrap();
1267 let font_size = 14.0;
1268 let buffer_start_header_height = rng.gen_range(1..=5);
1269 let excerpt_header_height = rng.gen_range(1..=5);
1270
1271 log::info!("Wrap width: {:?}", wrap_width);
1272 log::info!("Excerpt Header Height: {:?}", excerpt_header_height);
1273
1274 let buffer = if rng.gen() {
1275 let len = rng.gen_range(0..10);
1276 let text = RandomCharIter::new(&mut rng).take(len).collect::<String>();
1277 log::info!("initial buffer text: {:?}", text);
1278 MultiBuffer::build_simple(&text, cx)
1279 } else {
1280 MultiBuffer::build_random(&mut rng, cx)
1281 };
1282
1283 let mut buffer_snapshot = buffer.read(cx).snapshot(cx);
1284 let (fold_map, fold_snapshot) = FoldMap::new(buffer_snapshot.clone());
1285 let (suggestion_map, suggestion_snapshot) = SuggestionMap::new(fold_snapshot);
1286 let (inlay_map, inlay_snapshot) = InlayMap::new(suggestion_snapshot);
1287 let (tab_map, tab_snapshot) = TabMap::new(inlay_snapshot, 4.try_into().unwrap());
1288 let (wrap_map, wraps_snapshot) =
1289 WrapMap::new(tab_snapshot, font_id, font_size, wrap_width, cx);
1290 let mut block_map = BlockMap::new(
1291 wraps_snapshot,
1292 buffer_start_header_height,
1293 excerpt_header_height,
1294 );
1295 let mut custom_blocks = Vec::new();
1296
1297 for _ in 0..operations {
1298 let mut buffer_edits = Vec::new();
1299 match rng.gen_range(0..=100) {
1300 0..=19 => {
1301 let wrap_width = if rng.gen_bool(0.2) {
1302 None
1303 } else {
1304 Some(rng.gen_range(0.0..=100.0))
1305 };
1306 log::info!("Setting wrap width to {:?}", wrap_width);
1307 wrap_map.update(cx, |map, cx| map.set_wrap_width(wrap_width, cx));
1308 }
1309 20..=39 => {
1310 let block_count = rng.gen_range(1..=5);
1311 let block_properties = (0..block_count)
1312 .map(|_| {
1313 let buffer = buffer.read(cx).read(cx);
1314 let position = buffer.anchor_after(
1315 buffer.clip_offset(rng.gen_range(0..=buffer.len()), Bias::Left),
1316 );
1317
1318 let disposition = if rng.gen() {
1319 BlockDisposition::Above
1320 } else {
1321 BlockDisposition::Below
1322 };
1323 let height = rng.gen_range(1..5);
1324 log::info!(
1325 "inserting block {:?} {:?} with height {}",
1326 disposition,
1327 position.to_point(&buffer),
1328 height
1329 );
1330 BlockProperties {
1331 style: BlockStyle::Fixed,
1332 position,
1333 height,
1334 disposition,
1335 render: Arc::new(|_| Empty::new().into_any()),
1336 }
1337 })
1338 .collect::<Vec<_>>();
1339
1340 let (fold_snapshot, fold_edits) =
1341 fold_map.read(buffer_snapshot.clone(), vec![]);
1342 let (suggestion_snapshot, suggestion_edits) =
1343 suggestion_map.sync(fold_snapshot, fold_edits);
1344 let (inlay_snapshot, inlay_edits) =
1345 inlay_map.sync(suggestion_snapshot, suggestion_edits);
1346 let (tab_snapshot, tab_edits) =
1347 tab_map.sync(inlay_snapshot, inlay_edits, tab_size);
1348 let (wraps_snapshot, wrap_edits) = wrap_map.update(cx, |wrap_map, cx| {
1349 wrap_map.sync(tab_snapshot, tab_edits, cx)
1350 });
1351 let mut block_map = block_map.write(wraps_snapshot, wrap_edits);
1352 let block_ids = block_map.insert(block_properties.clone());
1353 for (block_id, props) in block_ids.into_iter().zip(block_properties) {
1354 custom_blocks.push((block_id, props));
1355 }
1356 }
1357 40..=59 if !custom_blocks.is_empty() => {
1358 let block_count = rng.gen_range(1..=4.min(custom_blocks.len()));
1359 let block_ids_to_remove = (0..block_count)
1360 .map(|_| {
1361 custom_blocks
1362 .remove(rng.gen_range(0..custom_blocks.len()))
1363 .0
1364 })
1365 .collect();
1366
1367 let (fold_snapshot, fold_edits) =
1368 fold_map.read(buffer_snapshot.clone(), vec![]);
1369 let (suggestion_snapshot, suggestion_edits) =
1370 suggestion_map.sync(fold_snapshot, fold_edits);
1371 let (inlay_snapshot, inlay_edits) =
1372 inlay_map.sync(suggestion_snapshot, suggestion_edits);
1373 let (tab_snapshot, tab_edits) =
1374 tab_map.sync(inlay_snapshot, inlay_edits, tab_size);
1375 let (wraps_snapshot, wrap_edits) = wrap_map.update(cx, |wrap_map, cx| {
1376 wrap_map.sync(tab_snapshot, tab_edits, cx)
1377 });
1378 let mut block_map = block_map.write(wraps_snapshot, wrap_edits);
1379 block_map.remove(block_ids_to_remove);
1380 }
1381 _ => {
1382 buffer.update(cx, |buffer, cx| {
1383 let mutation_count = rng.gen_range(1..=5);
1384 let subscription = buffer.subscribe();
1385 buffer.randomly_mutate(&mut rng, mutation_count, cx);
1386 buffer_snapshot = buffer.snapshot(cx);
1387 buffer_edits.extend(subscription.consume());
1388 log::info!("buffer text: {:?}", buffer_snapshot.text());
1389 });
1390 }
1391 }
1392
1393 let (fold_snapshot, fold_edits) = fold_map.read(buffer_snapshot.clone(), buffer_edits);
1394 let (suggestion_snapshot, suggestion_edits) =
1395 suggestion_map.sync(fold_snapshot, fold_edits);
1396 let (inlay_snapshot, inlay_edits) =
1397 inlay_map.sync(suggestion_snapshot, suggestion_edits);
1398 let (tab_snapshot, tab_edits) = tab_map.sync(inlay_snapshot, inlay_edits, tab_size);
1399 let (wraps_snapshot, wrap_edits) = wrap_map.update(cx, |wrap_map, cx| {
1400 wrap_map.sync(tab_snapshot, tab_edits, cx)
1401 });
1402 let blocks_snapshot = block_map.read(wraps_snapshot.clone(), wrap_edits);
1403 assert_eq!(
1404 blocks_snapshot.transforms.summary().input_rows,
1405 wraps_snapshot.max_point().row() + 1
1406 );
1407 log::info!("blocks text: {:?}", blocks_snapshot.text());
1408
1409 let mut expected_blocks = Vec::new();
1410 expected_blocks.extend(custom_blocks.iter().map(|(id, block)| {
1411 let mut position = block.position.to_point(&buffer_snapshot);
1412 match block.disposition {
1413 BlockDisposition::Above => {
1414 position.column = 0;
1415 }
1416 BlockDisposition::Below => {
1417 position.column = buffer_snapshot.line_len(position.row);
1418 }
1419 };
1420 let row = wraps_snapshot.make_wrap_point(position, Bias::Left).row();
1421 (
1422 row,
1423 ExpectedBlock::Custom {
1424 disposition: block.disposition,
1425 id: *id,
1426 height: block.height,
1427 },
1428 )
1429 }));
1430 expected_blocks.extend(buffer_snapshot.excerpt_boundaries_in_range(0..).map(
1431 |boundary| {
1432 let position =
1433 wraps_snapshot.make_wrap_point(Point::new(boundary.row, 0), Bias::Left);
1434 (
1435 position.row(),
1436 ExpectedBlock::ExcerptHeader {
1437 height: if boundary.starts_new_buffer {
1438 buffer_start_header_height
1439 } else {
1440 excerpt_header_height
1441 },
1442 starts_new_buffer: boundary.starts_new_buffer,
1443 },
1444 )
1445 },
1446 ));
1447 expected_blocks.sort_unstable();
1448 let mut sorted_blocks_iter = expected_blocks.into_iter().peekable();
1449
1450 let input_buffer_rows = buffer_snapshot.buffer_rows(0).collect::<Vec<_>>();
1451 let mut expected_buffer_rows = Vec::new();
1452 let mut expected_text = String::new();
1453 let mut expected_block_positions = Vec::new();
1454 let input_text = wraps_snapshot.text();
1455 for (row, input_line) in input_text.split('\n').enumerate() {
1456 let row = row as u32;
1457 if row > 0 {
1458 expected_text.push('\n');
1459 }
1460
1461 let buffer_row = input_buffer_rows[wraps_snapshot
1462 .to_point(WrapPoint::new(row, 0), Bias::Left)
1463 .row as usize];
1464
1465 while let Some((block_row, block)) = sorted_blocks_iter.peek() {
1466 if *block_row == row && block.disposition() == BlockDisposition::Above {
1467 let (_, block) = sorted_blocks_iter.next().unwrap();
1468 let height = block.height() as usize;
1469 expected_block_positions
1470 .push((expected_text.matches('\n').count() as u32, block));
1471 let text = "\n".repeat(height);
1472 expected_text.push_str(&text);
1473 for _ in 0..height {
1474 expected_buffer_rows.push(None);
1475 }
1476 } else {
1477 break;
1478 }
1479 }
1480
1481 let soft_wrapped = wraps_snapshot.to_tab_point(WrapPoint::new(row, 0)).column() > 0;
1482 expected_buffer_rows.push(if soft_wrapped { None } else { buffer_row });
1483 expected_text.push_str(input_line);
1484
1485 while let Some((block_row, block)) = sorted_blocks_iter.peek() {
1486 if *block_row == row && block.disposition() == BlockDisposition::Below {
1487 let (_, block) = sorted_blocks_iter.next().unwrap();
1488 let height = block.height() as usize;
1489 expected_block_positions
1490 .push((expected_text.matches('\n').count() as u32 + 1, block));
1491 let text = "\n".repeat(height);
1492 expected_text.push_str(&text);
1493 for _ in 0..height {
1494 expected_buffer_rows.push(None);
1495 }
1496 } else {
1497 break;
1498 }
1499 }
1500 }
1501
1502 let expected_lines = expected_text.split('\n').collect::<Vec<_>>();
1503 let expected_row_count = expected_lines.len();
1504 for start_row in 0..expected_row_count {
1505 let expected_text = expected_lines[start_row..].join("\n");
1506 let actual_text = blocks_snapshot
1507 .chunks(
1508 start_row as u32..blocks_snapshot.max_point().row + 1,
1509 false,
1510 None,
1511 None,
1512 )
1513 .map(|chunk| chunk.text)
1514 .collect::<String>();
1515 assert_eq!(
1516 actual_text, expected_text,
1517 "incorrect text starting from row {}",
1518 start_row
1519 );
1520 assert_eq!(
1521 blocks_snapshot
1522 .buffer_rows(start_row as u32)
1523 .collect::<Vec<_>>(),
1524 &expected_buffer_rows[start_row..]
1525 );
1526 }
1527
1528 assert_eq!(
1529 blocks_snapshot
1530 .blocks_in_range(0..(expected_row_count as u32))
1531 .map(|(row, block)| (row, block.clone().into()))
1532 .collect::<Vec<_>>(),
1533 expected_block_positions
1534 );
1535
1536 let mut expected_longest_rows = Vec::new();
1537 let mut longest_line_len = -1_isize;
1538 for (row, line) in expected_lines.iter().enumerate() {
1539 let row = row as u32;
1540
1541 assert_eq!(
1542 blocks_snapshot.line_len(row),
1543 line.len() as u32,
1544 "invalid line len for row {}",
1545 row
1546 );
1547
1548 let line_char_count = line.chars().count() as isize;
1549 match line_char_count.cmp(&longest_line_len) {
1550 Ordering::Less => {}
1551 Ordering::Equal => expected_longest_rows.push(row),
1552 Ordering::Greater => {
1553 longest_line_len = line_char_count;
1554 expected_longest_rows.clear();
1555 expected_longest_rows.push(row);
1556 }
1557 }
1558 }
1559
1560 let longest_row = blocks_snapshot.longest_row();
1561 assert!(
1562 expected_longest_rows.contains(&longest_row),
1563 "incorrect longest row {}. expected {:?} with length {}",
1564 longest_row,
1565 expected_longest_rows,
1566 longest_line_len,
1567 );
1568
1569 for row in 0..=blocks_snapshot.wrap_snapshot.max_point().row() {
1570 let wrap_point = WrapPoint::new(row, 0);
1571 let block_point = blocks_snapshot.to_block_point(wrap_point);
1572 assert_eq!(blocks_snapshot.to_wrap_point(block_point), wrap_point);
1573 }
1574
1575 let mut block_point = BlockPoint::new(0, 0);
1576 for c in expected_text.chars() {
1577 let left_point = blocks_snapshot.clip_point(block_point, Bias::Left);
1578 let left_buffer_point = blocks_snapshot.to_point(left_point, Bias::Left);
1579 assert_eq!(
1580 blocks_snapshot.to_block_point(blocks_snapshot.to_wrap_point(left_point)),
1581 left_point
1582 );
1583 assert_eq!(
1584 left_buffer_point,
1585 buffer_snapshot.clip_point(left_buffer_point, Bias::Right),
1586 "{:?} is not valid in buffer coordinates",
1587 left_point
1588 );
1589
1590 let right_point = blocks_snapshot.clip_point(block_point, Bias::Right);
1591 let right_buffer_point = blocks_snapshot.to_point(right_point, Bias::Right);
1592 assert_eq!(
1593 blocks_snapshot.to_block_point(blocks_snapshot.to_wrap_point(right_point)),
1594 right_point
1595 );
1596 assert_eq!(
1597 right_buffer_point,
1598 buffer_snapshot.clip_point(right_buffer_point, Bias::Left),
1599 "{:?} is not valid in buffer coordinates",
1600 right_point
1601 );
1602
1603 if c == '\n' {
1604 block_point.0 += Point::new(1, 0);
1605 } else {
1606 block_point.column += c.len_utf8() as u32;
1607 }
1608 }
1609 }
1610
1611 #[derive(Debug, Eq, PartialEq, Ord, PartialOrd)]
1612 enum ExpectedBlock {
1613 ExcerptHeader {
1614 height: u8,
1615 starts_new_buffer: bool,
1616 },
1617 Custom {
1618 disposition: BlockDisposition,
1619 id: BlockId,
1620 height: u8,
1621 },
1622 }
1623
1624 impl ExpectedBlock {
1625 fn height(&self) -> u8 {
1626 match self {
1627 ExpectedBlock::ExcerptHeader { height, .. } => *height,
1628 ExpectedBlock::Custom { height, .. } => *height,
1629 }
1630 }
1631
1632 fn disposition(&self) -> BlockDisposition {
1633 match self {
1634 ExpectedBlock::ExcerptHeader { .. } => BlockDisposition::Above,
1635 ExpectedBlock::Custom { disposition, .. } => *disposition,
1636 }
1637 }
1638 }
1639
1640 impl From<TransformBlock> for ExpectedBlock {
1641 fn from(block: TransformBlock) -> Self {
1642 match block {
1643 TransformBlock::Custom(block) => ExpectedBlock::Custom {
1644 id: block.id,
1645 disposition: block.disposition,
1646 height: block.height,
1647 },
1648 TransformBlock::ExcerptHeader {
1649 height,
1650 starts_new_buffer,
1651 ..
1652 } => ExpectedBlock::ExcerptHeader {
1653 height,
1654 starts_new_buffer,
1655 },
1656 }
1657 }
1658 }
1659 }
1660
1661 fn init_test(cx: &mut gpui::AppContext) {
1662 cx.set_global(SettingsStore::test(cx));
1663 theme::init((), cx);
1664 }
1665
1666 impl TransformBlock {
1667 fn as_custom(&self) -> Option<&Block> {
1668 match self {
1669 TransformBlock::Custom(block) => Some(block),
1670 TransformBlock::ExcerptHeader { .. } => None,
1671 }
1672 }
1673 }
1674
1675 impl BlockSnapshot {
1676 fn to_point(&self, point: BlockPoint, bias: Bias) -> Point {
1677 self.wrap_snapshot.to_point(self.to_wrap_point(point), bias)
1678 }
1679 }
1680}