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, point: DisplayPoint) -> DisplayPoint {
1072 let mut point = point.0;
1073 if point.column == self.line_len(DisplayRow(point.row)) {
1074 point.column = point.column.saturating_sub(1);
1075 point = self.block_snapshot.clip_point(point, Bias::Left);
1076 }
1077 DisplayPoint(point)
1078 }
1079
1080 pub fn folds_in_range<T>(&self, range: Range<T>) -> impl Iterator<Item = &Fold>
1081 where
1082 T: ToOffset,
1083 {
1084 self.fold_snapshot.folds_in_range(range)
1085 }
1086
1087 pub fn blocks_in_range(
1088 &self,
1089 rows: Range<DisplayRow>,
1090 ) -> impl Iterator<Item = (DisplayRow, &Block)> {
1091 self.block_snapshot
1092 .blocks_in_range(rows.start.0..rows.end.0)
1093 .map(|(row, block)| (DisplayRow(row), block))
1094 }
1095
1096 pub fn sticky_header_excerpt(&self, row: DisplayRow) -> Option<StickyHeaderExcerpt<'_>> {
1097 self.block_snapshot.sticky_header_excerpt(row.0)
1098 }
1099
1100 pub fn block_for_id(&self, id: BlockId) -> Option<Block> {
1101 self.block_snapshot.block_for_id(id)
1102 }
1103
1104 pub fn intersects_fold<T: ToOffset>(&self, offset: T) -> bool {
1105 self.fold_snapshot.intersects_fold(offset)
1106 }
1107
1108 pub fn is_line_folded(&self, buffer_row: MultiBufferRow) -> bool {
1109 self.block_snapshot.is_line_replaced(buffer_row)
1110 || self.fold_snapshot.is_line_folded(buffer_row)
1111 }
1112
1113 pub fn is_block_line(&self, display_row: DisplayRow) -> bool {
1114 self.block_snapshot.is_block_line(BlockRow(display_row.0))
1115 }
1116
1117 pub fn soft_wrap_indent(&self, display_row: DisplayRow) -> Option<u32> {
1118 let wrap_row = self
1119 .block_snapshot
1120 .to_wrap_point(BlockPoint::new(display_row.0, 0), Bias::Left)
1121 .row();
1122 self.wrap_snapshot.soft_wrap_indent(wrap_row)
1123 }
1124
1125 pub fn text(&self) -> String {
1126 self.text_chunks(DisplayRow(0)).collect()
1127 }
1128
1129 pub fn line(&self, display_row: DisplayRow) -> String {
1130 let mut result = String::new();
1131 for chunk in self.text_chunks(display_row) {
1132 if let Some(ix) = chunk.find('\n') {
1133 result.push_str(&chunk[0..ix]);
1134 break;
1135 } else {
1136 result.push_str(chunk);
1137 }
1138 }
1139 result
1140 }
1141
1142 pub fn line_indent_for_buffer_row(&self, buffer_row: MultiBufferRow) -> LineIndent {
1143 self.buffer_snapshot.line_indent_for_row(buffer_row)
1144 }
1145
1146 pub fn line_len(&self, row: DisplayRow) -> u32 {
1147 self.block_snapshot.line_len(BlockRow(row.0))
1148 }
1149
1150 pub fn longest_row(&self) -> DisplayRow {
1151 DisplayRow(self.block_snapshot.longest_row())
1152 }
1153
1154 pub fn longest_row_in_range(&self, range: Range<DisplayRow>) -> DisplayRow {
1155 let block_range = BlockRow(range.start.0)..BlockRow(range.end.0);
1156 let longest_row = self.block_snapshot.longest_row_in_range(block_range);
1157 DisplayRow(longest_row.0)
1158 }
1159
1160 pub fn starts_indent(&self, buffer_row: MultiBufferRow) -> bool {
1161 let max_row = self.buffer_snapshot.max_row();
1162 if buffer_row >= max_row {
1163 return false;
1164 }
1165
1166 let line_indent = self.line_indent_for_buffer_row(buffer_row);
1167 if line_indent.is_line_blank() {
1168 return false;
1169 }
1170
1171 (buffer_row.0 + 1..=max_row.0)
1172 .find_map(|next_row| {
1173 let next_line_indent = self.line_indent_for_buffer_row(MultiBufferRow(next_row));
1174 if next_line_indent.raw_len() > line_indent.raw_len() {
1175 Some(true)
1176 } else if !next_line_indent.is_line_blank() {
1177 Some(false)
1178 } else {
1179 None
1180 }
1181 })
1182 .unwrap_or(false)
1183 }
1184
1185 pub fn crease_for_buffer_row(&self, buffer_row: MultiBufferRow) -> Option<Crease<Point>> {
1186 let start = MultiBufferPoint::new(buffer_row.0, self.buffer_snapshot.line_len(buffer_row));
1187 if let Some(crease) = self
1188 .crease_snapshot
1189 .query_row(buffer_row, &self.buffer_snapshot)
1190 {
1191 match crease {
1192 Crease::Inline {
1193 range,
1194 placeholder,
1195 render_toggle,
1196 render_trailer,
1197 metadata,
1198 } => Some(Crease::Inline {
1199 range: range.to_point(&self.buffer_snapshot),
1200 placeholder: placeholder.clone(),
1201 render_toggle: render_toggle.clone(),
1202 render_trailer: render_trailer.clone(),
1203 metadata: metadata.clone(),
1204 }),
1205 Crease::Block {
1206 range,
1207 block_height,
1208 block_style,
1209 render_block,
1210 block_priority,
1211 render_toggle,
1212 } => Some(Crease::Block {
1213 range: range.to_point(&self.buffer_snapshot),
1214 block_height: *block_height,
1215 block_style: *block_style,
1216 render_block: render_block.clone(),
1217 block_priority: *block_priority,
1218 render_toggle: render_toggle.clone(),
1219 }),
1220 }
1221 } else if self.starts_indent(MultiBufferRow(start.row))
1222 && !self.is_line_folded(MultiBufferRow(start.row))
1223 {
1224 let start_line_indent = self.line_indent_for_buffer_row(buffer_row);
1225 let max_point = self.buffer_snapshot.max_point();
1226 let mut end = None;
1227
1228 for row in (buffer_row.0 + 1)..=max_point.row {
1229 let line_indent = self.line_indent_for_buffer_row(MultiBufferRow(row));
1230 if !line_indent.is_line_blank()
1231 && line_indent.raw_len() <= start_line_indent.raw_len()
1232 {
1233 let prev_row = row - 1;
1234 end = Some(Point::new(
1235 prev_row,
1236 self.buffer_snapshot.line_len(MultiBufferRow(prev_row)),
1237 ));
1238 break;
1239 }
1240 }
1241
1242 let mut row_before_line_breaks = end.unwrap_or(max_point);
1243 while row_before_line_breaks.row > start.row
1244 && self
1245 .buffer_snapshot
1246 .is_line_blank(MultiBufferRow(row_before_line_breaks.row))
1247 {
1248 row_before_line_breaks.row -= 1;
1249 }
1250
1251 row_before_line_breaks = Point::new(
1252 row_before_line_breaks.row,
1253 self.buffer_snapshot
1254 .line_len(MultiBufferRow(row_before_line_breaks.row)),
1255 );
1256
1257 Some(Crease::Inline {
1258 range: start..row_before_line_breaks,
1259 placeholder: self.fold_placeholder.clone(),
1260 render_toggle: None,
1261 render_trailer: None,
1262 metadata: None,
1263 })
1264 } else {
1265 None
1266 }
1267 }
1268
1269 #[cfg(any(test, feature = "test-support"))]
1270 pub fn text_highlight_ranges<Tag: ?Sized + 'static>(
1271 &self,
1272 ) -> Option<Arc<(HighlightStyle, Vec<Range<Anchor>>)>> {
1273 let type_id = TypeId::of::<Tag>();
1274 self.text_highlights.get(&type_id).cloned()
1275 }
1276
1277 #[allow(unused)]
1278 #[cfg(any(test, feature = "test-support"))]
1279 pub(crate) fn inlay_highlights<Tag: ?Sized + 'static>(
1280 &self,
1281 ) -> Option<&TreeMap<InlayId, (HighlightStyle, InlayHighlight)>> {
1282 let type_id = TypeId::of::<Tag>();
1283 self.inlay_highlights.get(&type_id)
1284 }
1285
1286 pub fn buffer_header_height(&self) -> u32 {
1287 self.block_snapshot.buffer_header_height
1288 }
1289
1290 pub fn excerpt_footer_height(&self) -> u32 {
1291 self.block_snapshot.excerpt_footer_height
1292 }
1293
1294 pub fn excerpt_header_height(&self) -> u32 {
1295 self.block_snapshot.excerpt_header_height
1296 }
1297}
1298
1299#[derive(Copy, Clone, Default, Eq, Ord, PartialOrd, PartialEq)]
1300pub struct DisplayPoint(BlockPoint);
1301
1302impl Debug for DisplayPoint {
1303 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1304 f.write_fmt(format_args!(
1305 "DisplayPoint({}, {})",
1306 self.row().0,
1307 self.column()
1308 ))
1309 }
1310}
1311
1312impl Add for DisplayPoint {
1313 type Output = Self;
1314
1315 fn add(self, other: Self) -> Self::Output {
1316 DisplayPoint(BlockPoint(self.0 .0 + other.0 .0))
1317 }
1318}
1319
1320impl Sub for DisplayPoint {
1321 type Output = Self;
1322
1323 fn sub(self, other: Self) -> Self::Output {
1324 DisplayPoint(BlockPoint(self.0 .0 - other.0 .0))
1325 }
1326}
1327
1328#[derive(Debug, Copy, Clone, Default, Eq, Ord, PartialOrd, PartialEq, Deserialize, Hash)]
1329#[serde(transparent)]
1330pub struct DisplayRow(pub u32);
1331
1332impl Add<DisplayRow> for DisplayRow {
1333 type Output = Self;
1334
1335 fn add(self, other: Self) -> Self::Output {
1336 DisplayRow(self.0 + other.0)
1337 }
1338}
1339
1340impl Add<u32> for DisplayRow {
1341 type Output = Self;
1342
1343 fn add(self, other: u32) -> Self::Output {
1344 DisplayRow(self.0 + other)
1345 }
1346}
1347
1348impl Sub<DisplayRow> for DisplayRow {
1349 type Output = Self;
1350
1351 fn sub(self, other: Self) -> Self::Output {
1352 DisplayRow(self.0 - other.0)
1353 }
1354}
1355
1356impl Sub<u32> for DisplayRow {
1357 type Output = Self;
1358
1359 fn sub(self, other: u32) -> Self::Output {
1360 DisplayRow(self.0 - other)
1361 }
1362}
1363
1364impl DisplayPoint {
1365 pub fn new(row: DisplayRow, column: u32) -> Self {
1366 Self(BlockPoint(Point::new(row.0, column)))
1367 }
1368
1369 pub fn zero() -> Self {
1370 Self::new(DisplayRow(0), 0)
1371 }
1372
1373 pub fn is_zero(&self) -> bool {
1374 self.0.is_zero()
1375 }
1376
1377 pub fn row(self) -> DisplayRow {
1378 DisplayRow(self.0.row)
1379 }
1380
1381 pub fn column(self) -> u32 {
1382 self.0.column
1383 }
1384
1385 pub fn row_mut(&mut self) -> &mut u32 {
1386 &mut self.0.row
1387 }
1388
1389 pub fn column_mut(&mut self) -> &mut u32 {
1390 &mut self.0.column
1391 }
1392
1393 pub fn to_point(self, map: &DisplaySnapshot) -> Point {
1394 map.display_point_to_point(self, Bias::Left)
1395 }
1396
1397 pub fn to_offset(self, map: &DisplaySnapshot, bias: Bias) -> usize {
1398 let wrap_point = map.block_snapshot.to_wrap_point(self.0, bias);
1399 let tab_point = map.wrap_snapshot.to_tab_point(wrap_point);
1400 let fold_point = map.tab_snapshot.to_fold_point(tab_point, bias).0;
1401 let inlay_point = fold_point.to_inlay_point(&map.fold_snapshot);
1402 map.inlay_snapshot
1403 .to_buffer_offset(map.inlay_snapshot.to_offset(inlay_point))
1404 }
1405}
1406
1407impl ToDisplayPoint for usize {
1408 fn to_display_point(&self, map: &DisplaySnapshot) -> DisplayPoint {
1409 map.point_to_display_point(self.to_point(&map.buffer_snapshot), Bias::Left)
1410 }
1411}
1412
1413impl ToDisplayPoint for OffsetUtf16 {
1414 fn to_display_point(&self, map: &DisplaySnapshot) -> DisplayPoint {
1415 self.to_offset(&map.buffer_snapshot).to_display_point(map)
1416 }
1417}
1418
1419impl ToDisplayPoint for Point {
1420 fn to_display_point(&self, map: &DisplaySnapshot) -> DisplayPoint {
1421 map.point_to_display_point(*self, Bias::Left)
1422 }
1423}
1424
1425impl ToDisplayPoint for Anchor {
1426 fn to_display_point(&self, map: &DisplaySnapshot) -> DisplayPoint {
1427 self.to_point(&map.buffer_snapshot).to_display_point(map)
1428 }
1429}
1430
1431#[cfg(test)]
1432pub mod tests {
1433 use super::*;
1434 use crate::{movement, test::marked_display_snapshot};
1435 use block_map::BlockPlacement;
1436 use gpui::{
1437 div, font, observe, px, App, AppContext as _, BorrowAppContext, Element, Hsla, Rgba,
1438 };
1439 use language::{
1440 language_settings::{AllLanguageSettings, AllLanguageSettingsContent},
1441 Buffer, Diagnostic, DiagnosticEntry, DiagnosticSet, Language, LanguageConfig,
1442 LanguageMatcher,
1443 };
1444 use lsp::LanguageServerId;
1445 use project::Project;
1446 use rand::{prelude::*, Rng};
1447 use settings::SettingsStore;
1448 use smol::stream::StreamExt;
1449 use std::{env, sync::Arc};
1450 use text::PointUtf16;
1451 use theme::{LoadThemes, SyntaxTheme};
1452 use unindent::Unindent as _;
1453 use util::test::{marked_text_ranges, sample_text};
1454 use Bias::*;
1455
1456 #[gpui::test(iterations = 100)]
1457 async fn test_random_display_map(cx: &mut gpui::TestAppContext, mut rng: StdRng) {
1458 cx.background_executor.set_block_on_ticks(0..=50);
1459 let operations = env::var("OPERATIONS")
1460 .map(|i| i.parse().expect("invalid `OPERATIONS` variable"))
1461 .unwrap_or(10);
1462
1463 let mut tab_size = rng.gen_range(1..=4);
1464 let buffer_start_excerpt_header_height = rng.gen_range(1..=5);
1465 let excerpt_header_height = rng.gen_range(1..=5);
1466 let font_size = px(14.0);
1467 let max_wrap_width = 300.0;
1468 let mut wrap_width = if rng.gen_bool(0.1) {
1469 None
1470 } else {
1471 Some(px(rng.gen_range(0.0..=max_wrap_width)))
1472 };
1473
1474 log::info!("tab size: {}", tab_size);
1475 log::info!("wrap width: {:?}", wrap_width);
1476
1477 cx.update(|cx| {
1478 init_test(cx, |s| s.defaults.tab_size = NonZeroU32::new(tab_size));
1479 });
1480
1481 let buffer = cx.update(|cx| {
1482 if rng.gen() {
1483 let len = rng.gen_range(0..10);
1484 let text = util::RandomCharIter::new(&mut rng)
1485 .take(len)
1486 .collect::<String>();
1487 MultiBuffer::build_simple(&text, cx)
1488 } else {
1489 MultiBuffer::build_random(&mut rng, cx)
1490 }
1491 });
1492
1493 let map = cx.new(|cx| {
1494 DisplayMap::new(
1495 buffer.clone(),
1496 font("Helvetica"),
1497 font_size,
1498 wrap_width,
1499 true,
1500 buffer_start_excerpt_header_height,
1501 excerpt_header_height,
1502 0,
1503 FoldPlaceholder::test(),
1504 cx,
1505 )
1506 });
1507 let mut notifications = observe(&map, cx);
1508 let mut fold_count = 0;
1509 let mut blocks = Vec::new();
1510
1511 let snapshot = map.update(cx, |map, cx| map.snapshot(cx));
1512 log::info!("buffer text: {:?}", snapshot.buffer_snapshot.text());
1513 log::info!("fold text: {:?}", snapshot.fold_snapshot.text());
1514 log::info!("tab text: {:?}", snapshot.tab_snapshot.text());
1515 log::info!("wrap text: {:?}", snapshot.wrap_snapshot.text());
1516 log::info!("block text: {:?}", snapshot.block_snapshot.text());
1517 log::info!("display text: {:?}", snapshot.text());
1518
1519 for _i in 0..operations {
1520 match rng.gen_range(0..100) {
1521 0..=19 => {
1522 wrap_width = if rng.gen_bool(0.2) {
1523 None
1524 } else {
1525 Some(px(rng.gen_range(0.0..=max_wrap_width)))
1526 };
1527 log::info!("setting wrap width to {:?}", wrap_width);
1528 map.update(cx, |map, cx| map.set_wrap_width(wrap_width, cx));
1529 }
1530 20..=29 => {
1531 let mut tab_sizes = vec![1, 2, 3, 4];
1532 tab_sizes.remove((tab_size - 1) as usize);
1533 tab_size = *tab_sizes.choose(&mut rng).unwrap();
1534 log::info!("setting tab size to {:?}", tab_size);
1535 cx.update(|cx| {
1536 cx.update_global::<SettingsStore, _>(|store, cx| {
1537 store.update_user_settings::<AllLanguageSettings>(cx, |s| {
1538 s.defaults.tab_size = NonZeroU32::new(tab_size);
1539 });
1540 });
1541 });
1542 }
1543 30..=44 => {
1544 map.update(cx, |map, cx| {
1545 if rng.gen() || blocks.is_empty() {
1546 let buffer = map.snapshot(cx).buffer_snapshot;
1547 let block_properties = (0..rng.gen_range(1..=1))
1548 .map(|_| {
1549 let position =
1550 buffer.anchor_after(buffer.clip_offset(
1551 rng.gen_range(0..=buffer.len()),
1552 Bias::Left,
1553 ));
1554
1555 let placement = if rng.gen() {
1556 BlockPlacement::Above(position)
1557 } else {
1558 BlockPlacement::Below(position)
1559 };
1560 let height = rng.gen_range(1..5);
1561 log::info!(
1562 "inserting block {:?} with height {}",
1563 placement.as_ref().map(|p| p.to_point(&buffer)),
1564 height
1565 );
1566 let priority = rng.gen_range(1..100);
1567 BlockProperties {
1568 placement,
1569 style: BlockStyle::Fixed,
1570 height,
1571 render: Arc::new(|_| div().into_any()),
1572 priority,
1573 }
1574 })
1575 .collect::<Vec<_>>();
1576 blocks.extend(map.insert_blocks(block_properties, cx));
1577 } else {
1578 blocks.shuffle(&mut rng);
1579 let remove_count = rng.gen_range(1..=4.min(blocks.len()));
1580 let block_ids_to_remove = (0..remove_count)
1581 .map(|_| blocks.remove(rng.gen_range(0..blocks.len())))
1582 .collect();
1583 log::info!("removing block ids {:?}", block_ids_to_remove);
1584 map.remove_blocks(block_ids_to_remove, cx);
1585 }
1586 });
1587 }
1588 45..=79 => {
1589 let mut ranges = Vec::new();
1590 for _ in 0..rng.gen_range(1..=3) {
1591 buffer.read_with(cx, |buffer, cx| {
1592 let buffer = buffer.read(cx);
1593 let end = buffer.clip_offset(rng.gen_range(0..=buffer.len()), Right);
1594 let start = buffer.clip_offset(rng.gen_range(0..=end), Left);
1595 ranges.push(start..end);
1596 });
1597 }
1598
1599 if rng.gen() && fold_count > 0 {
1600 log::info!("unfolding ranges: {:?}", ranges);
1601 map.update(cx, |map, cx| {
1602 map.unfold_intersecting(ranges, true, cx);
1603 });
1604 } else {
1605 log::info!("folding ranges: {:?}", ranges);
1606 map.update(cx, |map, cx| {
1607 map.fold(
1608 ranges
1609 .into_iter()
1610 .map(|range| Crease::simple(range, FoldPlaceholder::test()))
1611 .collect(),
1612 cx,
1613 );
1614 });
1615 }
1616 }
1617 _ => {
1618 buffer.update(cx, |buffer, cx| buffer.randomly_mutate(&mut rng, 5, cx));
1619 }
1620 }
1621
1622 if map.read_with(cx, |map, cx| map.is_rewrapping(cx)) {
1623 notifications.next().await.unwrap();
1624 }
1625
1626 let snapshot = map.update(cx, |map, cx| map.snapshot(cx));
1627 fold_count = snapshot.fold_count();
1628 log::info!("buffer text: {:?}", snapshot.buffer_snapshot.text());
1629 log::info!("fold text: {:?}", snapshot.fold_snapshot.text());
1630 log::info!("tab text: {:?}", snapshot.tab_snapshot.text());
1631 log::info!("wrap text: {:?}", snapshot.wrap_snapshot.text());
1632 log::info!("block text: {:?}", snapshot.block_snapshot.text());
1633 log::info!("display text: {:?}", snapshot.text());
1634
1635 // Line boundaries
1636 let buffer = &snapshot.buffer_snapshot;
1637 for _ in 0..5 {
1638 let row = rng.gen_range(0..=buffer.max_point().row);
1639 let column = rng.gen_range(0..=buffer.line_len(MultiBufferRow(row)));
1640 let point = buffer.clip_point(Point::new(row, column), Left);
1641
1642 let (prev_buffer_bound, prev_display_bound) = snapshot.prev_line_boundary(point);
1643 let (next_buffer_bound, next_display_bound) = snapshot.next_line_boundary(point);
1644
1645 assert!(prev_buffer_bound <= point);
1646 assert!(next_buffer_bound >= point);
1647 assert_eq!(prev_buffer_bound.column, 0);
1648 assert_eq!(prev_display_bound.column(), 0);
1649 if next_buffer_bound < buffer.max_point() {
1650 assert_eq!(buffer.chars_at(next_buffer_bound).next(), Some('\n'));
1651 }
1652
1653 assert_eq!(
1654 prev_display_bound,
1655 prev_buffer_bound.to_display_point(&snapshot),
1656 "row boundary before {:?}. reported buffer row boundary: {:?}",
1657 point,
1658 prev_buffer_bound
1659 );
1660 assert_eq!(
1661 next_display_bound,
1662 next_buffer_bound.to_display_point(&snapshot),
1663 "display row boundary after {:?}. reported buffer row boundary: {:?}",
1664 point,
1665 next_buffer_bound
1666 );
1667 assert_eq!(
1668 prev_buffer_bound,
1669 prev_display_bound.to_point(&snapshot),
1670 "row boundary before {:?}. reported display row boundary: {:?}",
1671 point,
1672 prev_display_bound
1673 );
1674 assert_eq!(
1675 next_buffer_bound,
1676 next_display_bound.to_point(&snapshot),
1677 "row boundary after {:?}. reported display row boundary: {:?}",
1678 point,
1679 next_display_bound
1680 );
1681 }
1682
1683 // Movement
1684 let min_point = snapshot.clip_point(DisplayPoint::new(DisplayRow(0), 0), Left);
1685 let max_point = snapshot.clip_point(snapshot.max_point(), Right);
1686 for _ in 0..5 {
1687 let row = rng.gen_range(0..=snapshot.max_point().row().0);
1688 let column = rng.gen_range(0..=snapshot.line_len(DisplayRow(row)));
1689 let point = snapshot.clip_point(DisplayPoint::new(DisplayRow(row), column), Left);
1690
1691 log::info!("Moving from point {:?}", point);
1692
1693 let moved_right = movement::right(&snapshot, point);
1694 log::info!("Right {:?}", moved_right);
1695 if point < max_point {
1696 assert!(moved_right > point);
1697 if point.column() == snapshot.line_len(point.row())
1698 || snapshot.soft_wrap_indent(point.row()).is_some()
1699 && point.column() == snapshot.line_len(point.row()) - 1
1700 {
1701 assert!(moved_right.row() > point.row());
1702 }
1703 } else {
1704 assert_eq!(moved_right, point);
1705 }
1706
1707 let moved_left = movement::left(&snapshot, point);
1708 log::info!("Left {:?}", moved_left);
1709 if point > min_point {
1710 assert!(moved_left < point);
1711 if point.column() == 0 {
1712 assert!(moved_left.row() < point.row());
1713 }
1714 } else {
1715 assert_eq!(moved_left, point);
1716 }
1717 }
1718 }
1719 }
1720
1721 #[cfg(target_os = "macos")]
1722 #[gpui::test(retries = 5)]
1723 async fn test_soft_wraps(cx: &mut gpui::TestAppContext) {
1724 cx.background_executor
1725 .set_block_on_ticks(usize::MAX..=usize::MAX);
1726 cx.update(|cx| {
1727 init_test(cx, |_| {});
1728 });
1729
1730 let mut cx = crate::test::editor_test_context::EditorTestContext::new(cx).await;
1731 let editor = cx.editor.clone();
1732 let window = cx.window;
1733
1734 _ = cx.update_window(window, |_, window, cx| {
1735 let text_layout_details =
1736 editor.update(cx, |editor, _cx| editor.text_layout_details(window));
1737
1738 let font_size = px(12.0);
1739 let wrap_width = Some(px(64.));
1740
1741 let text = "one two three four five\nsix seven eight";
1742 let buffer = MultiBuffer::build_simple(text, cx);
1743 let map = cx.new(|cx| {
1744 DisplayMap::new(
1745 buffer.clone(),
1746 font("Helvetica"),
1747 font_size,
1748 wrap_width,
1749 true,
1750 1,
1751 1,
1752 0,
1753 FoldPlaceholder::test(),
1754 cx,
1755 )
1756 });
1757
1758 let snapshot = map.update(cx, |map, cx| map.snapshot(cx));
1759 assert_eq!(
1760 snapshot.text_chunks(DisplayRow(0)).collect::<String>(),
1761 "one two \nthree four \nfive\nsix seven \neight"
1762 );
1763 assert_eq!(
1764 snapshot.clip_point(DisplayPoint::new(DisplayRow(0), 8), Bias::Left),
1765 DisplayPoint::new(DisplayRow(0), 7)
1766 );
1767 assert_eq!(
1768 snapshot.clip_point(DisplayPoint::new(DisplayRow(0), 8), Bias::Right),
1769 DisplayPoint::new(DisplayRow(1), 0)
1770 );
1771 assert_eq!(
1772 movement::right(&snapshot, DisplayPoint::new(DisplayRow(0), 7)),
1773 DisplayPoint::new(DisplayRow(1), 0)
1774 );
1775 assert_eq!(
1776 movement::left(&snapshot, DisplayPoint::new(DisplayRow(1), 0)),
1777 DisplayPoint::new(DisplayRow(0), 7)
1778 );
1779
1780 let x = snapshot
1781 .x_for_display_point(DisplayPoint::new(DisplayRow(1), 10), &text_layout_details);
1782 assert_eq!(
1783 movement::up(
1784 &snapshot,
1785 DisplayPoint::new(DisplayRow(1), 10),
1786 language::SelectionGoal::None,
1787 false,
1788 &text_layout_details,
1789 ),
1790 (
1791 DisplayPoint::new(DisplayRow(0), 7),
1792 language::SelectionGoal::HorizontalPosition(x.0)
1793 )
1794 );
1795 assert_eq!(
1796 movement::down(
1797 &snapshot,
1798 DisplayPoint::new(DisplayRow(0), 7),
1799 language::SelectionGoal::HorizontalPosition(x.0),
1800 false,
1801 &text_layout_details
1802 ),
1803 (
1804 DisplayPoint::new(DisplayRow(1), 10),
1805 language::SelectionGoal::HorizontalPosition(x.0)
1806 )
1807 );
1808 assert_eq!(
1809 movement::down(
1810 &snapshot,
1811 DisplayPoint::new(DisplayRow(1), 10),
1812 language::SelectionGoal::HorizontalPosition(x.0),
1813 false,
1814 &text_layout_details
1815 ),
1816 (
1817 DisplayPoint::new(DisplayRow(2), 4),
1818 language::SelectionGoal::HorizontalPosition(x.0)
1819 )
1820 );
1821
1822 let ix = snapshot.buffer_snapshot.text().find("seven").unwrap();
1823 buffer.update(cx, |buffer, cx| {
1824 buffer.edit([(ix..ix, "and ")], None, cx);
1825 });
1826
1827 let snapshot = map.update(cx, |map, cx| map.snapshot(cx));
1828 assert_eq!(
1829 snapshot.text_chunks(DisplayRow(1)).collect::<String>(),
1830 "three four \nfive\nsix and \nseven eight"
1831 );
1832
1833 // Re-wrap on font size changes
1834 map.update(cx, |map, cx| {
1835 map.set_font(font("Helvetica"), px(font_size.0 + 3.), cx)
1836 });
1837
1838 let snapshot = map.update(cx, |map, cx| map.snapshot(cx));
1839 assert_eq!(
1840 snapshot.text_chunks(DisplayRow(1)).collect::<String>(),
1841 "three \nfour five\nsix and \nseven \neight"
1842 )
1843 });
1844 }
1845
1846 #[gpui::test]
1847 fn test_text_chunks(cx: &mut gpui::App) {
1848 init_test(cx, |_| {});
1849
1850 let text = sample_text(6, 6, 'a');
1851 let buffer = MultiBuffer::build_simple(&text, cx);
1852
1853 let font_size = px(14.0);
1854 let map = cx.new(|cx| {
1855 DisplayMap::new(
1856 buffer.clone(),
1857 font("Helvetica"),
1858 font_size,
1859 None,
1860 true,
1861 1,
1862 1,
1863 0,
1864 FoldPlaceholder::test(),
1865 cx,
1866 )
1867 });
1868
1869 buffer.update(cx, |buffer, cx| {
1870 buffer.edit(
1871 vec![
1872 (
1873 MultiBufferPoint::new(1, 0)..MultiBufferPoint::new(1, 0),
1874 "\t",
1875 ),
1876 (
1877 MultiBufferPoint::new(1, 1)..MultiBufferPoint::new(1, 1),
1878 "\t",
1879 ),
1880 (
1881 MultiBufferPoint::new(2, 1)..MultiBufferPoint::new(2, 1),
1882 "\t",
1883 ),
1884 ],
1885 None,
1886 cx,
1887 )
1888 });
1889
1890 assert_eq!(
1891 map.update(cx, |map, cx| map.snapshot(cx))
1892 .text_chunks(DisplayRow(1))
1893 .collect::<String>()
1894 .lines()
1895 .next(),
1896 Some(" b bbbbb")
1897 );
1898 assert_eq!(
1899 map.update(cx, |map, cx| map.snapshot(cx))
1900 .text_chunks(DisplayRow(2))
1901 .collect::<String>()
1902 .lines()
1903 .next(),
1904 Some("c ccccc")
1905 );
1906 }
1907
1908 #[gpui::test]
1909 async fn test_chunks(cx: &mut gpui::TestAppContext) {
1910 let text = r#"
1911 fn outer() {}
1912
1913 mod module {
1914 fn inner() {}
1915 }"#
1916 .unindent();
1917
1918 let theme =
1919 SyntaxTheme::new_test(vec![("mod.body", Hsla::red()), ("fn.name", Hsla::blue())]);
1920 let language = Arc::new(
1921 Language::new(
1922 LanguageConfig {
1923 name: "Test".into(),
1924 matcher: LanguageMatcher {
1925 path_suffixes: vec![".test".to_string()],
1926 ..Default::default()
1927 },
1928 ..Default::default()
1929 },
1930 Some(tree_sitter_rust::LANGUAGE.into()),
1931 )
1932 .with_highlights_query(
1933 r#"
1934 (mod_item name: (identifier) body: _ @mod.body)
1935 (function_item name: (identifier) @fn.name)
1936 "#,
1937 )
1938 .unwrap(),
1939 );
1940 language.set_theme(&theme);
1941
1942 cx.update(|cx| init_test(cx, |s| s.defaults.tab_size = Some(2.try_into().unwrap())));
1943
1944 let buffer = cx.new(|cx| Buffer::local(text, cx).with_language(language, cx));
1945 cx.condition(&buffer, |buf, _| !buf.is_parsing()).await;
1946 let buffer = cx.new(|cx| MultiBuffer::singleton(buffer, cx));
1947
1948 let font_size = px(14.0);
1949
1950 let map = cx.new(|cx| {
1951 DisplayMap::new(
1952 buffer,
1953 font("Helvetica"),
1954 font_size,
1955 None,
1956 true,
1957 1,
1958 1,
1959 1,
1960 FoldPlaceholder::test(),
1961 cx,
1962 )
1963 });
1964 assert_eq!(
1965 cx.update(|cx| syntax_chunks(DisplayRow(0)..DisplayRow(5), &map, &theme, cx)),
1966 vec![
1967 ("fn ".to_string(), None),
1968 ("outer".to_string(), Some(Hsla::blue())),
1969 ("() {}\n\nmod module ".to_string(), None),
1970 ("{\n fn ".to_string(), Some(Hsla::red())),
1971 ("inner".to_string(), Some(Hsla::blue())),
1972 ("() {}\n}".to_string(), Some(Hsla::red())),
1973 ]
1974 );
1975 assert_eq!(
1976 cx.update(|cx| syntax_chunks(DisplayRow(3)..DisplayRow(5), &map, &theme, cx)),
1977 vec![
1978 (" fn ".to_string(), Some(Hsla::red())),
1979 ("inner".to_string(), Some(Hsla::blue())),
1980 ("() {}\n}".to_string(), Some(Hsla::red())),
1981 ]
1982 );
1983
1984 map.update(cx, |map, cx| {
1985 map.fold(
1986 vec![Crease::simple(
1987 MultiBufferPoint::new(0, 6)..MultiBufferPoint::new(3, 2),
1988 FoldPlaceholder::test(),
1989 )],
1990 cx,
1991 )
1992 });
1993 assert_eq!(
1994 cx.update(|cx| syntax_chunks(DisplayRow(0)..DisplayRow(2), &map, &theme, cx)),
1995 vec![
1996 ("fn ".to_string(), None),
1997 ("out".to_string(), Some(Hsla::blue())),
1998 ("⋯".to_string(), None),
1999 (" fn ".to_string(), Some(Hsla::red())),
2000 ("inner".to_string(), Some(Hsla::blue())),
2001 ("() {}\n}".to_string(), Some(Hsla::red())),
2002 ]
2003 );
2004 }
2005
2006 #[gpui::test]
2007 async fn test_chunks_with_syntax_highlighting_across_blocks(cx: &mut gpui::TestAppContext) {
2008 cx.background_executor
2009 .set_block_on_ticks(usize::MAX..=usize::MAX);
2010
2011 let text = r#"
2012 const A: &str = "
2013 one
2014 two
2015 three
2016 ";
2017 const B: &str = "four";
2018 "#
2019 .unindent();
2020
2021 let theme = SyntaxTheme::new_test(vec![
2022 ("string", Hsla::red()),
2023 ("punctuation", Hsla::blue()),
2024 ("keyword", Hsla::green()),
2025 ]);
2026 let language = Arc::new(
2027 Language::new(
2028 LanguageConfig {
2029 name: "Rust".into(),
2030 ..Default::default()
2031 },
2032 Some(tree_sitter_rust::LANGUAGE.into()),
2033 )
2034 .with_highlights_query(
2035 r#"
2036 (string_literal) @string
2037 "const" @keyword
2038 [":" ";"] @punctuation
2039 "#,
2040 )
2041 .unwrap(),
2042 );
2043 language.set_theme(&theme);
2044
2045 cx.update(|cx| init_test(cx, |_| {}));
2046
2047 let buffer = cx.new(|cx| Buffer::local(text, cx).with_language(language, cx));
2048 cx.condition(&buffer, |buf, _| !buf.is_parsing()).await;
2049 let buffer = cx.new(|cx| MultiBuffer::singleton(buffer, cx));
2050 let buffer_snapshot = buffer.read_with(cx, |buffer, cx| buffer.snapshot(cx));
2051
2052 let map = cx.new(|cx| {
2053 DisplayMap::new(
2054 buffer,
2055 font("Courier"),
2056 px(16.0),
2057 None,
2058 true,
2059 1,
2060 1,
2061 0,
2062 FoldPlaceholder::test(),
2063 cx,
2064 )
2065 });
2066
2067 // Insert a block in the middle of a multi-line string literal
2068 map.update(cx, |map, cx| {
2069 map.insert_blocks(
2070 [BlockProperties {
2071 placement: BlockPlacement::Below(
2072 buffer_snapshot.anchor_before(Point::new(1, 0)),
2073 ),
2074 height: 1,
2075 style: BlockStyle::Sticky,
2076 render: Arc::new(|_| div().into_any()),
2077 priority: 0,
2078 }],
2079 cx,
2080 )
2081 });
2082
2083 pretty_assertions::assert_eq!(
2084 cx.update(|cx| syntax_chunks(DisplayRow(0)..DisplayRow(7), &map, &theme, cx)),
2085 [
2086 ("const".into(), Some(Hsla::green())),
2087 (" A".into(), None),
2088 (":".into(), Some(Hsla::blue())),
2089 (" &str = ".into(), None),
2090 ("\"\n one\n".into(), Some(Hsla::red())),
2091 ("\n".into(), None),
2092 (" two\n three\n\"".into(), Some(Hsla::red())),
2093 (";".into(), Some(Hsla::blue())),
2094 ("\n".into(), None),
2095 ("const".into(), Some(Hsla::green())),
2096 (" B".into(), None),
2097 (":".into(), Some(Hsla::blue())),
2098 (" &str = ".into(), None),
2099 ("\"four\"".into(), Some(Hsla::red())),
2100 (";".into(), Some(Hsla::blue())),
2101 ("\n".into(), None),
2102 ]
2103 );
2104 }
2105
2106 #[gpui::test]
2107 async fn test_chunks_with_diagnostics_across_blocks(cx: &mut gpui::TestAppContext) {
2108 cx.background_executor
2109 .set_block_on_ticks(usize::MAX..=usize::MAX);
2110
2111 let text = r#"
2112 struct A {
2113 b: usize;
2114 }
2115 const c: usize = 1;
2116 "#
2117 .unindent();
2118
2119 cx.update(|cx| init_test(cx, |_| {}));
2120
2121 let buffer = cx.new(|cx| Buffer::local(text, cx));
2122
2123 buffer.update(cx, |buffer, cx| {
2124 buffer.update_diagnostics(
2125 LanguageServerId(0),
2126 DiagnosticSet::new(
2127 [DiagnosticEntry {
2128 range: PointUtf16::new(0, 0)..PointUtf16::new(2, 1),
2129 diagnostic: Diagnostic {
2130 severity: DiagnosticSeverity::ERROR,
2131 group_id: 1,
2132 message: "hi".into(),
2133 ..Default::default()
2134 },
2135 }],
2136 buffer,
2137 ),
2138 cx,
2139 )
2140 });
2141
2142 let buffer = cx.new(|cx| MultiBuffer::singleton(buffer, cx));
2143 let buffer_snapshot = buffer.read_with(cx, |buffer, cx| buffer.snapshot(cx));
2144
2145 let map = cx.new(|cx| {
2146 DisplayMap::new(
2147 buffer,
2148 font("Courier"),
2149 px(16.0),
2150 None,
2151 true,
2152 1,
2153 1,
2154 0,
2155 FoldPlaceholder::test(),
2156 cx,
2157 )
2158 });
2159
2160 let black = gpui::black().to_rgb();
2161 let red = gpui::red().to_rgb();
2162
2163 // Insert a block in the middle of a multi-line diagnostic.
2164 map.update(cx, |map, cx| {
2165 map.highlight_text(
2166 TypeId::of::<usize>(),
2167 vec![
2168 buffer_snapshot.anchor_before(Point::new(3, 9))
2169 ..buffer_snapshot.anchor_after(Point::new(3, 14)),
2170 buffer_snapshot.anchor_before(Point::new(3, 17))
2171 ..buffer_snapshot.anchor_after(Point::new(3, 18)),
2172 ],
2173 red.into(),
2174 );
2175 map.insert_blocks(
2176 [BlockProperties {
2177 placement: BlockPlacement::Below(
2178 buffer_snapshot.anchor_before(Point::new(1, 0)),
2179 ),
2180 height: 1,
2181 style: BlockStyle::Sticky,
2182 render: Arc::new(|_| div().into_any()),
2183 priority: 0,
2184 }],
2185 cx,
2186 )
2187 });
2188
2189 let snapshot = map.update(cx, |map, cx| map.snapshot(cx));
2190 let mut chunks = Vec::<(String, Option<DiagnosticSeverity>, Rgba)>::new();
2191 for chunk in snapshot.chunks(DisplayRow(0)..DisplayRow(5), true, Default::default()) {
2192 let color = chunk
2193 .highlight_style
2194 .and_then(|style| style.color)
2195 .map_or(black, |color| color.to_rgb());
2196 if let Some((last_chunk, last_severity, last_color)) = chunks.last_mut() {
2197 if *last_severity == chunk.diagnostic_severity && *last_color == color {
2198 last_chunk.push_str(chunk.text);
2199 continue;
2200 }
2201 }
2202
2203 chunks.push((chunk.text.to_string(), chunk.diagnostic_severity, color));
2204 }
2205
2206 assert_eq!(
2207 chunks,
2208 [
2209 (
2210 "struct A {\n b: usize;\n".into(),
2211 Some(DiagnosticSeverity::ERROR),
2212 black
2213 ),
2214 ("\n".into(), None, black),
2215 ("}".into(), Some(DiagnosticSeverity::ERROR), black),
2216 ("\nconst c: ".into(), None, black),
2217 ("usize".into(), None, red),
2218 (" = ".into(), None, black),
2219 ("1".into(), None, red),
2220 (";\n".into(), None, black),
2221 ]
2222 );
2223 }
2224
2225 #[gpui::test]
2226 async fn test_point_translation_with_replace_blocks(cx: &mut gpui::TestAppContext) {
2227 cx.background_executor
2228 .set_block_on_ticks(usize::MAX..=usize::MAX);
2229
2230 cx.update(|cx| init_test(cx, |_| {}));
2231
2232 let buffer = cx.update(|cx| MultiBuffer::build_simple("abcde\nfghij\nklmno\npqrst", cx));
2233 let buffer_snapshot = buffer.read_with(cx, |buffer, cx| buffer.snapshot(cx));
2234 let map = cx.new(|cx| {
2235 DisplayMap::new(
2236 buffer.clone(),
2237 font("Courier"),
2238 px(16.0),
2239 None,
2240 true,
2241 1,
2242 1,
2243 0,
2244 FoldPlaceholder::test(),
2245 cx,
2246 )
2247 });
2248
2249 let snapshot = map.update(cx, |map, cx| {
2250 map.insert_blocks(
2251 [BlockProperties {
2252 placement: BlockPlacement::Replace(
2253 buffer_snapshot.anchor_before(Point::new(1, 2))
2254 ..=buffer_snapshot.anchor_after(Point::new(2, 3)),
2255 ),
2256 height: 4,
2257 style: BlockStyle::Fixed,
2258 render: Arc::new(|_| div().into_any()),
2259 priority: 0,
2260 }],
2261 cx,
2262 );
2263 map.snapshot(cx)
2264 });
2265
2266 assert_eq!(snapshot.text(), "abcde\n\n\n\n\npqrst");
2267
2268 let point_to_display_points = [
2269 (Point::new(1, 0), DisplayPoint::new(DisplayRow(1), 0)),
2270 (Point::new(2, 0), DisplayPoint::new(DisplayRow(1), 0)),
2271 (Point::new(3, 0), DisplayPoint::new(DisplayRow(5), 0)),
2272 ];
2273 for (buffer_point, display_point) in point_to_display_points {
2274 assert_eq!(
2275 snapshot.point_to_display_point(buffer_point, Bias::Left),
2276 display_point,
2277 "point_to_display_point({:?}, Bias::Left)",
2278 buffer_point
2279 );
2280 assert_eq!(
2281 snapshot.point_to_display_point(buffer_point, Bias::Right),
2282 display_point,
2283 "point_to_display_point({:?}, Bias::Right)",
2284 buffer_point
2285 );
2286 }
2287
2288 let display_points_to_points = [
2289 (
2290 DisplayPoint::new(DisplayRow(1), 0),
2291 Point::new(1, 0),
2292 Point::new(2, 5),
2293 ),
2294 (
2295 DisplayPoint::new(DisplayRow(2), 0),
2296 Point::new(1, 0),
2297 Point::new(2, 5),
2298 ),
2299 (
2300 DisplayPoint::new(DisplayRow(3), 0),
2301 Point::new(1, 0),
2302 Point::new(2, 5),
2303 ),
2304 (
2305 DisplayPoint::new(DisplayRow(4), 0),
2306 Point::new(1, 0),
2307 Point::new(2, 5),
2308 ),
2309 (
2310 DisplayPoint::new(DisplayRow(5), 0),
2311 Point::new(3, 0),
2312 Point::new(3, 0),
2313 ),
2314 ];
2315 for (display_point, left_buffer_point, right_buffer_point) in display_points_to_points {
2316 assert_eq!(
2317 snapshot.display_point_to_point(display_point, Bias::Left),
2318 left_buffer_point,
2319 "display_point_to_point({:?}, Bias::Left)",
2320 display_point
2321 );
2322 assert_eq!(
2323 snapshot.display_point_to_point(display_point, Bias::Right),
2324 right_buffer_point,
2325 "display_point_to_point({:?}, Bias::Right)",
2326 display_point
2327 );
2328 }
2329 }
2330
2331 // todo(linux) fails due to pixel differences in text rendering
2332 #[cfg(target_os = "macos")]
2333 #[gpui::test]
2334 async fn test_chunks_with_soft_wrapping(cx: &mut gpui::TestAppContext) {
2335 cx.background_executor
2336 .set_block_on_ticks(usize::MAX..=usize::MAX);
2337
2338 let text = r#"
2339 fn outer() {}
2340
2341 mod module {
2342 fn inner() {}
2343 }"#
2344 .unindent();
2345
2346 let theme =
2347 SyntaxTheme::new_test(vec![("mod.body", Hsla::red()), ("fn.name", Hsla::blue())]);
2348 let language = Arc::new(
2349 Language::new(
2350 LanguageConfig {
2351 name: "Test".into(),
2352 matcher: LanguageMatcher {
2353 path_suffixes: vec![".test".to_string()],
2354 ..Default::default()
2355 },
2356 ..Default::default()
2357 },
2358 Some(tree_sitter_rust::LANGUAGE.into()),
2359 )
2360 .with_highlights_query(
2361 r#"
2362 (mod_item name: (identifier) body: _ @mod.body)
2363 (function_item name: (identifier) @fn.name)
2364 "#,
2365 )
2366 .unwrap(),
2367 );
2368 language.set_theme(&theme);
2369
2370 cx.update(|cx| init_test(cx, |_| {}));
2371
2372 let buffer = cx.new(|cx| Buffer::local(text, cx).with_language(language, cx));
2373 cx.condition(&buffer, |buf, _| !buf.is_parsing()).await;
2374 let buffer = cx.new(|cx| MultiBuffer::singleton(buffer, cx));
2375
2376 let font_size = px(16.0);
2377
2378 let map = cx.new(|cx| {
2379 DisplayMap::new(
2380 buffer,
2381 font("Courier"),
2382 font_size,
2383 Some(px(40.0)),
2384 true,
2385 1,
2386 1,
2387 0,
2388 FoldPlaceholder::test(),
2389 cx,
2390 )
2391 });
2392 assert_eq!(
2393 cx.update(|cx| syntax_chunks(DisplayRow(0)..DisplayRow(5), &map, &theme, cx)),
2394 [
2395 ("fn \n".to_string(), None),
2396 ("oute\nr".to_string(), Some(Hsla::blue())),
2397 ("() \n{}\n\n".to_string(), None),
2398 ]
2399 );
2400 assert_eq!(
2401 cx.update(|cx| syntax_chunks(DisplayRow(3)..DisplayRow(5), &map, &theme, cx)),
2402 [("{}\n\n".to_string(), None)]
2403 );
2404
2405 map.update(cx, |map, cx| {
2406 map.fold(
2407 vec![Crease::simple(
2408 MultiBufferPoint::new(0, 6)..MultiBufferPoint::new(3, 2),
2409 FoldPlaceholder::test(),
2410 )],
2411 cx,
2412 )
2413 });
2414 assert_eq!(
2415 cx.update(|cx| syntax_chunks(DisplayRow(1)..DisplayRow(4), &map, &theme, cx)),
2416 [
2417 ("out".to_string(), Some(Hsla::blue())),
2418 ("⋯\n".to_string(), None),
2419 (" \nfn ".to_string(), Some(Hsla::red())),
2420 ("i\n".to_string(), Some(Hsla::blue()))
2421 ]
2422 );
2423 }
2424
2425 #[gpui::test]
2426 async fn test_chunks_with_text_highlights(cx: &mut gpui::TestAppContext) {
2427 cx.update(|cx| init_test(cx, |_| {}));
2428
2429 let theme =
2430 SyntaxTheme::new_test(vec![("operator", Hsla::red()), ("string", Hsla::green())]);
2431 let language = Arc::new(
2432 Language::new(
2433 LanguageConfig {
2434 name: "Test".into(),
2435 matcher: LanguageMatcher {
2436 path_suffixes: vec![".test".to_string()],
2437 ..Default::default()
2438 },
2439 ..Default::default()
2440 },
2441 Some(tree_sitter_rust::LANGUAGE.into()),
2442 )
2443 .with_highlights_query(
2444 r#"
2445 ":" @operator
2446 (string_literal) @string
2447 "#,
2448 )
2449 .unwrap(),
2450 );
2451 language.set_theme(&theme);
2452
2453 let (text, highlighted_ranges) = marked_text_ranges(r#"constˇ «a»: B = "c «d»""#, false);
2454
2455 let buffer = cx.new(|cx| Buffer::local(text, cx).with_language(language, cx));
2456 cx.condition(&buffer, |buf, _| !buf.is_parsing()).await;
2457
2458 let buffer = cx.new(|cx| MultiBuffer::singleton(buffer, cx));
2459 let buffer_snapshot = buffer.read_with(cx, |buffer, cx| buffer.snapshot(cx));
2460
2461 let font_size = px(16.0);
2462 let map = cx.new(|cx| {
2463 DisplayMap::new(
2464 buffer,
2465 font("Courier"),
2466 font_size,
2467 None,
2468 true,
2469 1,
2470 1,
2471 1,
2472 FoldPlaceholder::test(),
2473 cx,
2474 )
2475 });
2476
2477 enum MyType {}
2478
2479 let style = HighlightStyle {
2480 color: Some(Hsla::blue()),
2481 ..Default::default()
2482 };
2483
2484 map.update(cx, |map, _cx| {
2485 map.highlight_text(
2486 TypeId::of::<MyType>(),
2487 highlighted_ranges
2488 .into_iter()
2489 .map(|range| {
2490 buffer_snapshot.anchor_before(range.start)
2491 ..buffer_snapshot.anchor_before(range.end)
2492 })
2493 .collect(),
2494 style,
2495 );
2496 });
2497
2498 assert_eq!(
2499 cx.update(|cx| chunks(DisplayRow(0)..DisplayRow(10), &map, &theme, cx)),
2500 [
2501 ("const ".to_string(), None, None),
2502 ("a".to_string(), None, Some(Hsla::blue())),
2503 (":".to_string(), Some(Hsla::red()), None),
2504 (" B = ".to_string(), None, None),
2505 ("\"c ".to_string(), Some(Hsla::green()), None),
2506 ("d".to_string(), Some(Hsla::green()), Some(Hsla::blue())),
2507 ("\"".to_string(), Some(Hsla::green()), None),
2508 ]
2509 );
2510 }
2511
2512 #[gpui::test]
2513 fn test_clip_point(cx: &mut gpui::App) {
2514 init_test(cx, |_| {});
2515
2516 fn assert(text: &str, shift_right: bool, bias: Bias, cx: &mut gpui::App) {
2517 let (unmarked_snapshot, mut markers) = marked_display_snapshot(text, cx);
2518
2519 match bias {
2520 Bias::Left => {
2521 if shift_right {
2522 *markers[1].column_mut() += 1;
2523 }
2524
2525 assert_eq!(unmarked_snapshot.clip_point(markers[1], bias), markers[0])
2526 }
2527 Bias::Right => {
2528 if shift_right {
2529 *markers[0].column_mut() += 1;
2530 }
2531
2532 assert_eq!(unmarked_snapshot.clip_point(markers[0], bias), markers[1])
2533 }
2534 };
2535 }
2536
2537 use Bias::{Left, Right};
2538 assert("ˇˇα", false, Left, cx);
2539 assert("ˇˇα", true, Left, cx);
2540 assert("ˇˇα", false, Right, cx);
2541 assert("ˇαˇ", true, Right, cx);
2542 assert("ˇˇ✋", false, Left, cx);
2543 assert("ˇˇ✋", true, Left, cx);
2544 assert("ˇˇ✋", false, Right, cx);
2545 assert("ˇ✋ˇ", true, Right, cx);
2546 assert("ˇˇ🍐", false, Left, cx);
2547 assert("ˇˇ🍐", true, Left, cx);
2548 assert("ˇˇ🍐", false, Right, cx);
2549 assert("ˇ🍐ˇ", true, Right, cx);
2550 assert("ˇˇ\t", false, Left, cx);
2551 assert("ˇˇ\t", true, Left, cx);
2552 assert("ˇˇ\t", false, Right, cx);
2553 assert("ˇ\tˇ", true, Right, cx);
2554 assert(" ˇˇ\t", false, Left, cx);
2555 assert(" ˇˇ\t", true, Left, cx);
2556 assert(" ˇˇ\t", false, Right, cx);
2557 assert(" ˇ\tˇ", true, Right, cx);
2558 assert(" ˇˇ\t", false, Left, cx);
2559 assert(" ˇˇ\t", false, Right, cx);
2560 }
2561
2562 #[gpui::test]
2563 fn test_clip_at_line_ends(cx: &mut gpui::App) {
2564 init_test(cx, |_| {});
2565
2566 fn assert(text: &str, cx: &mut gpui::App) {
2567 let (mut unmarked_snapshot, markers) = marked_display_snapshot(text, cx);
2568 unmarked_snapshot.clip_at_line_ends = true;
2569 assert_eq!(
2570 unmarked_snapshot.clip_point(markers[1], Bias::Left),
2571 markers[0]
2572 );
2573 }
2574
2575 assert("ˇˇ", cx);
2576 assert("ˇaˇ", cx);
2577 assert("aˇbˇ", cx);
2578 assert("aˇαˇ", cx);
2579 }
2580
2581 #[gpui::test]
2582 fn test_creases(cx: &mut gpui::App) {
2583 init_test(cx, |_| {});
2584
2585 let text = "aaa\nbbb\nccc\nddd\neee\nfff\nggg\nhhh\niii\njjj\nkkk\nlll";
2586 let buffer = MultiBuffer::build_simple(text, cx);
2587 let font_size = px(14.0);
2588 cx.new(|cx| {
2589 let mut map = DisplayMap::new(
2590 buffer.clone(),
2591 font("Helvetica"),
2592 font_size,
2593 None,
2594 true,
2595 1,
2596 1,
2597 0,
2598 FoldPlaceholder::test(),
2599 cx,
2600 );
2601 let snapshot = map.buffer.read(cx).snapshot(cx);
2602 let range =
2603 snapshot.anchor_before(Point::new(2, 0))..snapshot.anchor_after(Point::new(3, 3));
2604
2605 map.crease_map.insert(
2606 [Crease::inline(
2607 range,
2608 FoldPlaceholder::test(),
2609 |_row, _status, _toggle, _window, _cx| div(),
2610 |_row, _status, _window, _cx| div(),
2611 )],
2612 &map.buffer.read(cx).snapshot(cx),
2613 );
2614
2615 map
2616 });
2617 }
2618
2619 #[gpui::test]
2620 fn test_tabs_with_multibyte_chars(cx: &mut gpui::App) {
2621 init_test(cx, |_| {});
2622
2623 let text = "✅\t\tα\nβ\t\n🏀β\t\tγ";
2624 let buffer = MultiBuffer::build_simple(text, cx);
2625 let font_size = px(14.0);
2626
2627 let map = cx.new(|cx| {
2628 DisplayMap::new(
2629 buffer.clone(),
2630 font("Helvetica"),
2631 font_size,
2632 None,
2633 true,
2634 1,
2635 1,
2636 0,
2637 FoldPlaceholder::test(),
2638 cx,
2639 )
2640 });
2641 let map = map.update(cx, |map, cx| map.snapshot(cx));
2642 assert_eq!(map.text(), "✅ α\nβ \n🏀β γ");
2643 assert_eq!(
2644 map.text_chunks(DisplayRow(0)).collect::<String>(),
2645 "✅ α\nβ \n🏀β γ"
2646 );
2647 assert_eq!(
2648 map.text_chunks(DisplayRow(1)).collect::<String>(),
2649 "β \n🏀β γ"
2650 );
2651 assert_eq!(
2652 map.text_chunks(DisplayRow(2)).collect::<String>(),
2653 "🏀β γ"
2654 );
2655
2656 let point = MultiBufferPoint::new(0, "✅\t\t".len() as u32);
2657 let display_point = DisplayPoint::new(DisplayRow(0), "✅ ".len() as u32);
2658 assert_eq!(point.to_display_point(&map), display_point);
2659 assert_eq!(display_point.to_point(&map), point);
2660
2661 let point = MultiBufferPoint::new(1, "β\t".len() as u32);
2662 let display_point = DisplayPoint::new(DisplayRow(1), "β ".len() as u32);
2663 assert_eq!(point.to_display_point(&map), display_point);
2664 assert_eq!(display_point.to_point(&map), point,);
2665
2666 let point = MultiBufferPoint::new(2, "🏀β\t\t".len() as u32);
2667 let display_point = DisplayPoint::new(DisplayRow(2), "🏀β ".len() as u32);
2668 assert_eq!(point.to_display_point(&map), display_point);
2669 assert_eq!(display_point.to_point(&map), point,);
2670
2671 // Display points inside of expanded tabs
2672 assert_eq!(
2673 DisplayPoint::new(DisplayRow(0), "✅ ".len() as u32).to_point(&map),
2674 MultiBufferPoint::new(0, "✅\t".len() as u32),
2675 );
2676 assert_eq!(
2677 DisplayPoint::new(DisplayRow(0), "✅ ".len() as u32).to_point(&map),
2678 MultiBufferPoint::new(0, "✅".len() as u32),
2679 );
2680
2681 // Clipping display points inside of multi-byte characters
2682 assert_eq!(
2683 map.clip_point(
2684 DisplayPoint::new(DisplayRow(0), "✅".len() as u32 - 1),
2685 Left
2686 ),
2687 DisplayPoint::new(DisplayRow(0), 0)
2688 );
2689 assert_eq!(
2690 map.clip_point(
2691 DisplayPoint::new(DisplayRow(0), "✅".len() as u32 - 1),
2692 Bias::Right
2693 ),
2694 DisplayPoint::new(DisplayRow(0), "✅".len() as u32)
2695 );
2696 }
2697
2698 #[gpui::test]
2699 fn test_max_point(cx: &mut gpui::App) {
2700 init_test(cx, |_| {});
2701
2702 let buffer = MultiBuffer::build_simple("aaa\n\t\tbbb", cx);
2703 let font_size = px(14.0);
2704 let map = cx.new(|cx| {
2705 DisplayMap::new(
2706 buffer.clone(),
2707 font("Helvetica"),
2708 font_size,
2709 None,
2710 true,
2711 1,
2712 1,
2713 0,
2714 FoldPlaceholder::test(),
2715 cx,
2716 )
2717 });
2718 assert_eq!(
2719 map.update(cx, |map, cx| map.snapshot(cx)).max_point(),
2720 DisplayPoint::new(DisplayRow(1), 11)
2721 )
2722 }
2723
2724 fn syntax_chunks(
2725 rows: Range<DisplayRow>,
2726 map: &Entity<DisplayMap>,
2727 theme: &SyntaxTheme,
2728 cx: &mut App,
2729 ) -> Vec<(String, Option<Hsla>)> {
2730 chunks(rows, map, theme, cx)
2731 .into_iter()
2732 .map(|(text, color, _)| (text, color))
2733 .collect()
2734 }
2735
2736 fn chunks(
2737 rows: Range<DisplayRow>,
2738 map: &Entity<DisplayMap>,
2739 theme: &SyntaxTheme,
2740 cx: &mut App,
2741 ) -> Vec<(String, Option<Hsla>, Option<Hsla>)> {
2742 let snapshot = map.update(cx, |map, cx| map.snapshot(cx));
2743 let mut chunks: Vec<(String, Option<Hsla>, Option<Hsla>)> = Vec::new();
2744 for chunk in snapshot.chunks(rows, true, HighlightStyles::default()) {
2745 let syntax_color = chunk
2746 .syntax_highlight_id
2747 .and_then(|id| id.style(theme)?.color);
2748 let highlight_color = chunk.highlight_style.and_then(|style| style.color);
2749 if let Some((last_chunk, last_syntax_color, last_highlight_color)) = chunks.last_mut() {
2750 if syntax_color == *last_syntax_color && highlight_color == *last_highlight_color {
2751 last_chunk.push_str(chunk.text);
2752 continue;
2753 }
2754 }
2755 chunks.push((chunk.text.to_string(), syntax_color, highlight_color));
2756 }
2757 chunks
2758 }
2759
2760 fn init_test(cx: &mut App, f: impl Fn(&mut AllLanguageSettingsContent)) {
2761 let settings = SettingsStore::test(cx);
2762 cx.set_global(settings);
2763 language::init(cx);
2764 crate::init(cx);
2765 Project::init_settings(cx);
2766 theme::init(LoadThemes::JustBase, cx);
2767 cx.update_global::<SettingsStore, _>(|store, cx| {
2768 store.update_user_settings::<AllLanguageSettings>(cx, f);
2769 });
2770 }
2771}