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}
92
93#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord)]
94pub enum BlockDisposition {
95 Above,
96 Below,
97}
98
99#[derive(Clone, Debug)]
100struct Transform {
101 summary: TransformSummary,
102 block: Option<TransformBlock>,
103}
104
105#[allow(clippy::large_enum_variant)]
106#[derive(Clone)]
107pub enum TransformBlock {
108 Custom(Arc<Block>),
109 ExcerptHeader {
110 id: ExcerptId,
111 buffer: BufferSnapshot,
112 range: ExcerptRange<text::Anchor>,
113 height: u8,
114 starts_new_buffer: bool,
115 },
116}
117
118impl TransformBlock {
119 fn disposition(&self) -> BlockDisposition {
120 match self {
121 TransformBlock::Custom(block) => block.disposition,
122 TransformBlock::ExcerptHeader { .. } => BlockDisposition::Above,
123 }
124 }
125
126 pub fn height(&self) -> u8 {
127 match self {
128 TransformBlock::Custom(block) => block.height,
129 TransformBlock::ExcerptHeader { height, .. } => *height,
130 }
131 }
132}
133
134impl Debug for TransformBlock {
135 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
136 match self {
137 Self::Custom(block) => f.debug_struct("Custom").field("block", block).finish(),
138 Self::ExcerptHeader { buffer, .. } => f
139 .debug_struct("ExcerptHeader")
140 .field("path", &buffer.file().map(|f| f.path()))
141 .finish(),
142 }
143 }
144}
145
146#[derive(Clone, Debug, Default)]
147struct TransformSummary {
148 input_rows: u32,
149 output_rows: u32,
150}
151
152pub struct BlockChunks<'a> {
153 transforms: sum_tree::Cursor<'a, Transform, (BlockRow, WrapRow)>,
154 input_chunks: wrap_map::WrapChunks<'a>,
155 input_chunk: Chunk<'a>,
156 output_row: u32,
157 max_output_row: u32,
158}
159
160#[derive(Clone)]
161pub struct BlockBufferRows<'a> {
162 transforms: sum_tree::Cursor<'a, Transform, (BlockRow, WrapRow)>,
163 input_buffer_rows: wrap_map::WrapBufferRows<'a>,
164 output_row: u32,
165 started: bool,
166}
167
168impl BlockMap {
169 pub fn new(
170 wrap_snapshot: WrapSnapshot,
171 buffer_header_height: u8,
172 excerpt_header_height: u8,
173 ) -> Self {
174 let row_count = wrap_snapshot.max_point().row() + 1;
175 let map = Self {
176 next_block_id: AtomicUsize::new(0),
177 blocks: Vec::new(),
178 transforms: RefCell::new(SumTree::from_item(Transform::isomorphic(row_count), &())),
179 wrap_snapshot: RefCell::new(wrap_snapshot.clone()),
180 buffer_header_height,
181 excerpt_header_height,
182 };
183 map.sync(
184 &wrap_snapshot,
185 Patch::new(vec![Edit {
186 old: 0..row_count,
187 new: 0..row_count,
188 }]),
189 );
190 map
191 }
192
193 pub fn read(&self, wrap_snapshot: WrapSnapshot, edits: Patch<u32>) -> BlockSnapshot {
194 self.sync(&wrap_snapshot, edits);
195 *self.wrap_snapshot.borrow_mut() = wrap_snapshot.clone();
196 BlockSnapshot {
197 wrap_snapshot,
198 transforms: self.transforms.borrow().clone(),
199 }
200 }
201
202 pub fn write(&mut self, wrap_snapshot: WrapSnapshot, edits: Patch<u32>) -> BlockMapWriter {
203 self.sync(&wrap_snapshot, edits);
204 *self.wrap_snapshot.borrow_mut() = wrap_snapshot;
205 BlockMapWriter(self)
206 }
207
208 fn sync(&self, wrap_snapshot: &WrapSnapshot, mut edits: Patch<u32>) {
209 let buffer = wrap_snapshot.buffer_snapshot();
210
211 // Handle changing the last excerpt if it is empty.
212 if buffer.trailing_excerpt_update_count()
213 != self
214 .wrap_snapshot
215 .borrow()
216 .buffer_snapshot()
217 .trailing_excerpt_update_count()
218 {
219 let max_point = wrap_snapshot.max_point();
220 let edit_start = wrap_snapshot.prev_row_boundary(max_point);
221 let edit_end = max_point.row() + 1;
222 edits = edits.compose([WrapEdit {
223 old: edit_start..edit_end,
224 new: edit_start..edit_end,
225 }]);
226 }
227
228 let edits = edits.into_inner();
229 if edits.is_empty() {
230 return;
231 }
232
233 let mut transforms = self.transforms.borrow_mut();
234 let mut new_transforms = SumTree::new();
235 let old_row_count = transforms.summary().input_rows;
236 let new_row_count = wrap_snapshot.max_point().row() + 1;
237 let mut cursor = transforms.cursor::<WrapRow>();
238 let mut last_block_ix = 0;
239 let mut blocks_in_edit = Vec::new();
240 let mut edits = edits.into_iter().peekable();
241
242 while let Some(edit) = edits.next() {
243 // Preserve any old transforms that precede this edit.
244 let old_start = WrapRow(edit.old.start);
245 let new_start = WrapRow(edit.new.start);
246 new_transforms.push_tree(cursor.slice(&old_start, Bias::Left, &()), &());
247 if let Some(transform) = cursor.item() {
248 if transform.is_isomorphic() && old_start == cursor.end(&()) {
249 new_transforms.push(transform.clone(), &());
250 cursor.next(&());
251 while let Some(transform) = cursor.item() {
252 if transform
253 .block
254 .as_ref()
255 .map_or(false, |b| b.disposition().is_below())
256 {
257 new_transforms.push(transform.clone(), &());
258 cursor.next(&());
259 } else {
260 break;
261 }
262 }
263 }
264 }
265
266 // Preserve any portion of an old transform that precedes this edit.
267 let extent_before_edit = old_start.0 - cursor.start().0;
268 push_isomorphic(&mut new_transforms, extent_before_edit);
269
270 // Skip over any old transforms that intersect this edit.
271 let mut old_end = WrapRow(edit.old.end);
272 let mut new_end = WrapRow(edit.new.end);
273 cursor.seek(&old_end, Bias::Left, &());
274 cursor.next(&());
275 if old_end == *cursor.start() {
276 while let Some(transform) = cursor.item() {
277 if transform
278 .block
279 .as_ref()
280 .map_or(false, |b| b.disposition().is_below())
281 {
282 cursor.next(&());
283 } else {
284 break;
285 }
286 }
287 }
288
289 // Combine this edit with any subsequent edits that intersect the same transform.
290 while let Some(next_edit) = edits.peek() {
291 if next_edit.old.start <= cursor.start().0 {
292 old_end = WrapRow(next_edit.old.end);
293 new_end = WrapRow(next_edit.new.end);
294 cursor.seek(&old_end, Bias::Left, &());
295 cursor.next(&());
296 if old_end == *cursor.start() {
297 while let Some(transform) = cursor.item() {
298 if transform
299 .block
300 .as_ref()
301 .map_or(false, |b| b.disposition().is_below())
302 {
303 cursor.next(&());
304 } else {
305 break;
306 }
307 }
308 }
309 edits.next();
310 } else {
311 break;
312 }
313 }
314
315 // Find the blocks within this edited region.
316 let new_buffer_start =
317 wrap_snapshot.to_point(WrapPoint::new(new_start.0, 0), Bias::Left);
318 let start_bound = Bound::Included(new_buffer_start);
319 let start_block_ix = match self.blocks[last_block_ix..].binary_search_by(|probe| {
320 probe
321 .position
322 .to_point(buffer)
323 .cmp(&new_buffer_start)
324 .then(Ordering::Greater)
325 }) {
326 Ok(ix) | Err(ix) => last_block_ix + ix,
327 };
328
329 let end_bound;
330 let end_block_ix = if new_end.0 > wrap_snapshot.max_point().row() {
331 end_bound = Bound::Unbounded;
332 self.blocks.len()
333 } else {
334 let new_buffer_end =
335 wrap_snapshot.to_point(WrapPoint::new(new_end.0, 0), Bias::Left);
336 end_bound = Bound::Excluded(new_buffer_end);
337 match self.blocks[start_block_ix..].binary_search_by(|probe| {
338 probe
339 .position
340 .to_point(buffer)
341 .cmp(&new_buffer_end)
342 .then(Ordering::Greater)
343 }) {
344 Ok(ix) | Err(ix) => start_block_ix + ix,
345 }
346 };
347 last_block_ix = end_block_ix;
348
349 debug_assert!(blocks_in_edit.is_empty());
350 blocks_in_edit.extend(
351 self.blocks[start_block_ix..end_block_ix]
352 .iter()
353 .map(|block| {
354 let mut position = block.position.to_point(buffer);
355 match block.disposition {
356 BlockDisposition::Above => position.column = 0,
357 BlockDisposition::Below => {
358 position.column = buffer.line_len(position.row)
359 }
360 }
361 let position = wrap_snapshot.make_wrap_point(position, Bias::Left);
362 (position.row(), TransformBlock::Custom(block.clone()))
363 }),
364 );
365 blocks_in_edit.extend(
366 buffer
367 .excerpt_boundaries_in_range((start_bound, end_bound))
368 .map(|excerpt_boundary| {
369 (
370 wrap_snapshot
371 .make_wrap_point(Point::new(excerpt_boundary.row, 0), Bias::Left)
372 .row(),
373 TransformBlock::ExcerptHeader {
374 id: excerpt_boundary.id,
375 buffer: excerpt_boundary.buffer,
376 range: excerpt_boundary.range,
377 height: if excerpt_boundary.starts_new_buffer {
378 self.buffer_header_height
379 } else {
380 self.excerpt_header_height
381 },
382 starts_new_buffer: excerpt_boundary.starts_new_buffer,
383 },
384 )
385 }),
386 );
387
388 // Place excerpt headers above custom blocks on the same row.
389 blocks_in_edit.sort_unstable_by(|(row_a, block_a), (row_b, block_b)| {
390 row_a.cmp(row_b).then_with(|| match (block_a, block_b) {
391 (
392 TransformBlock::ExcerptHeader { .. },
393 TransformBlock::ExcerptHeader { .. },
394 ) => Ordering::Equal,
395 (TransformBlock::ExcerptHeader { .. }, _) => Ordering::Less,
396 (_, TransformBlock::ExcerptHeader { .. }) => Ordering::Greater,
397 (TransformBlock::Custom(block_a), TransformBlock::Custom(block_b)) => block_a
398 .disposition
399 .cmp(&block_b.disposition)
400 .then_with(|| block_a.id.cmp(&block_b.id)),
401 })
402 });
403
404 // For each of these blocks, insert a new isomorphic transform preceding the block,
405 // and then insert the block itself.
406 for (block_row, block) in blocks_in_edit.drain(..) {
407 let insertion_row = match block.disposition() {
408 BlockDisposition::Above => block_row,
409 BlockDisposition::Below => block_row + 1,
410 };
411 let extent_before_block = insertion_row - new_transforms.summary().input_rows;
412 push_isomorphic(&mut new_transforms, extent_before_block);
413 new_transforms.push(Transform::block(block), &());
414 }
415
416 old_end = WrapRow(old_end.0.min(old_row_count));
417 new_end = WrapRow(new_end.0.min(new_row_count));
418
419 // Insert an isomorphic transform after the final block.
420 let extent_after_last_block = new_end.0 - new_transforms.summary().input_rows;
421 push_isomorphic(&mut new_transforms, extent_after_last_block);
422
423 // Preserve any portion of the old transform after this edit.
424 let extent_after_edit = cursor.start().0 - old_end.0;
425 push_isomorphic(&mut new_transforms, extent_after_edit);
426 }
427
428 new_transforms.push_tree(cursor.suffix(&()), &());
429 debug_assert_eq!(
430 new_transforms.summary().input_rows,
431 wrap_snapshot.max_point().row() + 1
432 );
433
434 drop(cursor);
435 *transforms = new_transforms;
436 }
437
438 pub fn replace(&mut self, mut renderers: HashMap<BlockId, RenderBlock>) {
439 for block in &self.blocks {
440 if let Some(render) = renderers.remove(&block.id) {
441 *block.render.lock() = render;
442 }
443 }
444 }
445}
446
447fn push_isomorphic(tree: &mut SumTree<Transform>, rows: u32) {
448 if rows == 0 {
449 return;
450 }
451
452 let mut extent = Some(rows);
453 tree.update_last(
454 |last_transform| {
455 if last_transform.is_isomorphic() {
456 let extent = extent.take().unwrap();
457 last_transform.summary.input_rows += extent;
458 last_transform.summary.output_rows += extent;
459 }
460 },
461 &(),
462 );
463 if let Some(extent) = extent {
464 tree.push(Transform::isomorphic(extent), &());
465 }
466}
467
468impl BlockPoint {
469 pub fn new(row: u32, column: u32) -> Self {
470 Self(Point::new(row, column))
471 }
472}
473
474impl Deref for BlockPoint {
475 type Target = Point;
476
477 fn deref(&self) -> &Self::Target {
478 &self.0
479 }
480}
481
482impl std::ops::DerefMut for BlockPoint {
483 fn deref_mut(&mut self) -> &mut Self::Target {
484 &mut self.0
485 }
486}
487
488impl<'a> BlockMapWriter<'a> {
489 pub fn insert(
490 &mut self,
491 blocks: impl IntoIterator<Item = BlockProperties<Anchor>>,
492 ) -> Vec<BlockId> {
493 let mut ids = Vec::new();
494 let mut edits = Patch::default();
495 let wrap_snapshot = &*self.0.wrap_snapshot.borrow();
496 let buffer = wrap_snapshot.buffer_snapshot();
497
498 for block in blocks {
499 let id = BlockId(self.0.next_block_id.fetch_add(1, SeqCst));
500 ids.push(id);
501
502 let position = block.position;
503 let point = position.to_point(buffer);
504 let wrap_row = wrap_snapshot
505 .make_wrap_point(Point::new(point.row, 0), Bias::Left)
506 .row();
507 let start_row = wrap_snapshot.prev_row_boundary(WrapPoint::new(wrap_row, 0));
508 let end_row = wrap_snapshot
509 .next_row_boundary(WrapPoint::new(wrap_row, 0))
510 .unwrap_or(wrap_snapshot.max_point().row() + 1);
511
512 let block_ix = match self
513 .0
514 .blocks
515 .binary_search_by(|probe| probe.position.cmp(&position, buffer))
516 {
517 Ok(ix) | Err(ix) => ix,
518 };
519 self.0.blocks.insert(
520 block_ix,
521 Arc::new(Block {
522 id,
523 position,
524 height: block.height,
525 render: Mutex::new(block.render),
526 disposition: block.disposition,
527 style: block.style,
528 }),
529 );
530
531 edits = edits.compose([Edit {
532 old: start_row..end_row,
533 new: start_row..end_row,
534 }]);
535 }
536
537 self.0.sync(wrap_snapshot, edits);
538 ids
539 }
540
541 pub fn remove(&mut self, block_ids: HashSet<BlockId>) {
542 let wrap_snapshot = &*self.0.wrap_snapshot.borrow();
543 let buffer = wrap_snapshot.buffer_snapshot();
544 let mut edits = Patch::default();
545 let mut last_block_buffer_row = None;
546 self.0.blocks.retain(|block| {
547 if block_ids.contains(&block.id) {
548 let buffer_row = block.position.to_point(buffer).row;
549 if last_block_buffer_row != Some(buffer_row) {
550 last_block_buffer_row = Some(buffer_row);
551 let wrap_row = wrap_snapshot
552 .make_wrap_point(Point::new(buffer_row, 0), Bias::Left)
553 .row();
554 let start_row = wrap_snapshot.prev_row_boundary(WrapPoint::new(wrap_row, 0));
555 let end_row = wrap_snapshot
556 .next_row_boundary(WrapPoint::new(wrap_row, 0))
557 .unwrap_or(wrap_snapshot.max_point().row() + 1);
558 edits.push(Edit {
559 old: start_row..end_row,
560 new: start_row..end_row,
561 })
562 }
563 false
564 } else {
565 true
566 }
567 });
568 self.0.sync(wrap_snapshot, edits);
569 }
570}
571
572impl BlockSnapshot {
573 #[cfg(test)]
574 pub fn text(&self) -> String {
575 self.chunks(0..self.transforms.summary().output_rows, false, None, None)
576 .map(|chunk| chunk.text)
577 .collect()
578 }
579
580 pub fn chunks<'a>(
581 &'a self,
582 rows: Range<u32>,
583 language_aware: bool,
584 text_highlights: Option<&'a TextHighlights>,
585 suggestion_highlight: Option<HighlightStyle>,
586 ) -> BlockChunks<'a> {
587 let max_output_row = cmp::min(rows.end, self.transforms.summary().output_rows);
588 let mut cursor = self.transforms.cursor::<(BlockRow, WrapRow)>();
589 let input_end = {
590 cursor.seek(&BlockRow(rows.end), Bias::Right, &());
591 let overshoot = if cursor
592 .item()
593 .map_or(false, |transform| transform.is_isomorphic())
594 {
595 rows.end - cursor.start().0 .0
596 } else {
597 0
598 };
599 cursor.start().1 .0 + overshoot
600 };
601 let input_start = {
602 cursor.seek(&BlockRow(rows.start), Bias::Right, &());
603 let overshoot = if cursor
604 .item()
605 .map_or(false, |transform| transform.is_isomorphic())
606 {
607 rows.start - cursor.start().0 .0
608 } else {
609 0
610 };
611 cursor.start().1 .0 + overshoot
612 };
613 BlockChunks {
614 input_chunks: self.wrap_snapshot.chunks(
615 input_start..input_end,
616 language_aware,
617 text_highlights,
618 suggestion_highlight,
619 ),
620 input_chunk: Default::default(),
621 transforms: cursor,
622 output_row: rows.start,
623 max_output_row,
624 }
625 }
626
627 pub fn buffer_rows(&self, start_row: u32) -> BlockBufferRows {
628 let mut cursor = self.transforms.cursor::<(BlockRow, WrapRow)>();
629 cursor.seek(&BlockRow(start_row), Bias::Right, &());
630 let (output_start, input_start) = cursor.start();
631 let overshoot = if cursor.item().map_or(false, |t| t.is_isomorphic()) {
632 start_row - output_start.0
633 } else {
634 0
635 };
636 let input_start_row = input_start.0 + overshoot;
637 BlockBufferRows {
638 transforms: cursor,
639 input_buffer_rows: self.wrap_snapshot.buffer_rows(input_start_row),
640 output_row: start_row,
641 started: false,
642 }
643 }
644
645 pub fn blocks_in_range(
646 &self,
647 rows: Range<u32>,
648 ) -> impl Iterator<Item = (u32, &TransformBlock)> {
649 let mut cursor = self.transforms.cursor::<BlockRow>();
650 cursor.seek(&BlockRow(rows.start), Bias::Right, &());
651 std::iter::from_fn(move || {
652 while let Some(transform) = cursor.item() {
653 let start_row = cursor.start().0;
654 if start_row >= rows.end {
655 break;
656 }
657 if let Some(block) = &transform.block {
658 cursor.next(&());
659 return Some((start_row, block));
660 } else {
661 cursor.next(&());
662 }
663 }
664 None
665 })
666 }
667
668 pub fn max_point(&self) -> BlockPoint {
669 let row = self.transforms.summary().output_rows - 1;
670 BlockPoint::new(row, self.line_len(row))
671 }
672
673 pub fn longest_row(&self) -> u32 {
674 let input_row = self.wrap_snapshot.longest_row();
675 self.to_block_point(WrapPoint::new(input_row, 0)).row
676 }
677
678 pub fn line_len(&self, row: u32) -> u32 {
679 let mut cursor = self.transforms.cursor::<(BlockRow, WrapRow)>();
680 cursor.seek(&BlockRow(row), Bias::Right, &());
681 if let Some(transform) = cursor.item() {
682 let (output_start, input_start) = cursor.start();
683 let overshoot = row - output_start.0;
684 if transform.block.is_some() {
685 0
686 } else {
687 self.wrap_snapshot.line_len(input_start.0 + overshoot)
688 }
689 } else {
690 panic!("row out of range");
691 }
692 }
693
694 pub fn is_block_line(&self, row: u32) -> bool {
695 let mut cursor = self.transforms.cursor::<(BlockRow, WrapRow)>();
696 cursor.seek(&BlockRow(row), Bias::Right, &());
697 cursor.item().map_or(false, |t| t.block.is_some())
698 }
699
700 pub fn clip_point(&self, point: BlockPoint, bias: Bias) -> BlockPoint {
701 let mut cursor = self.transforms.cursor::<(BlockRow, WrapRow)>();
702 cursor.seek(&BlockRow(point.row), Bias::Right, &());
703
704 let max_input_row = WrapRow(self.transforms.summary().input_rows);
705 let mut search_left =
706 (bias == Bias::Left && cursor.start().1 .0 > 0) || cursor.end(&()).1 == max_input_row;
707 let mut reversed = false;
708
709 loop {
710 if let Some(transform) = cursor.item() {
711 if transform.is_isomorphic() {
712 let (output_start_row, input_start_row) = cursor.start();
713 let (output_end_row, input_end_row) = cursor.end(&());
714 let output_start = Point::new(output_start_row.0, 0);
715 let input_start = Point::new(input_start_row.0, 0);
716 let input_end = Point::new(input_end_row.0, 0);
717 let input_point = if point.row >= output_end_row.0 {
718 let line_len = self.wrap_snapshot.line_len(input_end_row.0 - 1);
719 self.wrap_snapshot
720 .clip_point(WrapPoint::new(input_end_row.0 - 1, line_len), bias)
721 } else {
722 let output_overshoot = point.0.saturating_sub(output_start);
723 self.wrap_snapshot
724 .clip_point(WrapPoint(input_start + output_overshoot), bias)
725 };
726
727 if (input_start..input_end).contains(&input_point.0) {
728 let input_overshoot = input_point.0.saturating_sub(input_start);
729 return BlockPoint(output_start + input_overshoot);
730 }
731 }
732
733 if search_left {
734 cursor.prev(&());
735 } else {
736 cursor.next(&());
737 }
738 } else if reversed {
739 return self.max_point();
740 } else {
741 reversed = true;
742 search_left = !search_left;
743 cursor.seek(&BlockRow(point.row), Bias::Right, &());
744 }
745 }
746 }
747
748 pub fn to_block_point(&self, wrap_point: WrapPoint) -> BlockPoint {
749 let mut cursor = self.transforms.cursor::<(WrapRow, BlockRow)>();
750 cursor.seek(&WrapRow(wrap_point.row()), Bias::Right, &());
751 if let Some(transform) = cursor.item() {
752 debug_assert!(transform.is_isomorphic());
753 } else {
754 return self.max_point();
755 }
756
757 let (input_start_row, output_start_row) = cursor.start();
758 let input_start = Point::new(input_start_row.0, 0);
759 let output_start = Point::new(output_start_row.0, 0);
760 let input_overshoot = wrap_point.0 - input_start;
761 BlockPoint(output_start + input_overshoot)
762 }
763
764 pub fn to_wrap_point(&self, block_point: BlockPoint) -> WrapPoint {
765 let mut cursor = self.transforms.cursor::<(BlockRow, WrapRow)>();
766 cursor.seek(&BlockRow(block_point.row), Bias::Right, &());
767 if let Some(transform) = cursor.item() {
768 match transform.block.as_ref().map(|b| b.disposition()) {
769 Some(BlockDisposition::Above) => WrapPoint::new(cursor.start().1 .0, 0),
770 Some(BlockDisposition::Below) => {
771 let wrap_row = cursor.start().1 .0 - 1;
772 WrapPoint::new(wrap_row, self.wrap_snapshot.line_len(wrap_row))
773 }
774 None => {
775 let overshoot = block_point.row - cursor.start().0 .0;
776 let wrap_row = cursor.start().1 .0 + overshoot;
777 WrapPoint::new(wrap_row, block_point.column)
778 }
779 }
780 } else {
781 self.wrap_snapshot.max_point()
782 }
783 }
784}
785
786impl Transform {
787 fn isomorphic(rows: u32) -> Self {
788 Self {
789 summary: TransformSummary {
790 input_rows: rows,
791 output_rows: rows,
792 },
793 block: None,
794 }
795 }
796
797 fn block(block: TransformBlock) -> Self {
798 Self {
799 summary: TransformSummary {
800 input_rows: 0,
801 output_rows: block.height() as u32,
802 },
803 block: Some(block),
804 }
805 }
806
807 fn is_isomorphic(&self) -> bool {
808 self.block.is_none()
809 }
810}
811
812impl<'a> Iterator for BlockChunks<'a> {
813 type Item = Chunk<'a>;
814
815 fn next(&mut self) -> Option<Self::Item> {
816 if self.output_row >= self.max_output_row {
817 return None;
818 }
819
820 let transform = self.transforms.item()?;
821 if transform.block.is_some() {
822 let block_start = self.transforms.start().0 .0;
823 let mut block_end = self.transforms.end(&()).0 .0;
824 self.transforms.next(&());
825 if self.transforms.item().is_none() {
826 block_end -= 1;
827 }
828
829 let start_in_block = self.output_row - block_start;
830 let end_in_block = cmp::min(self.max_output_row, block_end) - block_start;
831 let line_count = end_in_block - start_in_block;
832 self.output_row += line_count;
833
834 return Some(Chunk {
835 text: unsafe { std::str::from_utf8_unchecked(&NEWLINES[..line_count as usize]) },
836 syntax_highlight_id: None,
837 highlight_style: None,
838 diagnostic_severity: None,
839 is_unnecessary: false,
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::suggestion_map::SuggestionMap;
995 use crate::display_map::{fold_map::FoldMap, tab_map::TabMap, wrap_map::WrapMap};
996 use crate::multi_buffer::MultiBuffer;
997 use gpui::{elements::Empty, Element};
998 use rand::prelude::*;
999 use settings::Settings;
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 cx.set_global(Settings::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 (fold_map, fold_snapshot) = FoldMap::new(buffer_snapshot.clone());
1036 let (suggestion_map, suggestion_snapshot) = SuggestionMap::new(fold_snapshot);
1037 let (tab_map, tab_snapshot) = TabMap::new(suggestion_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 (tab_snapshot, tab_edits) =
1185 tab_map.sync(suggestion_snapshot, suggestion_edits, 4.try_into().unwrap());
1186 let (wraps_snapshot, wrap_edits) = wrap_map.update(cx, |wrap_map, cx| {
1187 wrap_map.sync(tab_snapshot, tab_edits, cx)
1188 });
1189 let snapshot = block_map.read(wraps_snapshot, wrap_edits);
1190 assert_eq!(snapshot.text(), "aaa\n\nb!!!\n\n\nbb\nccc\nddd\n\n\n");
1191 }
1192
1193 #[gpui::test]
1194 fn test_blocks_on_wrapped_lines(cx: &mut gpui::AppContext) {
1195 cx.set_global(Settings::test(cx));
1196
1197 let family_id = cx
1198 .font_cache()
1199 .load_family(&["Helvetica"], &Default::default())
1200 .unwrap();
1201 let font_id = cx
1202 .font_cache()
1203 .select_font(family_id, &Default::default())
1204 .unwrap();
1205
1206 let text = "one two three\nfour five six\nseven eight";
1207
1208 let buffer = MultiBuffer::build_simple(text, cx);
1209 let buffer_snapshot = buffer.read(cx).snapshot(cx);
1210 let (_, fold_snapshot) = FoldMap::new(buffer_snapshot.clone());
1211 let (_, suggestion_snapshot) = SuggestionMap::new(fold_snapshot);
1212 let (_, tab_snapshot) = TabMap::new(suggestion_snapshot, 1.try_into().unwrap());
1213 let (_, wraps_snapshot) = WrapMap::new(tab_snapshot, font_id, 14.0, Some(60.), cx);
1214 let mut block_map = BlockMap::new(wraps_snapshot.clone(), 1, 1);
1215
1216 let mut writer = block_map.write(wraps_snapshot.clone(), Default::default());
1217 writer.insert(vec![
1218 BlockProperties {
1219 style: BlockStyle::Fixed,
1220 position: buffer_snapshot.anchor_after(Point::new(1, 12)),
1221 disposition: BlockDisposition::Above,
1222 render: Arc::new(|_| Empty::new().into_any_named("block 1")),
1223 height: 1,
1224 },
1225 BlockProperties {
1226 style: BlockStyle::Fixed,
1227 position: buffer_snapshot.anchor_after(Point::new(1, 1)),
1228 disposition: BlockDisposition::Below,
1229 render: Arc::new(|_| Empty::new().into_any_named("block 2")),
1230 height: 1,
1231 },
1232 ]);
1233
1234 // Blocks with an 'above' disposition go above their corresponding buffer line.
1235 // Blocks with a 'below' disposition go below their corresponding buffer line.
1236 let snapshot = block_map.read(wraps_snapshot, Default::default());
1237 assert_eq!(
1238 snapshot.text(),
1239 "one two \nthree\n\nfour five \nsix\n\nseven \neight"
1240 );
1241 }
1242
1243 #[gpui::test(iterations = 100)]
1244 fn test_random_blocks(cx: &mut gpui::AppContext, mut rng: StdRng) {
1245 cx.set_global(Settings::test(cx));
1246
1247 let operations = env::var("OPERATIONS")
1248 .map(|i| i.parse().expect("invalid `OPERATIONS` variable"))
1249 .unwrap_or(10);
1250
1251 let wrap_width = if rng.gen_bool(0.2) {
1252 None
1253 } else {
1254 Some(rng.gen_range(0.0..=100.0))
1255 };
1256 let tab_size = 1.try_into().unwrap();
1257 let family_id = cx
1258 .font_cache()
1259 .load_family(&["Helvetica"], &Default::default())
1260 .unwrap();
1261 let font_id = cx
1262 .font_cache()
1263 .select_font(family_id, &Default::default())
1264 .unwrap();
1265 let font_size = 14.0;
1266 let buffer_start_header_height = rng.gen_range(1..=5);
1267 let excerpt_header_height = rng.gen_range(1..=5);
1268
1269 log::info!("Wrap width: {:?}", wrap_width);
1270 log::info!("Excerpt Header Height: {:?}", excerpt_header_height);
1271
1272 let buffer = if rng.gen() {
1273 let len = rng.gen_range(0..10);
1274 let text = RandomCharIter::new(&mut rng).take(len).collect::<String>();
1275 log::info!("initial buffer text: {:?}", text);
1276 MultiBuffer::build_simple(&text, cx)
1277 } else {
1278 MultiBuffer::build_random(&mut rng, cx)
1279 };
1280
1281 let mut buffer_snapshot = buffer.read(cx).snapshot(cx);
1282 let (fold_map, fold_snapshot) = FoldMap::new(buffer_snapshot.clone());
1283 let (suggestion_map, suggestion_snapshot) = SuggestionMap::new(fold_snapshot);
1284 let (tab_map, tab_snapshot) = TabMap::new(suggestion_snapshot, tab_size);
1285 let (wrap_map, wraps_snapshot) =
1286 WrapMap::new(tab_snapshot, font_id, font_size, wrap_width, cx);
1287 let mut block_map = BlockMap::new(
1288 wraps_snapshot,
1289 buffer_start_header_height,
1290 excerpt_header_height,
1291 );
1292 let mut custom_blocks = Vec::new();
1293
1294 for _ in 0..operations {
1295 let mut buffer_edits = Vec::new();
1296 match rng.gen_range(0..=100) {
1297 0..=19 => {
1298 let wrap_width = if rng.gen_bool(0.2) {
1299 None
1300 } else {
1301 Some(rng.gen_range(0.0..=100.0))
1302 };
1303 log::info!("Setting wrap width to {:?}", wrap_width);
1304 wrap_map.update(cx, |map, cx| map.set_wrap_width(wrap_width, cx));
1305 }
1306 20..=39 => {
1307 let block_count = rng.gen_range(1..=5);
1308 let block_properties = (0..block_count)
1309 .map(|_| {
1310 let buffer = buffer.read(cx).read(cx);
1311 let position = buffer.anchor_after(
1312 buffer.clip_offset(rng.gen_range(0..=buffer.len()), Bias::Left),
1313 );
1314
1315 let disposition = if rng.gen() {
1316 BlockDisposition::Above
1317 } else {
1318 BlockDisposition::Below
1319 };
1320 let height = rng.gen_range(1..5);
1321 log::info!(
1322 "inserting block {:?} {:?} with height {}",
1323 disposition,
1324 position.to_point(&buffer),
1325 height
1326 );
1327 BlockProperties {
1328 style: BlockStyle::Fixed,
1329 position,
1330 height,
1331 disposition,
1332 render: Arc::new(|_| Empty::new().into_any()),
1333 }
1334 })
1335 .collect::<Vec<_>>();
1336
1337 let (fold_snapshot, fold_edits) =
1338 fold_map.read(buffer_snapshot.clone(), vec![]);
1339 let (suggestion_snapshot, suggestion_edits) =
1340 suggestion_map.sync(fold_snapshot, fold_edits);
1341 let (tab_snapshot, tab_edits) =
1342 tab_map.sync(suggestion_snapshot, suggestion_edits, tab_size);
1343 let (wraps_snapshot, wrap_edits) = wrap_map.update(cx, |wrap_map, cx| {
1344 wrap_map.sync(tab_snapshot, tab_edits, cx)
1345 });
1346 let mut block_map = block_map.write(wraps_snapshot, wrap_edits);
1347 let block_ids = block_map.insert(block_properties.clone());
1348 for (block_id, props) in block_ids.into_iter().zip(block_properties) {
1349 custom_blocks.push((block_id, props));
1350 }
1351 }
1352 40..=59 if !custom_blocks.is_empty() => {
1353 let block_count = rng.gen_range(1..=4.min(custom_blocks.len()));
1354 let block_ids_to_remove = (0..block_count)
1355 .map(|_| {
1356 custom_blocks
1357 .remove(rng.gen_range(0..custom_blocks.len()))
1358 .0
1359 })
1360 .collect();
1361
1362 let (fold_snapshot, fold_edits) =
1363 fold_map.read(buffer_snapshot.clone(), vec![]);
1364 let (suggestion_snapshot, suggestion_edits) =
1365 suggestion_map.sync(fold_snapshot, fold_edits);
1366 let (tab_snapshot, tab_edits) =
1367 tab_map.sync(suggestion_snapshot, suggestion_edits, tab_size);
1368 let (wraps_snapshot, wrap_edits) = wrap_map.update(cx, |wrap_map, cx| {
1369 wrap_map.sync(tab_snapshot, tab_edits, cx)
1370 });
1371 let mut block_map = block_map.write(wraps_snapshot, wrap_edits);
1372 block_map.remove(block_ids_to_remove);
1373 }
1374 _ => {
1375 buffer.update(cx, |buffer, cx| {
1376 let mutation_count = rng.gen_range(1..=5);
1377 let subscription = buffer.subscribe();
1378 buffer.randomly_mutate(&mut rng, mutation_count, cx);
1379 buffer_snapshot = buffer.snapshot(cx);
1380 buffer_edits.extend(subscription.consume());
1381 log::info!("buffer text: {:?}", buffer_snapshot.text());
1382 });
1383 }
1384 }
1385
1386 let (fold_snapshot, fold_edits) = fold_map.read(buffer_snapshot.clone(), buffer_edits);
1387 let (suggestion_snapshot, suggestion_edits) =
1388 suggestion_map.sync(fold_snapshot, fold_edits);
1389 let (tab_snapshot, tab_edits) =
1390 tab_map.sync(suggestion_snapshot, suggestion_edits, tab_size);
1391 let (wraps_snapshot, wrap_edits) = wrap_map.update(cx, |wrap_map, cx| {
1392 wrap_map.sync(tab_snapshot, tab_edits, cx)
1393 });
1394 let blocks_snapshot = block_map.read(wraps_snapshot.clone(), wrap_edits);
1395 assert_eq!(
1396 blocks_snapshot.transforms.summary().input_rows,
1397 wraps_snapshot.max_point().row() + 1
1398 );
1399 log::info!("blocks text: {:?}", blocks_snapshot.text());
1400
1401 let mut expected_blocks = Vec::new();
1402 expected_blocks.extend(custom_blocks.iter().map(|(id, block)| {
1403 let mut position = block.position.to_point(&buffer_snapshot);
1404 match block.disposition {
1405 BlockDisposition::Above => {
1406 position.column = 0;
1407 }
1408 BlockDisposition::Below => {
1409 position.column = buffer_snapshot.line_len(position.row);
1410 }
1411 };
1412 let row = wraps_snapshot.make_wrap_point(position, Bias::Left).row();
1413 (
1414 row,
1415 ExpectedBlock::Custom {
1416 disposition: block.disposition,
1417 id: *id,
1418 height: block.height,
1419 },
1420 )
1421 }));
1422 expected_blocks.extend(buffer_snapshot.excerpt_boundaries_in_range(0..).map(
1423 |boundary| {
1424 let position =
1425 wraps_snapshot.make_wrap_point(Point::new(boundary.row, 0), Bias::Left);
1426 (
1427 position.row(),
1428 ExpectedBlock::ExcerptHeader {
1429 height: if boundary.starts_new_buffer {
1430 buffer_start_header_height
1431 } else {
1432 excerpt_header_height
1433 },
1434 starts_new_buffer: boundary.starts_new_buffer,
1435 },
1436 )
1437 },
1438 ));
1439 expected_blocks.sort_unstable();
1440 let mut sorted_blocks_iter = expected_blocks.into_iter().peekable();
1441
1442 let input_buffer_rows = buffer_snapshot.buffer_rows(0).collect::<Vec<_>>();
1443 let mut expected_buffer_rows = Vec::new();
1444 let mut expected_text = String::new();
1445 let mut expected_block_positions = Vec::new();
1446 let input_text = wraps_snapshot.text();
1447 for (row, input_line) in input_text.split('\n').enumerate() {
1448 let row = row as u32;
1449 if row > 0 {
1450 expected_text.push('\n');
1451 }
1452
1453 let buffer_row = input_buffer_rows[wraps_snapshot
1454 .to_point(WrapPoint::new(row, 0), Bias::Left)
1455 .row as usize];
1456
1457 while let Some((block_row, block)) = sorted_blocks_iter.peek() {
1458 if *block_row == row && block.disposition() == BlockDisposition::Above {
1459 let (_, block) = sorted_blocks_iter.next().unwrap();
1460 let height = block.height() as usize;
1461 expected_block_positions
1462 .push((expected_text.matches('\n').count() as u32, block));
1463 let text = "\n".repeat(height);
1464 expected_text.push_str(&text);
1465 for _ in 0..height {
1466 expected_buffer_rows.push(None);
1467 }
1468 } else {
1469 break;
1470 }
1471 }
1472
1473 let soft_wrapped = wraps_snapshot.to_tab_point(WrapPoint::new(row, 0)).column() > 0;
1474 expected_buffer_rows.push(if soft_wrapped { None } else { buffer_row });
1475 expected_text.push_str(input_line);
1476
1477 while let Some((block_row, block)) = sorted_blocks_iter.peek() {
1478 if *block_row == row && block.disposition() == BlockDisposition::Below {
1479 let (_, block) = sorted_blocks_iter.next().unwrap();
1480 let height = block.height() as usize;
1481 expected_block_positions
1482 .push((expected_text.matches('\n').count() as u32 + 1, block));
1483 let text = "\n".repeat(height);
1484 expected_text.push_str(&text);
1485 for _ in 0..height {
1486 expected_buffer_rows.push(None);
1487 }
1488 } else {
1489 break;
1490 }
1491 }
1492 }
1493
1494 let expected_lines = expected_text.split('\n').collect::<Vec<_>>();
1495 let expected_row_count = expected_lines.len();
1496 for start_row in 0..expected_row_count {
1497 let expected_text = expected_lines[start_row..].join("\n");
1498 let actual_text = blocks_snapshot
1499 .chunks(
1500 start_row as u32..blocks_snapshot.max_point().row + 1,
1501 false,
1502 None,
1503 None,
1504 )
1505 .map(|chunk| chunk.text)
1506 .collect::<String>();
1507 assert_eq!(
1508 actual_text, expected_text,
1509 "incorrect text starting from row {}",
1510 start_row
1511 );
1512 assert_eq!(
1513 blocks_snapshot
1514 .buffer_rows(start_row as u32)
1515 .collect::<Vec<_>>(),
1516 &expected_buffer_rows[start_row..]
1517 );
1518 }
1519
1520 assert_eq!(
1521 blocks_snapshot
1522 .blocks_in_range(0..(expected_row_count as u32))
1523 .map(|(row, block)| (row, block.clone().into()))
1524 .collect::<Vec<_>>(),
1525 expected_block_positions
1526 );
1527
1528 let mut expected_longest_rows = Vec::new();
1529 let mut longest_line_len = -1_isize;
1530 for (row, line) in expected_lines.iter().enumerate() {
1531 let row = row as u32;
1532
1533 assert_eq!(
1534 blocks_snapshot.line_len(row),
1535 line.len() as u32,
1536 "invalid line len for row {}",
1537 row
1538 );
1539
1540 let line_char_count = line.chars().count() as isize;
1541 match line_char_count.cmp(&longest_line_len) {
1542 Ordering::Less => {}
1543 Ordering::Equal => expected_longest_rows.push(row),
1544 Ordering::Greater => {
1545 longest_line_len = line_char_count;
1546 expected_longest_rows.clear();
1547 expected_longest_rows.push(row);
1548 }
1549 }
1550 }
1551
1552 let longest_row = blocks_snapshot.longest_row();
1553 assert!(
1554 expected_longest_rows.contains(&longest_row),
1555 "incorrect longest row {}. expected {:?} with length {}",
1556 longest_row,
1557 expected_longest_rows,
1558 longest_line_len,
1559 );
1560
1561 for row in 0..=blocks_snapshot.wrap_snapshot.max_point().row() {
1562 let wrap_point = WrapPoint::new(row, 0);
1563 let block_point = blocks_snapshot.to_block_point(wrap_point);
1564 assert_eq!(blocks_snapshot.to_wrap_point(block_point), wrap_point);
1565 }
1566
1567 let mut block_point = BlockPoint::new(0, 0);
1568 for c in expected_text.chars() {
1569 let left_point = blocks_snapshot.clip_point(block_point, Bias::Left);
1570 let left_buffer_point = blocks_snapshot.to_point(left_point, Bias::Left);
1571 assert_eq!(
1572 blocks_snapshot.to_block_point(blocks_snapshot.to_wrap_point(left_point)),
1573 left_point
1574 );
1575 assert_eq!(
1576 left_buffer_point,
1577 buffer_snapshot.clip_point(left_buffer_point, Bias::Right),
1578 "{:?} is not valid in buffer coordinates",
1579 left_point
1580 );
1581
1582 let right_point = blocks_snapshot.clip_point(block_point, Bias::Right);
1583 let right_buffer_point = blocks_snapshot.to_point(right_point, Bias::Right);
1584 assert_eq!(
1585 blocks_snapshot.to_block_point(blocks_snapshot.to_wrap_point(right_point)),
1586 right_point
1587 );
1588 assert_eq!(
1589 right_buffer_point,
1590 buffer_snapshot.clip_point(right_buffer_point, Bias::Left),
1591 "{:?} is not valid in buffer coordinates",
1592 right_point
1593 );
1594
1595 if c == '\n' {
1596 block_point.0 += Point::new(1, 0);
1597 } else {
1598 block_point.column += c.len_utf8() as u32;
1599 }
1600 }
1601 }
1602
1603 #[derive(Debug, Eq, PartialEq, Ord, PartialOrd)]
1604 enum ExpectedBlock {
1605 ExcerptHeader {
1606 height: u8,
1607 starts_new_buffer: bool,
1608 },
1609 Custom {
1610 disposition: BlockDisposition,
1611 id: BlockId,
1612 height: u8,
1613 },
1614 }
1615
1616 impl ExpectedBlock {
1617 fn height(&self) -> u8 {
1618 match self {
1619 ExpectedBlock::ExcerptHeader { height, .. } => *height,
1620 ExpectedBlock::Custom { height, .. } => *height,
1621 }
1622 }
1623
1624 fn disposition(&self) -> BlockDisposition {
1625 match self {
1626 ExpectedBlock::ExcerptHeader { .. } => BlockDisposition::Above,
1627 ExpectedBlock::Custom { disposition, .. } => *disposition,
1628 }
1629 }
1630 }
1631
1632 impl From<TransformBlock> for ExpectedBlock {
1633 fn from(block: TransformBlock) -> Self {
1634 match block {
1635 TransformBlock::Custom(block) => ExpectedBlock::Custom {
1636 id: block.id,
1637 disposition: block.disposition,
1638 height: block.height,
1639 },
1640 TransformBlock::ExcerptHeader {
1641 height,
1642 starts_new_buffer,
1643 ..
1644 } => ExpectedBlock::ExcerptHeader {
1645 height,
1646 starts_new_buffer,
1647 },
1648 }
1649 }
1650 }
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}