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, fmt::Debug, 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, Default, Eq, Ord, PartialOrd, PartialEq)]
418pub struct DisplayPoint(BlockPoint);
419
420impl Debug for DisplayPoint {
421 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
422 f.write_fmt(format_args!(
423 "DisplayPoint({}, {})",
424 self.row(),
425 self.column()
426 ))
427 }
428}
429
430impl DisplayPoint {
431 pub fn new(row: u32, column: u32) -> Self {
432 Self(BlockPoint(Point::new(row, column)))
433 }
434
435 pub fn zero() -> Self {
436 Self::new(0, 0)
437 }
438
439 pub fn is_zero(&self) -> bool {
440 self.0.is_zero()
441 }
442
443 pub fn row(self) -> u32 {
444 self.0.row
445 }
446
447 pub fn column(self) -> u32 {
448 self.0.column
449 }
450
451 pub fn row_mut(&mut self) -> &mut u32 {
452 &mut self.0.row
453 }
454
455 pub fn column_mut(&mut self) -> &mut u32 {
456 &mut self.0.column
457 }
458
459 pub fn to_point(self, map: &DisplaySnapshot) -> Point {
460 map.display_point_to_point(self, Bias::Left)
461 }
462
463 pub fn to_offset(self, map: &DisplaySnapshot, bias: Bias) -> usize {
464 let unblocked_point = map.blocks_snapshot.to_wrap_point(self.0);
465 let unwrapped_point = map.wraps_snapshot.to_tab_point(unblocked_point);
466 let unexpanded_point = map.tabs_snapshot.to_fold_point(unwrapped_point, bias).0;
467 unexpanded_point.to_buffer_offset(&map.folds_snapshot)
468 }
469}
470
471impl ToDisplayPoint for usize {
472 fn to_display_point(&self, map: &DisplaySnapshot) -> DisplayPoint {
473 map.point_to_display_point(self.to_point(&map.buffer_snapshot), Bias::Left)
474 }
475}
476
477impl ToDisplayPoint for Point {
478 fn to_display_point(&self, map: &DisplaySnapshot) -> DisplayPoint {
479 map.point_to_display_point(*self, Bias::Left)
480 }
481}
482
483impl ToDisplayPoint for Anchor {
484 fn to_display_point(&self, map: &DisplaySnapshot) -> DisplayPoint {
485 self.to_point(&map.buffer_snapshot).to_display_point(map)
486 }
487}
488
489#[cfg(test)]
490mod tests {
491 use super::*;
492 use crate::{
493 movement,
494 test::{marked_text, marked_text_ranges},
495 };
496 use gpui::{color::Color, elements::*, test::observe, MutableAppContext};
497 use language::{Buffer, Language, LanguageConfig, RandomCharIter, SelectionGoal};
498 use rand::{prelude::*, Rng};
499 use smol::stream::StreamExt;
500 use std::{env, sync::Arc};
501 use theme::SyntaxTheme;
502 use unindent::Unindent;
503 use util::test::sample_text;
504 use Bias::*;
505
506 #[gpui::test(iterations = 100)]
507 async fn test_random_display_map(cx: &mut gpui::TestAppContext, mut rng: StdRng) {
508 cx.foreground().set_block_on_ticks(0..=50);
509 cx.foreground().forbid_parking();
510 let operations = env::var("OPERATIONS")
511 .map(|i| i.parse().expect("invalid `OPERATIONS` variable"))
512 .unwrap_or(10);
513
514 let font_cache = cx.font_cache().clone();
515 let tab_size = rng.gen_range(1..=4);
516 let buffer_start_excerpt_header_height = rng.gen_range(1..=5);
517 let excerpt_header_height = rng.gen_range(1..=5);
518 let family_id = font_cache.load_family(&["Helvetica"]).unwrap();
519 let font_id = font_cache
520 .select_font(family_id, &Default::default())
521 .unwrap();
522 let font_size = 14.0;
523 let max_wrap_width = 300.0;
524 let mut wrap_width = if rng.gen_bool(0.1) {
525 None
526 } else {
527 Some(rng.gen_range(0.0..=max_wrap_width))
528 };
529
530 log::info!("tab size: {}", tab_size);
531 log::info!("wrap width: {:?}", wrap_width);
532
533 let buffer = cx.update(|cx| {
534 if rng.gen() {
535 let len = rng.gen_range(0..10);
536 let text = RandomCharIter::new(&mut rng).take(len).collect::<String>();
537 MultiBuffer::build_simple(&text, cx)
538 } else {
539 MultiBuffer::build_random(&mut rng, cx)
540 }
541 });
542
543 let map = cx.add_model(|cx| {
544 DisplayMap::new(
545 buffer.clone(),
546 tab_size,
547 font_id,
548 font_size,
549 wrap_width,
550 buffer_start_excerpt_header_height,
551 excerpt_header_height,
552 cx,
553 )
554 });
555 let mut notifications = observe(&map, cx);
556 let mut fold_count = 0;
557 let mut blocks = Vec::new();
558
559 let snapshot = map.update(cx, |map, cx| map.snapshot(cx));
560 log::info!("buffer text: {:?}", snapshot.buffer_snapshot.text());
561 log::info!("fold text: {:?}", snapshot.folds_snapshot.text());
562 log::info!("tab text: {:?}", snapshot.tabs_snapshot.text());
563 log::info!("wrap text: {:?}", snapshot.wraps_snapshot.text());
564 log::info!("block text: {:?}", snapshot.blocks_snapshot.text());
565 log::info!("display text: {:?}", snapshot.text());
566
567 for _i in 0..operations {
568 match rng.gen_range(0..100) {
569 0..=19 => {
570 wrap_width = if rng.gen_bool(0.2) {
571 None
572 } else {
573 Some(rng.gen_range(0.0..=max_wrap_width))
574 };
575 log::info!("setting wrap width to {:?}", wrap_width);
576 map.update(cx, |map, cx| map.set_wrap_width(wrap_width, cx));
577 }
578 20..=44 => {
579 map.update(cx, |map, cx| {
580 if rng.gen() || blocks.is_empty() {
581 let buffer = map.snapshot(cx).buffer_snapshot;
582 let block_properties = (0..rng.gen_range(1..=1))
583 .map(|_| {
584 let position =
585 buffer.anchor_after(buffer.clip_offset(
586 rng.gen_range(0..=buffer.len()),
587 Bias::Left,
588 ));
589
590 let disposition = if rng.gen() {
591 BlockDisposition::Above
592 } else {
593 BlockDisposition::Below
594 };
595 let height = rng.gen_range(1..5);
596 log::info!(
597 "inserting block {:?} {:?} with height {}",
598 disposition,
599 position.to_point(&buffer),
600 height
601 );
602 BlockProperties {
603 position,
604 height,
605 disposition,
606 render: Arc::new(|_| Empty::new().boxed()),
607 }
608 })
609 .collect::<Vec<_>>();
610 blocks.extend(map.insert_blocks(block_properties, cx));
611 } else {
612 blocks.shuffle(&mut rng);
613 let remove_count = rng.gen_range(1..=4.min(blocks.len()));
614 let block_ids_to_remove = (0..remove_count)
615 .map(|_| blocks.remove(rng.gen_range(0..blocks.len())))
616 .collect();
617 log::info!("removing block ids {:?}", block_ids_to_remove);
618 map.remove_blocks(block_ids_to_remove, cx);
619 }
620 });
621 }
622 45..=79 => {
623 let mut ranges = Vec::new();
624 for _ in 0..rng.gen_range(1..=3) {
625 buffer.read_with(cx, |buffer, cx| {
626 let buffer = buffer.read(cx);
627 let end = buffer.clip_offset(rng.gen_range(0..=buffer.len()), Right);
628 let start = buffer.clip_offset(rng.gen_range(0..=end), Left);
629 ranges.push(start..end);
630 });
631 }
632
633 if rng.gen() && fold_count > 0 {
634 log::info!("unfolding ranges: {:?}", ranges);
635 map.update(cx, |map, cx| {
636 map.unfold(ranges, cx);
637 });
638 } else {
639 log::info!("folding ranges: {:?}", ranges);
640 map.update(cx, |map, cx| {
641 map.fold(ranges, cx);
642 });
643 }
644 }
645 _ => {
646 buffer.update(cx, |buffer, cx| buffer.randomly_edit(&mut rng, 5, cx));
647 }
648 }
649
650 if map.read_with(cx, |map, cx| map.is_rewrapping(cx)) {
651 notifications.next().await.unwrap();
652 }
653
654 let snapshot = map.update(cx, |map, cx| map.snapshot(cx));
655 fold_count = snapshot.fold_count();
656 log::info!("buffer text: {:?}", snapshot.buffer_snapshot.text());
657 log::info!("fold text: {:?}", snapshot.folds_snapshot.text());
658 log::info!("tab text: {:?}", snapshot.tabs_snapshot.text());
659 log::info!("wrap text: {:?}", snapshot.wraps_snapshot.text());
660 log::info!("block text: {:?}", snapshot.blocks_snapshot.text());
661 log::info!("display text: {:?}", snapshot.text());
662
663 // Line boundaries
664 let buffer = &snapshot.buffer_snapshot;
665 for _ in 0..5 {
666 let row = rng.gen_range(0..=buffer.max_point().row);
667 let column = rng.gen_range(0..=buffer.line_len(row));
668 let point = buffer.clip_point(Point::new(row, column), Left);
669
670 let (prev_buffer_bound, prev_display_bound) = snapshot.prev_line_boundary(point);
671 let (next_buffer_bound, next_display_bound) = snapshot.next_line_boundary(point);
672
673 assert!(prev_buffer_bound <= point);
674 assert!(next_buffer_bound >= point);
675 assert_eq!(prev_buffer_bound.column, 0);
676 assert_eq!(prev_display_bound.column(), 0);
677 if next_buffer_bound < buffer.max_point() {
678 assert_eq!(buffer.chars_at(next_buffer_bound).next(), Some('\n'));
679 }
680
681 assert_eq!(
682 prev_display_bound,
683 prev_buffer_bound.to_display_point(&snapshot),
684 "row boundary before {:?}. reported buffer row boundary: {:?}",
685 point,
686 prev_buffer_bound
687 );
688 assert_eq!(
689 next_display_bound,
690 next_buffer_bound.to_display_point(&snapshot),
691 "display row boundary after {:?}. reported buffer row boundary: {:?}",
692 point,
693 next_buffer_bound
694 );
695 assert_eq!(
696 prev_buffer_bound,
697 prev_display_bound.to_point(&snapshot),
698 "row boundary before {:?}. reported display row boundary: {:?}",
699 point,
700 prev_display_bound
701 );
702 assert_eq!(
703 next_buffer_bound,
704 next_display_bound.to_point(&snapshot),
705 "row boundary after {:?}. reported display row boundary: {:?}",
706 point,
707 next_display_bound
708 );
709 }
710
711 // Movement
712 let min_point = snapshot.clip_point(DisplayPoint::new(0, 0), Left);
713 let max_point = snapshot.clip_point(snapshot.max_point(), Right);
714 for _ in 0..5 {
715 let row = rng.gen_range(0..=snapshot.max_point().row());
716 let column = rng.gen_range(0..=snapshot.line_len(row));
717 let point = snapshot.clip_point(DisplayPoint::new(row, column), Left);
718
719 log::info!("Moving from point {:?}", point);
720
721 let moved_right = movement::right(&snapshot, point);
722 log::info!("Right {:?}", moved_right);
723 if point < max_point {
724 assert!(moved_right > point);
725 if point.column() == snapshot.line_len(point.row())
726 || snapshot.soft_wrap_indent(point.row()).is_some()
727 && point.column() == snapshot.line_len(point.row()) - 1
728 {
729 assert!(moved_right.row() > point.row());
730 }
731 } else {
732 assert_eq!(moved_right, point);
733 }
734
735 let moved_left = movement::left(&snapshot, point);
736 log::info!("Left {:?}", moved_left);
737 if point > min_point {
738 assert!(moved_left < point);
739 if point.column() == 0 {
740 assert!(moved_left.row() < point.row());
741 }
742 } else {
743 assert_eq!(moved_left, point);
744 }
745 }
746 }
747 }
748
749 #[gpui::test(retries = 5)]
750 fn test_soft_wraps(cx: &mut MutableAppContext) {
751 cx.foreground().set_block_on_ticks(usize::MAX..=usize::MAX);
752 cx.foreground().forbid_parking();
753
754 let font_cache = cx.font_cache();
755
756 let tab_size = 4;
757 let family_id = font_cache.load_family(&["Helvetica"]).unwrap();
758 let font_id = font_cache
759 .select_font(family_id, &Default::default())
760 .unwrap();
761 let font_size = 12.0;
762 let wrap_width = Some(64.);
763
764 let text = "one two three four five\nsix seven eight";
765 let buffer = MultiBuffer::build_simple(text, cx);
766 let map = cx.add_model(|cx| {
767 DisplayMap::new(
768 buffer.clone(),
769 tab_size,
770 font_id,
771 font_size,
772 wrap_width,
773 1,
774 1,
775 cx,
776 )
777 });
778
779 let snapshot = map.update(cx, |map, cx| map.snapshot(cx));
780 assert_eq!(
781 snapshot.text_chunks(0).collect::<String>(),
782 "one two \nthree four \nfive\nsix seven \neight"
783 );
784 assert_eq!(
785 snapshot.clip_point(DisplayPoint::new(0, 8), Bias::Left),
786 DisplayPoint::new(0, 7)
787 );
788 assert_eq!(
789 snapshot.clip_point(DisplayPoint::new(0, 8), Bias::Right),
790 DisplayPoint::new(1, 0)
791 );
792 assert_eq!(
793 movement::right(&snapshot, DisplayPoint::new(0, 7)),
794 DisplayPoint::new(1, 0)
795 );
796 assert_eq!(
797 movement::left(&snapshot, DisplayPoint::new(1, 0)),
798 DisplayPoint::new(0, 7)
799 );
800 assert_eq!(
801 movement::up(&snapshot, DisplayPoint::new(1, 10), SelectionGoal::None),
802 (DisplayPoint::new(0, 7), SelectionGoal::Column(10))
803 );
804 assert_eq!(
805 movement::down(
806 &snapshot,
807 DisplayPoint::new(0, 7),
808 SelectionGoal::Column(10)
809 ),
810 (DisplayPoint::new(1, 10), SelectionGoal::Column(10))
811 );
812 assert_eq!(
813 movement::down(
814 &snapshot,
815 DisplayPoint::new(1, 10),
816 SelectionGoal::Column(10)
817 ),
818 (DisplayPoint::new(2, 4), SelectionGoal::Column(10))
819 );
820
821 let ix = snapshot.buffer_snapshot.text().find("seven").unwrap();
822 buffer.update(cx, |buffer, cx| {
823 buffer.edit(vec![ix..ix], "and ", cx);
824 });
825
826 let snapshot = map.update(cx, |map, cx| map.snapshot(cx));
827 assert_eq!(
828 snapshot.text_chunks(1).collect::<String>(),
829 "three four \nfive\nsix and \nseven eight"
830 );
831
832 // Re-wrap on font size changes
833 map.update(cx, |map, cx| map.set_font(font_id, font_size + 3., cx));
834
835 let snapshot = map.update(cx, |map, cx| map.snapshot(cx));
836 assert_eq!(
837 snapshot.text_chunks(1).collect::<String>(),
838 "three \nfour five\nsix and \nseven \neight"
839 )
840 }
841
842 #[gpui::test]
843 fn test_text_chunks(cx: &mut gpui::MutableAppContext) {
844 let text = sample_text(6, 6, 'a');
845 let buffer = MultiBuffer::build_simple(&text, cx);
846 let tab_size = 4;
847 let family_id = cx.font_cache().load_family(&["Helvetica"]).unwrap();
848 let font_id = cx
849 .font_cache()
850 .select_font(family_id, &Default::default())
851 .unwrap();
852 let font_size = 14.0;
853 let map = cx.add_model(|cx| {
854 DisplayMap::new(buffer.clone(), tab_size, font_id, font_size, None, 1, 1, cx)
855 });
856 buffer.update(cx, |buffer, cx| {
857 buffer.edit(
858 vec![
859 Point::new(1, 0)..Point::new(1, 0),
860 Point::new(1, 1)..Point::new(1, 1),
861 Point::new(2, 1)..Point::new(2, 1),
862 ],
863 "\t",
864 cx,
865 )
866 });
867
868 assert_eq!(
869 map.update(cx, |map, cx| map.snapshot(cx))
870 .text_chunks(1)
871 .collect::<String>()
872 .lines()
873 .next(),
874 Some(" b bbbbb")
875 );
876 assert_eq!(
877 map.update(cx, |map, cx| map.snapshot(cx))
878 .text_chunks(2)
879 .collect::<String>()
880 .lines()
881 .next(),
882 Some("c ccccc")
883 );
884 }
885
886 #[gpui::test]
887 async fn test_chunks(cx: &mut gpui::TestAppContext) {
888 use unindent::Unindent as _;
889
890 let text = r#"
891 fn outer() {}
892
893 mod module {
894 fn inner() {}
895 }"#
896 .unindent();
897
898 let theme = SyntaxTheme::new(vec![
899 ("mod.body".to_string(), Color::red().into()),
900 ("fn.name".to_string(), Color::blue().into()),
901 ]);
902 let language = Arc::new(
903 Language::new(
904 LanguageConfig {
905 name: "Test".into(),
906 path_suffixes: vec![".test".to_string()],
907 ..Default::default()
908 },
909 Some(tree_sitter_rust::language()),
910 )
911 .with_highlights_query(
912 r#"
913 (mod_item name: (identifier) body: _ @mod.body)
914 (function_item name: (identifier) @fn.name)
915 "#,
916 )
917 .unwrap(),
918 );
919 language.set_theme(&theme);
920
921 let buffer = cx.add_model(|cx| Buffer::new(0, text, cx).with_language(language, cx));
922 buffer.condition(&cx, |buf, _| !buf.is_parsing()).await;
923 let buffer = cx.add_model(|cx| MultiBuffer::singleton(buffer, cx));
924
925 let tab_size = 2;
926 let font_cache = cx.font_cache();
927 let family_id = font_cache.load_family(&["Helvetica"]).unwrap();
928 let font_id = font_cache
929 .select_font(family_id, &Default::default())
930 .unwrap();
931 let font_size = 14.0;
932
933 let map = cx
934 .add_model(|cx| DisplayMap::new(buffer, tab_size, font_id, font_size, None, 1, 1, cx));
935 assert_eq!(
936 cx.update(|cx| syntax_chunks(0..5, &map, &theme, cx)),
937 vec![
938 ("fn ".to_string(), None),
939 ("outer".to_string(), Some(Color::blue())),
940 ("() {}\n\nmod module ".to_string(), None),
941 ("{\n fn ".to_string(), Some(Color::red())),
942 ("inner".to_string(), Some(Color::blue())),
943 ("() {}\n}".to_string(), Some(Color::red())),
944 ]
945 );
946 assert_eq!(
947 cx.update(|cx| syntax_chunks(3..5, &map, &theme, cx)),
948 vec![
949 (" fn ".to_string(), Some(Color::red())),
950 ("inner".to_string(), Some(Color::blue())),
951 ("() {}\n}".to_string(), Some(Color::red())),
952 ]
953 );
954
955 map.update(cx, |map, cx| {
956 map.fold(vec![Point::new(0, 6)..Point::new(3, 2)], cx)
957 });
958 assert_eq!(
959 cx.update(|cx| syntax_chunks(0..2, &map, &theme, cx)),
960 vec![
961 ("fn ".to_string(), None),
962 ("out".to_string(), Some(Color::blue())),
963 ("…".to_string(), None),
964 (" fn ".to_string(), Some(Color::red())),
965 ("inner".to_string(), Some(Color::blue())),
966 ("() {}\n}".to_string(), Some(Color::red())),
967 ]
968 );
969 }
970
971 #[gpui::test]
972 async fn test_chunks_with_soft_wrapping(cx: &mut gpui::TestAppContext) {
973 use unindent::Unindent as _;
974
975 cx.foreground().set_block_on_ticks(usize::MAX..=usize::MAX);
976
977 let text = r#"
978 fn outer() {}
979
980 mod module {
981 fn inner() {}
982 }"#
983 .unindent();
984
985 let theme = SyntaxTheme::new(vec![
986 ("mod.body".to_string(), Color::red().into()),
987 ("fn.name".to_string(), Color::blue().into()),
988 ]);
989 let language = Arc::new(
990 Language::new(
991 LanguageConfig {
992 name: "Test".into(),
993 path_suffixes: vec![".test".to_string()],
994 ..Default::default()
995 },
996 Some(tree_sitter_rust::language()),
997 )
998 .with_highlights_query(
999 r#"
1000 (mod_item name: (identifier) body: _ @mod.body)
1001 (function_item name: (identifier) @fn.name)
1002 "#,
1003 )
1004 .unwrap(),
1005 );
1006 language.set_theme(&theme);
1007
1008 let buffer = cx.add_model(|cx| Buffer::new(0, text, cx).with_language(language, cx));
1009 buffer.condition(&cx, |buf, _| !buf.is_parsing()).await;
1010 let buffer = cx.add_model(|cx| MultiBuffer::singleton(buffer, cx));
1011
1012 let font_cache = cx.font_cache();
1013
1014 let tab_size = 4;
1015 let family_id = font_cache.load_family(&["Courier"]).unwrap();
1016 let font_id = font_cache
1017 .select_font(family_id, &Default::default())
1018 .unwrap();
1019 let font_size = 16.0;
1020
1021 let map = cx.add_model(|cx| {
1022 DisplayMap::new(buffer, tab_size, font_id, font_size, Some(40.0), 1, 1, cx)
1023 });
1024 assert_eq!(
1025 cx.update(|cx| syntax_chunks(0..5, &map, &theme, cx)),
1026 [
1027 ("fn \n".to_string(), None),
1028 ("oute\nr".to_string(), Some(Color::blue())),
1029 ("() \n{}\n\n".to_string(), None),
1030 ]
1031 );
1032 assert_eq!(
1033 cx.update(|cx| syntax_chunks(3..5, &map, &theme, cx)),
1034 [("{}\n\n".to_string(), None)]
1035 );
1036
1037 map.update(cx, |map, cx| {
1038 map.fold(vec![Point::new(0, 6)..Point::new(3, 2)], cx)
1039 });
1040 assert_eq!(
1041 cx.update(|cx| syntax_chunks(1..4, &map, &theme, cx)),
1042 [
1043 ("out".to_string(), Some(Color::blue())),
1044 ("…\n".to_string(), None),
1045 (" \nfn ".to_string(), Some(Color::red())),
1046 ("i\n".to_string(), Some(Color::blue()))
1047 ]
1048 );
1049 }
1050
1051 #[gpui::test]
1052 async fn test_chunks_with_text_highlights(cx: &mut gpui::TestAppContext) {
1053 cx.foreground().set_block_on_ticks(usize::MAX..=usize::MAX);
1054
1055 let theme = SyntaxTheme::new(vec![
1056 ("operator".to_string(), Color::red().into()),
1057 ("string".to_string(), Color::green().into()),
1058 ]);
1059 let language = Arc::new(
1060 Language::new(
1061 LanguageConfig {
1062 name: "Test".into(),
1063 path_suffixes: vec![".test".to_string()],
1064 ..Default::default()
1065 },
1066 Some(tree_sitter_rust::language()),
1067 )
1068 .with_highlights_query(
1069 r#"
1070 ":" @operator
1071 (string_literal) @string
1072 "#,
1073 )
1074 .unwrap(),
1075 );
1076 language.set_theme(&theme);
1077
1078 let (text, highlighted_ranges) = marked_text_ranges(
1079 r#"const{} <a>: B = "c [d]""#,
1080 vec![('{', '}'), ('<', '>'), ('[', ']')],
1081 );
1082
1083 let buffer = cx.add_model(|cx| Buffer::new(0, text, cx).with_language(language, cx));
1084 buffer.condition(&cx, |buf, _| !buf.is_parsing()).await;
1085
1086 let buffer = cx.add_model(|cx| MultiBuffer::singleton(buffer, cx));
1087 let buffer_snapshot = buffer.read_with(cx, |buffer, cx| buffer.snapshot(cx));
1088
1089 let font_cache = cx.font_cache();
1090 let tab_size = 4;
1091 let family_id = font_cache.load_family(&["Courier"]).unwrap();
1092 let font_id = font_cache
1093 .select_font(family_id, &Default::default())
1094 .unwrap();
1095 let font_size = 16.0;
1096 let map = cx
1097 .add_model(|cx| DisplayMap::new(buffer, tab_size, font_id, font_size, None, 1, 1, cx));
1098
1099 enum MyType {}
1100
1101 let style = HighlightStyle {
1102 color: Some(Color::blue()),
1103 ..Default::default()
1104 };
1105
1106 map.update(cx, |map, _cx| {
1107 map.highlight_text(
1108 TypeId::of::<MyType>(),
1109 highlighted_ranges
1110 .into_iter()
1111 .map(|range| {
1112 buffer_snapshot.anchor_before(range.start)
1113 ..buffer_snapshot.anchor_before(range.end)
1114 })
1115 .collect(),
1116 style,
1117 );
1118 });
1119
1120 assert_eq!(
1121 cx.update(|cx| chunks(0..10, &map, &theme, cx)),
1122 [
1123 ("const ".to_string(), None, None),
1124 ("a".to_string(), None, Some(Color::blue())),
1125 (":".to_string(), Some(Color::red()), None),
1126 (" B = ".to_string(), None, None),
1127 ("\"c ".to_string(), Some(Color::green()), None),
1128 ("d".to_string(), Some(Color::green()), Some(Color::blue())),
1129 ("\"".to_string(), Some(Color::green()), None),
1130 ]
1131 );
1132 }
1133
1134 #[gpui::test]
1135 fn test_clip_point(cx: &mut gpui::MutableAppContext) {
1136 use Bias::{Left, Right};
1137
1138 let text = "\n'a', 'α',\t'✋',\t'❎', '🍐'\n";
1139 let display_text = "\n'a', 'α', '✋', '❎', '🍐'\n";
1140 let buffer = MultiBuffer::build_simple(text, cx);
1141
1142 let tab_size = 4;
1143 let font_cache = cx.font_cache();
1144 let family_id = font_cache.load_family(&["Helvetica"]).unwrap();
1145 let font_id = font_cache
1146 .select_font(family_id, &Default::default())
1147 .unwrap();
1148 let font_size = 14.0;
1149 let map = cx.add_model(|cx| {
1150 DisplayMap::new(buffer.clone(), tab_size, font_id, font_size, None, 1, 1, cx)
1151 });
1152 let map = map.update(cx, |map, cx| map.snapshot(cx));
1153
1154 assert_eq!(map.text(), display_text);
1155 for (input_column, bias, output_column) in vec![
1156 ("'a', '".len(), Left, "'a', '".len()),
1157 ("'a', '".len() + 1, Left, "'a', '".len()),
1158 ("'a', '".len() + 1, Right, "'a', 'α".len()),
1159 ("'a', 'α', ".len(), Left, "'a', 'α',".len()),
1160 ("'a', 'α', ".len(), Right, "'a', 'α', ".len()),
1161 ("'a', 'α', '".len() + 1, Left, "'a', 'α', '".len()),
1162 ("'a', 'α', '".len() + 1, Right, "'a', 'α', '✋".len()),
1163 ("'a', 'α', '✋',".len(), Right, "'a', 'α', '✋',".len()),
1164 ("'a', 'α', '✋', ".len(), Left, "'a', 'α', '✋',".len()),
1165 (
1166 "'a', 'α', '✋', ".len(),
1167 Right,
1168 "'a', 'α', '✋', ".len(),
1169 ),
1170 ] {
1171 assert_eq!(
1172 map.clip_point(DisplayPoint::new(1, input_column as u32), bias),
1173 DisplayPoint::new(1, output_column as u32),
1174 "clip_point(({}, {}))",
1175 1,
1176 input_column,
1177 );
1178 }
1179 }
1180
1181 #[gpui::test]
1182 fn test_tabs_with_multibyte_chars(cx: &mut gpui::MutableAppContext) {
1183 let text = "✅\t\tα\nβ\t\n🏀β\t\tγ";
1184 let buffer = MultiBuffer::build_simple(text, cx);
1185 let tab_size = 4;
1186 let font_cache = cx.font_cache();
1187 let family_id = font_cache.load_family(&["Helvetica"]).unwrap();
1188 let font_id = font_cache
1189 .select_font(family_id, &Default::default())
1190 .unwrap();
1191 let font_size = 14.0;
1192
1193 let map = cx.add_model(|cx| {
1194 DisplayMap::new(buffer.clone(), tab_size, font_id, font_size, None, 1, 1, cx)
1195 });
1196 let map = map.update(cx, |map, cx| map.snapshot(cx));
1197 assert_eq!(map.text(), "✅ α\nβ \n🏀β γ");
1198 assert_eq!(
1199 map.text_chunks(0).collect::<String>(),
1200 "✅ α\nβ \n🏀β γ"
1201 );
1202 assert_eq!(map.text_chunks(1).collect::<String>(), "β \n🏀β γ");
1203 assert_eq!(map.text_chunks(2).collect::<String>(), "🏀β γ");
1204
1205 let point = Point::new(0, "✅\t\t".len() as u32);
1206 let display_point = DisplayPoint::new(0, "✅ ".len() as u32);
1207 assert_eq!(point.to_display_point(&map), display_point);
1208 assert_eq!(display_point.to_point(&map), point);
1209
1210 let point = Point::new(1, "β\t".len() as u32);
1211 let display_point = DisplayPoint::new(1, "β ".len() as u32);
1212 assert_eq!(point.to_display_point(&map), display_point);
1213 assert_eq!(display_point.to_point(&map), point,);
1214
1215 let point = Point::new(2, "🏀β\t\t".len() as u32);
1216 let display_point = DisplayPoint::new(2, "🏀β ".len() as u32);
1217 assert_eq!(point.to_display_point(&map), display_point);
1218 assert_eq!(display_point.to_point(&map), point,);
1219
1220 // Display points inside of expanded tabs
1221 assert_eq!(
1222 DisplayPoint::new(0, "✅ ".len() as u32).to_point(&map),
1223 Point::new(0, "✅\t".len() as u32),
1224 );
1225 assert_eq!(
1226 DisplayPoint::new(0, "✅ ".len() as u32).to_point(&map),
1227 Point::new(0, "✅".len() as u32),
1228 );
1229
1230 // Clipping display points inside of multi-byte characters
1231 assert_eq!(
1232 map.clip_point(DisplayPoint::new(0, "✅".len() as u32 - 1), Left),
1233 DisplayPoint::new(0, 0)
1234 );
1235 assert_eq!(
1236 map.clip_point(DisplayPoint::new(0, "✅".len() as u32 - 1), Bias::Right),
1237 DisplayPoint::new(0, "✅".len() as u32)
1238 );
1239 }
1240
1241 #[gpui::test]
1242 fn test_max_point(cx: &mut gpui::MutableAppContext) {
1243 let buffer = MultiBuffer::build_simple("aaa\n\t\tbbb", cx);
1244 let tab_size = 4;
1245 let font_cache = cx.font_cache();
1246 let family_id = font_cache.load_family(&["Helvetica"]).unwrap();
1247 let font_id = font_cache
1248 .select_font(family_id, &Default::default())
1249 .unwrap();
1250 let font_size = 14.0;
1251 let map = cx.add_model(|cx| {
1252 DisplayMap::new(buffer.clone(), tab_size, font_id, font_size, None, 1, 1, cx)
1253 });
1254 assert_eq!(
1255 map.update(cx, |map, cx| map.snapshot(cx)).max_point(),
1256 DisplayPoint::new(1, 11)
1257 )
1258 }
1259
1260 fn syntax_chunks<'a>(
1261 rows: Range<u32>,
1262 map: &ModelHandle<DisplayMap>,
1263 theme: &'a SyntaxTheme,
1264 cx: &mut MutableAppContext,
1265 ) -> Vec<(String, Option<Color>)> {
1266 chunks(rows, map, theme, cx)
1267 .into_iter()
1268 .map(|(text, color, _)| (text, color))
1269 .collect()
1270 }
1271
1272 fn chunks<'a>(
1273 rows: Range<u32>,
1274 map: &ModelHandle<DisplayMap>,
1275 theme: &'a SyntaxTheme,
1276 cx: &mut MutableAppContext,
1277 ) -> Vec<(String, Option<Color>, Option<Color>)> {
1278 let snapshot = map.update(cx, |map, cx| map.snapshot(cx));
1279 let mut chunks: Vec<(String, Option<Color>, Option<Color>)> = Vec::new();
1280 for chunk in snapshot.chunks(rows, true) {
1281 let syntax_color = chunk
1282 .syntax_highlight_id
1283 .and_then(|id| id.style(theme)?.color);
1284 let highlight_color = chunk.highlight_style.and_then(|style| style.color);
1285 if let Some((last_chunk, last_syntax_color, last_highlight_color)) = chunks.last_mut() {
1286 if syntax_color == *last_syntax_color && highlight_color == *last_highlight_color {
1287 last_chunk.push_str(chunk.text);
1288 continue;
1289 }
1290 }
1291 chunks.push((chunk.text.to_string(), syntax_color, highlight_color));
1292 }
1293 chunks
1294 }
1295}