use super::{ buffer::{AnchorRangeExt, TextSummary}, Anchor, Buffer, Point, ToOffset, }; use buffer::HighlightId; use gpui::{AppContext, ModelHandle}; use parking_lot::Mutex; use std::{ cmp::{self, Ordering}, iter, mem, ops::Range, sync::atomic::{AtomicUsize, Ordering::SeqCst}, }; use sum_tree::{self, Bias, Cursor, FilterCursor, SumTree}; pub trait ToFoldPoint { fn to_fold_point(&self, snapshot: &Snapshot, bias: Bias) -> FoldPoint; } #[derive(Copy, Clone, Debug, Default, Eq, Ord, PartialOrd, PartialEq)] pub struct FoldPoint(pub super::Point); impl FoldPoint { pub fn new(row: u32, column: u32) -> Self { Self(super::Point::new(row, column)) } pub fn row(self) -> u32 { self.0.row } pub fn column(self) -> u32 { self.0.column } pub fn row_mut(&mut self) -> &mut u32 { &mut self.0.row } #[cfg(test)] pub fn column_mut(&mut self) -> &mut u32 { &mut self.0.column } pub fn to_buffer_point(&self, snapshot: &Snapshot) -> Point { let mut cursor = snapshot.transforms.cursor::<(FoldPoint, Point)>(); cursor.seek(self, Bias::Right, &()); let overshoot = self.0 - cursor.start().0 .0; cursor.start().1 + overshoot } pub fn to_buffer_offset(&self, snapshot: &Snapshot) -> usize { let mut cursor = snapshot.transforms.cursor::<(FoldPoint, Point)>(); cursor.seek(self, Bias::Right, &()); let overshoot = self.0 - cursor.start().0 .0; snapshot .buffer_snapshot .to_offset(cursor.start().1 + overshoot) } pub fn to_offset(&self, snapshot: &Snapshot) -> FoldOffset { let mut cursor = snapshot .transforms .cursor::<(FoldPoint, TransformSummary)>(); cursor.seek(self, Bias::Right, &()); let overshoot = self.0 - cursor.start().1.output.lines; let mut offset = cursor.start().1.output.bytes; if !overshoot.is_zero() { let transform = cursor.item().expect("display point out of range"); assert!(transform.output_text.is_none()); let end_buffer_offset = snapshot .buffer_snapshot .to_offset(cursor.start().1.input.lines + overshoot); offset += end_buffer_offset - cursor.start().1.input.bytes; } FoldOffset(offset) } } impl ToFoldPoint for Point { fn to_fold_point(&self, snapshot: &Snapshot, bias: Bias) -> FoldPoint { let mut cursor = snapshot.transforms.cursor::<(Point, FoldPoint)>(); cursor.seek(self, Bias::Right, &()); if cursor.item().map_or(false, |t| t.is_fold()) { if bias == Bias::Left || *self == cursor.start().0 { cursor.start().1 } else { cursor.end(&()).1 } } else { let overshoot = *self - cursor.start().0; FoldPoint(cmp::min( cursor.start().1 .0 + overshoot, cursor.end(&()).1 .0, )) } } } pub struct FoldMapWriter<'a>(&'a mut FoldMap); impl<'a> FoldMapWriter<'a> { pub fn fold( &mut self, ranges: impl IntoIterator>, cx: &AppContext, ) -> (Snapshot, Vec) { let mut edits = Vec::new(); let mut folds = Vec::new(); let buffer = self.0.buffer.read(cx).snapshot(); for range in ranges.into_iter() { let range = range.start.to_offset(&buffer)..range.end.to_offset(&buffer); if range.start != range.end { let fold = Fold(buffer.anchor_after(range.start)..buffer.anchor_before(range.end)); folds.push(fold); edits.push(buffer::Edit { old_bytes: range.clone(), new_bytes: range.clone(), ..Default::default() }); } } folds.sort_unstable_by(|a, b| sum_tree::SeekTarget::cmp(a, b, &buffer)); self.0.folds = { let mut new_tree = SumTree::new(); let mut cursor = self.0.folds.cursor::(); for fold in folds { new_tree.push_tree(cursor.slice(&fold, Bias::Right, &buffer), &buffer); new_tree.push(fold, &buffer); } new_tree.push_tree(cursor.suffix(&buffer), &buffer); new_tree }; consolidate_buffer_edits(&mut edits); let edits = self.0.apply_edits(edits, cx); let snapshot = Snapshot { transforms: self.0.transforms.lock().clone(), folds: self.0.folds.clone(), buffer_snapshot: self.0.buffer.read(cx).snapshot(), version: self.0.version.load(SeqCst), }; (snapshot, edits) } pub fn unfold( &mut self, ranges: impl IntoIterator>, cx: &AppContext, ) -> (Snapshot, Vec) { let mut edits = Vec::new(); let mut fold_ixs_to_delete = Vec::new(); let buffer = self.0.buffer.read(cx).snapshot(); for range in ranges.into_iter() { // Remove intersecting folds and add their ranges to edits that are passed to apply_edits. let mut folds_cursor = intersecting_folds(&buffer, &self.0.folds, range, true); while let Some(fold) = folds_cursor.item() { let offset_range = fold.0.start.to_offset(&buffer)..fold.0.end.to_offset(&buffer); edits.push(buffer::Edit { old_bytes: offset_range.clone(), new_bytes: offset_range, ..Default::default() }); fold_ixs_to_delete.push(*folds_cursor.start()); folds_cursor.next(&buffer); } } fold_ixs_to_delete.sort_unstable(); fold_ixs_to_delete.dedup(); self.0.folds = { let mut cursor = self.0.folds.cursor::(); let mut folds = SumTree::new(); for fold_ix in fold_ixs_to_delete { folds.push_tree(cursor.slice(&fold_ix, Bias::Right, &buffer), &buffer); cursor.next(&buffer); } folds.push_tree(cursor.suffix(&buffer), &buffer); folds }; consolidate_buffer_edits(&mut edits); let edits = self.0.apply_edits(edits, cx); let snapshot = Snapshot { transforms: self.0.transforms.lock().clone(), folds: self.0.folds.clone(), buffer_snapshot: self.0.buffer.read(cx).snapshot(), version: self.0.version.load(SeqCst), }; (snapshot, edits) } } pub struct FoldMap { buffer: ModelHandle, transforms: Mutex>, folds: SumTree, last_sync: Mutex, version: AtomicUsize, } #[derive(Clone)] struct SyncState { version: clock::Global, parse_count: usize, } impl FoldMap { pub fn new(buffer_handle: ModelHandle, cx: &AppContext) -> (Self, Snapshot) { let buffer = buffer_handle.read(cx); let this = Self { buffer: buffer_handle, folds: Default::default(), transforms: Mutex::new(SumTree::from_item( Transform { summary: TransformSummary { input: buffer.text_summary(), output: buffer.text_summary(), }, output_text: None, }, &(), )), last_sync: Mutex::new(SyncState { version: buffer.version(), parse_count: buffer.parse_count(), }), version: AtomicUsize::new(0), }; let (snapshot, _) = this.read(cx); (this, snapshot) } pub fn read(&self, cx: &AppContext) -> (Snapshot, Vec) { let edits = self.sync(cx); self.check_invariants(cx); let snapshot = Snapshot { transforms: self.transforms.lock().clone(), folds: self.folds.clone(), buffer_snapshot: self.buffer.read(cx).snapshot(), version: self.version.load(SeqCst), }; (snapshot, edits) } pub fn write(&mut self, cx: &AppContext) -> (FoldMapWriter, Snapshot, Vec) { let (snapshot, edits) = self.read(cx); (FoldMapWriter(self), snapshot, edits) } fn sync(&self, cx: &AppContext) -> Vec { let buffer = self.buffer.read(cx); let last_sync = mem::replace( &mut *self.last_sync.lock(), SyncState { version: buffer.version(), parse_count: buffer.parse_count(), }, ); let edits = buffer .edits_since(last_sync.version) .map(Into::into) .collect::>(); if edits.is_empty() { if last_sync.parse_count != buffer.parse_count() { self.version.fetch_add(1, SeqCst); } Vec::new() } else { self.apply_edits(edits, cx) } } fn check_invariants(&self, cx: &AppContext) { if cfg!(test) { let buffer = self.buffer.read(cx); assert_eq!( self.transforms.lock().summary().input.bytes, buffer.len(), "transform tree does not match buffer's length" ); } } fn apply_edits(&self, buffer_edits: Vec, cx: &AppContext) -> Vec { let buffer = self.buffer.read(cx).snapshot(); let mut buffer_edits_iter = buffer_edits.iter().cloned().peekable(); let mut new_transforms = SumTree::new(); let mut transforms = self.transforms.lock(); let mut cursor = transforms.cursor::(); cursor.seek(&0, Bias::Right, &()); while let Some(mut edit) = buffer_edits_iter.next() { new_transforms.push_tree(cursor.slice(&edit.old_bytes.start, Bias::Left, &()), &()); edit.new_bytes.start -= edit.old_bytes.start - cursor.start(); edit.old_bytes.start = *cursor.start(); cursor.seek(&edit.old_bytes.end, Bias::Right, &()); cursor.next(&()); let mut delta = edit.delta(); loop { edit.old_bytes.end = *cursor.start(); if let Some(next_edit) = buffer_edits_iter.peek() { if next_edit.old_bytes.start > edit.old_bytes.end { break; } let next_edit = buffer_edits_iter.next().unwrap(); delta += next_edit.delta(); if next_edit.old_bytes.end >= edit.old_bytes.end { edit.old_bytes.end = next_edit.old_bytes.end; cursor.seek(&edit.old_bytes.end, Bias::Right, &()); cursor.next(&()); } } else { break; } } edit.new_bytes.end = ((edit.new_bytes.start + edit.deleted_bytes()) as isize + delta) as usize; let anchor = buffer.anchor_before(edit.new_bytes.start); let mut folds_cursor = self.folds.cursor::(); folds_cursor.seek(&Fold(anchor..Anchor::max()), Bias::Left, &buffer); let mut folds = iter::from_fn({ let buffer = &buffer; move || { let item = folds_cursor .item() .map(|f| f.0.start.to_offset(buffer)..f.0.end.to_offset(buffer)); folds_cursor.next(buffer); item } }) .peekable(); while folds .peek() .map_or(false, |fold| fold.start < edit.new_bytes.end) { let mut fold = folds.next().unwrap(); let sum = new_transforms.summary(); assert!(fold.start >= sum.input.bytes); while folds .peek() .map_or(false, |next_fold| next_fold.start <= fold.end) { let next_fold = folds.next().unwrap(); if next_fold.end > fold.end { fold.end = next_fold.end; } } if fold.start > sum.input.bytes { let text_summary = buffer.text_summary_for_range(sum.input.bytes..fold.start); new_transforms.push( Transform { summary: TransformSummary { output: text_summary.clone(), input: text_summary, }, output_text: None, }, &(), ); } if fold.end > fold.start { let output_text = "…"; let chars = output_text.chars().count() as u32; let lines = super::Point::new(0, output_text.len() as u32); new_transforms.push( Transform { summary: TransformSummary { output: TextSummary { bytes: output_text.len(), lines, first_line_chars: chars, last_line_chars: chars, longest_row: 0, longest_row_chars: chars, }, input: buffer.text_summary_for_range(fold.start..fold.end), }, output_text: Some(output_text), }, &(), ); } } let sum = new_transforms.summary(); if sum.input.bytes < edit.new_bytes.end { let text_summary = buffer.text_summary_for_range(sum.input.bytes..edit.new_bytes.end); new_transforms.push( Transform { summary: TransformSummary { output: text_summary.clone(), input: text_summary, }, output_text: None, }, &(), ); } } new_transforms.push_tree(cursor.suffix(&()), &()); if new_transforms.is_empty() { let text_summary = buffer.text_summary(); new_transforms.push( Transform { summary: TransformSummary { output: text_summary.clone(), input: text_summary, }, output_text: None, }, &(), ); } drop(cursor); let mut fold_edits = Vec::with_capacity(buffer_edits.len()); { let mut old_transforms = transforms.cursor::<(usize, FoldOffset)>(); let mut new_transforms = new_transforms.cursor::<(usize, FoldOffset)>(); for mut edit in buffer_edits { old_transforms.seek(&edit.old_bytes.start, Bias::Left, &()); if old_transforms.item().map_or(false, |t| t.is_fold()) { edit.old_bytes.start = old_transforms.start().0; } let old_start = old_transforms.start().1 .0 + (edit.old_bytes.start - old_transforms.start().0); old_transforms.seek_forward(&edit.old_bytes.end, Bias::Right, &()); if old_transforms.item().map_or(false, |t| t.is_fold()) { old_transforms.next(&()); edit.old_bytes.end = old_transforms.start().0; } let old_end = old_transforms.start().1 .0 + (edit.old_bytes.end - old_transforms.start().0); new_transforms.seek(&edit.new_bytes.start, Bias::Left, &()); if new_transforms.item().map_or(false, |t| t.is_fold()) { edit.new_bytes.start = new_transforms.start().0; } let new_start = new_transforms.start().1 .0 + (edit.new_bytes.start - new_transforms.start().0); new_transforms.seek_forward(&edit.new_bytes.end, Bias::Right, &()); if new_transforms.item().map_or(false, |t| t.is_fold()) { new_transforms.next(&()); edit.new_bytes.end = new_transforms.start().0; } let new_end = new_transforms.start().1 .0 + (edit.new_bytes.end - new_transforms.start().0); fold_edits.push(FoldEdit { old_bytes: FoldOffset(old_start)..FoldOffset(old_end), new_bytes: FoldOffset(new_start)..FoldOffset(new_end), }); } consolidate_fold_edits(&mut fold_edits); } *transforms = new_transforms; self.version.fetch_add(1, SeqCst); fold_edits } } #[derive(Clone)] pub struct Snapshot { transforms: SumTree, folds: SumTree, buffer_snapshot: buffer::Snapshot, pub version: usize, } impl Snapshot { #[cfg(test)] pub fn text(&self) -> String { self.chunks_at(FoldOffset(0)).collect() } #[cfg(test)] pub fn fold_count(&self) -> usize { self.folds.items(&self.buffer_snapshot).len() } pub fn text_summary_for_range(&self, range: Range) -> TextSummary { let mut summary = TextSummary::default(); let mut cursor = self.transforms.cursor::<(FoldPoint, Point)>(); cursor.seek(&range.start, Bias::Right, &()); if let Some(transform) = cursor.item() { let start_in_transform = range.start.0 - cursor.start().0 .0; let end_in_transform = cmp::min(range.end, cursor.end(&()).0).0 - cursor.start().0 .0; if let Some(output_text) = transform.output_text { summary = TextSummary::from( &output_text [start_in_transform.column as usize..end_in_transform.column as usize], ); } else { let buffer_start = cursor.start().1 + start_in_transform; let buffer_end = cursor.start().1 + end_in_transform; summary = self .buffer_snapshot .text_summary_for_range(buffer_start..buffer_end); } } if range.end > cursor.end(&()).0 { cursor.next(&()); summary += &cursor .summary::<_, TransformSummary>(&range.end, Bias::Right, &()) .output; if let Some(transform) = cursor.item() { let end_in_transform = range.end.0 - cursor.start().0 .0; if let Some(output_text) = transform.output_text { summary += TextSummary::from(&output_text[..end_in_transform.column as usize]); } else { let buffer_start = cursor.start().1; let buffer_end = cursor.start().1 + end_in_transform; summary += self .buffer_snapshot .text_summary_for_range(buffer_start..buffer_end); } } } summary } #[cfg(test)] pub fn len(&self) -> FoldOffset { FoldOffset(self.transforms.summary().output.bytes) } #[cfg(test)] pub fn line_len(&self, row: u32) -> u32 { let line_start = FoldPoint::new(row, 0).to_offset(self).0; let line_end = if row >= self.max_point().row() { self.len().0 } else { FoldPoint::new(row + 1, 0).to_offset(self).0 - 1 }; (line_end - line_start) as u32 } pub fn buffer_rows(&self, start_row: u32) -> BufferRows { if start_row > self.transforms.summary().output.lines.row { panic!("invalid display row {}", start_row); } let fold_point = FoldPoint::new(start_row, 0); let mut cursor = self.transforms.cursor(); cursor.seek(&fold_point, Bias::Left, &()); BufferRows { fold_point, cursor } } pub fn max_point(&self) -> FoldPoint { FoldPoint(self.transforms.summary().output.lines) } #[cfg(test)] pub fn longest_row(&self) -> u32 { self.transforms.summary().output.longest_row } pub fn folds_in_range<'a, T>( &'a self, range: Range, ) -> impl Iterator> where T: ToOffset, { let mut folds = intersecting_folds(&self.buffer_snapshot, &self.folds, range, false); iter::from_fn(move || { let item = folds.item().map(|f| &f.0); folds.next(&self.buffer_snapshot); item }) } pub fn intersects_fold(&self, offset: T) -> bool where T: ToOffset, { let offset = offset.to_offset(&self.buffer_snapshot); let mut cursor = self.transforms.cursor::(); cursor.seek(&offset, Bias::Right, &()); cursor.item().map_or(false, |t| t.output_text.is_some()) } pub fn is_line_folded(&self, output_row: u32) -> bool { let mut cursor = self.transforms.cursor::(); cursor.seek(&FoldPoint::new(output_row, 0), Bias::Right, &()); while let Some(transform) = cursor.item() { if transform.output_text.is_some() { return true; } if cursor.end(&()).row() == output_row { cursor.next(&()) } else { break; } } false } pub fn chunks_at(&self, offset: FoldOffset) -> Chunks { let mut transform_cursor = self.transforms.cursor::<(FoldOffset, usize)>(); transform_cursor.seek(&offset, Bias::Right, &()); let overshoot = offset.0 - transform_cursor.start().0 .0; let buffer_offset = transform_cursor.start().1 + overshoot; Chunks { transform_cursor, buffer_offset, buffer_chunks: self .buffer_snapshot .text_for_range(buffer_offset..self.buffer_snapshot.len()), } } pub fn highlighted_chunks(&mut self, range: Range) -> HighlightedChunks { let mut transform_cursor = self.transforms.cursor::<(FoldOffset, usize)>(); transform_cursor.seek(&range.end, Bias::Right, &()); let overshoot = range.end.0 - transform_cursor.start().0 .0; let buffer_end = transform_cursor.start().1 + overshoot; transform_cursor.seek(&range.start, Bias::Right, &()); let overshoot = range.start.0 - transform_cursor.start().0 .0; let buffer_start = transform_cursor.start().1 + overshoot; HighlightedChunks { transform_cursor, buffer_offset: buffer_start, buffer_chunks: self .buffer_snapshot .highlighted_text_for_range(buffer_start..buffer_end), buffer_chunk: None, } } pub fn chars_at<'a>(&'a self, point: FoldPoint) -> impl Iterator + 'a { let offset = point.to_offset(self); self.chunks_at(offset).flat_map(str::chars) } #[cfg(test)] pub fn clip_offset(&self, offset: FoldOffset, bias: Bias) -> FoldOffset { let mut cursor = self.transforms.cursor::<(FoldOffset, usize)>(); cursor.seek(&offset, Bias::Right, &()); if let Some(transform) = cursor.item() { let transform_start = cursor.start().0 .0; if transform.output_text.is_some() { if offset.0 == transform_start || matches!(bias, Bias::Left) { FoldOffset(transform_start) } else { FoldOffset(cursor.end(&()).0 .0) } } else { let overshoot = offset.0 - transform_start; let buffer_offset = cursor.start().1 + overshoot; let clipped_buffer_offset = self.buffer_snapshot.clip_offset(buffer_offset, bias); FoldOffset( (offset.0 as isize + (clipped_buffer_offset as isize - buffer_offset as isize)) as usize, ) } } else { FoldOffset(self.transforms.summary().output.bytes) } } pub fn clip_point(&self, point: FoldPoint, bias: Bias) -> FoldPoint { let mut cursor = self.transforms.cursor::<(FoldPoint, Point)>(); cursor.seek(&point, Bias::Right, &()); if let Some(transform) = cursor.item() { let transform_start = cursor.start().0 .0; if transform.output_text.is_some() { if point.0 == transform_start || matches!(bias, Bias::Left) { FoldPoint(transform_start) } else { FoldPoint(cursor.end(&()).0 .0) } } else { let overshoot = point.0 - transform_start; let buffer_position = cursor.start().1 + overshoot; let clipped_buffer_position = self.buffer_snapshot.clip_point(buffer_position, bias); FoldPoint::new( point.row(), ((point.column() as i32) + clipped_buffer_position.column as i32 - buffer_position.column as i32) as u32, ) } } else { FoldPoint(self.transforms.summary().output.lines) } } } fn intersecting_folds<'a, T>( buffer: &'a buffer::Snapshot, folds: &'a SumTree, range: Range, inclusive: bool, ) -> FilterCursor<'a, impl 'a + Fn(&FoldSummary) -> bool, Fold, usize> where T: ToOffset, { let start = buffer.anchor_before(range.start.to_offset(buffer)); let end = buffer.anchor_after(range.end.to_offset(buffer)); folds.filter::<_, usize>( move |summary| { let start_cmp = start.cmp(&summary.max_end, buffer).unwrap(); let end_cmp = end.cmp(&summary.min_start, buffer).unwrap(); if inclusive { start_cmp <= Ordering::Equal && end_cmp >= Ordering::Equal } else { start_cmp == Ordering::Less && end_cmp == Ordering::Greater } }, buffer, ) } fn consolidate_buffer_edits(edits: &mut Vec) { edits.sort_unstable_by(|a, b| { a.old_bytes .start .cmp(&b.old_bytes.start) .then_with(|| b.old_bytes.end.cmp(&a.old_bytes.end)) }); let mut i = 1; while i < edits.len() { let edit = edits[i].clone(); let prev_edit = &mut edits[i - 1]; if prev_edit.old_bytes.end >= edit.old_bytes.start { prev_edit.old_bytes.end = prev_edit.old_bytes.end.max(edit.old_bytes.end); prev_edit.new_bytes.start = prev_edit.new_bytes.start.min(edit.new_bytes.start); prev_edit.new_bytes.end = prev_edit.new_bytes.end.max(edit.new_bytes.end); edits.remove(i); continue; } i += 1; } } fn consolidate_fold_edits(edits: &mut Vec) { edits.sort_unstable_by(|a, b| { a.old_bytes .start .cmp(&b.old_bytes.start) .then_with(|| b.old_bytes.end.cmp(&a.old_bytes.end)) }); let mut i = 1; while i < edits.len() { let edit = edits[i].clone(); let prev_edit = &mut edits[i - 1]; if prev_edit.old_bytes.end >= edit.old_bytes.start { prev_edit.old_bytes.end = prev_edit.old_bytes.end.max(edit.old_bytes.end); prev_edit.new_bytes.start = prev_edit.new_bytes.start.min(edit.new_bytes.start); prev_edit.new_bytes.end = prev_edit.new_bytes.end.max(edit.new_bytes.end); edits.remove(i); continue; } i += 1; } } #[derive(Clone, Debug, Default, Eq, PartialEq)] struct Transform { summary: TransformSummary, output_text: Option<&'static str>, } impl Transform { fn is_fold(&self) -> bool { self.output_text.is_some() } } #[derive(Clone, Debug, Default, Eq, PartialEq)] struct TransformSummary { output: TextSummary, input: TextSummary, } impl sum_tree::Item for Transform { type Summary = TransformSummary; fn summary(&self) -> Self::Summary { self.summary.clone() } } impl sum_tree::Summary for TransformSummary { type Context = (); fn add_summary(&mut self, other: &Self, _: &()) { self.input += &other.input; self.output += &other.output; } } #[derive(Clone, Debug)] struct Fold(Range); impl Default for Fold { fn default() -> Self { Self(Anchor::min()..Anchor::max()) } } impl sum_tree::Item for Fold { type Summary = FoldSummary; fn summary(&self) -> Self::Summary { FoldSummary { start: self.0.start.clone(), end: self.0.end.clone(), min_start: self.0.start.clone(), max_end: self.0.end.clone(), count: 1, } } } #[derive(Clone, Debug)] struct FoldSummary { start: Anchor, end: Anchor, min_start: Anchor, max_end: Anchor, count: usize, } impl Default for FoldSummary { fn default() -> Self { Self { start: Anchor::min(), end: Anchor::max(), min_start: Anchor::max(), max_end: Anchor::min(), count: 0, } } } impl sum_tree::Summary for FoldSummary { type Context = buffer::Snapshot; fn add_summary(&mut self, other: &Self, buffer: &buffer::Snapshot) { if other.min_start.cmp(&self.min_start, buffer).unwrap() == Ordering::Less { self.min_start = other.min_start.clone(); } if other.max_end.cmp(&self.max_end, buffer).unwrap() == Ordering::Greater { self.max_end = other.max_end.clone(); } #[cfg(debug_assertions)] { let start_comparison = self.start.cmp(&other.start, buffer).unwrap(); assert!(start_comparison <= Ordering::Equal); if start_comparison == Ordering::Equal { assert!(self.end.cmp(&other.end, buffer).unwrap() >= Ordering::Equal); } } self.start = other.start.clone(); self.end = other.end.clone(); self.count += other.count; } } impl<'a> sum_tree::Dimension<'a, FoldSummary> for Fold { fn add_summary(&mut self, summary: &'a FoldSummary, _: &buffer::Snapshot) { self.0.start = summary.start.clone(); self.0.end = summary.end.clone(); } } impl<'a> sum_tree::SeekTarget<'a, FoldSummary, Fold> for Fold { fn cmp(&self, other: &Self, buffer: &buffer::Snapshot) -> Ordering { self.0.cmp(&other.0, buffer).unwrap() } } impl<'a> sum_tree::Dimension<'a, FoldSummary> for usize { fn add_summary(&mut self, summary: &'a FoldSummary, _: &buffer::Snapshot) { *self += summary.count; } } pub struct BufferRows<'a> { cursor: Cursor<'a, Transform, (FoldPoint, Point)>, fold_point: FoldPoint, } impl<'a> Iterator for BufferRows<'a> { type Item = u32; fn next(&mut self) -> Option { while self.fold_point > self.cursor.end(&()).0 { self.cursor.next(&()); if self.cursor.item().is_none() { // TODO: Return a bool from next? break; } } if self.cursor.item().is_some() { let overshoot = self.fold_point.0 - self.cursor.start().0 .0; let buffer_point = self.cursor.start().1 + overshoot; *self.fold_point.row_mut() += 1; Some(buffer_point.row) } else { None } } } pub struct Chunks<'a> { transform_cursor: Cursor<'a, Transform, (FoldOffset, usize)>, buffer_chunks: buffer::Chunks<'a>, buffer_offset: usize, } impl<'a> Iterator for Chunks<'a> { type Item = &'a str; fn next(&mut self) -> Option { let transform = if let Some(item) = self.transform_cursor.item() { item } else { return None; }; // If we're in a fold, then return the fold's display text and // advance the transform and buffer cursors to the end of the fold. if let Some(output_text) = transform.output_text { self.buffer_offset += transform.summary.input.bytes; self.buffer_chunks.seek(self.buffer_offset); while self.buffer_offset >= self.transform_cursor.end(&()).1 && self.transform_cursor.item().is_some() { self.transform_cursor.next(&()); } return Some(output_text); } // Otherwise, take a chunk from the buffer's text. if let Some(mut chunk) = self.buffer_chunks.peek() { let offset_in_chunk = self.buffer_offset - self.buffer_chunks.offset(); chunk = &chunk[offset_in_chunk..]; // Truncate the chunk so that it ends at the next fold. let region_end = self.transform_cursor.end(&()).1 - self.buffer_offset; if chunk.len() >= region_end { chunk = &chunk[0..region_end]; self.transform_cursor.next(&()); } else { self.buffer_chunks.next(); } self.buffer_offset += chunk.len(); return Some(chunk); } None } } pub struct HighlightedChunks<'a> { transform_cursor: Cursor<'a, Transform, (FoldOffset, usize)>, buffer_chunks: buffer::HighlightedChunks<'a>, buffer_chunk: Option<(usize, &'a str, HighlightId)>, buffer_offset: usize, } impl<'a> Iterator for HighlightedChunks<'a> { type Item = (&'a str, HighlightId); fn next(&mut self) -> Option { let transform = if let Some(item) = self.transform_cursor.item() { item } else { return None; }; // If we're in a fold, then return the fold's display text and // advance the transform and buffer cursors to the end of the fold. if let Some(output_text) = transform.output_text { self.buffer_chunk.take(); self.buffer_offset += transform.summary.input.bytes; self.buffer_chunks.seek(self.buffer_offset); while self.buffer_offset >= self.transform_cursor.end(&()).1 && self.transform_cursor.item().is_some() { self.transform_cursor.next(&()); } return Some((output_text, HighlightId::default())); } // Retrieve a chunk from the current location in the buffer. if self.buffer_chunk.is_none() { let chunk_offset = self.buffer_chunks.offset(); self.buffer_chunk = self .buffer_chunks .next() .map(|(chunk, capture_ix)| (chunk_offset, chunk, capture_ix)); } // Otherwise, take a chunk from the buffer's text. if let Some((chunk_offset, mut chunk, capture_ix)) = self.buffer_chunk { let offset_in_chunk = self.buffer_offset - chunk_offset; chunk = &chunk[offset_in_chunk..]; // Truncate the chunk so that it ends at the next fold. let region_end = self.transform_cursor.end(&()).1 - self.buffer_offset; if chunk.len() >= region_end { chunk = &chunk[0..region_end]; self.transform_cursor.next(&()); } else { self.buffer_chunk.take(); } self.buffer_offset += chunk.len(); return Some((chunk, capture_ix)); } None } } impl<'a> sum_tree::Dimension<'a, TransformSummary> for FoldPoint { fn add_summary(&mut self, summary: &'a TransformSummary, _: &()) { self.0 += &summary.output.lines; } } #[derive(Copy, Clone, Debug, Default, Eq, Ord, PartialOrd, PartialEq)] pub struct FoldOffset(pub usize); impl FoldOffset { pub fn to_point(&self, snapshot: &Snapshot) -> FoldPoint { let mut cursor = snapshot .transforms .cursor::<(FoldOffset, TransformSummary)>(); cursor.seek(self, Bias::Right, &()); let overshoot = if cursor.item().map_or(true, |t| t.is_fold()) { Point::new(0, (self.0 - cursor.start().0 .0) as u32) } else { let buffer_offset = cursor.start().1.input.bytes + self.0 - cursor.start().0 .0; let buffer_point = snapshot.buffer_snapshot.to_point(buffer_offset); buffer_point - cursor.start().1.input.lines }; FoldPoint(cursor.start().1.output.lines + overshoot) } } impl<'a> sum_tree::Dimension<'a, TransformSummary> for FoldOffset { fn add_summary(&mut self, summary: &'a TransformSummary, _: &()) { self.0 += &summary.output.bytes; } } impl<'a> sum_tree::Dimension<'a, TransformSummary> for Point { fn add_summary(&mut self, summary: &'a TransformSummary, _: &()) { *self += &summary.input.lines; } } impl<'a> sum_tree::Dimension<'a, TransformSummary> for usize { fn add_summary(&mut self, summary: &'a TransformSummary, _: &()) { *self += &summary.input.bytes; } } #[derive(Clone, Debug, PartialEq, Eq)] pub struct FoldEdit { pub old_bytes: Range, pub new_bytes: Range, } #[cfg(test)] impl FoldEdit { pub fn delta(&self) -> isize { self.inserted_bytes() as isize - self.deleted_bytes() as isize } pub fn deleted_bytes(&self) -> usize { self.old_bytes.end.0 - self.old_bytes.start.0 } pub fn inserted_bytes(&self) -> usize { self.new_bytes.end.0 - self.new_bytes.start.0 } } #[cfg(test)] mod tests { use super::*; use crate::{test::sample_text, ToPoint}; use buffer::RandomCharIter; use rand::prelude::*; use std::{env, mem}; use Bias::{Left, Right}; #[gpui::test] fn test_basic_folds(cx: &mut gpui::MutableAppContext) { let buffer = cx.add_model(|cx| Buffer::new(0, sample_text(5, 6), cx)); let mut map = FoldMap::new(buffer.clone(), cx.as_ref()).0; let (mut writer, _, _) = map.write(cx.as_ref()); let (snapshot2, edits) = writer.fold( vec![ Point::new(0, 2)..Point::new(2, 2), Point::new(2, 4)..Point::new(4, 1), ], cx.as_ref(), ); assert_eq!(snapshot2.text(), "aa…cc…eeeee"); assert_eq!( edits, &[ FoldEdit { old_bytes: FoldOffset(2)..FoldOffset(16), new_bytes: FoldOffset(2)..FoldOffset(5), }, FoldEdit { old_bytes: FoldOffset(18)..FoldOffset(29), new_bytes: FoldOffset(7)..FoldOffset(10) }, ] ); buffer.update(cx, |buffer, cx| { buffer.edit( vec![ Point::new(0, 0)..Point::new(0, 1), Point::new(2, 3)..Point::new(2, 3), ], "123", cx, ); }); let (snapshot3, edits) = map.read(cx.as_ref()); assert_eq!(snapshot3.text(), "123a…c123c…eeeee"); assert_eq!( edits, &[ FoldEdit { old_bytes: FoldOffset(0)..FoldOffset(1), new_bytes: FoldOffset(0)..FoldOffset(3), }, FoldEdit { old_bytes: FoldOffset(6)..FoldOffset(6), new_bytes: FoldOffset(8)..FoldOffset(11), }, ] ); buffer.update(cx, |buffer, cx| { buffer.edit(vec![Point::new(2, 6)..Point::new(4, 3)], "456", cx) }); let (snapshot4, _) = map.read(cx.as_ref()); assert_eq!(snapshot4.text(), "123a…c123456eee"); let (mut writer, _, _) = map.write(cx.as_ref()); writer.unfold(Some(Point::new(0, 4)..Point::new(0, 5)), cx.as_ref()); let (snapshot5, _) = map.read(cx.as_ref()); assert_eq!(snapshot5.text(), "123aaaaa\nbbbbbb\nccc123456eee"); } #[gpui::test] fn test_adjacent_folds(cx: &mut gpui::MutableAppContext) { let buffer = cx.add_model(|cx| Buffer::new(0, "abcdefghijkl", cx)); { let mut map = FoldMap::new(buffer.clone(), cx.as_ref()).0; let (mut writer, _, _) = map.write(cx.as_ref()); writer.fold(vec![5..8], cx.as_ref()); let (snapshot, _) = map.read(cx.as_ref()); assert_eq!(snapshot.text(), "abcde…ijkl"); // Create an fold adjacent to the start of the first fold. let (mut writer, _, _) = map.write(cx.as_ref()); writer.fold(vec![0..1, 2..5], cx.as_ref()); let (snapshot, _) = map.read(cx.as_ref()); assert_eq!(snapshot.text(), "…b…ijkl"); // Create an fold adjacent to the end of the first fold. let (mut writer, _, _) = map.write(cx.as_ref()); writer.fold(vec![11..11, 8..10], cx.as_ref()); let (snapshot, _) = map.read(cx.as_ref()); assert_eq!(snapshot.text(), "…b…kl"); } { let mut map = FoldMap::new(buffer.clone(), cx.as_ref()).0; // Create two adjacent folds. let (mut writer, _, _) = map.write(cx.as_ref()); writer.fold(vec![0..2, 2..5], cx.as_ref()); let (snapshot, _) = map.read(cx.as_ref()); assert_eq!(snapshot.text(), "…fghijkl"); // Edit within one of the folds. buffer.update(cx, |buffer, cx| buffer.edit(vec![0..1], "12345", cx)); let (snapshot, _) = map.read(cx.as_ref()); assert_eq!(snapshot.text(), "12345…fghijkl"); } } #[gpui::test] fn test_overlapping_folds(cx: &mut gpui::MutableAppContext) { let buffer = cx.add_model(|cx| Buffer::new(0, sample_text(5, 6), cx)); let mut map = FoldMap::new(buffer.clone(), cx.as_ref()).0; let (mut writer, _, _) = map.write(cx.as_ref()); writer.fold( vec![ Point::new(0, 2)..Point::new(2, 2), Point::new(0, 4)..Point::new(1, 0), Point::new(1, 2)..Point::new(3, 2), Point::new(3, 1)..Point::new(4, 1), ], cx.as_ref(), ); let (snapshot, _) = map.read(cx.as_ref()); assert_eq!(snapshot.text(), "aa…eeeee"); } #[gpui::test] fn test_merging_folds_via_edit(cx: &mut gpui::MutableAppContext) { let buffer = cx.add_model(|cx| Buffer::new(0, sample_text(5, 6), cx)); let mut map = FoldMap::new(buffer.clone(), cx.as_ref()).0; let (mut writer, _, _) = map.write(cx.as_ref()); writer.fold( vec![ Point::new(0, 2)..Point::new(2, 2), Point::new(3, 1)..Point::new(4, 1), ], cx.as_ref(), ); let (snapshot, _) = map.read(cx.as_ref()); assert_eq!(snapshot.text(), "aa…cccc\nd…eeeee"); buffer.update(cx, |buffer, cx| { buffer.edit(Some(Point::new(2, 2)..Point::new(3, 1)), "", cx) }); let (snapshot, _) = map.read(cx.as_ref()); assert_eq!(snapshot.text(), "aa…eeeee"); } #[gpui::test] fn test_folds_in_range(cx: &mut gpui::MutableAppContext) { let buffer = cx.add_model(|cx| Buffer::new(0, sample_text(5, 6), cx)); let mut map = FoldMap::new(buffer.clone(), cx.as_ref()).0; let buffer = buffer.read(cx); let (mut writer, _, _) = map.write(cx.as_ref()); writer.fold( vec![ Point::new(0, 2)..Point::new(2, 2), Point::new(0, 4)..Point::new(1, 0), Point::new(1, 2)..Point::new(3, 2), Point::new(3, 1)..Point::new(4, 1), ], cx.as_ref(), ); let (snapshot, _) = map.read(cx.as_ref()); let fold_ranges = snapshot .folds_in_range(Point::new(1, 0)..Point::new(1, 3)) .map(|fold| fold.start.to_point(buffer)..fold.end.to_point(buffer)) .collect::>(); assert_eq!( fold_ranges, vec![ Point::new(0, 2)..Point::new(2, 2), Point::new(1, 2)..Point::new(3, 2) ] ); } #[gpui::test(iterations = 100)] fn test_random_folds(cx: &mut gpui::MutableAppContext, mut rng: StdRng) { let operations = env::var("OPERATIONS") .map(|i| i.parse().expect("invalid `OPERATIONS` variable")) .unwrap_or(10); let buffer = cx.add_model(|cx| { let len = rng.gen_range(0..10); let text = RandomCharIter::new(&mut rng).take(len).collect::(); Buffer::new(0, text, cx) }); let mut map = FoldMap::new(buffer.clone(), cx.as_ref()).0; let (mut initial_snapshot, _) = map.read(cx.as_ref()); let mut snapshot_edits = Vec::new(); for _ in 0..operations { log::info!("text: {:?}", buffer.read(cx).text()); match rng.gen_range(0..=100) { 0..=59 => { snapshot_edits.extend(map.randomly_mutate(&mut rng, cx.as_ref())); } _ => { let edits = buffer.update(cx, |buffer, cx| { let start_version = buffer.version.clone(); let edit_count = rng.gen_range(1..=5); buffer.randomly_edit(&mut rng, edit_count, cx); buffer.edits_since(start_version).collect::>() }); log::info!("editing {:?}", edits); } } let buffer = map.buffer.read(cx).snapshot(); let mut expected_text: String = buffer.text().into(); let mut expected_buffer_rows = Vec::new(); let mut next_row = buffer.max_point().row; for fold_range in map.merged_fold_ranges(cx.as_ref()).into_iter().rev() { let fold_start = buffer.point_for_offset(fold_range.start).unwrap(); let fold_end = buffer.point_for_offset(fold_range.end).unwrap(); expected_buffer_rows.extend((fold_end.row + 1..=next_row).rev()); next_row = fold_start.row; expected_text.replace_range(fold_range.start..fold_range.end, "…"); } expected_buffer_rows.extend((0..=next_row).rev()); expected_buffer_rows.reverse(); let (snapshot, edits) = map.read(cx.as_ref()); assert_eq!(snapshot.text(), expected_text); snapshot_edits.push((snapshot.clone(), edits)); for (output_row, line) in expected_text.lines().enumerate() { let line_len = snapshot.line_len(output_row as u32); assert_eq!(line_len, line.len() as u32); } let longest_row = snapshot.longest_row(); let longest_char_column = expected_text .split('\n') .nth(longest_row as usize) .unwrap() .chars() .count(); let mut fold_point = FoldPoint::new(0, 0); let mut fold_offset = FoldOffset(0); let mut char_column = 0; for c in expected_text.chars() { let buffer_point = fold_point.to_buffer_point(&snapshot); let buffer_offset = buffer_point.to_offset(&buffer); assert_eq!( buffer_point.to_fold_point(&snapshot, Right), fold_point, "{:?} -> fold point", buffer_point, ); assert_eq!( fold_point.to_buffer_offset(&snapshot), buffer_offset, "fold_point.to_buffer_offset({:?})", fold_point, ); assert_eq!( fold_point.to_offset(&snapshot), fold_offset, "fold_point.to_offset({:?})", fold_point, ); if c == '\n' { *fold_point.row_mut() += 1; *fold_point.column_mut() = 0; char_column = 0; } else { *fold_point.column_mut() += c.len_utf8() as u32; char_column += 1; } fold_offset.0 += c.len_utf8(); if char_column > longest_char_column { panic!( "invalid longest row {:?} (chars {}), found row {:?} (chars: {})", longest_row, longest_char_column, fold_point.row(), char_column ); } } for _ in 0..5 { let offset = snapshot .clip_offset(FoldOffset(rng.gen_range(0..=snapshot.len().0)), Bias::Right); assert_eq!( snapshot.chunks_at(offset).collect::(), &expected_text[offset.0..], ); } for (idx, buffer_row) in expected_buffer_rows.iter().enumerate() { let fold_row = Point::new(*buffer_row, 0) .to_fold_point(&snapshot, Right) .row(); assert_eq!( snapshot.buffer_rows(fold_row).collect::>(), expected_buffer_rows[idx..], ); } for fold_range in map.merged_fold_ranges(cx.as_ref()) { let fold_point = fold_range .start .to_point(&buffer) .to_fold_point(&snapshot, Right); assert!(snapshot.is_line_folded(fold_point.row())); } for _ in 0..5 { let end = buffer.clip_offset(rng.gen_range(0..=buffer.len()), Right); let start = buffer.clip_offset(rng.gen_range(0..=end), Left); let expected_folds = map .folds .items(&buffer) .into_iter() .filter(|fold| { let start = buffer.anchor_before(start); let end = buffer.anchor_after(end); start.cmp(&fold.0.end, &buffer).unwrap() == Ordering::Less && end.cmp(&fold.0.start, &buffer).unwrap() == Ordering::Greater }) .map(|fold| fold.0) .collect::>(); assert_eq!( snapshot .folds_in_range(start..end) .cloned() .collect::>(), expected_folds ); } let text = snapshot.text(); for _ in 0..5 { let start_row = rng.gen_range(0..=snapshot.max_point().row()); let start_column = rng.gen_range(0..=snapshot.line_len(start_row)); let end_row = rng.gen_range(0..=snapshot.max_point().row()); let end_column = rng.gen_range(0..=snapshot.line_len(end_row)); let mut start = snapshot.clip_point(FoldPoint::new(start_row, start_column), Bias::Left); let mut end = snapshot.clip_point(FoldPoint::new(end_row, end_column), Bias::Right); if start > end { mem::swap(&mut start, &mut end); } let lines = start..end; let bytes = start.to_offset(&snapshot)..end.to_offset(&snapshot); assert_eq!( snapshot.text_summary_for_range(lines), TextSummary::from(&text[bytes.start.0..bytes.end.0]) ) } let mut text = initial_snapshot.text(); for (snapshot, edits) in snapshot_edits.drain(..) { let new_text = snapshot.text(); let mut delta = 0isize; for edit in edits { let old_bytes = ((edit.old_bytes.start.0 as isize) + delta) as usize ..((edit.old_bytes.end.0 as isize) + delta) as usize; let new_bytes = edit.new_bytes.start.0..edit.new_bytes.end.0; delta += edit.delta(); text.replace_range(old_bytes, &new_text[new_bytes]); } assert_eq!(text, new_text); initial_snapshot = snapshot; } } } #[gpui::test] fn test_buffer_rows(cx: &mut gpui::MutableAppContext) { let text = sample_text(6, 6) + "\n"; let buffer = cx.add_model(|cx| Buffer::new(0, text, cx)); let mut map = FoldMap::new(buffer.clone(), cx.as_ref()).0; let (mut writer, _, _) = map.write(cx.as_ref()); writer.fold( vec![ Point::new(0, 2)..Point::new(2, 2), Point::new(3, 1)..Point::new(4, 1), ], cx.as_ref(), ); let (snapshot, _) = map.read(cx.as_ref()); assert_eq!(snapshot.text(), "aa…cccc\nd…eeeee\nffffff\n"); assert_eq!(snapshot.buffer_rows(0).collect::>(), [0, 3, 5, 6]); assert_eq!(snapshot.buffer_rows(3).collect::>(), [6]); } impl FoldMap { fn merged_fold_ranges(&self, cx: &AppContext) -> Vec> { let buffer = self.buffer.read(cx).snapshot(); let mut folds = self.folds.items(&buffer); // Ensure sorting doesn't change how folds get merged and displayed. folds.sort_by(|a, b| a.0.cmp(&b.0, &buffer).unwrap()); let mut fold_ranges = folds .iter() .map(|fold| fold.0.start.to_offset(&buffer)..fold.0.end.to_offset(&buffer)) .peekable(); let mut merged_ranges = Vec::new(); while let Some(mut fold_range) = fold_ranges.next() { while let Some(next_range) = fold_ranges.peek() { if fold_range.end >= next_range.start { if next_range.end > fold_range.end { fold_range.end = next_range.end; } fold_ranges.next(); } else { break; } } if fold_range.end > fold_range.start { merged_ranges.push(fold_range); } } merged_ranges } pub fn randomly_mutate( &mut self, rng: &mut impl Rng, cx: &AppContext, ) -> Vec<(Snapshot, Vec)> { let mut snapshot_edits = Vec::new(); match rng.gen_range(0..=100) { 0..=39 if !self.folds.is_empty() => { let buffer = self.buffer.read(cx); let mut to_unfold = Vec::new(); for _ in 0..rng.gen_range(1..=3) { let end = buffer.clip_offset(rng.gen_range(0..=buffer.len()), Right); let start = buffer.clip_offset(rng.gen_range(0..=end), Left); to_unfold.push(start..end); } log::info!("unfolding {:?}", to_unfold); let (mut writer, snapshot, edits) = self.write(cx.as_ref()); snapshot_edits.push((snapshot, edits)); let (snapshot, edits) = writer.fold(to_unfold, cx.as_ref()); snapshot_edits.push((snapshot, edits)); } _ => { let buffer = self.buffer.read(cx); let mut to_fold = Vec::new(); for _ in 0..rng.gen_range(1..=2) { let end = buffer.clip_offset(rng.gen_range(0..=buffer.len()), Right); let start = buffer.clip_offset(rng.gen_range(0..=end), Left); to_fold.push(start..end); } log::info!("folding {:?}", to_fold); let (mut writer, snapshot, edits) = self.write(cx.as_ref()); snapshot_edits.push((snapshot, edits)); let (snapshot, edits) = writer.fold(to_fold, cx.as_ref()); snapshot_edits.push((snapshot, edits)); } } snapshot_edits } } }