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