1mod block_map;
2mod fold_map;
3mod inlay_map;
4mod tab_map;
5mod wrap_map;
6
7use crate::{
8 link_go_to_definition::InlayHighlight, Anchor, AnchorRangeExt, EditorStyle, InlayId,
9 MultiBuffer, MultiBufferSnapshot, ToOffset, ToPoint,
10};
11pub use block_map::{BlockMap, BlockPoint};
12use collections::{BTreeMap, HashMap, HashSet};
13use fold_map::FoldMap;
14use gpui::{
15 color::Color,
16 fonts::{FontId, HighlightStyle, Underline},
17 text_layout::{Line, RunStyle},
18 AppContext, Entity, FontCache, ModelContext, ModelHandle, TextLayoutCache,
19};
20use inlay_map::InlayMap;
21use language::{
22 language_settings::language_settings, OffsetUtf16, Point, Subscription as BufferSubscription,
23};
24use lsp::DiagnosticSeverity;
25use std::{any::TypeId, borrow::Cow, fmt::Debug, num::NonZeroU32, ops::Range, sync::Arc};
26use sum_tree::{Bias, TreeMap};
27use tab_map::TabMap;
28use wrap_map::WrapMap;
29
30pub use block_map::{
31 BlockBufferRows as DisplayBufferRows, BlockChunks as DisplayChunks, BlockContext,
32 BlockDisposition, BlockId, BlockProperties, BlockStyle, RenderBlock, TransformBlock,
33};
34
35pub use self::fold_map::FoldPoint;
36pub use self::inlay_map::{Inlay, InlayOffset, InlayPoint};
37
38#[derive(Copy, Clone, Debug, PartialEq, Eq)]
39pub enum FoldStatus {
40 Folded,
41 Foldable,
42}
43
44pub trait ToDisplayPoint {
45 fn to_display_point(&self, map: &DisplaySnapshot) -> DisplayPoint;
46}
47
48type TextHighlights = TreeMap<Option<TypeId>, Arc<(HighlightStyle, Vec<Range<Anchor>>)>>;
49type InlayHighlights = BTreeMap<TypeId, HashMap<InlayId, (HighlightStyle, InlayHighlight)>>;
50
51pub struct DisplayMap {
52 buffer: ModelHandle<MultiBuffer>,
53 buffer_subscription: BufferSubscription,
54 fold_map: FoldMap,
55 inlay_map: InlayMap,
56 tab_map: TabMap,
57 wrap_map: ModelHandle<WrapMap>,
58 block_map: BlockMap,
59 text_highlights: TextHighlights,
60 inlay_highlights: InlayHighlights,
61 pub clip_at_line_ends: bool,
62}
63
64impl Entity for DisplayMap {
65 type Event = ();
66}
67
68impl DisplayMap {
69 pub fn new(
70 buffer: ModelHandle<MultiBuffer>,
71 font_id: FontId,
72 font_size: f32,
73 wrap_width: Option<f32>,
74 buffer_header_height: u8,
75 excerpt_header_height: u8,
76 cx: &mut ModelContext<Self>,
77 ) -> Self {
78 let buffer_subscription = buffer.update(cx, |buffer, _| buffer.subscribe());
79
80 let tab_size = Self::tab_size(&buffer, cx);
81 let (inlay_map, snapshot) = InlayMap::new(buffer.read(cx).snapshot(cx));
82 let (fold_map, snapshot) = FoldMap::new(snapshot);
83 let (tab_map, snapshot) = TabMap::new(snapshot, tab_size);
84 let (wrap_map, snapshot) = WrapMap::new(snapshot, font_id, font_size, wrap_width, cx);
85 let block_map = BlockMap::new(snapshot, buffer_header_height, excerpt_header_height);
86 cx.observe(&wrap_map, |_, _, cx| cx.notify()).detach();
87 DisplayMap {
88 buffer,
89 buffer_subscription,
90 fold_map,
91 inlay_map,
92 tab_map,
93 wrap_map,
94 block_map,
95 text_highlights: Default::default(),
96 inlay_highlights: Default::default(),
97 clip_at_line_ends: false,
98 }
99 }
100
101 pub fn snapshot(&mut self, cx: &mut ModelContext<Self>) -> DisplaySnapshot {
102 let buffer_snapshot = self.buffer.read(cx).snapshot(cx);
103 let edits = self.buffer_subscription.consume().into_inner();
104 let (inlay_snapshot, edits) = self.inlay_map.sync(buffer_snapshot, edits);
105 let (fold_snapshot, edits) = self.fold_map.read(inlay_snapshot.clone(), edits);
106 let tab_size = Self::tab_size(&self.buffer, cx);
107 let (tab_snapshot, edits) = self.tab_map.sync(fold_snapshot.clone(), edits, tab_size);
108 let (wrap_snapshot, edits) = self
109 .wrap_map
110 .update(cx, |map, cx| map.sync(tab_snapshot.clone(), edits, cx));
111 let block_snapshot = self.block_map.read(wrap_snapshot.clone(), edits);
112
113 DisplaySnapshot {
114 buffer_snapshot: self.buffer.read(cx).snapshot(cx),
115 fold_snapshot,
116 inlay_snapshot,
117 tab_snapshot,
118 wrap_snapshot,
119 block_snapshot,
120 text_highlights: self.text_highlights.clone(),
121 inlay_highlights: self.inlay_highlights.clone(),
122 clip_at_line_ends: self.clip_at_line_ends,
123 }
124 }
125
126 pub fn set_state(&mut self, other: &DisplaySnapshot, cx: &mut ModelContext<Self>) {
127 self.fold(
128 other
129 .folds_in_range(0..other.buffer_snapshot.len())
130 .map(|fold| fold.to_offset(&other.buffer_snapshot)),
131 cx,
132 );
133 }
134
135 pub fn fold<T: ToOffset>(
136 &mut self,
137 ranges: impl IntoIterator<Item = Range<T>>,
138 cx: &mut ModelContext<Self>,
139 ) {
140 let snapshot = self.buffer.read(cx).snapshot(cx);
141 let edits = self.buffer_subscription.consume().into_inner();
142 let tab_size = Self::tab_size(&self.buffer, cx);
143 let (snapshot, edits) = self.inlay_map.sync(snapshot, edits);
144 let (mut fold_map, snapshot, edits) = self.fold_map.write(snapshot, edits);
145 let (snapshot, edits) = self.tab_map.sync(snapshot, edits, tab_size);
146 let (snapshot, edits) = self
147 .wrap_map
148 .update(cx, |map, cx| map.sync(snapshot, edits, cx));
149 self.block_map.read(snapshot, edits);
150 let (snapshot, edits) = fold_map.fold(ranges);
151 let (snapshot, edits) = self.tab_map.sync(snapshot, edits, tab_size);
152 let (snapshot, edits) = self
153 .wrap_map
154 .update(cx, |map, cx| map.sync(snapshot, edits, cx));
155 self.block_map.read(snapshot, edits);
156 }
157
158 pub fn unfold<T: ToOffset>(
159 &mut self,
160 ranges: impl IntoIterator<Item = Range<T>>,
161 inclusive: bool,
162 cx: &mut ModelContext<Self>,
163 ) {
164 let snapshot = self.buffer.read(cx).snapshot(cx);
165 let edits = self.buffer_subscription.consume().into_inner();
166 let tab_size = Self::tab_size(&self.buffer, cx);
167 let (snapshot, edits) = self.inlay_map.sync(snapshot, edits);
168 let (mut fold_map, snapshot, edits) = self.fold_map.write(snapshot, edits);
169 let (snapshot, edits) = self.tab_map.sync(snapshot, edits, tab_size);
170 let (snapshot, edits) = self
171 .wrap_map
172 .update(cx, |map, cx| map.sync(snapshot, edits, cx));
173 self.block_map.read(snapshot, edits);
174 let (snapshot, edits) = fold_map.unfold(ranges, inclusive);
175 let (snapshot, edits) = self.tab_map.sync(snapshot, edits, tab_size);
176 let (snapshot, edits) = self
177 .wrap_map
178 .update(cx, |map, cx| map.sync(snapshot, edits, cx));
179 self.block_map.read(snapshot, edits);
180 }
181
182 pub fn insert_blocks(
183 &mut self,
184 blocks: impl IntoIterator<Item = BlockProperties<Anchor>>,
185 cx: &mut ModelContext<Self>,
186 ) -> Vec<BlockId> {
187 let snapshot = self.buffer.read(cx).snapshot(cx);
188 let edits = self.buffer_subscription.consume().into_inner();
189 let tab_size = Self::tab_size(&self.buffer, cx);
190 let (snapshot, edits) = self.inlay_map.sync(snapshot, edits);
191 let (snapshot, edits) = self.fold_map.read(snapshot, edits);
192 let (snapshot, edits) = self.tab_map.sync(snapshot, edits, tab_size);
193 let (snapshot, edits) = self
194 .wrap_map
195 .update(cx, |map, cx| map.sync(snapshot, edits, cx));
196 let mut block_map = self.block_map.write(snapshot, edits);
197 block_map.insert(blocks)
198 }
199
200 pub fn replace_blocks(&mut self, styles: HashMap<BlockId, RenderBlock>) {
201 self.block_map.replace(styles);
202 }
203
204 pub fn remove_blocks(&mut self, ids: HashSet<BlockId>, cx: &mut ModelContext<Self>) {
205 let snapshot = self.buffer.read(cx).snapshot(cx);
206 let edits = self.buffer_subscription.consume().into_inner();
207 let tab_size = Self::tab_size(&self.buffer, cx);
208 let (snapshot, edits) = self.inlay_map.sync(snapshot, edits);
209 let (snapshot, edits) = self.fold_map.read(snapshot, edits);
210 let (snapshot, edits) = self.tab_map.sync(snapshot, edits, tab_size);
211 let (snapshot, edits) = self
212 .wrap_map
213 .update(cx, |map, cx| map.sync(snapshot, edits, cx));
214 let mut block_map = self.block_map.write(snapshot, edits);
215 block_map.remove(ids);
216 }
217
218 pub fn highlight_text(
219 &mut self,
220 type_id: TypeId,
221 ranges: Vec<Range<Anchor>>,
222 style: HighlightStyle,
223 ) {
224 self.text_highlights
225 .insert(Some(type_id), Arc::new((style, ranges)));
226 }
227
228 pub fn highlight_inlays(
229 &mut self,
230 type_id: TypeId,
231 highlights: Vec<InlayHighlight>,
232 style: HighlightStyle,
233 ) {
234 for highlight in highlights {
235 self.inlay_highlights
236 .entry(type_id)
237 .or_default()
238 .insert(highlight.inlay, (style, highlight));
239 }
240 }
241
242 pub fn text_highlights(&self, type_id: TypeId) -> Option<(HighlightStyle, &[Range<Anchor>])> {
243 let highlights = self.text_highlights.get(&Some(type_id))?;
244 Some((highlights.0, &highlights.1))
245 }
246 pub fn clear_highlights(&mut self, type_id: TypeId) -> bool {
247 let mut cleared = self.text_highlights.remove(&Some(type_id)).is_some();
248 cleared |= self.inlay_highlights.remove(&type_id).is_none();
249 cleared
250 }
251
252 pub fn set_font(&self, font_id: FontId, font_size: f32, cx: &mut ModelContext<Self>) -> bool {
253 self.wrap_map
254 .update(cx, |map, cx| map.set_font(font_id, font_size, cx))
255 }
256
257 pub fn set_fold_ellipses_color(&mut self, color: Color) -> bool {
258 self.fold_map.set_ellipses_color(color)
259 }
260
261 pub fn set_wrap_width(&self, width: Option<f32>, cx: &mut ModelContext<Self>) -> bool {
262 self.wrap_map
263 .update(cx, |map, cx| map.set_wrap_width(width, cx))
264 }
265
266 pub fn current_inlays(&self) -> impl Iterator<Item = &Inlay> {
267 self.inlay_map.current_inlays()
268 }
269
270 pub fn splice_inlays(
271 &mut self,
272 to_remove: Vec<InlayId>,
273 to_insert: Vec<Inlay>,
274 cx: &mut ModelContext<Self>,
275 ) {
276 if to_remove.is_empty() && to_insert.is_empty() {
277 return;
278 }
279 let buffer_snapshot = self.buffer.read(cx).snapshot(cx);
280 let edits = self.buffer_subscription.consume().into_inner();
281 let (snapshot, edits) = self.inlay_map.sync(buffer_snapshot, edits);
282 let (snapshot, edits) = self.fold_map.read(snapshot, edits);
283 let tab_size = Self::tab_size(&self.buffer, cx);
284 let (snapshot, edits) = self.tab_map.sync(snapshot, edits, tab_size);
285 let (snapshot, edits) = self
286 .wrap_map
287 .update(cx, |map, cx| map.sync(snapshot, edits, cx));
288 self.block_map.read(snapshot, edits);
289
290 let (snapshot, edits) = self.inlay_map.splice(to_remove, to_insert);
291 let (snapshot, edits) = self.fold_map.read(snapshot, edits);
292 let (snapshot, edits) = self.tab_map.sync(snapshot, edits, tab_size);
293 let (snapshot, edits) = self
294 .wrap_map
295 .update(cx, |map, cx| map.sync(snapshot, edits, cx));
296 self.block_map.read(snapshot, edits);
297 }
298
299 fn tab_size(buffer: &ModelHandle<MultiBuffer>, cx: &mut ModelContext<Self>) -> NonZeroU32 {
300 let language = buffer
301 .read(cx)
302 .as_singleton()
303 .and_then(|buffer| buffer.read(cx).language());
304 language_settings(language.as_deref(), None, cx).tab_size
305 }
306
307 #[cfg(test)]
308 pub fn is_rewrapping(&self, cx: &gpui::AppContext) -> bool {
309 self.wrap_map.read(cx).is_rewrapping()
310 }
311}
312
313#[derive(Debug, Default)]
314pub struct Highlights<'a> {
315 pub text_highlights: Option<&'a TextHighlights>,
316 pub inlay_highlights: Option<&'a InlayHighlights>,
317 pub inlay_highlight_style: Option<HighlightStyle>,
318 pub suggestion_highlight_style: Option<HighlightStyle>,
319}
320
321pub struct HighlightedChunk<'a> {
322 pub chunk: &'a str,
323 pub style: Option<HighlightStyle>,
324 pub is_tab: bool,
325}
326
327pub struct DisplaySnapshot {
328 pub buffer_snapshot: MultiBufferSnapshot,
329 pub fold_snapshot: fold_map::FoldSnapshot,
330 inlay_snapshot: inlay_map::InlaySnapshot,
331 tab_snapshot: tab_map::TabSnapshot,
332 wrap_snapshot: wrap_map::WrapSnapshot,
333 block_snapshot: block_map::BlockSnapshot,
334 text_highlights: TextHighlights,
335 inlay_highlights: InlayHighlights,
336 clip_at_line_ends: bool,
337}
338
339impl DisplaySnapshot {
340 #[cfg(test)]
341 pub fn fold_count(&self) -> usize {
342 self.fold_snapshot.fold_count()
343 }
344
345 pub fn is_empty(&self) -> bool {
346 self.buffer_snapshot.len() == 0
347 }
348
349 pub fn buffer_rows(&self, start_row: u32) -> DisplayBufferRows {
350 self.block_snapshot.buffer_rows(start_row)
351 }
352
353 pub fn max_buffer_row(&self) -> u32 {
354 self.buffer_snapshot.max_buffer_row()
355 }
356
357 pub fn prev_line_boundary(&self, mut point: Point) -> (Point, DisplayPoint) {
358 loop {
359 let mut inlay_point = self.inlay_snapshot.to_inlay_point(point);
360 let mut fold_point = self.fold_snapshot.to_fold_point(inlay_point, Bias::Left);
361 fold_point.0.column = 0;
362 inlay_point = fold_point.to_inlay_point(&self.fold_snapshot);
363 point = self.inlay_snapshot.to_buffer_point(inlay_point);
364
365 let mut display_point = self.point_to_display_point(point, Bias::Left);
366 *display_point.column_mut() = 0;
367 let next_point = self.display_point_to_point(display_point, Bias::Left);
368 if next_point == point {
369 return (point, display_point);
370 }
371 point = next_point;
372 }
373 }
374
375 pub fn next_line_boundary(&self, mut point: Point) -> (Point, DisplayPoint) {
376 loop {
377 let mut inlay_point = self.inlay_snapshot.to_inlay_point(point);
378 let mut fold_point = self.fold_snapshot.to_fold_point(inlay_point, Bias::Right);
379 fold_point.0.column = self.fold_snapshot.line_len(fold_point.row());
380 inlay_point = fold_point.to_inlay_point(&self.fold_snapshot);
381 point = self.inlay_snapshot.to_buffer_point(inlay_point);
382
383 let mut display_point = self.point_to_display_point(point, Bias::Right);
384 *display_point.column_mut() = self.line_len(display_point.row());
385 let next_point = self.display_point_to_point(display_point, Bias::Right);
386 if next_point == point {
387 return (point, display_point);
388 }
389 point = next_point;
390 }
391 }
392
393 // used by line_mode selections and tries to match vim behaviour
394 pub fn expand_to_line(&self, range: Range<Point>) -> Range<Point> {
395 let new_start = if range.start.row == 0 {
396 Point::new(0, 0)
397 } else if range.start.row == self.max_buffer_row()
398 || (range.end.column > 0 && range.end.row == self.max_buffer_row())
399 {
400 Point::new(range.start.row - 1, self.line_len(range.start.row - 1))
401 } else {
402 self.prev_line_boundary(range.start).0
403 };
404
405 let new_end = if range.end.column == 0 {
406 range.end
407 } else if range.end.row < self.max_buffer_row() {
408 self.buffer_snapshot
409 .clip_point(Point::new(range.end.row + 1, 0), Bias::Left)
410 } else {
411 self.buffer_snapshot.max_point()
412 };
413
414 new_start..new_end
415 }
416
417 fn point_to_display_point(&self, point: Point, bias: Bias) -> DisplayPoint {
418 let inlay_point = self.inlay_snapshot.to_inlay_point(point);
419 let fold_point = self.fold_snapshot.to_fold_point(inlay_point, bias);
420 let tab_point = self.tab_snapshot.to_tab_point(fold_point);
421 let wrap_point = self.wrap_snapshot.tab_point_to_wrap_point(tab_point);
422 let block_point = self.block_snapshot.to_block_point(wrap_point);
423 DisplayPoint(block_point)
424 }
425
426 fn display_point_to_point(&self, point: DisplayPoint, bias: Bias) -> Point {
427 self.inlay_snapshot
428 .to_buffer_point(self.display_point_to_inlay_point(point, bias))
429 }
430
431 pub fn display_point_to_inlay_offset(&self, point: DisplayPoint, bias: Bias) -> InlayOffset {
432 self.inlay_snapshot
433 .to_offset(self.display_point_to_inlay_point(point, bias))
434 }
435
436 pub fn anchor_to_inlay_offset(&self, anchor: Anchor) -> InlayOffset {
437 self.inlay_snapshot
438 .to_inlay_offset(anchor.to_offset(&self.buffer_snapshot))
439 }
440
441 fn display_point_to_inlay_point(&self, point: DisplayPoint, bias: Bias) -> InlayPoint {
442 let block_point = point.0;
443 let wrap_point = self.block_snapshot.to_wrap_point(block_point);
444 let tab_point = self.wrap_snapshot.to_tab_point(wrap_point);
445 let fold_point = self.tab_snapshot.to_fold_point(tab_point, bias).0;
446 fold_point.to_inlay_point(&self.fold_snapshot)
447 }
448
449 pub fn display_point_to_fold_point(&self, point: DisplayPoint, bias: Bias) -> FoldPoint {
450 let block_point = point.0;
451 let wrap_point = self.block_snapshot.to_wrap_point(block_point);
452 let tab_point = self.wrap_snapshot.to_tab_point(wrap_point);
453 self.tab_snapshot.to_fold_point(tab_point, bias).0
454 }
455
456 pub fn fold_point_to_display_point(&self, fold_point: FoldPoint) -> DisplayPoint {
457 let tab_point = self.tab_snapshot.to_tab_point(fold_point);
458 let wrap_point = self.wrap_snapshot.tab_point_to_wrap_point(tab_point);
459 let block_point = self.block_snapshot.to_block_point(wrap_point);
460 DisplayPoint(block_point)
461 }
462
463 pub fn max_point(&self) -> DisplayPoint {
464 DisplayPoint(self.block_snapshot.max_point())
465 }
466
467 /// Returns text chunks starting at the given display row until the end of the file
468 pub fn text_chunks(&self, display_row: u32) -> impl Iterator<Item = &str> {
469 self.block_snapshot
470 .chunks(
471 display_row..self.max_point().row() + 1,
472 false,
473 Highlights::default(),
474 )
475 .map(|h| h.text)
476 }
477
478 /// Returns text chunks starting at the end of the given display row in reverse until the start of the file
479 pub fn reverse_text_chunks(&self, display_row: u32) -> impl Iterator<Item = &str> {
480 (0..=display_row).into_iter().rev().flat_map(|row| {
481 self.block_snapshot
482 .chunks(row..row + 1, false, Highlights::default())
483 .map(|h| h.text)
484 .collect::<Vec<_>>()
485 .into_iter()
486 .rev()
487 })
488 }
489
490 pub fn chunks<'a>(
491 &'a self,
492 display_rows: Range<u32>,
493 language_aware: bool,
494 inlay_highlight_style: Option<HighlightStyle>,
495 suggestion_highlight_style: Option<HighlightStyle>,
496 ) -> DisplayChunks<'a> {
497 self.block_snapshot.chunks(
498 display_rows,
499 language_aware,
500 Highlights {
501 text_highlights: Some(&self.text_highlights),
502 inlay_highlights: Some(&self.inlay_highlights),
503 inlay_highlight_style,
504 suggestion_highlight_style,
505 },
506 )
507 }
508
509 pub fn highlighted_chunks<'a>(
510 &'a self,
511 display_rows: Range<u32>,
512 style: &'a EditorStyle,
513 ) -> impl Iterator<Item = HighlightedChunk<'a>> {
514 self.chunks(
515 display_rows,
516 true,
517 Some(style.theme.hint),
518 Some(style.theme.suggestion),
519 )
520 .map(|chunk| {
521 let mut highlight_style = chunk
522 .syntax_highlight_id
523 .and_then(|id| id.style(&style.syntax));
524
525 if let Some(chunk_highlight) = chunk.highlight_style {
526 if let Some(highlight_style) = highlight_style.as_mut() {
527 highlight_style.highlight(chunk_highlight);
528 } else {
529 highlight_style = Some(chunk_highlight);
530 }
531 }
532
533 let mut diagnostic_highlight = HighlightStyle::default();
534
535 if chunk.is_unnecessary {
536 diagnostic_highlight.fade_out = Some(style.unnecessary_code_fade);
537 }
538
539 if let Some(severity) = chunk.diagnostic_severity {
540 // Omit underlines for HINT/INFO diagnostics on 'unnecessary' code.
541 if severity <= DiagnosticSeverity::WARNING || !chunk.is_unnecessary {
542 let diagnostic_style = super::diagnostic_style(severity, true, style);
543 diagnostic_highlight.underline = Some(Underline {
544 color: Some(diagnostic_style.message.text.color),
545 thickness: 1.0.into(),
546 squiggly: true,
547 });
548 }
549 }
550
551 if let Some(highlight_style) = highlight_style.as_mut() {
552 highlight_style.highlight(diagnostic_highlight);
553 } else {
554 highlight_style = Some(diagnostic_highlight);
555 }
556
557 HighlightedChunk {
558 chunk: chunk.text,
559 style: highlight_style,
560 is_tab: chunk.is_tab,
561 }
562 })
563 }
564
565 fn layout_line_for_row(
566 &self,
567 display_row: u32,
568 font_cache: &FontCache,
569 text_layout_cache: &TextLayoutCache,
570 editor_style: &EditorStyle,
571 ) -> Line {
572 let mut styles = Vec::new();
573 let mut line = String::new();
574
575 let range = display_row..display_row + 1;
576 for chunk in self.highlighted_chunks(range, editor_style) {
577 dbg!(chunk.chunk);
578 line.push_str(chunk.chunk);
579
580 let text_style = if let Some(style) = chunk.style {
581 editor_style
582 .text
583 .clone()
584 .highlight(style, font_cache)
585 .map(Cow::Owned)
586 .unwrap_or_else(|_| Cow::Borrowed(&editor_style.text))
587 } else {
588 Cow::Borrowed(&editor_style.text)
589 };
590
591 styles.push((
592 chunk.chunk.len(),
593 RunStyle {
594 font_id: text_style.font_id,
595 color: text_style.color,
596 underline: text_style.underline,
597 },
598 ));
599 }
600
601 dbg!(&line, &editor_style.text.font_size, &styles);
602 text_layout_cache.layout_str(&line, editor_style.text.font_size, &styles)
603 }
604
605 pub fn x_for_point(
606 &self,
607 display_point: DisplayPoint,
608 font_cache: &FontCache,
609 text_layout_cache: &TextLayoutCache,
610 editor_style: &EditorStyle,
611 ) -> f32 {
612 let layout_line = self.layout_line_for_row(
613 display_point.row(),
614 font_cache,
615 text_layout_cache,
616 editor_style,
617 );
618 layout_line.x_for_index(display_point.column() as usize)
619 }
620
621 pub fn column_for_x(
622 &self,
623 display_row: u32,
624 x_coordinate: f32,
625 font_cache: &FontCache,
626 text_layout_cache: &TextLayoutCache,
627 editor_style: &EditorStyle,
628 ) -> Option<u32> {
629 let layout_line =
630 self.layout_line_for_row(display_row, font_cache, text_layout_cache, editor_style);
631 layout_line.index_for_x(x_coordinate).map(|c| c as u32)
632 }
633
634 // column_for_x(row, x)
635
636 fn point(
637 &self,
638 display_point: DisplayPoint,
639 text_layout_cache: &TextLayoutCache,
640 editor_style: &EditorStyle,
641 cx: &AppContext,
642 ) -> f32 {
643 let mut styles = Vec::new();
644 let mut line = String::new();
645
646 let range = display_point.row()..display_point.row() + 1;
647 for chunk in self.highlighted_chunks(range, editor_style) {
648 dbg!(chunk.chunk);
649 line.push_str(chunk.chunk);
650
651 let text_style = if let Some(style) = chunk.style {
652 editor_style
653 .text
654 .clone()
655 .highlight(style, cx.font_cache())
656 .map(Cow::Owned)
657 .unwrap_or_else(|_| Cow::Borrowed(&editor_style.text))
658 } else {
659 Cow::Borrowed(&editor_style.text)
660 };
661
662 styles.push((
663 chunk.chunk.len(),
664 RunStyle {
665 font_id: text_style.font_id,
666 color: text_style.color,
667 underline: text_style.underline,
668 },
669 ));
670 }
671
672 dbg!(&line, &editor_style.text.font_size, &styles);
673 let layout_line = text_layout_cache.layout_str(&line, editor_style.text.font_size, &styles);
674 layout_line.x_for_index(display_point.column() as usize)
675 }
676
677 pub fn chars_at(
678 &self,
679 mut point: DisplayPoint,
680 ) -> impl Iterator<Item = (char, DisplayPoint)> + '_ {
681 point = DisplayPoint(self.block_snapshot.clip_point(point.0, Bias::Left));
682 self.text_chunks(point.row())
683 .flat_map(str::chars)
684 .skip_while({
685 let mut column = 0;
686 move |char| {
687 let at_point = column >= point.column();
688 column += char.len_utf8() as u32;
689 !at_point
690 }
691 })
692 .map(move |ch| {
693 let result = (ch, point);
694 if ch == '\n' {
695 *point.row_mut() += 1;
696 *point.column_mut() = 0;
697 } else {
698 *point.column_mut() += ch.len_utf8() as u32;
699 }
700 result
701 })
702 }
703
704 pub fn reverse_chars_at(
705 &self,
706 mut point: DisplayPoint,
707 ) -> impl Iterator<Item = (char, DisplayPoint)> + '_ {
708 point = DisplayPoint(self.block_snapshot.clip_point(point.0, Bias::Left));
709 self.reverse_text_chunks(point.row())
710 .flat_map(|chunk| chunk.chars().rev())
711 .skip_while({
712 let mut column = self.line_len(point.row());
713 if self.max_point().row() > point.row() {
714 column += 1;
715 }
716
717 move |char| {
718 let at_point = column <= point.column();
719 column = column.saturating_sub(char.len_utf8() as u32);
720 !at_point
721 }
722 })
723 .map(move |ch| {
724 if ch == '\n' {
725 *point.row_mut() -= 1;
726 *point.column_mut() = self.line_len(point.row());
727 } else {
728 *point.column_mut() = point.column().saturating_sub(ch.len_utf8() as u32);
729 }
730 (ch, point)
731 })
732 }
733
734 pub fn column_to_chars(&self, display_row: u32, target: u32) -> u32 {
735 let mut count = 0;
736 let mut column = 0;
737 for (c, _) in self.chars_at(DisplayPoint::new(display_row, 0)) {
738 if column >= target {
739 break;
740 }
741 count += 1;
742 column += c.len_utf8() as u32;
743 }
744 count
745 }
746
747 pub fn column_from_chars(&self, display_row: u32, char_count: u32) -> u32 {
748 let mut column = 0;
749
750 for (count, (c, _)) in self.chars_at(DisplayPoint::new(display_row, 0)).enumerate() {
751 if c == '\n' || count >= char_count as usize {
752 break;
753 }
754 column += c.len_utf8() as u32;
755 }
756
757 column
758 }
759
760 pub fn clip_point(&self, point: DisplayPoint, bias: Bias) -> DisplayPoint {
761 let mut clipped = self.block_snapshot.clip_point(point.0, bias);
762 if self.clip_at_line_ends {
763 clipped = self.clip_at_line_end(DisplayPoint(clipped)).0
764 }
765 DisplayPoint(clipped)
766 }
767
768 pub fn clip_at_line_end(&self, point: DisplayPoint) -> DisplayPoint {
769 let mut point = point.0;
770 if point.column == self.line_len(point.row) {
771 point.column = point.column.saturating_sub(1);
772 point = self.block_snapshot.clip_point(point, Bias::Left);
773 }
774 DisplayPoint(point)
775 }
776
777 pub fn folds_in_range<T>(&self, range: Range<T>) -> impl Iterator<Item = &Range<Anchor>>
778 where
779 T: ToOffset,
780 {
781 self.fold_snapshot.folds_in_range(range)
782 }
783
784 pub fn blocks_in_range(
785 &self,
786 rows: Range<u32>,
787 ) -> impl Iterator<Item = (u32, &TransformBlock)> {
788 self.block_snapshot.blocks_in_range(rows)
789 }
790
791 pub fn intersects_fold<T: ToOffset>(&self, offset: T) -> bool {
792 self.fold_snapshot.intersects_fold(offset)
793 }
794
795 pub fn is_line_folded(&self, buffer_row: u32) -> bool {
796 self.fold_snapshot.is_line_folded(buffer_row)
797 }
798
799 pub fn is_block_line(&self, display_row: u32) -> bool {
800 self.block_snapshot.is_block_line(display_row)
801 }
802
803 pub fn soft_wrap_indent(&self, display_row: u32) -> Option<u32> {
804 let wrap_row = self
805 .block_snapshot
806 .to_wrap_point(BlockPoint::new(display_row, 0))
807 .row();
808 self.wrap_snapshot.soft_wrap_indent(wrap_row)
809 }
810
811 pub fn text(&self) -> String {
812 self.text_chunks(0).collect()
813 }
814
815 pub fn line(&self, display_row: u32) -> String {
816 let mut result = String::new();
817 for chunk in self.text_chunks(display_row) {
818 if let Some(ix) = chunk.find('\n') {
819 result.push_str(&chunk[0..ix]);
820 break;
821 } else {
822 result.push_str(chunk);
823 }
824 }
825 result
826 }
827
828 pub fn line_indent(&self, display_row: u32) -> (u32, bool) {
829 let mut indent = 0;
830 let mut is_blank = true;
831 for (c, _) in self.chars_at(DisplayPoint::new(display_row, 0)) {
832 if c == ' ' {
833 indent += 1;
834 } else {
835 is_blank = c == '\n';
836 break;
837 }
838 }
839 (indent, is_blank)
840 }
841
842 pub fn line_indent_for_buffer_row(&self, buffer_row: u32) -> (u32, bool) {
843 let (buffer, range) = self
844 .buffer_snapshot
845 .buffer_line_for_row(buffer_row)
846 .unwrap();
847
848 let mut indent_size = 0;
849 let mut is_blank = false;
850 for c in buffer.chars_at(Point::new(range.start.row, 0)) {
851 if c == ' ' || c == '\t' {
852 indent_size += 1;
853 } else {
854 if c == '\n' {
855 is_blank = true;
856 }
857 break;
858 }
859 }
860
861 (indent_size, is_blank)
862 }
863
864 pub fn line_len(&self, row: u32) -> u32 {
865 self.block_snapshot.line_len(row)
866 }
867
868 pub fn longest_row(&self) -> u32 {
869 self.block_snapshot.longest_row()
870 }
871
872 pub fn fold_for_line(self: &Self, buffer_row: u32) -> Option<FoldStatus> {
873 if self.is_line_folded(buffer_row) {
874 Some(FoldStatus::Folded)
875 } else if self.is_foldable(buffer_row) {
876 Some(FoldStatus::Foldable)
877 } else {
878 None
879 }
880 }
881
882 pub fn is_foldable(self: &Self, buffer_row: u32) -> bool {
883 let max_row = self.buffer_snapshot.max_buffer_row();
884 if buffer_row >= max_row {
885 return false;
886 }
887
888 let (indent_size, is_blank) = self.line_indent_for_buffer_row(buffer_row);
889 if is_blank {
890 return false;
891 }
892
893 for next_row in (buffer_row + 1)..=max_row {
894 let (next_indent_size, next_line_is_blank) = self.line_indent_for_buffer_row(next_row);
895 if next_indent_size > indent_size {
896 return true;
897 } else if !next_line_is_blank {
898 break;
899 }
900 }
901
902 false
903 }
904
905 pub fn foldable_range(self: &Self, buffer_row: u32) -> Option<Range<Point>> {
906 let start = Point::new(buffer_row, self.buffer_snapshot.line_len(buffer_row));
907 if self.is_foldable(start.row) && !self.is_line_folded(start.row) {
908 let (start_indent, _) = self.line_indent_for_buffer_row(buffer_row);
909 let max_point = self.buffer_snapshot.max_point();
910 let mut end = None;
911
912 for row in (buffer_row + 1)..=max_point.row {
913 let (indent, is_blank) = self.line_indent_for_buffer_row(row);
914 if !is_blank && indent <= start_indent {
915 let prev_row = row - 1;
916 end = Some(Point::new(
917 prev_row,
918 self.buffer_snapshot.line_len(prev_row),
919 ));
920 break;
921 }
922 }
923 let end = end.unwrap_or(max_point);
924 Some(start..end)
925 } else {
926 None
927 }
928 }
929
930 #[cfg(any(test, feature = "test-support"))]
931 pub fn text_highlight_ranges<Tag: ?Sized + 'static>(
932 &self,
933 ) -> Option<Arc<(HighlightStyle, Vec<Range<Anchor>>)>> {
934 let type_id = TypeId::of::<Tag>();
935 self.text_highlights.get(&Some(type_id)).cloned()
936 }
937
938 #[cfg(any(test, feature = "test-support"))]
939 pub fn inlay_highlights<Tag: ?Sized + 'static>(
940 &self,
941 ) -> Option<&HashMap<InlayId, (HighlightStyle, InlayHighlight)>> {
942 let type_id = TypeId::of::<Tag>();
943 self.inlay_highlights.get(&type_id)
944 }
945}
946
947#[derive(Copy, Clone, Default, Eq, Ord, PartialOrd, PartialEq)]
948pub struct DisplayPoint(BlockPoint);
949
950impl Debug for DisplayPoint {
951 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
952 f.write_fmt(format_args!(
953 "DisplayPoint({}, {})",
954 self.row(),
955 self.column()
956 ))
957 }
958}
959
960impl DisplayPoint {
961 pub fn new(row: u32, column: u32) -> Self {
962 Self(BlockPoint(Point::new(row, column)))
963 }
964
965 pub fn zero() -> Self {
966 Self::new(0, 0)
967 }
968
969 pub fn is_zero(&self) -> bool {
970 self.0.is_zero()
971 }
972
973 pub fn row(self) -> u32 {
974 self.0.row
975 }
976
977 pub fn column(self) -> u32 {
978 self.0.column
979 }
980
981 pub fn row_mut(&mut self) -> &mut u32 {
982 &mut self.0.row
983 }
984
985 pub fn column_mut(&mut self) -> &mut u32 {
986 &mut self.0.column
987 }
988
989 pub fn to_point(self, map: &DisplaySnapshot) -> Point {
990 map.display_point_to_point(self, Bias::Left)
991 }
992
993 pub fn to_offset(self, map: &DisplaySnapshot, bias: Bias) -> usize {
994 let wrap_point = map.block_snapshot.to_wrap_point(self.0);
995 let tab_point = map.wrap_snapshot.to_tab_point(wrap_point);
996 let fold_point = map.tab_snapshot.to_fold_point(tab_point, bias).0;
997 let inlay_point = fold_point.to_inlay_point(&map.fold_snapshot);
998 map.inlay_snapshot
999 .to_buffer_offset(map.inlay_snapshot.to_offset(inlay_point))
1000 }
1001}
1002
1003impl ToDisplayPoint for usize {
1004 fn to_display_point(&self, map: &DisplaySnapshot) -> DisplayPoint {
1005 map.point_to_display_point(self.to_point(&map.buffer_snapshot), Bias::Left)
1006 }
1007}
1008
1009impl ToDisplayPoint for OffsetUtf16 {
1010 fn to_display_point(&self, map: &DisplaySnapshot) -> DisplayPoint {
1011 self.to_offset(&map.buffer_snapshot).to_display_point(map)
1012 }
1013}
1014
1015impl ToDisplayPoint for Point {
1016 fn to_display_point(&self, map: &DisplaySnapshot) -> DisplayPoint {
1017 map.point_to_display_point(*self, Bias::Left)
1018 }
1019}
1020
1021impl ToDisplayPoint for Anchor {
1022 fn to_display_point(&self, map: &DisplaySnapshot) -> DisplayPoint {
1023 self.to_point(&map.buffer_snapshot).to_display_point(map)
1024 }
1025}
1026
1027pub fn next_rows(display_row: u32, display_map: &DisplaySnapshot) -> impl Iterator<Item = u32> {
1028 let max_row = display_map.max_point().row();
1029 let start_row = display_row + 1;
1030 let mut current = None;
1031 std::iter::from_fn(move || {
1032 if current == None {
1033 current = Some(start_row);
1034 } else {
1035 current = Some(current.unwrap() + 1)
1036 }
1037 if current.unwrap() > max_row {
1038 None
1039 } else {
1040 current
1041 }
1042 })
1043}
1044
1045#[cfg(test)]
1046pub mod tests {
1047 use super::*;
1048 use crate::{
1049 movement,
1050 test::{editor_test_context::EditorTestContext, marked_display_snapshot},
1051 };
1052 use gpui::{color::Color, elements::*, test::observe, AppContext};
1053 use language::{
1054 language_settings::{AllLanguageSettings, AllLanguageSettingsContent},
1055 Buffer, Language, LanguageConfig, SelectionGoal,
1056 };
1057 use project::Project;
1058 use rand::{prelude::*, Rng};
1059 use settings::SettingsStore;
1060 use smol::stream::StreamExt;
1061 use std::{env, sync::Arc};
1062 use theme::{SyntaxTheme, Theme};
1063 use util::test::{marked_text_ranges, sample_text};
1064 use Bias::*;
1065
1066 #[gpui::test(iterations = 100)]
1067 async fn test_random_display_map(cx: &mut gpui::TestAppContext, mut rng: StdRng) {
1068 cx.foreground().set_block_on_ticks(0..=50);
1069 cx.foreground().forbid_parking();
1070 let operations = env::var("OPERATIONS")
1071 .map(|i| i.parse().expect("invalid `OPERATIONS` variable"))
1072 .unwrap_or(10);
1073
1074 let font_cache = cx.font_cache().clone();
1075 let mut tab_size = rng.gen_range(1..=4);
1076 let buffer_start_excerpt_header_height = rng.gen_range(1..=5);
1077 let excerpt_header_height = rng.gen_range(1..=5);
1078 let family_id = font_cache
1079 .load_family(&["Helvetica"], &Default::default())
1080 .unwrap();
1081 let font_id = font_cache
1082 .select_font(family_id, &Default::default())
1083 .unwrap();
1084 let font_size = 14.0;
1085 let max_wrap_width = 300.0;
1086 let mut wrap_width = if rng.gen_bool(0.1) {
1087 None
1088 } else {
1089 Some(rng.gen_range(0.0..=max_wrap_width))
1090 };
1091
1092 log::info!("tab size: {}", tab_size);
1093 log::info!("wrap width: {:?}", wrap_width);
1094
1095 cx.update(|cx| {
1096 init_test(cx, |s| s.defaults.tab_size = NonZeroU32::new(tab_size));
1097 });
1098
1099 let buffer = cx.update(|cx| {
1100 if rng.gen() {
1101 let len = rng.gen_range(0..10);
1102 let text = util::RandomCharIter::new(&mut rng)
1103 .take(len)
1104 .collect::<String>();
1105 MultiBuffer::build_simple(&text, cx)
1106 } else {
1107 MultiBuffer::build_random(&mut rng, cx)
1108 }
1109 });
1110
1111 let map = cx.add_model(|cx| {
1112 DisplayMap::new(
1113 buffer.clone(),
1114 font_id,
1115 font_size,
1116 wrap_width,
1117 buffer_start_excerpt_header_height,
1118 excerpt_header_height,
1119 cx,
1120 )
1121 });
1122 let mut notifications = observe(&map, cx);
1123 let mut fold_count = 0;
1124 let mut blocks = Vec::new();
1125
1126 let snapshot = map.update(cx, |map, cx| map.snapshot(cx));
1127 log::info!("buffer text: {:?}", snapshot.buffer_snapshot.text());
1128 log::info!("fold text: {:?}", snapshot.fold_snapshot.text());
1129 log::info!("tab text: {:?}", snapshot.tab_snapshot.text());
1130 log::info!("wrap text: {:?}", snapshot.wrap_snapshot.text());
1131 log::info!("block text: {:?}", snapshot.block_snapshot.text());
1132 log::info!("display text: {:?}", snapshot.text());
1133
1134 for _i in 0..operations {
1135 match rng.gen_range(0..100) {
1136 0..=19 => {
1137 wrap_width = if rng.gen_bool(0.2) {
1138 None
1139 } else {
1140 Some(rng.gen_range(0.0..=max_wrap_width))
1141 };
1142 log::info!("setting wrap width to {:?}", wrap_width);
1143 map.update(cx, |map, cx| map.set_wrap_width(wrap_width, cx));
1144 }
1145 20..=29 => {
1146 let mut tab_sizes = vec![1, 2, 3, 4];
1147 tab_sizes.remove((tab_size - 1) as usize);
1148 tab_size = *tab_sizes.choose(&mut rng).unwrap();
1149 log::info!("setting tab size to {:?}", tab_size);
1150 cx.update(|cx| {
1151 cx.update_global::<SettingsStore, _, _>(|store, cx| {
1152 store.update_user_settings::<AllLanguageSettings>(cx, |s| {
1153 s.defaults.tab_size = NonZeroU32::new(tab_size);
1154 });
1155 });
1156 });
1157 }
1158 30..=44 => {
1159 map.update(cx, |map, cx| {
1160 if rng.gen() || blocks.is_empty() {
1161 let buffer = map.snapshot(cx).buffer_snapshot;
1162 let block_properties = (0..rng.gen_range(1..=1))
1163 .map(|_| {
1164 let position =
1165 buffer.anchor_after(buffer.clip_offset(
1166 rng.gen_range(0..=buffer.len()),
1167 Bias::Left,
1168 ));
1169
1170 let disposition = if rng.gen() {
1171 BlockDisposition::Above
1172 } else {
1173 BlockDisposition::Below
1174 };
1175 let height = rng.gen_range(1..5);
1176 log::info!(
1177 "inserting block {:?} {:?} with height {}",
1178 disposition,
1179 position.to_point(&buffer),
1180 height
1181 );
1182 BlockProperties {
1183 style: BlockStyle::Fixed,
1184 position,
1185 height,
1186 disposition,
1187 render: Arc::new(|_| Empty::new().into_any()),
1188 }
1189 })
1190 .collect::<Vec<_>>();
1191 blocks.extend(map.insert_blocks(block_properties, cx));
1192 } else {
1193 blocks.shuffle(&mut rng);
1194 let remove_count = rng.gen_range(1..=4.min(blocks.len()));
1195 let block_ids_to_remove = (0..remove_count)
1196 .map(|_| blocks.remove(rng.gen_range(0..blocks.len())))
1197 .collect();
1198 log::info!("removing block ids {:?}", block_ids_to_remove);
1199 map.remove_blocks(block_ids_to_remove, cx);
1200 }
1201 });
1202 }
1203 45..=79 => {
1204 let mut ranges = Vec::new();
1205 for _ in 0..rng.gen_range(1..=3) {
1206 buffer.read_with(cx, |buffer, cx| {
1207 let buffer = buffer.read(cx);
1208 let end = buffer.clip_offset(rng.gen_range(0..=buffer.len()), Right);
1209 let start = buffer.clip_offset(rng.gen_range(0..=end), Left);
1210 ranges.push(start..end);
1211 });
1212 }
1213
1214 if rng.gen() && fold_count > 0 {
1215 log::info!("unfolding ranges: {:?}", ranges);
1216 map.update(cx, |map, cx| {
1217 map.unfold(ranges, true, cx);
1218 });
1219 } else {
1220 log::info!("folding ranges: {:?}", ranges);
1221 map.update(cx, |map, cx| {
1222 map.fold(ranges, cx);
1223 });
1224 }
1225 }
1226 _ => {
1227 buffer.update(cx, |buffer, cx| buffer.randomly_mutate(&mut rng, 5, cx));
1228 }
1229 }
1230
1231 if map.read_with(cx, |map, cx| map.is_rewrapping(cx)) {
1232 notifications.next().await.unwrap();
1233 }
1234
1235 let snapshot = map.update(cx, |map, cx| map.snapshot(cx));
1236 fold_count = snapshot.fold_count();
1237 log::info!("buffer text: {:?}", snapshot.buffer_snapshot.text());
1238 log::info!("fold text: {:?}", snapshot.fold_snapshot.text());
1239 log::info!("tab text: {:?}", snapshot.tab_snapshot.text());
1240 log::info!("wrap text: {:?}", snapshot.wrap_snapshot.text());
1241 log::info!("block text: {:?}", snapshot.block_snapshot.text());
1242 log::info!("display text: {:?}", snapshot.text());
1243
1244 // Line boundaries
1245 let buffer = &snapshot.buffer_snapshot;
1246 for _ in 0..5 {
1247 let row = rng.gen_range(0..=buffer.max_point().row);
1248 let column = rng.gen_range(0..=buffer.line_len(row));
1249 let point = buffer.clip_point(Point::new(row, column), Left);
1250
1251 let (prev_buffer_bound, prev_display_bound) = snapshot.prev_line_boundary(point);
1252 let (next_buffer_bound, next_display_bound) = snapshot.next_line_boundary(point);
1253
1254 assert!(prev_buffer_bound <= point);
1255 assert!(next_buffer_bound >= point);
1256 assert_eq!(prev_buffer_bound.column, 0);
1257 assert_eq!(prev_display_bound.column(), 0);
1258 if next_buffer_bound < buffer.max_point() {
1259 assert_eq!(buffer.chars_at(next_buffer_bound).next(), Some('\n'));
1260 }
1261
1262 assert_eq!(
1263 prev_display_bound,
1264 prev_buffer_bound.to_display_point(&snapshot),
1265 "row boundary before {:?}. reported buffer row boundary: {:?}",
1266 point,
1267 prev_buffer_bound
1268 );
1269 assert_eq!(
1270 next_display_bound,
1271 next_buffer_bound.to_display_point(&snapshot),
1272 "display row boundary after {:?}. reported buffer row boundary: {:?}",
1273 point,
1274 next_buffer_bound
1275 );
1276 assert_eq!(
1277 prev_buffer_bound,
1278 prev_display_bound.to_point(&snapshot),
1279 "row boundary before {:?}. reported display row boundary: {:?}",
1280 point,
1281 prev_display_bound
1282 );
1283 assert_eq!(
1284 next_buffer_bound,
1285 next_display_bound.to_point(&snapshot),
1286 "row boundary after {:?}. reported display row boundary: {:?}",
1287 point,
1288 next_display_bound
1289 );
1290 }
1291
1292 // Movement
1293 let min_point = snapshot.clip_point(DisplayPoint::new(0, 0), Left);
1294 let max_point = snapshot.clip_point(snapshot.max_point(), Right);
1295 for _ in 0..5 {
1296 let row = rng.gen_range(0..=snapshot.max_point().row());
1297 let column = rng.gen_range(0..=snapshot.line_len(row));
1298 let point = snapshot.clip_point(DisplayPoint::new(row, column), Left);
1299
1300 log::info!("Moving from point {:?}", point);
1301
1302 let moved_right = movement::right(&snapshot, point);
1303 log::info!("Right {:?}", moved_right);
1304 if point < max_point {
1305 assert!(moved_right > point);
1306 if point.column() == snapshot.line_len(point.row())
1307 || snapshot.soft_wrap_indent(point.row()).is_some()
1308 && point.column() == snapshot.line_len(point.row()) - 1
1309 {
1310 assert!(moved_right.row() > point.row());
1311 }
1312 } else {
1313 assert_eq!(moved_right, point);
1314 }
1315
1316 let moved_left = movement::left(&snapshot, point);
1317 log::info!("Left {:?}", moved_left);
1318 if point > min_point {
1319 assert!(moved_left < point);
1320 if point.column() == 0 {
1321 assert!(moved_left.row() < point.row());
1322 }
1323 } else {
1324 assert_eq!(moved_left, point);
1325 }
1326 }
1327 }
1328 }
1329
1330 #[gpui::test(retries = 5)]
1331 async fn test_soft_wraps(cx: &mut gpui::TestAppContext) {
1332 cx.foreground().set_block_on_ticks(usize::MAX..=usize::MAX);
1333 cx.update(|cx| {
1334 init_test(cx, |_| {});
1335 });
1336
1337 let mut cx = EditorTestContext::new(cx).await;
1338 let editor = cx.editor.clone();
1339 let window = cx.window.clone();
1340
1341 cx.update_window(window, |cx| {
1342 let editor_style = editor.read(&cx).style(cx);
1343
1344 let font_cache = cx.font_cache().clone();
1345
1346 let family_id = font_cache
1347 .load_family(&["Helvetica"], &Default::default())
1348 .unwrap();
1349 let font_id = font_cache
1350 .select_font(family_id, &Default::default())
1351 .unwrap();
1352 let font_size = 12.0;
1353 let wrap_width = Some(64.);
1354
1355 let text = "one two three four five\nsix seven eight";
1356 let buffer = MultiBuffer::build_simple(text, cx);
1357 let map = cx.add_model(|cx| {
1358 DisplayMap::new(buffer.clone(), font_id, font_size, wrap_width, 1, 1, cx)
1359 });
1360
1361 let snapshot = map.update(cx, |map, cx| map.snapshot(cx));
1362 assert_eq!(
1363 snapshot.text_chunks(0).collect::<String>(),
1364 "one two \nthree four \nfive\nsix seven \neight"
1365 );
1366 assert_eq!(
1367 snapshot.clip_point(DisplayPoint::new(0, 8), Bias::Left),
1368 DisplayPoint::new(0, 7)
1369 );
1370 assert_eq!(
1371 snapshot.clip_point(DisplayPoint::new(0, 8), Bias::Right),
1372 DisplayPoint::new(1, 0)
1373 );
1374 assert_eq!(
1375 movement::right(&snapshot, DisplayPoint::new(0, 7)),
1376 DisplayPoint::new(1, 0)
1377 );
1378 assert_eq!(
1379 movement::left(&snapshot, DisplayPoint::new(1, 0)),
1380 DisplayPoint::new(0, 7)
1381 );
1382
1383 let x = snapshot.x_for_point(
1384 DisplayPoint::new(1, 10),
1385 cx.font_cache(),
1386 cx.text_layout_cache(),
1387 &editor_style,
1388 );
1389 dbg!(x);
1390 assert_eq!(
1391 movement::up(
1392 &snapshot,
1393 DisplayPoint::new(1, 10),
1394 SelectionGoal::None,
1395 false,
1396 cx.font_cache(),
1397 cx.text_layout_cache(),
1398 &editor_style,
1399 ),
1400 (
1401 DisplayPoint::new(0, 7),
1402 SelectionGoal::HorizontalPosition(x)
1403 )
1404 );
1405 assert_eq!(
1406 movement::down(
1407 &snapshot,
1408 DisplayPoint::new(0, 7),
1409 SelectionGoal::Column(10),
1410 false
1411 ),
1412 (DisplayPoint::new(1, 10), SelectionGoal::Column(10))
1413 );
1414 assert_eq!(
1415 movement::down(
1416 &snapshot,
1417 DisplayPoint::new(1, 10),
1418 SelectionGoal::Column(10),
1419 false
1420 ),
1421 (DisplayPoint::new(2, 4), SelectionGoal::Column(10))
1422 );
1423
1424 let ix = snapshot.buffer_snapshot.text().find("seven").unwrap();
1425 buffer.update(cx, |buffer, cx| {
1426 buffer.edit([(ix..ix, "and ")], None, cx);
1427 });
1428
1429 let snapshot = map.update(cx, |map, cx| map.snapshot(cx));
1430 assert_eq!(
1431 snapshot.text_chunks(1).collect::<String>(),
1432 "three four \nfive\nsix and \nseven eight"
1433 );
1434
1435 // Re-wrap on font size changes
1436 map.update(cx, |map, cx| map.set_font(font_id, font_size + 3., cx));
1437
1438 let snapshot = map.update(cx, |map, cx| map.snapshot(cx));
1439 assert_eq!(
1440 snapshot.text_chunks(1).collect::<String>(),
1441 "three \nfour five\nsix and \nseven \neight"
1442 )
1443 });
1444 }
1445
1446 #[gpui::test]
1447 fn test_text_chunks(cx: &mut gpui::AppContext) {
1448 init_test(cx, |_| {});
1449
1450 let text = sample_text(6, 6, 'a');
1451 let buffer = MultiBuffer::build_simple(&text, cx);
1452 let family_id = cx
1453 .font_cache()
1454 .load_family(&["Helvetica"], &Default::default())
1455 .unwrap();
1456 let font_id = cx
1457 .font_cache()
1458 .select_font(family_id, &Default::default())
1459 .unwrap();
1460 let font_size = 14.0;
1461 let map =
1462 cx.add_model(|cx| DisplayMap::new(buffer.clone(), font_id, font_size, None, 1, 1, cx));
1463
1464 buffer.update(cx, |buffer, cx| {
1465 buffer.edit(
1466 vec![
1467 (Point::new(1, 0)..Point::new(1, 0), "\t"),
1468 (Point::new(1, 1)..Point::new(1, 1), "\t"),
1469 (Point::new(2, 1)..Point::new(2, 1), "\t"),
1470 ],
1471 None,
1472 cx,
1473 )
1474 });
1475
1476 assert_eq!(
1477 map.update(cx, |map, cx| map.snapshot(cx))
1478 .text_chunks(1)
1479 .collect::<String>()
1480 .lines()
1481 .next(),
1482 Some(" b bbbbb")
1483 );
1484 assert_eq!(
1485 map.update(cx, |map, cx| map.snapshot(cx))
1486 .text_chunks(2)
1487 .collect::<String>()
1488 .lines()
1489 .next(),
1490 Some("c ccccc")
1491 );
1492 }
1493
1494 #[gpui::test]
1495 async fn test_chunks(cx: &mut gpui::TestAppContext) {
1496 use unindent::Unindent as _;
1497
1498 let text = r#"
1499 fn outer() {}
1500
1501 mod module {
1502 fn inner() {}
1503 }"#
1504 .unindent();
1505
1506 let theme = SyntaxTheme::new(vec![
1507 ("mod.body".to_string(), Color::red().into()),
1508 ("fn.name".to_string(), Color::blue().into()),
1509 ]);
1510 let language = Arc::new(
1511 Language::new(
1512 LanguageConfig {
1513 name: "Test".into(),
1514 path_suffixes: vec![".test".to_string()],
1515 ..Default::default()
1516 },
1517 Some(tree_sitter_rust::language()),
1518 )
1519 .with_highlights_query(
1520 r#"
1521 (mod_item name: (identifier) body: _ @mod.body)
1522 (function_item name: (identifier) @fn.name)
1523 "#,
1524 )
1525 .unwrap(),
1526 );
1527 language.set_theme(&theme);
1528
1529 cx.update(|cx| init_test(cx, |s| s.defaults.tab_size = Some(2.try_into().unwrap())));
1530
1531 let buffer = cx
1532 .add_model(|cx| Buffer::new(0, cx.model_id() as u64, text).with_language(language, cx));
1533 buffer.condition(cx, |buf, _| !buf.is_parsing()).await;
1534 let buffer = cx.add_model(|cx| MultiBuffer::singleton(buffer, cx));
1535
1536 let font_cache = cx.font_cache();
1537 let family_id = font_cache
1538 .load_family(&["Helvetica"], &Default::default())
1539 .unwrap();
1540 let font_id = font_cache
1541 .select_font(family_id, &Default::default())
1542 .unwrap();
1543 let font_size = 14.0;
1544
1545 let map = cx.add_model(|cx| DisplayMap::new(buffer, font_id, font_size, None, 1, 1, cx));
1546 assert_eq!(
1547 cx.update(|cx| syntax_chunks(0..5, &map, &theme, cx)),
1548 vec![
1549 ("fn ".to_string(), None),
1550 ("outer".to_string(), Some(Color::blue())),
1551 ("() {}\n\nmod module ".to_string(), None),
1552 ("{\n fn ".to_string(), Some(Color::red())),
1553 ("inner".to_string(), Some(Color::blue())),
1554 ("() {}\n}".to_string(), Some(Color::red())),
1555 ]
1556 );
1557 assert_eq!(
1558 cx.update(|cx| syntax_chunks(3..5, &map, &theme, cx)),
1559 vec![
1560 (" fn ".to_string(), Some(Color::red())),
1561 ("inner".to_string(), Some(Color::blue())),
1562 ("() {}\n}".to_string(), Some(Color::red())),
1563 ]
1564 );
1565
1566 map.update(cx, |map, cx| {
1567 map.fold(vec![Point::new(0, 6)..Point::new(3, 2)], cx)
1568 });
1569 assert_eq!(
1570 cx.update(|cx| syntax_chunks(0..2, &map, &theme, cx)),
1571 vec![
1572 ("fn ".to_string(), None),
1573 ("out".to_string(), Some(Color::blue())),
1574 ("āÆ".to_string(), None),
1575 (" fn ".to_string(), Some(Color::red())),
1576 ("inner".to_string(), Some(Color::blue())),
1577 ("() {}\n}".to_string(), Some(Color::red())),
1578 ]
1579 );
1580 }
1581
1582 #[gpui::test]
1583 async fn test_chunks_with_soft_wrapping(cx: &mut gpui::TestAppContext) {
1584 use unindent::Unindent as _;
1585
1586 cx.foreground().set_block_on_ticks(usize::MAX..=usize::MAX);
1587
1588 let text = r#"
1589 fn outer() {}
1590
1591 mod module {
1592 fn inner() {}
1593 }"#
1594 .unindent();
1595
1596 let theme = SyntaxTheme::new(vec![
1597 ("mod.body".to_string(), Color::red().into()),
1598 ("fn.name".to_string(), Color::blue().into()),
1599 ]);
1600 let language = Arc::new(
1601 Language::new(
1602 LanguageConfig {
1603 name: "Test".into(),
1604 path_suffixes: vec![".test".to_string()],
1605 ..Default::default()
1606 },
1607 Some(tree_sitter_rust::language()),
1608 )
1609 .with_highlights_query(
1610 r#"
1611 (mod_item name: (identifier) body: _ @mod.body)
1612 (function_item name: (identifier) @fn.name)
1613 "#,
1614 )
1615 .unwrap(),
1616 );
1617 language.set_theme(&theme);
1618
1619 cx.update(|cx| init_test(cx, |_| {}));
1620
1621 let buffer = cx
1622 .add_model(|cx| Buffer::new(0, cx.model_id() as u64, text).with_language(language, cx));
1623 buffer.condition(cx, |buf, _| !buf.is_parsing()).await;
1624 let buffer = cx.add_model(|cx| MultiBuffer::singleton(buffer, cx));
1625
1626 let font_cache = cx.font_cache();
1627
1628 let family_id = font_cache
1629 .load_family(&["Courier"], &Default::default())
1630 .unwrap();
1631 let font_id = font_cache
1632 .select_font(family_id, &Default::default())
1633 .unwrap();
1634 let font_size = 16.0;
1635
1636 let map =
1637 cx.add_model(|cx| DisplayMap::new(buffer, font_id, font_size, Some(40.0), 1, 1, cx));
1638 assert_eq!(
1639 cx.update(|cx| syntax_chunks(0..5, &map, &theme, cx)),
1640 [
1641 ("fn \n".to_string(), None),
1642 ("oute\nr".to_string(), Some(Color::blue())),
1643 ("() \n{}\n\n".to_string(), None),
1644 ]
1645 );
1646 assert_eq!(
1647 cx.update(|cx| syntax_chunks(3..5, &map, &theme, cx)),
1648 [("{}\n\n".to_string(), None)]
1649 );
1650
1651 map.update(cx, |map, cx| {
1652 map.fold(vec![Point::new(0, 6)..Point::new(3, 2)], cx)
1653 });
1654 assert_eq!(
1655 cx.update(|cx| syntax_chunks(1..4, &map, &theme, cx)),
1656 [
1657 ("out".to_string(), Some(Color::blue())),
1658 ("āÆ\n".to_string(), None),
1659 (" \nfn ".to_string(), Some(Color::red())),
1660 ("i\n".to_string(), Some(Color::blue()))
1661 ]
1662 );
1663 }
1664
1665 #[gpui::test]
1666 async fn test_chunks_with_text_highlights(cx: &mut gpui::TestAppContext) {
1667 cx.update(|cx| init_test(cx, |_| {}));
1668
1669 let theme = SyntaxTheme::new(vec![
1670 ("operator".to_string(), Color::red().into()),
1671 ("string".to_string(), Color::green().into()),
1672 ]);
1673 let language = Arc::new(
1674 Language::new(
1675 LanguageConfig {
1676 name: "Test".into(),
1677 path_suffixes: vec![".test".to_string()],
1678 ..Default::default()
1679 },
1680 Some(tree_sitter_rust::language()),
1681 )
1682 .with_highlights_query(
1683 r#"
1684 ":" @operator
1685 (string_literal) @string
1686 "#,
1687 )
1688 .unwrap(),
1689 );
1690 language.set_theme(&theme);
1691
1692 let (text, highlighted_ranges) = marked_text_ranges(r#"constĖ Ā«aĀ»: B = "c Ā«dĀ»""#, false);
1693
1694 let buffer = cx
1695 .add_model(|cx| Buffer::new(0, cx.model_id() as u64, text).with_language(language, cx));
1696 buffer.condition(cx, |buf, _| !buf.is_parsing()).await;
1697
1698 let buffer = cx.add_model(|cx| MultiBuffer::singleton(buffer, cx));
1699 let buffer_snapshot = buffer.read_with(cx, |buffer, cx| buffer.snapshot(cx));
1700
1701 let font_cache = cx.font_cache();
1702 let family_id = font_cache
1703 .load_family(&["Courier"], &Default::default())
1704 .unwrap();
1705 let font_id = font_cache
1706 .select_font(family_id, &Default::default())
1707 .unwrap();
1708 let font_size = 16.0;
1709 let map = cx.add_model(|cx| DisplayMap::new(buffer, font_id, font_size, None, 1, 1, cx));
1710
1711 enum MyType {}
1712
1713 let style = HighlightStyle {
1714 color: Some(Color::blue()),
1715 ..Default::default()
1716 };
1717
1718 map.update(cx, |map, _cx| {
1719 map.highlight_text(
1720 TypeId::of::<MyType>(),
1721 highlighted_ranges
1722 .into_iter()
1723 .map(|range| {
1724 buffer_snapshot.anchor_before(range.start)
1725 ..buffer_snapshot.anchor_before(range.end)
1726 })
1727 .collect(),
1728 style,
1729 );
1730 });
1731
1732 assert_eq!(
1733 cx.update(|cx| chunks(0..10, &map, &theme, cx)),
1734 [
1735 ("const ".to_string(), None, None),
1736 ("a".to_string(), None, Some(Color::blue())),
1737 (":".to_string(), Some(Color::red()), None),
1738 (" B = ".to_string(), None, None),
1739 ("\"c ".to_string(), Some(Color::green()), None),
1740 ("d".to_string(), Some(Color::green()), Some(Color::blue())),
1741 ("\"".to_string(), Some(Color::green()), None),
1742 ]
1743 );
1744 }
1745
1746 #[gpui::test]
1747 fn test_clip_point(cx: &mut gpui::AppContext) {
1748 init_test(cx, |_| {});
1749
1750 fn assert(text: &str, shift_right: bool, bias: Bias, cx: &mut gpui::AppContext) {
1751 let (unmarked_snapshot, mut markers) = marked_display_snapshot(text, cx);
1752
1753 match bias {
1754 Bias::Left => {
1755 if shift_right {
1756 *markers[1].column_mut() += 1;
1757 }
1758
1759 assert_eq!(unmarked_snapshot.clip_point(markers[1], bias), markers[0])
1760 }
1761 Bias::Right => {
1762 if shift_right {
1763 *markers[0].column_mut() += 1;
1764 }
1765
1766 assert_eq!(unmarked_snapshot.clip_point(markers[0], bias), markers[1])
1767 }
1768 };
1769 }
1770
1771 use Bias::{Left, Right};
1772 assert("ĖĖα", false, Left, cx);
1773 assert("ĖĖα", true, Left, cx);
1774 assert("ĖĖα", false, Right, cx);
1775 assert("ĖαĖ", true, Right, cx);
1776 assert("ĖĖā", false, Left, cx);
1777 assert("ĖĖā", true, Left, cx);
1778 assert("ĖĖā", false, Right, cx);
1779 assert("ĖāĖ", true, Right, cx);
1780 assert("ĖĖš", false, Left, cx);
1781 assert("ĖĖš", true, Left, cx);
1782 assert("ĖĖš", false, Right, cx);
1783 assert("ĖšĖ", true, Right, cx);
1784 assert("ĖĖ\t", false, Left, cx);
1785 assert("ĖĖ\t", true, Left, cx);
1786 assert("ĖĖ\t", false, Right, cx);
1787 assert("Ė\tĖ", true, Right, cx);
1788 assert(" ĖĖ\t", false, Left, cx);
1789 assert(" ĖĖ\t", true, Left, cx);
1790 assert(" ĖĖ\t", false, Right, cx);
1791 assert(" Ė\tĖ", true, Right, cx);
1792 assert(" ĖĖ\t", false, Left, cx);
1793 assert(" ĖĖ\t", false, Right, cx);
1794 }
1795
1796 #[gpui::test]
1797 fn test_clip_at_line_ends(cx: &mut gpui::AppContext) {
1798 init_test(cx, |_| {});
1799
1800 fn assert(text: &str, cx: &mut gpui::AppContext) {
1801 let (mut unmarked_snapshot, markers) = marked_display_snapshot(text, cx);
1802 unmarked_snapshot.clip_at_line_ends = true;
1803 assert_eq!(
1804 unmarked_snapshot.clip_point(markers[1], Bias::Left),
1805 markers[0]
1806 );
1807 }
1808
1809 assert("ĖĖ", cx);
1810 assert("ĖaĖ", cx);
1811 assert("aĖbĖ", cx);
1812 assert("aĖαĖ", cx);
1813 }
1814
1815 #[gpui::test]
1816 fn test_tabs_with_multibyte_chars(cx: &mut gpui::AppContext) {
1817 init_test(cx, |_| {});
1818
1819 let text = "ā
\t\tα\nβ\t\nšĪ²\t\tγ";
1820 let buffer = MultiBuffer::build_simple(text, cx);
1821 let font_cache = cx.font_cache();
1822 let family_id = font_cache
1823 .load_family(&["Helvetica"], &Default::default())
1824 .unwrap();
1825 let font_id = font_cache
1826 .select_font(family_id, &Default::default())
1827 .unwrap();
1828 let font_size = 14.0;
1829
1830 let map =
1831 cx.add_model(|cx| DisplayMap::new(buffer.clone(), font_id, font_size, None, 1, 1, cx));
1832 let map = map.update(cx, |map, cx| map.snapshot(cx));
1833 assert_eq!(map.text(), "ā
α\nβ \nšĪ² γ");
1834 assert_eq!(
1835 map.text_chunks(0).collect::<String>(),
1836 "ā
α\nβ \nšĪ² γ"
1837 );
1838 assert_eq!(map.text_chunks(1).collect::<String>(), "β \nšĪ² γ");
1839 assert_eq!(map.text_chunks(2).collect::<String>(), "šĪ² γ");
1840
1841 let point = Point::new(0, "ā
\t\t".len() as u32);
1842 let display_point = DisplayPoint::new(0, "ā
".len() as u32);
1843 assert_eq!(point.to_display_point(&map), display_point);
1844 assert_eq!(display_point.to_point(&map), point);
1845
1846 let point = Point::new(1, "β\t".len() as u32);
1847 let display_point = DisplayPoint::new(1, "β ".len() as u32);
1848 assert_eq!(point.to_display_point(&map), display_point);
1849 assert_eq!(display_point.to_point(&map), point,);
1850
1851 let point = Point::new(2, "šĪ²\t\t".len() as u32);
1852 let display_point = DisplayPoint::new(2, "šĪ² ".len() as u32);
1853 assert_eq!(point.to_display_point(&map), display_point);
1854 assert_eq!(display_point.to_point(&map), point,);
1855
1856 // Display points inside of expanded tabs
1857 assert_eq!(
1858 DisplayPoint::new(0, "ā
".len() as u32).to_point(&map),
1859 Point::new(0, "ā
\t".len() as u32),
1860 );
1861 assert_eq!(
1862 DisplayPoint::new(0, "ā
".len() as u32).to_point(&map),
1863 Point::new(0, "ā
".len() as u32),
1864 );
1865
1866 // Clipping display points inside of multi-byte characters
1867 assert_eq!(
1868 map.clip_point(DisplayPoint::new(0, "ā
".len() as u32 - 1), Left),
1869 DisplayPoint::new(0, 0)
1870 );
1871 assert_eq!(
1872 map.clip_point(DisplayPoint::new(0, "ā
".len() as u32 - 1), Bias::Right),
1873 DisplayPoint::new(0, "ā
".len() as u32)
1874 );
1875 }
1876
1877 #[gpui::test]
1878 fn test_max_point(cx: &mut gpui::AppContext) {
1879 init_test(cx, |_| {});
1880
1881 let buffer = MultiBuffer::build_simple("aaa\n\t\tbbb", cx);
1882 let font_cache = cx.font_cache();
1883 let family_id = font_cache
1884 .load_family(&["Helvetica"], &Default::default())
1885 .unwrap();
1886 let font_id = font_cache
1887 .select_font(family_id, &Default::default())
1888 .unwrap();
1889 let font_size = 14.0;
1890 let map =
1891 cx.add_model(|cx| DisplayMap::new(buffer.clone(), font_id, font_size, None, 1, 1, cx));
1892 assert_eq!(
1893 map.update(cx, |map, cx| map.snapshot(cx)).max_point(),
1894 DisplayPoint::new(1, 11)
1895 )
1896 }
1897
1898 fn syntax_chunks<'a>(
1899 rows: Range<u32>,
1900 map: &ModelHandle<DisplayMap>,
1901 theme: &'a SyntaxTheme,
1902 cx: &mut AppContext,
1903 ) -> Vec<(String, Option<Color>)> {
1904 chunks(rows, map, theme, cx)
1905 .into_iter()
1906 .map(|(text, color, _)| (text, color))
1907 .collect()
1908 }
1909
1910 fn chunks<'a>(
1911 rows: Range<u32>,
1912 map: &ModelHandle<DisplayMap>,
1913 theme: &'a SyntaxTheme,
1914 cx: &mut AppContext,
1915 ) -> Vec<(String, Option<Color>, Option<Color>)> {
1916 let snapshot = map.update(cx, |map, cx| map.snapshot(cx));
1917 let mut chunks: Vec<(String, Option<Color>, Option<Color>)> = Vec::new();
1918 for chunk in snapshot.chunks(rows, true, None, None) {
1919 let syntax_color = chunk
1920 .syntax_highlight_id
1921 .and_then(|id| id.style(theme)?.color);
1922 let highlight_color = chunk.highlight_style.and_then(|style| style.color);
1923 if let Some((last_chunk, last_syntax_color, last_highlight_color)) = chunks.last_mut() {
1924 if syntax_color == *last_syntax_color && highlight_color == *last_highlight_color {
1925 last_chunk.push_str(chunk.text);
1926 continue;
1927 }
1928 }
1929 chunks.push((chunk.text.to_string(), syntax_color, highlight_color));
1930 }
1931 chunks
1932 }
1933
1934 fn init_test(cx: &mut AppContext, f: impl Fn(&mut AllLanguageSettingsContent)) {
1935 cx.foreground().forbid_parking();
1936 cx.set_global(SettingsStore::test(cx));
1937 language::init(cx);
1938 crate::init(cx);
1939 Project::init_settings(cx);
1940 theme::init((), cx);
1941 cx.update_global::<SettingsStore, _, _>(|store, cx| {
1942 store.update_user_settings::<AllLanguageSettings>(cx, f);
1943 });
1944 }
1945}