1use super::{
2 wrap_map::{self, WrapEdit, WrapPoint, WrapSnapshot},
3 Highlights,
4};
5use crate::{Anchor, Editor, ExcerptId, ExcerptRange, ToPoint as _};
6use collections::{Bound, HashMap, HashSet};
7use gpui::{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(
577 0..self.transforms.summary().output_rows,
578 false,
579 Highlights::default(),
580 )
581 .map(|chunk| chunk.text)
582 .collect()
583 }
584
585 pub fn chunks<'a>(
586 &'a self,
587 rows: Range<u32>,
588 language_aware: bool,
589 highlights: Highlights<'a>,
590 ) -> BlockChunks<'a> {
591 let max_output_row = cmp::min(rows.end, self.transforms.summary().output_rows);
592 let mut cursor = self.transforms.cursor::<(BlockRow, WrapRow)>();
593 let input_end = {
594 cursor.seek(&BlockRow(rows.end), Bias::Right, &());
595 let overshoot = if cursor
596 .item()
597 .map_or(false, |transform| transform.is_isomorphic())
598 {
599 rows.end - cursor.start().0 .0
600 } else {
601 0
602 };
603 cursor.start().1 .0 + overshoot
604 };
605 let input_start = {
606 cursor.seek(&BlockRow(rows.start), Bias::Right, &());
607 let overshoot = if cursor
608 .item()
609 .map_or(false, |transform| transform.is_isomorphic())
610 {
611 rows.start - cursor.start().0 .0
612 } else {
613 0
614 };
615 cursor.start().1 .0 + overshoot
616 };
617 BlockChunks {
618 input_chunks: self.wrap_snapshot.chunks(
619 input_start..input_end,
620 language_aware,
621 highlights,
622 ),
623 input_chunk: Default::default(),
624 transforms: cursor,
625 output_row: rows.start,
626 max_output_row,
627 }
628 }
629
630 pub fn buffer_rows(&self, start_row: u32) -> BlockBufferRows {
631 let mut cursor = self.transforms.cursor::<(BlockRow, WrapRow)>();
632 cursor.seek(&BlockRow(start_row), Bias::Right, &());
633 let (output_start, input_start) = cursor.start();
634 let overshoot = if cursor.item().map_or(false, |t| t.is_isomorphic()) {
635 start_row - output_start.0
636 } else {
637 0
638 };
639 let input_start_row = input_start.0 + overshoot;
640 BlockBufferRows {
641 transforms: cursor,
642 input_buffer_rows: self.wrap_snapshot.buffer_rows(input_start_row),
643 output_row: start_row,
644 started: false,
645 }
646 }
647
648 pub fn blocks_in_range(
649 &self,
650 rows: Range<u32>,
651 ) -> impl Iterator<Item = (u32, &TransformBlock)> {
652 let mut cursor = self.transforms.cursor::<BlockRow>();
653 cursor.seek(&BlockRow(rows.start), Bias::Right, &());
654 std::iter::from_fn(move || {
655 while let Some(transform) = cursor.item() {
656 let start_row = cursor.start().0;
657 if start_row >= rows.end {
658 break;
659 }
660 if let Some(block) = &transform.block {
661 cursor.next(&());
662 return Some((start_row, block));
663 } else {
664 cursor.next(&());
665 }
666 }
667 None
668 })
669 }
670
671 pub fn max_point(&self) -> BlockPoint {
672 let row = self.transforms.summary().output_rows - 1;
673 BlockPoint::new(row, self.line_len(row))
674 }
675
676 pub fn longest_row(&self) -> u32 {
677 let input_row = self.wrap_snapshot.longest_row();
678 self.to_block_point(WrapPoint::new(input_row, 0)).row
679 }
680
681 pub fn line_len(&self, row: u32) -> u32 {
682 let mut cursor = self.transforms.cursor::<(BlockRow, WrapRow)>();
683 cursor.seek(&BlockRow(row), Bias::Right, &());
684 if let Some(transform) = cursor.item() {
685 let (output_start, input_start) = cursor.start();
686 let overshoot = row - output_start.0;
687 if transform.block.is_some() {
688 0
689 } else {
690 self.wrap_snapshot.line_len(input_start.0 + overshoot)
691 }
692 } else {
693 panic!("row out of range");
694 }
695 }
696
697 pub fn is_block_line(&self, row: u32) -> bool {
698 let mut cursor = self.transforms.cursor::<(BlockRow, WrapRow)>();
699 cursor.seek(&BlockRow(row), Bias::Right, &());
700 cursor.item().map_or(false, |t| t.block.is_some())
701 }
702
703 pub fn clip_point(&self, point: BlockPoint, bias: Bias) -> BlockPoint {
704 let mut cursor = self.transforms.cursor::<(BlockRow, WrapRow)>();
705 cursor.seek(&BlockRow(point.row), Bias::Right, &());
706
707 let max_input_row = WrapRow(self.transforms.summary().input_rows);
708 let mut search_left =
709 (bias == Bias::Left && cursor.start().1 .0 > 0) || cursor.end(&()).1 == max_input_row;
710 let mut reversed = false;
711
712 loop {
713 if let Some(transform) = cursor.item() {
714 if transform.is_isomorphic() {
715 let (output_start_row, input_start_row) = cursor.start();
716 let (output_end_row, input_end_row) = cursor.end(&());
717 let output_start = Point::new(output_start_row.0, 0);
718 let input_start = Point::new(input_start_row.0, 0);
719 let input_end = Point::new(input_end_row.0, 0);
720 let input_point = if point.row >= output_end_row.0 {
721 let line_len = self.wrap_snapshot.line_len(input_end_row.0 - 1);
722 self.wrap_snapshot
723 .clip_point(WrapPoint::new(input_end_row.0 - 1, line_len), bias)
724 } else {
725 let output_overshoot = point.0.saturating_sub(output_start);
726 self.wrap_snapshot
727 .clip_point(WrapPoint(input_start + output_overshoot), bias)
728 };
729
730 if (input_start..input_end).contains(&input_point.0) {
731 let input_overshoot = input_point.0.saturating_sub(input_start);
732 return BlockPoint(output_start + input_overshoot);
733 }
734 }
735
736 if search_left {
737 cursor.prev(&());
738 } else {
739 cursor.next(&());
740 }
741 } else if reversed {
742 return self.max_point();
743 } else {
744 reversed = true;
745 search_left = !search_left;
746 cursor.seek(&BlockRow(point.row), Bias::Right, &());
747 }
748 }
749 }
750
751 pub fn to_block_point(&self, wrap_point: WrapPoint) -> BlockPoint {
752 let mut cursor = self.transforms.cursor::<(WrapRow, BlockRow)>();
753 cursor.seek(&WrapRow(wrap_point.row()), Bias::Right, &());
754 if let Some(transform) = cursor.item() {
755 debug_assert!(transform.is_isomorphic());
756 } else {
757 return self.max_point();
758 }
759
760 let (input_start_row, output_start_row) = cursor.start();
761 let input_start = Point::new(input_start_row.0, 0);
762 let output_start = Point::new(output_start_row.0, 0);
763 let input_overshoot = wrap_point.0 - input_start;
764 BlockPoint(output_start + input_overshoot)
765 }
766
767 pub fn to_wrap_point(&self, block_point: BlockPoint) -> WrapPoint {
768 let mut cursor = self.transforms.cursor::<(BlockRow, WrapRow)>();
769 cursor.seek(&BlockRow(block_point.row), Bias::Right, &());
770 if let Some(transform) = cursor.item() {
771 match transform.block.as_ref().map(|b| b.disposition()) {
772 Some(BlockDisposition::Above) => WrapPoint::new(cursor.start().1 .0, 0),
773 Some(BlockDisposition::Below) => {
774 let wrap_row = cursor.start().1 .0 - 1;
775 WrapPoint::new(wrap_row, self.wrap_snapshot.line_len(wrap_row))
776 }
777 None => {
778 let overshoot = block_point.row - cursor.start().0 .0;
779 let wrap_row = cursor.start().1 .0 + overshoot;
780 WrapPoint::new(wrap_row, block_point.column)
781 }
782 }
783 } else {
784 self.wrap_snapshot.max_point()
785 }
786 }
787}
788
789impl Transform {
790 fn isomorphic(rows: u32) -> Self {
791 Self {
792 summary: TransformSummary {
793 input_rows: rows,
794 output_rows: rows,
795 },
796 block: None,
797 }
798 }
799
800 fn block(block: TransformBlock) -> Self {
801 Self {
802 summary: TransformSummary {
803 input_rows: 0,
804 output_rows: block.height() as u32,
805 },
806 block: Some(block),
807 }
808 }
809
810 fn is_isomorphic(&self) -> bool {
811 self.block.is_none()
812 }
813}
814
815impl<'a> Iterator for BlockChunks<'a> {
816 type Item = Chunk<'a>;
817
818 fn next(&mut self) -> Option<Self::Item> {
819 if self.output_row >= self.max_output_row {
820 return None;
821 }
822
823 let transform = self.transforms.item()?;
824 if transform.block.is_some() {
825 let block_start = self.transforms.start().0 .0;
826 let mut block_end = self.transforms.end(&()).0 .0;
827 self.transforms.next(&());
828 if self.transforms.item().is_none() {
829 block_end -= 1;
830 }
831
832 let start_in_block = self.output_row - block_start;
833 let end_in_block = cmp::min(self.max_output_row, block_end) - block_start;
834 let line_count = end_in_block - start_in_block;
835 self.output_row += line_count;
836
837 return Some(Chunk {
838 text: unsafe { std::str::from_utf8_unchecked(&NEWLINES[..line_count as usize]) },
839 ..Default::default()
840 });
841 }
842
843 if self.input_chunk.text.is_empty() {
844 if let Some(input_chunk) = self.input_chunks.next() {
845 self.input_chunk = input_chunk;
846 } else {
847 self.output_row += 1;
848 if self.output_row < self.max_output_row {
849 self.transforms.next(&());
850 return Some(Chunk {
851 text: "\n",
852 ..Default::default()
853 });
854 } else {
855 return None;
856 }
857 }
858 }
859
860 let transform_end = self.transforms.end(&()).0 .0;
861 let (prefix_rows, prefix_bytes) =
862 offset_for_row(self.input_chunk.text, transform_end - self.output_row);
863 self.output_row += prefix_rows;
864 let (prefix, suffix) = self.input_chunk.text.split_at(prefix_bytes);
865 self.input_chunk.text = suffix;
866 if self.output_row == transform_end {
867 self.transforms.next(&());
868 }
869
870 Some(Chunk {
871 text: prefix,
872 ..self.input_chunk
873 })
874 }
875}
876
877impl<'a> Iterator for BlockBufferRows<'a> {
878 type Item = Option<u32>;
879
880 fn next(&mut self) -> Option<Self::Item> {
881 if self.started {
882 self.output_row += 1;
883 } else {
884 self.started = true;
885 }
886
887 if self.output_row >= self.transforms.end(&()).0 .0 {
888 self.transforms.next(&());
889 }
890
891 let transform = self.transforms.item()?;
892 if transform.block.is_some() {
893 Some(None)
894 } else {
895 Some(self.input_buffer_rows.next().unwrap())
896 }
897 }
898}
899
900impl sum_tree::Item for Transform {
901 type Summary = TransformSummary;
902
903 fn summary(&self) -> Self::Summary {
904 self.summary.clone()
905 }
906}
907
908impl sum_tree::Summary for TransformSummary {
909 type Context = ();
910
911 fn add_summary(&mut self, summary: &Self, _: &()) {
912 self.input_rows += summary.input_rows;
913 self.output_rows += summary.output_rows;
914 }
915}
916
917impl<'a> sum_tree::Dimension<'a, TransformSummary> for WrapRow {
918 fn add_summary(&mut self, summary: &'a TransformSummary, _: &()) {
919 self.0 += summary.input_rows;
920 }
921}
922
923impl<'a> sum_tree::Dimension<'a, TransformSummary> for BlockRow {
924 fn add_summary(&mut self, summary: &'a TransformSummary, _: &()) {
925 self.0 += summary.output_rows;
926 }
927}
928
929impl BlockDisposition {
930 fn is_below(&self) -> bool {
931 matches!(self, BlockDisposition::Below)
932 }
933}
934
935impl<'a, 'b, 'c> Deref for BlockContext<'a, 'b, 'c> {
936 type Target = ViewContext<'a, 'b, Editor>;
937
938 fn deref(&self) -> &Self::Target {
939 self.view_context
940 }
941}
942
943impl DerefMut for BlockContext<'_, '_, '_> {
944 fn deref_mut(&mut self) -> &mut Self::Target {
945 self.view_context
946 }
947}
948
949impl Block {
950 pub fn render(&self, cx: &mut BlockContext) -> AnyElement<Editor> {
951 self.render.lock()(cx)
952 }
953
954 pub fn position(&self) -> &Anchor {
955 &self.position
956 }
957
958 pub fn style(&self) -> BlockStyle {
959 self.style
960 }
961}
962
963impl Debug for Block {
964 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
965 f.debug_struct("Block")
966 .field("id", &self.id)
967 .field("position", &self.position)
968 .field("disposition", &self.disposition)
969 .finish()
970 }
971}
972
973// Count the number of bytes prior to a target point. If the string doesn't contain the target
974// point, return its total extent. Otherwise return the target point itself.
975fn offset_for_row(s: &str, target: u32) -> (u32, usize) {
976 let mut row = 0;
977 let mut offset = 0;
978 for (ix, line) in s.split('\n').enumerate() {
979 if ix > 0 {
980 row += 1;
981 offset += 1;
982 }
983 if row >= target {
984 break;
985 }
986 offset += line.len() as usize;
987 }
988 (row, offset)
989}
990
991#[cfg(test)]
992mod tests {
993 use super::*;
994 use crate::display_map::inlay_map::InlayMap;
995 use crate::display_map::{fold_map::FoldMap, tab_map::TabMap, wrap_map::WrapMap};
996 use gpui::{elements::Empty, Element};
997 use multi_buffer::MultiBuffer;
998 use rand::prelude::*;
999 use settings::SettingsStore;
1000 use std::env;
1001 use util::RandomCharIter;
1002
1003 #[gpui::test]
1004 fn test_offset_for_row() {
1005 assert_eq!(offset_for_row("", 0), (0, 0));
1006 assert_eq!(offset_for_row("", 1), (0, 0));
1007 assert_eq!(offset_for_row("abcd", 0), (0, 0));
1008 assert_eq!(offset_for_row("abcd", 1), (0, 4));
1009 assert_eq!(offset_for_row("\n", 0), (0, 0));
1010 assert_eq!(offset_for_row("\n", 1), (1, 1));
1011 assert_eq!(offset_for_row("abc\ndef\nghi", 0), (0, 0));
1012 assert_eq!(offset_for_row("abc\ndef\nghi", 1), (1, 4));
1013 assert_eq!(offset_for_row("abc\ndef\nghi", 2), (2, 8));
1014 assert_eq!(offset_for_row("abc\ndef\nghi", 3), (2, 11));
1015 }
1016
1017 #[gpui::test]
1018 fn test_basic_blocks(cx: &mut gpui::AppContext) {
1019 init_test(cx);
1020
1021 let family_id = cx
1022 .font_cache()
1023 .load_family(&["Helvetica"], &Default::default())
1024 .unwrap();
1025 let font_id = cx
1026 .font_cache()
1027 .select_font(family_id, &Default::default())
1028 .unwrap();
1029
1030 let text = "aaa\nbbb\nccc\nddd";
1031
1032 let buffer = MultiBuffer::build_simple(text, cx);
1033 let buffer_snapshot = buffer.read(cx).snapshot(cx);
1034 let subscription = buffer.update(cx, |buffer, _| buffer.subscribe());
1035 let (mut inlay_map, inlay_snapshot) = InlayMap::new(buffer_snapshot.clone());
1036 let (mut fold_map, fold_snapshot) = FoldMap::new(inlay_snapshot);
1037 let (mut tab_map, tab_snapshot) = TabMap::new(fold_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 (inlay_snapshot, inlay_edits) =
1181 inlay_map.sync(buffer_snapshot, subscription.consume().into_inner());
1182 let (fold_snapshot, fold_edits) = fold_map.read(inlay_snapshot, inlay_edits);
1183 let (tab_snapshot, tab_edits) =
1184 tab_map.sync(fold_snapshot, fold_edits, 4.try_into().unwrap());
1185 let (wraps_snapshot, wrap_edits) = wrap_map.update(cx, |wrap_map, cx| {
1186 wrap_map.sync(tab_snapshot, tab_edits, cx)
1187 });
1188 let snapshot = block_map.read(wraps_snapshot, wrap_edits);
1189 assert_eq!(snapshot.text(), "aaa\n\nb!!!\n\n\nbb\nccc\nddd\n\n\n");
1190 }
1191
1192 #[gpui::test]
1193 fn test_blocks_on_wrapped_lines(cx: &mut gpui::AppContext) {
1194 init_test(cx);
1195
1196 let family_id = cx
1197 .font_cache()
1198 .load_family(&["Helvetica"], &Default::default())
1199 .unwrap();
1200 let font_id = cx
1201 .font_cache()
1202 .select_font(family_id, &Default::default())
1203 .unwrap();
1204
1205 let text = "one two three\nfour five six\nseven eight";
1206
1207 let buffer = MultiBuffer::build_simple(text, cx);
1208 let buffer_snapshot = buffer.read(cx).snapshot(cx);
1209 let (_, inlay_snapshot) = InlayMap::new(buffer_snapshot.clone());
1210 let (_, fold_snapshot) = FoldMap::new(inlay_snapshot);
1211 let (_, tab_snapshot) = TabMap::new(fold_snapshot, 4.try_into().unwrap());
1212 let (_, wraps_snapshot) = WrapMap::new(tab_snapshot, font_id, 14.0, Some(60.), cx);
1213 let mut block_map = BlockMap::new(wraps_snapshot.clone(), 1, 1);
1214
1215 let mut writer = block_map.write(wraps_snapshot.clone(), Default::default());
1216 writer.insert(vec![
1217 BlockProperties {
1218 style: BlockStyle::Fixed,
1219 position: buffer_snapshot.anchor_after(Point::new(1, 12)),
1220 disposition: BlockDisposition::Above,
1221 render: Arc::new(|_| Empty::new().into_any_named("block 1")),
1222 height: 1,
1223 },
1224 BlockProperties {
1225 style: BlockStyle::Fixed,
1226 position: buffer_snapshot.anchor_after(Point::new(1, 1)),
1227 disposition: BlockDisposition::Below,
1228 render: Arc::new(|_| Empty::new().into_any_named("block 2")),
1229 height: 1,
1230 },
1231 ]);
1232
1233 // Blocks with an 'above' disposition go above their corresponding buffer line.
1234 // Blocks with a 'below' disposition go below their corresponding buffer line.
1235 let snapshot = block_map.read(wraps_snapshot, Default::default());
1236 assert_eq!(
1237 snapshot.text(),
1238 "one two \nthree\n\nfour five \nsix\n\nseven \neight"
1239 );
1240 }
1241
1242 #[gpui::test(iterations = 100)]
1243 fn test_random_blocks(cx: &mut gpui::AppContext, mut rng: StdRng) {
1244 init_test(cx);
1245
1246 let operations = env::var("OPERATIONS")
1247 .map(|i| i.parse().expect("invalid `OPERATIONS` variable"))
1248 .unwrap_or(10);
1249
1250 let wrap_width = if rng.gen_bool(0.2) {
1251 None
1252 } else {
1253 Some(rng.gen_range(0.0..=100.0))
1254 };
1255 let tab_size = 1.try_into().unwrap();
1256 let family_id = cx
1257 .font_cache()
1258 .load_family(&["Helvetica"], &Default::default())
1259 .unwrap();
1260 let font_id = cx
1261 .font_cache()
1262 .select_font(family_id, &Default::default())
1263 .unwrap();
1264 let font_size = 14.0;
1265 let buffer_start_header_height = rng.gen_range(1..=5);
1266 let excerpt_header_height = rng.gen_range(1..=5);
1267
1268 log::info!("Wrap width: {:?}", wrap_width);
1269 log::info!("Excerpt Header Height: {:?}", excerpt_header_height);
1270
1271 let buffer = if rng.gen() {
1272 let len = rng.gen_range(0..10);
1273 let text = RandomCharIter::new(&mut rng).take(len).collect::<String>();
1274 log::info!("initial buffer text: {:?}", text);
1275 MultiBuffer::build_simple(&text, cx)
1276 } else {
1277 MultiBuffer::build_random(&mut rng, cx)
1278 };
1279
1280 let mut buffer_snapshot = buffer.read(cx).snapshot(cx);
1281 let (mut inlay_map, inlay_snapshot) = InlayMap::new(buffer_snapshot.clone());
1282 let (mut fold_map, fold_snapshot) = FoldMap::new(inlay_snapshot);
1283 let (mut tab_map, tab_snapshot) = TabMap::new(fold_snapshot, 4.try_into().unwrap());
1284 let (wrap_map, wraps_snapshot) =
1285 WrapMap::new(tab_snapshot, font_id, font_size, wrap_width, cx);
1286 let mut block_map = BlockMap::new(
1287 wraps_snapshot,
1288 buffer_start_header_height,
1289 excerpt_header_height,
1290 );
1291 let mut custom_blocks = Vec::new();
1292
1293 for _ in 0..operations {
1294 let mut buffer_edits = Vec::new();
1295 match rng.gen_range(0..=100) {
1296 0..=19 => {
1297 let wrap_width = if rng.gen_bool(0.2) {
1298 None
1299 } else {
1300 Some(rng.gen_range(0.0..=100.0))
1301 };
1302 log::info!("Setting wrap width to {:?}", wrap_width);
1303 wrap_map.update(cx, |map, cx| map.set_wrap_width(wrap_width, cx));
1304 }
1305 20..=39 => {
1306 let block_count = rng.gen_range(1..=5);
1307 let block_properties = (0..block_count)
1308 .map(|_| {
1309 let buffer = buffer.read(cx).read(cx);
1310 let position = buffer.anchor_after(
1311 buffer.clip_offset(rng.gen_range(0..=buffer.len()), Bias::Left),
1312 );
1313
1314 let disposition = if rng.gen() {
1315 BlockDisposition::Above
1316 } else {
1317 BlockDisposition::Below
1318 };
1319 let height = rng.gen_range(1..5);
1320 log::info!(
1321 "inserting block {:?} {:?} with height {}",
1322 disposition,
1323 position.to_point(&buffer),
1324 height
1325 );
1326 BlockProperties {
1327 style: BlockStyle::Fixed,
1328 position,
1329 height,
1330 disposition,
1331 render: Arc::new(|_| Empty::new().into_any()),
1332 }
1333 })
1334 .collect::<Vec<_>>();
1335
1336 let (inlay_snapshot, inlay_edits) =
1337 inlay_map.sync(buffer_snapshot.clone(), vec![]);
1338 let (fold_snapshot, fold_edits) = fold_map.read(inlay_snapshot, inlay_edits);
1339 let (tab_snapshot, tab_edits) =
1340 tab_map.sync(fold_snapshot, fold_edits, tab_size);
1341 let (wraps_snapshot, wrap_edits) = wrap_map.update(cx, |wrap_map, cx| {
1342 wrap_map.sync(tab_snapshot, tab_edits, cx)
1343 });
1344 let mut block_map = block_map.write(wraps_snapshot, wrap_edits);
1345 let block_ids = block_map.insert(block_properties.clone());
1346 for (block_id, props) in block_ids.into_iter().zip(block_properties) {
1347 custom_blocks.push((block_id, props));
1348 }
1349 }
1350 40..=59 if !custom_blocks.is_empty() => {
1351 let block_count = rng.gen_range(1..=4.min(custom_blocks.len()));
1352 let block_ids_to_remove = (0..block_count)
1353 .map(|_| {
1354 custom_blocks
1355 .remove(rng.gen_range(0..custom_blocks.len()))
1356 .0
1357 })
1358 .collect();
1359
1360 let (inlay_snapshot, inlay_edits) =
1361 inlay_map.sync(buffer_snapshot.clone(), vec![]);
1362 let (fold_snapshot, fold_edits) = fold_map.read(inlay_snapshot, inlay_edits);
1363 let (tab_snapshot, tab_edits) =
1364 tab_map.sync(fold_snapshot, fold_edits, tab_size);
1365 let (wraps_snapshot, wrap_edits) = wrap_map.update(cx, |wrap_map, cx| {
1366 wrap_map.sync(tab_snapshot, tab_edits, cx)
1367 });
1368 let mut block_map = block_map.write(wraps_snapshot, wrap_edits);
1369 block_map.remove(block_ids_to_remove);
1370 }
1371 _ => {
1372 buffer.update(cx, |buffer, cx| {
1373 let mutation_count = rng.gen_range(1..=5);
1374 let subscription = buffer.subscribe();
1375 buffer.randomly_mutate(&mut rng, mutation_count, cx);
1376 buffer_snapshot = buffer.snapshot(cx);
1377 buffer_edits.extend(subscription.consume());
1378 log::info!("buffer text: {:?}", buffer_snapshot.text());
1379 });
1380 }
1381 }
1382
1383 let (inlay_snapshot, inlay_edits) =
1384 inlay_map.sync(buffer_snapshot.clone(), buffer_edits);
1385 let (fold_snapshot, fold_edits) = fold_map.read(inlay_snapshot, inlay_edits);
1386 let (tab_snapshot, tab_edits) = tab_map.sync(fold_snapshot, fold_edits, tab_size);
1387 let (wraps_snapshot, wrap_edits) = wrap_map.update(cx, |wrap_map, cx| {
1388 wrap_map.sync(tab_snapshot, tab_edits, cx)
1389 });
1390 let blocks_snapshot = block_map.read(wraps_snapshot.clone(), wrap_edits);
1391 assert_eq!(
1392 blocks_snapshot.transforms.summary().input_rows,
1393 wraps_snapshot.max_point().row() + 1
1394 );
1395 log::info!("blocks text: {:?}", blocks_snapshot.text());
1396
1397 let mut expected_blocks = Vec::new();
1398 expected_blocks.extend(custom_blocks.iter().map(|(id, block)| {
1399 let mut position = block.position.to_point(&buffer_snapshot);
1400 match block.disposition {
1401 BlockDisposition::Above => {
1402 position.column = 0;
1403 }
1404 BlockDisposition::Below => {
1405 position.column = buffer_snapshot.line_len(position.row);
1406 }
1407 };
1408 let row = wraps_snapshot.make_wrap_point(position, Bias::Left).row();
1409 (
1410 row,
1411 ExpectedBlock::Custom {
1412 disposition: block.disposition,
1413 id: *id,
1414 height: block.height,
1415 },
1416 )
1417 }));
1418 expected_blocks.extend(buffer_snapshot.excerpt_boundaries_in_range(0..).map(
1419 |boundary| {
1420 let position =
1421 wraps_snapshot.make_wrap_point(Point::new(boundary.row, 0), Bias::Left);
1422 (
1423 position.row(),
1424 ExpectedBlock::ExcerptHeader {
1425 height: if boundary.starts_new_buffer {
1426 buffer_start_header_height
1427 } else {
1428 excerpt_header_height
1429 },
1430 starts_new_buffer: boundary.starts_new_buffer,
1431 },
1432 )
1433 },
1434 ));
1435 expected_blocks.sort_unstable();
1436 let mut sorted_blocks_iter = expected_blocks.into_iter().peekable();
1437
1438 let input_buffer_rows = buffer_snapshot.buffer_rows(0).collect::<Vec<_>>();
1439 let mut expected_buffer_rows = Vec::new();
1440 let mut expected_text = String::new();
1441 let mut expected_block_positions = Vec::new();
1442 let input_text = wraps_snapshot.text();
1443 for (row, input_line) in input_text.split('\n').enumerate() {
1444 let row = row as u32;
1445 if row > 0 {
1446 expected_text.push('\n');
1447 }
1448
1449 let buffer_row = input_buffer_rows[wraps_snapshot
1450 .to_point(WrapPoint::new(row, 0), Bias::Left)
1451 .row as usize];
1452
1453 while let Some((block_row, block)) = sorted_blocks_iter.peek() {
1454 if *block_row == row && block.disposition() == BlockDisposition::Above {
1455 let (_, block) = sorted_blocks_iter.next().unwrap();
1456 let height = block.height() as usize;
1457 expected_block_positions
1458 .push((expected_text.matches('\n').count() as u32, block));
1459 let text = "\n".repeat(height);
1460 expected_text.push_str(&text);
1461 for _ in 0..height {
1462 expected_buffer_rows.push(None);
1463 }
1464 } else {
1465 break;
1466 }
1467 }
1468
1469 let soft_wrapped = wraps_snapshot.to_tab_point(WrapPoint::new(row, 0)).column() > 0;
1470 expected_buffer_rows.push(if soft_wrapped { None } else { buffer_row });
1471 expected_text.push_str(input_line);
1472
1473 while let Some((block_row, block)) = sorted_blocks_iter.peek() {
1474 if *block_row == row && block.disposition() == BlockDisposition::Below {
1475 let (_, block) = sorted_blocks_iter.next().unwrap();
1476 let height = block.height() as usize;
1477 expected_block_positions
1478 .push((expected_text.matches('\n').count() as u32 + 1, block));
1479 let text = "\n".repeat(height);
1480 expected_text.push_str(&text);
1481 for _ in 0..height {
1482 expected_buffer_rows.push(None);
1483 }
1484 } else {
1485 break;
1486 }
1487 }
1488 }
1489
1490 let expected_lines = expected_text.split('\n').collect::<Vec<_>>();
1491 let expected_row_count = expected_lines.len();
1492 for start_row in 0..expected_row_count {
1493 let expected_text = expected_lines[start_row..].join("\n");
1494 let actual_text = blocks_snapshot
1495 .chunks(
1496 start_row as u32..blocks_snapshot.max_point().row + 1,
1497 false,
1498 Highlights::default(),
1499 )
1500 .map(|chunk| chunk.text)
1501 .collect::<String>();
1502 assert_eq!(
1503 actual_text, expected_text,
1504 "incorrect text starting from row {}",
1505 start_row
1506 );
1507 assert_eq!(
1508 blocks_snapshot
1509 .buffer_rows(start_row as u32)
1510 .collect::<Vec<_>>(),
1511 &expected_buffer_rows[start_row..]
1512 );
1513 }
1514
1515 assert_eq!(
1516 blocks_snapshot
1517 .blocks_in_range(0..(expected_row_count as u32))
1518 .map(|(row, block)| (row, block.clone().into()))
1519 .collect::<Vec<_>>(),
1520 expected_block_positions
1521 );
1522
1523 let mut expected_longest_rows = Vec::new();
1524 let mut longest_line_len = -1_isize;
1525 for (row, line) in expected_lines.iter().enumerate() {
1526 let row = row as u32;
1527
1528 assert_eq!(
1529 blocks_snapshot.line_len(row),
1530 line.len() as u32,
1531 "invalid line len for row {}",
1532 row
1533 );
1534
1535 let line_char_count = line.chars().count() as isize;
1536 match line_char_count.cmp(&longest_line_len) {
1537 Ordering::Less => {}
1538 Ordering::Equal => expected_longest_rows.push(row),
1539 Ordering::Greater => {
1540 longest_line_len = line_char_count;
1541 expected_longest_rows.clear();
1542 expected_longest_rows.push(row);
1543 }
1544 }
1545 }
1546
1547 let longest_row = blocks_snapshot.longest_row();
1548 assert!(
1549 expected_longest_rows.contains(&longest_row),
1550 "incorrect longest row {}. expected {:?} with length {}",
1551 longest_row,
1552 expected_longest_rows,
1553 longest_line_len,
1554 );
1555
1556 for row in 0..=blocks_snapshot.wrap_snapshot.max_point().row() {
1557 let wrap_point = WrapPoint::new(row, 0);
1558 let block_point = blocks_snapshot.to_block_point(wrap_point);
1559 assert_eq!(blocks_snapshot.to_wrap_point(block_point), wrap_point);
1560 }
1561
1562 let mut block_point = BlockPoint::new(0, 0);
1563 for c in expected_text.chars() {
1564 let left_point = blocks_snapshot.clip_point(block_point, Bias::Left);
1565 let left_buffer_point = blocks_snapshot.to_point(left_point, Bias::Left);
1566 assert_eq!(
1567 blocks_snapshot.to_block_point(blocks_snapshot.to_wrap_point(left_point)),
1568 left_point
1569 );
1570 assert_eq!(
1571 left_buffer_point,
1572 buffer_snapshot.clip_point(left_buffer_point, Bias::Right),
1573 "{:?} is not valid in buffer coordinates",
1574 left_point
1575 );
1576
1577 let right_point = blocks_snapshot.clip_point(block_point, Bias::Right);
1578 let right_buffer_point = blocks_snapshot.to_point(right_point, Bias::Right);
1579 assert_eq!(
1580 blocks_snapshot.to_block_point(blocks_snapshot.to_wrap_point(right_point)),
1581 right_point
1582 );
1583 assert_eq!(
1584 right_buffer_point,
1585 buffer_snapshot.clip_point(right_buffer_point, Bias::Left),
1586 "{:?} is not valid in buffer coordinates",
1587 right_point
1588 );
1589
1590 if c == '\n' {
1591 block_point.0 += Point::new(1, 0);
1592 } else {
1593 block_point.column += c.len_utf8() as u32;
1594 }
1595 }
1596 }
1597
1598 #[derive(Debug, Eq, PartialEq, Ord, PartialOrd)]
1599 enum ExpectedBlock {
1600 ExcerptHeader {
1601 height: u8,
1602 starts_new_buffer: bool,
1603 },
1604 Custom {
1605 disposition: BlockDisposition,
1606 id: BlockId,
1607 height: u8,
1608 },
1609 }
1610
1611 impl ExpectedBlock {
1612 fn height(&self) -> u8 {
1613 match self {
1614 ExpectedBlock::ExcerptHeader { height, .. } => *height,
1615 ExpectedBlock::Custom { height, .. } => *height,
1616 }
1617 }
1618
1619 fn disposition(&self) -> BlockDisposition {
1620 match self {
1621 ExpectedBlock::ExcerptHeader { .. } => BlockDisposition::Above,
1622 ExpectedBlock::Custom { disposition, .. } => *disposition,
1623 }
1624 }
1625 }
1626
1627 impl From<TransformBlock> for ExpectedBlock {
1628 fn from(block: TransformBlock) -> Self {
1629 match block {
1630 TransformBlock::Custom(block) => ExpectedBlock::Custom {
1631 id: block.id,
1632 disposition: block.disposition,
1633 height: block.height,
1634 },
1635 TransformBlock::ExcerptHeader {
1636 height,
1637 starts_new_buffer,
1638 ..
1639 } => ExpectedBlock::ExcerptHeader {
1640 height,
1641 starts_new_buffer,
1642 },
1643 }
1644 }
1645 }
1646 }
1647
1648 fn init_test(cx: &mut gpui::AppContext) {
1649 cx.set_global(SettingsStore::test(cx));
1650 theme::init((), cx);
1651 }
1652
1653 impl TransformBlock {
1654 fn as_custom(&self) -> Option<&Block> {
1655 match self {
1656 TransformBlock::Custom(block) => Some(block),
1657 TransformBlock::ExcerptHeader { .. } => None,
1658 }
1659 }
1660 }
1661
1662 impl BlockSnapshot {
1663 fn to_point(&self, point: BlockPoint, bias: Bias) -> Point {
1664 self.wrap_snapshot.to_point(self.to_wrap_point(point), bias)
1665 }
1666 }
1667}