use super::{ fold_map::{FoldBufferRows, FoldChunks, FoldEdit, FoldOffset, FoldPoint, FoldSnapshot}, TextHighlights, }; use crate::ToPoint; use gpui::fonts::HighlightStyle; use language::{Bias, Chunk, Edit, Patch, Point, Rope}; use parking_lot::Mutex; use std::{ cmp, ops::{Add, AddAssign, Range, Sub}, }; use util::post_inc; pub type SuggestionEdit = Edit; #[derive(Copy, Clone, Debug, Default, Eq, Ord, PartialOrd, PartialEq)] pub struct SuggestionOffset(pub usize); impl Add for SuggestionOffset { type Output = Self; fn add(self, rhs: Self) -> Self::Output { Self(self.0 + rhs.0) } } impl Sub for SuggestionOffset { type Output = Self; fn sub(self, rhs: Self) -> Self::Output { Self(self.0 - rhs.0) } } impl AddAssign for SuggestionOffset { fn add_assign(&mut self, rhs: Self) { self.0 += rhs.0; } } #[derive(Copy, Clone, Debug, Default, Eq, Ord, PartialOrd, PartialEq)] pub struct SuggestionPoint(pub Point); impl SuggestionPoint { pub fn row(self) -> u32 { self.0.row } pub fn column(self) -> u32 { self.0.column } } #[derive(Clone, Debug)] pub struct Suggestion { position: T, text: Rope, highlight_style: HighlightStyle, } pub struct SuggestionMap(Mutex); impl SuggestionMap { pub fn new(fold_snapshot: FoldSnapshot) -> (Self, SuggestionSnapshot) { let snapshot = SuggestionSnapshot { fold_snapshot, suggestion: None, }; (Self(Mutex::new(snapshot.clone())), snapshot) } pub fn replace( &self, new_suggestion: Option>, fold_snapshot: FoldSnapshot, fold_edits: Vec, ) -> (SuggestionSnapshot, Vec) where T: ToPoint, { let new_suggestion = new_suggestion.map(|new_suggestion| { let buffer_point = new_suggestion .position .to_point(fold_snapshot.buffer_snapshot()); let fold_point = fold_snapshot.to_fold_point(buffer_point, Bias::Left); let fold_offset = fold_point.to_offset(&fold_snapshot); Suggestion { position: fold_offset, text: new_suggestion.text, highlight_style: new_suggestion.highlight_style, } }); let (_, edits) = self.sync(fold_snapshot, fold_edits); let mut snapshot = self.0.lock(); let mut patch = Patch::new(edits); if let Some(suggestion) = snapshot.suggestion.take() { patch = patch.compose([SuggestionEdit { old: SuggestionOffset(suggestion.position.0) ..SuggestionOffset(suggestion.position.0 + suggestion.text.len()), new: SuggestionOffset(suggestion.position.0) ..SuggestionOffset(suggestion.position.0), }]); } if let Some(suggestion) = new_suggestion.as_ref() { patch = patch.compose([SuggestionEdit { old: SuggestionOffset(suggestion.position.0) ..SuggestionOffset(suggestion.position.0), new: SuggestionOffset(suggestion.position.0) ..SuggestionOffset(suggestion.position.0 + suggestion.text.len()), }]); } snapshot.suggestion = new_suggestion; (snapshot.clone(), patch.into_inner()) } pub fn sync( &self, fold_snapshot: FoldSnapshot, fold_edits: Vec, ) -> (SuggestionSnapshot, Vec) { let mut snapshot = self.0.lock(); let mut suggestion_edits = Vec::new(); let mut suggestion_old_len = 0; let mut suggestion_new_len = 0; for fold_edit in fold_edits { let start = fold_edit.new.start; let end = FoldOffset(start.0 + fold_edit.old_len().0); if let Some(suggestion) = snapshot.suggestion.as_mut() { if end <= suggestion.position { suggestion.position.0 += fold_edit.new_len().0; suggestion.position.0 -= fold_edit.old_len().0; } else if start > suggestion.position { suggestion_old_len = suggestion.text.len(); suggestion_new_len = suggestion_old_len; } else { suggestion_old_len = suggestion.text.len(); snapshot.suggestion.take(); suggestion_edits.push(SuggestionEdit { old: SuggestionOffset(fold_edit.old.start.0) ..SuggestionOffset(fold_edit.old.end.0 + suggestion_old_len), new: SuggestionOffset(fold_edit.new.start.0) ..SuggestionOffset(fold_edit.new.end.0), }); continue; } } suggestion_edits.push(SuggestionEdit { old: SuggestionOffset(fold_edit.old.start.0 + suggestion_old_len) ..SuggestionOffset(fold_edit.old.end.0 + suggestion_old_len), new: SuggestionOffset(fold_edit.new.start.0 + suggestion_new_len) ..SuggestionOffset(fold_edit.new.end.0 + suggestion_new_len), }); } snapshot.fold_snapshot = fold_snapshot; (snapshot.clone(), suggestion_edits) } } #[derive(Clone)] pub struct SuggestionSnapshot { fold_snapshot: FoldSnapshot, suggestion: Option>, } impl SuggestionSnapshot { pub fn max_point(&self) -> SuggestionPoint { if let Some(suggestion) = self.suggestion.as_ref() { let suggestion_point = suggestion.position.to_point(&self.fold_snapshot); let mut max_point = suggestion_point.0; max_point += suggestion.text.max_point(); max_point += self.fold_snapshot.max_point().0 - suggestion_point.0; SuggestionPoint(max_point) } else { SuggestionPoint(self.fold_snapshot.max_point().0) } } pub fn len(&self) -> SuggestionOffset { if let Some(suggestion) = self.suggestion.as_ref() { let mut len = suggestion.position.0; len += suggestion.text.len(); len += self.fold_snapshot.len().0 - suggestion.position.0; SuggestionOffset(len) } else { SuggestionOffset(self.fold_snapshot.len().0) } } pub fn clip_point(&self, point: SuggestionPoint, bias: Bias) -> SuggestionPoint { if let Some(suggestion) = self.suggestion.as_ref() { let suggestion_start = suggestion.position.to_point(&self.fold_snapshot).0; let suggestion_end = suggestion_start + suggestion.text.max_point(); if point.0 <= suggestion_start { SuggestionPoint(self.fold_snapshot.clip_point(FoldPoint(point.0), bias).0) } else if point.0 > suggestion_end { let fold_point = self.fold_snapshot.clip_point( FoldPoint(suggestion_start + (point.0 - suggestion_end)), bias, ); let suggestion_point = suggestion_end + (fold_point.0 - suggestion_start); if bias == Bias::Left && suggestion_point == suggestion_end { SuggestionPoint(suggestion_start) } else { SuggestionPoint(suggestion_point) } } else if bias == Bias::Left || suggestion_start == self.fold_snapshot.max_point().0 { SuggestionPoint(suggestion_start) } else { let fold_point = if self.fold_snapshot.line_len(suggestion_start.row) > suggestion_start.column { FoldPoint(suggestion_start + Point::new(0, 1)) } else { FoldPoint(suggestion_start + Point::new(1, 0)) }; let clipped_fold_point = self.fold_snapshot.clip_point(fold_point, bias); SuggestionPoint(suggestion_end + (clipped_fold_point.0 - suggestion_start)) } } else { SuggestionPoint(self.fold_snapshot.clip_point(FoldPoint(point.0), bias).0) } } pub fn line_len(&self, row: u32) -> u32 { if let Some(suggestion) = self.suggestion.as_ref() { let suggestion_lines = suggestion.text.max_point(); let suggestion_start = suggestion.position.to_point(&self.fold_snapshot).0; let suggestion_end = suggestion_start + suggestion_lines; if row < suggestion_start.row { self.fold_snapshot.line_len(row) } else if row > suggestion_end.row { self.fold_snapshot.line_len(row - suggestion_lines.row) } else { let mut len = suggestion.text.line_len(row - suggestion_start.row); if row == suggestion_start.row { len += suggestion_start.column; } if row == suggestion_end.row { len += self.fold_snapshot.line_len(suggestion_start.row) - suggestion_start.column; } len } } else { self.fold_snapshot.line_len(row) } } pub fn chunks<'a>( &'a self, range: Range, language_aware: bool, text_highlights: Option<&'a TextHighlights>, ) -> Chunks<'a> { if let Some(suggestion) = self.suggestion.as_ref() { let suggestion_range = suggestion.position.0..suggestion.position.0 + suggestion.text.len(); let prefix_chunks = if range.start.0 < suggestion_range.start { Some(self.fold_snapshot.chunks( FoldOffset(range.start.0) ..cmp::min(FoldOffset(suggestion_range.start), FoldOffset(range.end.0)), language_aware, text_highlights, )) } else { None }; let clipped_suggestion_range = cmp::max(range.start.0, suggestion_range.start) ..cmp::min(range.end.0, suggestion_range.end); let suggestion_chunks = if clipped_suggestion_range.start < clipped_suggestion_range.end { let start = clipped_suggestion_range.start - suggestion_range.start; let end = clipped_suggestion_range.end - suggestion_range.start; Some(suggestion.text.chunks_in_range(start..end)) } else { None }; let suffix_chunks = if range.end.0 > suggestion_range.end { let start = cmp::max(suggestion_range.end, range.start.0) - suggestion_range.len(); let end = range.end.0 - suggestion_range.len(); Some(self.fold_snapshot.chunks( FoldOffset(start)..FoldOffset(end), language_aware, text_highlights, )) } else { None }; Chunks { prefix_chunks, suggestion_chunks, suffix_chunks, highlight_style: suggestion.highlight_style, } } else { Chunks { prefix_chunks: Some(self.fold_snapshot.chunks( FoldOffset(range.start.0)..FoldOffset(range.end.0), language_aware, text_highlights, )), suggestion_chunks: None, suffix_chunks: None, highlight_style: Default::default(), } } } pub fn buffer_rows<'a>(&'a self, row: u32) -> SuggestionBufferRows<'a> { let suggestion_range = if let Some(suggestion) = self.suggestion.as_ref() { let start = suggestion.position.to_point(&self.fold_snapshot).0; let end = start + suggestion.text.max_point(); start.row..end.row } else { u32::MAX..u32::MAX }; let fold_buffer_rows = if row <= suggestion_range.start { self.fold_snapshot.buffer_rows(row) } else if row > suggestion_range.end { self.fold_snapshot .buffer_rows(row - (suggestion_range.end - suggestion_range.start)) } else { let mut rows = self.fold_snapshot.buffer_rows(suggestion_range.start); rows.next(); rows }; SuggestionBufferRows { current_row: row, suggestion_row_start: suggestion_range.start, suggestion_row_end: suggestion_range.end, fold_buffer_rows, } } #[cfg(test)] pub fn text(&self) -> String { self.chunks(Default::default()..self.len(), false, None) .map(|chunk| chunk.text) .collect() } } pub struct Chunks<'a> { prefix_chunks: Option>, suggestion_chunks: Option>, suffix_chunks: Option>, highlight_style: HighlightStyle, } impl<'a> Iterator for Chunks<'a> { type Item = Chunk<'a>; fn next(&mut self) -> Option { if let Some(chunks) = self.prefix_chunks.as_mut() { if let Some(chunk) = chunks.next() { return Some(chunk); } else { self.prefix_chunks = None; } } if let Some(chunks) = self.suggestion_chunks.as_mut() { if let Some(chunk) = chunks.next() { return Some(Chunk { text: chunk, syntax_highlight_id: None, highlight_style: Some(self.highlight_style), diagnostic_severity: None, is_unnecessary: false, }); } else { self.suggestion_chunks = None; } } if let Some(chunks) = self.suffix_chunks.as_mut() { if let Some(chunk) = chunks.next() { return Some(chunk); } else { self.suffix_chunks = None; } } None } } pub struct SuggestionBufferRows<'a> { current_row: u32, suggestion_row_start: u32, suggestion_row_end: u32, fold_buffer_rows: FoldBufferRows<'a>, } impl<'a> Iterator for SuggestionBufferRows<'a> { type Item = Option; fn next(&mut self) -> Option { let row = post_inc(&mut self.current_row); if row <= self.suggestion_row_start || row > self.suggestion_row_end { self.fold_buffer_rows.next() } else { Some(None) } } } #[cfg(test)] mod tests { use super::*; use crate::{display_map::fold_map::FoldMap, MultiBuffer}; use gpui::MutableAppContext; use rand::{prelude::StdRng, Rng}; use settings::Settings; use std::{ env, ops::{Bound, RangeBounds}, }; #[gpui::test] fn test_basic(cx: &mut MutableAppContext) { let buffer = MultiBuffer::build_simple("abcdefghi", cx); let buffer_edits = buffer.update(cx, |buffer, _| buffer.subscribe()); let (mut fold_map, fold_snapshot) = FoldMap::new(buffer.read(cx).snapshot(cx)); let (suggestion_map, suggestion_snapshot) = SuggestionMap::new(fold_snapshot.clone()); assert_eq!(suggestion_snapshot.text(), "abcdefghi"); let (suggestion_snapshot, _) = suggestion_map.replace( Some(Suggestion { position: 3, text: "123\n456".into(), highlight_style: Default::default(), }), fold_snapshot, Default::default(), ); assert_eq!(suggestion_snapshot.text(), "abc123\n456defghi"); buffer.update(cx, |buffer, cx| { buffer.edit( [(0..0, "ABC"), (3..3, "DEF"), (4..4, "GHI"), (9..9, "JKL")], None, cx, ) }); let (fold_snapshot, fold_edits) = fold_map.read( buffer.read(cx).snapshot(cx), buffer_edits.consume().into_inner(), ); let (suggestion_snapshot, _) = suggestion_map.sync(fold_snapshot.clone(), fold_edits); assert_eq!(suggestion_snapshot.text(), "ABCabcDEF123\n456dGHIefghiJKL"); let (mut fold_map_writer, _, _) = fold_map.write(buffer.read(cx).snapshot(cx), Default::default()); let (fold_snapshot, fold_edits) = fold_map_writer.fold([0..3]); let (suggestion_snapshot, _) = suggestion_map.sync(fold_snapshot, fold_edits); assert_eq!(suggestion_snapshot.text(), "⋯abcDEF123\n456dGHIefghiJKL"); let (mut fold_map_writer, _, _) = fold_map.write(buffer.read(cx).snapshot(cx), Default::default()); let (fold_snapshot, fold_edits) = fold_map_writer.fold([6..10]); let (suggestion_snapshot, _) = suggestion_map.sync(fold_snapshot, fold_edits); assert_eq!(suggestion_snapshot.text(), "⋯abc⋯GHIefghiJKL"); } #[gpui::test(iterations = 100)] fn test_random_suggestions(cx: &mut MutableAppContext, mut rng: StdRng) { cx.set_global(Settings::test(cx)); let operations = env::var("OPERATIONS") .map(|i| i.parse().expect("invalid `OPERATIONS` variable")) .unwrap_or(10); let len = rng.gen_range(0..30); let buffer = if rng.gen() { let text = util::RandomCharIter::new(&mut rng) .take(len) .collect::(); MultiBuffer::build_simple(&text, cx) } else { MultiBuffer::build_random(&mut rng, cx) }; let mut buffer_snapshot = buffer.read(cx).snapshot(cx); log::info!("buffer text: {:?}", buffer_snapshot.text()); let (mut fold_map, mut fold_snapshot) = FoldMap::new(buffer_snapshot.clone()); let (suggestion_map, mut suggestion_snapshot) = SuggestionMap::new(fold_snapshot.clone()); for _ in 0..operations { let mut suggestion_edits = Patch::default(); let mut prev_suggestion_text = suggestion_snapshot.text(); let mut buffer_edits = Vec::new(); match rng.gen_range(0..=100) { 0..=29 => { let new_suggestion = if rng.gen_bool(0.3) { None } else { let index = rng.gen_range(0..=buffer_snapshot.len()); let len = rng.gen_range(0..30); Some(Suggestion { position: index, text: util::RandomCharIter::new(&mut rng) .take(len) .collect::() .as_str() .into(), highlight_style: Default::default(), }) }; log::info!("replacing suggestion with {:?}", new_suggestion); let (_, edits) = suggestion_map.replace(new_suggestion, fold_snapshot, Default::default()); suggestion_edits = suggestion_edits.compose(edits); } 30..=59 => { for (new_fold_snapshot, fold_edits) in fold_map.randomly_mutate(&mut rng) { fold_snapshot = new_fold_snapshot; let (_, edits) = suggestion_map.sync(fold_snapshot.clone(), fold_edits); suggestion_edits = suggestion_edits.compose(edits); } } _ => buffer.update(cx, |buffer, cx| { let subscription = buffer.subscribe(); let edit_count = rng.gen_range(1..=5); buffer.randomly_mutate(&mut rng, edit_count, cx); buffer_snapshot = buffer.snapshot(cx); let edits = subscription.consume().into_inner(); log::info!("editing {:?}", edits); buffer_edits.extend(edits); }), }; let (new_fold_snapshot, fold_edits) = fold_map.read(buffer_snapshot.clone(), buffer_edits); fold_snapshot = new_fold_snapshot; let (new_suggestion_snapshot, edits) = suggestion_map.sync(fold_snapshot.clone(), fold_edits); suggestion_snapshot = new_suggestion_snapshot; suggestion_edits = suggestion_edits.compose(edits); log::info!("buffer text: {:?}", buffer_snapshot.text()); log::info!("folds text: {:?}", fold_snapshot.text()); log::info!("suggestions text: {:?}", suggestion_snapshot.text()); let mut expected_text = Rope::from(fold_snapshot.text().as_str()); let mut expected_buffer_rows = fold_snapshot.buffer_rows(0).collect::>(); if let Some(suggestion) = suggestion_snapshot.suggestion.as_ref() { expected_text.replace( suggestion.position.0..suggestion.position.0, &suggestion.text.to_string(), ); let suggestion_start = suggestion.position.to_point(&fold_snapshot).0; let suggestion_end = suggestion_start + suggestion.text.max_point(); expected_buffer_rows.splice( (suggestion_start.row + 1) as usize..(suggestion_start.row + 1) as usize, (0..suggestion_end.row - suggestion_start.row).map(|_| None), ); } assert_eq!(suggestion_snapshot.text(), expected_text.to_string()); for row_start in 0..expected_buffer_rows.len() { assert_eq!( suggestion_snapshot .buffer_rows(row_start as u32) .collect::>(), &expected_buffer_rows[row_start..], "incorrect buffer rows starting at {}", row_start ); } for _ in 0..5 { let mut end = rng.gen_range(0..=suggestion_snapshot.len().0); end = expected_text.clip_offset(end, Bias::Right); let mut start = rng.gen_range(0..=end); start = expected_text.clip_offset(start, Bias::Right); let actual_text = suggestion_snapshot .chunks(SuggestionOffset(start)..SuggestionOffset(end), false, None) .map(|chunk| chunk.text) .collect::(); assert_eq!( actual_text, expected_text.slice(start..end).to_string(), "incorrect text in range {:?}", start..end ); } for edit in suggestion_edits.into_inner() { prev_suggestion_text.replace_range( edit.new.start.0..edit.new.start.0 + edit.old_len().0, &suggestion_snapshot.text()[edit.new.start.0..edit.new.end.0], ); } assert_eq!(prev_suggestion_text, suggestion_snapshot.text()); assert_eq!(expected_text.max_point(), suggestion_snapshot.max_point().0); assert_eq!(expected_text.len(), suggestion_snapshot.len().0); for row in 0..=suggestion_snapshot.max_point().row() { assert_eq!( suggestion_snapshot.line_len(row), expected_text.line_len(row), "incorrect line len for row {}", row ); } let mut suggestion_point = SuggestionPoint::default(); for ch in expected_text.chars() { let mut bytes = [0; 4]; for byte in ch.encode_utf8(&mut bytes).as_bytes() { if *byte == b'\n' { suggestion_point.0 += Point::new(1, 0); } else { suggestion_point.0 += Point::new(0, 1); } let clipped_left_point = suggestion_snapshot.clip_point(suggestion_point, Bias::Left); let clipped_right_point = suggestion_snapshot.clip_point(suggestion_point, Bias::Right); assert!( clipped_left_point <= clipped_right_point, "clipped left point {:?} is greater than clipped right point {:?}", clipped_left_point, clipped_right_point ); assert_eq!( clipped_left_point.0, expected_text.clip_point(clipped_left_point.0, Bias::Left) ); assert_eq!( clipped_right_point.0, expected_text.clip_point(clipped_right_point.0, Bias::Right) ); assert!(clipped_left_point <= suggestion_snapshot.max_point()); assert!(clipped_right_point <= suggestion_snapshot.max_point()); if let Some(suggestion) = suggestion_snapshot.suggestion.as_ref() { let suggestion_start = suggestion.position.to_point(&fold_snapshot).0; let suggestion_end = suggestion_start + suggestion.text.max_point(); let invalid_range = ( Bound::Excluded(suggestion_start), Bound::Included(suggestion_end), ); assert!( !invalid_range.contains(&clipped_left_point.0), "clipped left point {:?} is inside invalid suggestion range {:?}", clipped_left_point, invalid_range ); assert!( !invalid_range.contains(&clipped_right_point.0), "clipped right point {:?} is inside invalid suggestion range {:?}", clipped_right_point, invalid_range ); } } } } } }