1use super::{
   2    fold_map,
   3    tab_map::{self, TabEdit, TabPoint, TabSnapshot},
   4};
   5use crate::{MultiBufferSnapshot, Point};
   6use gpui::{
   7    fonts::FontId, text_layout::LineWrapper, Entity, ModelContext, ModelHandle, MutableAppContext,
   8    Task,
   9};
  10use language::Chunk;
  11use lazy_static::lazy_static;
  12use smol::future::yield_now;
  13use std::{collections::VecDeque, mem, ops::Range, time::Duration};
  14use sum_tree::{Bias, Cursor, SumTree};
  15use text::Patch;
  16use theme::SyntaxTheme;
  17
  18pub use super::tab_map::TextSummary;
  19pub type WrapEdit = text::Edit<u32>;
  20
  21pub struct WrapMap {
  22    snapshot: WrapSnapshot,
  23    pending_edits: VecDeque<(TabSnapshot, Vec<TabEdit>)>,
  24    interpolated_edits: Patch<u32>,
  25    edits_since_sync: Patch<u32>,
  26    wrap_width: Option<f32>,
  27    background_task: Option<Task<()>>,
  28    font: (FontId, f32),
  29}
  30
  31impl Entity for WrapMap {
  32    type Event = ();
  33}
  34
  35#[derive(Clone)]
  36pub struct WrapSnapshot {
  37    tab_snapshot: TabSnapshot,
  38    transforms: SumTree<Transform>,
  39    interpolated: bool,
  40}
  41
  42#[derive(Clone, Debug, Default, Eq, PartialEq)]
  43struct Transform {
  44    summary: TransformSummary,
  45    display_text: Option<&'static str>,
  46}
  47
  48#[derive(Clone, Debug, Default, Eq, PartialEq)]
  49struct TransformSummary {
  50    input: TextSummary,
  51    output: TextSummary,
  52}
  53
  54#[derive(Copy, Clone, Debug, Default, Eq, Ord, PartialOrd, PartialEq)]
  55pub struct WrapPoint(pub super::Point);
  56
  57pub struct WrapChunks<'a> {
  58    input_chunks: tab_map::TabChunks<'a>,
  59    input_chunk: Chunk<'a>,
  60    output_position: WrapPoint,
  61    max_output_row: u32,
  62    transforms: Cursor<'a, Transform, (WrapPoint, TabPoint)>,
  63}
  64
  65pub struct WrapBufferRows<'a> {
  66    input_buffer_rows: fold_map::FoldBufferRows<'a>,
  67    input_buffer_row: u32,
  68    output_row: u32,
  69    soft_wrapped: bool,
  70    max_output_row: u32,
  71    transforms: Cursor<'a, Transform, (WrapPoint, TabPoint)>,
  72}
  73
  74impl WrapMap {
  75    pub fn new(
  76        tab_snapshot: TabSnapshot,
  77        font_id: FontId,
  78        font_size: f32,
  79        wrap_width: Option<f32>,
  80        cx: &mut MutableAppContext,
  81    ) -> (ModelHandle<Self>, WrapSnapshot) {
  82        let handle = cx.add_model(|cx| {
  83            let mut this = Self {
  84                font: (font_id, font_size),
  85                wrap_width: None,
  86                pending_edits: Default::default(),
  87                interpolated_edits: Default::default(),
  88                edits_since_sync: Default::default(),
  89                snapshot: WrapSnapshot::new(tab_snapshot),
  90                background_task: None,
  91            };
  92            this.set_wrap_width(wrap_width, cx);
  93            mem::take(&mut this.edits_since_sync);
  94            this
  95        });
  96        let snapshot = handle.read(cx).snapshot.clone();
  97        (handle, snapshot)
  98    }
  99
 100    #[cfg(test)]
 101    pub fn is_rewrapping(&self) -> bool {
 102        self.background_task.is_some()
 103    }
 104
 105    pub fn sync(
 106        &mut self,
 107        tab_snapshot: TabSnapshot,
 108        edits: Vec<TabEdit>,
 109        cx: &mut ModelContext<Self>,
 110    ) -> (WrapSnapshot, Vec<WrapEdit>) {
 111        if self.wrap_width.is_some() {
 112            self.pending_edits.push_back((tab_snapshot, edits));
 113            self.flush_edits(cx);
 114        } else {
 115            self.edits_since_sync = self
 116                .edits_since_sync
 117                .compose(&self.snapshot.interpolate(tab_snapshot, &edits));
 118            self.snapshot.interpolated = false;
 119        }
 120
 121        (
 122            self.snapshot.clone(),
 123            mem::take(&mut self.edits_since_sync).into_inner(),
 124        )
 125    }
 126
 127    pub fn set_font(&mut self, font_id: FontId, font_size: f32, cx: &mut ModelContext<Self>) {
 128        if (font_id, font_size) != self.font {
 129            self.font = (font_id, font_size);
 130            self.rewrap(cx)
 131        }
 132    }
 133
 134    pub fn set_wrap_width(&mut self, wrap_width: Option<f32>, cx: &mut ModelContext<Self>) -> bool {
 135        if wrap_width == self.wrap_width {
 136            return false;
 137        }
 138
 139        self.wrap_width = wrap_width;
 140        self.rewrap(cx);
 141        true
 142    }
 143
 144    fn rewrap(&mut self, cx: &mut ModelContext<Self>) {
 145        self.background_task.take();
 146        self.interpolated_edits.clear();
 147        self.pending_edits.clear();
 148
 149        if let Some(wrap_width) = self.wrap_width {
 150            let mut new_snapshot = self.snapshot.clone();
 151            let font_cache = cx.font_cache().clone();
 152            let (font_id, font_size) = self.font;
 153            let task = cx.background().spawn(async move {
 154                let mut line_wrapper = font_cache.line_wrapper(font_id, font_size);
 155                let tab_snapshot = new_snapshot.tab_snapshot.clone();
 156                let range = TabPoint::zero()..tab_snapshot.max_point();
 157                let edits = new_snapshot
 158                    .update(
 159                        tab_snapshot,
 160                        &[TabEdit {
 161                            old: range.clone(),
 162                            new: range.clone(),
 163                        }],
 164                        wrap_width,
 165                        &mut line_wrapper,
 166                    )
 167                    .await;
 168                (new_snapshot, edits)
 169            });
 170
 171            match cx
 172                .background()
 173                .block_with_timeout(Duration::from_millis(5), task)
 174            {
 175                Ok((snapshot, edits)) => {
 176                    self.snapshot = snapshot;
 177                    self.edits_since_sync = self.edits_since_sync.compose(&edits);
 178                    cx.notify();
 179                }
 180                Err(wrap_task) => {
 181                    self.background_task = Some(cx.spawn(|this, mut cx| async move {
 182                        let (snapshot, edits) = wrap_task.await;
 183                        this.update(&mut cx, |this, cx| {
 184                            this.snapshot = snapshot;
 185                            this.edits_since_sync = this
 186                                .edits_since_sync
 187                                .compose(mem::take(&mut this.interpolated_edits).invert())
 188                                .compose(&edits);
 189                            this.background_task = None;
 190                            this.flush_edits(cx);
 191                            cx.notify();
 192                        });
 193                    }));
 194                }
 195            }
 196        } else {
 197            let old_rows = self.snapshot.transforms.summary().output.lines.row + 1;
 198            self.snapshot.transforms = SumTree::new();
 199            let summary = self.snapshot.tab_snapshot.text_summary();
 200            if !summary.lines.is_zero() {
 201                self.snapshot
 202                    .transforms
 203                    .push(Transform::isomorphic(summary), &());
 204            }
 205            let new_rows = self.snapshot.transforms.summary().output.lines.row + 1;
 206            self.snapshot.interpolated = false;
 207            self.edits_since_sync = self.edits_since_sync.compose(&Patch::new(vec![WrapEdit {
 208                old: 0..old_rows,
 209                new: 0..new_rows,
 210            }]));
 211        }
 212    }
 213
 214    fn flush_edits(&mut self, cx: &mut ModelContext<Self>) {
 215        if !self.snapshot.interpolated {
 216            let mut to_remove_len = 0;
 217            for (tab_snapshot, _) in &self.pending_edits {
 218                if tab_snapshot.version() <= self.snapshot.tab_snapshot.version() {
 219                    to_remove_len += 1;
 220                } else {
 221                    break;
 222                }
 223            }
 224            self.pending_edits.drain(..to_remove_len);
 225        }
 226
 227        if self.pending_edits.is_empty() {
 228            return;
 229        }
 230
 231        if let Some(wrap_width) = self.wrap_width {
 232            if self.background_task.is_none() {
 233                let pending_edits = self.pending_edits.clone();
 234                let mut snapshot = self.snapshot.clone();
 235                let font_cache = cx.font_cache().clone();
 236                let (font_id, font_size) = self.font;
 237                let update_task = cx.background().spawn(async move {
 238                    let mut line_wrapper = font_cache.line_wrapper(font_id, font_size);
 239
 240                    let mut edits = Patch::default();
 241                    for (tab_snapshot, tab_edits) in pending_edits {
 242                        let wrap_edits = snapshot
 243                            .update(tab_snapshot, &tab_edits, wrap_width, &mut line_wrapper)
 244                            .await;
 245                        edits = edits.compose(&wrap_edits);
 246                    }
 247                    (snapshot, edits)
 248                });
 249
 250                match cx
 251                    .background()
 252                    .block_with_timeout(Duration::from_millis(1), update_task)
 253                {
 254                    Ok((snapshot, output_edits)) => {
 255                        self.snapshot = snapshot;
 256                        self.edits_since_sync = self.edits_since_sync.compose(&output_edits);
 257                    }
 258                    Err(update_task) => {
 259                        self.background_task = Some(cx.spawn(|this, mut cx| async move {
 260                            let (snapshot, edits) = update_task.await;
 261                            this.update(&mut cx, |this, cx| {
 262                                this.snapshot = snapshot;
 263                                this.edits_since_sync = this
 264                                    .edits_since_sync
 265                                    .compose(mem::take(&mut this.interpolated_edits).invert())
 266                                    .compose(&edits);
 267                                this.background_task = None;
 268                                this.flush_edits(cx);
 269                                cx.notify();
 270                            });
 271                        }));
 272                    }
 273                }
 274            }
 275        }
 276
 277        let was_interpolated = self.snapshot.interpolated;
 278        let mut to_remove_len = 0;
 279        for (tab_snapshot, edits) in &self.pending_edits {
 280            if tab_snapshot.version() <= self.snapshot.tab_snapshot.version() {
 281                to_remove_len += 1;
 282            } else {
 283                let interpolated_edits = self.snapshot.interpolate(tab_snapshot.clone(), &edits);
 284                self.edits_since_sync = self.edits_since_sync.compose(&interpolated_edits);
 285                self.interpolated_edits = self.interpolated_edits.compose(&interpolated_edits);
 286            }
 287        }
 288
 289        if !was_interpolated {
 290            self.pending_edits.drain(..to_remove_len);
 291        }
 292    }
 293}
 294
 295impl WrapSnapshot {
 296    fn new(tab_snapshot: TabSnapshot) -> Self {
 297        let mut transforms = SumTree::new();
 298        let extent = tab_snapshot.text_summary();
 299        if !extent.lines.is_zero() {
 300            transforms.push(Transform::isomorphic(extent), &());
 301        }
 302        Self {
 303            transforms,
 304            tab_snapshot,
 305            interpolated: true,
 306        }
 307    }
 308
 309    pub fn buffer_snapshot(&self) -> &MultiBufferSnapshot {
 310        self.tab_snapshot.buffer_snapshot()
 311    }
 312
 313    fn interpolate(&mut self, new_tab_snapshot: TabSnapshot, tab_edits: &[TabEdit]) -> Patch<u32> {
 314        let mut new_transforms;
 315        if tab_edits.is_empty() {
 316            new_transforms = self.transforms.clone();
 317        } else {
 318            let mut old_cursor = self.transforms.cursor::<TabPoint>();
 319
 320            let mut tab_edits_iter = tab_edits.iter().peekable();
 321            new_transforms =
 322                old_cursor.slice(&tab_edits_iter.peek().unwrap().old.start, Bias::Right, &());
 323
 324            while let Some(edit) = tab_edits_iter.next() {
 325                if edit.new.start > TabPoint::from(new_transforms.summary().input.lines) {
 326                    let summary = new_tab_snapshot.text_summary_for_range(
 327                        TabPoint::from(new_transforms.summary().input.lines)..edit.new.start,
 328                    );
 329                    new_transforms.push_or_extend(Transform::isomorphic(summary));
 330                }
 331
 332                if !edit.new.is_empty() {
 333                    new_transforms.push_or_extend(Transform::isomorphic(
 334                        new_tab_snapshot.text_summary_for_range(edit.new.clone()),
 335                    ));
 336                }
 337
 338                old_cursor.seek_forward(&edit.old.end, Bias::Right, &());
 339                if let Some(next_edit) = tab_edits_iter.peek() {
 340                    if next_edit.old.start > old_cursor.end(&()) {
 341                        if old_cursor.end(&()) > edit.old.end {
 342                            let summary = self
 343                                .tab_snapshot
 344                                .text_summary_for_range(edit.old.end..old_cursor.end(&()));
 345                            new_transforms.push_or_extend(Transform::isomorphic(summary));
 346                        }
 347
 348                        old_cursor.next(&());
 349                        new_transforms.push_tree(
 350                            old_cursor.slice(&next_edit.old.start, Bias::Right, &()),
 351                            &(),
 352                        );
 353                    }
 354                } else {
 355                    if old_cursor.end(&()) > edit.old.end {
 356                        let summary = self
 357                            .tab_snapshot
 358                            .text_summary_for_range(edit.old.end..old_cursor.end(&()));
 359                        new_transforms.push_or_extend(Transform::isomorphic(summary));
 360                    }
 361                    old_cursor.next(&());
 362                    new_transforms.push_tree(old_cursor.suffix(&()), &());
 363                }
 364            }
 365        }
 366
 367        let old_snapshot = mem::replace(
 368            self,
 369            WrapSnapshot {
 370                tab_snapshot: new_tab_snapshot,
 371                transforms: new_transforms,
 372                interpolated: true,
 373            },
 374        );
 375        self.check_invariants();
 376        old_snapshot.compute_edits(tab_edits, self)
 377    }
 378
 379    async fn update(
 380        &mut self,
 381        new_tab_snapshot: TabSnapshot,
 382        tab_edits: &[TabEdit],
 383        wrap_width: f32,
 384        line_wrapper: &mut LineWrapper,
 385    ) -> Patch<u32> {
 386        #[derive(Debug)]
 387        struct RowEdit {
 388            old_rows: Range<u32>,
 389            new_rows: Range<u32>,
 390        }
 391
 392        let mut tab_edits_iter = tab_edits.into_iter().peekable();
 393        let mut row_edits = Vec::new();
 394        while let Some(edit) = tab_edits_iter.next() {
 395            let mut row_edit = RowEdit {
 396                old_rows: edit.old.start.row()..edit.old.end.row() + 1,
 397                new_rows: edit.new.start.row()..edit.new.end.row() + 1,
 398            };
 399
 400            while let Some(next_edit) = tab_edits_iter.peek() {
 401                if next_edit.old.start.row() <= row_edit.old_rows.end {
 402                    row_edit.old_rows.end = next_edit.old.end.row() + 1;
 403                    row_edit.new_rows.end = next_edit.new.end.row() + 1;
 404                    tab_edits_iter.next();
 405                } else {
 406                    break;
 407                }
 408            }
 409
 410            row_edits.push(row_edit);
 411        }
 412
 413        let mut new_transforms;
 414        if row_edits.is_empty() {
 415            new_transforms = self.transforms.clone();
 416        } else {
 417            let mut row_edits = row_edits.into_iter().peekable();
 418            let mut old_cursor = self.transforms.cursor::<TabPoint>();
 419
 420            new_transforms = old_cursor.slice(
 421                &TabPoint::new(row_edits.peek().unwrap().old_rows.start, 0),
 422                Bias::Right,
 423                &(),
 424            );
 425
 426            while let Some(edit) = row_edits.next() {
 427                if edit.new_rows.start > new_transforms.summary().input.lines.row {
 428                    let summary = new_tab_snapshot.text_summary_for_range(
 429                        TabPoint(new_transforms.summary().input.lines)
 430                            ..TabPoint::new(edit.new_rows.start, 0),
 431                    );
 432                    new_transforms.push_or_extend(Transform::isomorphic(summary));
 433                }
 434
 435                let mut line = String::new();
 436                let mut remaining = None;
 437                let mut chunks = new_tab_snapshot.chunks(
 438                    TabPoint::new(edit.new_rows.start, 0)..new_tab_snapshot.max_point(),
 439                    None,
 440                );
 441                let mut edit_transforms = Vec::<Transform>::new();
 442                for _ in edit.new_rows.start..edit.new_rows.end {
 443                    while let Some(chunk) =
 444                        remaining.take().or_else(|| chunks.next().map(|c| c.text))
 445                    {
 446                        if let Some(ix) = chunk.find('\n') {
 447                            line.push_str(&chunk[..ix + 1]);
 448                            remaining = Some(&chunk[ix + 1..]);
 449                            break;
 450                        } else {
 451                            line.push_str(chunk)
 452                        }
 453                    }
 454
 455                    if line.is_empty() {
 456                        break;
 457                    }
 458
 459                    let mut prev_boundary_ix = 0;
 460                    for boundary in line_wrapper.wrap_line(&line, wrap_width) {
 461                        let wrapped = &line[prev_boundary_ix..boundary.ix];
 462                        push_isomorphic(&mut edit_transforms, TextSummary::from(wrapped));
 463                        edit_transforms.push(Transform::wrap(boundary.next_indent));
 464                        prev_boundary_ix = boundary.ix;
 465                    }
 466
 467                    if prev_boundary_ix < line.len() {
 468                        push_isomorphic(
 469                            &mut edit_transforms,
 470                            TextSummary::from(&line[prev_boundary_ix..]),
 471                        );
 472                    }
 473
 474                    line.clear();
 475                    yield_now().await;
 476                }
 477
 478                let mut edit_transforms = edit_transforms.into_iter();
 479                if let Some(transform) = edit_transforms.next() {
 480                    new_transforms.push_or_extend(transform);
 481                }
 482                new_transforms.extend(edit_transforms, &());
 483
 484                old_cursor.seek_forward(&TabPoint::new(edit.old_rows.end, 0), Bias::Right, &());
 485                if let Some(next_edit) = row_edits.peek() {
 486                    if next_edit.old_rows.start > old_cursor.end(&()).row() {
 487                        if old_cursor.end(&()) > TabPoint::new(edit.old_rows.end, 0) {
 488                            let summary = self.tab_snapshot.text_summary_for_range(
 489                                TabPoint::new(edit.old_rows.end, 0)..old_cursor.end(&()),
 490                            );
 491                            new_transforms.push_or_extend(Transform::isomorphic(summary));
 492                        }
 493                        old_cursor.next(&());
 494                        new_transforms.push_tree(
 495                            old_cursor.slice(
 496                                &TabPoint::new(next_edit.old_rows.start, 0),
 497                                Bias::Right,
 498                                &(),
 499                            ),
 500                            &(),
 501                        );
 502                    }
 503                } else {
 504                    if old_cursor.end(&()) > TabPoint::new(edit.old_rows.end, 0) {
 505                        let summary = self.tab_snapshot.text_summary_for_range(
 506                            TabPoint::new(edit.old_rows.end, 0)..old_cursor.end(&()),
 507                        );
 508                        new_transforms.push_or_extend(Transform::isomorphic(summary));
 509                    }
 510                    old_cursor.next(&());
 511                    new_transforms.push_tree(old_cursor.suffix(&()), &());
 512                }
 513            }
 514        }
 515
 516        let old_snapshot = mem::replace(
 517            self,
 518            WrapSnapshot {
 519                tab_snapshot: new_tab_snapshot,
 520                transforms: new_transforms,
 521                interpolated: false,
 522            },
 523        );
 524        self.check_invariants();
 525        old_snapshot.compute_edits(tab_edits, self)
 526    }
 527
 528    fn compute_edits(&self, tab_edits: &[TabEdit], new_snapshot: &WrapSnapshot) -> Patch<u32> {
 529        let mut wrap_edits = Vec::new();
 530        let mut old_cursor = self.transforms.cursor::<TransformSummary>();
 531        let mut new_cursor = new_snapshot.transforms.cursor::<TransformSummary>();
 532        for mut tab_edit in tab_edits.iter().cloned() {
 533            tab_edit.old.start.0.column = 0;
 534            tab_edit.old.end.0 += Point::new(1, 0);
 535            tab_edit.new.start.0.column = 0;
 536            tab_edit.new.end.0 += Point::new(1, 0);
 537
 538            old_cursor.seek(&tab_edit.old.start, Bias::Right, &());
 539            let mut old_start = old_cursor.start().output.lines;
 540            old_start += tab_edit.old.start.0 - old_cursor.start().input.lines;
 541
 542            old_cursor.seek(&tab_edit.old.end, Bias::Right, &());
 543            let mut old_end = old_cursor.start().output.lines;
 544            old_end += tab_edit.old.end.0 - old_cursor.start().input.lines;
 545
 546            new_cursor.seek(&tab_edit.new.start, Bias::Right, &());
 547            let mut new_start = new_cursor.start().output.lines;
 548            new_start += tab_edit.new.start.0 - new_cursor.start().input.lines;
 549
 550            new_cursor.seek(&tab_edit.new.end, Bias::Right, &());
 551            let mut new_end = new_cursor.start().output.lines;
 552            new_end += tab_edit.new.end.0 - new_cursor.start().input.lines;
 553
 554            wrap_edits.push(WrapEdit {
 555                old: old_start.row..old_end.row,
 556                new: new_start.row..new_end.row,
 557            });
 558        }
 559
 560        consolidate_wrap_edits(&mut wrap_edits);
 561        Patch::new(wrap_edits)
 562    }
 563
 564    pub fn text_chunks(&self, wrap_row: u32) -> impl Iterator<Item = &str> {
 565        self.chunks(wrap_row..self.max_point().row() + 1, None)
 566            .map(|h| h.text)
 567    }
 568
 569    pub fn chunks<'a>(
 570        &'a self,
 571        rows: Range<u32>,
 572        theme: Option<&'a SyntaxTheme>,
 573    ) -> WrapChunks<'a> {
 574        let output_start = WrapPoint::new(rows.start, 0);
 575        let output_end = WrapPoint::new(rows.end, 0);
 576        let mut transforms = self.transforms.cursor::<(WrapPoint, TabPoint)>();
 577        transforms.seek(&output_start, Bias::Right, &());
 578        let mut input_start = TabPoint(transforms.start().1 .0);
 579        if transforms.item().map_or(false, |t| t.is_isomorphic()) {
 580            input_start.0 += output_start.0 - transforms.start().0 .0;
 581        }
 582        let input_end = self
 583            .to_tab_point(output_end)
 584            .min(self.tab_snapshot.max_point());
 585        WrapChunks {
 586            input_chunks: self.tab_snapshot.chunks(input_start..input_end, theme),
 587            input_chunk: Default::default(),
 588            output_position: output_start,
 589            max_output_row: rows.end,
 590            transforms,
 591        }
 592    }
 593
 594    pub fn text_summary(&self) -> TextSummary {
 595        self.transforms.summary().output
 596    }
 597
 598    pub fn max_point(&self) -> WrapPoint {
 599        WrapPoint(self.transforms.summary().output.lines)
 600    }
 601
 602    pub fn line_len(&self, row: u32) -> u32 {
 603        let mut len = 0;
 604        for chunk in self.text_chunks(row) {
 605            if let Some(newline_ix) = chunk.find('\n') {
 606                len += newline_ix;
 607                break;
 608            } else {
 609                len += chunk.len();
 610            }
 611        }
 612        len as u32
 613    }
 614
 615    pub fn soft_wrap_indent(&self, row: u32) -> Option<u32> {
 616        let mut cursor = self.transforms.cursor::<WrapPoint>();
 617        cursor.seek(&WrapPoint::new(row + 1, 0), Bias::Right, &());
 618        cursor.item().and_then(|transform| {
 619            if transform.is_isomorphic() {
 620                None
 621            } else {
 622                Some(transform.summary.output.lines.column)
 623            }
 624        })
 625    }
 626
 627    pub fn longest_row(&self) -> u32 {
 628        self.transforms.summary().output.longest_row
 629    }
 630
 631    pub fn buffer_rows(&self, start_row: u32) -> WrapBufferRows {
 632        let mut transforms = self.transforms.cursor::<(WrapPoint, TabPoint)>();
 633        transforms.seek(&WrapPoint::new(start_row, 0), Bias::Left, &());
 634        let mut input_row = transforms.start().1.row();
 635        if transforms.item().map_or(false, |t| t.is_isomorphic()) {
 636            input_row += start_row - transforms.start().0.row();
 637        }
 638        let soft_wrapped = transforms.item().map_or(false, |t| !t.is_isomorphic());
 639        let mut input_buffer_rows = self.tab_snapshot.buffer_rows(input_row);
 640        let input_buffer_row = input_buffer_rows.next().unwrap();
 641        WrapBufferRows {
 642            transforms,
 643            input_buffer_row,
 644            input_buffer_rows,
 645            output_row: start_row,
 646            soft_wrapped,
 647            max_output_row: self.max_point().row(),
 648        }
 649    }
 650
 651    pub fn to_tab_point(&self, point: WrapPoint) -> TabPoint {
 652        let mut cursor = self.transforms.cursor::<(WrapPoint, TabPoint)>();
 653        cursor.seek(&point, Bias::Right, &());
 654        let mut tab_point = cursor.start().1 .0;
 655        if cursor.item().map_or(false, |t| t.is_isomorphic()) {
 656            tab_point += point.0 - cursor.start().0 .0;
 657        }
 658        TabPoint(tab_point)
 659    }
 660
 661    pub fn to_point(&self, point: WrapPoint, bias: Bias) -> Point {
 662        self.tab_snapshot.to_point(self.to_tab_point(point), bias)
 663    }
 664
 665    pub fn from_point(&self, point: Point, bias: Bias) -> WrapPoint {
 666        self.from_tab_point(self.tab_snapshot.from_point(point, bias))
 667    }
 668
 669    pub fn from_tab_point(&self, point: TabPoint) -> WrapPoint {
 670        let mut cursor = self.transforms.cursor::<(TabPoint, WrapPoint)>();
 671        cursor.seek(&point, Bias::Right, &());
 672        WrapPoint(cursor.start().1 .0 + (point.0 - cursor.start().0 .0))
 673    }
 674
 675    pub fn from_tab_point_with_clipping(&self, point: TabPoint, bias: Bias) -> WrapPoint {
 676        let mut cursor = self.transforms.cursor::<(TabPoint, WrapPoint)>();
 677        cursor.seek(&point, bias, &());
 678        self.clip_point(
 679            WrapPoint(cursor.start().1 .0 + (point.0 - cursor.start().0 .0)),
 680            bias,
 681        )
 682    }
 683
 684    pub fn clip_point(&self, mut point: WrapPoint, bias: Bias) -> WrapPoint {
 685        if bias == Bias::Left {
 686            let mut cursor = self.transforms.cursor::<WrapPoint>();
 687            cursor.seek(&point, Bias::Right, &());
 688            if cursor.item().map_or(false, |t| !t.is_isomorphic()) {
 689                point = *cursor.start();
 690                *point.column_mut() -= 1;
 691            }
 692        }
 693
 694        self.from_tab_point(self.tab_snapshot.clip_point(self.to_tab_point(point), bias))
 695    }
 696
 697    fn check_invariants(&self) {
 698        #[cfg(test)]
 699        {
 700            assert_eq!(
 701                TabPoint::from(self.transforms.summary().input.lines),
 702                self.tab_snapshot.max_point()
 703            );
 704
 705            {
 706                let mut transforms = self.transforms.cursor::<()>().peekable();
 707                while let Some(transform) = transforms.next() {
 708                    if let Some(next_transform) = transforms.peek() {
 709                        assert!(transform.is_isomorphic() != next_transform.is_isomorphic());
 710                    }
 711                }
 712            }
 713
 714            let mut expected_buffer_rows = Vec::new();
 715            let mut buffer_row = 0;
 716            let mut prev_tab_row = 0;
 717            for display_row in 0..=self.max_point().row() {
 718                let tab_point = self.to_tab_point(WrapPoint::new(display_row, 0));
 719                let soft_wrapped;
 720                if tab_point.row() == prev_tab_row {
 721                    soft_wrapped = display_row != 0;
 722                } else {
 723                    let fold_point = self.tab_snapshot.to_fold_point(tab_point, Bias::Left).0;
 724                    let buffer_point = fold_point.to_buffer_point(&self.tab_snapshot.fold_snapshot);
 725                    buffer_row = buffer_point.row;
 726                    prev_tab_row = tab_point.row();
 727                    soft_wrapped = false;
 728                }
 729                expected_buffer_rows.push(if soft_wrapped { None } else { Some(buffer_row) });
 730            }
 731
 732            for start_display_row in 0..expected_buffer_rows.len() {
 733                assert_eq!(
 734                    self.buffer_rows(start_display_row as u32)
 735                        .collect::<Vec<_>>(),
 736                    &expected_buffer_rows[start_display_row..],
 737                    "invalid buffer_rows({}..)",
 738                    start_display_row
 739                );
 740            }
 741        }
 742    }
 743}
 744
 745impl<'a> Iterator for WrapChunks<'a> {
 746    type Item = Chunk<'a>;
 747
 748    fn next(&mut self) -> Option<Self::Item> {
 749        if self.output_position.row() >= self.max_output_row {
 750            return None;
 751        }
 752
 753        let transform = self.transforms.item()?;
 754        if let Some(display_text) = transform.display_text {
 755            let mut start_ix = 0;
 756            let mut end_ix = display_text.len();
 757            let mut summary = transform.summary.output.lines;
 758
 759            if self.output_position > self.transforms.start().0 {
 760                // Exclude newline starting prior to the desired row.
 761                start_ix = 1;
 762                summary.row = 0;
 763            } else if self.output_position.row() + 1 >= self.max_output_row {
 764                // Exclude soft indentation ending after the desired row.
 765                end_ix = 1;
 766                summary.column = 0;
 767            }
 768
 769            self.output_position.0 += summary;
 770            self.transforms.next(&());
 771            return Some(Chunk {
 772                text: &display_text[start_ix..end_ix],
 773                ..self.input_chunk
 774            });
 775        }
 776
 777        if self.input_chunk.text.is_empty() {
 778            self.input_chunk = self.input_chunks.next().unwrap();
 779        }
 780
 781        let mut input_len = 0;
 782        let transform_end = self.transforms.end(&()).0;
 783        for c in self.input_chunk.text.chars() {
 784            let char_len = c.len_utf8();
 785            input_len += char_len;
 786            if c == '\n' {
 787                *self.output_position.row_mut() += 1;
 788                *self.output_position.column_mut() = 0;
 789            } else {
 790                *self.output_position.column_mut() += char_len as u32;
 791            }
 792
 793            if self.output_position >= transform_end {
 794                self.transforms.next(&());
 795                break;
 796            }
 797        }
 798
 799        let (prefix, suffix) = self.input_chunk.text.split_at(input_len);
 800        self.input_chunk.text = suffix;
 801        Some(Chunk {
 802            text: prefix,
 803            ..self.input_chunk
 804        })
 805    }
 806}
 807
 808impl<'a> Iterator for WrapBufferRows<'a> {
 809    type Item = Option<u32>;
 810
 811    fn next(&mut self) -> Option<Self::Item> {
 812        if self.output_row > self.max_output_row {
 813            return None;
 814        }
 815
 816        let buffer_row = self.input_buffer_row;
 817        let soft_wrapped = self.soft_wrapped;
 818
 819        self.output_row += 1;
 820        self.transforms
 821            .seek_forward(&WrapPoint::new(self.output_row, 0), Bias::Left, &());
 822        if self.transforms.item().map_or(false, |t| t.is_isomorphic()) {
 823            self.input_buffer_row = self.input_buffer_rows.next().unwrap();
 824            self.soft_wrapped = false;
 825        } else {
 826            self.soft_wrapped = true;
 827        }
 828
 829        Some(if soft_wrapped { None } else { Some(buffer_row) })
 830    }
 831}
 832
 833impl Transform {
 834    fn isomorphic(summary: TextSummary) -> Self {
 835        #[cfg(test)]
 836        assert!(!summary.lines.is_zero());
 837
 838        Self {
 839            summary: TransformSummary {
 840                input: summary.clone(),
 841                output: summary,
 842            },
 843            display_text: None,
 844        }
 845    }
 846
 847    fn wrap(indent: u32) -> Self {
 848        lazy_static! {
 849            static ref WRAP_TEXT: String = {
 850                let mut wrap_text = String::new();
 851                wrap_text.push('\n');
 852                wrap_text.extend((0..LineWrapper::MAX_INDENT as usize).map(|_| ' '));
 853                wrap_text
 854            };
 855        }
 856
 857        Self {
 858            summary: TransformSummary {
 859                input: TextSummary::default(),
 860                output: TextSummary {
 861                    lines: Point::new(1, indent),
 862                    first_line_chars: 0,
 863                    last_line_chars: indent,
 864                    longest_row: 1,
 865                    longest_row_chars: indent,
 866                },
 867            },
 868            display_text: Some(&WRAP_TEXT[..1 + indent as usize]),
 869        }
 870    }
 871
 872    fn is_isomorphic(&self) -> bool {
 873        self.display_text.is_none()
 874    }
 875}
 876
 877impl sum_tree::Item for Transform {
 878    type Summary = TransformSummary;
 879
 880    fn summary(&self) -> Self::Summary {
 881        self.summary.clone()
 882    }
 883}
 884
 885fn push_isomorphic(transforms: &mut Vec<Transform>, summary: TextSummary) {
 886    if let Some(last_transform) = transforms.last_mut() {
 887        if last_transform.is_isomorphic() {
 888            last_transform.summary.input += &summary;
 889            last_transform.summary.output += &summary;
 890            return;
 891        }
 892    }
 893    transforms.push(Transform::isomorphic(summary));
 894}
 895
 896trait SumTreeExt {
 897    fn push_or_extend(&mut self, transform: Transform);
 898}
 899
 900impl SumTreeExt for SumTree<Transform> {
 901    fn push_or_extend(&mut self, transform: Transform) {
 902        let mut transform = Some(transform);
 903        self.update_last(
 904            |last_transform| {
 905                if last_transform.is_isomorphic() && transform.as_ref().unwrap().is_isomorphic() {
 906                    let transform = transform.take().unwrap();
 907                    last_transform.summary.input += &transform.summary.input;
 908                    last_transform.summary.output += &transform.summary.output;
 909                }
 910            },
 911            &(),
 912        );
 913
 914        if let Some(transform) = transform {
 915            self.push(transform, &());
 916        }
 917    }
 918}
 919
 920impl WrapPoint {
 921    pub fn new(row: u32, column: u32) -> Self {
 922        Self(super::Point::new(row, column))
 923    }
 924
 925    pub fn row(self) -> u32 {
 926        self.0.row
 927    }
 928
 929    pub fn row_mut(&mut self) -> &mut u32 {
 930        &mut self.0.row
 931    }
 932
 933    pub fn column(&self) -> u32 {
 934        self.0.column
 935    }
 936
 937    pub fn column_mut(&mut self) -> &mut u32 {
 938        &mut self.0.column
 939    }
 940}
 941
 942impl sum_tree::Summary for TransformSummary {
 943    type Context = ();
 944
 945    fn add_summary(&mut self, other: &Self, _: &()) {
 946        self.input += &other.input;
 947        self.output += &other.output;
 948    }
 949}
 950
 951impl<'a> sum_tree::Dimension<'a, TransformSummary> for TabPoint {
 952    fn add_summary(&mut self, summary: &'a TransformSummary, _: &()) {
 953        self.0 += summary.input.lines;
 954    }
 955}
 956
 957impl<'a> sum_tree::SeekTarget<'a, TransformSummary, TransformSummary> for TabPoint {
 958    fn cmp(&self, cursor_location: &TransformSummary, _: &()) -> std::cmp::Ordering {
 959        Ord::cmp(&self.0, &cursor_location.input.lines)
 960    }
 961}
 962
 963impl<'a> sum_tree::Dimension<'a, TransformSummary> for WrapPoint {
 964    fn add_summary(&mut self, summary: &'a TransformSummary, _: &()) {
 965        self.0 += summary.output.lines;
 966    }
 967}
 968
 969fn consolidate_wrap_edits(edits: &mut Vec<WrapEdit>) {
 970    let mut i = 1;
 971    while i < edits.len() {
 972        let edit = edits[i].clone();
 973        let prev_edit = &mut edits[i - 1];
 974        if prev_edit.old.end >= edit.old.start {
 975            prev_edit.old.end = edit.old.end;
 976            prev_edit.new.end = edit.new.end;
 977            edits.remove(i);
 978            continue;
 979        }
 980        i += 1;
 981    }
 982}
 983
 984#[cfg(test)]
 985mod tests {
 986    use super::*;
 987    use crate::{
 988        display_map::{fold_map::FoldMap, tab_map::TabMap},
 989        test::Observer,
 990        MultiBuffer,
 991    };
 992    use language::RandomCharIter;
 993    use rand::prelude::*;
 994    use std::{cmp, env};
 995    use text::Rope;
 996
 997    #[gpui::test(iterations = 100)]
 998    async fn test_random_wraps(mut cx: gpui::TestAppContext, mut rng: StdRng) {
 999        cx.foreground().set_block_on_ticks(0..=50);
1000        cx.foreground().forbid_parking();
1001        let operations = env::var("OPERATIONS")
1002            .map(|i| i.parse().expect("invalid `OPERATIONS` variable"))
1003            .unwrap_or(10);
1004
1005        let font_cache = cx.font_cache().clone();
1006        let font_system = cx.platform().fonts();
1007        let mut wrap_width = if rng.gen_bool(0.1) {
1008            None
1009        } else {
1010            Some(rng.gen_range(0.0..=1000.0))
1011        };
1012        let tab_size = rng.gen_range(1..=4);
1013        let family_id = font_cache.load_family(&["Helvetica"]).unwrap();
1014        let font_id = font_cache
1015            .select_font(family_id, &Default::default())
1016            .unwrap();
1017        let font_size = 14.0;
1018
1019        log::info!("Tab size: {}", tab_size);
1020        log::info!("Wrap width: {:?}", wrap_width);
1021
1022        let buffer = cx.update(|cx| {
1023            if rng.gen() {
1024                MultiBuffer::build_random(&mut rng, cx)
1025            } else {
1026                let len = rng.gen_range(0..10);
1027                let text = RandomCharIter::new(&mut rng).take(len).collect::<String>();
1028                MultiBuffer::build_simple(&text, cx)
1029            }
1030        });
1031        let mut buffer_snapshot = buffer.read_with(&cx, |buffer, cx| buffer.snapshot(cx));
1032        let (mut fold_map, folds_snapshot) = FoldMap::new(buffer_snapshot.clone());
1033        let (tab_map, tabs_snapshot) = TabMap::new(folds_snapshot.clone(), tab_size);
1034        log::info!("Unwrapped text (no folds): {:?}", buffer_snapshot.text());
1035        log::info!(
1036            "Unwrapped text (unexpanded tabs): {:?}",
1037            folds_snapshot.text()
1038        );
1039        log::info!("Unwrapped text (expanded tabs): {:?}", tabs_snapshot.text());
1040
1041        let mut line_wrapper = LineWrapper::new(font_id, font_size, font_system);
1042        let unwrapped_text = tabs_snapshot.text();
1043        let expected_text = wrap_text(&unwrapped_text, wrap_width, &mut line_wrapper);
1044
1045        let (wrap_map, _) =
1046            cx.update(|cx| WrapMap::new(tabs_snapshot.clone(), font_id, font_size, wrap_width, cx));
1047        let (_observer, notifications) = Observer::new(&wrap_map, &mut cx);
1048
1049        if wrap_map.read_with(&cx, |map, _| map.is_rewrapping()) {
1050            notifications.recv().await.unwrap();
1051        }
1052
1053        let (initial_snapshot, _) = wrap_map.update(&mut cx, |map, cx| {
1054            assert!(!map.is_rewrapping());
1055            map.sync(tabs_snapshot.clone(), Vec::new(), cx)
1056        });
1057
1058        let actual_text = initial_snapshot.text();
1059        assert_eq!(
1060            actual_text, expected_text,
1061            "unwrapped text is: {:?}",
1062            unwrapped_text
1063        );
1064        log::info!("Wrapped text: {:?}", actual_text);
1065
1066        let mut edits = Vec::new();
1067        for _i in 0..operations {
1068            log::info!("{} ==============================================", _i);
1069
1070            let mut buffer_edits = Vec::new();
1071            match rng.gen_range(0..=100) {
1072                0..=19 => {
1073                    wrap_width = if rng.gen_bool(0.2) {
1074                        None
1075                    } else {
1076                        Some(rng.gen_range(0.0..=1000.0))
1077                    };
1078                    log::info!("Setting wrap width to {:?}", wrap_width);
1079                    wrap_map.update(&mut cx, |map, cx| map.set_wrap_width(wrap_width, cx));
1080                }
1081                20..=39 => {
1082                    for (folds_snapshot, fold_edits) in fold_map.randomly_mutate(&mut rng) {
1083                        let (tabs_snapshot, tab_edits) = tab_map.sync(folds_snapshot, fold_edits);
1084                        let (mut snapshot, wrap_edits) = wrap_map
1085                            .update(&mut cx, |map, cx| map.sync(tabs_snapshot, tab_edits, cx));
1086                        snapshot.check_invariants();
1087                        snapshot.verify_chunks(&mut rng);
1088                        edits.push((snapshot, wrap_edits));
1089                    }
1090                }
1091                _ => {
1092                    buffer.update(&mut cx, |buffer, cx| {
1093                        let subscription = buffer.subscribe();
1094                        let edit_count = rng.gen_range(1..=5);
1095                        buffer.randomly_edit(&mut rng, edit_count, cx);
1096                        buffer_snapshot = buffer.snapshot(cx);
1097                        buffer_edits.extend(subscription.consume());
1098                    });
1099                }
1100            }
1101
1102            log::info!("Unwrapped text (no folds): {:?}", buffer_snapshot.text());
1103            let (folds_snapshot, fold_edits) = fold_map.read(buffer_snapshot.clone(), buffer_edits);
1104            log::info!(
1105                "Unwrapped text (unexpanded tabs): {:?}",
1106                folds_snapshot.text()
1107            );
1108            let (tabs_snapshot, tab_edits) = tab_map.sync(folds_snapshot, fold_edits);
1109            log::info!("Unwrapped text (expanded tabs): {:?}", tabs_snapshot.text());
1110
1111            let unwrapped_text = tabs_snapshot.text();
1112            let expected_text = wrap_text(&unwrapped_text, wrap_width, &mut line_wrapper);
1113            let (mut snapshot, wrap_edits) = wrap_map.update(&mut cx, |map, cx| {
1114                map.sync(tabs_snapshot.clone(), tab_edits, cx)
1115            });
1116            snapshot.check_invariants();
1117            snapshot.verify_chunks(&mut rng);
1118            edits.push((snapshot, wrap_edits));
1119
1120            if wrap_map.read_with(&cx, |map, _| map.is_rewrapping()) && rng.gen_bool(0.4) {
1121                log::info!("Waiting for wrapping to finish");
1122                while wrap_map.read_with(&cx, |map, _| map.is_rewrapping()) {
1123                    notifications.recv().await.unwrap();
1124                }
1125                wrap_map.read_with(&cx, |map, _| assert!(map.pending_edits.is_empty()));
1126            }
1127
1128            if !wrap_map.read_with(&cx, |map, _| map.is_rewrapping()) {
1129                let (mut wrapped_snapshot, wrap_edits) =
1130                    wrap_map.update(&mut cx, |map, cx| map.sync(tabs_snapshot, Vec::new(), cx));
1131                let actual_text = wrapped_snapshot.text();
1132                let actual_longest_row = wrapped_snapshot.longest_row();
1133                log::info!("Wrapping finished: {:?}", actual_text);
1134                wrapped_snapshot.check_invariants();
1135                wrapped_snapshot.verify_chunks(&mut rng);
1136                edits.push((wrapped_snapshot.clone(), wrap_edits));
1137                assert_eq!(
1138                    actual_text, expected_text,
1139                    "unwrapped text is: {:?}",
1140                    unwrapped_text
1141                );
1142
1143                let mut summary = TextSummary::default();
1144                for (ix, item) in wrapped_snapshot
1145                    .transforms
1146                    .items(&())
1147                    .into_iter()
1148                    .enumerate()
1149                {
1150                    summary += &item.summary.output;
1151                    log::info!("{} summary: {:?}", ix, item.summary.output,);
1152                }
1153
1154                if tab_size == 1
1155                    || !wrapped_snapshot
1156                        .tab_snapshot
1157                        .fold_snapshot
1158                        .text()
1159                        .contains('\t')
1160                {
1161                    let mut expected_longest_rows = Vec::new();
1162                    let mut longest_line_len = -1;
1163                    for (row, line) in expected_text.split('\n').enumerate() {
1164                        let line_char_count = line.chars().count() as isize;
1165                        if line_char_count > longest_line_len {
1166                            expected_longest_rows.clear();
1167                            longest_line_len = line_char_count;
1168                        }
1169                        if line_char_count >= longest_line_len {
1170                            expected_longest_rows.push(row as u32);
1171                        }
1172                    }
1173
1174                    assert!(
1175                        expected_longest_rows.contains(&actual_longest_row),
1176                        "incorrect longest row {}. expected {:?} with length {}",
1177                        actual_longest_row,
1178                        expected_longest_rows,
1179                        longest_line_len,
1180                    )
1181                }
1182            }
1183        }
1184
1185        let mut initial_text = Rope::from(initial_snapshot.text().as_str());
1186        for (snapshot, patch) in edits {
1187            let snapshot_text = Rope::from(snapshot.text().as_str());
1188            for edit in &patch {
1189                let old_start = initial_text.point_to_offset(Point::new(edit.new.start, 0));
1190                let old_end = initial_text.point_to_offset(cmp::min(
1191                    Point::new(edit.new.start + edit.old.len() as u32, 0),
1192                    initial_text.max_point(),
1193                ));
1194                let new_start = snapshot_text.point_to_offset(Point::new(edit.new.start, 0));
1195                let new_end = snapshot_text.point_to_offset(cmp::min(
1196                    Point::new(edit.new.end, 0),
1197                    snapshot_text.max_point(),
1198                ));
1199                let new_text = snapshot_text
1200                    .chunks_in_range(new_start..new_end)
1201                    .collect::<String>();
1202
1203                initial_text.replace(old_start..old_end, &new_text);
1204            }
1205            assert_eq!(initial_text.to_string(), snapshot_text.to_string());
1206        }
1207
1208        if wrap_map.read_with(&cx, |map, _| map.is_rewrapping()) {
1209            log::info!("Waiting for wrapping to finish");
1210            while wrap_map.read_with(&cx, |map, _| map.is_rewrapping()) {
1211                notifications.recv().await.unwrap();
1212            }
1213        }
1214        wrap_map.read_with(&cx, |map, _| assert!(map.pending_edits.is_empty()));
1215    }
1216
1217    fn wrap_text(
1218        unwrapped_text: &str,
1219        wrap_width: Option<f32>,
1220        line_wrapper: &mut LineWrapper,
1221    ) -> String {
1222        if let Some(wrap_width) = wrap_width {
1223            let mut wrapped_text = String::new();
1224            for (row, line) in unwrapped_text.split('\n').enumerate() {
1225                if row > 0 {
1226                    wrapped_text.push('\n')
1227                }
1228
1229                let mut prev_ix = 0;
1230                for boundary in line_wrapper.wrap_line(line, wrap_width) {
1231                    wrapped_text.push_str(&line[prev_ix..boundary.ix]);
1232                    wrapped_text.push('\n');
1233                    wrapped_text.push_str(&" ".repeat(boundary.next_indent as usize));
1234                    prev_ix = boundary.ix;
1235                }
1236                wrapped_text.push_str(&line[prev_ix..]);
1237            }
1238            wrapped_text
1239        } else {
1240            unwrapped_text.to_string()
1241        }
1242    }
1243
1244    impl WrapSnapshot {
1245        pub fn text(&self) -> String {
1246            self.text_chunks(0).collect()
1247        }
1248
1249        fn verify_chunks(&mut self, rng: &mut impl Rng) {
1250            for _ in 0..5 {
1251                let mut end_row = rng.gen_range(0..=self.max_point().row());
1252                let start_row = rng.gen_range(0..=end_row);
1253                end_row += 1;
1254
1255                let mut expected_text = self.text_chunks(start_row).collect::<String>();
1256                if expected_text.ends_with("\n") {
1257                    expected_text.push('\n');
1258                }
1259                let mut expected_text = expected_text
1260                    .lines()
1261                    .take((end_row - start_row) as usize)
1262                    .collect::<Vec<_>>()
1263                    .join("\n");
1264                if end_row <= self.max_point().row() {
1265                    expected_text.push('\n');
1266                }
1267
1268                let actual_text = self
1269                    .chunks(start_row..end_row, None)
1270                    .map(|c| c.text)
1271                    .collect::<String>();
1272                assert_eq!(
1273                    expected_text,
1274                    actual_text,
1275                    "chunks != highlighted_chunks for rows {:?}",
1276                    start_row..end_row
1277                );
1278            }
1279        }
1280    }
1281}