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