display_map.rs

   1mod block_map;
   2mod fold_map;
   3mod tab_map;
   4mod wrap_map;
   5
   6use crate::{Anchor, AnchorRangeExt, MultiBuffer, MultiBufferSnapshot, ToOffset, ToPoint};
   7use block_map::{BlockMap, BlockPoint};
   8use collections::{HashMap, HashSet};
   9use fold_map::FoldMap;
  10use gpui::{
  11    fonts::{FontId, HighlightStyle},
  12    Entity, ModelContext, ModelHandle,
  13};
  14use language::{OffsetUtf16, Point, Subscription as BufferSubscription};
  15use settings::Settings;
  16use std::{any::TypeId, fmt::Debug, num::NonZeroU32, ops::Range, sync::Arc};
  17use sum_tree::{Bias, TreeMap};
  18use tab_map::TabMap;
  19use wrap_map::WrapMap;
  20
  21pub use block_map::{
  22    BlockBufferRows as DisplayBufferRows, BlockChunks as DisplayChunks, BlockContext,
  23    BlockDisposition, BlockId, BlockProperties, BlockStyle, RenderBlock, TransformBlock,
  24};
  25
  26pub trait ToDisplayPoint {
  27    fn to_display_point(&self, map: &DisplaySnapshot) -> DisplayPoint;
  28}
  29
  30type TextHighlights = TreeMap<Option<TypeId>, Arc<(HighlightStyle, Vec<Range<Anchor>>)>>;
  31
  32pub struct DisplayMap {
  33    buffer: ModelHandle<MultiBuffer>,
  34    buffer_subscription: BufferSubscription,
  35    fold_map: FoldMap,
  36    tab_map: TabMap,
  37    wrap_map: ModelHandle<WrapMap>,
  38    block_map: BlockMap,
  39    text_highlights: TextHighlights,
  40    pub clip_at_line_ends: bool,
  41}
  42
  43impl Entity for DisplayMap {
  44    type Event = ();
  45}
  46
  47impl DisplayMap {
  48    pub fn new(
  49        buffer: ModelHandle<MultiBuffer>,
  50        font_id: FontId,
  51        font_size: f32,
  52        wrap_width: Option<f32>,
  53        buffer_header_height: u8,
  54        excerpt_header_height: u8,
  55        cx: &mut ModelContext<Self>,
  56    ) -> Self {
  57        let buffer_subscription = buffer.update(cx, |buffer, _| buffer.subscribe());
  58
  59        let tab_size = Self::tab_size(&buffer, cx);
  60        let (fold_map, snapshot) = FoldMap::new(buffer.read(cx).snapshot(cx));
  61        let (tab_map, snapshot) = TabMap::new(snapshot, tab_size);
  62        let (wrap_map, snapshot) = WrapMap::new(snapshot, font_id, font_size, wrap_width, cx);
  63        let block_map = BlockMap::new(snapshot, buffer_header_height, excerpt_header_height);
  64        cx.observe(&wrap_map, |_, _, cx| cx.notify()).detach();
  65        DisplayMap {
  66            buffer,
  67            buffer_subscription,
  68            fold_map,
  69            tab_map,
  70            wrap_map,
  71            block_map,
  72            text_highlights: Default::default(),
  73            clip_at_line_ends: false,
  74        }
  75    }
  76
  77    pub fn snapshot(&self, cx: &mut ModelContext<Self>) -> DisplaySnapshot {
  78        let buffer_snapshot = self.buffer.read(cx).snapshot(cx);
  79        let edits = self.buffer_subscription.consume().into_inner();
  80        let (folds_snapshot, edits) = self.fold_map.read(buffer_snapshot, edits);
  81
  82        let tab_size = Self::tab_size(&self.buffer, cx);
  83        let (tabs_snapshot, edits) = self.tab_map.sync(folds_snapshot.clone(), edits, tab_size);
  84        let (wraps_snapshot, edits) = self
  85            .wrap_map
  86            .update(cx, |map, cx| map.sync(tabs_snapshot.clone(), edits, cx));
  87        let blocks_snapshot = self.block_map.read(wraps_snapshot.clone(), edits);
  88
  89        DisplaySnapshot {
  90            buffer_snapshot: self.buffer.read(cx).snapshot(cx),
  91            folds_snapshot,
  92            tabs_snapshot,
  93            wraps_snapshot,
  94            blocks_snapshot,
  95            text_highlights: self.text_highlights.clone(),
  96            clip_at_line_ends: self.clip_at_line_ends,
  97        }
  98    }
  99
 100    pub fn set_state(&mut self, other: &DisplaySnapshot, cx: &mut ModelContext<Self>) {
 101        self.fold(
 102            other
 103                .folds_in_range(0..other.buffer_snapshot.len())
 104                .map(|fold| fold.to_offset(&other.buffer_snapshot)),
 105            cx,
 106        );
 107    }
 108
 109    pub fn fold<T: ToOffset>(
 110        &mut self,
 111        ranges: impl IntoIterator<Item = Range<T>>,
 112        cx: &mut ModelContext<Self>,
 113    ) {
 114        let snapshot = self.buffer.read(cx).snapshot(cx);
 115        let edits = self.buffer_subscription.consume().into_inner();
 116        let tab_size = Self::tab_size(&self.buffer, cx);
 117        let (mut fold_map, snapshot, edits) = self.fold_map.write(snapshot, edits);
 118        let (snapshot, edits) = self.tab_map.sync(snapshot, edits, tab_size);
 119        let (snapshot, edits) = self
 120            .wrap_map
 121            .update(cx, |map, cx| map.sync(snapshot, edits, cx));
 122        self.block_map.read(snapshot, edits);
 123        let (snapshot, edits) = fold_map.fold(ranges);
 124        let (snapshot, edits) = self.tab_map.sync(snapshot, edits, tab_size);
 125        let (snapshot, edits) = self
 126            .wrap_map
 127            .update(cx, |map, cx| map.sync(snapshot, edits, cx));
 128        self.block_map.read(snapshot, edits);
 129    }
 130
 131    pub fn unfold<T: ToOffset>(
 132        &mut self,
 133        ranges: impl IntoIterator<Item = Range<T>>,
 134        inclusive: bool,
 135        cx: &mut ModelContext<Self>,
 136    ) {
 137        let snapshot = self.buffer.read(cx).snapshot(cx);
 138        let edits = self.buffer_subscription.consume().into_inner();
 139        let tab_size = Self::tab_size(&self.buffer, cx);
 140        let (mut fold_map, snapshot, edits) = self.fold_map.write(snapshot, edits);
 141        let (snapshot, edits) = self.tab_map.sync(snapshot, edits, tab_size);
 142        let (snapshot, edits) = self
 143            .wrap_map
 144            .update(cx, |map, cx| map.sync(snapshot, edits, cx));
 145        self.block_map.read(snapshot, edits);
 146        let (snapshot, edits) = fold_map.unfold(ranges, inclusive);
 147        let (snapshot, edits) = self.tab_map.sync(snapshot, edits, tab_size);
 148        let (snapshot, edits) = self
 149            .wrap_map
 150            .update(cx, |map, cx| map.sync(snapshot, edits, cx));
 151        self.block_map.read(snapshot, edits);
 152    }
 153
 154    pub fn insert_blocks(
 155        &mut self,
 156        blocks: impl IntoIterator<Item = BlockProperties<Anchor>>,
 157        cx: &mut ModelContext<Self>,
 158    ) -> Vec<BlockId> {
 159        let snapshot = self.buffer.read(cx).snapshot(cx);
 160        let edits = self.buffer_subscription.consume().into_inner();
 161        let tab_size = Self::tab_size(&self.buffer, cx);
 162        let (snapshot, edits) = self.fold_map.read(snapshot, edits);
 163        let (snapshot, edits) = self.tab_map.sync(snapshot, edits, tab_size);
 164        let (snapshot, edits) = self
 165            .wrap_map
 166            .update(cx, |map, cx| map.sync(snapshot, edits, cx));
 167        let mut block_map = self.block_map.write(snapshot, edits);
 168        block_map.insert(blocks)
 169    }
 170
 171    pub fn replace_blocks(&mut self, styles: HashMap<BlockId, RenderBlock>) {
 172        self.block_map.replace(styles);
 173    }
 174
 175    pub fn remove_blocks(&mut self, ids: HashSet<BlockId>, cx: &mut ModelContext<Self>) {
 176        let snapshot = self.buffer.read(cx).snapshot(cx);
 177        let edits = self.buffer_subscription.consume().into_inner();
 178        let tab_size = Self::tab_size(&self.buffer, cx);
 179        let (snapshot, edits) = self.fold_map.read(snapshot, edits);
 180        let (snapshot, edits) = self.tab_map.sync(snapshot, edits, tab_size);
 181        let (snapshot, edits) = self
 182            .wrap_map
 183            .update(cx, |map, cx| map.sync(snapshot, edits, cx));
 184        let mut block_map = self.block_map.write(snapshot, edits);
 185        block_map.remove(ids);
 186    }
 187
 188    pub fn highlight_text(
 189        &mut self,
 190        type_id: TypeId,
 191        ranges: Vec<Range<Anchor>>,
 192        style: HighlightStyle,
 193    ) {
 194        self.text_highlights
 195            .insert(Some(type_id), Arc::new((style, ranges)));
 196    }
 197
 198    pub fn text_highlights(&self, type_id: TypeId) -> Option<(HighlightStyle, &[Range<Anchor>])> {
 199        let highlights = self.text_highlights.get(&Some(type_id))?;
 200        Some((highlights.0, &highlights.1))
 201    }
 202
 203    pub fn clear_text_highlights(
 204        &mut self,
 205        type_id: TypeId,
 206    ) -> Option<Arc<(HighlightStyle, Vec<Range<Anchor>>)>> {
 207        self.text_highlights.remove(&Some(type_id))
 208    }
 209
 210    pub fn set_font(&self, font_id: FontId, font_size: f32, cx: &mut ModelContext<Self>) -> bool {
 211        self.wrap_map
 212            .update(cx, |map, cx| map.set_font(font_id, font_size, cx))
 213    }
 214
 215    pub fn set_wrap_width(&self, width: Option<f32>, cx: &mut ModelContext<Self>) -> bool {
 216        self.wrap_map
 217            .update(cx, |map, cx| map.set_wrap_width(width, cx))
 218    }
 219
 220    fn tab_size(buffer: &ModelHandle<MultiBuffer>, cx: &mut ModelContext<Self>) -> NonZeroU32 {
 221        let language_name = buffer
 222            .read(cx)
 223            .as_singleton()
 224            .and_then(|buffer| buffer.read(cx).language())
 225            .map(|language| language.name());
 226
 227        cx.global::<Settings>().tab_size(language_name.as_deref())
 228    }
 229
 230    #[cfg(test)]
 231    pub fn is_rewrapping(&self, cx: &gpui::AppContext) -> bool {
 232        self.wrap_map.read(cx).is_rewrapping()
 233    }
 234}
 235
 236pub struct DisplaySnapshot {
 237    pub buffer_snapshot: MultiBufferSnapshot,
 238    folds_snapshot: fold_map::FoldSnapshot,
 239    tabs_snapshot: tab_map::TabSnapshot,
 240    wraps_snapshot: wrap_map::WrapSnapshot,
 241    blocks_snapshot: block_map::BlockSnapshot,
 242    text_highlights: TextHighlights,
 243    clip_at_line_ends: bool,
 244}
 245
 246impl DisplaySnapshot {
 247    #[cfg(test)]
 248    pub fn fold_count(&self) -> usize {
 249        self.folds_snapshot.fold_count()
 250    }
 251
 252    pub fn is_empty(&self) -> bool {
 253        self.buffer_snapshot.len() == 0
 254    }
 255
 256    pub fn buffer_rows<'a>(&'a self, start_row: u32) -> DisplayBufferRows<'a> {
 257        self.blocks_snapshot.buffer_rows(start_row)
 258    }
 259
 260    pub fn max_buffer_row(&self) -> u32 {
 261        self.buffer_snapshot.max_buffer_row()
 262    }
 263
 264    pub fn prev_line_boundary(&self, mut point: Point) -> (Point, DisplayPoint) {
 265        loop {
 266            let mut fold_point = self.folds_snapshot.to_fold_point(point, Bias::Left);
 267            *fold_point.column_mut() = 0;
 268            point = fold_point.to_buffer_point(&self.folds_snapshot);
 269
 270            let mut display_point = self.point_to_display_point(point, Bias::Left);
 271            *display_point.column_mut() = 0;
 272            let next_point = self.display_point_to_point(display_point, Bias::Left);
 273            if next_point == point {
 274                return (point, display_point);
 275            }
 276            point = next_point;
 277        }
 278    }
 279
 280    pub fn next_line_boundary(&self, mut point: Point) -> (Point, DisplayPoint) {
 281        loop {
 282            let mut fold_point = self.folds_snapshot.to_fold_point(point, Bias::Right);
 283            *fold_point.column_mut() = self.folds_snapshot.line_len(fold_point.row());
 284            point = fold_point.to_buffer_point(&self.folds_snapshot);
 285
 286            let mut display_point = self.point_to_display_point(point, Bias::Right);
 287            *display_point.column_mut() = self.line_len(display_point.row());
 288            let next_point = self.display_point_to_point(display_point, Bias::Right);
 289            if next_point == point {
 290                return (point, display_point);
 291            }
 292            point = next_point;
 293        }
 294    }
 295
 296    pub fn expand_to_line(&self, range: Range<Point>) -> Range<Point> {
 297        let mut new_start = self.prev_line_boundary(range.start).0;
 298        let mut new_end = self.next_line_boundary(range.end).0;
 299
 300        if new_start.row == range.start.row && new_end.row == range.end.row {
 301            if new_end.row < self.buffer_snapshot.max_point().row {
 302                new_end.row += 1;
 303                new_end.column = 0;
 304            } else if new_start.row > 0 {
 305                new_start.row -= 1;
 306                new_start.column = self.buffer_snapshot.line_len(new_start.row);
 307            }
 308        }
 309
 310        new_start..new_end
 311    }
 312
 313    fn point_to_display_point(&self, point: Point, bias: Bias) -> DisplayPoint {
 314        let fold_point = self.folds_snapshot.to_fold_point(point, bias);
 315        let tab_point = self.tabs_snapshot.to_tab_point(fold_point);
 316        let wrap_point = self.wraps_snapshot.from_tab_point(tab_point);
 317        let block_point = self.blocks_snapshot.to_block_point(wrap_point);
 318        DisplayPoint(block_point)
 319    }
 320
 321    fn display_point_to_point(&self, point: DisplayPoint, bias: Bias) -> Point {
 322        let block_point = point.0;
 323        let wrap_point = self.blocks_snapshot.to_wrap_point(block_point);
 324        let tab_point = self.wraps_snapshot.to_tab_point(wrap_point);
 325        let fold_point = self.tabs_snapshot.to_fold_point(tab_point, bias).0;
 326        fold_point.to_buffer_point(&self.folds_snapshot)
 327    }
 328
 329    pub fn max_point(&self) -> DisplayPoint {
 330        DisplayPoint(self.blocks_snapshot.max_point())
 331    }
 332
 333    pub fn text_chunks(&self, display_row: u32) -> impl Iterator<Item = &str> {
 334        self.blocks_snapshot
 335            .chunks(display_row..self.max_point().row() + 1, false, None)
 336            .map(|h| h.text)
 337    }
 338
 339    pub fn chunks<'a>(
 340        &'a self,
 341        display_rows: Range<u32>,
 342        language_aware: bool,
 343    ) -> DisplayChunks<'a> {
 344        self.blocks_snapshot
 345            .chunks(display_rows, language_aware, Some(&self.text_highlights))
 346    }
 347
 348    pub fn chars_at<'a>(&'a self, point: DisplayPoint) -> impl Iterator<Item = char> + 'a {
 349        let mut column = 0;
 350        let mut chars = self.text_chunks(point.row()).flat_map(str::chars);
 351        while column < point.column() {
 352            if let Some(c) = chars.next() {
 353                column += c.len_utf8() as u32;
 354            } else {
 355                break;
 356            }
 357        }
 358        chars
 359    }
 360
 361    pub fn column_to_chars(&self, display_row: u32, target: u32) -> u32 {
 362        let mut count = 0;
 363        let mut column = 0;
 364        for c in self.chars_at(DisplayPoint::new(display_row, 0)) {
 365            if column >= target {
 366                break;
 367            }
 368            count += 1;
 369            column += c.len_utf8() as u32;
 370        }
 371        count
 372    }
 373
 374    pub fn column_from_chars(&self, display_row: u32, char_count: u32) -> u32 {
 375        let mut count = 0;
 376        let mut column = 0;
 377        for c in self.chars_at(DisplayPoint::new(display_row, 0)) {
 378            if c == '\n' || count >= char_count {
 379                break;
 380            }
 381            count += 1;
 382            column += c.len_utf8() as u32;
 383        }
 384        column
 385    }
 386
 387    pub fn clip_point(&self, point: DisplayPoint, bias: Bias) -> DisplayPoint {
 388        let mut clipped = self.blocks_snapshot.clip_point(point.0, bias);
 389        if self.clip_at_line_ends {
 390            clipped = self.clip_at_line_end(DisplayPoint(clipped)).0
 391        }
 392        DisplayPoint(clipped)
 393    }
 394
 395    pub fn clip_at_line_end(&self, point: DisplayPoint) -> DisplayPoint {
 396        let mut point = point.0;
 397        if point.column == self.line_len(point.row) {
 398            point.column = point.column.saturating_sub(1);
 399            point = self.blocks_snapshot.clip_point(point, Bias::Left);
 400        }
 401        DisplayPoint(point)
 402    }
 403
 404    pub fn folds_in_range<'a, T>(
 405        &'a self,
 406        range: Range<T>,
 407    ) -> impl Iterator<Item = &'a Range<Anchor>>
 408    where
 409        T: ToOffset,
 410    {
 411        self.folds_snapshot.folds_in_range(range)
 412    }
 413
 414    pub fn blocks_in_range<'a>(
 415        &'a self,
 416        rows: Range<u32>,
 417    ) -> impl Iterator<Item = (u32, &'a TransformBlock)> {
 418        self.blocks_snapshot.blocks_in_range(rows)
 419    }
 420
 421    pub fn intersects_fold<T: ToOffset>(&self, offset: T) -> bool {
 422        self.folds_snapshot.intersects_fold(offset)
 423    }
 424
 425    pub fn is_line_folded(&self, display_row: u32) -> bool {
 426        let block_point = BlockPoint(Point::new(display_row, 0));
 427        let wrap_point = self.blocks_snapshot.to_wrap_point(block_point);
 428        let tab_point = self.wraps_snapshot.to_tab_point(wrap_point);
 429        self.folds_snapshot.is_line_folded(tab_point.row())
 430    }
 431
 432    pub fn is_block_line(&self, display_row: u32) -> bool {
 433        self.blocks_snapshot.is_block_line(display_row)
 434    }
 435
 436    pub fn soft_wrap_indent(&self, display_row: u32) -> Option<u32> {
 437        let wrap_row = self
 438            .blocks_snapshot
 439            .to_wrap_point(BlockPoint::new(display_row, 0))
 440            .row();
 441        self.wraps_snapshot.soft_wrap_indent(wrap_row)
 442    }
 443
 444    pub fn text(&self) -> String {
 445        self.text_chunks(0).collect()
 446    }
 447
 448    pub fn line(&self, display_row: u32) -> String {
 449        let mut result = String::new();
 450        for chunk in self.text_chunks(display_row) {
 451            if let Some(ix) = chunk.find('\n') {
 452                result.push_str(&chunk[0..ix]);
 453                break;
 454            } else {
 455                result.push_str(chunk);
 456            }
 457        }
 458        result
 459    }
 460
 461    pub fn line_indent(&self, display_row: u32) -> (u32, bool) {
 462        let mut indent = 0;
 463        let mut is_blank = true;
 464        for c in self.chars_at(DisplayPoint::new(display_row, 0)) {
 465            if c == ' ' {
 466                indent += 1;
 467            } else {
 468                is_blank = c == '\n';
 469                break;
 470            }
 471        }
 472        (indent, is_blank)
 473    }
 474
 475    pub fn line_len(&self, row: u32) -> u32 {
 476        self.blocks_snapshot.line_len(row)
 477    }
 478
 479    pub fn longest_row(&self) -> u32 {
 480        self.blocks_snapshot.longest_row()
 481    }
 482
 483    #[cfg(any(test, feature = "test-support"))]
 484    pub fn highlight_ranges<Tag: ?Sized + 'static>(
 485        &self,
 486    ) -> Option<Arc<(HighlightStyle, Vec<Range<Anchor>>)>> {
 487        let type_id = TypeId::of::<Tag>();
 488        self.text_highlights.get(&Some(type_id)).cloned()
 489    }
 490}
 491
 492#[derive(Copy, Clone, Default, Eq, Ord, PartialOrd, PartialEq)]
 493pub struct DisplayPoint(BlockPoint);
 494
 495impl Debug for DisplayPoint {
 496    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
 497        f.write_fmt(format_args!(
 498            "DisplayPoint({}, {})",
 499            self.row(),
 500            self.column()
 501        ))
 502    }
 503}
 504
 505impl DisplayPoint {
 506    pub fn new(row: u32, column: u32) -> Self {
 507        Self(BlockPoint(Point::new(row, column)))
 508    }
 509
 510    pub fn zero() -> Self {
 511        Self::new(0, 0)
 512    }
 513
 514    pub fn is_zero(&self) -> bool {
 515        self.0.is_zero()
 516    }
 517
 518    pub fn row(self) -> u32 {
 519        self.0.row
 520    }
 521
 522    pub fn column(self) -> u32 {
 523        self.0.column
 524    }
 525
 526    pub fn row_mut(&mut self) -> &mut u32 {
 527        &mut self.0.row
 528    }
 529
 530    pub fn column_mut(&mut self) -> &mut u32 {
 531        &mut self.0.column
 532    }
 533
 534    pub fn to_point(self, map: &DisplaySnapshot) -> Point {
 535        map.display_point_to_point(self, Bias::Left)
 536    }
 537
 538    pub fn to_offset(self, map: &DisplaySnapshot, bias: Bias) -> usize {
 539        let unblocked_point = map.blocks_snapshot.to_wrap_point(self.0);
 540        let unwrapped_point = map.wraps_snapshot.to_tab_point(unblocked_point);
 541        let unexpanded_point = map.tabs_snapshot.to_fold_point(unwrapped_point, bias).0;
 542        unexpanded_point.to_buffer_offset(&map.folds_snapshot)
 543    }
 544}
 545
 546impl ToDisplayPoint for usize {
 547    fn to_display_point(&self, map: &DisplaySnapshot) -> DisplayPoint {
 548        map.point_to_display_point(self.to_point(&map.buffer_snapshot), Bias::Left)
 549    }
 550}
 551
 552impl ToDisplayPoint for OffsetUtf16 {
 553    fn to_display_point(&self, map: &DisplaySnapshot) -> DisplayPoint {
 554        self.to_offset(&map.buffer_snapshot).to_display_point(map)
 555    }
 556}
 557
 558impl ToDisplayPoint for Point {
 559    fn to_display_point(&self, map: &DisplaySnapshot) -> DisplayPoint {
 560        map.point_to_display_point(*self, Bias::Left)
 561    }
 562}
 563
 564impl ToDisplayPoint for Anchor {
 565    fn to_display_point(&self, map: &DisplaySnapshot) -> DisplayPoint {
 566        self.to_point(&map.buffer_snapshot).to_display_point(map)
 567    }
 568}
 569
 570#[cfg(test)]
 571pub mod tests {
 572    use super::*;
 573    use crate::{movement, test::marked_display_snapshot};
 574    use gpui::{color::Color, elements::*, test::observe, MutableAppContext};
 575    use language::{Buffer, Language, LanguageConfig, RandomCharIter, SelectionGoal};
 576    use rand::{prelude::*, Rng};
 577    use smol::stream::StreamExt;
 578    use std::{env, sync::Arc};
 579    use theme::SyntaxTheme;
 580    use util::test::{marked_text_ranges, sample_text};
 581    use Bias::*;
 582
 583    #[gpui::test(iterations = 100)]
 584    async fn test_random_display_map(cx: &mut gpui::TestAppContext, mut rng: StdRng) {
 585        cx.foreground().set_block_on_ticks(0..=50);
 586        cx.foreground().forbid_parking();
 587        let operations = env::var("OPERATIONS")
 588            .map(|i| i.parse().expect("invalid `OPERATIONS` variable"))
 589            .unwrap_or(10);
 590
 591        let font_cache = cx.font_cache().clone();
 592        let tab_size = rng.gen_range(1..=4);
 593        let buffer_start_excerpt_header_height = rng.gen_range(1..=5);
 594        let excerpt_header_height = rng.gen_range(1..=5);
 595        let family_id = font_cache.load_family(&["Helvetica"]).unwrap();
 596        let font_id = font_cache
 597            .select_font(family_id, &Default::default())
 598            .unwrap();
 599        let font_size = 14.0;
 600        let max_wrap_width = 300.0;
 601        let mut wrap_width = if rng.gen_bool(0.1) {
 602            None
 603        } else {
 604            Some(rng.gen_range(0.0..=max_wrap_width))
 605        };
 606
 607        log::info!("tab size: {}", tab_size);
 608        log::info!("wrap width: {:?}", wrap_width);
 609
 610        cx.update(|cx| cx.set_global(Settings::test(cx)));
 611
 612        let buffer = cx.update(|cx| {
 613            if rng.gen() {
 614                let len = rng.gen_range(0..10);
 615                let text = RandomCharIter::new(&mut rng).take(len).collect::<String>();
 616                MultiBuffer::build_simple(&text, cx)
 617            } else {
 618                MultiBuffer::build_random(&mut rng, cx)
 619            }
 620        });
 621
 622        let map = cx.add_model(|cx| {
 623            DisplayMap::new(
 624                buffer.clone(),
 625                font_id,
 626                font_size,
 627                wrap_width,
 628                buffer_start_excerpt_header_height,
 629                excerpt_header_height,
 630                cx,
 631            )
 632        });
 633        let mut notifications = observe(&map, cx);
 634        let mut fold_count = 0;
 635        let mut blocks = Vec::new();
 636
 637        let snapshot = map.update(cx, |map, cx| map.snapshot(cx));
 638        log::info!("buffer text: {:?}", snapshot.buffer_snapshot.text());
 639        log::info!("fold text: {:?}", snapshot.folds_snapshot.text());
 640        log::info!("tab text: {:?}", snapshot.tabs_snapshot.text());
 641        log::info!("wrap text: {:?}", snapshot.wraps_snapshot.text());
 642        log::info!("block text: {:?}", snapshot.blocks_snapshot.text());
 643        log::info!("display text: {:?}", snapshot.text());
 644
 645        for _i in 0..operations {
 646            match rng.gen_range(0..100) {
 647                0..=19 => {
 648                    wrap_width = if rng.gen_bool(0.2) {
 649                        None
 650                    } else {
 651                        Some(rng.gen_range(0.0..=max_wrap_width))
 652                    };
 653                    log::info!("setting wrap width to {:?}", wrap_width);
 654                    map.update(cx, |map, cx| map.set_wrap_width(wrap_width, cx));
 655                }
 656                20..=44 => {
 657                    map.update(cx, |map, cx| {
 658                        if rng.gen() || blocks.is_empty() {
 659                            let buffer = map.snapshot(cx).buffer_snapshot;
 660                            let block_properties = (0..rng.gen_range(1..=1))
 661                                .map(|_| {
 662                                    let position =
 663                                        buffer.anchor_after(buffer.clip_offset(
 664                                            rng.gen_range(0..=buffer.len()),
 665                                            Bias::Left,
 666                                        ));
 667
 668                                    let disposition = if rng.gen() {
 669                                        BlockDisposition::Above
 670                                    } else {
 671                                        BlockDisposition::Below
 672                                    };
 673                                    let height = rng.gen_range(1..5);
 674                                    log::info!(
 675                                        "inserting block {:?} {:?} with height {}",
 676                                        disposition,
 677                                        position.to_point(&buffer),
 678                                        height
 679                                    );
 680                                    BlockProperties {
 681                                        style: BlockStyle::Fixed,
 682                                        position,
 683                                        height,
 684                                        disposition,
 685                                        render: Arc::new(|_| Empty::new().boxed()),
 686                                    }
 687                                })
 688                                .collect::<Vec<_>>();
 689                            blocks.extend(map.insert_blocks(block_properties, cx));
 690                        } else {
 691                            blocks.shuffle(&mut rng);
 692                            let remove_count = rng.gen_range(1..=4.min(blocks.len()));
 693                            let block_ids_to_remove = (0..remove_count)
 694                                .map(|_| blocks.remove(rng.gen_range(0..blocks.len())))
 695                                .collect();
 696                            log::info!("removing block ids {:?}", block_ids_to_remove);
 697                            map.remove_blocks(block_ids_to_remove, cx);
 698                        }
 699                    });
 700                }
 701                45..=79 => {
 702                    let mut ranges = Vec::new();
 703                    for _ in 0..rng.gen_range(1..=3) {
 704                        buffer.read_with(cx, |buffer, cx| {
 705                            let buffer = buffer.read(cx);
 706                            let end = buffer.clip_offset(rng.gen_range(0..=buffer.len()), Right);
 707                            let start = buffer.clip_offset(rng.gen_range(0..=end), Left);
 708                            ranges.push(start..end);
 709                        });
 710                    }
 711
 712                    if rng.gen() && fold_count > 0 {
 713                        log::info!("unfolding ranges: {:?}", ranges);
 714                        map.update(cx, |map, cx| {
 715                            map.unfold(ranges, true, cx);
 716                        });
 717                    } else {
 718                        log::info!("folding ranges: {:?}", ranges);
 719                        map.update(cx, |map, cx| {
 720                            map.fold(ranges, cx);
 721                        });
 722                    }
 723                }
 724                _ => {
 725                    buffer.update(cx, |buffer, cx| buffer.randomly_mutate(&mut rng, 5, cx));
 726                }
 727            }
 728
 729            if map.read_with(cx, |map, cx| map.is_rewrapping(cx)) {
 730                notifications.next().await.unwrap();
 731            }
 732
 733            let snapshot = map.update(cx, |map, cx| map.snapshot(cx));
 734            fold_count = snapshot.fold_count();
 735            log::info!("buffer text: {:?}", snapshot.buffer_snapshot.text());
 736            log::info!("fold text: {:?}", snapshot.folds_snapshot.text());
 737            log::info!("tab text: {:?}", snapshot.tabs_snapshot.text());
 738            log::info!("wrap text: {:?}", snapshot.wraps_snapshot.text());
 739            log::info!("block text: {:?}", snapshot.blocks_snapshot.text());
 740            log::info!("display text: {:?}", snapshot.text());
 741
 742            // Line boundaries
 743            let buffer = &snapshot.buffer_snapshot;
 744            for _ in 0..5 {
 745                let row = rng.gen_range(0..=buffer.max_point().row);
 746                let column = rng.gen_range(0..=buffer.line_len(row));
 747                let point = buffer.clip_point(Point::new(row, column), Left);
 748
 749                let (prev_buffer_bound, prev_display_bound) = snapshot.prev_line_boundary(point);
 750                let (next_buffer_bound, next_display_bound) = snapshot.next_line_boundary(point);
 751
 752                assert!(prev_buffer_bound <= point);
 753                assert!(next_buffer_bound >= point);
 754                assert_eq!(prev_buffer_bound.column, 0);
 755                assert_eq!(prev_display_bound.column(), 0);
 756                if next_buffer_bound < buffer.max_point() {
 757                    assert_eq!(buffer.chars_at(next_buffer_bound).next(), Some('\n'));
 758                }
 759
 760                assert_eq!(
 761                    prev_display_bound,
 762                    prev_buffer_bound.to_display_point(&snapshot),
 763                    "row boundary before {:?}. reported buffer row boundary: {:?}",
 764                    point,
 765                    prev_buffer_bound
 766                );
 767                assert_eq!(
 768                    next_display_bound,
 769                    next_buffer_bound.to_display_point(&snapshot),
 770                    "display row boundary after {:?}. reported buffer row boundary: {:?}",
 771                    point,
 772                    next_buffer_bound
 773                );
 774                assert_eq!(
 775                    prev_buffer_bound,
 776                    prev_display_bound.to_point(&snapshot),
 777                    "row boundary before {:?}. reported display row boundary: {:?}",
 778                    point,
 779                    prev_display_bound
 780                );
 781                assert_eq!(
 782                    next_buffer_bound,
 783                    next_display_bound.to_point(&snapshot),
 784                    "row boundary after {:?}. reported display row boundary: {:?}",
 785                    point,
 786                    next_display_bound
 787                );
 788            }
 789
 790            // Movement
 791            let min_point = snapshot.clip_point(DisplayPoint::new(0, 0), Left);
 792            let max_point = snapshot.clip_point(snapshot.max_point(), Right);
 793            for _ in 0..5 {
 794                let row = rng.gen_range(0..=snapshot.max_point().row());
 795                let column = rng.gen_range(0..=snapshot.line_len(row));
 796                let point = snapshot.clip_point(DisplayPoint::new(row, column), Left);
 797
 798                log::info!("Moving from point {:?}", point);
 799
 800                let moved_right = movement::right(&snapshot, point);
 801                log::info!("Right {:?}", moved_right);
 802                if point < max_point {
 803                    assert!(moved_right > point);
 804                    if point.column() == snapshot.line_len(point.row())
 805                        || snapshot.soft_wrap_indent(point.row()).is_some()
 806                            && point.column() == snapshot.line_len(point.row()) - 1
 807                    {
 808                        assert!(moved_right.row() > point.row());
 809                    }
 810                } else {
 811                    assert_eq!(moved_right, point);
 812                }
 813
 814                let moved_left = movement::left(&snapshot, point);
 815                log::info!("Left {:?}", moved_left);
 816                if point > min_point {
 817                    assert!(moved_left < point);
 818                    if point.column() == 0 {
 819                        assert!(moved_left.row() < point.row());
 820                    }
 821                } else {
 822                    assert_eq!(moved_left, point);
 823                }
 824            }
 825        }
 826    }
 827
 828    #[gpui::test(retries = 5)]
 829    fn test_soft_wraps(cx: &mut MutableAppContext) {
 830        cx.foreground().set_block_on_ticks(usize::MAX..=usize::MAX);
 831        cx.foreground().forbid_parking();
 832
 833        let font_cache = cx.font_cache();
 834
 835        let family_id = font_cache.load_family(&["Helvetica"]).unwrap();
 836        let font_id = font_cache
 837            .select_font(family_id, &Default::default())
 838            .unwrap();
 839        let font_size = 12.0;
 840        let wrap_width = Some(64.);
 841        cx.set_global(Settings::test(cx));
 842
 843        let text = "one two three four five\nsix seven eight";
 844        let buffer = MultiBuffer::build_simple(text, cx);
 845        let map = cx.add_model(|cx| {
 846            DisplayMap::new(buffer.clone(), font_id, font_size, wrap_width, 1, 1, cx)
 847        });
 848
 849        let snapshot = map.update(cx, |map, cx| map.snapshot(cx));
 850        assert_eq!(
 851            snapshot.text_chunks(0).collect::<String>(),
 852            "one two \nthree four \nfive\nsix seven \neight"
 853        );
 854        assert_eq!(
 855            snapshot.clip_point(DisplayPoint::new(0, 8), Bias::Left),
 856            DisplayPoint::new(0, 7)
 857        );
 858        assert_eq!(
 859            snapshot.clip_point(DisplayPoint::new(0, 8), Bias::Right),
 860            DisplayPoint::new(1, 0)
 861        );
 862        assert_eq!(
 863            movement::right(&snapshot, DisplayPoint::new(0, 7)),
 864            DisplayPoint::new(1, 0)
 865        );
 866        assert_eq!(
 867            movement::left(&snapshot, DisplayPoint::new(1, 0)),
 868            DisplayPoint::new(0, 7)
 869        );
 870        assert_eq!(
 871            movement::up(
 872                &snapshot,
 873                DisplayPoint::new(1, 10),
 874                SelectionGoal::None,
 875                false
 876            ),
 877            (DisplayPoint::new(0, 7), SelectionGoal::Column(10))
 878        );
 879        assert_eq!(
 880            movement::down(
 881                &snapshot,
 882                DisplayPoint::new(0, 7),
 883                SelectionGoal::Column(10),
 884                false
 885            ),
 886            (DisplayPoint::new(1, 10), SelectionGoal::Column(10))
 887        );
 888        assert_eq!(
 889            movement::down(
 890                &snapshot,
 891                DisplayPoint::new(1, 10),
 892                SelectionGoal::Column(10),
 893                false
 894            ),
 895            (DisplayPoint::new(2, 4), SelectionGoal::Column(10))
 896        );
 897
 898        let ix = snapshot.buffer_snapshot.text().find("seven").unwrap();
 899        buffer.update(cx, |buffer, cx| {
 900            buffer.edit([(ix..ix, "and ")], None, cx);
 901        });
 902
 903        let snapshot = map.update(cx, |map, cx| map.snapshot(cx));
 904        assert_eq!(
 905            snapshot.text_chunks(1).collect::<String>(),
 906            "three four \nfive\nsix and \nseven eight"
 907        );
 908
 909        // Re-wrap on font size changes
 910        map.update(cx, |map, cx| map.set_font(font_id, font_size + 3., cx));
 911
 912        let snapshot = map.update(cx, |map, cx| map.snapshot(cx));
 913        assert_eq!(
 914            snapshot.text_chunks(1).collect::<String>(),
 915            "three \nfour five\nsix and \nseven \neight"
 916        )
 917    }
 918
 919    #[gpui::test]
 920    fn test_text_chunks(cx: &mut gpui::MutableAppContext) {
 921        cx.set_global(Settings::test(cx));
 922        let text = sample_text(6, 6, 'a');
 923        let buffer = MultiBuffer::build_simple(&text, cx);
 924        let family_id = cx.font_cache().load_family(&["Helvetica"]).unwrap();
 925        let font_id = cx
 926            .font_cache()
 927            .select_font(family_id, &Default::default())
 928            .unwrap();
 929        let font_size = 14.0;
 930        let map =
 931            cx.add_model(|cx| DisplayMap::new(buffer.clone(), font_id, font_size, None, 1, 1, cx));
 932        buffer.update(cx, |buffer, cx| {
 933            buffer.edit(
 934                vec![
 935                    (Point::new(1, 0)..Point::new(1, 0), "\t"),
 936                    (Point::new(1, 1)..Point::new(1, 1), "\t"),
 937                    (Point::new(2, 1)..Point::new(2, 1), "\t"),
 938                ],
 939                None,
 940                cx,
 941            )
 942        });
 943
 944        assert_eq!(
 945            map.update(cx, |map, cx| map.snapshot(cx))
 946                .text_chunks(1)
 947                .collect::<String>()
 948                .lines()
 949                .next(),
 950            Some("    b   bbbbb")
 951        );
 952        assert_eq!(
 953            map.update(cx, |map, cx| map.snapshot(cx))
 954                .text_chunks(2)
 955                .collect::<String>()
 956                .lines()
 957                .next(),
 958            Some("c   ccccc")
 959        );
 960    }
 961
 962    #[gpui::test]
 963    async fn test_chunks(cx: &mut gpui::TestAppContext) {
 964        use unindent::Unindent as _;
 965
 966        let text = r#"
 967            fn outer() {}
 968
 969            mod module {
 970                fn inner() {}
 971            }"#
 972        .unindent();
 973
 974        let theme = SyntaxTheme::new(vec![
 975            ("mod.body".to_string(), Color::red().into()),
 976            ("fn.name".to_string(), Color::blue().into()),
 977        ]);
 978        let language = Arc::new(
 979            Language::new(
 980                LanguageConfig {
 981                    name: "Test".into(),
 982                    path_suffixes: vec![".test".to_string()],
 983                    ..Default::default()
 984                },
 985                Some(tree_sitter_rust::language()),
 986            )
 987            .with_highlights_query(
 988                r#"
 989                (mod_item name: (identifier) body: _ @mod.body)
 990                (function_item name: (identifier) @fn.name)
 991                "#,
 992            )
 993            .unwrap(),
 994        );
 995        language.set_theme(&theme);
 996        cx.update(|cx| {
 997            let mut settings = Settings::test(cx);
 998            settings.editor_defaults.tab_size = Some(2.try_into().unwrap());
 999            cx.set_global(settings);
1000        });
1001
1002        let buffer = cx.add_model(|cx| Buffer::new(0, text, cx).with_language(language, cx));
1003        buffer.condition(&cx, |buf, _| !buf.is_parsing()).await;
1004        let buffer = cx.add_model(|cx| MultiBuffer::singleton(buffer, cx));
1005
1006        let font_cache = cx.font_cache();
1007        let family_id = font_cache.load_family(&["Helvetica"]).unwrap();
1008        let font_id = font_cache
1009            .select_font(family_id, &Default::default())
1010            .unwrap();
1011        let font_size = 14.0;
1012
1013        let map = cx.add_model(|cx| DisplayMap::new(buffer, font_id, font_size, None, 1, 1, cx));
1014        assert_eq!(
1015            cx.update(|cx| syntax_chunks(0..5, &map, &theme, cx)),
1016            vec![
1017                ("fn ".to_string(), None),
1018                ("outer".to_string(), Some(Color::blue())),
1019                ("() {}\n\nmod module ".to_string(), None),
1020                ("{\n    fn ".to_string(), Some(Color::red())),
1021                ("inner".to_string(), Some(Color::blue())),
1022                ("() {}\n}".to_string(), Some(Color::red())),
1023            ]
1024        );
1025        assert_eq!(
1026            cx.update(|cx| syntax_chunks(3..5, &map, &theme, cx)),
1027            vec![
1028                ("    fn ".to_string(), Some(Color::red())),
1029                ("inner".to_string(), Some(Color::blue())),
1030                ("() {}\n}".to_string(), Some(Color::red())),
1031            ]
1032        );
1033
1034        map.update(cx, |map, cx| {
1035            map.fold(vec![Point::new(0, 6)..Point::new(3, 2)], cx)
1036        });
1037        assert_eq!(
1038            cx.update(|cx| syntax_chunks(0..2, &map, &theme, cx)),
1039            vec![
1040                ("fn ".to_string(), None),
1041                ("out".to_string(), Some(Color::blue())),
1042                ("".to_string(), None),
1043                ("  fn ".to_string(), Some(Color::red())),
1044                ("inner".to_string(), Some(Color::blue())),
1045                ("() {}\n}".to_string(), Some(Color::red())),
1046            ]
1047        );
1048    }
1049
1050    #[gpui::test]
1051    async fn test_chunks_with_soft_wrapping(cx: &mut gpui::TestAppContext) {
1052        use unindent::Unindent as _;
1053
1054        cx.foreground().set_block_on_ticks(usize::MAX..=usize::MAX);
1055
1056        let text = r#"
1057            fn outer() {}
1058
1059            mod module {
1060                fn inner() {}
1061            }"#
1062        .unindent();
1063
1064        let theme = SyntaxTheme::new(vec![
1065            ("mod.body".to_string(), Color::red().into()),
1066            ("fn.name".to_string(), Color::blue().into()),
1067        ]);
1068        let language = Arc::new(
1069            Language::new(
1070                LanguageConfig {
1071                    name: "Test".into(),
1072                    path_suffixes: vec![".test".to_string()],
1073                    ..Default::default()
1074                },
1075                Some(tree_sitter_rust::language()),
1076            )
1077            .with_highlights_query(
1078                r#"
1079                (mod_item name: (identifier) body: _ @mod.body)
1080                (function_item name: (identifier) @fn.name)
1081                "#,
1082            )
1083            .unwrap(),
1084        );
1085        language.set_theme(&theme);
1086
1087        cx.update(|cx| cx.set_global(Settings::test(cx)));
1088
1089        let buffer = cx.add_model(|cx| Buffer::new(0, text, cx).with_language(language, cx));
1090        buffer.condition(&cx, |buf, _| !buf.is_parsing()).await;
1091        let buffer = cx.add_model(|cx| MultiBuffer::singleton(buffer, cx));
1092
1093        let font_cache = cx.font_cache();
1094
1095        let family_id = font_cache.load_family(&["Courier"]).unwrap();
1096        let font_id = font_cache
1097            .select_font(family_id, &Default::default())
1098            .unwrap();
1099        let font_size = 16.0;
1100
1101        let map =
1102            cx.add_model(|cx| DisplayMap::new(buffer, font_id, font_size, Some(40.0), 1, 1, cx));
1103        assert_eq!(
1104            cx.update(|cx| syntax_chunks(0..5, &map, &theme, cx)),
1105            [
1106                ("fn \n".to_string(), None),
1107                ("oute\nr".to_string(), Some(Color::blue())),
1108                ("() \n{}\n\n".to_string(), None),
1109            ]
1110        );
1111        assert_eq!(
1112            cx.update(|cx| syntax_chunks(3..5, &map, &theme, cx)),
1113            [("{}\n\n".to_string(), None)]
1114        );
1115
1116        map.update(cx, |map, cx| {
1117            map.fold(vec![Point::new(0, 6)..Point::new(3, 2)], cx)
1118        });
1119        assert_eq!(
1120            cx.update(|cx| syntax_chunks(1..4, &map, &theme, cx)),
1121            [
1122                ("out".to_string(), Some(Color::blue())),
1123                ("\n".to_string(), None),
1124                ("  \nfn ".to_string(), Some(Color::red())),
1125                ("i\n".to_string(), Some(Color::blue()))
1126            ]
1127        );
1128    }
1129
1130    #[gpui::test]
1131    async fn test_chunks_with_text_highlights(cx: &mut gpui::TestAppContext) {
1132        cx.foreground().set_block_on_ticks(usize::MAX..=usize::MAX);
1133
1134        cx.update(|cx| cx.set_global(Settings::test(cx)));
1135        let theme = SyntaxTheme::new(vec![
1136            ("operator".to_string(), Color::red().into()),
1137            ("string".to_string(), Color::green().into()),
1138        ]);
1139        let language = Arc::new(
1140            Language::new(
1141                LanguageConfig {
1142                    name: "Test".into(),
1143                    path_suffixes: vec![".test".to_string()],
1144                    ..Default::default()
1145                },
1146                Some(tree_sitter_rust::language()),
1147            )
1148            .with_highlights_query(
1149                r#"
1150                ":" @operator
1151                (string_literal) @string
1152                "#,
1153            )
1154            .unwrap(),
1155        );
1156        language.set_theme(&theme);
1157
1158        let (text, highlighted_ranges) = marked_text_ranges(r#"const[] [a]: B = "c [d]""#);
1159
1160        let buffer = cx.add_model(|cx| Buffer::new(0, text, cx).with_language(language, cx));
1161        buffer.condition(&cx, |buf, _| !buf.is_parsing()).await;
1162
1163        let buffer = cx.add_model(|cx| MultiBuffer::singleton(buffer, cx));
1164        let buffer_snapshot = buffer.read_with(cx, |buffer, cx| buffer.snapshot(cx));
1165
1166        let font_cache = cx.font_cache();
1167        let family_id = font_cache.load_family(&["Courier"]).unwrap();
1168        let font_id = font_cache
1169            .select_font(family_id, &Default::default())
1170            .unwrap();
1171        let font_size = 16.0;
1172        let map = cx.add_model(|cx| DisplayMap::new(buffer, font_id, font_size, None, 1, 1, cx));
1173
1174        enum MyType {}
1175
1176        let style = HighlightStyle {
1177            color: Some(Color::blue()),
1178            ..Default::default()
1179        };
1180
1181        map.update(cx, |map, _cx| {
1182            map.highlight_text(
1183                TypeId::of::<MyType>(),
1184                highlighted_ranges
1185                    .into_iter()
1186                    .map(|range| {
1187                        buffer_snapshot.anchor_before(range.start)
1188                            ..buffer_snapshot.anchor_before(range.end)
1189                    })
1190                    .collect(),
1191                style,
1192            );
1193        });
1194
1195        assert_eq!(
1196            cx.update(|cx| chunks(0..10, &map, &theme, cx)),
1197            [
1198                ("const ".to_string(), None, None),
1199                ("a".to_string(), None, Some(Color::blue())),
1200                (":".to_string(), Some(Color::red()), None),
1201                (" B = ".to_string(), None, None),
1202                ("\"c ".to_string(), Some(Color::green()), None),
1203                ("d".to_string(), Some(Color::green()), Some(Color::blue())),
1204                ("\"".to_string(), Some(Color::green()), None),
1205            ]
1206        );
1207    }
1208
1209    #[gpui::test]
1210    fn test_clip_point(cx: &mut gpui::MutableAppContext) {
1211        cx.set_global(Settings::test(cx));
1212        fn assert(text: &str, shift_right: bool, bias: Bias, cx: &mut gpui::MutableAppContext) {
1213            let (unmarked_snapshot, mut markers) = marked_display_snapshot(text, cx);
1214
1215            match bias {
1216                Bias::Left => {
1217                    if shift_right {
1218                        *markers[1].column_mut() += 1;
1219                    }
1220
1221                    assert_eq!(unmarked_snapshot.clip_point(markers[1], bias), markers[0])
1222                }
1223                Bias::Right => {
1224                    if shift_right {
1225                        *markers[0].column_mut() += 1;
1226                    }
1227
1228                    assert_eq!(unmarked_snapshot.clip_point(markers[0], bias), markers[1])
1229                }
1230            };
1231        }
1232
1233        use Bias::{Left, Right};
1234        assert("||α", false, Left, cx);
1235        assert("||α", true, Left, cx);
1236        assert("||α", false, Right, cx);
1237        assert("|α|", true, Right, cx);
1238        assert("||✋", false, Left, cx);
1239        assert("||✋", true, Left, cx);
1240        assert("||✋", false, Right, cx);
1241        assert("|✋|", true, Right, cx);
1242        assert("||🍐", false, Left, cx);
1243        assert("||🍐", true, Left, cx);
1244        assert("||🍐", false, Right, cx);
1245        assert("|🍐|", true, Right, cx);
1246        assert("||\t", false, Left, cx);
1247        assert("||\t", true, Left, cx);
1248        assert("||\t", false, Right, cx);
1249        assert("|\t|", true, Right, cx);
1250        assert(" ||\t", false, Left, cx);
1251        assert(" ||\t", true, Left, cx);
1252        assert(" ||\t", false, Right, cx);
1253        assert(" |\t|", true, Right, cx);
1254        assert("   ||\t", false, Left, cx);
1255        assert("   ||\t", false, Right, cx);
1256    }
1257
1258    #[gpui::test]
1259    fn test_clip_at_line_ends(cx: &mut gpui::MutableAppContext) {
1260        cx.set_global(Settings::test(cx));
1261
1262        fn assert(text: &str, cx: &mut gpui::MutableAppContext) {
1263            let (mut unmarked_snapshot, markers) = marked_display_snapshot(text, cx);
1264            unmarked_snapshot.clip_at_line_ends = true;
1265            assert_eq!(
1266                unmarked_snapshot.clip_point(markers[1], Bias::Left),
1267                markers[0]
1268            );
1269        }
1270
1271        assert("||", cx);
1272        assert("|a|", cx);
1273        assert("a|b|", cx);
1274        assert("a|α|", cx);
1275    }
1276
1277    #[gpui::test]
1278    fn test_tabs_with_multibyte_chars(cx: &mut gpui::MutableAppContext) {
1279        cx.set_global(Settings::test(cx));
1280        let text = "\t\tα\nβ\t\n🏀β\t\tγ";
1281        let buffer = MultiBuffer::build_simple(text, cx);
1282        let font_cache = cx.font_cache();
1283        let family_id = font_cache.load_family(&["Helvetica"]).unwrap();
1284        let font_id = font_cache
1285            .select_font(family_id, &Default::default())
1286            .unwrap();
1287        let font_size = 14.0;
1288
1289        let map =
1290            cx.add_model(|cx| DisplayMap::new(buffer.clone(), font_id, font_size, None, 1, 1, cx));
1291        let map = map.update(cx, |map, cx| map.snapshot(cx));
1292        assert_eq!(map.text(), "✅       α\nβ   \n🏀β      γ");
1293        assert_eq!(
1294            map.text_chunks(0).collect::<String>(),
1295            "✅       α\nβ   \n🏀β      γ"
1296        );
1297        assert_eq!(map.text_chunks(1).collect::<String>(), "β   \n🏀β      γ");
1298        assert_eq!(map.text_chunks(2).collect::<String>(), "🏀β      γ");
1299
1300        let point = Point::new(0, "\t\t".len() as u32);
1301        let display_point = DisplayPoint::new(0, "".len() as u32);
1302        assert_eq!(point.to_display_point(&map), display_point);
1303        assert_eq!(display_point.to_point(&map), point);
1304
1305        let point = Point::new(1, "β\t".len() as u32);
1306        let display_point = DisplayPoint::new(1, "β   ".len() as u32);
1307        assert_eq!(point.to_display_point(&map), display_point);
1308        assert_eq!(display_point.to_point(&map), point,);
1309
1310        let point = Point::new(2, "🏀β\t\t".len() as u32);
1311        let display_point = DisplayPoint::new(2, "🏀β      ".len() as u32);
1312        assert_eq!(point.to_display_point(&map), display_point);
1313        assert_eq!(display_point.to_point(&map), point,);
1314
1315        // Display points inside of expanded tabs
1316        assert_eq!(
1317            DisplayPoint::new(0, "".len() as u32).to_point(&map),
1318            Point::new(0, "\t".len() as u32),
1319        );
1320        assert_eq!(
1321            DisplayPoint::new(0, "".len() as u32).to_point(&map),
1322            Point::new(0, "".len() as u32),
1323        );
1324
1325        // Clipping display points inside of multi-byte characters
1326        assert_eq!(
1327            map.clip_point(DisplayPoint::new(0, "".len() as u32 - 1), Left),
1328            DisplayPoint::new(0, 0)
1329        );
1330        assert_eq!(
1331            map.clip_point(DisplayPoint::new(0, "".len() as u32 - 1), Bias::Right),
1332            DisplayPoint::new(0, "".len() as u32)
1333        );
1334    }
1335
1336    #[gpui::test]
1337    fn test_max_point(cx: &mut gpui::MutableAppContext) {
1338        cx.set_global(Settings::test(cx));
1339        let buffer = MultiBuffer::build_simple("aaa\n\t\tbbb", cx);
1340        let font_cache = cx.font_cache();
1341        let family_id = font_cache.load_family(&["Helvetica"]).unwrap();
1342        let font_id = font_cache
1343            .select_font(family_id, &Default::default())
1344            .unwrap();
1345        let font_size = 14.0;
1346        let map =
1347            cx.add_model(|cx| DisplayMap::new(buffer.clone(), font_id, font_size, None, 1, 1, cx));
1348        assert_eq!(
1349            map.update(cx, |map, cx| map.snapshot(cx)).max_point(),
1350            DisplayPoint::new(1, 11)
1351        )
1352    }
1353
1354    #[gpui::test]
1355    fn test_changing_tab_size(cx: &mut gpui::MutableAppContext) {
1356        cx.set_global({
1357            let mut settings = Settings::test(cx);
1358            settings.editor_overrides.tab_size = Some(NonZeroU32::new(4).unwrap());
1359            settings
1360        });
1361        let buffer = MultiBuffer::build_simple("\ta\n\tb\n\tc", cx);
1362        let font_cache = cx.font_cache();
1363        let family_id = font_cache.load_family(&["Helvetica"]).unwrap();
1364        let font_id = font_cache
1365            .select_font(family_id, &Default::default())
1366            .unwrap();
1367        let font_size = 14.0;
1368
1369        let map =
1370            cx.add_model(|cx| DisplayMap::new(buffer.clone(), font_id, font_size, None, 1, 1, cx));
1371        assert_eq!(
1372            map.update(cx, |map, cx| map.snapshot(cx)).text(),
1373            "    a\n    b\n    c"
1374        );
1375
1376        cx.set_global({
1377            let mut settings = Settings::test(cx);
1378            settings.editor_overrides.tab_size = Some(NonZeroU32::new(2).unwrap());
1379            settings
1380        });
1381        assert_eq!(
1382            map.update(cx, |map, cx| map.snapshot(cx)).text(),
1383            "  a\n  b\n  c"
1384        );
1385    }
1386
1387    fn syntax_chunks<'a>(
1388        rows: Range<u32>,
1389        map: &ModelHandle<DisplayMap>,
1390        theme: &'a SyntaxTheme,
1391        cx: &mut MutableAppContext,
1392    ) -> Vec<(String, Option<Color>)> {
1393        chunks(rows, map, theme, cx)
1394            .into_iter()
1395            .map(|(text, color, _)| (text, color))
1396            .collect()
1397    }
1398
1399    fn chunks<'a>(
1400        rows: Range<u32>,
1401        map: &ModelHandle<DisplayMap>,
1402        theme: &'a SyntaxTheme,
1403        cx: &mut MutableAppContext,
1404    ) -> Vec<(String, Option<Color>, Option<Color>)> {
1405        let snapshot = map.update(cx, |map, cx| map.snapshot(cx));
1406        let mut chunks: Vec<(String, Option<Color>, Option<Color>)> = Vec::new();
1407        for chunk in snapshot.chunks(rows, true) {
1408            let syntax_color = chunk
1409                .syntax_highlight_id
1410                .and_then(|id| id.style(theme)?.color);
1411            let highlight_color = chunk.highlight_style.and_then(|style| style.color);
1412            if let Some((last_chunk, last_syntax_color, last_highlight_color)) = chunks.last_mut() {
1413                if syntax_color == *last_syntax_color && highlight_color == *last_highlight_color {
1414                    last_chunk.push_str(chunk.text);
1415                    continue;
1416                }
1417            }
1418            chunks.push((chunk.text.to_string(), syntax_color, highlight_color));
1419        }
1420        chunks
1421    }
1422}