use std::{ cell::Ref, cmp, iter, mem, ops::{Deref, DerefMut, Range, Sub}, sync::Arc, }; use collections::HashMap; use gpui::{App, Entity, Pixels}; use itertools::Itertools; use language::{Bias, Point, Selection, SelectionGoal, TextDimension}; use util::post_inc; use crate::{ Anchor, DisplayPoint, DisplayRow, ExcerptId, MultiBuffer, MultiBufferSnapshot, SelectMode, ToOffset, ToPoint, display_map::{DisplayMap, DisplaySnapshot, ToDisplayPoint}, movement::TextLayoutDetails, }; #[derive(Debug, Clone)] pub struct PendingSelection { pub selection: Selection, pub mode: SelectMode, } #[derive(Debug, Clone)] pub struct SelectionsCollection { display_map: Entity, buffer: Entity, pub next_selection_id: usize, pub line_mode: bool, /// The non-pending, non-overlapping selections. /// The [SelectionsCollection::pending] selection could possibly overlap these pub disjoint: Arc<[Selection]>, /// A pending selection, such as when the mouse is being dragged pub pending: Option, } impl SelectionsCollection { pub fn new(display_map: Entity, buffer: Entity) -> Self { Self { display_map, buffer, next_selection_id: 1, line_mode: false, disjoint: Arc::default(), pending: Some(PendingSelection { selection: Selection { id: 0, start: Anchor::min(), end: Anchor::min(), reversed: false, goal: SelectionGoal::None, }, mode: SelectMode::Character, }), } } pub fn display_map(&self, cx: &mut App) -> DisplaySnapshot { self.display_map.update(cx, |map, cx| map.snapshot(cx)) } fn buffer<'a>(&self, cx: &'a App) -> Ref<'a, MultiBufferSnapshot> { self.buffer.read(cx).read(cx) } pub fn clone_state(&mut self, other: &SelectionsCollection) { self.next_selection_id = other.next_selection_id; self.line_mode = other.line_mode; self.disjoint = other.disjoint.clone(); self.pending.clone_from(&other.pending); } pub fn count(&self) -> usize { let mut count = self.disjoint.len(); if self.pending.is_some() { count += 1; } count } /// The non-pending, non-overlapping selections. There could be a pending selection that /// overlaps these if the mouse is being dragged, etc. This could also be empty if there is a /// pending selection. Returned as selections over Anchors. pub fn disjoint_anchors(&self) -> Arc<[Selection]> { self.disjoint.clone() } pub fn disjoint_anchor_ranges(&self) -> impl Iterator> { // Mapping the Arc slice would borrow it, whereas indexing captures it. let disjoint = self.disjoint_anchors(); (0..disjoint.len()).map(move |ix| disjoint[ix].range()) } /// Non-overlapping selections using anchors, including the pending selection. pub fn all_anchors(&self, cx: &mut App) -> Arc<[Selection]> { if self.pending.is_none() { self.disjoint_anchors() } else { let all_offset_selections = self.all::(cx); let buffer = self.buffer(cx); all_offset_selections .into_iter() .map(|selection| selection_to_anchor_selection(selection, &buffer)) .collect() } } pub fn pending_anchor(&self) -> Option> { self.pending .as_ref() .map(|pending| pending.selection.clone()) } pub fn pending>( &self, cx: &mut App, ) -> Option> { let map = self.display_map(cx); resolve_selections(self.pending_anchor().as_ref(), &map).next() } pub(crate) fn pending_mode(&self) -> Option { self.pending.as_ref().map(|pending| pending.mode.clone()) } pub fn all<'a, D>(&self, cx: &mut App) -> Vec> where D: 'a + TextDimension + Ord + Sub, { let map = self.display_map(cx); let disjoint_anchors = &self.disjoint; let mut disjoint = resolve_selections::(disjoint_anchors.iter(), &map).peekable(); let mut pending_opt = self.pending::(cx); iter::from_fn(move || { if let Some(pending) = pending_opt.as_mut() { while let Some(next_selection) = disjoint.peek() { if pending.start <= next_selection.end && pending.end >= next_selection.start { let next_selection = disjoint.next().unwrap(); if next_selection.start < pending.start { pending.start = next_selection.start; } if next_selection.end > pending.end { pending.end = next_selection.end; } } else if next_selection.end < pending.start { return disjoint.next(); } else { break; } } pending_opt.take() } else { disjoint.next() } }) .collect() } /// Returns all of the selections, adjusted to take into account the selection line_mode pub fn all_adjusted(&self, cx: &mut App) -> Vec> { let mut selections = self.all::(cx); if self.line_mode { let map = self.display_map(cx); for selection in &mut selections { let new_range = map.expand_to_line(selection.range()); selection.start = new_range.start; selection.end = new_range.end; } } selections } /// Returns the newest selection, adjusted to take into account the selection line_mode pub fn newest_adjusted(&self, cx: &mut App) -> Selection { let mut selection = self.newest::(cx); if self.line_mode { let map = self.display_map(cx); let new_range = map.expand_to_line(selection.range()); selection.start = new_range.start; selection.end = new_range.end; } selection } pub fn all_adjusted_display( &self, cx: &mut App, ) -> (DisplaySnapshot, Vec>) { if self.line_mode { let selections = self.all::(cx); let map = self.display_map(cx); let result = selections .into_iter() .map(|mut selection| { let new_range = map.expand_to_line(selection.range()); selection.start = new_range.start; selection.end = new_range.end; selection.map(|point| point.to_display_point(&map)) }) .collect(); (map, result) } else { self.all_display(cx) } } pub fn disjoint_in_range<'a, D>(&self, range: Range, cx: &mut App) -> Vec> where D: 'a + TextDimension + Ord + Sub + std::fmt::Debug, { let map = self.display_map(cx); let start_ix = match self .disjoint .binary_search_by(|probe| probe.end.cmp(&range.start, &map.buffer_snapshot)) { Ok(ix) | Err(ix) => ix, }; let end_ix = match self .disjoint .binary_search_by(|probe| probe.start.cmp(&range.end, &map.buffer_snapshot)) { Ok(ix) => ix + 1, Err(ix) => ix, }; resolve_selections(&self.disjoint[start_ix..end_ix], &map).collect() } pub fn all_display(&self, cx: &mut App) -> (DisplaySnapshot, Vec>) { let map = self.display_map(cx); let disjoint_anchors = &self.disjoint; let mut disjoint = resolve_selections_display(disjoint_anchors.iter(), &map).peekable(); let mut pending_opt = resolve_selections_display(self.pending_anchor().as_ref(), &map).next(); let selections = iter::from_fn(move || { if let Some(pending) = pending_opt.as_mut() { while let Some(next_selection) = disjoint.peek() { if pending.start <= next_selection.end && pending.end >= next_selection.start { let next_selection = disjoint.next().unwrap(); if next_selection.start < pending.start { pending.start = next_selection.start; } if next_selection.end > pending.end { pending.end = next_selection.end; } } else if next_selection.end < pending.start { return disjoint.next(); } else { break; } } pending_opt.take() } else { disjoint.next() } }) .collect(); (map, selections) } pub fn newest_anchor(&self) -> &Selection { self.pending .as_ref() .map(|s| &s.selection) .or_else(|| self.disjoint.iter().max_by_key(|s| s.id)) .unwrap() } pub fn newest>( &self, cx: &mut App, ) -> Selection { let map = self.display_map(cx); resolve_selections([self.newest_anchor()], &map) .next() .unwrap() } pub fn newest_display(&self, cx: &mut App) -> Selection { let map = self.display_map(cx); resolve_selections_display([self.newest_anchor()], &map) .next() .unwrap() } pub fn oldest_anchor(&self) -> &Selection { self.disjoint .iter() .min_by_key(|s| s.id) .or_else(|| self.pending.as_ref().map(|p| &p.selection)) .unwrap() } pub fn oldest>( &self, cx: &mut App, ) -> Selection { let map = self.display_map(cx); resolve_selections([self.oldest_anchor()], &map) .next() .unwrap() } pub fn first_anchor(&self) -> Selection { self.pending .as_ref() .map(|pending| pending.selection.clone()) .unwrap_or_else(|| self.disjoint.first().cloned().unwrap()) } pub fn first>(&self, cx: &mut App) -> Selection { self.all(cx).first().unwrap().clone() } pub fn last>(&self, cx: &mut App) -> Selection { self.all(cx).last().unwrap().clone() } pub fn ranges>( &self, cx: &mut App, ) -> Vec> { self.all::(cx) .iter() .map(|s| { if s.reversed { s.end..s.start } else { s.start..s.end } }) .collect() } #[cfg(any(test, feature = "test-support"))] pub fn display_ranges(&self, cx: &mut App) -> Vec> { let display_map = self.display_map(cx); self.disjoint_anchors() .iter() .chain(self.pending_anchor().as_ref()) .map(|s| { if s.reversed { s.end.to_display_point(&display_map)..s.start.to_display_point(&display_map) } else { s.start.to_display_point(&display_map)..s.end.to_display_point(&display_map) } }) .collect() } pub fn build_columnar_selection( &mut self, display_map: &DisplaySnapshot, row: DisplayRow, positions: &Range, reversed: bool, text_layout_details: &TextLayoutDetails, ) -> Option> { let is_empty = positions.start == positions.end; let line_len = display_map.line_len(row); let line = display_map.layout_row(row, text_layout_details); let start_col = line.closest_index_for_x(positions.start) as u32; let (start, end) = if is_empty { let point = DisplayPoint::new(row, std::cmp::min(start_col, line_len)); (point, point) } else { if start_col >= line_len { return None; } let start = DisplayPoint::new(row, start_col); let end_col = line.closest_index_for_x(positions.end) as u32; let end = DisplayPoint::new(row, end_col); (start, end) }; Some(Selection { id: post_inc(&mut self.next_selection_id), start: start.to_point(display_map), end: end.to_point(display_map), reversed, goal: SelectionGoal::HorizontalRange { start: positions.start.into(), end: positions.end.into(), }, }) } pub fn change_with( &mut self, cx: &mut App, change: impl FnOnce(&mut MutableSelectionsCollection) -> R, ) -> (bool, R) { let mut mutable_collection = MutableSelectionsCollection { collection: self, selections_changed: false, cx, }; let result = change(&mut mutable_collection); assert!( !mutable_collection.disjoint.is_empty() || mutable_collection.pending.is_some(), "There must be at least one selection" ); (mutable_collection.selections_changed, result) } } pub struct MutableSelectionsCollection<'a> { collection: &'a mut SelectionsCollection, selections_changed: bool, cx: &'a mut App, } impl<'a> MutableSelectionsCollection<'a> { pub fn display_map(&mut self) -> DisplaySnapshot { self.collection.display_map(self.cx) } pub fn buffer(&self) -> Ref<'_, MultiBufferSnapshot> { self.collection.buffer(self.cx) } pub fn clear_disjoint(&mut self) { self.collection.disjoint = Arc::default(); } pub fn delete(&mut self, selection_id: usize) { let mut changed = false; self.collection.disjoint = self .disjoint .iter() .filter(|selection| { let found = selection.id == selection_id; changed |= found; !found }) .cloned() .collect(); self.selections_changed |= changed; } pub fn clear_pending(&mut self) { if self.collection.pending.is_some() { self.collection.pending = None; self.selections_changed = true; } } pub(crate) fn set_pending_anchor_range(&mut self, range: Range, mode: SelectMode) { self.collection.pending = Some(PendingSelection { selection: Selection { id: post_inc(&mut self.collection.next_selection_id), start: range.start, end: range.end, reversed: false, goal: SelectionGoal::None, }, mode, }); self.selections_changed = true; } pub(crate) fn set_pending(&mut self, selection: Selection, mode: SelectMode) { self.collection.pending = Some(PendingSelection { selection, mode }); self.selections_changed = true; } pub fn try_cancel(&mut self) -> bool { if let Some(pending) = self.collection.pending.take() { if self.disjoint.is_empty() { self.collection.disjoint = Arc::from([pending.selection]); } self.selections_changed = true; return true; } let mut oldest = self.oldest_anchor().clone(); if self.count() > 1 { self.collection.disjoint = Arc::from([oldest]); self.selections_changed = true; return true; } if !oldest.start.cmp(&oldest.end, &self.buffer()).is_eq() { let head = oldest.head(); oldest.start = head; oldest.end = head; self.collection.disjoint = Arc::from([oldest]); self.selections_changed = true; return true; } false } pub fn insert_range(&mut self, range: Range) where T: 'a + ToOffset + ToPoint + TextDimension + Ord + Sub + std::marker::Copy, { let mut selections = self.collection.all(self.cx); let mut start = range.start.to_offset(&self.buffer()); let mut end = range.end.to_offset(&self.buffer()); let reversed = if start > end { mem::swap(&mut start, &mut end); true } else { false }; selections.push(Selection { id: post_inc(&mut self.collection.next_selection_id), start, end, reversed, goal: SelectionGoal::None, }); self.select(selections); } pub fn select(&mut self, mut selections: Vec>) where T: ToOffset + ToPoint + Ord + std::marker::Copy + std::fmt::Debug, { let buffer = self.buffer.read(self.cx).snapshot(self.cx); selections.sort_unstable_by_key(|s| s.start); // Merge overlapping selections. let mut i = 1; while i < selections.len() { if selections[i - 1].end >= selections[i].start { let removed = selections.remove(i); if removed.start < selections[i - 1].start { selections[i - 1].start = removed.start; } if removed.end > selections[i - 1].end { selections[i - 1].end = removed.end; } } else { i += 1; } } self.collection.disjoint = Arc::from_iter( selections .into_iter() .map(|selection| selection_to_anchor_selection(selection, &buffer)), ); self.collection.pending = None; self.selections_changed = true; } pub fn select_anchors(&mut self, selections: Vec>) { let map = self.display_map(); let resolved_selections = resolve_selections::(&selections, &map).collect::>(); self.select(resolved_selections); } pub fn select_ranges(&mut self, ranges: I) where I: IntoIterator>, T: ToOffset, { let buffer = self.buffer.read(self.cx).snapshot(self.cx); let ranges = ranges .into_iter() .map(|range| range.start.to_offset(&buffer)..range.end.to_offset(&buffer)); self.select_offset_ranges(ranges); } fn select_offset_ranges(&mut self, ranges: I) where I: IntoIterator>, { let selections = ranges .into_iter() .map(|range| { let mut start = range.start; let mut end = range.end; let reversed = if start > end { mem::swap(&mut start, &mut end); true } else { false }; Selection { id: post_inc(&mut self.collection.next_selection_id), start, end, reversed, goal: SelectionGoal::None, } }) .collect::>(); self.select(selections) } pub fn select_anchor_ranges(&mut self, ranges: I) where I: IntoIterator>, { let buffer = self.buffer.read(self.cx).snapshot(self.cx); let selections = ranges .into_iter() .map(|range| { let mut start = range.start; let mut end = range.end; let reversed = if start.cmp(&end, &buffer).is_gt() { mem::swap(&mut start, &mut end); true } else { false }; Selection { id: post_inc(&mut self.collection.next_selection_id), start, end, reversed, goal: SelectionGoal::None, } }) .collect::>(); self.select_anchors(selections) } pub fn new_selection_id(&mut self) -> usize { post_inc(&mut self.next_selection_id) } pub fn select_display_ranges(&mut self, ranges: T) where T: IntoIterator>, { let display_map = self.display_map(); let selections = ranges .into_iter() .map(|range| { let mut start = range.start; let mut end = range.end; let reversed = if start > end { mem::swap(&mut start, &mut end); true } else { false }; Selection { id: post_inc(&mut self.collection.next_selection_id), start: start.to_point(&display_map), end: end.to_point(&display_map), reversed, goal: SelectionGoal::None, } }) .collect(); self.select(selections); } pub fn reverse_selections(&mut self) { let map = &self.display_map(); let mut new_selections: Vec> = Vec::new(); let disjoint = self.disjoint.clone(); for selection in disjoint .iter() .sorted_by(|first, second| Ord::cmp(&second.id, &first.id)) .collect::>>() { new_selections.push(Selection { id: self.new_selection_id(), start: selection.start.to_display_point(map).to_point(map), end: selection.end.to_display_point(map).to_point(map), reversed: selection.reversed, goal: selection.goal, }); } self.select(new_selections); } pub fn move_with( &mut self, mut move_selection: impl FnMut(&DisplaySnapshot, &mut Selection), ) { let mut changed = false; let display_map = self.display_map(); let (_, selections) = self.collection.all_display(self.cx); let selections = selections .into_iter() .map(|selection| { let mut moved_selection = selection.clone(); move_selection(&display_map, &mut moved_selection); if selection != moved_selection { changed = true; } moved_selection.map(|display_point| display_point.to_point(&display_map)) }) .collect(); if changed { self.select(selections) } } pub fn move_offsets_with( &mut self, mut move_selection: impl FnMut(&MultiBufferSnapshot, &mut Selection), ) { let mut changed = false; let snapshot = self.buffer().clone(); let selections = self .collection .all::(self.cx) .into_iter() .map(|selection| { let mut moved_selection = selection.clone(); move_selection(&snapshot, &mut moved_selection); if selection != moved_selection { changed = true; } moved_selection }) .collect(); drop(snapshot); if changed { self.select(selections) } } pub fn move_heads_with( &mut self, mut update_head: impl FnMut( &DisplaySnapshot, DisplayPoint, SelectionGoal, ) -> (DisplayPoint, SelectionGoal), ) { self.move_with(|map, selection| { let (new_head, new_goal) = update_head(map, selection.head(), selection.goal); selection.set_head(new_head, new_goal); }); } pub fn move_cursors_with( &mut self, mut update_cursor_position: impl FnMut( &DisplaySnapshot, DisplayPoint, SelectionGoal, ) -> (DisplayPoint, SelectionGoal), ) { self.move_with(|map, selection| { let (cursor, new_goal) = update_cursor_position(map, selection.head(), selection.goal); selection.collapse_to(cursor, new_goal) }); } pub fn maybe_move_cursors_with( &mut self, mut update_cursor_position: impl FnMut( &DisplaySnapshot, DisplayPoint, SelectionGoal, ) -> Option<(DisplayPoint, SelectionGoal)>, ) { self.move_cursors_with(|map, point, goal| { update_cursor_position(map, point, goal).unwrap_or((point, goal)) }) } pub fn replace_cursors_with( &mut self, find_replacement_cursors: impl FnOnce(&DisplaySnapshot) -> Vec, ) { let display_map = self.display_map(); let new_selections = find_replacement_cursors(&display_map) .into_iter() .map(|cursor| { let cursor_point = cursor.to_point(&display_map); Selection { id: post_inc(&mut self.collection.next_selection_id), start: cursor_point, end: cursor_point, reversed: false, goal: SelectionGoal::None, } }) .collect(); self.select(new_selections); } /// Compute new ranges for any selections that were located in excerpts that have /// since been removed. /// /// Returns a `HashMap` indicating which selections whose former head position /// was no longer present. The keys of the map are selection ids. The values are /// the id of the new excerpt where the head of the selection has been moved. pub fn refresh(&mut self) -> HashMap { let mut pending = self.collection.pending.take(); let mut selections_with_lost_position = HashMap::default(); let anchors_with_status = { let buffer = self.buffer(); let disjoint_anchors = self .disjoint .iter() .flat_map(|selection| [&selection.start, &selection.end]); buffer.refresh_anchors(disjoint_anchors) }; let adjusted_disjoint: Vec<_> = anchors_with_status .chunks(2) .map(|selection_anchors| { let (anchor_ix, start, kept_start) = selection_anchors[0]; let (_, end, kept_end) = selection_anchors[1]; let selection = &self.disjoint[anchor_ix / 2]; let kept_head = if selection.reversed { kept_start } else { kept_end }; if !kept_head { selections_with_lost_position.insert(selection.id, selection.head().excerpt_id); } Selection { id: selection.id, start, end, reversed: selection.reversed, goal: selection.goal, } }) .collect(); if !adjusted_disjoint.is_empty() { let map = self.display_map(); let resolved_selections = resolve_selections(adjusted_disjoint.iter(), &map).collect(); self.select::(resolved_selections); } if let Some(pending) = pending.as_mut() { let buffer = self.buffer(); let anchors = buffer.refresh_anchors([&pending.selection.start, &pending.selection.end]); let (_, start, kept_start) = anchors[0]; let (_, end, kept_end) = anchors[1]; let kept_head = if pending.selection.reversed { kept_start } else { kept_end }; if !kept_head { selections_with_lost_position .insert(pending.selection.id, pending.selection.head().excerpt_id); } pending.selection.start = start; pending.selection.end = end; } self.collection.pending = pending; self.selections_changed = true; selections_with_lost_position } } impl Deref for MutableSelectionsCollection<'_> { type Target = SelectionsCollection; fn deref(&self) -> &Self::Target { self.collection } } impl DerefMut for MutableSelectionsCollection<'_> { fn deref_mut(&mut self) -> &mut Self::Target { self.collection } } fn selection_to_anchor_selection( selection: Selection, buffer: &MultiBufferSnapshot, ) -> Selection where T: ToOffset + Ord, { let end_bias = if selection.end > selection.start { Bias::Left } else { Bias::Right }; Selection { id: selection.id, start: buffer.anchor_after(selection.start), end: buffer.anchor_at(selection.end, end_bias), reversed: selection.reversed, goal: selection.goal, } } // Panics if passed selections are not in order fn resolve_selections_display<'a>( selections: impl 'a + IntoIterator>, map: &'a DisplaySnapshot, ) -> impl 'a + Iterator> { let (to_summarize, selections) = selections.into_iter().tee(); let mut summaries = map .buffer_snapshot .summaries_for_anchors::(to_summarize.flat_map(|s| [&s.start, &s.end])) .into_iter(); let mut selections = selections .map(move |s| { let start = summaries.next().unwrap(); let end = summaries.next().unwrap(); let display_start = map.point_to_display_point(start, Bias::Left); let display_end = if start == end { map.point_to_display_point(end, Bias::Right) } else { map.point_to_display_point(end, Bias::Left) }; Selection { id: s.id, start: display_start, end: display_end, reversed: s.reversed, goal: s.goal, } }) .peekable(); iter::from_fn(move || { let mut selection = selections.next()?; while let Some(next_selection) = selections.peek() { if selection.end >= next_selection.start { selection.end = cmp::max(selection.end, next_selection.end); selections.next(); } else { break; } } Some(selection) }) } // Panics if passed selections are not in order pub(crate) fn resolve_selections<'a, D, I>( selections: I, map: &'a DisplaySnapshot, ) -> impl 'a + Iterator> where D: TextDimension + Ord + Sub, I: 'a + IntoIterator>, { let (to_convert, selections) = resolve_selections_display(selections, map).tee(); let mut converted_endpoints = map.buffer_snapshot .dimensions_from_points::(to_convert.flat_map(|s| { let start = map.display_point_to_point(s.start, Bias::Left); let end = map.display_point_to_point(s.end, Bias::Right); [start, end] })); selections.map(move |s| { let start = converted_endpoints.next().unwrap(); let end = converted_endpoints.next().unwrap(); Selection { id: s.id, start, end, reversed: s.reversed, goal: s.goal, } }) }