ZIm/crates/editor/src/display_map/inlay_map.rs
2023-06-29 22:25:49 +03:00

1166 lines
44 KiB
Rust

#![allow(unused)]
// TODO kb
use std::{
cmp::{self, Reverse},
ops::{Add, AddAssign, Range, Sub},
sync::atomic::{self, AtomicUsize},
};
use crate::{Anchor, ExcerptId, InlayHintLocation, MultiBufferSnapshot, ToOffset, ToPoint};
use super::{
suggestion_map::{
SuggestionBufferRows, SuggestionChunks, SuggestionEdit, SuggestionOffset, SuggestionPoint,
SuggestionSnapshot,
},
TextHighlights,
};
use collections::{BTreeMap, HashMap, HashSet};
use gpui::fonts::HighlightStyle;
use language::{Chunk, Edit, Point, Rope, TextSummary};
use parking_lot::Mutex;
use project::InlayHint;
use rand::Rng;
use sum_tree::{Bias, Cursor, SumTree};
use text::Patch;
use util::post_inc;
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct InlayId(usize);
pub struct InlayMap {
snapshot: Mutex<InlaySnapshot>,
next_inlay_id: usize,
pub(super) inlays: HashMap<InlayId, Inlay>,
}
#[derive(Clone)]
pub struct InlaySnapshot {
// TODO kb merge these two together?
pub suggestion_snapshot: SuggestionSnapshot,
transforms: SumTree<Transform>,
pub version: usize,
}
#[derive(Clone, Debug)]
enum Transform {
Isomorphic(TextSummary),
Inlay(Inlay),
}
impl Transform {
fn is_inlay(&self) -> bool {
matches!(self, Self::Inlay(_))
}
}
impl sum_tree::Item for Transform {
type Summary = TransformSummary;
fn summary(&self) -> Self::Summary {
match self {
Transform::Isomorphic(summary) => TransformSummary {
input: summary.clone(),
output: summary.clone(),
},
Transform::Inlay(inlay) => TransformSummary {
input: TextSummary::default(),
output: inlay.properties.text.summary(),
},
}
}
}
#[derive(Clone, Debug, Default)]
struct TransformSummary {
input: TextSummary,
output: TextSummary,
}
impl sum_tree::Summary for TransformSummary {
type Context = ();
fn add_summary(&mut self, other: &Self, _: &()) {
self.input += &other.input;
self.output += &other.output;
}
}
pub type InlayEdit = Edit<InlayOffset>;
#[derive(Copy, Clone, Debug, Default, Eq, Ord, PartialOrd, PartialEq)]
pub struct InlayOffset(pub usize);
impl Add for InlayOffset {
type Output = Self;
fn add(self, rhs: Self) -> Self::Output {
Self(self.0 + rhs.0)
}
}
impl Sub for InlayOffset {
type Output = Self;
fn sub(self, rhs: Self) -> Self::Output {
Self(self.0 - rhs.0)
}
}
impl AddAssign for InlayOffset {
fn add_assign(&mut self, rhs: Self) {
self.0 += rhs.0;
}
}
impl<'a> sum_tree::Dimension<'a, TransformSummary> for InlayOffset {
fn add_summary(&mut self, summary: &'a TransformSummary, _: &()) {
self.0 += &summary.output.len;
}
}
impl<'a> sum_tree::Dimension<'a, TransformSummary> for SuggestionOffset {
fn add_summary(&mut self, summary: &'a TransformSummary, _: &()) {
self.0 += &summary.input.len;
}
}
#[derive(Copy, Clone, Debug, Default, Eq, Ord, PartialOrd, PartialEq)]
pub struct InlayPoint(pub Point);
impl<'a> sum_tree::Dimension<'a, TransformSummary> for InlayPoint {
fn add_summary(&mut self, summary: &'a TransformSummary, _: &()) {
self.0 += &summary.output.lines;
}
}
impl<'a> sum_tree::Dimension<'a, TransformSummary> for SuggestionPoint {
fn add_summary(&mut self, summary: &'a TransformSummary, _: &()) {
self.0 += &summary.input.lines;
}
}
#[derive(Clone)]
pub struct InlayBufferRows<'a> {
suggestion_rows: SuggestionBufferRows<'a>,
}
pub struct InlayChunks<'a> {
transforms: Cursor<'a, Transform, (InlayOffset, SuggestionOffset)>,
suggestion_chunks: SuggestionChunks<'a>,
suggestion_chunk: Option<Chunk<'a>>,
inlay_chunks: Option<text::Chunks<'a>>,
output_offset: InlayOffset,
max_output_offset: InlayOffset,
highlight_style: Option<HighlightStyle>,
}
#[derive(Debug, Clone)]
pub struct Inlay {
pub(super) id: InlayId,
pub(super) properties: InlayProperties,
}
#[derive(Debug, Clone)]
pub struct InlayProperties {
pub(super) position: Anchor,
pub(super) text: Rope,
}
impl<'a> Iterator for InlayChunks<'a> {
type Item = Chunk<'a>;
fn next(&mut self) -> Option<Self::Item> {
if self.output_offset == self.max_output_offset {
return None;
}
let chunk = match self.transforms.item()? {
Transform::Isomorphic(transform) => {
let chunk = self
.suggestion_chunk
.get_or_insert_with(|| self.suggestion_chunks.next().unwrap());
if chunk.text.is_empty() {
*chunk = self.suggestion_chunks.next().unwrap();
}
let (prefix, suffix) = chunk.text.split_at(cmp::min(
self.transforms.end(&()).0 .0 - self.output_offset.0,
chunk.text.len(),
));
chunk.text = suffix;
self.output_offset.0 += prefix.len();
Chunk {
text: prefix,
..chunk.clone()
}
}
Transform::Inlay(inlay) => {
let inlay_chunks = self.inlay_chunks.get_or_insert_with(|| {
let start = self.output_offset - self.transforms.start().0;
let end = cmp::min(self.max_output_offset, self.transforms.end(&()).0)
- self.transforms.start().0;
inlay.properties.text.chunks_in_range(start.0..end.0)
});
let chunk = inlay_chunks.next().unwrap();
self.output_offset.0 += chunk.len();
Chunk {
text: chunk,
highlight_style: self.highlight_style,
..Default::default()
}
}
};
if self.output_offset == self.transforms.end(&()).0 {
self.inlay_chunks = None;
self.transforms.next(&());
}
Some(chunk)
}
}
impl<'a> Iterator for InlayBufferRows<'a> {
type Item = Option<u32>;
fn next(&mut self) -> Option<Self::Item> {
self.suggestion_rows.next()
}
}
impl InlayPoint {
pub fn new(row: u32, column: u32) -> Self {
Self(Point::new(row, column))
}
pub fn row(self) -> u32 {
self.0.row
}
pub fn column(self) -> u32 {
self.0.column
}
}
impl InlayMap {
pub fn new(suggestion_snapshot: SuggestionSnapshot) -> (Self, InlaySnapshot) {
let snapshot = InlaySnapshot {
suggestion_snapshot: suggestion_snapshot.clone(),
version: 0,
transforms: SumTree::from_item(
Transform::Isomorphic(suggestion_snapshot.text_summary()),
&(),
),
};
(
Self {
snapshot: Mutex::new(snapshot.clone()),
next_inlay_id: 0,
inlays: HashMap::default(),
},
snapshot,
)
}
pub fn sync(
&mut self,
suggestion_snapshot: SuggestionSnapshot,
suggestion_edits: Vec<SuggestionEdit>,
) -> (InlaySnapshot, Vec<InlayEdit>) {
let mut snapshot = self.snapshot.lock();
let mut new_snapshot = snapshot.clone();
if new_snapshot.suggestion_snapshot.version != suggestion_snapshot.version {
new_snapshot.version += 1;
}
let mut inlay_edits = Patch::default();
new_snapshot.transforms = SumTree::new();
let mut cursor = snapshot
.transforms
.cursor::<(SuggestionOffset, InlayOffset)>();
let mut suggestion_edits_iter = suggestion_edits.iter().peekable();
while let Some(suggestion_edit) = suggestion_edits_iter.next() {
new_snapshot.transforms.push_tree(
cursor.slice(&suggestion_edit.old.start, Bias::Left, &()),
&(),
);
if let Some(Transform::Isomorphic(transform)) = cursor.item() {
if cursor.end(&()).0 == suggestion_edit.old.start {
new_snapshot
.transforms
.push(Transform::Isomorphic(transform.clone()), &());
cursor.next(&());
}
}
// Remove all the inlays and transforms contained by the edit.
let old_start =
cursor.start().1 + InlayOffset(suggestion_edit.old.start.0 - cursor.start().0 .0);
while suggestion_edit.old.end > cursor.end(&()).0 {
if let Some(Transform::Inlay(inlay)) = cursor.item() {
self.inlays.remove(&inlay.id);
}
cursor.next(&());
}
let old_end =
cursor.start().1 + InlayOffset(suggestion_edit.old.end.0 - cursor.start().0 .0);
// Push the unchanged prefix.
let prefix_start = SuggestionOffset(new_snapshot.transforms.summary().input.len);
let prefix_end = suggestion_edit.new.start;
push_isomorphic(
&mut new_snapshot.transforms,
suggestion_snapshot.text_summary_for_range(
suggestion_snapshot.to_point(prefix_start)
..suggestion_snapshot.to_point(prefix_end),
),
);
let new_start = InlayOffset(new_snapshot.transforms.summary().output.len);
let new_end = InlayOffset(
new_snapshot.transforms.summary().output.len + suggestion_edit.new_len().0,
);
inlay_edits.push(Edit {
old: old_start..old_end,
new: new_start..new_end,
});
// Apply the edit.
push_isomorphic(
&mut new_snapshot.transforms,
suggestion_snapshot.text_summary_for_range(
suggestion_snapshot.to_point(suggestion_edit.new.start)
..suggestion_snapshot.to_point(suggestion_edit.new.end),
),
);
// Push all the inlays starting at the end of the edit.
while let Some(Transform::Inlay(inlay)) = cursor.item() {
new_snapshot
.transforms
.push(Transform::Inlay(inlay.clone()), &());
cursor.next(&());
}
// If the next edit doesn't intersect the current isomorphic transform, then
// we can push its remainder.
if suggestion_edits_iter
.peek()
.map_or(true, |edit| edit.old.start >= cursor.end(&()).0)
{
let transform_start = SuggestionOffset(new_snapshot.transforms.summary().input.len);
let transform_end =
suggestion_edit.new.end + (cursor.end(&()).0 - suggestion_edit.old.end);
push_isomorphic(
&mut new_snapshot.transforms,
suggestion_snapshot.text_summary_for_range(
suggestion_snapshot.to_point(transform_start)
..suggestion_snapshot.to_point(transform_end),
),
);
cursor.next(&());
}
}
new_snapshot.transforms.push_tree(cursor.suffix(&()), &());
new_snapshot.suggestion_snapshot = suggestion_snapshot;
drop(cursor);
*snapshot = new_snapshot.clone();
snapshot.check_invariants();
(new_snapshot, inlay_edits.into_inner())
}
pub fn splice(
&mut self,
to_remove: HashSet<InlayId>,
to_insert: Vec<InlayProperties>,
) -> (InlaySnapshot, Vec<InlayEdit>, Vec<InlayId>) {
let mut snapshot = self.snapshot.lock();
let mut inlays = BTreeMap::new();
let mut new_ids = Vec::new();
for properties in to_insert {
let inlay = Inlay {
id: InlayId(post_inc(&mut self.next_inlay_id)),
properties,
};
self.inlays.insert(inlay.id, inlay.clone());
new_ids.push(inlay.id);
let buffer_point = inlay
.properties
.position
.to_point(snapshot.buffer_snapshot());
let fold_point = snapshot
.suggestion_snapshot
.fold_snapshot
.to_fold_point(buffer_point, Bias::Left);
let suggestion_point = snapshot.suggestion_snapshot.to_suggestion_point(fold_point);
inlays.insert((suggestion_point, Reverse(inlay.id)), Some(inlay));
}
for inlay_id in to_remove {
if let Some(inlay) = self.inlays.remove(&inlay_id) {
let buffer_point = inlay
.properties
.position
.to_point(snapshot.buffer_snapshot());
let fold_point = snapshot
.suggestion_snapshot
.fold_snapshot
.to_fold_point(buffer_point, Bias::Left);
let suggestion_point = snapshot.suggestion_snapshot.to_suggestion_point(fold_point);
inlays.insert((suggestion_point, Reverse(inlay.id)), None);
}
}
let mut inlay_edits = Patch::default();
let mut new_transforms = SumTree::new();
let mut cursor = snapshot
.transforms
.cursor::<(SuggestionPoint, (InlayOffset, InlayPoint))>();
let mut inlays = inlays.into_iter().peekable();
while let Some(((suggestion_point, inlay_id), inlay)) = inlays.next() {
new_transforms.push_tree(cursor.slice(&suggestion_point, Bias::Left, &()), &());
while let Some(transform) = cursor.item() {
match transform {
Transform::Isomorphic(_) => {
if suggestion_point >= cursor.end(&()).0 {
new_transforms.push(transform.clone(), &());
cursor.next(&());
} else {
break;
}
}
Transform::Inlay(inlay) => {
if inlay.id > inlay_id.0 {
new_transforms.push(transform.clone(), &());
cursor.next(&());
} else {
if inlay.id == inlay_id.0 {
let new_start = InlayOffset(new_transforms.summary().output.len);
inlay_edits.push(Edit {
old: cursor.start().1 .0..cursor.end(&()).1 .0,
new: new_start..new_start,
});
cursor.next(&());
}
break;
}
}
}
}
if let Some(inlay) = inlay {
let prefix_suggestion_start = SuggestionPoint(new_transforms.summary().input.lines);
push_isomorphic(
&mut new_transforms,
snapshot
.suggestion_snapshot
.text_summary_for_range(prefix_suggestion_start..suggestion_point),
);
let new_start = InlayOffset(new_transforms.summary().output.len);
let new_end = InlayOffset(new_start.0 + inlay.properties.text.len());
if let Some(Transform::Isomorphic(transform)) = cursor.item() {
let old_start = snapshot.to_offset(InlayPoint(
cursor.start().1 .1 .0 + (suggestion_point.0 - cursor.start().0 .0),
));
inlay_edits.push(Edit {
old: old_start..old_start,
new: new_start..new_end,
});
new_transforms.push(Transform::Inlay(inlay), &());
if inlays.peek().map_or(true, |((suggestion_point, _), _)| {
*suggestion_point >= cursor.end(&()).0
}) {
let suffix_suggestion_end = cursor.end(&()).0;
push_isomorphic(
&mut new_transforms,
snapshot
.suggestion_snapshot
.text_summary_for_range(suggestion_point..suffix_suggestion_end),
);
cursor.next(&());
}
} else {
let old_start = cursor.start().1 .0;
inlay_edits.push(Edit {
old: old_start..old_start,
new: new_start..new_end,
});
new_transforms.push(Transform::Inlay(inlay), &());
}
}
}
new_transforms.push_tree(cursor.suffix(&()), &());
drop(cursor);
snapshot.transforms = new_transforms;
snapshot.version += 1;
snapshot.check_invariants();
(snapshot.clone(), inlay_edits.into_inner(), new_ids)
}
#[cfg(test)]
pub fn randomly_mutate(
&mut self,
rng: &mut rand::rngs::StdRng,
) -> (InlaySnapshot, Vec<InlayEdit>, Vec<InlayId>) {
use rand::seq::IteratorRandom;
let mut to_remove = HashSet::default();
let mut to_insert = Vec::default();
let snapshot = self.snapshot.lock();
for _ in 0..rng.gen_range(1..=5) {
if self.inlays.is_empty() || rng.gen() {
let buffer_snapshot = snapshot.buffer_snapshot();
let position = buffer_snapshot.random_byte_range(0, rng).start;
let len = rng.gen_range(1..=5);
let text = util::RandomCharIter::new(&mut *rng)
.take(len)
.collect::<String>();
log::info!(
"creating inlay at buffer offset {} with text {:?}",
position,
text
);
to_insert.push(InlayProperties {
position: buffer_snapshot.anchor_after(position),
text: text.as_str().into(),
});
} else {
to_remove.insert(*self.inlays.keys().choose(rng).unwrap());
}
}
drop(snapshot);
self.splice(to_remove, to_insert)
}
}
impl InlaySnapshot {
pub fn buffer_snapshot(&self) -> &MultiBufferSnapshot {
self.suggestion_snapshot.buffer_snapshot()
}
pub fn to_point(&self, offset: InlayOffset) -> InlayPoint {
let mut cursor = self
.transforms
.cursor::<(InlayOffset, (InlayPoint, SuggestionOffset))>();
cursor.seek(&offset, Bias::Right, &());
let overshoot = offset.0 - cursor.start().0 .0;
match cursor.item() {
Some(Transform::Isomorphic(transform)) => {
let suggestion_offset_start = cursor.start().1 .1;
let suggestion_offset_end = SuggestionOffset(suggestion_offset_start.0 + overshoot);
let suggestion_start = self.suggestion_snapshot.to_point(suggestion_offset_start);
let suggestion_end = self.suggestion_snapshot.to_point(suggestion_offset_end);
InlayPoint(cursor.start().1 .0 .0 + (suggestion_end.0 - suggestion_start.0))
}
Some(Transform::Inlay(inlay)) => {
let overshoot = inlay.properties.text.offset_to_point(overshoot);
InlayPoint(cursor.start().1 .0 .0 + overshoot)
}
None => self.max_point(),
}
}
pub fn len(&self) -> InlayOffset {
InlayOffset(self.transforms.summary().output.len)
}
pub fn max_point(&self) -> InlayPoint {
InlayPoint(self.transforms.summary().output.lines)
}
pub fn to_offset(&self, point: InlayPoint) -> InlayOffset {
let mut cursor = self
.transforms
.cursor::<(InlayPoint, (InlayOffset, SuggestionPoint))>();
cursor.seek(&point, Bias::Right, &());
let overshoot = point.0 - cursor.start().0 .0;
match cursor.item() {
Some(Transform::Isomorphic(transform)) => {
let suggestion_point_start = cursor.start().1 .1;
let suggestion_point_end = SuggestionPoint(suggestion_point_start.0 + overshoot);
let suggestion_start = self.suggestion_snapshot.to_offset(suggestion_point_start);
let suggestion_end = self.suggestion_snapshot.to_offset(suggestion_point_end);
InlayOffset(cursor.start().1 .0 .0 + (suggestion_end.0 - suggestion_start.0))
}
Some(Transform::Inlay(inlay)) => {
let overshoot = inlay.properties.text.point_to_offset(overshoot);
InlayOffset(cursor.start().1 .0 .0 + overshoot)
}
None => self.len(),
}
}
pub fn chars_at(&self, start: InlayPoint) -> impl '_ + Iterator<Item = char> {
self.chunks(self.to_offset(start)..self.len(), false, None, None)
.flat_map(|chunk| chunk.text.chars())
}
pub fn to_suggestion_point(&self, point: InlayPoint) -> SuggestionPoint {
let mut cursor = self.transforms.cursor::<(InlayPoint, SuggestionPoint)>();
cursor.seek(&point, Bias::Right, &());
let overshoot = point.0 - cursor.start().0 .0;
match cursor.item() {
Some(Transform::Isomorphic(transform)) => {
SuggestionPoint(cursor.start().1 .0 + overshoot)
}
Some(Transform::Inlay(inlay)) => cursor.start().1,
None => self.suggestion_snapshot.max_point(),
}
}
pub fn to_suggestion_offset(&self, offset: InlayOffset) -> SuggestionOffset {
let mut cursor = self.transforms.cursor::<(InlayOffset, SuggestionOffset)>();
cursor.seek(&offset, Bias::Right, &());
match cursor.item() {
Some(Transform::Isomorphic(transform)) => {
let overshoot = offset - cursor.start().0;
cursor.start().1 + SuggestionOffset(overshoot.0)
}
Some(Transform::Inlay(inlay)) => cursor.start().1,
None => self.suggestion_snapshot.len(),
}
}
pub fn to_inlay_offset(&self, offset: SuggestionOffset) -> InlayOffset {
let mut cursor = self.transforms.cursor::<(SuggestionOffset, InlayOffset)>();
// TODO kb is the bias right? should we have an external one instead?
cursor.seek(&offset, Bias::Right, &());
let overshoot = offset.0 - cursor.start().0 .0;
match cursor.item() {
Some(Transform::Isomorphic(transform)) => InlayOffset(cursor.start().1 .0 + overshoot),
Some(Transform::Inlay(inlay)) => cursor.start().1,
None => self.len(),
}
}
pub fn to_inlay_point(&self, point: SuggestionPoint) -> InlayPoint {
let mut cursor = self.transforms.cursor::<(SuggestionPoint, InlayPoint)>();
// TODO kb is the bias right? should we have an external one instead?
cursor.seek(&point, Bias::Right, &());
let overshoot = point.0 - cursor.start().0 .0;
match cursor.item() {
Some(Transform::Isomorphic(transform)) => InlayPoint(cursor.start().1 .0 + overshoot),
Some(Transform::Inlay(inlay)) => cursor.start().1,
None => self.max_point(),
}
}
// TODO kb clippig is funky, does not allow to get to left
pub fn clip_point(&self, point: InlayPoint, bias: Bias) -> InlayPoint {
let mut cursor = self.transforms.cursor::<(InlayPoint, SuggestionPoint)>();
cursor.seek(&point, bias, &());
match cursor.item() {
Some(Transform::Isomorphic(_)) => {
let overshoot = point.0 - cursor.start().0 .0;
let suggestion_point = SuggestionPoint(cursor.start().1 .0 + overshoot);
let clipped_suggestion_point =
self.suggestion_snapshot.clip_point(suggestion_point, bias);
let clipped_overshoot = clipped_suggestion_point.0 - cursor.start().1 .0;
return InlayPoint(cursor.start().0 .0 + clipped_overshoot);
}
Some(Transform::Inlay(_)) => {}
None => return self.max_point(),
}
while cursor
.item()
.map_or(false, |transform| transform.is_inlay())
{
match bias {
Bias::Left => cursor.prev(&()),
Bias::Right => cursor.next(&()),
}
}
match bias {
Bias::Left => cursor.end(&()).0,
Bias::Right => cursor.start().0,
}
}
pub fn text_summary_for_range(&self, range: Range<InlayPoint>) -> TextSummary {
let mut summary = TextSummary::default();
let mut cursor = self.transforms.cursor::<(InlayPoint, SuggestionPoint)>();
cursor.seek(&range.start, Bias::Right, &());
let overshoot = range.start.0 - cursor.start().0 .0;
match cursor.item() {
Some(Transform::Isomorphic(transform)) => {
let suggestion_start = cursor.start().1 .0;
let suffix_start = SuggestionPoint(suggestion_start + overshoot);
let suffix_end = SuggestionPoint(
suggestion_start
+ (cmp::min(cursor.end(&()).0, range.end).0 - cursor.start().0 .0),
);
summary = self
.suggestion_snapshot
.text_summary_for_range(suffix_start..suffix_end);
cursor.next(&());
}
Some(Transform::Inlay(inlay)) => {
let text = &inlay.properties.text;
let suffix_start = text.point_to_offset(overshoot);
let suffix_end = text.point_to_offset(
cmp::min(cursor.end(&()).0, range.end).0 - cursor.start().0 .0,
);
summary = text.cursor(suffix_start).summary(suffix_end);
cursor.next(&());
}
None => {}
}
if range.end > cursor.start().0 {
summary += cursor
.summary::<_, TransformSummary>(&range.end, Bias::Right, &())
.output;
let overshoot = range.end.0 - cursor.start().0 .0;
match cursor.item() {
Some(Transform::Isomorphic(transform)) => {
let prefix_start = cursor.start().1;
let prefix_end = SuggestionPoint(prefix_start.0 + overshoot);
summary += self
.suggestion_snapshot
.text_summary_for_range(prefix_start..prefix_end);
}
Some(Transform::Inlay(inlay)) => {
let text = &inlay.properties.text;
let prefix_end = text.point_to_offset(overshoot);
summary += text.cursor(0).summary::<TextSummary>(prefix_end);
}
None => {}
}
}
summary
}
// TODO kb copied from suggestion_snapshot
pub fn buffer_rows<'a>(&'a self, row: u32) -> InlayBufferRows<'a> {
InlayBufferRows {
suggestion_rows: self.suggestion_snapshot.buffer_rows(row),
}
}
pub fn line_len(&self, row: u32) -> u32 {
let line_start = self.to_offset(InlayPoint::new(row, 0)).0;
let line_end = if row >= self.max_point().row() {
self.len().0
} else {
self.to_offset(InlayPoint::new(row + 1, 0)).0 - 1
};
(line_end - line_start) as u32
}
pub fn chunks<'a>(
&'a self,
range: Range<InlayOffset>,
language_aware: bool,
text_highlights: Option<&'a TextHighlights>,
suggestion_highlight: Option<HighlightStyle>,
) -> InlayChunks<'a> {
let mut cursor = self.transforms.cursor::<(InlayOffset, SuggestionOffset)>();
cursor.seek(&range.start, Bias::Right, &());
let suggestion_range =
self.to_suggestion_offset(range.start)..self.to_suggestion_offset(range.end);
let suggestion_chunks = self.suggestion_snapshot.chunks(
suggestion_range,
language_aware,
text_highlights,
suggestion_highlight,
);
InlayChunks {
transforms: cursor,
suggestion_chunks,
inlay_chunks: None,
suggestion_chunk: None,
output_offset: range.start,
max_output_offset: range.end,
highlight_style: suggestion_highlight,
}
}
#[cfg(test)]
pub fn text(&self) -> String {
self.chunks(Default::default()..self.len(), false, None, None)
.map(|chunk| chunk.text)
.collect()
}
fn check_invariants(&self) {
#[cfg(any(debug_assertions, feature = "test-support"))]
{
assert_eq!(
self.transforms.summary().input,
self.suggestion_snapshot.text_summary()
);
}
}
}
fn push_isomorphic(sum_tree: &mut SumTree<Transform>, summary: TextSummary) {
if summary.len == 0 {
return;
}
let mut summary = Some(summary);
sum_tree.update_last(
|transform| {
if let Transform::Isomorphic(transform) = transform {
*transform += summary.take().unwrap();
}
},
&(),
);
if let Some(summary) = summary {
sum_tree.push(Transform::Isomorphic(summary), &());
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::{
display_map::{fold_map::FoldMap, suggestion_map::SuggestionMap},
MultiBuffer,
};
use gpui::AppContext;
use rand::prelude::*;
use settings::SettingsStore;
use std::env;
use text::Patch;
#[gpui::test]
fn test_basic_inlays(cx: &mut AppContext) {
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());
let (mut inlay_map, inlay_snapshot) = InlayMap::new(suggestion_snapshot.clone());
assert_eq!(inlay_snapshot.text(), "abcdefghi");
let (inlay_snapshot, _, inlay_ids) = inlay_map.splice(
HashSet::default(),
vec![InlayProperties {
position: buffer.read(cx).read(cx).anchor_before(3),
text: "|123|".into(),
}],
);
assert_eq!(inlay_snapshot.text(), "abc|123|defghi");
assert_eq!(
inlay_snapshot.to_inlay_point(SuggestionPoint::new(0, 0)),
InlayPoint::new(0, 0)
);
assert_eq!(
inlay_snapshot.to_inlay_point(SuggestionPoint::new(0, 1)),
InlayPoint::new(0, 1)
);
assert_eq!(
inlay_snapshot.to_inlay_point(SuggestionPoint::new(0, 2)),
InlayPoint::new(0, 2)
);
assert_eq!(
inlay_snapshot.to_inlay_point(SuggestionPoint::new(0, 3)),
InlayPoint::new(0, 8)
);
assert_eq!(
inlay_snapshot.to_inlay_point(SuggestionPoint::new(0, 4)),
InlayPoint::new(0, 9)
);
assert_eq!(
inlay_snapshot.to_inlay_point(SuggestionPoint::new(0, 5)),
InlayPoint::new(0, 10)
);
assert_eq!(
inlay_snapshot.clip_point(InlayPoint::new(0, 0), Bias::Left),
InlayPoint::new(0, 0)
);
assert_eq!(
inlay_snapshot.clip_point(InlayPoint::new(0, 0), Bias::Right),
InlayPoint::new(0, 0)
);
assert_eq!(
inlay_snapshot.clip_point(InlayPoint::new(0, 3), Bias::Left),
InlayPoint::new(0, 3)
);
assert_eq!(
inlay_snapshot.clip_point(InlayPoint::new(0, 3), Bias::Right),
InlayPoint::new(0, 8)
);
assert_eq!(
inlay_snapshot.clip_point(InlayPoint::new(0, 4), Bias::Left),
InlayPoint::new(0, 3)
);
assert_eq!(
inlay_snapshot.clip_point(InlayPoint::new(0, 4), Bias::Right),
InlayPoint::new(0, 8)
);
assert_eq!(
inlay_snapshot.clip_point(InlayPoint::new(0, 9), Bias::Left),
InlayPoint::new(0, 9)
);
assert_eq!(
inlay_snapshot.clip_point(InlayPoint::new(0, 9), Bias::Right),
InlayPoint::new(0, 9)
);
buffer.update(cx, |buffer, cx| buffer.edit([(0..0, "XYZ")], None, cx));
let (fold_snapshot, fold_edits) = fold_map.read(
buffer.read(cx).snapshot(cx),
buffer_edits.consume().into_inner(),
);
let (suggestion_snapshot, suggestion_edits) =
suggestion_map.sync(fold_snapshot.clone(), fold_edits);
let (inlay_snapshot, _) = inlay_map.sync(suggestion_snapshot.clone(), suggestion_edits);
assert_eq!(inlay_snapshot.text(), "XYZabc|123|defghi");
//////// case: folding and unfolding the text should hine and then return the hint back
let (mut fold_map_writer, _, _) = fold_map.write(
buffer.read(cx).snapshot(cx),
buffer_edits.consume().into_inner(),
);
let (fold_snapshot, fold_edits) = fold_map_writer.fold([4..8]);
let (suggestion_snapshot, suggestion_edits) =
suggestion_map.sync(fold_snapshot.clone(), fold_edits);
let (inlay_snapshot, _) = inlay_map.sync(suggestion_snapshot.clone(), suggestion_edits);
assert_eq!(inlay_snapshot.text(), "XYZa⋯fghi");
let (fold_snapshot, fold_edits) = fold_map_writer.unfold([4..8], false);
let (suggestion_snapshot, suggestion_edits) =
suggestion_map.sync(fold_snapshot.clone(), fold_edits);
let (inlay_snapshot, _) = inlay_map.sync(suggestion_snapshot.clone(), suggestion_edits);
assert_eq!(inlay_snapshot.text(), "XYZabc|123|defghi");
////////// case: replacing the anchor that got the hint: it should disappear
buffer.update(cx, |buffer, cx| buffer.edit([(2..3, "C")], None, cx));
let (fold_snapshot, fold_edits) = fold_map.read(
buffer.read(cx).snapshot(cx),
buffer_edits.consume().into_inner(),
);
let (suggestion_snapshot, suggestion_edits) =
suggestion_map.sync(fold_snapshot.clone(), fold_edits);
let (inlay_snapshot, _) = inlay_map.sync(suggestion_snapshot.clone(), suggestion_edits);
assert_eq!(inlay_snapshot.text(), "XYZabCdefghi");
}
#[gpui::test(iterations = 100)]
fn test_random_inlays(cx: &mut AppContext, mut rng: StdRng) {
init_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::<String>();
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());
let (mut inlay_map, mut inlay_snapshot) = InlayMap::new(suggestion_snapshot.clone());
for _ in 0..operations {
let mut suggestion_edits = Patch::default();
let mut inlay_edits = Patch::default();
let mut prev_inlay_text = inlay_snapshot.text();
let mut buffer_edits = Vec::new();
match rng.gen_range(0..=100) {
0..=29 => {
let (snapshot, edits, _) = inlay_map.randomly_mutate(&mut rng);
inlay_snapshot = snapshot;
inlay_edits = Patch::new(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, new_suggestion_edits) =
suggestion_map.sync(fold_snapshot.clone(), fold_edits);
suggestion_snapshot = new_suggestion_snapshot;
suggestion_edits = suggestion_edits.compose(new_suggestion_edits);
let (new_inlay_snapshot, new_inlay_edits) =
inlay_map.sync(suggestion_snapshot.clone(), suggestion_edits.into_inner());
inlay_snapshot = new_inlay_snapshot;
inlay_edits = inlay_edits.compose(new_inlay_edits);
log::info!("buffer text: {:?}", buffer_snapshot.text());
log::info!("folds text: {:?}", fold_snapshot.text());
log::info!("suggestions text: {:?}", suggestion_snapshot.text());
log::info!("inlay text: {:?}", inlay_snapshot.text());
let mut inlays = inlay_map
.inlays
.values()
.map(|inlay| {
let buffer_point = inlay.properties.position.to_point(&buffer_snapshot);
let fold_point = fold_snapshot.to_fold_point(buffer_point, Bias::Left);
let suggestion_point = suggestion_snapshot.to_suggestion_point(fold_point);
let suggestion_offset = suggestion_snapshot.to_offset(suggestion_point);
(suggestion_offset, inlay.clone())
})
.collect::<Vec<_>>();
inlays.sort_by_key(|(offset, inlay)| (*offset, Reverse(inlay.id)));
let mut expected_text = Rope::from(suggestion_snapshot.text().as_str());
for (offset, inlay) in inlays.into_iter().rev() {
expected_text.replace(offset.0..offset.0, &inlay.properties.text.to_string());
}
assert_eq!(inlay_snapshot.text(), expected_text.to_string());
// TODO kb !!!
// let mut expected_buffer_rows = suggestion_snapshot.buffer_rows(0).collect::<Vec<_>>();
// for row_start in 0..expected_buffer_rows.len() {
// assert_eq!(
// inlay_snapshot
// .buffer_rows(row_start as u32)
// .collect::<Vec<_>>(),
// &expected_buffer_rows[row_start..],
// "incorrect buffer rows starting at {}",
// row_start
// );
// }
for _ in 0..5 {
let mut end = rng.gen_range(0..=inlay_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 = inlay_snapshot
.chunks(InlayOffset(start)..InlayOffset(end), false, None, None)
.map(|chunk| chunk.text)
.collect::<String>();
assert_eq!(
actual_text,
expected_text.slice(start..end).to_string(),
"incorrect text in range {:?}",
start..end
);
let start_point = InlayPoint(expected_text.offset_to_point(start));
let end_point = InlayPoint(expected_text.offset_to_point(end));
assert_eq!(
inlay_snapshot.text_summary_for_range(start_point..end_point),
expected_text.slice(start..end).summary()
);
}
for edit in inlay_edits {
prev_inlay_text.replace_range(
edit.new.start.0..edit.new.start.0 + edit.old_len().0,
&inlay_snapshot.text()[edit.new.start.0..edit.new.end.0],
);
}
assert_eq!(prev_inlay_text, inlay_snapshot.text());
assert_eq!(expected_text.max_point(), inlay_snapshot.max_point().0);
assert_eq!(expected_text.len(), inlay_snapshot.len().0);
continue; // TODO kb fix the rest of the test
let mut inlay_point = InlayPoint::default();
let mut inlay_offset = InlayOffset::default();
for ch in expected_text.chars() {
assert_eq!(
inlay_snapshot.to_offset(inlay_point),
inlay_offset,
"invalid to_offset({:?})",
inlay_point
);
assert_eq!(
inlay_snapshot.to_point(inlay_offset),
inlay_point,
"invalid to_point({:?})",
inlay_offset
);
assert_eq!(
inlay_snapshot.to_inlay_point(inlay_snapshot.to_suggestion_point(inlay_point)),
inlay_snapshot.clip_point(inlay_point, Bias::Right),
"to_suggestion_point({:?}) = {:?}",
inlay_point,
inlay_snapshot.to_suggestion_point(inlay_point),
);
let mut bytes = [0; 4];
for byte in ch.encode_utf8(&mut bytes).as_bytes() {
inlay_offset.0 += 1;
if *byte == b'\n' {
inlay_point.0 += Point::new(1, 0);
} else {
inlay_point.0 += Point::new(0, 1);
}
let clipped_left_point = inlay_snapshot.clip_point(inlay_point, Bias::Left);
let clipped_right_point = inlay_snapshot.clip_point(inlay_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 <= inlay_snapshot.max_point());
assert!(clipped_right_point <= inlay_snapshot.max_point());
}
}
}
}
fn init_test(cx: &mut AppContext) {
cx.set_global(SettingsStore::test(cx));
theme::init((), cx);
}
}