1//! This module defines where the text should be displayed in an [`Editor`][Editor].
2//!
3//! Not literally though - rendering, layout and all that jazz is a responsibility of [`EditorElement`][EditorElement].
4//! Instead, [`DisplayMap`] decides where Inlays/Inlay hints are displayed, when
5//! to apply a soft wrap, where to add fold indicators, whether there are any tabs in the buffer that
6//! we display as spaces and where to display custom blocks (like diagnostics).
7//! Seems like a lot? That's because it is. [`DisplayMap`] is conceptually made up
8//! of several smaller structures that form a hierarchy (starting at the bottom):
9//! - [`InlayMap`] that decides where the [`Inlay`]s should be displayed.
10//! - [`FoldMap`] that decides where the fold indicators should be; it also tracks parts of a source file that are currently folded.
11//! - [`TabMap`] that keeps track of hard tabs in a buffer.
12//! - [`WrapMap`] that handles soft wrapping.
13//! - [`BlockMap`] that tracks custom blocks such as diagnostics that should be displayed within buffer.
14//! - [`DisplayMap`] that adds background highlights to the regions of text.
15//! Each one of those builds on top of preceding map.
16//!
17//! [Editor]: crate::Editor
18//! [EditorElement]: crate::element::EditorElement
19
20mod block_map;
21mod crease_map;
22mod custom_highlights;
23mod fold_map;
24mod inlay_map;
25pub(crate) mod invisibles;
26mod tab_map;
27mod wrap_map;
28
29use crate::{
30 EditorStyle, InlayId, RowExt, hover_links::InlayHighlight, movement::TextLayoutDetails,
31};
32pub use block_map::{
33 Block, BlockChunks as DisplayChunks, BlockContext, BlockId, BlockMap, BlockPlacement,
34 BlockPoint, BlockProperties, BlockRows, BlockStyle, CustomBlockId, EditorMargins, RenderBlock,
35 StickyHeaderExcerpt,
36};
37use block_map::{BlockRow, BlockSnapshot};
38use collections::{HashMap, HashSet};
39pub use crease_map::*;
40use fold_map::FoldSnapshot;
41pub use fold_map::{
42 ChunkRenderer, ChunkRendererContext, ChunkRendererId, Fold, FoldId, FoldPlaceholder, FoldPoint,
43};
44use gpui::{App, Context, Entity, Font, HighlightStyle, LineLayout, Pixels, UnderlineStyle};
45pub use inlay_map::Inlay;
46use inlay_map::InlaySnapshot;
47pub use inlay_map::{InlayOffset, InlayPoint};
48pub use invisibles::{is_invisible, replacement};
49use language::{
50 OffsetUtf16, Point, Subscription as BufferSubscription, language_settings::language_settings,
51};
52use multi_buffer::{
53 Anchor, AnchorRangeExt, ExcerptId, MultiBuffer, MultiBufferPoint, MultiBufferRow,
54 MultiBufferSnapshot, RowInfo, ToOffset, ToPoint,
55};
56use project::project_settings::DiagnosticSeverity;
57use serde::Deserialize;
58
59use std::{
60 any::TypeId,
61 borrow::Cow,
62 fmt::Debug,
63 iter,
64 num::NonZeroU32,
65 ops::{Add, Range, Sub},
66 sync::Arc,
67};
68use sum_tree::{Bias, TreeMap};
69use tab_map::TabSnapshot;
70use text::{BufferId, LineIndent};
71use ui::{SharedString, px};
72use unicode_segmentation::UnicodeSegmentation;
73use wrap_map::{WrapMap, WrapSnapshot};
74
75pub use crate::display_map::{fold_map::FoldMap, inlay_map::InlayMap, tab_map::TabMap};
76
77#[derive(Copy, Clone, Debug, PartialEq, Eq)]
78pub enum FoldStatus {
79 Folded,
80 Foldable,
81}
82
83#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
84pub enum HighlightKey {
85 Type(TypeId),
86 TypePlus(TypeId, usize),
87}
88
89pub trait ToDisplayPoint {
90 fn to_display_point(&self, map: &DisplaySnapshot) -> DisplayPoint;
91}
92
93type TextHighlights = TreeMap<HighlightKey, Arc<(HighlightStyle, Vec<Range<Anchor>>)>>;
94type InlayHighlights = TreeMap<TypeId, TreeMap<InlayId, (HighlightStyle, InlayHighlight)>>;
95
96/// Decides how text in a [`MultiBuffer`] should be displayed in a buffer, handling inlay hints,
97/// folding, hard tabs, soft wrapping, custom blocks (like diagnostics), and highlighting.
98///
99/// See the [module level documentation](self) for more information.
100pub struct DisplayMap {
101 /// The buffer that we are displaying.
102 buffer: Entity<MultiBuffer>,
103 buffer_subscription: BufferSubscription,
104 /// Decides where the [`Inlay`]s should be displayed.
105 inlay_map: InlayMap,
106 /// Decides where the fold indicators should be and tracks parts of a source file that are currently folded.
107 fold_map: FoldMap,
108 /// Keeps track of hard tabs in a buffer.
109 tab_map: TabMap,
110 /// Handles soft wrapping.
111 wrap_map: Entity<WrapMap>,
112 /// Tracks custom blocks such as diagnostics that should be displayed within buffer.
113 block_map: BlockMap,
114 /// Regions of text that should be highlighted.
115 text_highlights: TextHighlights,
116 /// Regions of inlays that should be highlighted.
117 inlay_highlights: InlayHighlights,
118 /// A container for explicitly foldable ranges, which supersede indentation based fold range suggestions.
119 crease_map: CreaseMap,
120 pub(crate) fold_placeholder: FoldPlaceholder,
121 pub clip_at_line_ends: bool,
122 pub(crate) masked: bool,
123 pub(crate) diagnostics_max_severity: DiagnosticSeverity,
124}
125
126impl DisplayMap {
127 pub fn new(
128 buffer: Entity<MultiBuffer>,
129 font: Font,
130 font_size: Pixels,
131 wrap_width: Option<Pixels>,
132 buffer_header_height: u32,
133 excerpt_header_height: u32,
134 fold_placeholder: FoldPlaceholder,
135 diagnostics_max_severity: DiagnosticSeverity,
136 cx: &mut Context<Self>,
137 ) -> Self {
138 let buffer_subscription = buffer.update(cx, |buffer, _| buffer.subscribe());
139
140 let tab_size = Self::tab_size(&buffer, cx);
141 let buffer_snapshot = buffer.read(cx).snapshot(cx);
142 let crease_map = CreaseMap::new(&buffer_snapshot);
143 let (inlay_map, snapshot) = InlayMap::new(buffer_snapshot);
144 let (fold_map, snapshot) = FoldMap::new(snapshot);
145 let (tab_map, snapshot) = TabMap::new(snapshot, tab_size);
146 let (wrap_map, snapshot) = WrapMap::new(snapshot, font, font_size, wrap_width, cx);
147 let block_map = BlockMap::new(snapshot, buffer_header_height, excerpt_header_height);
148
149 cx.observe(&wrap_map, |_, _, cx| cx.notify()).detach();
150
151 DisplayMap {
152 buffer,
153 buffer_subscription,
154 fold_map,
155 inlay_map,
156 tab_map,
157 wrap_map,
158 block_map,
159 crease_map,
160 fold_placeholder,
161 diagnostics_max_severity,
162 text_highlights: Default::default(),
163 inlay_highlights: Default::default(),
164 clip_at_line_ends: false,
165 masked: false,
166 }
167 }
168
169 pub fn snapshot(&mut self, cx: &mut Context<Self>) -> DisplaySnapshot {
170 let buffer_snapshot = self.buffer.read(cx).snapshot(cx);
171 let edits = self.buffer_subscription.consume().into_inner();
172 let (inlay_snapshot, edits) = self.inlay_map.sync(buffer_snapshot, edits);
173 let (fold_snapshot, edits) = self.fold_map.read(inlay_snapshot, edits);
174 let tab_size = Self::tab_size(&self.buffer, cx);
175 let (tab_snapshot, edits) = self.tab_map.sync(fold_snapshot, edits, tab_size);
176 let (wrap_snapshot, edits) = self
177 .wrap_map
178 .update(cx, |map, cx| map.sync(tab_snapshot, edits, cx));
179 let block_snapshot = self.block_map.read(wrap_snapshot, edits).snapshot;
180
181 DisplaySnapshot {
182 block_snapshot,
183 diagnostics_max_severity: self.diagnostics_max_severity,
184 crease_snapshot: self.crease_map.snapshot(),
185 text_highlights: self.text_highlights.clone(),
186 inlay_highlights: self.inlay_highlights.clone(),
187 clip_at_line_ends: self.clip_at_line_ends,
188 masked: self.masked,
189 fold_placeholder: self.fold_placeholder.clone(),
190 }
191 }
192
193 pub fn set_state(&mut self, other: &DisplaySnapshot, cx: &mut Context<Self>) {
194 self.fold(
195 other
196 .folds_in_range(0..other.buffer_snapshot().len())
197 .map(|fold| {
198 Crease::simple(
199 fold.range.to_offset(other.buffer_snapshot()),
200 fold.placeholder.clone(),
201 )
202 })
203 .collect(),
204 cx,
205 );
206 }
207
208 /// Creates folds for the given creases.
209 pub fn fold<T: Clone + ToOffset>(&mut self, creases: Vec<Crease<T>>, cx: &mut Context<Self>) {
210 let buffer_snapshot = self.buffer.read(cx).snapshot(cx);
211 let edits = self.buffer_subscription.consume().into_inner();
212 let tab_size = Self::tab_size(&self.buffer, cx);
213 let (snapshot, edits) = self.inlay_map.sync(buffer_snapshot.clone(), edits);
214 let (mut fold_map, snapshot, edits) = self.fold_map.write(snapshot, edits);
215 let (snapshot, edits) = self.tab_map.sync(snapshot, edits, tab_size);
216 let (snapshot, edits) = self
217 .wrap_map
218 .update(cx, |map, cx| map.sync(snapshot, edits, cx));
219 self.block_map.read(snapshot, edits);
220
221 let inline = creases.iter().filter_map(|crease| {
222 if let Crease::Inline {
223 range, placeholder, ..
224 } = crease
225 {
226 Some((range.clone(), placeholder.clone()))
227 } else {
228 None
229 }
230 });
231 let (snapshot, edits) = fold_map.fold(inline);
232
233 let (snapshot, edits) = self.tab_map.sync(snapshot, edits, tab_size);
234 let (snapshot, edits) = self
235 .wrap_map
236 .update(cx, |map, cx| map.sync(snapshot, edits, cx));
237 let mut block_map = self.block_map.write(snapshot, edits);
238 let blocks = creases.into_iter().filter_map(|crease| {
239 if let Crease::Block {
240 range,
241 block_height,
242 render_block,
243 block_style,
244 block_priority,
245 ..
246 } = crease
247 {
248 Some((
249 range,
250 render_block,
251 block_height,
252 block_style,
253 block_priority,
254 ))
255 } else {
256 None
257 }
258 });
259 block_map.insert(
260 blocks
261 .into_iter()
262 .map(|(range, render, height, style, priority)| {
263 let start = buffer_snapshot.anchor_before(range.start);
264 let end = buffer_snapshot.anchor_after(range.end);
265 BlockProperties {
266 placement: BlockPlacement::Replace(start..=end),
267 render,
268 height: Some(height),
269 style,
270 priority,
271 }
272 }),
273 );
274 }
275
276 /// Removes any folds with the given ranges.
277 pub fn remove_folds_with_type<T: ToOffset>(
278 &mut self,
279 ranges: impl IntoIterator<Item = Range<T>>,
280 type_id: TypeId,
281 cx: &mut Context<Self>,
282 ) {
283 let snapshot = self.buffer.read(cx).snapshot(cx);
284 let edits = self.buffer_subscription.consume().into_inner();
285 let tab_size = Self::tab_size(&self.buffer, cx);
286 let (snapshot, edits) = self.inlay_map.sync(snapshot, edits);
287 let (mut fold_map, snapshot, edits) = self.fold_map.write(snapshot, edits);
288 let (snapshot, edits) = self.tab_map.sync(snapshot, edits, tab_size);
289 let (snapshot, edits) = self
290 .wrap_map
291 .update(cx, |map, cx| map.sync(snapshot, edits, cx));
292 self.block_map.read(snapshot, edits);
293 let (snapshot, edits) = fold_map.remove_folds(ranges, type_id);
294 let (snapshot, edits) = self.tab_map.sync(snapshot, edits, tab_size);
295 let (snapshot, edits) = self
296 .wrap_map
297 .update(cx, |map, cx| map.sync(snapshot, edits, cx));
298 self.block_map.write(snapshot, edits);
299 }
300
301 /// Removes any folds whose ranges intersect any of the given ranges.
302 pub fn unfold_intersecting<T: ToOffset>(
303 &mut self,
304 ranges: impl IntoIterator<Item = Range<T>>,
305 inclusive: bool,
306 cx: &mut Context<Self>,
307 ) {
308 let snapshot = self.buffer.read(cx).snapshot(cx);
309 let offset_ranges = ranges
310 .into_iter()
311 .map(|range| range.start.to_offset(&snapshot)..range.end.to_offset(&snapshot))
312 .collect::<Vec<_>>();
313 let edits = self.buffer_subscription.consume().into_inner();
314 let tab_size = Self::tab_size(&self.buffer, cx);
315 let (snapshot, edits) = self.inlay_map.sync(snapshot, edits);
316 let (mut fold_map, snapshot, edits) = self.fold_map.write(snapshot, edits);
317 let (snapshot, edits) = self.tab_map.sync(snapshot, edits, tab_size);
318 let (snapshot, edits) = self
319 .wrap_map
320 .update(cx, |map, cx| map.sync(snapshot, edits, cx));
321 self.block_map.read(snapshot, edits);
322
323 let (snapshot, edits) =
324 fold_map.unfold_intersecting(offset_ranges.iter().cloned(), inclusive);
325 let (snapshot, edits) = self.tab_map.sync(snapshot, edits, tab_size);
326 let (snapshot, edits) = self
327 .wrap_map
328 .update(cx, |map, cx| map.sync(snapshot, edits, cx));
329 let mut block_map = self.block_map.write(snapshot, edits);
330 block_map.remove_intersecting_replace_blocks(offset_ranges, inclusive);
331 }
332
333 pub fn disable_header_for_buffer(&mut self, buffer_id: BufferId, cx: &mut Context<Self>) {
334 let snapshot = self.buffer.read(cx).snapshot(cx);
335 let edits = self.buffer_subscription.consume().into_inner();
336 let tab_size = Self::tab_size(&self.buffer, cx);
337 let (snapshot, edits) = self.inlay_map.sync(snapshot, edits);
338 let (snapshot, edits) = self.fold_map.read(snapshot, edits);
339 let (snapshot, edits) = self.tab_map.sync(snapshot, edits, tab_size);
340 let (snapshot, edits) = self
341 .wrap_map
342 .update(cx, |map, cx| map.sync(snapshot, edits, cx));
343 let mut block_map = self.block_map.write(snapshot, edits);
344 block_map.disable_header_for_buffer(buffer_id)
345 }
346
347 pub fn fold_buffers(
348 &mut self,
349 buffer_ids: impl IntoIterator<Item = language::BufferId>,
350 cx: &mut Context<Self>,
351 ) {
352 let snapshot = self.buffer.read(cx).snapshot(cx);
353 let edits = self.buffer_subscription.consume().into_inner();
354 let tab_size = Self::tab_size(&self.buffer, cx);
355 let (snapshot, edits) = self.inlay_map.sync(snapshot, edits);
356 let (snapshot, edits) = self.fold_map.read(snapshot, edits);
357 let (snapshot, edits) = self.tab_map.sync(snapshot, edits, tab_size);
358 let (snapshot, edits) = self
359 .wrap_map
360 .update(cx, |map, cx| map.sync(snapshot, edits, cx));
361 let mut block_map = self.block_map.write(snapshot, edits);
362 block_map.fold_buffers(buffer_ids, self.buffer.read(cx), cx)
363 }
364
365 pub fn unfold_buffers(
366 &mut self,
367 buffer_ids: impl IntoIterator<Item = language::BufferId>,
368 cx: &mut Context<Self>,
369 ) {
370 let snapshot = self.buffer.read(cx).snapshot(cx);
371 let edits = self.buffer_subscription.consume().into_inner();
372 let tab_size = Self::tab_size(&self.buffer, cx);
373 let (snapshot, edits) = self.inlay_map.sync(snapshot, edits);
374 let (snapshot, edits) = self.fold_map.read(snapshot, edits);
375 let (snapshot, edits) = self.tab_map.sync(snapshot, edits, tab_size);
376 let (snapshot, edits) = self
377 .wrap_map
378 .update(cx, |map, cx| map.sync(snapshot, edits, cx));
379 let mut block_map = self.block_map.write(snapshot, edits);
380 block_map.unfold_buffers(buffer_ids, self.buffer.read(cx), cx)
381 }
382
383 pub(crate) fn is_buffer_folded(&self, buffer_id: language::BufferId) -> bool {
384 self.block_map.folded_buffers.contains(&buffer_id)
385 }
386
387 pub(crate) fn folded_buffers(&self) -> &HashSet<BufferId> {
388 &self.block_map.folded_buffers
389 }
390
391 pub fn insert_creases(
392 &mut self,
393 creases: impl IntoIterator<Item = Crease<Anchor>>,
394 cx: &mut Context<Self>,
395 ) -> Vec<CreaseId> {
396 let snapshot = self.buffer.read(cx).snapshot(cx);
397 self.crease_map.insert(creases, &snapshot)
398 }
399
400 pub fn remove_creases(
401 &mut self,
402 crease_ids: impl IntoIterator<Item = CreaseId>,
403 cx: &mut Context<Self>,
404 ) -> Vec<(CreaseId, Range<Anchor>)> {
405 let snapshot = self.buffer.read(cx).snapshot(cx);
406 self.crease_map.remove(crease_ids, &snapshot)
407 }
408
409 pub fn insert_blocks(
410 &mut self,
411 blocks: impl IntoIterator<Item = BlockProperties<Anchor>>,
412 cx: &mut Context<Self>,
413 ) -> Vec<CustomBlockId> {
414 let snapshot = self.buffer.read(cx).snapshot(cx);
415 let edits = self.buffer_subscription.consume().into_inner();
416 let tab_size = Self::tab_size(&self.buffer, cx);
417 let (snapshot, edits) = self.inlay_map.sync(snapshot, edits);
418 let (snapshot, edits) = self.fold_map.read(snapshot, edits);
419 let (snapshot, edits) = self.tab_map.sync(snapshot, edits, tab_size);
420 let (snapshot, edits) = self
421 .wrap_map
422 .update(cx, |map, cx| map.sync(snapshot, edits, cx));
423 let mut block_map = self.block_map.write(snapshot, edits);
424 block_map.insert(blocks)
425 }
426
427 pub fn resize_blocks(&mut self, heights: HashMap<CustomBlockId, u32>, cx: &mut Context<Self>) {
428 let snapshot = self.buffer.read(cx).snapshot(cx);
429 let edits = self.buffer_subscription.consume().into_inner();
430 let tab_size = Self::tab_size(&self.buffer, cx);
431 let (snapshot, edits) = self.inlay_map.sync(snapshot, edits);
432 let (snapshot, edits) = self.fold_map.read(snapshot, edits);
433 let (snapshot, edits) = self.tab_map.sync(snapshot, edits, tab_size);
434 let (snapshot, edits) = self
435 .wrap_map
436 .update(cx, |map, cx| map.sync(snapshot, edits, cx));
437 let mut block_map = self.block_map.write(snapshot, edits);
438 block_map.resize(heights);
439 }
440
441 pub fn replace_blocks(&mut self, renderers: HashMap<CustomBlockId, RenderBlock>) {
442 self.block_map.replace_blocks(renderers);
443 }
444
445 pub fn remove_blocks(&mut self, ids: HashSet<CustomBlockId>, cx: &mut Context<Self>) {
446 let snapshot = self.buffer.read(cx).snapshot(cx);
447 let edits = self.buffer_subscription.consume().into_inner();
448 let tab_size = Self::tab_size(&self.buffer, cx);
449 let (snapshot, edits) = self.inlay_map.sync(snapshot, edits);
450 let (snapshot, edits) = self.fold_map.read(snapshot, edits);
451 let (snapshot, edits) = self.tab_map.sync(snapshot, edits, tab_size);
452 let (snapshot, edits) = self
453 .wrap_map
454 .update(cx, |map, cx| map.sync(snapshot, edits, cx));
455 let mut block_map = self.block_map.write(snapshot, edits);
456 block_map.remove(ids);
457 }
458
459 pub fn row_for_block(
460 &mut self,
461 block_id: CustomBlockId,
462 cx: &mut Context<Self>,
463 ) -> Option<DisplayRow> {
464 let snapshot = self.buffer.read(cx).snapshot(cx);
465 let edits = self.buffer_subscription.consume().into_inner();
466 let tab_size = Self::tab_size(&self.buffer, cx);
467 let (snapshot, edits) = self.inlay_map.sync(snapshot, edits);
468 let (snapshot, edits) = self.fold_map.read(snapshot, edits);
469 let (snapshot, edits) = self.tab_map.sync(snapshot, edits, tab_size);
470 let (snapshot, edits) = self
471 .wrap_map
472 .update(cx, |map, cx| map.sync(snapshot, edits, cx));
473 let block_map = self.block_map.read(snapshot, edits);
474 let block_row = block_map.row_for_block(block_id)?;
475 Some(DisplayRow(block_row.0))
476 }
477
478 pub fn highlight_text(
479 &mut self,
480 key: HighlightKey,
481 ranges: Vec<Range<Anchor>>,
482 style: HighlightStyle,
483 ) {
484 self.text_highlights.insert(key, Arc::new((style, ranges)));
485 }
486
487 pub(crate) fn highlight_inlays(
488 &mut self,
489 type_id: TypeId,
490 highlights: Vec<InlayHighlight>,
491 style: HighlightStyle,
492 ) {
493 for highlight in highlights {
494 let update = self.inlay_highlights.update(&type_id, |highlights| {
495 highlights.insert(highlight.inlay, (style, highlight.clone()))
496 });
497 if update.is_none() {
498 self.inlay_highlights.insert(
499 type_id,
500 TreeMap::from_ordered_entries([(highlight.inlay, (style, highlight))]),
501 );
502 }
503 }
504 }
505
506 pub fn text_highlights(&self, type_id: TypeId) -> Option<(HighlightStyle, &[Range<Anchor>])> {
507 let highlights = self.text_highlights.get(&HighlightKey::Type(type_id))?;
508 Some((highlights.0, &highlights.1))
509 }
510
511 #[cfg(feature = "test-support")]
512 pub fn all_text_highlights(
513 &self,
514 ) -> impl Iterator<Item = &Arc<(HighlightStyle, Vec<Range<Anchor>>)>> {
515 self.text_highlights.values()
516 }
517
518 pub fn clear_highlights(&mut self, type_id: TypeId) -> bool {
519 let mut cleared = self
520 .text_highlights
521 .remove(&HighlightKey::Type(type_id))
522 .is_some();
523 cleared |= self.inlay_highlights.remove(&type_id).is_some();
524 cleared
525 }
526
527 pub fn set_font(&self, font: Font, font_size: Pixels, cx: &mut Context<Self>) -> bool {
528 self.wrap_map
529 .update(cx, |map, cx| map.set_font_with_size(font, font_size, cx))
530 }
531
532 pub fn set_wrap_width(&self, width: Option<Pixels>, cx: &mut Context<Self>) -> bool {
533 self.wrap_map
534 .update(cx, |map, cx| map.set_wrap_width(width, cx))
535 }
536
537 pub fn update_fold_widths(
538 &mut self,
539 widths: impl IntoIterator<Item = (ChunkRendererId, Pixels)>,
540 cx: &mut Context<Self>,
541 ) -> bool {
542 let snapshot = self.buffer.read(cx).snapshot(cx);
543 let edits = self.buffer_subscription.consume().into_inner();
544 let tab_size = Self::tab_size(&self.buffer, cx);
545 let (snapshot, edits) = self.inlay_map.sync(snapshot, edits);
546 let (mut fold_map, snapshot, edits) = self.fold_map.write(snapshot, edits);
547 let (snapshot, edits) = self.tab_map.sync(snapshot, edits, tab_size);
548 let (snapshot, edits) = self
549 .wrap_map
550 .update(cx, |map, cx| map.sync(snapshot, edits, cx));
551 self.block_map.read(snapshot, edits);
552
553 let (snapshot, edits) = fold_map.update_fold_widths(widths);
554 let widths_changed = !edits.is_empty();
555 let (snapshot, edits) = self.tab_map.sync(snapshot, edits, tab_size);
556 let (snapshot, edits) = self
557 .wrap_map
558 .update(cx, |map, cx| map.sync(snapshot, edits, cx));
559 self.block_map.read(snapshot, edits);
560
561 widths_changed
562 }
563
564 pub(crate) fn current_inlays(&self) -> impl Iterator<Item = &Inlay> {
565 self.inlay_map.current_inlays()
566 }
567
568 pub(crate) fn splice_inlays(
569 &mut self,
570 to_remove: &[InlayId],
571 to_insert: Vec<Inlay>,
572 cx: &mut Context<Self>,
573 ) {
574 if to_remove.is_empty() && to_insert.is_empty() {
575 return;
576 }
577 let buffer_snapshot = self.buffer.read(cx).snapshot(cx);
578 let edits = self.buffer_subscription.consume().into_inner();
579 let (snapshot, edits) = self.inlay_map.sync(buffer_snapshot, edits);
580 let (snapshot, edits) = self.fold_map.read(snapshot, edits);
581 let tab_size = Self::tab_size(&self.buffer, cx);
582 let (snapshot, edits) = self.tab_map.sync(snapshot, edits, tab_size);
583 let (snapshot, edits) = self
584 .wrap_map
585 .update(cx, |map, cx| map.sync(snapshot, edits, cx));
586 self.block_map.read(snapshot, edits);
587
588 let (snapshot, edits) = self.inlay_map.splice(to_remove, to_insert);
589 let (snapshot, edits) = self.fold_map.read(snapshot, edits);
590 let (snapshot, edits) = self.tab_map.sync(snapshot, edits, tab_size);
591 let (snapshot, edits) = self
592 .wrap_map
593 .update(cx, |map, cx| map.sync(snapshot, edits, cx));
594 self.block_map.read(snapshot, edits);
595 }
596
597 pub fn remove_inlays_for_excerpts(
598 &mut self,
599 excerpts_removed: &[ExcerptId],
600 cx: &mut Context<Self>,
601 ) {
602 let to_remove = self
603 .inlay_map
604 .current_inlays()
605 .filter_map(|inlay| {
606 if excerpts_removed.contains(&inlay.position.excerpt_id) {
607 Some(inlay.id)
608 } else {
609 None
610 }
611 })
612 .collect::<Vec<_>>();
613 self.splice_inlays(&to_remove, Vec::new(), cx);
614 }
615
616 fn tab_size(buffer: &Entity<MultiBuffer>, cx: &App) -> NonZeroU32 {
617 let buffer = buffer.read(cx).as_singleton().map(|buffer| buffer.read(cx));
618 let language = buffer
619 .and_then(|buffer| buffer.language())
620 .map(|l| l.name());
621 let file = buffer.and_then(|buffer| buffer.file());
622 language_settings(language, file, cx).tab_size
623 }
624
625 #[cfg(test)]
626 pub fn is_rewrapping(&self, cx: &gpui::App) -> bool {
627 self.wrap_map.read(cx).is_rewrapping()
628 }
629}
630
631#[derive(Debug, Default)]
632pub(crate) struct Highlights<'a> {
633 pub text_highlights: Option<&'a TextHighlights>,
634 pub inlay_highlights: Option<&'a InlayHighlights>,
635 pub styles: HighlightStyles,
636}
637
638#[derive(Clone, Copy, Debug)]
639pub struct EditPredictionStyles {
640 pub insertion: HighlightStyle,
641 pub whitespace: HighlightStyle,
642}
643
644#[derive(Default, Debug, Clone, Copy)]
645pub struct HighlightStyles {
646 pub inlay_hint: Option<HighlightStyle>,
647 pub edit_prediction: Option<EditPredictionStyles>,
648}
649
650#[derive(Clone)]
651pub enum ChunkReplacement {
652 Renderer(ChunkRenderer),
653 Str(SharedString),
654}
655
656pub struct HighlightedChunk<'a> {
657 pub text: &'a str,
658 pub style: Option<HighlightStyle>,
659 pub is_tab: bool,
660 pub is_inlay: bool,
661 pub replacement: Option<ChunkReplacement>,
662}
663
664impl<'a> HighlightedChunk<'a> {
665 fn highlight_invisibles(
666 self,
667 editor_style: &'a EditorStyle,
668 ) -> impl Iterator<Item = Self> + 'a {
669 let mut chars = self.text.chars().peekable();
670 let mut text = self.text;
671 let style = self.style;
672 let is_tab = self.is_tab;
673 let renderer = self.replacement;
674 let is_inlay = self.is_inlay;
675 iter::from_fn(move || {
676 let mut prefix_len = 0;
677 while let Some(&ch) = chars.peek() {
678 if !is_invisible(ch) {
679 prefix_len += ch.len_utf8();
680 chars.next();
681 continue;
682 }
683 if prefix_len > 0 {
684 let (prefix, suffix) = text.split_at(prefix_len);
685 text = suffix;
686 return Some(HighlightedChunk {
687 text: prefix,
688 style,
689 is_tab,
690 is_inlay,
691 replacement: renderer.clone(),
692 });
693 }
694 chars.next();
695 let (prefix, suffix) = text.split_at(ch.len_utf8());
696 text = suffix;
697 if let Some(replacement) = replacement(ch) {
698 let invisible_highlight = HighlightStyle {
699 background_color: Some(editor_style.status.hint_background),
700 underline: Some(UnderlineStyle {
701 color: Some(editor_style.status.hint),
702 thickness: px(1.),
703 wavy: false,
704 }),
705 ..Default::default()
706 };
707 let invisible_style = if let Some(style) = style {
708 style.highlight(invisible_highlight)
709 } else {
710 invisible_highlight
711 };
712 return Some(HighlightedChunk {
713 text: prefix,
714 style: Some(invisible_style),
715 is_tab: false,
716 is_inlay,
717 replacement: Some(ChunkReplacement::Str(replacement.into())),
718 });
719 } else {
720 let invisible_highlight = HighlightStyle {
721 background_color: Some(editor_style.status.hint_background),
722 underline: Some(UnderlineStyle {
723 color: Some(editor_style.status.hint),
724 thickness: px(1.),
725 wavy: false,
726 }),
727 ..Default::default()
728 };
729 let invisible_style = if let Some(style) = style {
730 style.highlight(invisible_highlight)
731 } else {
732 invisible_highlight
733 };
734
735 return Some(HighlightedChunk {
736 text: prefix,
737 style: Some(invisible_style),
738 is_tab: false,
739 is_inlay,
740 replacement: renderer.clone(),
741 });
742 }
743 }
744
745 if !text.is_empty() {
746 let remainder = text;
747 text = "";
748 Some(HighlightedChunk {
749 text: remainder,
750 style,
751 is_tab,
752 is_inlay,
753 replacement: renderer.clone(),
754 })
755 } else {
756 None
757 }
758 })
759 }
760}
761
762#[derive(Clone)]
763pub struct DisplaySnapshot {
764 pub crease_snapshot: CreaseSnapshot,
765 block_snapshot: BlockSnapshot,
766 text_highlights: TextHighlights,
767 inlay_highlights: InlayHighlights,
768 clip_at_line_ends: bool,
769 masked: bool,
770 diagnostics_max_severity: DiagnosticSeverity,
771 pub(crate) fold_placeholder: FoldPlaceholder,
772}
773impl DisplaySnapshot {
774 pub fn wrap_snapshot(&self) -> &WrapSnapshot {
775 &self.block_snapshot.wrap_snapshot
776 }
777 pub fn tab_snapshot(&self) -> &TabSnapshot {
778 &self.block_snapshot.wrap_snapshot.tab_snapshot
779 }
780
781 pub fn fold_snapshot(&self) -> &FoldSnapshot {
782 &self.block_snapshot.wrap_snapshot.tab_snapshot.fold_snapshot
783 }
784
785 pub fn inlay_snapshot(&self) -> &InlaySnapshot {
786 &self
787 .block_snapshot
788 .wrap_snapshot
789 .tab_snapshot
790 .fold_snapshot
791 .inlay_snapshot
792 }
793
794 pub fn buffer_snapshot(&self) -> &MultiBufferSnapshot {
795 &self
796 .block_snapshot
797 .wrap_snapshot
798 .tab_snapshot
799 .fold_snapshot
800 .inlay_snapshot
801 .buffer
802 }
803
804 #[cfg(test)]
805 pub fn fold_count(&self) -> usize {
806 self.fold_snapshot().fold_count()
807 }
808
809 pub fn is_empty(&self) -> bool {
810 self.buffer_snapshot().len() == 0
811 }
812
813 pub fn row_infos(&self, start_row: DisplayRow) -> impl Iterator<Item = RowInfo> + '_ {
814 self.block_snapshot.row_infos(BlockRow(start_row.0))
815 }
816
817 pub fn widest_line_number(&self) -> u32 {
818 self.buffer_snapshot().widest_line_number()
819 }
820
821 pub fn prev_line_boundary(&self, mut point: MultiBufferPoint) -> (Point, DisplayPoint) {
822 loop {
823 let mut inlay_point = self.inlay_snapshot().to_inlay_point(point);
824 let mut fold_point = self.fold_snapshot().to_fold_point(inlay_point, Bias::Left);
825 fold_point.0.column = 0;
826 inlay_point = fold_point.to_inlay_point(self.fold_snapshot());
827 point = self.inlay_snapshot().to_buffer_point(inlay_point);
828
829 let mut display_point = self.point_to_display_point(point, Bias::Left);
830 *display_point.column_mut() = 0;
831 let next_point = self.display_point_to_point(display_point, Bias::Left);
832 if next_point == point {
833 return (point, display_point);
834 }
835 point = next_point;
836 }
837 }
838
839 pub fn next_line_boundary(
840 &self,
841 mut point: MultiBufferPoint,
842 ) -> (MultiBufferPoint, DisplayPoint) {
843 let original_point = point;
844 loop {
845 let mut inlay_point = self.inlay_snapshot().to_inlay_point(point);
846 let mut fold_point = self.fold_snapshot().to_fold_point(inlay_point, Bias::Right);
847 fold_point.0.column = self.fold_snapshot().line_len(fold_point.row());
848 inlay_point = fold_point.to_inlay_point(self.fold_snapshot());
849 point = self.inlay_snapshot().to_buffer_point(inlay_point);
850
851 let mut display_point = self.point_to_display_point(point, Bias::Right);
852 *display_point.column_mut() = self.line_len(display_point.row());
853 let next_point = self.display_point_to_point(display_point, Bias::Right);
854 if next_point == point || original_point == point || original_point == next_point {
855 return (point, display_point);
856 }
857 point = next_point;
858 }
859 }
860
861 // used by line_mode selections and tries to match vim behavior
862 pub fn expand_to_line(&self, range: Range<Point>) -> Range<Point> {
863 let new_start = MultiBufferPoint::new(range.start.row, 0);
864 let new_end = if range.end.column > 0 {
865 MultiBufferPoint::new(
866 range.end.row,
867 self.buffer_snapshot()
868 .line_len(MultiBufferRow(range.end.row)),
869 )
870 } else {
871 range.end
872 };
873
874 new_start..new_end
875 }
876
877 pub fn point_to_display_point(&self, point: MultiBufferPoint, bias: Bias) -> DisplayPoint {
878 let inlay_point = self.inlay_snapshot().to_inlay_point(point);
879 let fold_point = self.fold_snapshot().to_fold_point(inlay_point, bias);
880 let tab_point = self.tab_snapshot().to_tab_point(fold_point);
881 let wrap_point = self.wrap_snapshot().tab_point_to_wrap_point(tab_point);
882 let block_point = self.block_snapshot.to_block_point(wrap_point);
883 DisplayPoint(block_point)
884 }
885
886 pub fn display_point_to_point(&self, point: DisplayPoint, bias: Bias) -> Point {
887 self.inlay_snapshot()
888 .to_buffer_point(self.display_point_to_inlay_point(point, bias))
889 }
890
891 pub fn display_point_to_inlay_offset(&self, point: DisplayPoint, bias: Bias) -> InlayOffset {
892 self.inlay_snapshot()
893 .to_offset(self.display_point_to_inlay_point(point, bias))
894 }
895
896 pub fn anchor_to_inlay_offset(&self, anchor: Anchor) -> InlayOffset {
897 self.inlay_snapshot()
898 .to_inlay_offset(anchor.to_offset(self.buffer_snapshot()))
899 }
900
901 pub fn display_point_to_anchor(&self, point: DisplayPoint, bias: Bias) -> Anchor {
902 self.buffer_snapshot()
903 .anchor_at(point.to_offset(self, bias), bias)
904 }
905
906 fn display_point_to_inlay_point(&self, point: DisplayPoint, bias: Bias) -> InlayPoint {
907 let block_point = point.0;
908 let wrap_point = self.block_snapshot.to_wrap_point(block_point, bias);
909 let tab_point = self.wrap_snapshot().to_tab_point(wrap_point);
910 let fold_point = self.tab_snapshot().to_fold_point(tab_point, bias).0;
911 fold_point.to_inlay_point(self.fold_snapshot())
912 }
913
914 pub fn display_point_to_fold_point(&self, point: DisplayPoint, bias: Bias) -> FoldPoint {
915 let block_point = point.0;
916 let wrap_point = self.block_snapshot.to_wrap_point(block_point, bias);
917 let tab_point = self.wrap_snapshot().to_tab_point(wrap_point);
918 self.tab_snapshot().to_fold_point(tab_point, bias).0
919 }
920
921 pub fn fold_point_to_display_point(&self, fold_point: FoldPoint) -> DisplayPoint {
922 let tab_point = self.tab_snapshot().to_tab_point(fold_point);
923 let wrap_point = self.wrap_snapshot().tab_point_to_wrap_point(tab_point);
924 let block_point = self.block_snapshot.to_block_point(wrap_point);
925 DisplayPoint(block_point)
926 }
927
928 pub fn max_point(&self) -> DisplayPoint {
929 DisplayPoint(self.block_snapshot.max_point())
930 }
931
932 /// Returns text chunks starting at the given display row until the end of the file
933 pub fn text_chunks(&self, display_row: DisplayRow) -> impl Iterator<Item = &str> {
934 self.block_snapshot
935 .chunks(
936 display_row.0..self.max_point().row().next_row().0,
937 false,
938 self.masked,
939 Highlights::default(),
940 )
941 .map(|h| h.text)
942 }
943
944 /// Returns text chunks starting at the end of the given display row in reverse until the start of the file
945 pub fn reverse_text_chunks(&self, display_row: DisplayRow) -> impl Iterator<Item = &str> {
946 (0..=display_row.0).rev().flat_map(move |row| {
947 self.block_snapshot
948 .chunks(row..row + 1, false, self.masked, Highlights::default())
949 .map(|h| h.text)
950 .collect::<Vec<_>>()
951 .into_iter()
952 .rev()
953 })
954 }
955
956 pub fn chunks(
957 &self,
958 display_rows: Range<DisplayRow>,
959 language_aware: bool,
960 highlight_styles: HighlightStyles,
961 ) -> DisplayChunks<'_> {
962 self.block_snapshot.chunks(
963 display_rows.start.0..display_rows.end.0,
964 language_aware,
965 self.masked,
966 Highlights {
967 text_highlights: Some(&self.text_highlights),
968 inlay_highlights: Some(&self.inlay_highlights),
969 styles: highlight_styles,
970 },
971 )
972 }
973
974 pub fn highlighted_chunks<'a>(
975 &'a self,
976 display_rows: Range<DisplayRow>,
977 language_aware: bool,
978 editor_style: &'a EditorStyle,
979 ) -> impl Iterator<Item = HighlightedChunk<'a>> {
980 self.chunks(
981 display_rows,
982 language_aware,
983 HighlightStyles {
984 inlay_hint: Some(editor_style.inlay_hints_style),
985 edit_prediction: Some(editor_style.edit_prediction_styles),
986 },
987 )
988 .flat_map(|chunk| {
989 let highlight_style = chunk
990 .syntax_highlight_id
991 .and_then(|id| id.style(&editor_style.syntax));
992
993 let chunk_highlight = chunk.highlight_style.map(|chunk_highlight| {
994 HighlightStyle {
995 // For color inlays, blend the color with the editor background
996 // if the color has transparency (alpha < 1.0)
997 color: chunk_highlight.color.map(|color| {
998 if chunk.is_inlay && !color.is_opaque() {
999 editor_style.background.blend(color)
1000 } else {
1001 color
1002 }
1003 }),
1004 ..chunk_highlight
1005 }
1006 });
1007
1008 let diagnostic_highlight = chunk
1009 .diagnostic_severity
1010 .filter(|severity| {
1011 self.diagnostics_max_severity
1012 .into_lsp()
1013 .is_some_and(|max_severity| severity <= &max_severity)
1014 })
1015 .map(|severity| HighlightStyle {
1016 fade_out: chunk
1017 .is_unnecessary
1018 .then_some(editor_style.unnecessary_code_fade),
1019 underline: (chunk.underline
1020 && editor_style.show_underlines
1021 && !(chunk.is_unnecessary && severity > lsp::DiagnosticSeverity::WARNING))
1022 .then(|| {
1023 let diagnostic_color =
1024 super::diagnostic_style(severity, &editor_style.status);
1025 UnderlineStyle {
1026 color: Some(diagnostic_color),
1027 thickness: 1.0.into(),
1028 wavy: true,
1029 }
1030 }),
1031 ..Default::default()
1032 });
1033
1034 let style = [highlight_style, chunk_highlight, diagnostic_highlight]
1035 .into_iter()
1036 .flatten()
1037 .reduce(|acc, highlight| acc.highlight(highlight));
1038
1039 HighlightedChunk {
1040 text: chunk.text,
1041 style,
1042 is_tab: chunk.is_tab,
1043 is_inlay: chunk.is_inlay,
1044 replacement: chunk.renderer.map(ChunkReplacement::Renderer),
1045 }
1046 .highlight_invisibles(editor_style)
1047 })
1048 }
1049
1050 pub fn layout_row(
1051 &self,
1052 display_row: DisplayRow,
1053 TextLayoutDetails {
1054 text_system,
1055 editor_style,
1056 rem_size,
1057 scroll_anchor: _,
1058 visible_rows: _,
1059 vertical_scroll_margin: _,
1060 }: &TextLayoutDetails,
1061 ) -> Arc<LineLayout> {
1062 let mut runs = Vec::new();
1063 let mut line = String::new();
1064
1065 let range = display_row..display_row.next_row();
1066 for chunk in self.highlighted_chunks(range, false, editor_style) {
1067 line.push_str(chunk.text);
1068
1069 let text_style = if let Some(style) = chunk.style {
1070 Cow::Owned(editor_style.text.clone().highlight(style))
1071 } else {
1072 Cow::Borrowed(&editor_style.text)
1073 };
1074
1075 runs.push(text_style.to_run(chunk.text.len()))
1076 }
1077
1078 if line.ends_with('\n') {
1079 line.pop();
1080 if let Some(last_run) = runs.last_mut() {
1081 last_run.len -= 1;
1082 if last_run.len == 0 {
1083 runs.pop();
1084 }
1085 }
1086 }
1087
1088 let font_size = editor_style.text.font_size.to_pixels(*rem_size);
1089 text_system.layout_line(&line, font_size, &runs, None)
1090 }
1091
1092 pub fn x_for_display_point(
1093 &self,
1094 display_point: DisplayPoint,
1095 text_layout_details: &TextLayoutDetails,
1096 ) -> Pixels {
1097 let line = self.layout_row(display_point.row(), text_layout_details);
1098 line.x_for_index(display_point.column() as usize)
1099 }
1100
1101 pub fn display_column_for_x(
1102 &self,
1103 display_row: DisplayRow,
1104 x: Pixels,
1105 details: &TextLayoutDetails,
1106 ) -> u32 {
1107 let layout_line = self.layout_row(display_row, details);
1108 layout_line.closest_index_for_x(x) as u32
1109 }
1110
1111 pub fn grapheme_at(&self, mut point: DisplayPoint) -> Option<SharedString> {
1112 point = DisplayPoint(self.block_snapshot.clip_point(point.0, Bias::Left));
1113 let chars = self
1114 .text_chunks(point.row())
1115 .flat_map(str::chars)
1116 .skip_while({
1117 let mut column = 0;
1118 move |char| {
1119 let at_point = column >= point.column();
1120 column += char.len_utf8() as u32;
1121 !at_point
1122 }
1123 })
1124 .take_while({
1125 let mut prev = false;
1126 move |char| {
1127 let now = char.is_ascii();
1128 let end = char.is_ascii() && (char.is_ascii_whitespace() || prev);
1129 prev = now;
1130 !end
1131 }
1132 });
1133 chars.collect::<String>().graphemes(true).next().map(|s| {
1134 if let Some(invisible) = s.chars().next().filter(|&c| is_invisible(c)) {
1135 replacement(invisible).unwrap_or(s).to_owned().into()
1136 } else if s == "\n" {
1137 " ".into()
1138 } else {
1139 s.to_owned().into()
1140 }
1141 })
1142 }
1143
1144 pub fn buffer_chars_at(&self, mut offset: usize) -> impl Iterator<Item = (char, usize)> + '_ {
1145 self.buffer_snapshot().chars_at(offset).map(move |ch| {
1146 let ret = (ch, offset);
1147 offset += ch.len_utf8();
1148 ret
1149 })
1150 }
1151
1152 pub fn reverse_buffer_chars_at(
1153 &self,
1154 mut offset: usize,
1155 ) -> impl Iterator<Item = (char, usize)> + '_ {
1156 self.buffer_snapshot()
1157 .reversed_chars_at(offset)
1158 .map(move |ch| {
1159 offset -= ch.len_utf8();
1160 (ch, offset)
1161 })
1162 }
1163
1164 pub fn clip_point(&self, point: DisplayPoint, bias: Bias) -> DisplayPoint {
1165 let mut clipped = self.block_snapshot.clip_point(point.0, bias);
1166 if self.clip_at_line_ends {
1167 clipped = self.clip_at_line_end(DisplayPoint(clipped)).0
1168 }
1169 DisplayPoint(clipped)
1170 }
1171
1172 pub fn clip_ignoring_line_ends(&self, point: DisplayPoint, bias: Bias) -> DisplayPoint {
1173 DisplayPoint(self.block_snapshot.clip_point(point.0, bias))
1174 }
1175
1176 pub fn clip_at_line_end(&self, display_point: DisplayPoint) -> DisplayPoint {
1177 let mut point = self.display_point_to_point(display_point, Bias::Left);
1178
1179 if point.column != self.buffer_snapshot().line_len(MultiBufferRow(point.row)) {
1180 return display_point;
1181 }
1182 point.column = point.column.saturating_sub(1);
1183 point = self.buffer_snapshot().clip_point(point, Bias::Left);
1184 self.point_to_display_point(point, Bias::Left)
1185 }
1186
1187 pub fn folds_in_range<T>(&self, range: Range<T>) -> impl Iterator<Item = &Fold>
1188 where
1189 T: ToOffset,
1190 {
1191 self.fold_snapshot().folds_in_range(range)
1192 }
1193
1194 pub fn blocks_in_range(
1195 &self,
1196 rows: Range<DisplayRow>,
1197 ) -> impl Iterator<Item = (DisplayRow, &Block)> {
1198 self.block_snapshot
1199 .blocks_in_range(rows.start.0..rows.end.0)
1200 .map(|(row, block)| (DisplayRow(row), block))
1201 }
1202
1203 pub fn sticky_header_excerpt(&self, row: f64) -> Option<StickyHeaderExcerpt<'_>> {
1204 self.block_snapshot.sticky_header_excerpt(row)
1205 }
1206
1207 pub fn block_for_id(&self, id: BlockId) -> Option<Block> {
1208 self.block_snapshot.block_for_id(id)
1209 }
1210
1211 pub fn intersects_fold<T: ToOffset>(&self, offset: T) -> bool {
1212 self.fold_snapshot().intersects_fold(offset)
1213 }
1214
1215 pub fn is_line_folded(&self, buffer_row: MultiBufferRow) -> bool {
1216 self.block_snapshot.is_line_replaced(buffer_row)
1217 || self.fold_snapshot().is_line_folded(buffer_row)
1218 }
1219
1220 pub fn is_block_line(&self, display_row: DisplayRow) -> bool {
1221 self.block_snapshot.is_block_line(BlockRow(display_row.0))
1222 }
1223
1224 pub fn is_folded_buffer_header(&self, display_row: DisplayRow) -> bool {
1225 self.block_snapshot
1226 .is_folded_buffer_header(BlockRow(display_row.0))
1227 }
1228
1229 pub fn soft_wrap_indent(&self, display_row: DisplayRow) -> Option<u32> {
1230 let wrap_row = self
1231 .block_snapshot
1232 .to_wrap_point(BlockPoint::new(display_row.0, 0), Bias::Left)
1233 .row();
1234 self.wrap_snapshot().soft_wrap_indent(wrap_row)
1235 }
1236
1237 pub fn text(&self) -> String {
1238 self.text_chunks(DisplayRow(0)).collect()
1239 }
1240
1241 pub fn line(&self, display_row: DisplayRow) -> String {
1242 let mut result = String::new();
1243 for chunk in self.text_chunks(display_row) {
1244 if let Some(ix) = chunk.find('\n') {
1245 result.push_str(&chunk[0..ix]);
1246 break;
1247 } else {
1248 result.push_str(chunk);
1249 }
1250 }
1251 result
1252 }
1253
1254 pub fn line_indent_for_buffer_row(&self, buffer_row: MultiBufferRow) -> LineIndent {
1255 self.buffer_snapshot().line_indent_for_row(buffer_row)
1256 }
1257
1258 pub fn line_len(&self, row: DisplayRow) -> u32 {
1259 self.block_snapshot.line_len(BlockRow(row.0))
1260 }
1261
1262 pub fn longest_row(&self) -> DisplayRow {
1263 DisplayRow(self.block_snapshot.longest_row())
1264 }
1265
1266 pub fn longest_row_in_range(&self, range: Range<DisplayRow>) -> DisplayRow {
1267 let block_range = BlockRow(range.start.0)..BlockRow(range.end.0);
1268 let longest_row = self.block_snapshot.longest_row_in_range(block_range);
1269 DisplayRow(longest_row.0)
1270 }
1271
1272 pub fn starts_indent(&self, buffer_row: MultiBufferRow) -> bool {
1273 let max_row = self.buffer_snapshot().max_row();
1274 if buffer_row >= max_row {
1275 return false;
1276 }
1277
1278 let line_indent = self.line_indent_for_buffer_row(buffer_row);
1279 if line_indent.is_line_blank() {
1280 return false;
1281 }
1282
1283 (buffer_row.0 + 1..=max_row.0)
1284 .find_map(|next_row| {
1285 let next_line_indent = self.line_indent_for_buffer_row(MultiBufferRow(next_row));
1286 if next_line_indent.raw_len() > line_indent.raw_len() {
1287 Some(true)
1288 } else if !next_line_indent.is_line_blank() {
1289 Some(false)
1290 } else {
1291 None
1292 }
1293 })
1294 .unwrap_or(false)
1295 }
1296
1297 pub fn crease_for_buffer_row(&self, buffer_row: MultiBufferRow) -> Option<Crease<Point>> {
1298 let start =
1299 MultiBufferPoint::new(buffer_row.0, self.buffer_snapshot().line_len(buffer_row));
1300 if let Some(crease) = self
1301 .crease_snapshot
1302 .query_row(buffer_row, self.buffer_snapshot())
1303 {
1304 match crease {
1305 Crease::Inline {
1306 range,
1307 placeholder,
1308 render_toggle,
1309 render_trailer,
1310 metadata,
1311 } => Some(Crease::Inline {
1312 range: range.to_point(self.buffer_snapshot()),
1313 placeholder: placeholder.clone(),
1314 render_toggle: render_toggle.clone(),
1315 render_trailer: render_trailer.clone(),
1316 metadata: metadata.clone(),
1317 }),
1318 Crease::Block {
1319 range,
1320 block_height,
1321 block_style,
1322 render_block,
1323 block_priority,
1324 render_toggle,
1325 } => Some(Crease::Block {
1326 range: range.to_point(self.buffer_snapshot()),
1327 block_height: *block_height,
1328 block_style: *block_style,
1329 render_block: render_block.clone(),
1330 block_priority: *block_priority,
1331 render_toggle: render_toggle.clone(),
1332 }),
1333 }
1334 } else if self.starts_indent(MultiBufferRow(start.row))
1335 && !self.is_line_folded(MultiBufferRow(start.row))
1336 {
1337 let start_line_indent = self.line_indent_for_buffer_row(buffer_row);
1338 let max_point = self.buffer_snapshot().max_point();
1339 let mut end = None;
1340
1341 for row in (buffer_row.0 + 1)..=max_point.row {
1342 let line_indent = self.line_indent_for_buffer_row(MultiBufferRow(row));
1343 if !line_indent.is_line_blank()
1344 && line_indent.raw_len() <= start_line_indent.raw_len()
1345 {
1346 let prev_row = row - 1;
1347 end = Some(Point::new(
1348 prev_row,
1349 self.buffer_snapshot().line_len(MultiBufferRow(prev_row)),
1350 ));
1351 break;
1352 }
1353 }
1354
1355 let mut row_before_line_breaks = end.unwrap_or(max_point);
1356 while row_before_line_breaks.row > start.row
1357 && self
1358 .buffer_snapshot()
1359 .is_line_blank(MultiBufferRow(row_before_line_breaks.row))
1360 {
1361 row_before_line_breaks.row -= 1;
1362 }
1363
1364 row_before_line_breaks = Point::new(
1365 row_before_line_breaks.row,
1366 self.buffer_snapshot()
1367 .line_len(MultiBufferRow(row_before_line_breaks.row)),
1368 );
1369
1370 Some(Crease::Inline {
1371 range: start..row_before_line_breaks,
1372 placeholder: self.fold_placeholder.clone(),
1373 render_toggle: None,
1374 render_trailer: None,
1375 metadata: None,
1376 })
1377 } else {
1378 None
1379 }
1380 }
1381
1382 #[cfg(any(test, feature = "test-support"))]
1383 pub fn text_highlight_ranges<Tag: ?Sized + 'static>(
1384 &self,
1385 ) -> Option<Arc<(HighlightStyle, Vec<Range<Anchor>>)>> {
1386 let type_id = TypeId::of::<Tag>();
1387 self.text_highlights
1388 .get(&HighlightKey::Type(type_id))
1389 .cloned()
1390 }
1391
1392 #[allow(unused)]
1393 #[cfg(any(test, feature = "test-support"))]
1394 pub(crate) fn inlay_highlights<Tag: ?Sized + 'static>(
1395 &self,
1396 ) -> Option<&TreeMap<InlayId, (HighlightStyle, InlayHighlight)>> {
1397 let type_id = TypeId::of::<Tag>();
1398 self.inlay_highlights.get(&type_id)
1399 }
1400
1401 pub fn buffer_header_height(&self) -> u32 {
1402 self.block_snapshot.buffer_header_height
1403 }
1404
1405 pub fn excerpt_header_height(&self) -> u32 {
1406 self.block_snapshot.excerpt_header_height
1407 }
1408}
1409
1410#[derive(Copy, Clone, Default, Eq, Ord, PartialOrd, PartialEq)]
1411pub struct DisplayPoint(BlockPoint);
1412
1413impl Debug for DisplayPoint {
1414 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1415 f.write_fmt(format_args!(
1416 "DisplayPoint({}, {})",
1417 self.row().0,
1418 self.column()
1419 ))
1420 }
1421}
1422
1423impl Add for DisplayPoint {
1424 type Output = Self;
1425
1426 fn add(self, other: Self) -> Self::Output {
1427 DisplayPoint(BlockPoint(self.0.0 + other.0.0))
1428 }
1429}
1430
1431impl Sub for DisplayPoint {
1432 type Output = Self;
1433
1434 fn sub(self, other: Self) -> Self::Output {
1435 DisplayPoint(BlockPoint(self.0.0 - other.0.0))
1436 }
1437}
1438
1439#[derive(Debug, Copy, Clone, Default, Eq, Ord, PartialOrd, PartialEq, Deserialize, Hash)]
1440#[serde(transparent)]
1441pub struct DisplayRow(pub u32);
1442
1443impl Add<DisplayRow> for DisplayRow {
1444 type Output = Self;
1445
1446 fn add(self, other: Self) -> Self::Output {
1447 DisplayRow(self.0 + other.0)
1448 }
1449}
1450
1451impl Add<u32> for DisplayRow {
1452 type Output = Self;
1453
1454 fn add(self, other: u32) -> Self::Output {
1455 DisplayRow(self.0 + other)
1456 }
1457}
1458
1459impl Sub<DisplayRow> for DisplayRow {
1460 type Output = Self;
1461
1462 fn sub(self, other: Self) -> Self::Output {
1463 DisplayRow(self.0 - other.0)
1464 }
1465}
1466
1467impl Sub<u32> for DisplayRow {
1468 type Output = Self;
1469
1470 fn sub(self, other: u32) -> Self::Output {
1471 DisplayRow(self.0 - other)
1472 }
1473}
1474
1475impl DisplayPoint {
1476 pub fn new(row: DisplayRow, column: u32) -> Self {
1477 Self(BlockPoint(Point::new(row.0, column)))
1478 }
1479
1480 pub fn zero() -> Self {
1481 Self::new(DisplayRow(0), 0)
1482 }
1483
1484 pub fn is_zero(&self) -> bool {
1485 self.0.is_zero()
1486 }
1487
1488 pub fn row(self) -> DisplayRow {
1489 DisplayRow(self.0.row)
1490 }
1491
1492 pub fn column(self) -> u32 {
1493 self.0.column
1494 }
1495
1496 pub fn row_mut(&mut self) -> &mut u32 {
1497 &mut self.0.row
1498 }
1499
1500 pub fn column_mut(&mut self) -> &mut u32 {
1501 &mut self.0.column
1502 }
1503
1504 pub fn to_point(self, map: &DisplaySnapshot) -> Point {
1505 map.display_point_to_point(self, Bias::Left)
1506 }
1507
1508 pub fn to_offset(self, map: &DisplaySnapshot, bias: Bias) -> usize {
1509 let wrap_point = map.block_snapshot.to_wrap_point(self.0, bias);
1510 let tab_point = map.wrap_snapshot().to_tab_point(wrap_point);
1511 let fold_point = map.tab_snapshot().to_fold_point(tab_point, bias).0;
1512 let inlay_point = fold_point.to_inlay_point(map.fold_snapshot());
1513 map.inlay_snapshot()
1514 .to_buffer_offset(map.inlay_snapshot().to_offset(inlay_point))
1515 }
1516}
1517
1518impl ToDisplayPoint for usize {
1519 fn to_display_point(&self, map: &DisplaySnapshot) -> DisplayPoint {
1520 map.point_to_display_point(self.to_point(map.buffer_snapshot()), Bias::Left)
1521 }
1522}
1523
1524impl ToDisplayPoint for OffsetUtf16 {
1525 fn to_display_point(&self, map: &DisplaySnapshot) -> DisplayPoint {
1526 self.to_offset(map.buffer_snapshot()).to_display_point(map)
1527 }
1528}
1529
1530impl ToDisplayPoint for Point {
1531 fn to_display_point(&self, map: &DisplaySnapshot) -> DisplayPoint {
1532 map.point_to_display_point(*self, Bias::Left)
1533 }
1534}
1535
1536impl ToDisplayPoint for Anchor {
1537 fn to_display_point(&self, map: &DisplaySnapshot) -> DisplayPoint {
1538 self.to_point(map.buffer_snapshot()).to_display_point(map)
1539 }
1540}
1541
1542#[cfg(test)]
1543pub mod tests {
1544 use super::*;
1545 use crate::{
1546 movement,
1547 test::{marked_display_snapshot, test_font},
1548 };
1549 use Bias::*;
1550 use block_map::BlockPlacement;
1551 use gpui::{
1552 App, AppContext as _, BorrowAppContext, Element, Hsla, Rgba, div, font, observe, px,
1553 };
1554 use language::{
1555 Buffer, Diagnostic, DiagnosticEntry, DiagnosticSet, Language, LanguageConfig,
1556 LanguageMatcher,
1557 };
1558 use lsp::LanguageServerId;
1559 use project::Project;
1560 use rand::{Rng, prelude::*};
1561 use settings::{SettingsContent, SettingsStore};
1562 use smol::stream::StreamExt;
1563 use std::{env, sync::Arc};
1564 use text::PointUtf16;
1565 use theme::{LoadThemes, SyntaxTheme};
1566 use unindent::Unindent as _;
1567 use util::test::{marked_text_ranges, sample_text};
1568
1569 #[gpui::test(iterations = 100)]
1570 async fn test_random_display_map(cx: &mut gpui::TestAppContext, mut rng: StdRng) {
1571 cx.background_executor.set_block_on_ticks(0..=50);
1572 let operations = env::var("OPERATIONS")
1573 .map(|i| i.parse().expect("invalid `OPERATIONS` variable"))
1574 .unwrap_or(10);
1575
1576 let mut tab_size = rng.random_range(1..=4);
1577 let buffer_start_excerpt_header_height = rng.random_range(1..=5);
1578 let excerpt_header_height = rng.random_range(1..=5);
1579 let font_size = px(14.0);
1580 let max_wrap_width = 300.0;
1581 let mut wrap_width = if rng.random_bool(0.1) {
1582 None
1583 } else {
1584 Some(px(rng.random_range(0.0..=max_wrap_width)))
1585 };
1586
1587 log::info!("tab size: {}", tab_size);
1588 log::info!("wrap width: {:?}", wrap_width);
1589
1590 cx.update(|cx| {
1591 init_test(cx, |s| {
1592 s.project.all_languages.defaults.tab_size = NonZeroU32::new(tab_size)
1593 });
1594 });
1595
1596 let buffer = cx.update(|cx| {
1597 if rng.random() {
1598 let len = rng.random_range(0..10);
1599 let text = util::RandomCharIter::new(&mut rng)
1600 .take(len)
1601 .collect::<String>();
1602 MultiBuffer::build_simple(&text, cx)
1603 } else {
1604 MultiBuffer::build_random(&mut rng, cx)
1605 }
1606 });
1607
1608 let font = test_font();
1609 let map = cx.new(|cx| {
1610 DisplayMap::new(
1611 buffer.clone(),
1612 font,
1613 font_size,
1614 wrap_width,
1615 buffer_start_excerpt_header_height,
1616 excerpt_header_height,
1617 FoldPlaceholder::test(),
1618 DiagnosticSeverity::Warning,
1619 cx,
1620 )
1621 });
1622 let mut notifications = observe(&map, cx);
1623 let mut fold_count = 0;
1624 let mut blocks = Vec::new();
1625
1626 let snapshot = map.update(cx, |map, cx| map.snapshot(cx));
1627 log::info!("buffer text: {:?}", snapshot.buffer_snapshot().text());
1628 log::info!("fold text: {:?}", snapshot.fold_snapshot().text());
1629 log::info!("tab text: {:?}", snapshot.tab_snapshot().text());
1630 log::info!("wrap text: {:?}", snapshot.wrap_snapshot().text());
1631 log::info!("block text: {:?}", snapshot.block_snapshot.text());
1632 log::info!("display text: {:?}", snapshot.text());
1633
1634 for _i in 0..operations {
1635 match rng.random_range(0..100) {
1636 0..=19 => {
1637 wrap_width = if rng.random_bool(0.2) {
1638 None
1639 } else {
1640 Some(px(rng.random_range(0.0..=max_wrap_width)))
1641 };
1642 log::info!("setting wrap width to {:?}", wrap_width);
1643 map.update(cx, |map, cx| map.set_wrap_width(wrap_width, cx));
1644 }
1645 20..=29 => {
1646 let mut tab_sizes = vec![1, 2, 3, 4];
1647 tab_sizes.remove((tab_size - 1) as usize);
1648 tab_size = *tab_sizes.choose(&mut rng).unwrap();
1649 log::info!("setting tab size to {:?}", tab_size);
1650 cx.update(|cx| {
1651 cx.update_global::<SettingsStore, _>(|store, cx| {
1652 store.update_user_settings(cx, |s| {
1653 s.project.all_languages.defaults.tab_size =
1654 NonZeroU32::new(tab_size);
1655 });
1656 });
1657 });
1658 }
1659 30..=44 => {
1660 map.update(cx, |map, cx| {
1661 if rng.random() || blocks.is_empty() {
1662 let snapshot = map.snapshot(cx);
1663 let buffer = snapshot.buffer_snapshot();
1664 let block_properties = (0..rng.random_range(1..=1))
1665 .map(|_| {
1666 let position = buffer.anchor_after(buffer.clip_offset(
1667 rng.random_range(0..=buffer.len()),
1668 Bias::Left,
1669 ));
1670
1671 let placement = if rng.random() {
1672 BlockPlacement::Above(position)
1673 } else {
1674 BlockPlacement::Below(position)
1675 };
1676 let height = rng.random_range(1..5);
1677 log::info!(
1678 "inserting block {:?} with height {}",
1679 placement.as_ref().map(|p| p.to_point(&buffer)),
1680 height
1681 );
1682 let priority = rng.random_range(1..100);
1683 BlockProperties {
1684 placement,
1685 style: BlockStyle::Fixed,
1686 height: Some(height),
1687 render: Arc::new(|_| div().into_any()),
1688 priority,
1689 }
1690 })
1691 .collect::<Vec<_>>();
1692 blocks.extend(map.insert_blocks(block_properties, cx));
1693 } else {
1694 blocks.shuffle(&mut rng);
1695 let remove_count = rng.random_range(1..=4.min(blocks.len()));
1696 let block_ids_to_remove = (0..remove_count)
1697 .map(|_| blocks.remove(rng.random_range(0..blocks.len())))
1698 .collect();
1699 log::info!("removing block ids {:?}", block_ids_to_remove);
1700 map.remove_blocks(block_ids_to_remove, cx);
1701 }
1702 });
1703 }
1704 45..=79 => {
1705 let mut ranges = Vec::new();
1706 for _ in 0..rng.random_range(1..=3) {
1707 buffer.read_with(cx, |buffer, cx| {
1708 let buffer = buffer.read(cx);
1709 let end = buffer.clip_offset(rng.random_range(0..=buffer.len()), Right);
1710 let start = buffer.clip_offset(rng.random_range(0..=end), Left);
1711 ranges.push(start..end);
1712 });
1713 }
1714
1715 if rng.random() && fold_count > 0 {
1716 log::info!("unfolding ranges: {:?}", ranges);
1717 map.update(cx, |map, cx| {
1718 map.unfold_intersecting(ranges, true, cx);
1719 });
1720 } else {
1721 log::info!("folding ranges: {:?}", ranges);
1722 map.update(cx, |map, cx| {
1723 map.fold(
1724 ranges
1725 .into_iter()
1726 .map(|range| Crease::simple(range, FoldPlaceholder::test()))
1727 .collect(),
1728 cx,
1729 );
1730 });
1731 }
1732 }
1733 _ => {
1734 buffer.update(cx, |buffer, cx| buffer.randomly_mutate(&mut rng, 5, cx));
1735 }
1736 }
1737
1738 if map.read_with(cx, |map, cx| map.is_rewrapping(cx)) {
1739 notifications.next().await.unwrap();
1740 }
1741
1742 let snapshot = map.update(cx, |map, cx| map.snapshot(cx));
1743 fold_count = snapshot.fold_count();
1744 log::info!("buffer text: {:?}", snapshot.buffer_snapshot().text());
1745 log::info!("fold text: {:?}", snapshot.fold_snapshot().text());
1746 log::info!("tab text: {:?}", snapshot.tab_snapshot().text());
1747 log::info!("wrap text: {:?}", snapshot.wrap_snapshot().text());
1748 log::info!("block text: {:?}", snapshot.block_snapshot.text());
1749 log::info!("display text: {:?}", snapshot.text());
1750
1751 // Line boundaries
1752 let buffer = snapshot.buffer_snapshot();
1753 for _ in 0..5 {
1754 let row = rng.random_range(0..=buffer.max_point().row);
1755 let column = rng.random_range(0..=buffer.line_len(MultiBufferRow(row)));
1756 let point = buffer.clip_point(Point::new(row, column), Left);
1757
1758 let (prev_buffer_bound, prev_display_bound) = snapshot.prev_line_boundary(point);
1759 let (next_buffer_bound, next_display_bound) = snapshot.next_line_boundary(point);
1760
1761 assert!(prev_buffer_bound <= point);
1762 assert!(next_buffer_bound >= point);
1763 assert_eq!(prev_buffer_bound.column, 0);
1764 assert_eq!(prev_display_bound.column(), 0);
1765 if next_buffer_bound < buffer.max_point() {
1766 assert_eq!(buffer.chars_at(next_buffer_bound).next(), Some('\n'));
1767 }
1768
1769 assert_eq!(
1770 prev_display_bound,
1771 prev_buffer_bound.to_display_point(&snapshot),
1772 "row boundary before {:?}. reported buffer row boundary: {:?}",
1773 point,
1774 prev_buffer_bound
1775 );
1776 assert_eq!(
1777 next_display_bound,
1778 next_buffer_bound.to_display_point(&snapshot),
1779 "display row boundary after {:?}. reported buffer row boundary: {:?}",
1780 point,
1781 next_buffer_bound
1782 );
1783 assert_eq!(
1784 prev_buffer_bound,
1785 prev_display_bound.to_point(&snapshot),
1786 "row boundary before {:?}. reported display row boundary: {:?}",
1787 point,
1788 prev_display_bound
1789 );
1790 assert_eq!(
1791 next_buffer_bound,
1792 next_display_bound.to_point(&snapshot),
1793 "row boundary after {:?}. reported display row boundary: {:?}",
1794 point,
1795 next_display_bound
1796 );
1797 }
1798
1799 // Movement
1800 let min_point = snapshot.clip_point(DisplayPoint::new(DisplayRow(0), 0), Left);
1801 let max_point = snapshot.clip_point(snapshot.max_point(), Right);
1802 for _ in 0..5 {
1803 let row = rng.random_range(0..=snapshot.max_point().row().0);
1804 let column = rng.random_range(0..=snapshot.line_len(DisplayRow(row)));
1805 let point = snapshot.clip_point(DisplayPoint::new(DisplayRow(row), column), Left);
1806
1807 log::info!("Moving from point {:?}", point);
1808
1809 let moved_right = movement::right(&snapshot, point);
1810 log::info!("Right {:?}", moved_right);
1811 if point < max_point {
1812 assert!(moved_right > point);
1813 if point.column() == snapshot.line_len(point.row())
1814 || snapshot.soft_wrap_indent(point.row()).is_some()
1815 && point.column() == snapshot.line_len(point.row()) - 1
1816 {
1817 assert!(moved_right.row() > point.row());
1818 }
1819 } else {
1820 assert_eq!(moved_right, point);
1821 }
1822
1823 let moved_left = movement::left(&snapshot, point);
1824 log::info!("Left {:?}", moved_left);
1825 if point > min_point {
1826 assert!(moved_left < point);
1827 if point.column() == 0 {
1828 assert!(moved_left.row() < point.row());
1829 }
1830 } else {
1831 assert_eq!(moved_left, point);
1832 }
1833 }
1834 }
1835 }
1836
1837 #[gpui::test(retries = 5)]
1838 async fn test_soft_wraps(cx: &mut gpui::TestAppContext) {
1839 cx.background_executor
1840 .set_block_on_ticks(usize::MAX..=usize::MAX);
1841 cx.update(|cx| {
1842 init_test(cx, |_| {});
1843 });
1844
1845 let mut cx = crate::test::editor_test_context::EditorTestContext::new(cx).await;
1846 let editor = cx.editor.clone();
1847 let window = cx.window;
1848
1849 _ = cx.update_window(window, |_, window, cx| {
1850 let text_layout_details =
1851 editor.update(cx, |editor, _cx| editor.text_layout_details(window));
1852
1853 let font_size = px(12.0);
1854 let wrap_width = Some(px(96.));
1855
1856 let text = "one two three four five\nsix seven eight";
1857 let buffer = MultiBuffer::build_simple(text, cx);
1858 let map = cx.new(|cx| {
1859 DisplayMap::new(
1860 buffer.clone(),
1861 font("Helvetica"),
1862 font_size,
1863 wrap_width,
1864 1,
1865 1,
1866 FoldPlaceholder::test(),
1867 DiagnosticSeverity::Warning,
1868 cx,
1869 )
1870 });
1871
1872 let snapshot = map.update(cx, |map, cx| map.snapshot(cx));
1873 assert_eq!(
1874 snapshot.text_chunks(DisplayRow(0)).collect::<String>(),
1875 "one two \nthree four \nfive\nsix seven \neight"
1876 );
1877 assert_eq!(
1878 snapshot.clip_point(DisplayPoint::new(DisplayRow(0), 8), Bias::Left),
1879 DisplayPoint::new(DisplayRow(0), 7)
1880 );
1881 assert_eq!(
1882 snapshot.clip_point(DisplayPoint::new(DisplayRow(0), 8), Bias::Right),
1883 DisplayPoint::new(DisplayRow(1), 0)
1884 );
1885 assert_eq!(
1886 movement::right(&snapshot, DisplayPoint::new(DisplayRow(0), 7)),
1887 DisplayPoint::new(DisplayRow(1), 0)
1888 );
1889 assert_eq!(
1890 movement::left(&snapshot, DisplayPoint::new(DisplayRow(1), 0)),
1891 DisplayPoint::new(DisplayRow(0), 7)
1892 );
1893
1894 let x = snapshot
1895 .x_for_display_point(DisplayPoint::new(DisplayRow(1), 10), &text_layout_details);
1896 assert_eq!(
1897 movement::up(
1898 &snapshot,
1899 DisplayPoint::new(DisplayRow(1), 10),
1900 language::SelectionGoal::None,
1901 false,
1902 &text_layout_details,
1903 ),
1904 (
1905 DisplayPoint::new(DisplayRow(0), 7),
1906 language::SelectionGoal::HorizontalPosition(f64::from(x))
1907 )
1908 );
1909 assert_eq!(
1910 movement::down(
1911 &snapshot,
1912 DisplayPoint::new(DisplayRow(0), 7),
1913 language::SelectionGoal::HorizontalPosition(f64::from(x)),
1914 false,
1915 &text_layout_details
1916 ),
1917 (
1918 DisplayPoint::new(DisplayRow(1), 10),
1919 language::SelectionGoal::HorizontalPosition(f64::from(x))
1920 )
1921 );
1922 assert_eq!(
1923 movement::down(
1924 &snapshot,
1925 DisplayPoint::new(DisplayRow(1), 10),
1926 language::SelectionGoal::HorizontalPosition(f64::from(x)),
1927 false,
1928 &text_layout_details
1929 ),
1930 (
1931 DisplayPoint::new(DisplayRow(2), 4),
1932 language::SelectionGoal::HorizontalPosition(f64::from(x))
1933 )
1934 );
1935
1936 let ix = snapshot.buffer_snapshot().text().find("seven").unwrap();
1937 buffer.update(cx, |buffer, cx| {
1938 buffer.edit([(ix..ix, "and ")], None, cx);
1939 });
1940
1941 let snapshot = map.update(cx, |map, cx| map.snapshot(cx));
1942 assert_eq!(
1943 snapshot.text_chunks(DisplayRow(1)).collect::<String>(),
1944 "three four \nfive\nsix and \nseven eight"
1945 );
1946
1947 // Re-wrap on font size changes
1948 map.update(cx, |map, cx| {
1949 map.set_font(font("Helvetica"), font_size + Pixels::from(3.), cx)
1950 });
1951
1952 let snapshot = map.update(cx, |map, cx| map.snapshot(cx));
1953 assert_eq!(
1954 snapshot.text_chunks(DisplayRow(1)).collect::<String>(),
1955 "three \nfour five\nsix and \nseven \neight"
1956 )
1957 });
1958 }
1959
1960 #[gpui::test]
1961 fn test_text_chunks(cx: &mut gpui::App) {
1962 init_test(cx, |_| {});
1963
1964 let text = sample_text(6, 6, 'a');
1965 let buffer = MultiBuffer::build_simple(&text, cx);
1966
1967 let font_size = px(14.0);
1968 let map = cx.new(|cx| {
1969 DisplayMap::new(
1970 buffer.clone(),
1971 font("Helvetica"),
1972 font_size,
1973 None,
1974 1,
1975 1,
1976 FoldPlaceholder::test(),
1977 DiagnosticSeverity::Warning,
1978 cx,
1979 )
1980 });
1981
1982 buffer.update(cx, |buffer, cx| {
1983 buffer.edit(
1984 vec![
1985 (
1986 MultiBufferPoint::new(1, 0)..MultiBufferPoint::new(1, 0),
1987 "\t",
1988 ),
1989 (
1990 MultiBufferPoint::new(1, 1)..MultiBufferPoint::new(1, 1),
1991 "\t",
1992 ),
1993 (
1994 MultiBufferPoint::new(2, 1)..MultiBufferPoint::new(2, 1),
1995 "\t",
1996 ),
1997 ],
1998 None,
1999 cx,
2000 )
2001 });
2002
2003 assert_eq!(
2004 map.update(cx, |map, cx| map.snapshot(cx))
2005 .text_chunks(DisplayRow(1))
2006 .collect::<String>()
2007 .lines()
2008 .next(),
2009 Some(" b bbbbb")
2010 );
2011 assert_eq!(
2012 map.update(cx, |map, cx| map.snapshot(cx))
2013 .text_chunks(DisplayRow(2))
2014 .collect::<String>()
2015 .lines()
2016 .next(),
2017 Some("c ccccc")
2018 );
2019 }
2020
2021 #[gpui::test]
2022 fn test_inlays_with_newlines_after_blocks(cx: &mut gpui::TestAppContext) {
2023 cx.update(|cx| init_test(cx, |_| {}));
2024
2025 let buffer = cx.new(|cx| Buffer::local("a", cx));
2026 let buffer = cx.new(|cx| MultiBuffer::singleton(buffer, cx));
2027 let buffer_snapshot = buffer.read_with(cx, |buffer, cx| buffer.snapshot(cx));
2028
2029 let font_size = px(14.0);
2030 let map = cx.new(|cx| {
2031 DisplayMap::new(
2032 buffer.clone(),
2033 font("Helvetica"),
2034 font_size,
2035 None,
2036 1,
2037 1,
2038 FoldPlaceholder::test(),
2039 DiagnosticSeverity::Warning,
2040 cx,
2041 )
2042 });
2043
2044 map.update(cx, |map, cx| {
2045 map.insert_blocks(
2046 [BlockProperties {
2047 placement: BlockPlacement::Above(
2048 buffer_snapshot.anchor_before(Point::new(0, 0)),
2049 ),
2050 height: Some(2),
2051 style: BlockStyle::Sticky,
2052 render: Arc::new(|_| div().into_any()),
2053 priority: 0,
2054 }],
2055 cx,
2056 );
2057 });
2058 map.update(cx, |m, cx| assert_eq!(m.snapshot(cx).text(), "\n\na"));
2059
2060 map.update(cx, |map, cx| {
2061 map.splice_inlays(
2062 &[],
2063 vec![Inlay::edit_prediction(
2064 0,
2065 buffer_snapshot.anchor_after(0),
2066 "\n",
2067 )],
2068 cx,
2069 );
2070 });
2071 map.update(cx, |m, cx| assert_eq!(m.snapshot(cx).text(), "\n\n\na"));
2072
2073 // Regression test: updating the display map does not crash when a
2074 // block is immediately followed by a multi-line inlay.
2075 buffer.update(cx, |buffer, cx| {
2076 buffer.edit([(1..1, "b")], None, cx);
2077 });
2078 map.update(cx, |m, cx| assert_eq!(m.snapshot(cx).text(), "\n\n\nab"));
2079 }
2080
2081 #[gpui::test]
2082 async fn test_chunks(cx: &mut gpui::TestAppContext) {
2083 let text = r#"
2084 fn outer() {}
2085
2086 mod module {
2087 fn inner() {}
2088 }"#
2089 .unindent();
2090
2091 let theme =
2092 SyntaxTheme::new_test(vec![("mod.body", Hsla::red()), ("fn.name", Hsla::blue())]);
2093 let language = Arc::new(
2094 Language::new(
2095 LanguageConfig {
2096 name: "Test".into(),
2097 matcher: LanguageMatcher {
2098 path_suffixes: vec![".test".to_string()],
2099 ..Default::default()
2100 },
2101 ..Default::default()
2102 },
2103 Some(tree_sitter_rust::LANGUAGE.into()),
2104 )
2105 .with_highlights_query(
2106 r#"
2107 (mod_item name: (identifier) body: _ @mod.body)
2108 (function_item name: (identifier) @fn.name)
2109 "#,
2110 )
2111 .unwrap(),
2112 );
2113 language.set_theme(&theme);
2114
2115 cx.update(|cx| {
2116 init_test(cx, |s| {
2117 s.project.all_languages.defaults.tab_size = Some(2.try_into().unwrap())
2118 })
2119 });
2120
2121 let buffer = cx.new(|cx| Buffer::local(text, cx).with_language(language, cx));
2122 cx.condition(&buffer, |buf, _| !buf.is_parsing()).await;
2123 let buffer = cx.new(|cx| MultiBuffer::singleton(buffer, cx));
2124
2125 let font_size = px(14.0);
2126
2127 let map = cx.new(|cx| {
2128 DisplayMap::new(
2129 buffer,
2130 font("Helvetica"),
2131 font_size,
2132 None,
2133 1,
2134 1,
2135 FoldPlaceholder::test(),
2136 DiagnosticSeverity::Warning,
2137 cx,
2138 )
2139 });
2140 assert_eq!(
2141 cx.update(|cx| syntax_chunks(DisplayRow(0)..DisplayRow(5), &map, &theme, cx)),
2142 vec![
2143 ("fn ".to_string(), None),
2144 ("outer".to_string(), Some(Hsla::blue())),
2145 ("() {}\n\nmod module ".to_string(), None),
2146 ("{\n fn ".to_string(), Some(Hsla::red())),
2147 ("inner".to_string(), Some(Hsla::blue())),
2148 ("() {}\n}".to_string(), Some(Hsla::red())),
2149 ]
2150 );
2151 assert_eq!(
2152 cx.update(|cx| syntax_chunks(DisplayRow(3)..DisplayRow(5), &map, &theme, cx)),
2153 vec![
2154 (" fn ".to_string(), Some(Hsla::red())),
2155 ("inner".to_string(), Some(Hsla::blue())),
2156 ("() {}\n}".to_string(), Some(Hsla::red())),
2157 ]
2158 );
2159
2160 map.update(cx, |map, cx| {
2161 map.fold(
2162 vec![Crease::simple(
2163 MultiBufferPoint::new(0, 6)..MultiBufferPoint::new(3, 2),
2164 FoldPlaceholder::test(),
2165 )],
2166 cx,
2167 )
2168 });
2169 assert_eq!(
2170 cx.update(|cx| syntax_chunks(DisplayRow(0)..DisplayRow(2), &map, &theme, cx)),
2171 vec![
2172 ("fn ".to_string(), None),
2173 ("out".to_string(), Some(Hsla::blue())),
2174 ("⋯".to_string(), None),
2175 (" fn ".to_string(), Some(Hsla::red())),
2176 ("inner".to_string(), Some(Hsla::blue())),
2177 ("() {}\n}".to_string(), Some(Hsla::red())),
2178 ]
2179 );
2180 }
2181
2182 #[gpui::test]
2183 async fn test_chunks_with_syntax_highlighting_across_blocks(cx: &mut gpui::TestAppContext) {
2184 cx.background_executor
2185 .set_block_on_ticks(usize::MAX..=usize::MAX);
2186
2187 let text = r#"
2188 const A: &str = "
2189 one
2190 two
2191 three
2192 ";
2193 const B: &str = "four";
2194 "#
2195 .unindent();
2196
2197 let theme = SyntaxTheme::new_test(vec![
2198 ("string", Hsla::red()),
2199 ("punctuation", Hsla::blue()),
2200 ("keyword", Hsla::green()),
2201 ]);
2202 let language = Arc::new(
2203 Language::new(
2204 LanguageConfig {
2205 name: "Rust".into(),
2206 ..Default::default()
2207 },
2208 Some(tree_sitter_rust::LANGUAGE.into()),
2209 )
2210 .with_highlights_query(
2211 r#"
2212 (string_literal) @string
2213 "const" @keyword
2214 [":" ";"] @punctuation
2215 "#,
2216 )
2217 .unwrap(),
2218 );
2219 language.set_theme(&theme);
2220
2221 cx.update(|cx| init_test(cx, |_| {}));
2222
2223 let buffer = cx.new(|cx| Buffer::local(text, cx).with_language(language, cx));
2224 cx.condition(&buffer, |buf, _| !buf.is_parsing()).await;
2225 let buffer = cx.new(|cx| MultiBuffer::singleton(buffer, cx));
2226 let buffer_snapshot = buffer.read_with(cx, |buffer, cx| buffer.snapshot(cx));
2227
2228 let map = cx.new(|cx| {
2229 DisplayMap::new(
2230 buffer,
2231 font("Courier"),
2232 px(16.0),
2233 None,
2234 1,
2235 1,
2236 FoldPlaceholder::test(),
2237 DiagnosticSeverity::Warning,
2238 cx,
2239 )
2240 });
2241
2242 // Insert two blocks in the middle of a multi-line string literal.
2243 // The second block has zero height.
2244 map.update(cx, |map, cx| {
2245 map.insert_blocks(
2246 [
2247 BlockProperties {
2248 placement: BlockPlacement::Below(
2249 buffer_snapshot.anchor_before(Point::new(1, 0)),
2250 ),
2251 height: Some(1),
2252 style: BlockStyle::Sticky,
2253 render: Arc::new(|_| div().into_any()),
2254 priority: 0,
2255 },
2256 BlockProperties {
2257 placement: BlockPlacement::Below(
2258 buffer_snapshot.anchor_before(Point::new(2, 0)),
2259 ),
2260 height: None,
2261 style: BlockStyle::Sticky,
2262 render: Arc::new(|_| div().into_any()),
2263 priority: 0,
2264 },
2265 ],
2266 cx,
2267 )
2268 });
2269
2270 pretty_assertions::assert_eq!(
2271 cx.update(|cx| syntax_chunks(DisplayRow(0)..DisplayRow(7), &map, &theme, cx)),
2272 [
2273 ("const".into(), Some(Hsla::green())),
2274 (" A".into(), None),
2275 (":".into(), Some(Hsla::blue())),
2276 (" &str = ".into(), None),
2277 ("\"\n one\n".into(), Some(Hsla::red())),
2278 ("\n".into(), None),
2279 (" two\n three\n\"".into(), Some(Hsla::red())),
2280 (";".into(), Some(Hsla::blue())),
2281 ("\n".into(), None),
2282 ("const".into(), Some(Hsla::green())),
2283 (" B".into(), None),
2284 (":".into(), Some(Hsla::blue())),
2285 (" &str = ".into(), None),
2286 ("\"four\"".into(), Some(Hsla::red())),
2287 (";".into(), Some(Hsla::blue())),
2288 ("\n".into(), None),
2289 ]
2290 );
2291 }
2292
2293 #[gpui::test]
2294 async fn test_chunks_with_diagnostics_across_blocks(cx: &mut gpui::TestAppContext) {
2295 cx.background_executor
2296 .set_block_on_ticks(usize::MAX..=usize::MAX);
2297
2298 let text = r#"
2299 struct A {
2300 b: usize;
2301 }
2302 const c: usize = 1;
2303 "#
2304 .unindent();
2305
2306 cx.update(|cx| init_test(cx, |_| {}));
2307
2308 let buffer = cx.new(|cx| Buffer::local(text, cx));
2309
2310 buffer.update(cx, |buffer, cx| {
2311 buffer.update_diagnostics(
2312 LanguageServerId(0),
2313 DiagnosticSet::new(
2314 [DiagnosticEntry {
2315 range: PointUtf16::new(0, 0)..PointUtf16::new(2, 1),
2316 diagnostic: Diagnostic {
2317 severity: lsp::DiagnosticSeverity::ERROR,
2318 group_id: 1,
2319 message: "hi".into(),
2320 ..Default::default()
2321 },
2322 }],
2323 buffer,
2324 ),
2325 cx,
2326 )
2327 });
2328
2329 let buffer = cx.new(|cx| MultiBuffer::singleton(buffer, cx));
2330 let buffer_snapshot = buffer.read_with(cx, |buffer, cx| buffer.snapshot(cx));
2331
2332 let map = cx.new(|cx| {
2333 DisplayMap::new(
2334 buffer,
2335 font("Courier"),
2336 px(16.0),
2337 None,
2338 1,
2339 1,
2340 FoldPlaceholder::test(),
2341 DiagnosticSeverity::Warning,
2342 cx,
2343 )
2344 });
2345
2346 let black = gpui::black().to_rgb();
2347 let red = gpui::red().to_rgb();
2348
2349 // Insert a block in the middle of a multi-line diagnostic.
2350 map.update(cx, |map, cx| {
2351 map.highlight_text(
2352 HighlightKey::Type(TypeId::of::<usize>()),
2353 vec![
2354 buffer_snapshot.anchor_before(Point::new(3, 9))
2355 ..buffer_snapshot.anchor_after(Point::new(3, 14)),
2356 buffer_snapshot.anchor_before(Point::new(3, 17))
2357 ..buffer_snapshot.anchor_after(Point::new(3, 18)),
2358 ],
2359 red.into(),
2360 );
2361 map.insert_blocks(
2362 [BlockProperties {
2363 placement: BlockPlacement::Below(
2364 buffer_snapshot.anchor_before(Point::new(1, 0)),
2365 ),
2366 height: Some(1),
2367 style: BlockStyle::Sticky,
2368 render: Arc::new(|_| div().into_any()),
2369 priority: 0,
2370 }],
2371 cx,
2372 )
2373 });
2374
2375 let snapshot = map.update(cx, |map, cx| map.snapshot(cx));
2376 let mut chunks = Vec::<(String, Option<lsp::DiagnosticSeverity>, Rgba)>::new();
2377 for chunk in snapshot.chunks(DisplayRow(0)..DisplayRow(5), true, Default::default()) {
2378 let color = chunk
2379 .highlight_style
2380 .and_then(|style| style.color)
2381 .map_or(black, |color| color.to_rgb());
2382 if let Some((last_chunk, last_severity, last_color)) = chunks.last_mut()
2383 && *last_severity == chunk.diagnostic_severity
2384 && *last_color == color
2385 {
2386 last_chunk.push_str(chunk.text);
2387 continue;
2388 }
2389
2390 chunks.push((chunk.text.to_string(), chunk.diagnostic_severity, color));
2391 }
2392
2393 assert_eq!(
2394 chunks,
2395 [
2396 (
2397 "struct A {\n b: usize;\n".into(),
2398 Some(lsp::DiagnosticSeverity::ERROR),
2399 black
2400 ),
2401 ("\n".into(), None, black),
2402 ("}".into(), Some(lsp::DiagnosticSeverity::ERROR), black),
2403 ("\nconst c: ".into(), None, black),
2404 ("usize".into(), None, red),
2405 (" = ".into(), None, black),
2406 ("1".into(), None, red),
2407 (";\n".into(), None, black),
2408 ]
2409 );
2410 }
2411
2412 #[gpui::test]
2413 async fn test_point_translation_with_replace_blocks(cx: &mut gpui::TestAppContext) {
2414 cx.background_executor
2415 .set_block_on_ticks(usize::MAX..=usize::MAX);
2416
2417 cx.update(|cx| init_test(cx, |_| {}));
2418
2419 let buffer = cx.update(|cx| MultiBuffer::build_simple("abcde\nfghij\nklmno\npqrst", cx));
2420 let buffer_snapshot = buffer.read_with(cx, |buffer, cx| buffer.snapshot(cx));
2421 let map = cx.new(|cx| {
2422 DisplayMap::new(
2423 buffer.clone(),
2424 font("Courier"),
2425 px(16.0),
2426 None,
2427 1,
2428 1,
2429 FoldPlaceholder::test(),
2430 DiagnosticSeverity::Warning,
2431 cx,
2432 )
2433 });
2434
2435 let snapshot = map.update(cx, |map, cx| {
2436 map.insert_blocks(
2437 [BlockProperties {
2438 placement: BlockPlacement::Replace(
2439 buffer_snapshot.anchor_before(Point::new(1, 2))
2440 ..=buffer_snapshot.anchor_after(Point::new(2, 3)),
2441 ),
2442 height: Some(4),
2443 style: BlockStyle::Fixed,
2444 render: Arc::new(|_| div().into_any()),
2445 priority: 0,
2446 }],
2447 cx,
2448 );
2449 map.snapshot(cx)
2450 });
2451
2452 assert_eq!(snapshot.text(), "abcde\n\n\n\n\npqrst");
2453
2454 let point_to_display_points = [
2455 (Point::new(1, 0), DisplayPoint::new(DisplayRow(1), 0)),
2456 (Point::new(2, 0), DisplayPoint::new(DisplayRow(1), 0)),
2457 (Point::new(3, 0), DisplayPoint::new(DisplayRow(5), 0)),
2458 ];
2459 for (buffer_point, display_point) in point_to_display_points {
2460 assert_eq!(
2461 snapshot.point_to_display_point(buffer_point, Bias::Left),
2462 display_point,
2463 "point_to_display_point({:?}, Bias::Left)",
2464 buffer_point
2465 );
2466 assert_eq!(
2467 snapshot.point_to_display_point(buffer_point, Bias::Right),
2468 display_point,
2469 "point_to_display_point({:?}, Bias::Right)",
2470 buffer_point
2471 );
2472 }
2473
2474 let display_points_to_points = [
2475 (
2476 DisplayPoint::new(DisplayRow(1), 0),
2477 Point::new(1, 0),
2478 Point::new(2, 5),
2479 ),
2480 (
2481 DisplayPoint::new(DisplayRow(2), 0),
2482 Point::new(1, 0),
2483 Point::new(2, 5),
2484 ),
2485 (
2486 DisplayPoint::new(DisplayRow(3), 0),
2487 Point::new(1, 0),
2488 Point::new(2, 5),
2489 ),
2490 (
2491 DisplayPoint::new(DisplayRow(4), 0),
2492 Point::new(1, 0),
2493 Point::new(2, 5),
2494 ),
2495 (
2496 DisplayPoint::new(DisplayRow(5), 0),
2497 Point::new(3, 0),
2498 Point::new(3, 0),
2499 ),
2500 ];
2501 for (display_point, left_buffer_point, right_buffer_point) in display_points_to_points {
2502 assert_eq!(
2503 snapshot.display_point_to_point(display_point, Bias::Left),
2504 left_buffer_point,
2505 "display_point_to_point({:?}, Bias::Left)",
2506 display_point
2507 );
2508 assert_eq!(
2509 snapshot.display_point_to_point(display_point, Bias::Right),
2510 right_buffer_point,
2511 "display_point_to_point({:?}, Bias::Right)",
2512 display_point
2513 );
2514 }
2515 }
2516
2517 #[gpui::test]
2518 async fn test_chunks_with_soft_wrapping(cx: &mut gpui::TestAppContext) {
2519 cx.background_executor
2520 .set_block_on_ticks(usize::MAX..=usize::MAX);
2521
2522 let text = r#"
2523 fn outer() {}
2524
2525 mod module {
2526 fn inner() {}
2527 }"#
2528 .unindent();
2529
2530 let theme =
2531 SyntaxTheme::new_test(vec![("mod.body", Hsla::red()), ("fn.name", Hsla::blue())]);
2532 let language = Arc::new(
2533 Language::new(
2534 LanguageConfig {
2535 name: "Test".into(),
2536 matcher: LanguageMatcher {
2537 path_suffixes: vec![".test".to_string()],
2538 ..Default::default()
2539 },
2540 ..Default::default()
2541 },
2542 Some(tree_sitter_rust::LANGUAGE.into()),
2543 )
2544 .with_highlights_query(
2545 r#"
2546 (mod_item name: (identifier) body: _ @mod.body)
2547 (function_item name: (identifier) @fn.name)
2548 "#,
2549 )
2550 .unwrap(),
2551 );
2552 language.set_theme(&theme);
2553
2554 cx.update(|cx| init_test(cx, |_| {}));
2555
2556 let buffer = cx.new(|cx| Buffer::local(text, cx).with_language(language, cx));
2557 cx.condition(&buffer, |buf, _| !buf.is_parsing()).await;
2558 let buffer = cx.new(|cx| MultiBuffer::singleton(buffer, cx));
2559
2560 let font_size = px(16.0);
2561
2562 let map = cx.new(|cx| {
2563 DisplayMap::new(
2564 buffer,
2565 font("Courier"),
2566 font_size,
2567 Some(px(40.0)),
2568 1,
2569 1,
2570 FoldPlaceholder::test(),
2571 DiagnosticSeverity::Warning,
2572 cx,
2573 )
2574 });
2575 assert_eq!(
2576 cx.update(|cx| syntax_chunks(DisplayRow(0)..DisplayRow(5), &map, &theme, cx)),
2577 [
2578 ("fn \n".to_string(), None),
2579 ("oute".to_string(), Some(Hsla::blue())),
2580 ("\n".to_string(), None),
2581 ("r".to_string(), Some(Hsla::blue())),
2582 ("() \n{}\n\n".to_string(), None),
2583 ]
2584 );
2585 assert_eq!(
2586 cx.update(|cx| syntax_chunks(DisplayRow(3)..DisplayRow(5), &map, &theme, cx)),
2587 [("{}\n\n".to_string(), None)]
2588 );
2589
2590 map.update(cx, |map, cx| {
2591 map.fold(
2592 vec![Crease::simple(
2593 MultiBufferPoint::new(0, 6)..MultiBufferPoint::new(3, 2),
2594 FoldPlaceholder::test(),
2595 )],
2596 cx,
2597 )
2598 });
2599 assert_eq!(
2600 cx.update(|cx| syntax_chunks(DisplayRow(1)..DisplayRow(4), &map, &theme, cx)),
2601 [
2602 ("out".to_string(), Some(Hsla::blue())),
2603 ("⋯\n".to_string(), None),
2604 (" ".to_string(), Some(Hsla::red())),
2605 ("\n".to_string(), None),
2606 ("fn ".to_string(), Some(Hsla::red())),
2607 ("i".to_string(), Some(Hsla::blue())),
2608 ("\n".to_string(), None)
2609 ]
2610 );
2611 }
2612
2613 #[gpui::test]
2614 async fn test_chunks_with_text_highlights(cx: &mut gpui::TestAppContext) {
2615 cx.update(|cx| init_test(cx, |_| {}));
2616
2617 let theme =
2618 SyntaxTheme::new_test(vec![("operator", Hsla::red()), ("string", Hsla::green())]);
2619 let language = Arc::new(
2620 Language::new(
2621 LanguageConfig {
2622 name: "Test".into(),
2623 matcher: LanguageMatcher {
2624 path_suffixes: vec![".test".to_string()],
2625 ..Default::default()
2626 },
2627 ..Default::default()
2628 },
2629 Some(tree_sitter_rust::LANGUAGE.into()),
2630 )
2631 .with_highlights_query(
2632 r#"
2633 ":" @operator
2634 (string_literal) @string
2635 "#,
2636 )
2637 .unwrap(),
2638 );
2639 language.set_theme(&theme);
2640
2641 let (text, highlighted_ranges) = marked_text_ranges(r#"constˇ «a»«:» B = "c «d»""#, false);
2642
2643 let buffer = cx.new(|cx| Buffer::local(text, cx).with_language(language, cx));
2644 cx.condition(&buffer, |buf, _| !buf.is_parsing()).await;
2645
2646 let buffer = cx.new(|cx| MultiBuffer::singleton(buffer, cx));
2647 let buffer_snapshot = buffer.read_with(cx, |buffer, cx| buffer.snapshot(cx));
2648
2649 let font_size = px(16.0);
2650 let map = cx.new(|cx| {
2651 DisplayMap::new(
2652 buffer,
2653 font("Courier"),
2654 font_size,
2655 None,
2656 1,
2657 1,
2658 FoldPlaceholder::test(),
2659 DiagnosticSeverity::Warning,
2660 cx,
2661 )
2662 });
2663
2664 enum MyType {}
2665
2666 let style = HighlightStyle {
2667 color: Some(Hsla::blue()),
2668 ..Default::default()
2669 };
2670
2671 map.update(cx, |map, _cx| {
2672 map.highlight_text(
2673 HighlightKey::Type(TypeId::of::<MyType>()),
2674 highlighted_ranges
2675 .into_iter()
2676 .map(|range| {
2677 buffer_snapshot.anchor_before(range.start)
2678 ..buffer_snapshot.anchor_before(range.end)
2679 })
2680 .collect(),
2681 style,
2682 );
2683 });
2684
2685 assert_eq!(
2686 cx.update(|cx| chunks(DisplayRow(0)..DisplayRow(10), &map, &theme, cx)),
2687 [
2688 ("const ".to_string(), None, None),
2689 ("a".to_string(), None, Some(Hsla::blue())),
2690 (":".to_string(), Some(Hsla::red()), Some(Hsla::blue())),
2691 (" B = ".to_string(), None, None),
2692 ("\"c ".to_string(), Some(Hsla::green()), None),
2693 ("d".to_string(), Some(Hsla::green()), Some(Hsla::blue())),
2694 ("\"".to_string(), Some(Hsla::green()), None),
2695 ]
2696 );
2697 }
2698
2699 #[gpui::test]
2700 fn test_clip_point(cx: &mut gpui::App) {
2701 init_test(cx, |_| {});
2702
2703 fn assert(text: &str, shift_right: bool, bias: Bias, cx: &mut gpui::App) {
2704 let (unmarked_snapshot, mut markers) = marked_display_snapshot(text, cx);
2705
2706 match bias {
2707 Bias::Left => {
2708 if shift_right {
2709 *markers[1].column_mut() += 1;
2710 }
2711
2712 assert_eq!(unmarked_snapshot.clip_point(markers[1], bias), markers[0])
2713 }
2714 Bias::Right => {
2715 if shift_right {
2716 *markers[0].column_mut() += 1;
2717 }
2718
2719 assert_eq!(unmarked_snapshot.clip_point(markers[0], bias), markers[1])
2720 }
2721 };
2722 }
2723
2724 use Bias::{Left, Right};
2725 assert("ˇˇα", false, Left, cx);
2726 assert("ˇˇα", true, Left, cx);
2727 assert("ˇˇα", false, Right, cx);
2728 assert("ˇαˇ", true, Right, cx);
2729 assert("ˇˇ✋", false, Left, cx);
2730 assert("ˇˇ✋", true, Left, cx);
2731 assert("ˇˇ✋", false, Right, cx);
2732 assert("ˇ✋ˇ", true, Right, cx);
2733 assert("ˇˇ🍐", false, Left, cx);
2734 assert("ˇˇ🍐", true, Left, cx);
2735 assert("ˇˇ🍐", false, Right, cx);
2736 assert("ˇ🍐ˇ", true, Right, cx);
2737 assert("ˇˇ\t", false, Left, cx);
2738 assert("ˇˇ\t", true, Left, cx);
2739 assert("ˇˇ\t", false, Right, cx);
2740 assert("ˇ\tˇ", true, Right, cx);
2741 assert(" ˇˇ\t", false, Left, cx);
2742 assert(" ˇˇ\t", true, Left, cx);
2743 assert(" ˇˇ\t", false, Right, cx);
2744 assert(" ˇ\tˇ", true, Right, cx);
2745 assert(" ˇˇ\t", false, Left, cx);
2746 assert(" ˇˇ\t", false, Right, cx);
2747 }
2748
2749 #[gpui::test]
2750 fn test_clip_at_line_ends(cx: &mut gpui::App) {
2751 init_test(cx, |_| {});
2752
2753 fn assert(text: &str, cx: &mut gpui::App) {
2754 let (mut unmarked_snapshot, markers) = marked_display_snapshot(text, cx);
2755 unmarked_snapshot.clip_at_line_ends = true;
2756 assert_eq!(
2757 unmarked_snapshot.clip_point(markers[1], Bias::Left),
2758 markers[0]
2759 );
2760 }
2761
2762 assert("ˇˇ", cx);
2763 assert("ˇaˇ", cx);
2764 assert("aˇbˇ", cx);
2765 assert("aˇαˇ", cx);
2766 }
2767
2768 #[gpui::test]
2769 fn test_creases(cx: &mut gpui::App) {
2770 init_test(cx, |_| {});
2771
2772 let text = "aaa\nbbb\nccc\nddd\neee\nfff\nggg\nhhh\niii\njjj\nkkk\nlll";
2773 let buffer = MultiBuffer::build_simple(text, cx);
2774 let font_size = px(14.0);
2775 cx.new(|cx| {
2776 let mut map = DisplayMap::new(
2777 buffer.clone(),
2778 font("Helvetica"),
2779 font_size,
2780 None,
2781 1,
2782 1,
2783 FoldPlaceholder::test(),
2784 DiagnosticSeverity::Warning,
2785 cx,
2786 );
2787 let snapshot = map.buffer.read(cx).snapshot(cx);
2788 let range =
2789 snapshot.anchor_before(Point::new(2, 0))..snapshot.anchor_after(Point::new(3, 3));
2790
2791 map.crease_map.insert(
2792 [Crease::inline(
2793 range,
2794 FoldPlaceholder::test(),
2795 |_row, _status, _toggle, _window, _cx| div(),
2796 |_row, _status, _window, _cx| div(),
2797 )],
2798 &map.buffer.read(cx).snapshot(cx),
2799 );
2800
2801 map
2802 });
2803 }
2804
2805 #[gpui::test]
2806 fn test_tabs_with_multibyte_chars(cx: &mut gpui::App) {
2807 init_test(cx, |_| {});
2808
2809 let text = "✅\t\tα\nβ\t\n🏀β\t\tγ";
2810 let buffer = MultiBuffer::build_simple(text, cx);
2811 let font_size = px(14.0);
2812
2813 let map = cx.new(|cx| {
2814 DisplayMap::new(
2815 buffer.clone(),
2816 font("Helvetica"),
2817 font_size,
2818 None,
2819 1,
2820 1,
2821 FoldPlaceholder::test(),
2822 DiagnosticSeverity::Warning,
2823 cx,
2824 )
2825 });
2826 let map = map.update(cx, |map, cx| map.snapshot(cx));
2827 assert_eq!(map.text(), "✅ α\nβ \n🏀β γ");
2828 assert_eq!(
2829 map.text_chunks(DisplayRow(0)).collect::<String>(),
2830 "✅ α\nβ \n🏀β γ"
2831 );
2832 assert_eq!(
2833 map.text_chunks(DisplayRow(1)).collect::<String>(),
2834 "β \n🏀β γ"
2835 );
2836 assert_eq!(
2837 map.text_chunks(DisplayRow(2)).collect::<String>(),
2838 "🏀β γ"
2839 );
2840
2841 let point = MultiBufferPoint::new(0, "✅\t\t".len() as u32);
2842 let display_point = DisplayPoint::new(DisplayRow(0), "✅ ".len() as u32);
2843 assert_eq!(point.to_display_point(&map), display_point);
2844 assert_eq!(display_point.to_point(&map), point);
2845
2846 let point = MultiBufferPoint::new(1, "β\t".len() as u32);
2847 let display_point = DisplayPoint::new(DisplayRow(1), "β ".len() as u32);
2848 assert_eq!(point.to_display_point(&map), display_point);
2849 assert_eq!(display_point.to_point(&map), point,);
2850
2851 let point = MultiBufferPoint::new(2, "🏀β\t\t".len() as u32);
2852 let display_point = DisplayPoint::new(DisplayRow(2), "🏀β ".len() as u32);
2853 assert_eq!(point.to_display_point(&map), display_point);
2854 assert_eq!(display_point.to_point(&map), point,);
2855
2856 // Display points inside of expanded tabs
2857 assert_eq!(
2858 DisplayPoint::new(DisplayRow(0), "✅ ".len() as u32).to_point(&map),
2859 MultiBufferPoint::new(0, "✅\t".len() as u32),
2860 );
2861 assert_eq!(
2862 DisplayPoint::new(DisplayRow(0), "✅ ".len() as u32).to_point(&map),
2863 MultiBufferPoint::new(0, "✅".len() as u32),
2864 );
2865
2866 // Clipping display points inside of multi-byte characters
2867 assert_eq!(
2868 map.clip_point(
2869 DisplayPoint::new(DisplayRow(0), "✅".len() as u32 - 1),
2870 Left
2871 ),
2872 DisplayPoint::new(DisplayRow(0), 0)
2873 );
2874 assert_eq!(
2875 map.clip_point(
2876 DisplayPoint::new(DisplayRow(0), "✅".len() as u32 - 1),
2877 Bias::Right
2878 ),
2879 DisplayPoint::new(DisplayRow(0), "✅".len() as u32)
2880 );
2881 }
2882
2883 #[gpui::test]
2884 fn test_max_point(cx: &mut gpui::App) {
2885 init_test(cx, |_| {});
2886
2887 let buffer = MultiBuffer::build_simple("aaa\n\t\tbbb", cx);
2888 let font_size = px(14.0);
2889 let map = cx.new(|cx| {
2890 DisplayMap::new(
2891 buffer.clone(),
2892 font("Helvetica"),
2893 font_size,
2894 None,
2895 1,
2896 1,
2897 FoldPlaceholder::test(),
2898 DiagnosticSeverity::Warning,
2899 cx,
2900 )
2901 });
2902 assert_eq!(
2903 map.update(cx, |map, cx| map.snapshot(cx)).max_point(),
2904 DisplayPoint::new(DisplayRow(1), 11)
2905 )
2906 }
2907
2908 fn syntax_chunks(
2909 rows: Range<DisplayRow>,
2910 map: &Entity<DisplayMap>,
2911 theme: &SyntaxTheme,
2912 cx: &mut App,
2913 ) -> Vec<(String, Option<Hsla>)> {
2914 chunks(rows, map, theme, cx)
2915 .into_iter()
2916 .map(|(text, color, _)| (text, color))
2917 .collect()
2918 }
2919
2920 fn chunks(
2921 rows: Range<DisplayRow>,
2922 map: &Entity<DisplayMap>,
2923 theme: &SyntaxTheme,
2924 cx: &mut App,
2925 ) -> Vec<(String, Option<Hsla>, Option<Hsla>)> {
2926 let snapshot = map.update(cx, |map, cx| map.snapshot(cx));
2927 let mut chunks: Vec<(String, Option<Hsla>, Option<Hsla>)> = Vec::new();
2928 for chunk in snapshot.chunks(rows, true, HighlightStyles::default()) {
2929 let syntax_color = chunk
2930 .syntax_highlight_id
2931 .and_then(|id| id.style(theme)?.color);
2932 let highlight_color = chunk.highlight_style.and_then(|style| style.color);
2933 if let Some((last_chunk, last_syntax_color, last_highlight_color)) = chunks.last_mut()
2934 && syntax_color == *last_syntax_color
2935 && highlight_color == *last_highlight_color
2936 {
2937 last_chunk.push_str(chunk.text);
2938 continue;
2939 }
2940 chunks.push((chunk.text.to_string(), syntax_color, highlight_color));
2941 }
2942 chunks
2943 }
2944
2945 fn init_test(cx: &mut App, f: impl Fn(&mut SettingsContent)) {
2946 let settings = SettingsStore::test(cx);
2947 cx.set_global(settings);
2948 workspace::init_settings(cx);
2949 language::init(cx);
2950 crate::init(cx);
2951 Project::init_settings(cx);
2952 theme::init(LoadThemes::JustBase, cx);
2953 cx.update_global::<SettingsStore, _>(|store, cx| {
2954 store.update_user_settings(cx, f);
2955 });
2956 }
2957}