1mod block_map;
2mod fold_map;
3mod tab_map;
4mod wrap_map;
5
6use crate::{Anchor, MultiBuffer, MultiBufferSnapshot, ToOffset, ToPoint};
7use block_map::{BlockMap, BlockPoint};
8use collections::{HashMap, HashSet};
9use fold_map::FoldMap;
10use gpui::{
11 fonts::{FontId, HighlightStyle},
12 Entity, ModelContext, ModelHandle,
13};
14use language::{Point, Subscription as BufferSubscription};
15use std::{any::TypeId, ops::Range, sync::Arc};
16use sum_tree::{Bias, TreeMap};
17use tab_map::TabMap;
18use wrap_map::WrapMap;
19
20pub use block_map::{
21 BlockBufferRows as DisplayBufferRows, BlockChunks as DisplayChunks, BlockContext,
22 BlockDisposition, BlockId, BlockProperties, RenderBlock, TransformBlock,
23};
24
25pub trait ToDisplayPoint {
26 fn to_display_point(&self, map: &DisplaySnapshot) -> DisplayPoint;
27}
28
29type TextHighlights = TreeMap<Option<TypeId>, Arc<(HighlightStyle, Vec<Range<Anchor>>)>>;
30
31pub struct DisplayMap {
32 buffer: ModelHandle<MultiBuffer>,
33 buffer_subscription: BufferSubscription,
34 fold_map: FoldMap,
35 tab_map: TabMap,
36 wrap_map: ModelHandle<WrapMap>,
37 block_map: BlockMap,
38 text_highlights: TextHighlights,
39}
40
41impl Entity for DisplayMap {
42 type Event = ();
43}
44
45impl DisplayMap {
46 pub fn new(
47 buffer: ModelHandle<MultiBuffer>,
48 tab_size: usize,
49 font_id: FontId,
50 font_size: f32,
51 wrap_width: Option<f32>,
52 buffer_header_height: u8,
53 excerpt_header_height: u8,
54 cx: &mut ModelContext<Self>,
55 ) -> Self {
56 let buffer_subscription = buffer.update(cx, |buffer, _| buffer.subscribe());
57 let (fold_map, snapshot) = FoldMap::new(buffer.read(cx).snapshot(cx));
58 let (tab_map, snapshot) = TabMap::new(snapshot, tab_size);
59 let (wrap_map, snapshot) = WrapMap::new(snapshot, font_id, font_size, wrap_width, cx);
60 let block_map = BlockMap::new(snapshot, buffer_header_height, excerpt_header_height);
61 cx.observe(&wrap_map, |_, _, cx| cx.notify()).detach();
62 DisplayMap {
63 buffer,
64 buffer_subscription,
65 fold_map,
66 tab_map,
67 wrap_map,
68 block_map,
69 text_highlights: Default::default(),
70 }
71 }
72
73 pub fn snapshot(&self, cx: &mut ModelContext<Self>) -> DisplaySnapshot {
74 let buffer_snapshot = self.buffer.read(cx).snapshot(cx);
75 let edits = self.buffer_subscription.consume().into_inner();
76 let (folds_snapshot, edits) = self.fold_map.read(buffer_snapshot, edits);
77 let (tabs_snapshot, edits) = self.tab_map.sync(folds_snapshot.clone(), edits);
78 let (wraps_snapshot, edits) = self
79 .wrap_map
80 .update(cx, |map, cx| map.sync(tabs_snapshot.clone(), edits, cx));
81 let blocks_snapshot = self.block_map.read(wraps_snapshot.clone(), edits);
82
83 DisplaySnapshot {
84 buffer_snapshot: self.buffer.read(cx).snapshot(cx),
85 folds_snapshot,
86 tabs_snapshot,
87 wraps_snapshot,
88 blocks_snapshot,
89 text_highlights: self.text_highlights.clone(),
90 }
91 }
92
93 pub fn fold<T: ToOffset>(
94 &mut self,
95 ranges: impl IntoIterator<Item = Range<T>>,
96 cx: &mut ModelContext<Self>,
97 ) {
98 let snapshot = self.buffer.read(cx).snapshot(cx);
99 let edits = self.buffer_subscription.consume().into_inner();
100 let (mut fold_map, snapshot, edits) = self.fold_map.write(snapshot, edits);
101 let (snapshot, edits) = self.tab_map.sync(snapshot, edits);
102 let (snapshot, edits) = self
103 .wrap_map
104 .update(cx, |map, cx| map.sync(snapshot, edits, cx));
105 self.block_map.read(snapshot, edits);
106 let (snapshot, edits) = fold_map.fold(ranges);
107 let (snapshot, edits) = self.tab_map.sync(snapshot, edits);
108 let (snapshot, edits) = self
109 .wrap_map
110 .update(cx, |map, cx| map.sync(snapshot, edits, cx));
111 self.block_map.read(snapshot, edits);
112 }
113
114 pub fn unfold<T: ToOffset>(
115 &mut self,
116 ranges: impl IntoIterator<Item = Range<T>>,
117 cx: &mut ModelContext<Self>,
118 ) {
119 let snapshot = self.buffer.read(cx).snapshot(cx);
120 let edits = self.buffer_subscription.consume().into_inner();
121 let (mut fold_map, snapshot, edits) = self.fold_map.write(snapshot, edits);
122 let (snapshot, edits) = self.tab_map.sync(snapshot, edits);
123 let (snapshot, edits) = self
124 .wrap_map
125 .update(cx, |map, cx| map.sync(snapshot, edits, cx));
126 self.block_map.read(snapshot, edits);
127 let (snapshot, edits) = fold_map.unfold(ranges);
128 let (snapshot, edits) = self.tab_map.sync(snapshot, edits);
129 let (snapshot, edits) = self
130 .wrap_map
131 .update(cx, |map, cx| map.sync(snapshot, edits, cx));
132 self.block_map.read(snapshot, edits);
133 }
134
135 pub fn insert_blocks(
136 &mut self,
137 blocks: impl IntoIterator<Item = BlockProperties<Anchor>>,
138 cx: &mut ModelContext<Self>,
139 ) -> Vec<BlockId> {
140 let snapshot = self.buffer.read(cx).snapshot(cx);
141 let edits = self.buffer_subscription.consume().into_inner();
142 let (snapshot, edits) = self.fold_map.read(snapshot, edits);
143 let (snapshot, edits) = self.tab_map.sync(snapshot, edits);
144 let (snapshot, edits) = self
145 .wrap_map
146 .update(cx, |map, cx| map.sync(snapshot, edits, cx));
147 let mut block_map = self.block_map.write(snapshot, edits);
148 block_map.insert(blocks)
149 }
150
151 pub fn replace_blocks(&mut self, styles: HashMap<BlockId, RenderBlock>) {
152 self.block_map.replace(styles);
153 }
154
155 pub fn remove_blocks(&mut self, ids: HashSet<BlockId>, cx: &mut ModelContext<Self>) {
156 let snapshot = self.buffer.read(cx).snapshot(cx);
157 let edits = self.buffer_subscription.consume().into_inner();
158 let (snapshot, edits) = self.fold_map.read(snapshot, edits);
159 let (snapshot, edits) = self.tab_map.sync(snapshot, edits);
160 let (snapshot, edits) = self
161 .wrap_map
162 .update(cx, |map, cx| map.sync(snapshot, edits, cx));
163 let mut block_map = self.block_map.write(snapshot, edits);
164 block_map.remove(ids);
165 }
166
167 pub fn highlight_text(
168 &mut self,
169 type_id: TypeId,
170 ranges: Vec<Range<Anchor>>,
171 style: HighlightStyle,
172 ) {
173 self.text_highlights
174 .insert(Some(type_id), Arc::new((style, ranges)));
175 }
176
177 pub fn clear_text_highlights(
178 &mut self,
179 type_id: TypeId,
180 ) -> Option<Arc<(HighlightStyle, Vec<Range<Anchor>>)>> {
181 self.text_highlights.remove(&Some(type_id))
182 }
183
184 pub fn set_font(&self, font_id: FontId, font_size: f32, cx: &mut ModelContext<Self>) {
185 self.wrap_map
186 .update(cx, |map, cx| map.set_font(font_id, font_size, cx));
187 }
188
189 pub fn set_wrap_width(&self, width: Option<f32>, cx: &mut ModelContext<Self>) -> bool {
190 self.wrap_map
191 .update(cx, |map, cx| map.set_wrap_width(width, cx))
192 }
193
194 #[cfg(test)]
195 pub fn is_rewrapping(&self, cx: &gpui::AppContext) -> bool {
196 self.wrap_map.read(cx).is_rewrapping()
197 }
198}
199
200pub struct DisplaySnapshot {
201 pub buffer_snapshot: MultiBufferSnapshot,
202 folds_snapshot: fold_map::FoldSnapshot,
203 tabs_snapshot: tab_map::TabSnapshot,
204 wraps_snapshot: wrap_map::WrapSnapshot,
205 blocks_snapshot: block_map::BlockSnapshot,
206 text_highlights: TextHighlights,
207}
208
209impl DisplaySnapshot {
210 #[cfg(test)]
211 pub fn fold_count(&self) -> usize {
212 self.folds_snapshot.fold_count()
213 }
214
215 pub fn is_empty(&self) -> bool {
216 self.buffer_snapshot.len() == 0
217 }
218
219 pub fn buffer_rows<'a>(&'a self, start_row: u32) -> DisplayBufferRows<'a> {
220 self.blocks_snapshot.buffer_rows(start_row)
221 }
222
223 pub fn max_buffer_row(&self) -> u32 {
224 self.buffer_snapshot.max_buffer_row()
225 }
226
227 pub fn prev_line_boundary(&self, mut point: Point) -> (Point, DisplayPoint) {
228 loop {
229 let mut fold_point = self.folds_snapshot.to_fold_point(point, Bias::Left);
230 *fold_point.column_mut() = 0;
231 point = fold_point.to_buffer_point(&self.folds_snapshot);
232
233 let mut display_point = self.point_to_display_point(point, Bias::Left);
234 *display_point.column_mut() = 0;
235 let next_point = self.display_point_to_point(display_point, Bias::Left);
236 if next_point == point {
237 return (point, display_point);
238 }
239 point = next_point;
240 }
241 }
242
243 pub fn next_line_boundary(&self, mut point: Point) -> (Point, DisplayPoint) {
244 loop {
245 let mut fold_point = self.folds_snapshot.to_fold_point(point, Bias::Right);
246 *fold_point.column_mut() = self.folds_snapshot.line_len(fold_point.row());
247 point = fold_point.to_buffer_point(&self.folds_snapshot);
248
249 let mut display_point = self.point_to_display_point(point, Bias::Right);
250 *display_point.column_mut() = self.line_len(display_point.row());
251 let next_point = self.display_point_to_point(display_point, Bias::Right);
252 if next_point == point {
253 return (point, display_point);
254 }
255 point = next_point;
256 }
257 }
258
259 fn point_to_display_point(&self, point: Point, bias: Bias) -> DisplayPoint {
260 let fold_point = self.folds_snapshot.to_fold_point(point, bias);
261 let tab_point = self.tabs_snapshot.to_tab_point(fold_point);
262 let wrap_point = self.wraps_snapshot.from_tab_point(tab_point);
263 let block_point = self.blocks_snapshot.to_block_point(wrap_point);
264 DisplayPoint(block_point)
265 }
266
267 fn display_point_to_point(&self, point: DisplayPoint, bias: Bias) -> Point {
268 let block_point = point.0;
269 let wrap_point = self.blocks_snapshot.to_wrap_point(block_point);
270 let tab_point = self.wraps_snapshot.to_tab_point(wrap_point);
271 let fold_point = self.tabs_snapshot.to_fold_point(tab_point, bias).0;
272 fold_point.to_buffer_point(&self.folds_snapshot)
273 }
274
275 pub fn max_point(&self) -> DisplayPoint {
276 DisplayPoint(self.blocks_snapshot.max_point())
277 }
278
279 pub fn text_chunks(&self, display_row: u32) -> impl Iterator<Item = &str> {
280 self.blocks_snapshot
281 .chunks(display_row..self.max_point().row() + 1, false, None)
282 .map(|h| h.text)
283 }
284
285 pub fn chunks<'a>(
286 &'a self,
287 display_rows: Range<u32>,
288 language_aware: bool,
289 ) -> DisplayChunks<'a> {
290 self.blocks_snapshot
291 .chunks(display_rows, language_aware, Some(&self.text_highlights))
292 }
293
294 pub fn chars_at<'a>(&'a self, point: DisplayPoint) -> impl Iterator<Item = char> + 'a {
295 let mut column = 0;
296 let mut chars = self.text_chunks(point.row()).flat_map(str::chars);
297 while column < point.column() {
298 if let Some(c) = chars.next() {
299 column += c.len_utf8() as u32;
300 } else {
301 break;
302 }
303 }
304 chars
305 }
306
307 pub fn column_to_chars(&self, display_row: u32, target: u32) -> u32 {
308 let mut count = 0;
309 let mut column = 0;
310 for c in self.chars_at(DisplayPoint::new(display_row, 0)) {
311 if column >= target {
312 break;
313 }
314 count += 1;
315 column += c.len_utf8() as u32;
316 }
317 count
318 }
319
320 pub fn column_from_chars(&self, display_row: u32, char_count: u32) -> u32 {
321 let mut count = 0;
322 let mut column = 0;
323 for c in self.chars_at(DisplayPoint::new(display_row, 0)) {
324 if c == '\n' || count >= char_count {
325 break;
326 }
327 count += 1;
328 column += c.len_utf8() as u32;
329 }
330 column
331 }
332
333 pub fn clip_point(&self, point: DisplayPoint, bias: Bias) -> DisplayPoint {
334 DisplayPoint(self.blocks_snapshot.clip_point(point.0, bias))
335 }
336
337 pub fn folds_in_range<'a, T>(
338 &'a self,
339 range: Range<T>,
340 ) -> impl Iterator<Item = &'a Range<Anchor>>
341 where
342 T: ToOffset,
343 {
344 self.folds_snapshot.folds_in_range(range)
345 }
346
347 pub fn blocks_in_range<'a>(
348 &'a self,
349 rows: Range<u32>,
350 ) -> impl Iterator<Item = (u32, &'a TransformBlock)> {
351 self.blocks_snapshot.blocks_in_range(rows)
352 }
353
354 pub fn intersects_fold<T: ToOffset>(&self, offset: T) -> bool {
355 self.folds_snapshot.intersects_fold(offset)
356 }
357
358 pub fn is_line_folded(&self, display_row: u32) -> bool {
359 let block_point = BlockPoint(Point::new(display_row, 0));
360 let wrap_point = self.blocks_snapshot.to_wrap_point(block_point);
361 let tab_point = self.wraps_snapshot.to_tab_point(wrap_point);
362 self.folds_snapshot.is_line_folded(tab_point.row())
363 }
364
365 pub fn is_block_line(&self, display_row: u32) -> bool {
366 self.blocks_snapshot.is_block_line(display_row)
367 }
368
369 pub fn soft_wrap_indent(&self, display_row: u32) -> Option<u32> {
370 let wrap_row = self
371 .blocks_snapshot
372 .to_wrap_point(BlockPoint::new(display_row, 0))
373 .row();
374 self.wraps_snapshot.soft_wrap_indent(wrap_row)
375 }
376
377 pub fn text(&self) -> String {
378 self.text_chunks(0).collect()
379 }
380
381 pub fn line(&self, display_row: u32) -> String {
382 let mut result = String::new();
383 for chunk in self.text_chunks(display_row) {
384 if let Some(ix) = chunk.find('\n') {
385 result.push_str(&chunk[0..ix]);
386 break;
387 } else {
388 result.push_str(chunk);
389 }
390 }
391 result
392 }
393
394 pub fn line_indent(&self, display_row: u32) -> (u32, bool) {
395 let mut indent = 0;
396 let mut is_blank = true;
397 for c in self.chars_at(DisplayPoint::new(display_row, 0)) {
398 if c == ' ' {
399 indent += 1;
400 } else {
401 is_blank = c == '\n';
402 break;
403 }
404 }
405 (indent, is_blank)
406 }
407
408 pub fn line_len(&self, row: u32) -> u32 {
409 self.blocks_snapshot.line_len(row)
410 }
411
412 pub fn longest_row(&self) -> u32 {
413 self.blocks_snapshot.longest_row()
414 }
415}
416
417#[derive(Copy, Clone, Debug, Default, Eq, Ord, PartialOrd, PartialEq)]
418pub struct DisplayPoint(BlockPoint);
419
420impl DisplayPoint {
421 pub fn new(row: u32, column: u32) -> Self {
422 Self(BlockPoint(Point::new(row, column)))
423 }
424
425 pub fn zero() -> Self {
426 Self::new(0, 0)
427 }
428
429 #[cfg(test)]
430 pub fn is_zero(&self) -> bool {
431 self.0.is_zero()
432 }
433
434 pub fn row(self) -> u32 {
435 self.0.row
436 }
437
438 pub fn column(self) -> u32 {
439 self.0.column
440 }
441
442 pub fn row_mut(&mut self) -> &mut u32 {
443 &mut self.0.row
444 }
445
446 pub fn column_mut(&mut self) -> &mut u32 {
447 &mut self.0.column
448 }
449
450 pub fn to_point(self, map: &DisplaySnapshot) -> Point {
451 map.display_point_to_point(self, Bias::Left)
452 }
453
454 pub fn to_offset(self, map: &DisplaySnapshot, bias: Bias) -> usize {
455 let unblocked_point = map.blocks_snapshot.to_wrap_point(self.0);
456 let unwrapped_point = map.wraps_snapshot.to_tab_point(unblocked_point);
457 let unexpanded_point = map.tabs_snapshot.to_fold_point(unwrapped_point, bias).0;
458 unexpanded_point.to_buffer_offset(&map.folds_snapshot)
459 }
460}
461
462impl ToDisplayPoint for usize {
463 fn to_display_point(&self, map: &DisplaySnapshot) -> DisplayPoint {
464 map.point_to_display_point(self.to_point(&map.buffer_snapshot), Bias::Left)
465 }
466}
467
468impl ToDisplayPoint for Point {
469 fn to_display_point(&self, map: &DisplaySnapshot) -> DisplayPoint {
470 map.point_to_display_point(*self, Bias::Left)
471 }
472}
473
474impl ToDisplayPoint for Anchor {
475 fn to_display_point(&self, map: &DisplaySnapshot) -> DisplayPoint {
476 self.to_point(&map.buffer_snapshot).to_display_point(map)
477 }
478}
479
480#[cfg(test)]
481mod tests {
482 use super::*;
483 use crate::movement;
484 use gpui::{color::Color, elements::*, test::observe, MutableAppContext};
485 use language::{Buffer, Language, LanguageConfig, RandomCharIter, SelectionGoal};
486 use rand::{prelude::*, Rng};
487 use smol::stream::StreamExt;
488 use std::{env, sync::Arc};
489 use theme::SyntaxTheme;
490 use util::test::sample_text;
491 use Bias::*;
492
493 #[gpui::test(iterations = 100)]
494 async fn test_random_display_map(cx: &mut gpui::TestAppContext, mut rng: StdRng) {
495 cx.foreground().set_block_on_ticks(0..=50);
496 cx.foreground().forbid_parking();
497 let operations = env::var("OPERATIONS")
498 .map(|i| i.parse().expect("invalid `OPERATIONS` variable"))
499 .unwrap_or(10);
500
501 let font_cache = cx.font_cache().clone();
502 let tab_size = rng.gen_range(1..=4);
503 let buffer_start_excerpt_header_height = rng.gen_range(1..=5);
504 let excerpt_header_height = rng.gen_range(1..=5);
505 let family_id = font_cache.load_family(&["Helvetica"]).unwrap();
506 let font_id = font_cache
507 .select_font(family_id, &Default::default())
508 .unwrap();
509 let font_size = 14.0;
510 let max_wrap_width = 300.0;
511 let mut wrap_width = if rng.gen_bool(0.1) {
512 None
513 } else {
514 Some(rng.gen_range(0.0..=max_wrap_width))
515 };
516
517 log::info!("tab size: {}", tab_size);
518 log::info!("wrap width: {:?}", wrap_width);
519
520 let buffer = cx.update(|cx| {
521 if rng.gen() {
522 let len = rng.gen_range(0..10);
523 let text = RandomCharIter::new(&mut rng).take(len).collect::<String>();
524 MultiBuffer::build_simple(&text, cx)
525 } else {
526 MultiBuffer::build_random(&mut rng, cx)
527 }
528 });
529
530 let map = cx.add_model(|cx| {
531 DisplayMap::new(
532 buffer.clone(),
533 tab_size,
534 font_id,
535 font_size,
536 wrap_width,
537 buffer_start_excerpt_header_height,
538 excerpt_header_height,
539 cx,
540 )
541 });
542 let mut notifications = observe(&map, cx);
543 let mut fold_count = 0;
544 let mut blocks = Vec::new();
545
546 let snapshot = map.update(cx, |map, cx| map.snapshot(cx));
547 log::info!("buffer text: {:?}", snapshot.buffer_snapshot.text());
548 log::info!("fold text: {:?}", snapshot.folds_snapshot.text());
549 log::info!("tab text: {:?}", snapshot.tabs_snapshot.text());
550 log::info!("wrap text: {:?}", snapshot.wraps_snapshot.text());
551 log::info!("block text: {:?}", snapshot.blocks_snapshot.text());
552 log::info!("display text: {:?}", snapshot.text());
553
554 for _i in 0..operations {
555 match rng.gen_range(0..100) {
556 0..=19 => {
557 wrap_width = if rng.gen_bool(0.2) {
558 None
559 } else {
560 Some(rng.gen_range(0.0..=max_wrap_width))
561 };
562 log::info!("setting wrap width to {:?}", wrap_width);
563 map.update(cx, |map, cx| map.set_wrap_width(wrap_width, cx));
564 }
565 20..=44 => {
566 map.update(cx, |map, cx| {
567 if rng.gen() || blocks.is_empty() {
568 let buffer = map.snapshot(cx).buffer_snapshot;
569 let block_properties = (0..rng.gen_range(1..=1))
570 .map(|_| {
571 let position =
572 buffer.anchor_after(buffer.clip_offset(
573 rng.gen_range(0..=buffer.len()),
574 Bias::Left,
575 ));
576
577 let disposition = if rng.gen() {
578 BlockDisposition::Above
579 } else {
580 BlockDisposition::Below
581 };
582 let height = rng.gen_range(1..5);
583 log::info!(
584 "inserting block {:?} {:?} with height {}",
585 disposition,
586 position.to_point(&buffer),
587 height
588 );
589 BlockProperties {
590 position,
591 height,
592 disposition,
593 render: Arc::new(|_| Empty::new().boxed()),
594 }
595 })
596 .collect::<Vec<_>>();
597 blocks.extend(map.insert_blocks(block_properties, cx));
598 } else {
599 blocks.shuffle(&mut rng);
600 let remove_count = rng.gen_range(1..=4.min(blocks.len()));
601 let block_ids_to_remove = (0..remove_count)
602 .map(|_| blocks.remove(rng.gen_range(0..blocks.len())))
603 .collect();
604 log::info!("removing block ids {:?}", block_ids_to_remove);
605 map.remove_blocks(block_ids_to_remove, cx);
606 }
607 });
608 }
609 45..=79 => {
610 let mut ranges = Vec::new();
611 for _ in 0..rng.gen_range(1..=3) {
612 buffer.read_with(cx, |buffer, cx| {
613 let buffer = buffer.read(cx);
614 let end = buffer.clip_offset(rng.gen_range(0..=buffer.len()), Right);
615 let start = buffer.clip_offset(rng.gen_range(0..=end), Left);
616 ranges.push(start..end);
617 });
618 }
619
620 if rng.gen() && fold_count > 0 {
621 log::info!("unfolding ranges: {:?}", ranges);
622 map.update(cx, |map, cx| {
623 map.unfold(ranges, cx);
624 });
625 } else {
626 log::info!("folding ranges: {:?}", ranges);
627 map.update(cx, |map, cx| {
628 map.fold(ranges, cx);
629 });
630 }
631 }
632 _ => {
633 buffer.update(cx, |buffer, cx| buffer.randomly_edit(&mut rng, 5, cx));
634 }
635 }
636
637 if map.read_with(cx, |map, cx| map.is_rewrapping(cx)) {
638 notifications.next().await.unwrap();
639 }
640
641 let snapshot = map.update(cx, |map, cx| map.snapshot(cx));
642 fold_count = snapshot.fold_count();
643 log::info!("buffer text: {:?}", snapshot.buffer_snapshot.text());
644 log::info!("fold text: {:?}", snapshot.folds_snapshot.text());
645 log::info!("tab text: {:?}", snapshot.tabs_snapshot.text());
646 log::info!("wrap text: {:?}", snapshot.wraps_snapshot.text());
647 log::info!("block text: {:?}", snapshot.blocks_snapshot.text());
648 log::info!("display text: {:?}", snapshot.text());
649
650 // Line boundaries
651 let buffer = &snapshot.buffer_snapshot;
652 for _ in 0..5 {
653 let row = rng.gen_range(0..=buffer.max_point().row);
654 let column = rng.gen_range(0..=buffer.line_len(row));
655 let point = buffer.clip_point(Point::new(row, column), Left);
656
657 let (prev_buffer_bound, prev_display_bound) = snapshot.prev_line_boundary(point);
658 let (next_buffer_bound, next_display_bound) = snapshot.next_line_boundary(point);
659
660 assert!(prev_buffer_bound <= point);
661 assert!(next_buffer_bound >= point);
662 assert_eq!(prev_buffer_bound.column, 0);
663 assert_eq!(prev_display_bound.column(), 0);
664 if next_buffer_bound < buffer.max_point() {
665 assert_eq!(buffer.chars_at(next_buffer_bound).next(), Some('\n'));
666 }
667
668 assert_eq!(
669 prev_display_bound,
670 prev_buffer_bound.to_display_point(&snapshot),
671 "row boundary before {:?}. reported buffer row boundary: {:?}",
672 point,
673 prev_buffer_bound
674 );
675 assert_eq!(
676 next_display_bound,
677 next_buffer_bound.to_display_point(&snapshot),
678 "display row boundary after {:?}. reported buffer row boundary: {:?}",
679 point,
680 next_buffer_bound
681 );
682 assert_eq!(
683 prev_buffer_bound,
684 prev_display_bound.to_point(&snapshot),
685 "row boundary before {:?}. reported display row boundary: {:?}",
686 point,
687 prev_display_bound
688 );
689 assert_eq!(
690 next_buffer_bound,
691 next_display_bound.to_point(&snapshot),
692 "row boundary after {:?}. reported display row boundary: {:?}",
693 point,
694 next_display_bound
695 );
696 }
697
698 // Movement
699 let min_point = snapshot.clip_point(DisplayPoint::new(0, 0), Left);
700 let max_point = snapshot.clip_point(snapshot.max_point(), Right);
701 for _ in 0..5 {
702 let row = rng.gen_range(0..=snapshot.max_point().row());
703 let column = rng.gen_range(0..=snapshot.line_len(row));
704 let point = snapshot.clip_point(DisplayPoint::new(row, column), Left);
705
706 log::info!("Moving from point {:?}", point);
707
708 let moved_right = movement::right(&snapshot, point).unwrap();
709 log::info!("Right {:?}", moved_right);
710 if point < max_point {
711 assert!(moved_right > point);
712 if point.column() == snapshot.line_len(point.row())
713 || snapshot.soft_wrap_indent(point.row()).is_some()
714 && point.column() == snapshot.line_len(point.row()) - 1
715 {
716 assert!(moved_right.row() > point.row());
717 }
718 } else {
719 assert_eq!(moved_right, point);
720 }
721
722 let moved_left = movement::left(&snapshot, point).unwrap();
723 log::info!("Left {:?}", moved_left);
724 if point > min_point {
725 assert!(moved_left < point);
726 if point.column() == 0 {
727 assert!(moved_left.row() < point.row());
728 }
729 } else {
730 assert_eq!(moved_left, point);
731 }
732 }
733 }
734 }
735
736 #[gpui::test(retries = 5)]
737 fn test_soft_wraps(cx: &mut MutableAppContext) {
738 cx.foreground().set_block_on_ticks(usize::MAX..=usize::MAX);
739 cx.foreground().forbid_parking();
740
741 let font_cache = cx.font_cache();
742
743 let tab_size = 4;
744 let family_id = font_cache.load_family(&["Helvetica"]).unwrap();
745 let font_id = font_cache
746 .select_font(family_id, &Default::default())
747 .unwrap();
748 let font_size = 12.0;
749 let wrap_width = Some(64.);
750
751 let text = "one two three four five\nsix seven eight";
752 let buffer = MultiBuffer::build_simple(text, cx);
753 let map = cx.add_model(|cx| {
754 DisplayMap::new(
755 buffer.clone(),
756 tab_size,
757 font_id,
758 font_size,
759 wrap_width,
760 1,
761 1,
762 cx,
763 )
764 });
765
766 let snapshot = map.update(cx, |map, cx| map.snapshot(cx));
767 assert_eq!(
768 snapshot.text_chunks(0).collect::<String>(),
769 "one two \nthree four \nfive\nsix seven \neight"
770 );
771 assert_eq!(
772 snapshot.clip_point(DisplayPoint::new(0, 8), Bias::Left),
773 DisplayPoint::new(0, 7)
774 );
775 assert_eq!(
776 snapshot.clip_point(DisplayPoint::new(0, 8), Bias::Right),
777 DisplayPoint::new(1, 0)
778 );
779 assert_eq!(
780 movement::right(&snapshot, DisplayPoint::new(0, 7)).unwrap(),
781 DisplayPoint::new(1, 0)
782 );
783 assert_eq!(
784 movement::left(&snapshot, DisplayPoint::new(1, 0)).unwrap(),
785 DisplayPoint::new(0, 7)
786 );
787 assert_eq!(
788 movement::up(&snapshot, DisplayPoint::new(1, 10), SelectionGoal::None).unwrap(),
789 (DisplayPoint::new(0, 7), SelectionGoal::Column(10))
790 );
791 assert_eq!(
792 movement::down(
793 &snapshot,
794 DisplayPoint::new(0, 7),
795 SelectionGoal::Column(10)
796 )
797 .unwrap(),
798 (DisplayPoint::new(1, 10), SelectionGoal::Column(10))
799 );
800 assert_eq!(
801 movement::down(
802 &snapshot,
803 DisplayPoint::new(1, 10),
804 SelectionGoal::Column(10)
805 )
806 .unwrap(),
807 (DisplayPoint::new(2, 4), SelectionGoal::Column(10))
808 );
809
810 let ix = snapshot.buffer_snapshot.text().find("seven").unwrap();
811 buffer.update(cx, |buffer, cx| {
812 buffer.edit(vec![ix..ix], "and ", cx);
813 });
814
815 let snapshot = map.update(cx, |map, cx| map.snapshot(cx));
816 assert_eq!(
817 snapshot.text_chunks(1).collect::<String>(),
818 "three four \nfive\nsix and \nseven eight"
819 );
820
821 // Re-wrap on font size changes
822 map.update(cx, |map, cx| map.set_font(font_id, font_size + 3., cx));
823
824 let snapshot = map.update(cx, |map, cx| map.snapshot(cx));
825 assert_eq!(
826 snapshot.text_chunks(1).collect::<String>(),
827 "three \nfour five\nsix and \nseven \neight"
828 )
829 }
830
831 #[gpui::test]
832 fn test_text_chunks(cx: &mut gpui::MutableAppContext) {
833 let text = sample_text(6, 6, 'a');
834 let buffer = MultiBuffer::build_simple(&text, cx);
835 let tab_size = 4;
836 let family_id = cx.font_cache().load_family(&["Helvetica"]).unwrap();
837 let font_id = cx
838 .font_cache()
839 .select_font(family_id, &Default::default())
840 .unwrap();
841 let font_size = 14.0;
842 let map = cx.add_model(|cx| {
843 DisplayMap::new(buffer.clone(), tab_size, font_id, font_size, None, 1, 1, cx)
844 });
845 buffer.update(cx, |buffer, cx| {
846 buffer.edit(
847 vec![
848 Point::new(1, 0)..Point::new(1, 0),
849 Point::new(1, 1)..Point::new(1, 1),
850 Point::new(2, 1)..Point::new(2, 1),
851 ],
852 "\t",
853 cx,
854 )
855 });
856
857 assert_eq!(
858 map.update(cx, |map, cx| map.snapshot(cx))
859 .text_chunks(1)
860 .collect::<String>()
861 .lines()
862 .next(),
863 Some(" b bbbbb")
864 );
865 assert_eq!(
866 map.update(cx, |map, cx| map.snapshot(cx))
867 .text_chunks(2)
868 .collect::<String>()
869 .lines()
870 .next(),
871 Some("c ccccc")
872 );
873 }
874
875 #[gpui::test]
876 async fn test_chunks(cx: &mut gpui::TestAppContext) {
877 use unindent::Unindent as _;
878
879 let text = r#"
880 fn outer() {}
881
882 mod module {
883 fn inner() {}
884 }"#
885 .unindent();
886
887 let theme = SyntaxTheme::new(vec![
888 ("mod.body".to_string(), Color::red().into()),
889 ("fn.name".to_string(), Color::blue().into()),
890 ]);
891 let language = Arc::new(
892 Language::new(
893 LanguageConfig {
894 name: "Test".into(),
895 path_suffixes: vec![".test".to_string()],
896 ..Default::default()
897 },
898 Some(tree_sitter_rust::language()),
899 )
900 .with_highlights_query(
901 r#"
902 (mod_item name: (identifier) body: _ @mod.body)
903 (function_item name: (identifier) @fn.name)
904 "#,
905 )
906 .unwrap(),
907 );
908 language.set_theme(&theme);
909
910 let buffer = cx.add_model(|cx| Buffer::new(0, text, cx).with_language(language, cx));
911 buffer.condition(&cx, |buf, _| !buf.is_parsing()).await;
912 let buffer = cx.add_model(|cx| MultiBuffer::singleton(buffer, cx));
913
914 let tab_size = 2;
915 let font_cache = cx.font_cache();
916 let family_id = font_cache.load_family(&["Helvetica"]).unwrap();
917 let font_id = font_cache
918 .select_font(family_id, &Default::default())
919 .unwrap();
920 let font_size = 14.0;
921
922 let map = cx
923 .add_model(|cx| DisplayMap::new(buffer, tab_size, font_id, font_size, None, 1, 1, cx));
924 assert_eq!(
925 cx.update(|cx| chunks(0..5, &map, &theme, cx)),
926 vec![
927 ("fn ".to_string(), None),
928 ("outer".to_string(), Some(Color::blue())),
929 ("() {}\n\nmod module ".to_string(), None),
930 ("{\n fn ".to_string(), Some(Color::red())),
931 ("inner".to_string(), Some(Color::blue())),
932 ("() {}\n}".to_string(), Some(Color::red())),
933 ]
934 );
935 assert_eq!(
936 cx.update(|cx| chunks(3..5, &map, &theme, cx)),
937 vec![
938 (" fn ".to_string(), Some(Color::red())),
939 ("inner".to_string(), Some(Color::blue())),
940 ("() {}\n}".to_string(), Some(Color::red())),
941 ]
942 );
943
944 map.update(cx, |map, cx| {
945 map.fold(vec![Point::new(0, 6)..Point::new(3, 2)], cx)
946 });
947 assert_eq!(
948 cx.update(|cx| chunks(0..2, &map, &theme, cx)),
949 vec![
950 ("fn ".to_string(), None),
951 ("out".to_string(), Some(Color::blue())),
952 ("…".to_string(), None),
953 (" fn ".to_string(), Some(Color::red())),
954 ("inner".to_string(), Some(Color::blue())),
955 ("() {}\n}".to_string(), Some(Color::red())),
956 ]
957 );
958 }
959
960 #[gpui::test]
961 async fn test_chunks_with_soft_wrapping(cx: &mut gpui::TestAppContext) {
962 use unindent::Unindent as _;
963
964 cx.foreground().set_block_on_ticks(usize::MAX..=usize::MAX);
965
966 let text = r#"
967 fn outer() {}
968
969 mod module {
970 fn inner() {}
971 }"#
972 .unindent();
973
974 let theme = SyntaxTheme::new(vec![
975 ("mod.body".to_string(), Color::red().into()),
976 ("fn.name".to_string(), Color::blue().into()),
977 ]);
978 let language = Arc::new(
979 Language::new(
980 LanguageConfig {
981 name: "Test".into(),
982 path_suffixes: vec![".test".to_string()],
983 ..Default::default()
984 },
985 Some(tree_sitter_rust::language()),
986 )
987 .with_highlights_query(
988 r#"
989 (mod_item name: (identifier) body: _ @mod.body)
990 (function_item name: (identifier) @fn.name)
991 "#,
992 )
993 .unwrap(),
994 );
995 language.set_theme(&theme);
996
997 let buffer = cx.add_model(|cx| Buffer::new(0, text, cx).with_language(language, cx));
998 buffer.condition(&cx, |buf, _| !buf.is_parsing()).await;
999 let buffer = cx.add_model(|cx| MultiBuffer::singleton(buffer, cx));
1000
1001 let font_cache = cx.font_cache();
1002
1003 let tab_size = 4;
1004 let family_id = font_cache.load_family(&["Courier"]).unwrap();
1005 let font_id = font_cache
1006 .select_font(family_id, &Default::default())
1007 .unwrap();
1008 let font_size = 16.0;
1009
1010 let map = cx.add_model(|cx| {
1011 DisplayMap::new(buffer, tab_size, font_id, font_size, Some(40.0), 1, 1, cx)
1012 });
1013 assert_eq!(
1014 cx.update(|cx| chunks(0..5, &map, &theme, cx)),
1015 [
1016 ("fn \n".to_string(), None),
1017 ("oute\nr".to_string(), Some(Color::blue())),
1018 ("() \n{}\n\n".to_string(), None),
1019 ]
1020 );
1021 assert_eq!(
1022 cx.update(|cx| chunks(3..5, &map, &theme, cx)),
1023 [("{}\n\n".to_string(), None)]
1024 );
1025
1026 map.update(cx, |map, cx| {
1027 map.fold(vec![Point::new(0, 6)..Point::new(3, 2)], cx)
1028 });
1029 assert_eq!(
1030 cx.update(|cx| chunks(1..4, &map, &theme, cx)),
1031 [
1032 ("out".to_string(), Some(Color::blue())),
1033 ("…\n".to_string(), None),
1034 (" \nfn ".to_string(), Some(Color::red())),
1035 ("i\n".to_string(), Some(Color::blue()))
1036 ]
1037 );
1038 }
1039
1040 #[gpui::test]
1041 fn test_clip_point(cx: &mut gpui::MutableAppContext) {
1042 use Bias::{Left, Right};
1043
1044 let text = "\n'a', 'α',\t'✋',\t'❎', '🍐'\n";
1045 let display_text = "\n'a', 'α', '✋', '❎', '🍐'\n";
1046 let buffer = MultiBuffer::build_simple(text, cx);
1047
1048 let tab_size = 4;
1049 let font_cache = cx.font_cache();
1050 let family_id = font_cache.load_family(&["Helvetica"]).unwrap();
1051 let font_id = font_cache
1052 .select_font(family_id, &Default::default())
1053 .unwrap();
1054 let font_size = 14.0;
1055 let map = cx.add_model(|cx| {
1056 DisplayMap::new(buffer.clone(), tab_size, font_id, font_size, None, 1, 1, cx)
1057 });
1058 let map = map.update(cx, |map, cx| map.snapshot(cx));
1059
1060 assert_eq!(map.text(), display_text);
1061 for (input_column, bias, output_column) in vec![
1062 ("'a', '".len(), Left, "'a', '".len()),
1063 ("'a', '".len() + 1, Left, "'a', '".len()),
1064 ("'a', '".len() + 1, Right, "'a', 'α".len()),
1065 ("'a', 'α', ".len(), Left, "'a', 'α',".len()),
1066 ("'a', 'α', ".len(), Right, "'a', 'α', ".len()),
1067 ("'a', 'α', '".len() + 1, Left, "'a', 'α', '".len()),
1068 ("'a', 'α', '".len() + 1, Right, "'a', 'α', '✋".len()),
1069 ("'a', 'α', '✋',".len(), Right, "'a', 'α', '✋',".len()),
1070 ("'a', 'α', '✋', ".len(), Left, "'a', 'α', '✋',".len()),
1071 (
1072 "'a', 'α', '✋', ".len(),
1073 Right,
1074 "'a', 'α', '✋', ".len(),
1075 ),
1076 ] {
1077 assert_eq!(
1078 map.clip_point(DisplayPoint::new(1, input_column as u32), bias),
1079 DisplayPoint::new(1, output_column as u32),
1080 "clip_point(({}, {}))",
1081 1,
1082 input_column,
1083 );
1084 }
1085 }
1086
1087 #[gpui::test]
1088 fn test_tabs_with_multibyte_chars(cx: &mut gpui::MutableAppContext) {
1089 let text = "✅\t\tα\nβ\t\n🏀β\t\tγ";
1090 let buffer = MultiBuffer::build_simple(text, cx);
1091 let tab_size = 4;
1092 let font_cache = cx.font_cache();
1093 let family_id = font_cache.load_family(&["Helvetica"]).unwrap();
1094 let font_id = font_cache
1095 .select_font(family_id, &Default::default())
1096 .unwrap();
1097 let font_size = 14.0;
1098
1099 let map = cx.add_model(|cx| {
1100 DisplayMap::new(buffer.clone(), tab_size, font_id, font_size, None, 1, 1, cx)
1101 });
1102 let map = map.update(cx, |map, cx| map.snapshot(cx));
1103 assert_eq!(map.text(), "✅ α\nβ \n🏀β γ");
1104 assert_eq!(
1105 map.text_chunks(0).collect::<String>(),
1106 "✅ α\nβ \n🏀β γ"
1107 );
1108 assert_eq!(map.text_chunks(1).collect::<String>(), "β \n🏀β γ");
1109 assert_eq!(map.text_chunks(2).collect::<String>(), "🏀β γ");
1110
1111 let point = Point::new(0, "✅\t\t".len() as u32);
1112 let display_point = DisplayPoint::new(0, "✅ ".len() as u32);
1113 assert_eq!(point.to_display_point(&map), display_point);
1114 assert_eq!(display_point.to_point(&map), point);
1115
1116 let point = Point::new(1, "β\t".len() as u32);
1117 let display_point = DisplayPoint::new(1, "β ".len() as u32);
1118 assert_eq!(point.to_display_point(&map), display_point);
1119 assert_eq!(display_point.to_point(&map), point,);
1120
1121 let point = Point::new(2, "🏀β\t\t".len() as u32);
1122 let display_point = DisplayPoint::new(2, "🏀β ".len() as u32);
1123 assert_eq!(point.to_display_point(&map), display_point);
1124 assert_eq!(display_point.to_point(&map), point,);
1125
1126 // Display points inside of expanded tabs
1127 assert_eq!(
1128 DisplayPoint::new(0, "✅ ".len() as u32).to_point(&map),
1129 Point::new(0, "✅\t".len() as u32),
1130 );
1131 assert_eq!(
1132 DisplayPoint::new(0, "✅ ".len() as u32).to_point(&map),
1133 Point::new(0, "✅".len() as u32),
1134 );
1135
1136 // Clipping display points inside of multi-byte characters
1137 assert_eq!(
1138 map.clip_point(DisplayPoint::new(0, "✅".len() as u32 - 1), Left),
1139 DisplayPoint::new(0, 0)
1140 );
1141 assert_eq!(
1142 map.clip_point(DisplayPoint::new(0, "✅".len() as u32 - 1), Bias::Right),
1143 DisplayPoint::new(0, "✅".len() as u32)
1144 );
1145 }
1146
1147 #[gpui::test]
1148 fn test_max_point(cx: &mut gpui::MutableAppContext) {
1149 let buffer = MultiBuffer::build_simple("aaa\n\t\tbbb", cx);
1150 let tab_size = 4;
1151 let font_cache = cx.font_cache();
1152 let family_id = font_cache.load_family(&["Helvetica"]).unwrap();
1153 let font_id = font_cache
1154 .select_font(family_id, &Default::default())
1155 .unwrap();
1156 let font_size = 14.0;
1157 let map = cx.add_model(|cx| {
1158 DisplayMap::new(buffer.clone(), tab_size, font_id, font_size, None, 1, 1, cx)
1159 });
1160 assert_eq!(
1161 map.update(cx, |map, cx| map.snapshot(cx)).max_point(),
1162 DisplayPoint::new(1, 11)
1163 )
1164 }
1165
1166 fn chunks<'a>(
1167 rows: Range<u32>,
1168 map: &ModelHandle<DisplayMap>,
1169 theme: &'a SyntaxTheme,
1170 cx: &mut MutableAppContext,
1171 ) -> Vec<(String, Option<Color>)> {
1172 let snapshot = map.update(cx, |map, cx| map.snapshot(cx));
1173 let mut chunks: Vec<(String, Option<Color>)> = Vec::new();
1174 for chunk in snapshot.chunks(rows, true) {
1175 let color = chunk
1176 .syntax_highlight_id
1177 .and_then(|id| id.style(theme)?.color);
1178 if let Some((last_chunk, last_color)) = chunks.last_mut() {
1179 if color == *last_color {
1180 last_chunk.push_str(chunk.text);
1181 } else {
1182 chunks.push((chunk.text.to_string(), color));
1183 }
1184 } else {
1185 chunks.push((chunk.text.to_string(), color));
1186 }
1187 }
1188 chunks
1189 }
1190}