ZIm/crates/outline_panel/src/outline_panel.rs
Bennet Bo Fenner b5c41eeb98
Future-proof indent guides settings for panels (#19878)
This PR ensures that we do not have to break the indent guides settings
for the project/outline panel. In the future we might want to have a
more granular way to control when to show indent guides, or control
other indent guide properties, like its width.

Release Notes:

- N/A
2024-10-29 09:52:36 +01:00

4875 lines
195 KiB
Rust

mod outline_panel_settings;
use std::{
cell::OnceCell,
cmp,
hash::Hash,
ops::Range,
path::{Path, PathBuf},
sync::{atomic::AtomicBool, Arc, OnceLock},
time::Duration,
u32,
};
use anyhow::Context;
use collections::{hash_map, BTreeSet, HashMap, HashSet};
use db::kvp::KEY_VALUE_STORE;
use editor::{
display_map::ToDisplayPoint,
items::{entry_git_aware_label_color, entry_label_color},
scroll::{Autoscroll, AutoscrollStrategy, ScrollAnchor},
AnchorRangeExt, Bias, DisplayPoint, Editor, EditorEvent, EditorMode, ExcerptId, ExcerptRange,
MultiBufferSnapshot, RangeToAnchorExt,
};
use file_icons::FileIcons;
use fuzzy::{match_strings, StringMatch, StringMatchCandidate};
use gpui::{
actions, anchored, deferred, div, impl_actions, point, px, size, uniform_list, Action,
AnyElement, AppContext, AssetSource, AsyncWindowContext, Bounds, ClipboardItem, DismissEvent,
Div, ElementId, EventEmitter, FocusHandle, FocusableView, HighlightStyle, InteractiveElement,
IntoElement, KeyContext, Model, MouseButton, MouseDownEvent, ParentElement, Pixels, Point,
Render, SharedString, Stateful, Styled, Subscription, Task, UniformListScrollHandle, View,
ViewContext, VisualContext, WeakView, WindowContext,
};
use itertools::Itertools;
use language::{BufferId, BufferSnapshot, OffsetRangeExt, OutlineItem};
use menu::{Cancel, SelectFirst, SelectLast, SelectNext, SelectPrev};
use outline_panel_settings::{OutlinePanelDockPosition, OutlinePanelSettings, ShowIndentGuides};
use project::{File, Fs, Item, Project};
use search::{BufferSearchBar, ProjectSearchView};
use serde::{Deserialize, Serialize};
use settings::{Settings, SettingsStore};
use smol::channel;
use theme::{SyntaxTheme, ThemeSettings};
use ui::{IndentGuideColors, IndentGuideLayout};
use util::{debug_panic, RangeExt, ResultExt, TryFutureExt};
use workspace::{
dock::{DockPosition, Panel, PanelEvent},
item::ItemHandle,
searchable::{SearchEvent, SearchableItem},
ui::{
h_flex, v_flex, ActiveTheme, ButtonCommon, Clickable, Color, ContextMenu, FluentBuilder,
HighlightedLabel, Icon, IconButton, IconButtonShape, IconName, IconSize, Label,
LabelCommon, ListItem, Selectable, Spacing, StyledExt, StyledTypography, Tooltip,
},
OpenInTerminal, WeakItemHandle, Workspace,
};
use worktree::{Entry, ProjectEntryId, WorktreeId};
#[derive(Clone, Default, Deserialize, PartialEq)]
pub struct Open {
change_selection: bool,
}
impl_actions!(outline_panel, [Open]);
actions!(
outline_panel,
[
CollapseAllEntries,
CollapseSelectedEntry,
CopyPath,
CopyRelativePath,
ExpandAllEntries,
ExpandSelectedEntry,
FoldDirectory,
ToggleActiveEditorPin,
RevealInFileManager,
SelectParent,
ToggleFocus,
UnfoldDirectory,
]
);
const OUTLINE_PANEL_KEY: &str = "OutlinePanel";
const UPDATE_DEBOUNCE: Duration = Duration::from_millis(50);
type Outline = OutlineItem<language::Anchor>;
type HighlightStyleData = Arc<OnceLock<Vec<(Range<usize>, HighlightStyle)>>>;
pub struct OutlinePanel {
fs: Arc<dyn Fs>,
width: Option<Pixels>,
project: Model<Project>,
workspace: WeakView<Workspace>,
active: bool,
pinned: bool,
scroll_handle: UniformListScrollHandle,
context_menu: Option<(View<ContextMenu>, Point<Pixels>, Subscription)>,
focus_handle: FocusHandle,
pending_serialization: Task<Option<()>>,
fs_entries_depth: HashMap<(WorktreeId, ProjectEntryId), usize>,
fs_entries: Vec<FsEntry>,
fs_children_count: HashMap<WorktreeId, HashMap<Arc<Path>, FsChildren>>,
collapsed_entries: HashSet<CollapsedEntry>,
unfolded_dirs: HashMap<WorktreeId, BTreeSet<ProjectEntryId>>,
selected_entry: SelectedEntry,
active_item: Option<ActiveItem>,
_subscriptions: Vec<Subscription>,
updating_fs_entries: bool,
fs_entries_update_task: Task<()>,
cached_entries_update_task: Task<()>,
reveal_selection_task: Task<anyhow::Result<()>>,
outline_fetch_tasks: HashMap<(BufferId, ExcerptId), Task<()>>,
excerpts: HashMap<BufferId, HashMap<ExcerptId, Excerpt>>,
cached_entries: Vec<CachedEntry>,
filter_editor: View<Editor>,
mode: ItemsDisplayMode,
}
enum ItemsDisplayMode {
Search(SearchState),
Outline,
}
struct SearchState {
kind: SearchKind,
query: String,
matches: Vec<(Range<editor::Anchor>, OnceCell<Arc<SearchData>>)>,
highlight_search_match_tx: channel::Sender<HighlightArguments>,
_search_match_highlighter: Task<()>,
_search_match_notify: Task<()>,
}
struct HighlightArguments {
multi_buffer_snapshot: MultiBufferSnapshot,
search_data: Arc<SearchData>,
}
impl SearchState {
fn new(
kind: SearchKind,
query: String,
new_matches: Vec<Range<editor::Anchor>>,
theme: Arc<SyntaxTheme>,
cx: &mut ViewContext<'_, OutlinePanel>,
) -> Self {
let (highlight_search_match_tx, highlight_search_match_rx) = channel::unbounded();
let (notify_tx, notify_rx) = channel::bounded::<()>(1);
Self {
kind,
query,
matches: new_matches
.into_iter()
.map(|range| (range, OnceCell::new()))
.collect(),
highlight_search_match_tx,
_search_match_highlighter: cx.background_executor().spawn(async move {
while let Ok(highlight_arguments) = highlight_search_match_rx.recv().await {
let highlight_data = &highlight_arguments.search_data.highlights_data;
if highlight_data.get().is_some() {
continue;
}
let mut left_whitespaces_count = 0;
let mut non_whitespace_symbol_occurred = false;
let context_offset_range = highlight_arguments
.search_data
.context_range
.to_offset(&highlight_arguments.multi_buffer_snapshot);
let mut offset = context_offset_range.start;
let mut context_text = String::new();
let mut highlight_ranges = Vec::new();
for mut chunk in highlight_arguments
.multi_buffer_snapshot
.chunks(context_offset_range.start..context_offset_range.end, true)
{
if !non_whitespace_symbol_occurred {
for c in chunk.text.chars() {
if c.is_whitespace() {
left_whitespaces_count += c.len_utf8();
} else {
non_whitespace_symbol_occurred = true;
break;
}
}
}
if chunk.text.len() > context_offset_range.end - offset {
chunk.text = &chunk.text[0..(context_offset_range.end - offset)];
offset = context_offset_range.end;
} else {
offset += chunk.text.len();
}
let style = chunk
.syntax_highlight_id
.and_then(|highlight| highlight.style(&theme));
if let Some(style) = style {
let start = context_text.len();
let end = start + chunk.text.len();
highlight_ranges.push((start..end, style));
}
context_text.push_str(chunk.text);
if offset >= context_offset_range.end {
break;
}
}
highlight_ranges.iter_mut().for_each(|(range, _)| {
range.start = range.start.saturating_sub(left_whitespaces_count);
range.end = range.end.saturating_sub(left_whitespaces_count);
});
if highlight_data.set(highlight_ranges).ok().is_some() {
notify_tx.try_send(()).ok();
}
let trimmed_text = context_text[left_whitespaces_count..].to_owned();
debug_assert_eq!(
trimmed_text, highlight_arguments.search_data.context_text,
"Highlighted text that does not match the buffer text"
);
}
}),
_search_match_notify: cx.spawn(|outline_panel, mut cx| async move {
while let Ok(()) = notify_rx.recv().await {
let update_result = outline_panel.update(&mut cx, |_, cx| {
cx.notify();
});
if update_result.is_err() {
break;
}
}
}),
}
}
fn highlight_search_match(
&mut self,
match_range: &Range<editor::Anchor>,
multi_buffer_snapshot: &MultiBufferSnapshot,
) {
if let Some((_, search_data)) = self.matches.iter().find(|(range, _)| range == match_range)
{
let search_data = search_data
.get_or_init(|| Arc::new(SearchData::new(match_range, multi_buffer_snapshot)));
self.highlight_search_match_tx
.send_blocking(HighlightArguments {
multi_buffer_snapshot: multi_buffer_snapshot.clone(),
search_data: Arc::clone(search_data),
})
.ok();
}
}
}
#[derive(Debug)]
enum SelectedEntry {
Invalidated(Option<PanelEntry>),
Valid(PanelEntry, usize),
None,
}
impl SelectedEntry {
fn invalidate(&mut self) {
match std::mem::replace(self, SelectedEntry::None) {
Self::Valid(entry, _) => *self = Self::Invalidated(Some(entry)),
Self::None => *self = Self::Invalidated(None),
other => *self = other,
}
}
fn is_invalidated(&self) -> bool {
matches!(self, Self::Invalidated(_))
}
}
#[derive(Debug, Clone, Copy, Default)]
struct FsChildren {
files: usize,
dirs: usize,
}
impl FsChildren {
fn may_be_fold_part(&self) -> bool {
self.dirs == 0 || (self.dirs == 1 && self.files == 0)
}
}
#[derive(Clone, Debug)]
struct CachedEntry {
depth: usize,
string_match: Option<StringMatch>,
entry: PanelEntry,
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
enum CollapsedEntry {
Dir(WorktreeId, ProjectEntryId),
File(WorktreeId, BufferId),
ExternalFile(BufferId),
Excerpt(BufferId, ExcerptId),
}
#[derive(Debug)]
struct Excerpt {
range: ExcerptRange<language::Anchor>,
outlines: ExcerptOutlines,
}
impl Excerpt {
fn invalidate_outlines(&mut self) {
if let ExcerptOutlines::Outlines(valid_outlines) = &mut self.outlines {
self.outlines = ExcerptOutlines::Invalidated(std::mem::take(valid_outlines));
}
}
fn iter_outlines(&self) -> impl Iterator<Item = &Outline> {
match &self.outlines {
ExcerptOutlines::Outlines(outlines) => outlines.iter(),
ExcerptOutlines::Invalidated(outlines) => outlines.iter(),
ExcerptOutlines::NotFetched => [].iter(),
}
}
fn should_fetch_outlines(&self) -> bool {
match &self.outlines {
ExcerptOutlines::Outlines(_) => false,
ExcerptOutlines::Invalidated(_) => true,
ExcerptOutlines::NotFetched => true,
}
}
}
#[derive(Debug)]
enum ExcerptOutlines {
Outlines(Vec<Outline>),
Invalidated(Vec<Outline>),
NotFetched,
}
#[derive(Clone, Debug)]
enum PanelEntry {
Fs(FsEntry),
FoldedDirs(WorktreeId, Vec<Entry>),
Outline(OutlineEntry),
Search(SearchEntry),
}
#[derive(Clone, Debug)]
struct SearchEntry {
match_range: Range<editor::Anchor>,
kind: SearchKind,
render_data: Arc<SearchData>,
}
#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
enum SearchKind {
Project,
Buffer,
}
#[derive(Clone, Debug)]
struct SearchData {
context_range: Range<editor::Anchor>,
context_text: String,
truncated_left: bool,
truncated_right: bool,
search_match_indices: Vec<Range<usize>>,
highlights_data: HighlightStyleData,
}
impl PartialEq for PanelEntry {
fn eq(&self, other: &Self) -> bool {
match (self, other) {
(Self::Fs(a), Self::Fs(b)) => a == b,
(Self::FoldedDirs(a1, a2), Self::FoldedDirs(b1, b2)) => a1 == b1 && a2 == b2,
(Self::Outline(a), Self::Outline(b)) => a == b,
(
Self::Search(SearchEntry {
match_range: match_range_a,
kind: kind_a,
..
}),
Self::Search(SearchEntry {
match_range: match_range_b,
kind: kind_b,
..
}),
) => match_range_a == match_range_b && kind_a == kind_b,
_ => false,
}
}
}
impl Eq for PanelEntry {}
const SEARCH_MATCH_CONTEXT_SIZE: u32 = 40;
const TRUNCATED_CONTEXT_MARK: &str = "";
impl SearchData {
fn new(
match_range: &Range<editor::Anchor>,
multi_buffer_snapshot: &MultiBufferSnapshot,
) -> Self {
let match_point_range = match_range.to_point(multi_buffer_snapshot);
let context_left_border = multi_buffer_snapshot.clip_point(
language::Point::new(
match_point_range.start.row,
match_point_range
.start
.column
.saturating_sub(SEARCH_MATCH_CONTEXT_SIZE),
),
Bias::Left,
);
let context_right_border = multi_buffer_snapshot.clip_point(
language::Point::new(
match_point_range.end.row,
match_point_range.end.column + SEARCH_MATCH_CONTEXT_SIZE,
),
Bias::Right,
);
let context_anchor_range =
(context_left_border..context_right_border).to_anchors(multi_buffer_snapshot);
let context_offset_range = context_anchor_range.to_offset(multi_buffer_snapshot);
let match_offset_range = match_range.to_offset(multi_buffer_snapshot);
let mut search_match_indices = vec![
multi_buffer_snapshot.clip_offset(
match_offset_range.start - context_offset_range.start,
Bias::Left,
)
..multi_buffer_snapshot.clip_offset(
match_offset_range.end - context_offset_range.start,
Bias::Right,
),
];
let entire_context_text = multi_buffer_snapshot
.text_for_range(context_offset_range.clone())
.collect::<String>();
let left_whitespaces_offset = entire_context_text
.chars()
.take_while(|c| c.is_whitespace())
.map(|c| c.len_utf8())
.sum::<usize>();
let mut extended_context_left_border = context_left_border;
extended_context_left_border.column = extended_context_left_border.column.saturating_sub(1);
let extended_context_left_border =
multi_buffer_snapshot.clip_point(extended_context_left_border, Bias::Left);
let mut extended_context_right_border = context_right_border;
extended_context_right_border.column += 1;
let extended_context_right_border =
multi_buffer_snapshot.clip_point(extended_context_right_border, Bias::Right);
let truncated_left = left_whitespaces_offset == 0
&& extended_context_left_border < context_left_border
&& multi_buffer_snapshot
.chars_at(extended_context_left_border)
.last()
.map_or(false, |c| !c.is_whitespace());
let truncated_right = entire_context_text
.chars()
.last()
.map_or(true, |c| !c.is_whitespace())
&& extended_context_right_border > context_right_border
&& multi_buffer_snapshot
.chars_at(extended_context_right_border)
.next()
.map_or(false, |c| !c.is_whitespace());
search_match_indices.iter_mut().for_each(|range| {
range.start = multi_buffer_snapshot.clip_offset(
range.start.saturating_sub(left_whitespaces_offset),
Bias::Left,
);
range.end = multi_buffer_snapshot.clip_offset(
range.end.saturating_sub(left_whitespaces_offset),
Bias::Right,
);
});
let trimmed_row_offset_range =
context_offset_range.start + left_whitespaces_offset..context_offset_range.end;
let trimmed_text = entire_context_text[left_whitespaces_offset..].to_owned();
Self {
highlights_data: Arc::default(),
search_match_indices,
context_range: trimmed_row_offset_range.to_anchors(multi_buffer_snapshot),
context_text: trimmed_text,
truncated_left,
truncated_right,
}
}
}
#[derive(Clone, Debug, PartialEq, Eq)]
enum OutlineEntry {
Excerpt(BufferId, ExcerptId, ExcerptRange<language::Anchor>),
Outline(BufferId, ExcerptId, Outline),
}
#[derive(Clone, Debug, Eq)]
enum FsEntry {
ExternalFile(BufferId, Vec<ExcerptId>),
Directory(WorktreeId, Entry),
File(WorktreeId, Entry, BufferId, Vec<ExcerptId>),
}
impl PartialEq for FsEntry {
fn eq(&self, other: &Self) -> bool {
match (self, other) {
(Self::ExternalFile(id_a, _), Self::ExternalFile(id_b, _)) => id_a == id_b,
(Self::Directory(id_a, entry_a), Self::Directory(id_b, entry_b)) => {
id_a == id_b && entry_a.id == entry_b.id
}
(
Self::File(worktree_a, entry_a, id_a, ..),
Self::File(worktree_b, entry_b, id_b, ..),
) => worktree_a == worktree_b && entry_a.id == entry_b.id && id_a == id_b,
_ => false,
}
}
}
impl Hash for FsEntry {
fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
match self {
Self::ExternalFile(buffer_id, _) => {
buffer_id.hash(state);
}
Self::Directory(worktree_id, entry) => {
worktree_id.hash(state);
entry.id.hash(state);
}
Self::File(worktree_id, entry, buffer_id, _) => {
worktree_id.hash(state);
entry.id.hash(state);
buffer_id.hash(state);
}
}
}
}
struct ActiveItem {
item_handle: Box<dyn WeakItemHandle>,
active_editor: WeakView<Editor>,
_buffer_search_subscription: Subscription,
_editor_subscrpiption: Subscription,
}
#[derive(Debug)]
pub enum Event {
Focus,
}
#[derive(Serialize, Deserialize)]
struct SerializedOutlinePanel {
width: Option<Pixels>,
active: Option<bool>,
}
pub fn init_settings(cx: &mut AppContext) {
OutlinePanelSettings::register(cx);
}
pub fn init(assets: impl AssetSource, cx: &mut AppContext) {
init_settings(cx);
file_icons::init(assets, cx);
cx.observe_new_views(|workspace: &mut Workspace, _| {
workspace.register_action(|workspace, _: &ToggleFocus, cx| {
workspace.toggle_panel_focus::<OutlinePanel>(cx);
});
})
.detach();
}
impl OutlinePanel {
pub async fn load(
workspace: WeakView<Workspace>,
mut cx: AsyncWindowContext,
) -> anyhow::Result<View<Self>> {
let serialized_panel = cx
.background_executor()
.spawn(async move { KEY_VALUE_STORE.read_kvp(OUTLINE_PANEL_KEY) })
.await
.context("loading outline panel")
.log_err()
.flatten()
.map(|panel| serde_json::from_str::<SerializedOutlinePanel>(&panel))
.transpose()
.log_err()
.flatten();
workspace.update(&mut cx, |workspace, cx| {
let panel = Self::new(workspace, cx);
if let Some(serialized_panel) = serialized_panel {
panel.update(cx, |panel, cx| {
panel.width = serialized_panel.width.map(|px| px.round());
panel.active = serialized_panel.active.unwrap_or(false);
cx.notify();
});
}
panel
})
}
fn new(workspace: &mut Workspace, cx: &mut ViewContext<Workspace>) -> View<Self> {
let project = workspace.project().clone();
let workspace_handle = cx.view().downgrade();
let outline_panel = cx.new_view(|cx| {
let filter_editor = cx.new_view(|cx| {
let mut editor = Editor::single_line(cx);
editor.set_placeholder_text("Filter...", cx);
editor
});
let filter_update_subscription =
cx.subscribe(&filter_editor, |outline_panel: &mut Self, _, event, cx| {
if let editor::EditorEvent::BufferEdited = event {
outline_panel.update_cached_entries(Some(UPDATE_DEBOUNCE), cx);
}
});
let focus_handle = cx.focus_handle();
let focus_subscription = cx.on_focus(&focus_handle, Self::focus_in);
let workspace_subscription = cx.subscribe(
&workspace
.weak_handle()
.upgrade()
.expect("have a &mut Workspace"),
move |outline_panel, workspace, event, cx| {
if let workspace::Event::ActiveItemChanged = event {
if let Some((new_active_item, new_active_editor)) =
workspace_active_editor(workspace.read(cx), cx)
{
if outline_panel.should_replace_active_item(new_active_item.as_ref()) {
outline_panel.replace_active_editor(
new_active_item,
new_active_editor,
cx,
);
}
} else {
outline_panel.clear_previous(cx);
cx.notify();
}
}
},
);
let icons_subscription = cx.observe_global::<FileIcons>(|_, cx| {
cx.notify();
});
let mut outline_panel_settings = *OutlinePanelSettings::get_global(cx);
let mut current_theme = ThemeSettings::get_global(cx).clone();
let settings_subscription =
cx.observe_global::<SettingsStore>(move |outline_panel, cx| {
let new_settings = OutlinePanelSettings::get_global(cx);
let new_theme = ThemeSettings::get_global(cx);
if &current_theme != new_theme {
outline_panel_settings = *new_settings;
current_theme = new_theme.clone();
for excerpts in outline_panel.excerpts.values_mut() {
for excerpt in excerpts.values_mut() {
excerpt.invalidate_outlines();
}
}
outline_panel.update_non_fs_items(cx);
} else if &outline_panel_settings != new_settings {
outline_panel_settings = *new_settings;
cx.notify();
}
});
let mut outline_panel = Self {
mode: ItemsDisplayMode::Outline,
active: false,
pinned: false,
workspace: workspace_handle,
project,
fs: workspace.app_state().fs.clone(),
scroll_handle: UniformListScrollHandle::new(),
focus_handle,
filter_editor,
fs_entries: Vec::new(),
fs_entries_depth: HashMap::default(),
fs_children_count: HashMap::default(),
collapsed_entries: HashSet::default(),
unfolded_dirs: HashMap::default(),
selected_entry: SelectedEntry::None,
context_menu: None,
width: None,
active_item: None,
pending_serialization: Task::ready(None),
updating_fs_entries: false,
fs_entries_update_task: Task::ready(()),
cached_entries_update_task: Task::ready(()),
reveal_selection_task: Task::ready(Ok(())),
outline_fetch_tasks: HashMap::default(),
excerpts: HashMap::default(),
cached_entries: Vec::new(),
_subscriptions: vec![
settings_subscription,
icons_subscription,
focus_subscription,
workspace_subscription,
filter_update_subscription,
],
};
if let Some((item, editor)) = workspace_active_editor(workspace, cx) {
outline_panel.replace_active_editor(item, editor, cx);
}
outline_panel
});
outline_panel
}
fn serialize(&mut self, cx: &mut ViewContext<Self>) {
let width = self.width;
let active = Some(self.active);
self.pending_serialization = cx.background_executor().spawn(
async move {
KEY_VALUE_STORE
.write_kvp(
OUTLINE_PANEL_KEY.into(),
serde_json::to_string(&SerializedOutlinePanel { width, active })?,
)
.await?;
anyhow::Ok(())
}
.log_err(),
);
}
fn dispatch_context(&self, cx: &ViewContext<Self>) -> KeyContext {
let mut dispatch_context = KeyContext::new_with_defaults();
dispatch_context.add("OutlinePanel");
dispatch_context.add("menu");
let identifier = if self.filter_editor.focus_handle(cx).is_focused(cx) {
"editing"
} else {
"not_editing"
};
dispatch_context.add(identifier);
dispatch_context
}
fn unfold_directory(&mut self, _: &UnfoldDirectory, cx: &mut ViewContext<Self>) {
if let Some(PanelEntry::FoldedDirs(worktree_id, entries)) = self.selected_entry().cloned() {
self.unfolded_dirs
.entry(worktree_id)
.or_default()
.extend(entries.iter().map(|entry| entry.id));
self.update_cached_entries(None, cx);
}
}
fn fold_directory(&mut self, _: &FoldDirectory, cx: &mut ViewContext<Self>) {
let (worktree_id, entry) = match self.selected_entry().cloned() {
Some(PanelEntry::Fs(FsEntry::Directory(worktree_id, entry))) => {
(worktree_id, Some(entry))
}
Some(PanelEntry::FoldedDirs(worktree_id, entries)) => {
(worktree_id, entries.last().cloned())
}
_ => return,
};
let Some(entry) = entry else {
return;
};
let unfolded_dirs = self.unfolded_dirs.get_mut(&worktree_id);
let worktree = self
.project
.read(cx)
.worktree_for_id(worktree_id, cx)
.map(|w| w.read(cx).snapshot());
let Some((_, unfolded_dirs)) = worktree.zip(unfolded_dirs) else {
return;
};
unfolded_dirs.remove(&entry.id);
self.update_cached_entries(None, cx);
}
fn open(&mut self, open: &Open, cx: &mut ViewContext<Self>) {
if self.filter_editor.focus_handle(cx).is_focused(cx) {
cx.propagate()
} else if let Some(selected_entry) = self.selected_entry().cloned() {
self.open_entry(&selected_entry, open.change_selection, cx);
}
}
fn cancel(&mut self, _: &Cancel, cx: &mut ViewContext<Self>) {
if self.filter_editor.focus_handle(cx).is_focused(cx) {
self.focus_handle.focus(cx);
} else {
self.filter_editor.focus_handle(cx).focus(cx);
}
if self.context_menu.is_some() {
self.context_menu.take();
cx.notify();
}
}
fn open_entry(
&mut self,
entry: &PanelEntry,
change_selection: bool,
cx: &mut ViewContext<OutlinePanel>,
) {
let Some(active_editor) = self.active_editor() else {
return;
};
let active_multi_buffer = active_editor.read(cx).buffer().clone();
let multi_buffer_snapshot = active_multi_buffer.read(cx).snapshot(cx);
let offset_from_top = if active_multi_buffer.read(cx).is_singleton() {
Point::default()
} else {
Point::new(0.0, -(active_editor.read(cx).file_header_size() as f32))
};
self.toggle_expanded(entry, cx);
let scroll_target = match entry {
PanelEntry::FoldedDirs(..) | PanelEntry::Fs(FsEntry::Directory(..)) => None,
PanelEntry::Fs(FsEntry::ExternalFile(buffer_id, _)) => {
let scroll_target = multi_buffer_snapshot.excerpts().find_map(
|(excerpt_id, buffer_snapshot, excerpt_range)| {
if &buffer_snapshot.remote_id() == buffer_id {
multi_buffer_snapshot
.anchor_in_excerpt(excerpt_id, excerpt_range.context.start)
} else {
None
}
},
);
Some(offset_from_top).zip(scroll_target)
}
PanelEntry::Fs(FsEntry::File(_, file_entry, ..)) => {
let scroll_target = self
.project
.update(cx, |project, cx| {
project
.path_for_entry(file_entry.id, cx)
.and_then(|path| project.get_open_buffer(&path, cx))
})
.map(|buffer| {
active_multi_buffer
.read(cx)
.excerpts_for_buffer(&buffer, cx)
})
.and_then(|excerpts| {
let (excerpt_id, excerpt_range) = excerpts.first()?;
multi_buffer_snapshot
.anchor_in_excerpt(*excerpt_id, excerpt_range.context.start)
});
Some(offset_from_top).zip(scroll_target)
}
PanelEntry::Outline(OutlineEntry::Outline(_, excerpt_id, outline)) => {
let scroll_target = multi_buffer_snapshot
.anchor_in_excerpt(*excerpt_id, outline.range.start)
.or_else(|| {
multi_buffer_snapshot.anchor_in_excerpt(*excerpt_id, outline.range.end)
});
Some(Point::default()).zip(scroll_target)
}
PanelEntry::Outline(OutlineEntry::Excerpt(_, excerpt_id, excerpt_range)) => {
let scroll_target = multi_buffer_snapshot
.anchor_in_excerpt(*excerpt_id, excerpt_range.context.start);
Some(Point::default()).zip(scroll_target)
}
PanelEntry::Search(SearchEntry { match_range, .. }) => {
Some((Point::default(), match_range.start))
}
};
if let Some((offset, anchor)) = scroll_target {
let activate = self
.workspace
.update(cx, |workspace, cx| match self.active_item() {
Some(active_item) => {
workspace.activate_item(active_item.as_ref(), true, change_selection, cx)
}
None => workspace.activate_item(&active_editor, true, change_selection, cx),
});
if activate.is_ok() {
self.select_entry(entry.clone(), true, cx);
if change_selection {
active_editor.update(cx, |editor, cx| {
editor.change_selections(
Some(Autoscroll::Strategy(AutoscrollStrategy::Top)),
cx,
|s| s.select_ranges(Some(anchor..anchor)),
);
});
active_editor.focus_handle(cx).focus(cx);
} else {
active_editor.update(cx, |editor, cx| {
editor.set_scroll_anchor(ScrollAnchor { offset, anchor }, cx);
});
self.focus_handle.focus(cx);
}
}
}
}
fn select_next(&mut self, _: &SelectNext, cx: &mut ViewContext<Self>) {
if let Some(entry_to_select) = self.selected_entry().and_then(|selected_entry| {
self.cached_entries
.iter()
.map(|cached_entry| &cached_entry.entry)
.skip_while(|entry| entry != &selected_entry)
.nth(1)
.cloned()
}) {
self.select_entry(entry_to_select, true, cx);
} else {
self.select_first(&SelectFirst {}, cx)
}
}
fn select_prev(&mut self, _: &SelectPrev, cx: &mut ViewContext<Self>) {
if let Some(entry_to_select) = self.selected_entry().and_then(|selected_entry| {
self.cached_entries
.iter()
.rev()
.map(|cached_entry| &cached_entry.entry)
.skip_while(|entry| entry != &selected_entry)
.nth(1)
.cloned()
}) {
self.select_entry(entry_to_select, true, cx);
} else {
self.select_last(&SelectLast, cx)
}
}
fn select_parent(&mut self, _: &SelectParent, cx: &mut ViewContext<Self>) {
if let Some(entry_to_select) = self.selected_entry().and_then(|selected_entry| {
let mut previous_entries = self
.cached_entries
.iter()
.rev()
.map(|cached_entry| &cached_entry.entry)
.skip_while(|entry| entry != &selected_entry)
.skip(1);
match &selected_entry {
PanelEntry::Fs(fs_entry) => match fs_entry {
FsEntry::ExternalFile(..) => None,
FsEntry::File(worktree_id, entry, ..)
| FsEntry::Directory(worktree_id, entry) => {
entry.path.parent().and_then(|parent_path| {
previous_entries.find(|entry| match entry {
PanelEntry::Fs(FsEntry::Directory(dir_worktree_id, dir_entry)) => {
dir_worktree_id == worktree_id
&& dir_entry.path.as_ref() == parent_path
}
PanelEntry::FoldedDirs(dirs_worktree_id, dirs) => {
dirs_worktree_id == worktree_id
&& dirs
.last()
.map_or(false, |dir| dir.path.as_ref() == parent_path)
}
_ => false,
})
})
}
},
PanelEntry::FoldedDirs(worktree_id, entries) => entries
.first()
.and_then(|entry| entry.path.parent())
.and_then(|parent_path| {
previous_entries.find(|entry| {
if let PanelEntry::Fs(FsEntry::Directory(dir_worktree_id, dir_entry)) =
entry
{
dir_worktree_id == worktree_id
&& dir_entry.path.as_ref() == parent_path
} else {
false
}
})
}),
PanelEntry::Outline(OutlineEntry::Excerpt(excerpt_buffer_id, excerpt_id, _)) => {
previous_entries.find(|entry| match entry {
PanelEntry::Fs(FsEntry::File(_, _, file_buffer_id, file_excerpts)) => {
file_buffer_id == excerpt_buffer_id
&& file_excerpts.contains(excerpt_id)
}
PanelEntry::Fs(FsEntry::ExternalFile(file_buffer_id, file_excerpts)) => {
file_buffer_id == excerpt_buffer_id
&& file_excerpts.contains(excerpt_id)
}
_ => false,
})
}
PanelEntry::Outline(OutlineEntry::Outline(
outline_buffer_id,
outline_excerpt_id,
_,
)) => previous_entries.find(|entry| {
if let PanelEntry::Outline(OutlineEntry::Excerpt(
excerpt_buffer_id,
excerpt_id,
_,
)) = entry
{
outline_buffer_id == excerpt_buffer_id && outline_excerpt_id == excerpt_id
} else {
false
}
}),
PanelEntry::Search(_) => {
previous_entries.find(|entry| !matches!(entry, PanelEntry::Search(_)))
}
}
}) {
self.select_entry(entry_to_select.clone(), true, cx);
} else {
self.select_first(&SelectFirst {}, cx);
}
}
fn select_first(&mut self, _: &SelectFirst, cx: &mut ViewContext<Self>) {
if let Some(first_entry) = self.cached_entries.first() {
self.select_entry(first_entry.entry.clone(), true, cx);
}
}
fn select_last(&mut self, _: &SelectLast, cx: &mut ViewContext<Self>) {
if let Some(new_selection) = self
.cached_entries
.iter()
.rev()
.map(|cached_entry| &cached_entry.entry)
.next()
{
self.select_entry(new_selection.clone(), true, cx);
}
}
fn autoscroll(&mut self, cx: &mut ViewContext<Self>) {
if let Some(selected_entry) = self.selected_entry() {
let index = self
.cached_entries
.iter()
.position(|cached_entry| &cached_entry.entry == selected_entry);
if let Some(index) = index {
self.scroll_handle.scroll_to_item(index);
cx.notify();
}
}
}
fn focus_in(&mut self, cx: &mut ViewContext<Self>) {
if !self.focus_handle.contains_focused(cx) {
cx.emit(Event::Focus);
}
}
fn deploy_context_menu(
&mut self,
position: Point<Pixels>,
entry: PanelEntry,
cx: &mut ViewContext<Self>,
) {
self.select_entry(entry.clone(), true, cx);
let is_root = match &entry {
PanelEntry::Fs(FsEntry::File(worktree_id, entry, ..))
| PanelEntry::Fs(FsEntry::Directory(worktree_id, entry)) => self
.project
.read(cx)
.worktree_for_id(*worktree_id, cx)
.map(|worktree| {
worktree.read(cx).root_entry().map(|entry| entry.id) == Some(entry.id)
})
.unwrap_or(false),
PanelEntry::FoldedDirs(worktree_id, entries) => entries
.first()
.and_then(|entry| {
self.project
.read(cx)
.worktree_for_id(*worktree_id, cx)
.map(|worktree| {
worktree.read(cx).root_entry().map(|entry| entry.id) == Some(entry.id)
})
})
.unwrap_or(false),
PanelEntry::Fs(FsEntry::ExternalFile(..)) => false,
PanelEntry::Outline(..) => {
cx.notify();
return;
}
PanelEntry::Search(_) => {
cx.notify();
return;
}
};
let auto_fold_dirs = OutlinePanelSettings::get_global(cx).auto_fold_dirs;
let is_foldable = auto_fold_dirs && !is_root && self.is_foldable(&entry);
let is_unfoldable = auto_fold_dirs && !is_root && self.is_unfoldable(&entry);
let context_menu = ContextMenu::build(cx, |menu, _| {
menu.context(self.focus_handle.clone())
.when(cfg!(target_os = "macos"), |menu| {
menu.action("Reveal in Finder", Box::new(RevealInFileManager))
})
.when(cfg!(not(target_os = "macos")), |menu| {
menu.action("Reveal in File Manager", Box::new(RevealInFileManager))
})
.action("Open in Terminal", Box::new(OpenInTerminal))
.when(is_unfoldable, |menu| {
menu.action("Unfold Directory", Box::new(UnfoldDirectory))
})
.when(is_foldable, |menu| {
menu.action("Fold Directory", Box::new(FoldDirectory))
})
.separator()
.action("Copy Path", Box::new(CopyPath))
.action("Copy Relative Path", Box::new(CopyRelativePath))
});
cx.focus_view(&context_menu);
let subscription = cx.subscribe(&context_menu, |outline_panel, _, _: &DismissEvent, cx| {
outline_panel.context_menu.take();
cx.notify();
});
self.context_menu = Some((context_menu, position, subscription));
cx.notify();
}
fn is_unfoldable(&self, entry: &PanelEntry) -> bool {
matches!(entry, PanelEntry::FoldedDirs(..))
}
fn is_foldable(&self, entry: &PanelEntry) -> bool {
let (directory_worktree, directory_entry) = match entry {
PanelEntry::Fs(FsEntry::Directory(directory_worktree, directory_entry)) => {
(*directory_worktree, Some(directory_entry))
}
_ => return false,
};
let Some(directory_entry) = directory_entry else {
return false;
};
if self
.unfolded_dirs
.get(&directory_worktree)
.map_or(true, |unfolded_dirs| {
!unfolded_dirs.contains(&directory_entry.id)
})
{
return false;
}
let children = self
.fs_children_count
.get(&directory_worktree)
.and_then(|entries| entries.get(&directory_entry.path))
.copied()
.unwrap_or_default();
children.may_be_fold_part() && children.dirs > 0
}
fn expand_selected_entry(&mut self, _: &ExpandSelectedEntry, cx: &mut ViewContext<Self>) {
let entry_to_expand = match self.selected_entry() {
Some(PanelEntry::FoldedDirs(worktree_id, dir_entries)) => dir_entries
.last()
.map(|entry| CollapsedEntry::Dir(*worktree_id, entry.id)),
Some(PanelEntry::Fs(FsEntry::Directory(worktree_id, dir_entry))) => {
Some(CollapsedEntry::Dir(*worktree_id, dir_entry.id))
}
Some(PanelEntry::Fs(FsEntry::File(worktree_id, _, buffer_id, _))) => {
Some(CollapsedEntry::File(*worktree_id, *buffer_id))
}
Some(PanelEntry::Fs(FsEntry::ExternalFile(buffer_id, _))) => {
Some(CollapsedEntry::ExternalFile(*buffer_id))
}
Some(PanelEntry::Outline(OutlineEntry::Excerpt(buffer_id, excerpt_id, _))) => {
Some(CollapsedEntry::Excerpt(*buffer_id, *excerpt_id))
}
None | Some(PanelEntry::Search(_)) | Some(PanelEntry::Outline(..)) => None,
};
let Some(collapsed_entry) = entry_to_expand else {
return;
};
let expanded = self.collapsed_entries.remove(&collapsed_entry);
if expanded {
if let CollapsedEntry::Dir(worktree_id, dir_entry_id) = collapsed_entry {
self.project.update(cx, |project, cx| {
project.expand_entry(worktree_id, dir_entry_id, cx);
});
}
self.update_cached_entries(None, cx);
} else {
self.select_next(&SelectNext, cx)
}
}
fn collapse_selected_entry(&mut self, _: &CollapseSelectedEntry, cx: &mut ViewContext<Self>) {
let Some(selected_entry) = self.selected_entry().cloned() else {
return;
};
match &selected_entry {
PanelEntry::Fs(FsEntry::Directory(worktree_id, selected_dir_entry)) => {
self.collapsed_entries
.insert(CollapsedEntry::Dir(*worktree_id, selected_dir_entry.id));
self.select_entry(selected_entry, true, cx);
self.update_cached_entries(None, cx);
}
PanelEntry::Fs(FsEntry::File(worktree_id, _, buffer_id, _)) => {
self.collapsed_entries
.insert(CollapsedEntry::File(*worktree_id, *buffer_id));
self.select_entry(selected_entry, true, cx);
self.update_cached_entries(None, cx);
}
PanelEntry::Fs(FsEntry::ExternalFile(buffer_id, _)) => {
self.collapsed_entries
.insert(CollapsedEntry::ExternalFile(*buffer_id));
self.select_entry(selected_entry, true, cx);
self.update_cached_entries(None, cx);
}
PanelEntry::FoldedDirs(worktree_id, dir_entries) => {
if let Some(dir_entry) = dir_entries.last() {
if self
.collapsed_entries
.insert(CollapsedEntry::Dir(*worktree_id, dir_entry.id))
{
self.select_entry(selected_entry, true, cx);
self.update_cached_entries(None, cx);
}
}
}
PanelEntry::Outline(OutlineEntry::Excerpt(buffer_id, excerpt_id, _)) => {
if self
.collapsed_entries
.insert(CollapsedEntry::Excerpt(*buffer_id, *excerpt_id))
{
self.select_entry(selected_entry, true, cx);
self.update_cached_entries(None, cx);
}
}
PanelEntry::Search(_) | PanelEntry::Outline(..) => {}
}
}
pub fn expand_all_entries(&mut self, _: &ExpandAllEntries, cx: &mut ViewContext<Self>) {
let expanded_entries =
self.fs_entries
.iter()
.fold(HashSet::default(), |mut entries, fs_entry| {
match fs_entry {
FsEntry::ExternalFile(buffer_id, _) => {
entries.insert(CollapsedEntry::ExternalFile(*buffer_id));
entries.extend(self.excerpts.get(buffer_id).into_iter().flat_map(
|excerpts| {
excerpts.iter().map(|(excerpt_id, _)| {
CollapsedEntry::Excerpt(*buffer_id, *excerpt_id)
})
},
));
}
FsEntry::Directory(worktree_id, entry) => {
entries.insert(CollapsedEntry::Dir(*worktree_id, entry.id));
}
FsEntry::File(worktree_id, _, buffer_id, _) => {
entries.insert(CollapsedEntry::File(*worktree_id, *buffer_id));
entries.extend(self.excerpts.get(buffer_id).into_iter().flat_map(
|excerpts| {
excerpts.iter().map(|(excerpt_id, _)| {
CollapsedEntry::Excerpt(*buffer_id, *excerpt_id)
})
},
));
}
}
entries
});
self.collapsed_entries
.retain(|entry| !expanded_entries.contains(entry));
self.update_cached_entries(None, cx);
}
pub fn collapse_all_entries(&mut self, _: &CollapseAllEntries, cx: &mut ViewContext<Self>) {
let new_entries = self
.cached_entries
.iter()
.flat_map(|cached_entry| match &cached_entry.entry {
PanelEntry::Fs(FsEntry::Directory(worktree_id, entry)) => {
Some(CollapsedEntry::Dir(*worktree_id, entry.id))
}
PanelEntry::Fs(FsEntry::File(worktree_id, _, buffer_id, _)) => {
Some(CollapsedEntry::File(*worktree_id, *buffer_id))
}
PanelEntry::Fs(FsEntry::ExternalFile(buffer_id, _)) => {
Some(CollapsedEntry::ExternalFile(*buffer_id))
}
PanelEntry::FoldedDirs(worktree_id, entries) => {
Some(CollapsedEntry::Dir(*worktree_id, entries.last()?.id))
}
PanelEntry::Outline(OutlineEntry::Excerpt(buffer_id, excerpt_id, _)) => {
Some(CollapsedEntry::Excerpt(*buffer_id, *excerpt_id))
}
PanelEntry::Search(_) | PanelEntry::Outline(..) => None,
})
.collect::<Vec<_>>();
self.collapsed_entries.extend(new_entries);
self.update_cached_entries(None, cx);
}
fn toggle_expanded(&mut self, entry: &PanelEntry, cx: &mut ViewContext<Self>) {
match entry {
PanelEntry::Fs(FsEntry::Directory(worktree_id, dir_entry)) => {
let entry_id = dir_entry.id;
let collapsed_entry = CollapsedEntry::Dir(*worktree_id, entry_id);
if self.collapsed_entries.remove(&collapsed_entry) {
self.project
.update(cx, |project, cx| {
project.expand_entry(*worktree_id, entry_id, cx)
})
.unwrap_or_else(|| Task::ready(Ok(())))
.detach_and_log_err(cx);
} else {
self.collapsed_entries.insert(collapsed_entry);
}
}
PanelEntry::Fs(FsEntry::File(worktree_id, _, buffer_id, _)) => {
let collapsed_entry = CollapsedEntry::File(*worktree_id, *buffer_id);
if !self.collapsed_entries.remove(&collapsed_entry) {
self.collapsed_entries.insert(collapsed_entry);
}
}
PanelEntry::Fs(FsEntry::ExternalFile(buffer_id, _)) => {
let collapsed_entry = CollapsedEntry::ExternalFile(*buffer_id);
if !self.collapsed_entries.remove(&collapsed_entry) {
self.collapsed_entries.insert(collapsed_entry);
}
}
PanelEntry::FoldedDirs(worktree_id, dir_entries) => {
if let Some(entry_id) = dir_entries.first().map(|entry| entry.id) {
let collapsed_entry = CollapsedEntry::Dir(*worktree_id, entry_id);
if self.collapsed_entries.remove(&collapsed_entry) {
self.project
.update(cx, |project, cx| {
project.expand_entry(*worktree_id, entry_id, cx)
})
.unwrap_or_else(|| Task::ready(Ok(())))
.detach_and_log_err(cx);
} else {
self.collapsed_entries.insert(collapsed_entry);
}
}
}
PanelEntry::Outline(OutlineEntry::Excerpt(buffer_id, excerpt_id, _)) => {
let collapsed_entry = CollapsedEntry::Excerpt(*buffer_id, *excerpt_id);
if !self.collapsed_entries.remove(&collapsed_entry) {
self.collapsed_entries.insert(collapsed_entry);
}
}
PanelEntry::Search(_) | PanelEntry::Outline(..) => return,
}
self.select_entry(entry.clone(), true, cx);
self.update_cached_entries(None, cx);
}
fn copy_path(&mut self, _: &CopyPath, cx: &mut ViewContext<Self>) {
if let Some(clipboard_text) = self
.selected_entry()
.and_then(|entry| self.abs_path(entry, cx))
.map(|p| p.to_string_lossy().to_string())
{
cx.write_to_clipboard(ClipboardItem::new_string(clipboard_text));
}
}
fn copy_relative_path(&mut self, _: &CopyRelativePath, cx: &mut ViewContext<Self>) {
if let Some(clipboard_text) = self
.selected_entry()
.and_then(|entry| match entry {
PanelEntry::Fs(entry) => self.relative_path(entry, cx),
PanelEntry::FoldedDirs(_, dirs) => dirs.last().map(|entry| entry.path.clone()),
PanelEntry::Search(_) | PanelEntry::Outline(..) => None,
})
.map(|p| p.to_string_lossy().to_string())
{
cx.write_to_clipboard(ClipboardItem::new_string(clipboard_text));
}
}
fn reveal_in_finder(&mut self, _: &RevealInFileManager, cx: &mut ViewContext<Self>) {
if let Some(abs_path) = self
.selected_entry()
.and_then(|entry| self.abs_path(entry, cx))
{
cx.reveal_path(&abs_path);
}
}
fn open_in_terminal(&mut self, _: &OpenInTerminal, cx: &mut ViewContext<Self>) {
let selected_entry = self.selected_entry();
let abs_path = selected_entry.and_then(|entry| self.abs_path(entry, cx));
let working_directory = if let (
Some(abs_path),
Some(PanelEntry::Fs(FsEntry::File(..) | FsEntry::ExternalFile(..))),
) = (&abs_path, selected_entry)
{
abs_path.parent().map(|p| p.to_owned())
} else {
abs_path
};
if let Some(working_directory) = working_directory {
cx.dispatch_action(workspace::OpenTerminal { working_directory }.boxed_clone())
}
}
fn reveal_entry_for_selection(
&mut self,
editor: &View<Editor>,
cx: &mut ViewContext<'_, Self>,
) {
if !self.active {
return;
}
if !OutlinePanelSettings::get_global(cx).auto_reveal_entries {
return;
}
let Some(entry_with_selection) = self.location_for_editor_selection(editor, cx) else {
self.selected_entry = SelectedEntry::None;
cx.notify();
return;
};
let project = self.project.clone();
self.reveal_selection_task = cx.spawn(|outline_panel, mut cx| async move {
cx.background_executor().timer(UPDATE_DEBOUNCE).await;
let related_buffer_entry = match &entry_with_selection {
PanelEntry::Fs(FsEntry::File(worktree_id, _, buffer_id, _)) => {
project.update(&mut cx, |project, cx| {
let entry_id = project
.buffer_for_id(*buffer_id, cx)
.and_then(|buffer| buffer.read(cx).entry_id(cx));
project
.worktree_for_id(*worktree_id, cx)
.zip(entry_id)
.and_then(|(worktree, entry_id)| {
let entry = worktree.read(cx).entry_for_id(entry_id)?.clone();
Some((worktree, entry))
})
})?
}
PanelEntry::Outline(outline_entry) => {
let &(OutlineEntry::Outline(buffer_id, excerpt_id, _)
| OutlineEntry::Excerpt(buffer_id, excerpt_id, _)) = outline_entry;
outline_panel.update(&mut cx, |outline_panel, cx| {
outline_panel
.collapsed_entries
.remove(&CollapsedEntry::ExternalFile(buffer_id));
outline_panel
.collapsed_entries
.remove(&CollapsedEntry::Excerpt(buffer_id, excerpt_id));
let project = outline_panel.project.read(cx);
let entry_id = project
.buffer_for_id(buffer_id, cx)
.and_then(|buffer| buffer.read(cx).entry_id(cx));
entry_id.and_then(|entry_id| {
project
.worktree_for_entry(entry_id, cx)
.and_then(|worktree| {
let worktree_id = worktree.read(cx).id();
outline_panel
.collapsed_entries
.remove(&CollapsedEntry::File(worktree_id, buffer_id));
let entry = worktree.read(cx).entry_for_id(entry_id)?.clone();
Some((worktree, entry))
})
})
})?
}
PanelEntry::Fs(FsEntry::ExternalFile(..)) => None,
PanelEntry::Search(SearchEntry { match_range, .. }) => match_range
.start
.buffer_id
.or(match_range.end.buffer_id)
.map(|buffer_id| {
outline_panel.update(&mut cx, |outline_panel, cx| {
outline_panel
.collapsed_entries
.remove(&CollapsedEntry::ExternalFile(buffer_id));
let project = project.read(cx);
let entry_id = project
.buffer_for_id(buffer_id, cx)
.and_then(|buffer| buffer.read(cx).entry_id(cx));
entry_id.and_then(|entry_id| {
project
.worktree_for_entry(entry_id, cx)
.and_then(|worktree| {
let worktree_id = worktree.read(cx).id();
outline_panel
.collapsed_entries
.remove(&CollapsedEntry::File(worktree_id, buffer_id));
let entry =
worktree.read(cx).entry_for_id(entry_id)?.clone();
Some((worktree, entry))
})
})
})
})
.transpose()?
.flatten(),
_ => return anyhow::Ok(()),
};
if let Some((worktree, buffer_entry)) = related_buffer_entry {
outline_panel.update(&mut cx, |outline_panel, cx| {
let worktree_id = worktree.read(cx).id();
let mut dirs_to_expand = Vec::new();
{
let mut traversal = worktree.read(cx).traverse_from_path(
true,
true,
true,
buffer_entry.path.as_ref(),
);
let mut current_entry = buffer_entry;
loop {
if current_entry.is_dir()
&& outline_panel
.collapsed_entries
.remove(&CollapsedEntry::Dir(worktree_id, current_entry.id))
{
dirs_to_expand.push(current_entry.id);
}
if traversal.back_to_parent() {
if let Some(parent_entry) = traversal.entry() {
current_entry = parent_entry.clone();
continue;
}
}
break;
}
}
for dir_to_expand in dirs_to_expand {
project
.update(cx, |project, cx| {
project.expand_entry(worktree_id, dir_to_expand, cx)
})
.unwrap_or_else(|| Task::ready(Ok(())))
.detach_and_log_err(cx)
}
})?
}
outline_panel.update(&mut cx, |outline_panel, cx| {
outline_panel.select_entry(entry_with_selection, false, cx);
outline_panel.update_cached_entries(None, cx);
})?;
anyhow::Ok(())
});
}
fn render_excerpt(
&self,
buffer_id: BufferId,
excerpt_id: ExcerptId,
range: &ExcerptRange<language::Anchor>,
depth: usize,
cx: &mut ViewContext<OutlinePanel>,
) -> Option<Stateful<Div>> {
let item_id = ElementId::from(excerpt_id.to_proto() as usize);
let is_active = match self.selected_entry() {
Some(PanelEntry::Outline(OutlineEntry::Excerpt(
selected_buffer_id,
selected_excerpt_id,
_,
))) => selected_buffer_id == &buffer_id && selected_excerpt_id == &excerpt_id,
_ => false,
};
let has_outlines = self
.excerpts
.get(&buffer_id)
.and_then(|excerpts| match &excerpts.get(&excerpt_id)?.outlines {
ExcerptOutlines::Outlines(outlines) => Some(outlines),
ExcerptOutlines::Invalidated(outlines) => Some(outlines),
ExcerptOutlines::NotFetched => None,
})
.map_or(false, |outlines| !outlines.is_empty());
let is_expanded = !self
.collapsed_entries
.contains(&CollapsedEntry::Excerpt(buffer_id, excerpt_id));
let color = entry_git_aware_label_color(None, false, is_active);
let icon = if has_outlines {
FileIcons::get_chevron_icon(is_expanded, cx)
.map(|icon_path| Icon::from_path(icon_path).color(color).into_any_element())
} else {
None
}
.unwrap_or_else(empty_icon);
let buffer_snapshot = self.buffer_snapshot_for_id(buffer_id, cx)?;
let excerpt_range = range.context.to_point(&buffer_snapshot);
let label_element = Label::new(format!(
"Lines {}- {}",
excerpt_range.start.row + 1,
excerpt_range.end.row + 1,
))
.single_line()
.color(color)
.into_any_element();
Some(self.entry_element(
PanelEntry::Outline(OutlineEntry::Excerpt(buffer_id, excerpt_id, range.clone())),
item_id,
depth,
Some(icon),
is_active,
label_element,
cx,
))
}
fn render_outline(
&self,
buffer_id: BufferId,
excerpt_id: ExcerptId,
rendered_outline: &Outline,
depth: usize,
string_match: Option<&StringMatch>,
cx: &mut ViewContext<Self>,
) -> Stateful<Div> {
let (item_id, label_element) = (
ElementId::from(SharedString::from(format!(
"{buffer_id:?}|{excerpt_id:?}{:?}|{:?}",
rendered_outline.range, &rendered_outline.text,
))),
language::render_item(
rendered_outline,
string_match
.map(|string_match| string_match.ranges().collect::<Vec<_>>())
.unwrap_or_default(),
cx,
)
.into_any_element(),
);
let is_active = match self.selected_entry() {
Some(PanelEntry::Outline(OutlineEntry::Outline(
selected_buffer_id,
selected_excerpt_id,
selected_entry,
))) => {
selected_buffer_id == &buffer_id
&& selected_excerpt_id == &excerpt_id
&& selected_entry == rendered_outline
}
_ => false,
};
let icon = if self.is_singleton_active(cx) {
None
} else {
Some(empty_icon())
};
self.entry_element(
PanelEntry::Outline(OutlineEntry::Outline(
buffer_id,
excerpt_id,
rendered_outline.clone(),
)),
item_id,
depth,
icon,
is_active,
label_element,
cx,
)
}
fn render_entry(
&self,
rendered_entry: &FsEntry,
depth: usize,
string_match: Option<&StringMatch>,
cx: &mut ViewContext<Self>,
) -> Stateful<Div> {
let settings = OutlinePanelSettings::get_global(cx);
let is_active = match self.selected_entry() {
Some(PanelEntry::Fs(selected_entry)) => selected_entry == rendered_entry,
_ => false,
};
let (item_id, label_element, icon) = match rendered_entry {
FsEntry::File(worktree_id, entry, ..) => {
let name = self.entry_name(worktree_id, entry, cx);
let color =
entry_git_aware_label_color(entry.git_status, entry.is_ignored, is_active);
let icon = if settings.file_icons {
FileIcons::get_icon(&entry.path, cx)
.map(|icon_path| Icon::from_path(icon_path).color(color).into_any_element())
} else {
None
};
(
ElementId::from(entry.id.to_proto() as usize),
HighlightedLabel::new(
name,
string_match
.map(|string_match| string_match.positions.clone())
.unwrap_or_default(),
)
.color(color)
.into_any_element(),
icon.unwrap_or_else(empty_icon),
)
}
FsEntry::Directory(worktree_id, entry) => {
let name = self.entry_name(worktree_id, entry, cx);
let is_expanded = !self
.collapsed_entries
.contains(&CollapsedEntry::Dir(*worktree_id, entry.id));
let color =
entry_git_aware_label_color(entry.git_status, entry.is_ignored, is_active);
let icon = if settings.folder_icons {
FileIcons::get_folder_icon(is_expanded, cx)
} else {
FileIcons::get_chevron_icon(is_expanded, cx)
}
.map(Icon::from_path)
.map(|icon| icon.color(color).into_any_element());
(
ElementId::from(entry.id.to_proto() as usize),
HighlightedLabel::new(
name,
string_match
.map(|string_match| string_match.positions.clone())
.unwrap_or_default(),
)
.color(color)
.into_any_element(),
icon.unwrap_or_else(empty_icon),
)
}
FsEntry::ExternalFile(buffer_id, ..) => {
let color = entry_label_color(is_active);
let (icon, name) = match self.buffer_snapshot_for_id(*buffer_id, cx) {
Some(buffer_snapshot) => match buffer_snapshot.file() {
Some(file) => {
let path = file.path();
let icon = if settings.file_icons {
FileIcons::get_icon(path.as_ref(), cx)
} else {
None
}
.map(Icon::from_path)
.map(|icon| icon.color(color).into_any_element());
(icon, file_name(path.as_ref()))
}
None => (None, "Untitled".to_string()),
},
None => (None, "Unknown buffer".to_string()),
};
(
ElementId::from(buffer_id.to_proto() as usize),
HighlightedLabel::new(
name,
string_match
.map(|string_match| string_match.positions.clone())
.unwrap_or_default(),
)
.color(color)
.into_any_element(),
icon.unwrap_or_else(empty_icon),
)
}
};
self.entry_element(
PanelEntry::Fs(rendered_entry.clone()),
item_id,
depth,
Some(icon),
is_active,
label_element,
cx,
)
}
fn render_folded_dirs(
&self,
worktree_id: WorktreeId,
dir_entries: &[Entry],
depth: usize,
string_match: Option<&StringMatch>,
cx: &mut ViewContext<OutlinePanel>,
) -> Stateful<Div> {
let settings = OutlinePanelSettings::get_global(cx);
let is_active = match self.selected_entry() {
Some(PanelEntry::FoldedDirs(selected_worktree_id, selected_entries)) => {
selected_worktree_id == &worktree_id && selected_entries == dir_entries
}
_ => false,
};
let (item_id, label_element, icon) = {
let name = self.dir_names_string(dir_entries, worktree_id, cx);
let is_expanded = dir_entries.iter().all(|dir| {
!self
.collapsed_entries
.contains(&CollapsedEntry::Dir(worktree_id, dir.id))
});
let is_ignored = dir_entries.iter().any(|entry| entry.is_ignored);
let git_status = dir_entries.first().and_then(|entry| entry.git_status);
let color = entry_git_aware_label_color(git_status, is_ignored, is_active);
let icon = if settings.folder_icons {
FileIcons::get_folder_icon(is_expanded, cx)
} else {
FileIcons::get_chevron_icon(is_expanded, cx)
}
.map(Icon::from_path)
.map(|icon| icon.color(color).into_any_element());
(
ElementId::from(
dir_entries
.last()
.map(|entry| entry.id.to_proto())
.unwrap_or_else(|| worktree_id.to_proto()) as usize,
),
HighlightedLabel::new(
name,
string_match
.map(|string_match| string_match.positions.clone())
.unwrap_or_default(),
)
.color(color)
.into_any_element(),
icon.unwrap_or_else(empty_icon),
)
};
self.entry_element(
PanelEntry::FoldedDirs(worktree_id, dir_entries.to_vec()),
item_id,
depth,
Some(icon),
is_active,
label_element,
cx,
)
}
#[allow(clippy::too_many_arguments)]
fn render_search_match(
&mut self,
multi_buffer_snapshot: Option<&MultiBufferSnapshot>,
match_range: &Range<editor::Anchor>,
search_data: &Arc<SearchData>,
kind: SearchKind,
depth: usize,
string_match: Option<&StringMatch>,
cx: &mut ViewContext<Self>,
) -> Stateful<Div> {
if let ItemsDisplayMode::Search(search_state) = &mut self.mode {
if let Some(multi_buffer_snapshot) = multi_buffer_snapshot {
search_state.highlight_search_match(match_range, multi_buffer_snapshot);
}
}
let search_matches = string_match
.iter()
.flat_map(|string_match| string_match.ranges())
.collect::<Vec<_>>();
let match_ranges = if search_matches.is_empty() {
&search_data.search_match_indices
} else {
&search_matches
};
let label_element = language::render_item(
&OutlineItem {
depth,
annotation_range: None,
range: search_data.context_range.clone(),
text: search_data.context_text.clone(),
highlight_ranges: search_data
.highlights_data
.get()
.cloned()
.unwrap_or_default(),
name_ranges: search_data.search_match_indices.clone(),
body_range: Some(search_data.context_range.clone()),
},
match_ranges.iter().cloned(),
cx,
);
let truncated_contents_label = || Label::new(TRUNCATED_CONTEXT_MARK);
let entire_label = h_flex()
.justify_center()
.p_0()
.when(search_data.truncated_left, |parent| {
parent.child(truncated_contents_label())
})
.child(label_element)
.when(search_data.truncated_right, |parent| {
parent.child(truncated_contents_label())
})
.into_any_element();
let is_active = match self.selected_entry() {
Some(PanelEntry::Search(SearchEntry {
match_range: selected_match_range,
..
})) => match_range == selected_match_range,
_ => false,
};
self.entry_element(
PanelEntry::Search(SearchEntry {
kind,
match_range: match_range.clone(),
render_data: Arc::clone(search_data),
}),
ElementId::from(SharedString::from(format!("search-{match_range:?}"))),
depth,
None,
is_active,
entire_label,
cx,
)
}
#[allow(clippy::too_many_arguments)]
fn entry_element(
&self,
rendered_entry: PanelEntry,
item_id: ElementId,
depth: usize,
icon_element: Option<AnyElement>,
is_active: bool,
label_element: gpui::AnyElement,
cx: &mut ViewContext<OutlinePanel>,
) -> Stateful<Div> {
let settings = OutlinePanelSettings::get_global(cx);
div()
.text_ui(cx)
.id(item_id.clone())
.child(
ListItem::new(item_id)
.indent_level(depth)
.indent_step_size(px(settings.indent_size))
.selected(is_active)
.when_some(icon_element, |list_item, icon_element| {
list_item.child(h_flex().child(icon_element))
})
.child(h_flex().h_6().child(label_element).ml_1())
.on_click({
let clicked_entry = rendered_entry.clone();
cx.listener(move |outline_panel, event: &gpui::ClickEvent, cx| {
if event.down.button == MouseButton::Right || event.down.first_mouse {
return;
}
let change_selection = event.down.click_count > 1;
outline_panel.open_entry(&clicked_entry, change_selection, cx);
})
})
.on_secondary_mouse_down(cx.listener(
move |outline_panel, event: &MouseDownEvent, cx| {
// Stop propagation to prevent the catch-all context menu for the project
// panel from being deployed.
cx.stop_propagation();
outline_panel.deploy_context_menu(
event.position,
rendered_entry.clone(),
cx,
)
},
)),
)
.border_1()
.border_r_2()
.rounded_none()
.hover(|style| {
if is_active {
style
} else {
let hover_color = cx.theme().colors().ghost_element_hover;
style.bg(hover_color).border_color(hover_color)
}
})
.when(is_active && self.focus_handle.contains_focused(cx), |div| {
div.border_color(Color::Selected.color(cx))
})
}
fn entry_name(&self, worktree_id: &WorktreeId, entry: &Entry, cx: &AppContext) -> String {
let name = match self.project.read(cx).worktree_for_id(*worktree_id, cx) {
Some(worktree) => {
let worktree = worktree.read(cx);
match worktree.snapshot().root_entry() {
Some(root_entry) => {
if root_entry.id == entry.id {
file_name(worktree.abs_path().as_ref())
} else {
let path = worktree.absolutize(entry.path.as_ref()).ok();
let path = path.as_deref().unwrap_or_else(|| entry.path.as_ref());
file_name(path)
}
}
None => {
let path = worktree.absolutize(entry.path.as_ref()).ok();
let path = path.as_deref().unwrap_or_else(|| entry.path.as_ref());
file_name(path)
}
}
}
None => file_name(entry.path.as_ref()),
};
name
}
fn update_fs_entries(
&mut self,
active_editor: &View<Editor>,
new_entries: HashSet<ExcerptId>,
debounce: Option<Duration>,
cx: &mut ViewContext<Self>,
) {
if !self.active {
return;
}
let auto_fold_dirs = OutlinePanelSettings::get_global(cx).auto_fold_dirs;
let active_multi_buffer = active_editor.read(cx).buffer().clone();
let multi_buffer_snapshot = active_multi_buffer.read(cx).snapshot(cx);
let mut new_collapsed_entries = self.collapsed_entries.clone();
let mut new_unfolded_dirs = self.unfolded_dirs.clone();
let mut root_entries = HashSet::default();
let mut new_excerpts = HashMap::<BufferId, HashMap<ExcerptId, Excerpt>>::default();
let buffer_excerpts = multi_buffer_snapshot.excerpts().fold(
HashMap::default(),
|mut buffer_excerpts, (excerpt_id, buffer_snapshot, excerpt_range)| {
let buffer_id = buffer_snapshot.remote_id();
let file = File::from_dyn(buffer_snapshot.file());
let entry_id = file.and_then(|file| file.project_entry_id(cx));
let worktree = file.map(|file| file.worktree.read(cx).snapshot());
let is_new =
new_entries.contains(&excerpt_id) || !self.excerpts.contains_key(&buffer_id);
buffer_excerpts
.entry(buffer_id)
.or_insert_with(|| (is_new, Vec::new(), entry_id, worktree))
.1
.push(excerpt_id);
let outlines = match self
.excerpts
.get(&buffer_id)
.and_then(|excerpts| excerpts.get(&excerpt_id))
{
Some(old_excerpt) => match &old_excerpt.outlines {
ExcerptOutlines::Outlines(outlines) => {
ExcerptOutlines::Outlines(outlines.clone())
}
ExcerptOutlines::Invalidated(_) => ExcerptOutlines::NotFetched,
ExcerptOutlines::NotFetched => ExcerptOutlines::NotFetched,
},
None => ExcerptOutlines::NotFetched,
};
new_excerpts.entry(buffer_id).or_default().insert(
excerpt_id,
Excerpt {
range: excerpt_range,
outlines,
},
);
buffer_excerpts
},
);
self.updating_fs_entries = true;
self.fs_entries_update_task = cx.spawn(|outline_panel, mut cx| async move {
if let Some(debounce) = debounce {
cx.background_executor().timer(debounce).await;
}
let Some((
new_collapsed_entries,
new_unfolded_dirs,
new_fs_entries,
new_depth_map,
new_children_count,
)) = cx
.background_executor()
.spawn(async move {
let mut processed_external_buffers = HashSet::default();
let mut new_worktree_entries =
HashMap::<WorktreeId, (worktree::Snapshot, HashSet<Entry>)>::default();
let mut worktree_excerpts = HashMap::<
WorktreeId,
HashMap<ProjectEntryId, (BufferId, Vec<ExcerptId>)>,
>::default();
let mut external_excerpts = HashMap::default();
for (buffer_id, (is_new, excerpts, entry_id, worktree)) in buffer_excerpts {
if is_new {
match &worktree {
Some(worktree) => {
new_collapsed_entries
.remove(&CollapsedEntry::File(worktree.id(), buffer_id));
}
None => {
new_collapsed_entries
.remove(&CollapsedEntry::ExternalFile(buffer_id));
}
}
}
if let Some(worktree) = worktree {
let worktree_id = worktree.id();
let unfolded_dirs = new_unfolded_dirs.entry(worktree_id).or_default();
match entry_id.and_then(|id| worktree.entry_for_id(id)).cloned() {
Some(entry) => {
let mut traversal = worktree.traverse_from_path(
true,
true,
true,
entry.path.as_ref(),
);
let mut entries_to_add = HashSet::default();
worktree_excerpts
.entry(worktree_id)
.or_default()
.insert(entry.id, (buffer_id, excerpts));
let mut current_entry = entry;
loop {
if current_entry.is_dir() {
let is_root =
worktree.root_entry().map(|entry| entry.id)
== Some(current_entry.id);
if is_root {
root_entries.insert(current_entry.id);
if auto_fold_dirs {
unfolded_dirs.insert(current_entry.id);
}
}
if is_new {
new_collapsed_entries.remove(&CollapsedEntry::Dir(
worktree_id,
current_entry.id,
));
}
}
let new_entry_added = entries_to_add.insert(current_entry);
if new_entry_added && traversal.back_to_parent() {
if let Some(parent_entry) = traversal.entry() {
current_entry = parent_entry.clone();
continue;
}
}
break;
}
new_worktree_entries
.entry(worktree_id)
.or_insert_with(|| (worktree.clone(), HashSet::default()))
.1
.extend(entries_to_add);
}
None => {
if processed_external_buffers.insert(buffer_id) {
external_excerpts
.entry(buffer_id)
.or_insert_with(Vec::new)
.extend(excerpts);
}
}
}
} else if processed_external_buffers.insert(buffer_id) {
external_excerpts
.entry(buffer_id)
.or_insert_with(Vec::new)
.extend(excerpts);
}
}
let mut new_children_count =
HashMap::<WorktreeId, HashMap<Arc<Path>, FsChildren>>::default();
let worktree_entries = new_worktree_entries
.into_iter()
.map(|(worktree_id, (worktree_snapshot, entries))| {
let mut entries = entries.into_iter().collect::<Vec<_>>();
// For a proper git status propagation, we have to keep the entries sorted lexicographically.
entries.sort_by(|a, b| a.path.as_ref().cmp(b.path.as_ref()));
worktree_snapshot.propagate_git_statuses(&mut entries);
project::sort_worktree_entries(&mut entries);
(worktree_id, entries)
})
.flat_map(|(worktree_id, entries)| {
{
entries
.into_iter()
.filter_map(|entry| {
if auto_fold_dirs {
if let Some(parent) = entry.path.parent() {
let children = new_children_count
.entry(worktree_id)
.or_default()
.entry(Arc::from(parent))
.or_default();
if entry.is_dir() {
children.dirs += 1;
} else {
children.files += 1;
}
}
}
if entry.is_dir() {
Some(FsEntry::Directory(worktree_id, entry))
} else {
let (buffer_id, excerpts) = worktree_excerpts
.get_mut(&worktree_id)
.and_then(|worktree_excerpts| {
worktree_excerpts.remove(&entry.id)
})?;
Some(FsEntry::File(
worktree_id,
entry,
buffer_id,
excerpts,
))
}
})
.collect::<Vec<_>>()
}
})
.collect::<Vec<_>>();
let mut visited_dirs = Vec::new();
let mut new_depth_map = HashMap::default();
let new_visible_entries = external_excerpts
.into_iter()
.sorted_by_key(|(id, _)| *id)
.map(|(buffer_id, excerpts)| FsEntry::ExternalFile(buffer_id, excerpts))
.chain(worktree_entries)
.filter(|visible_item| {
match visible_item {
FsEntry::Directory(worktree_id, dir_entry) => {
let parent_id = back_to_common_visited_parent(
&mut visited_dirs,
worktree_id,
dir_entry,
);
let depth = if root_entries.contains(&dir_entry.id) {
0
} else {
if auto_fold_dirs {
let children = new_children_count
.get(worktree_id)
.and_then(|children_count| {
children_count.get(&dir_entry.path)
})
.copied()
.unwrap_or_default();
if !children.may_be_fold_part()
|| (children.dirs == 0
&& visited_dirs
.last()
.map(|(parent_dir_id, _)| {
new_unfolded_dirs
.get(worktree_id)
.map_or(true, |unfolded_dirs| {
unfolded_dirs
.contains(parent_dir_id)
})
})
.unwrap_or(true))
{
new_unfolded_dirs
.entry(*worktree_id)
.or_default()
.insert(dir_entry.id);
}
}
parent_id
.and_then(|(worktree_id, id)| {
new_depth_map.get(&(worktree_id, id)).copied()
})
.unwrap_or(0)
+ 1
};
visited_dirs.push((dir_entry.id, dir_entry.path.clone()));
new_depth_map.insert((*worktree_id, dir_entry.id), depth);
}
FsEntry::File(worktree_id, file_entry, ..) => {
let parent_id = back_to_common_visited_parent(
&mut visited_dirs,
worktree_id,
file_entry,
);
let depth = if root_entries.contains(&file_entry.id) {
0
} else {
parent_id
.and_then(|(worktree_id, id)| {
new_depth_map.get(&(worktree_id, id)).copied()
})
.unwrap_or(0)
+ 1
};
new_depth_map.insert((*worktree_id, file_entry.id), depth);
}
FsEntry::ExternalFile(..) => {
visited_dirs.clear();
}
}
true
})
.collect::<Vec<_>>();
anyhow::Ok((
new_collapsed_entries,
new_unfolded_dirs,
new_visible_entries,
new_depth_map,
new_children_count,
))
})
.await
.log_err()
else {
return;
};
outline_panel
.update(&mut cx, |outline_panel, cx| {
outline_panel.updating_fs_entries = false;
outline_panel.excerpts = new_excerpts;
outline_panel.collapsed_entries = new_collapsed_entries;
outline_panel.unfolded_dirs = new_unfolded_dirs;
outline_panel.fs_entries = new_fs_entries;
outline_panel.fs_entries_depth = new_depth_map;
outline_panel.fs_children_count = new_children_count;
outline_panel.update_cached_entries(Some(UPDATE_DEBOUNCE), cx);
outline_panel.update_non_fs_items(cx);
cx.notify();
})
.ok();
});
}
fn replace_active_editor(
&mut self,
new_active_item: Box<dyn ItemHandle>,
new_active_editor: View<Editor>,
cx: &mut ViewContext<Self>,
) {
self.clear_previous(cx);
let buffer_search_subscription = cx.subscribe(
&new_active_editor,
|outline_panel: &mut Self, _, e: &SearchEvent, cx: &mut ViewContext<'_, Self>| {
if matches!(e, SearchEvent::MatchesInvalidated) {
outline_panel.update_search_matches(cx);
};
outline_panel.autoscroll(cx);
},
);
self.active_item = Some(ActiveItem {
_buffer_search_subscription: buffer_search_subscription,
_editor_subscrpiption: subscribe_for_editor_events(&new_active_editor, cx),
item_handle: new_active_item.downgrade_item(),
active_editor: new_active_editor.downgrade(),
});
let new_entries =
HashSet::from_iter(new_active_editor.read(cx).buffer().read(cx).excerpt_ids());
self.selected_entry.invalidate();
self.update_fs_entries(&new_active_editor, new_entries, None, cx);
}
fn clear_previous(&mut self, cx: &mut WindowContext<'_>) {
self.filter_editor.update(cx, |editor, cx| editor.clear(cx));
self.collapsed_entries.clear();
self.unfolded_dirs.clear();
self.selected_entry = SelectedEntry::None;
self.fs_entries_update_task = Task::ready(());
self.cached_entries_update_task = Task::ready(());
self.active_item = None;
self.fs_entries.clear();
self.fs_entries_depth.clear();
self.fs_children_count.clear();
self.outline_fetch_tasks.clear();
self.excerpts.clear();
self.cached_entries = Vec::new();
self.pinned = false;
self.mode = ItemsDisplayMode::Outline;
}
fn location_for_editor_selection(
&mut self,
editor: &View<Editor>,
cx: &mut ViewContext<Self>,
) -> Option<PanelEntry> {
let selection = editor
.read(cx)
.selections
.newest::<language::Point>(cx)
.head();
let editor_snapshot = editor.update(cx, |editor, cx| editor.snapshot(cx));
let multi_buffer = editor.read(cx).buffer();
let multi_buffer_snapshot = multi_buffer.read(cx).snapshot(cx);
let (excerpt_id, buffer, _) = editor
.read(cx)
.buffer()
.read(cx)
.excerpt_containing(selection, cx)?;
let buffer_id = buffer.read(cx).remote_id();
let selection_display_point = selection.to_display_point(&editor_snapshot);
match &self.mode {
ItemsDisplayMode::Search(search_state) => search_state
.matches
.iter()
.rev()
.min_by_key(|&(match_range, _)| {
let match_display_range =
match_range.clone().to_display_points(&editor_snapshot);
let start_distance = if selection_display_point < match_display_range.start {
match_display_range.start - selection_display_point
} else {
selection_display_point - match_display_range.start
};
let end_distance = if selection_display_point < match_display_range.end {
match_display_range.end - selection_display_point
} else {
selection_display_point - match_display_range.end
};
start_distance + end_distance
})
.and_then(|(closest_range, _)| {
self.cached_entries.iter().find_map(|cached_entry| {
if let PanelEntry::Search(SearchEntry { match_range, .. }) =
&cached_entry.entry
{
if match_range == closest_range {
Some(cached_entry.entry.clone())
} else {
None
}
} else {
None
}
})
}),
ItemsDisplayMode::Outline => self.outline_location(
buffer_id,
excerpt_id,
multi_buffer_snapshot,
editor_snapshot,
selection_display_point,
),
}
}
fn outline_location(
&mut self,
buffer_id: BufferId,
excerpt_id: ExcerptId,
multi_buffer_snapshot: editor::MultiBufferSnapshot,
editor_snapshot: editor::EditorSnapshot,
selection_display_point: DisplayPoint,
) -> Option<PanelEntry> {
let excerpt_outlines = self
.excerpts
.get(&buffer_id)
.and_then(|excerpts| excerpts.get(&excerpt_id))
.into_iter()
.flat_map(|excerpt| excerpt.iter_outlines())
.flat_map(|outline| {
let start = multi_buffer_snapshot
.anchor_in_excerpt(excerpt_id, outline.range.start)?
.to_display_point(&editor_snapshot);
let end = multi_buffer_snapshot
.anchor_in_excerpt(excerpt_id, outline.range.end)?
.to_display_point(&editor_snapshot);
Some((start..end, outline))
})
.collect::<Vec<_>>();
let mut matching_outline_indices = Vec::new();
let mut children = HashMap::default();
let mut parents_stack = Vec::<(&Range<DisplayPoint>, &&Outline, usize)>::new();
for (i, (outline_range, outline)) in excerpt_outlines.iter().enumerate() {
if outline_range
.to_inclusive()
.contains(&selection_display_point)
{
matching_outline_indices.push(i);
} else if (outline_range.start.row()..outline_range.end.row())
.to_inclusive()
.contains(&selection_display_point.row())
{
matching_outline_indices.push(i);
}
while let Some((parent_range, parent_outline, _)) = parents_stack.last() {
if parent_outline.depth >= outline.depth
|| !parent_range.contains(&outline_range.start)
{
parents_stack.pop();
} else {
break;
}
}
if let Some((_, _, parent_index)) = parents_stack.last_mut() {
children
.entry(*parent_index)
.or_insert_with(Vec::new)
.push(i);
}
parents_stack.push((outline_range, outline, i));
}
let outline_item = matching_outline_indices
.into_iter()
.flat_map(|i| Some((i, excerpt_outlines.get(i)?)))
.filter(|(i, _)| {
children
.get(i)
.map(|children| {
children.iter().all(|child_index| {
excerpt_outlines
.get(*child_index)
.map(|(child_range, _)| child_range.start > selection_display_point)
.unwrap_or(false)
})
})
.unwrap_or(true)
})
.min_by_key(|(_, (outline_range, outline))| {
let distance_from_start = if outline_range.start > selection_display_point {
outline_range.start - selection_display_point
} else {
selection_display_point - outline_range.start
};
let distance_from_end = if outline_range.end > selection_display_point {
outline_range.end - selection_display_point
} else {
selection_display_point - outline_range.end
};
(
cmp::Reverse(outline.depth),
distance_from_start + distance_from_end,
)
})
.map(|(_, (_, outline))| *outline)
.cloned();
let closest_container = match outline_item {
Some(outline) => {
PanelEntry::Outline(OutlineEntry::Outline(buffer_id, excerpt_id, outline))
}
None => {
self.cached_entries.iter().rev().find_map(|cached_entry| {
match &cached_entry.entry {
PanelEntry::Outline(OutlineEntry::Excerpt(
entry_buffer_id,
entry_excerpt_id,
_,
)) => {
if entry_buffer_id == &buffer_id && entry_excerpt_id == &excerpt_id {
Some(cached_entry.entry.clone())
} else {
None
}
}
PanelEntry::Fs(
FsEntry::ExternalFile(file_buffer_id, file_excerpts)
| FsEntry::File(_, _, file_buffer_id, file_excerpts),
) => {
if file_buffer_id == &buffer_id && file_excerpts.contains(&excerpt_id) {
Some(cached_entry.entry.clone())
} else {
None
}
}
_ => None,
}
})?
}
};
Some(closest_container)
}
fn fetch_outdated_outlines(&mut self, cx: &mut ViewContext<Self>) {
let excerpt_fetch_ranges = self.excerpt_fetch_ranges(cx);
if excerpt_fetch_ranges.is_empty() {
return;
}
let syntax_theme = cx.theme().syntax().clone();
for (buffer_id, (buffer_snapshot, excerpt_ranges)) in excerpt_fetch_ranges {
for (excerpt_id, excerpt_range) in excerpt_ranges {
let syntax_theme = syntax_theme.clone();
let buffer_snapshot = buffer_snapshot.clone();
self.outline_fetch_tasks.insert(
(buffer_id, excerpt_id),
cx.spawn(|outline_panel, mut cx| async move {
let fetched_outlines = cx
.background_executor()
.spawn(async move {
buffer_snapshot
.outline_items_containing(
excerpt_range.context,
false,
Some(&syntax_theme),
)
.unwrap_or_default()
})
.await;
outline_panel
.update(&mut cx, |outline_panel, cx| {
if let Some(excerpt) = outline_panel
.excerpts
.entry(buffer_id)
.or_default()
.get_mut(&excerpt_id)
{
excerpt.outlines = ExcerptOutlines::Outlines(fetched_outlines);
}
outline_panel.update_cached_entries(Some(UPDATE_DEBOUNCE), cx);
})
.ok();
}),
);
}
}
}
fn is_singleton_active(&self, cx: &AppContext) -> bool {
self.active_editor().map_or(false, |active_editor| {
active_editor.read(cx).buffer().read(cx).is_singleton()
})
}
fn invalidate_outlines(&mut self, ids: &[ExcerptId]) {
self.outline_fetch_tasks.clear();
let mut ids = ids.iter().collect::<HashSet<_>>();
for excerpts in self.excerpts.values_mut() {
ids.retain(|id| {
if let Some(excerpt) = excerpts.get_mut(id) {
excerpt.invalidate_outlines();
false
} else {
true
}
});
if ids.is_empty() {
break;
}
}
}
fn excerpt_fetch_ranges(
&self,
cx: &AppContext,
) -> HashMap<
BufferId,
(
BufferSnapshot,
HashMap<ExcerptId, ExcerptRange<language::Anchor>>,
),
> {
self.fs_entries
.iter()
.fold(HashMap::default(), |mut excerpts_to_fetch, fs_entry| {
match fs_entry {
FsEntry::File(_, _, buffer_id, file_excerpts)
| FsEntry::ExternalFile(buffer_id, file_excerpts) => {
let excerpts = self.excerpts.get(buffer_id);
for &file_excerpt in file_excerpts {
if let Some(excerpt) = excerpts
.and_then(|excerpts| excerpts.get(&file_excerpt))
.filter(|excerpt| excerpt.should_fetch_outlines())
{
match excerpts_to_fetch.entry(*buffer_id) {
hash_map::Entry::Occupied(mut o) => {
o.get_mut().1.insert(file_excerpt, excerpt.range.clone());
}
hash_map::Entry::Vacant(v) => {
if let Some(buffer_snapshot) =
self.buffer_snapshot_for_id(*buffer_id, cx)
{
v.insert((buffer_snapshot, HashMap::default()))
.1
.insert(file_excerpt, excerpt.range.clone());
}
}
}
}
}
}
FsEntry::Directory(..) => {}
}
excerpts_to_fetch
})
}
fn buffer_snapshot_for_id(
&self,
buffer_id: BufferId,
cx: &AppContext,
) -> Option<BufferSnapshot> {
let editor = self.active_editor()?;
Some(
editor
.read(cx)
.buffer()
.read(cx)
.buffer(buffer_id)?
.read(cx)
.snapshot(),
)
}
fn abs_path(&self, entry: &PanelEntry, cx: &AppContext) -> Option<PathBuf> {
match entry {
PanelEntry::Fs(
FsEntry::File(_, _, buffer_id, _) | FsEntry::ExternalFile(buffer_id, _),
) => self
.buffer_snapshot_for_id(*buffer_id, cx)
.and_then(|buffer_snapshot| {
let file = File::from_dyn(buffer_snapshot.file())?;
file.worktree.read(cx).absolutize(&file.path).ok()
}),
PanelEntry::Fs(FsEntry::Directory(worktree_id, entry)) => self
.project
.read(cx)
.worktree_for_id(*worktree_id, cx)?
.read(cx)
.absolutize(&entry.path)
.ok(),
PanelEntry::FoldedDirs(worktree_id, dirs) => dirs.last().and_then(|entry| {
self.project
.read(cx)
.worktree_for_id(*worktree_id, cx)
.and_then(|worktree| worktree.read(cx).absolutize(&entry.path).ok())
}),
PanelEntry::Search(_) | PanelEntry::Outline(..) => None,
}
}
fn relative_path(&self, entry: &FsEntry, cx: &AppContext) -> Option<Arc<Path>> {
match entry {
FsEntry::ExternalFile(buffer_id, _) => {
let buffer_snapshot = self.buffer_snapshot_for_id(*buffer_id, cx)?;
Some(buffer_snapshot.file()?.path().clone())
}
FsEntry::Directory(_, entry) => Some(entry.path.clone()),
FsEntry::File(_, entry, ..) => Some(entry.path.clone()),
}
}
fn update_cached_entries(
&mut self,
debounce: Option<Duration>,
cx: &mut ViewContext<OutlinePanel>,
) {
if !self.active {
return;
}
let is_singleton = self.is_singleton_active(cx);
let query = self.query(cx);
self.cached_entries_update_task = cx.spawn(|outline_panel, mut cx| async move {
if let Some(debounce) = debounce {
cx.background_executor().timer(debounce).await;
}
let Some(new_cached_entries) = outline_panel
.update(&mut cx, |outline_panel, cx| {
outline_panel.generate_cached_entries(is_singleton, query, cx)
})
.ok()
else {
return;
};
let new_cached_entries = new_cached_entries.await;
outline_panel
.update(&mut cx, |outline_panel, cx| {
outline_panel.cached_entries = new_cached_entries;
if outline_panel.selected_entry.is_invalidated() {
if let Some(new_selected_entry) =
outline_panel.active_editor().and_then(|active_editor| {
outline_panel.location_for_editor_selection(&active_editor, cx)
})
{
outline_panel.select_entry(new_selected_entry, false, cx);
}
}
outline_panel.autoscroll(cx);
cx.notify();
})
.ok();
});
}
fn generate_cached_entries(
&self,
is_singleton: bool,
query: Option<String>,
cx: &mut ViewContext<'_, Self>,
) -> Task<Vec<CachedEntry>> {
let project = self.project.clone();
cx.spawn(|outline_panel, mut cx| async move {
let mut entries = Vec::new();
let mut match_candidates = Vec::new();
let Ok(()) = outline_panel.update(&mut cx, |outline_panel, cx| {
let auto_fold_dirs = OutlinePanelSettings::get_global(cx).auto_fold_dirs;
let mut folded_dirs_entry = None::<(usize, WorktreeId, Vec<Entry>)>;
let track_matches = query.is_some();
#[derive(Debug)]
struct ParentStats {
path: Arc<Path>,
folded: bool,
expanded: bool,
depth: usize,
}
let mut parent_dirs = Vec::<ParentStats>::new();
for entry in outline_panel.fs_entries.clone() {
let is_expanded = outline_panel.is_expanded(&entry);
let (depth, should_add) = match &entry {
FsEntry::Directory(worktree_id, dir_entry) => {
let mut should_add = true;
let is_root = project
.read(cx)
.worktree_for_id(*worktree_id, cx)
.map_or(false, |worktree| {
worktree.read(cx).root_entry() == Some(dir_entry)
});
let folded = auto_fold_dirs
&& !is_root
&& outline_panel
.unfolded_dirs
.get(worktree_id)
.map_or(true, |unfolded_dirs| {
!unfolded_dirs.contains(&dir_entry.id)
});
let fs_depth = outline_panel
.fs_entries_depth
.get(&(*worktree_id, dir_entry.id))
.copied()
.unwrap_or(0);
while let Some(parent) = parent_dirs.last() {
if dir_entry.path.starts_with(&parent.path) {
break;
}
parent_dirs.pop();
}
let auto_fold = match parent_dirs.last() {
Some(parent) => {
parent.folded
&& Some(parent.path.as_ref()) == dir_entry.path.parent()
&& outline_panel
.fs_children_count
.get(worktree_id)
.and_then(|entries| entries.get(&dir_entry.path))
.copied()
.unwrap_or_default()
.may_be_fold_part()
}
None => false,
};
let folded = folded || auto_fold;
let (depth, parent_expanded, parent_folded) = match parent_dirs.last() {
Some(parent) => {
let parent_folded = parent.folded;
let parent_expanded = parent.expanded;
let new_depth = if parent_folded {
parent.depth
} else {
parent.depth + 1
};
parent_dirs.push(ParentStats {
path: dir_entry.path.clone(),
folded,
expanded: parent_expanded && is_expanded,
depth: new_depth,
});
(new_depth, parent_expanded, parent_folded)
}
None => {
parent_dirs.push(ParentStats {
path: dir_entry.path.clone(),
folded,
expanded: is_expanded,
depth: fs_depth,
});
(fs_depth, true, false)
}
};
if let Some((folded_depth, folded_worktree_id, mut folded_dirs)) =
folded_dirs_entry.take()
{
if folded
&& worktree_id == &folded_worktree_id
&& dir_entry.path.parent()
== folded_dirs.last().map(|entry| entry.path.as_ref())
{
folded_dirs.push(dir_entry.clone());
folded_dirs_entry =
Some((folded_depth, folded_worktree_id, folded_dirs))
} else {
if !is_singleton {
let start_of_collapsed_dir_sequence = !parent_expanded
&& parent_dirs
.iter()
.rev()
.nth(folded_dirs.len() + 1)
.map_or(true, |parent| parent.expanded);
if start_of_collapsed_dir_sequence
|| parent_expanded
|| query.is_some()
{
if parent_folded {
folded_dirs.push(dir_entry.clone());
should_add = false;
}
let new_folded_dirs = PanelEntry::FoldedDirs(
folded_worktree_id,
folded_dirs,
);
outline_panel.push_entry(
&mut entries,
&mut match_candidates,
track_matches,
new_folded_dirs,
folded_depth,
cx,
);
}
}
folded_dirs_entry = if parent_folded {
None
} else {
Some((depth, *worktree_id, vec![dir_entry.clone()]))
};
}
} else if folded {
folded_dirs_entry =
Some((depth, *worktree_id, vec![dir_entry.clone()]));
}
let should_add =
should_add && parent_expanded && folded_dirs_entry.is_none();
(depth, should_add)
}
FsEntry::ExternalFile(..) => {
if let Some((folded_depth, worktree_id, folded_dirs)) =
folded_dirs_entry.take()
{
let parent_expanded = parent_dirs
.iter()
.rev()
.find(|parent| {
folded_dirs.iter().all(|entry| entry.path != parent.path)
})
.map_or(true, |parent| parent.expanded);
if !is_singleton && (parent_expanded || query.is_some()) {
outline_panel.push_entry(
&mut entries,
&mut match_candidates,
track_matches,
PanelEntry::FoldedDirs(worktree_id, folded_dirs),
folded_depth,
cx,
);
}
}
parent_dirs.clear();
(0, true)
}
FsEntry::File(worktree_id, file_entry, ..) => {
if let Some((folded_depth, worktree_id, folded_dirs)) =
folded_dirs_entry.take()
{
let parent_expanded = parent_dirs
.iter()
.rev()
.find(|parent| {
folded_dirs.iter().all(|entry| entry.path != parent.path)
})
.map_or(true, |parent| parent.expanded);
if !is_singleton && (parent_expanded || query.is_some()) {
outline_panel.push_entry(
&mut entries,
&mut match_candidates,
track_matches,
PanelEntry::FoldedDirs(worktree_id, folded_dirs),
folded_depth,
cx,
);
}
}
let fs_depth = outline_panel
.fs_entries_depth
.get(&(*worktree_id, file_entry.id))
.copied()
.unwrap_or(0);
while let Some(parent) = parent_dirs.last() {
if file_entry.path.starts_with(&parent.path) {
break;
}
parent_dirs.pop();
}
let (depth, should_add) = match parent_dirs.last() {
Some(parent) => {
let new_depth = parent.depth + 1;
(new_depth, parent.expanded)
}
None => (fs_depth, true),
};
(depth, should_add)
}
};
if !is_singleton
&& (should_add || (query.is_some() && folded_dirs_entry.is_none()))
{
outline_panel.push_entry(
&mut entries,
&mut match_candidates,
track_matches,
PanelEntry::Fs(entry.clone()),
depth,
cx,
);
}
match outline_panel.mode {
ItemsDisplayMode::Search(_) => {
if is_singleton || query.is_some() || (should_add && is_expanded) {
outline_panel.add_search_entries(
&mut entries,
&mut match_candidates,
entry.clone(),
depth,
query.clone(),
is_singleton,
cx,
);
}
}
ItemsDisplayMode::Outline => {
let excerpts_to_consider =
if is_singleton || query.is_some() || (should_add && is_expanded) {
match &entry {
FsEntry::File(_, _, buffer_id, entry_excerpts) => {
Some((*buffer_id, entry_excerpts))
}
FsEntry::ExternalFile(buffer_id, entry_excerpts) => {
Some((*buffer_id, entry_excerpts))
}
_ => None,
}
} else {
None
};
if let Some((buffer_id, entry_excerpts)) = excerpts_to_consider {
outline_panel.add_excerpt_entries(
buffer_id,
entry_excerpts,
depth,
track_matches,
is_singleton,
query.as_deref(),
&mut entries,
&mut match_candidates,
cx,
);
}
}
}
if is_singleton
&& matches!(entry, FsEntry::File(..) | FsEntry::ExternalFile(..))
&& !entries.iter().any(|item| {
matches!(item.entry, PanelEntry::Outline(..) | PanelEntry::Search(_))
})
{
outline_panel.push_entry(
&mut entries,
&mut match_candidates,
track_matches,
PanelEntry::Fs(entry.clone()),
0,
cx,
);
}
}
if let Some((folded_depth, worktree_id, folded_dirs)) = folded_dirs_entry.take() {
let parent_expanded = parent_dirs
.iter()
.rev()
.find(|parent| folded_dirs.iter().all(|entry| entry.path != parent.path))
.map_or(true, |parent| parent.expanded);
if parent_expanded || query.is_some() {
outline_panel.push_entry(
&mut entries,
&mut match_candidates,
track_matches,
PanelEntry::FoldedDirs(worktree_id, folded_dirs),
folded_depth,
cx,
);
}
}
}) else {
return Vec::new();
};
let Some(query) = query else {
return entries;
};
let mut matched_ids = match_strings(
&match_candidates,
&query,
true,
usize::MAX,
&AtomicBool::default(),
cx.background_executor().clone(),
)
.await
.into_iter()
.map(|string_match| (string_match.candidate_id, string_match))
.collect::<HashMap<_, _>>();
let mut id = 0;
entries.retain_mut(|cached_entry| {
let retain = match matched_ids.remove(&id) {
Some(string_match) => {
cached_entry.string_match = Some(string_match);
true
}
None => false,
};
id += 1;
retain
});
entries
})
}
#[allow(clippy::too_many_arguments)]
fn push_entry(
&self,
entries: &mut Vec<CachedEntry>,
match_candidates: &mut Vec<StringMatchCandidate>,
track_matches: bool,
entry: PanelEntry,
depth: usize,
cx: &mut WindowContext,
) {
let entry = if let PanelEntry::FoldedDirs(worktree_id, entries) = &entry {
match entries.len() {
0 => {
debug_panic!("Empty folded dirs receiver");
return;
}
1 => PanelEntry::Fs(FsEntry::Directory(*worktree_id, entries[0].clone())),
_ => entry,
}
} else {
entry
};
if track_matches {
let id = entries.len();
match &entry {
PanelEntry::Fs(fs_entry) => {
if let Some(file_name) =
self.relative_path(fs_entry, cx).as_deref().map(file_name)
{
match_candidates.push(StringMatchCandidate {
id,
string: file_name.to_string(),
char_bag: file_name.chars().collect(),
});
}
}
PanelEntry::FoldedDirs(worktree_id, entries) => {
let dir_names = self.dir_names_string(entries, *worktree_id, cx);
{
match_candidates.push(StringMatchCandidate {
id,
string: dir_names.clone(),
char_bag: dir_names.chars().collect(),
});
}
}
PanelEntry::Outline(outline_entry) => match outline_entry {
OutlineEntry::Outline(_, _, outline) => {
match_candidates.push(StringMatchCandidate {
id,
string: outline.text.clone(),
char_bag: outline.text.chars().collect(),
});
}
OutlineEntry::Excerpt(..) => {}
},
PanelEntry::Search(new_search_entry) => {
match_candidates.push(StringMatchCandidate {
id,
char_bag: new_search_entry.render_data.context_text.chars().collect(),
string: new_search_entry.render_data.context_text.clone(),
});
}
}
}
entries.push(CachedEntry {
depth,
entry,
string_match: None,
});
}
fn dir_names_string(
&self,
entries: &[Entry],
worktree_id: WorktreeId,
cx: &AppContext,
) -> String {
let dir_names_segment = entries
.iter()
.map(|entry| self.entry_name(&worktree_id, entry, cx))
.collect::<PathBuf>();
dir_names_segment.to_string_lossy().to_string()
}
fn query(&self, cx: &AppContext) -> Option<String> {
let query = self.filter_editor.read(cx).text(cx);
if query.trim().is_empty() {
None
} else {
Some(query)
}
}
fn is_expanded(&self, entry: &FsEntry) -> bool {
let entry_to_check = match entry {
FsEntry::ExternalFile(buffer_id, _) => CollapsedEntry::ExternalFile(*buffer_id),
FsEntry::File(worktree_id, _, buffer_id, _) => {
CollapsedEntry::File(*worktree_id, *buffer_id)
}
FsEntry::Directory(worktree_id, entry) => CollapsedEntry::Dir(*worktree_id, entry.id),
};
!self.collapsed_entries.contains(&entry_to_check)
}
fn update_non_fs_items(&mut self, cx: &mut ViewContext<OutlinePanel>) {
if !self.active {
return;
}
self.update_search_matches(cx);
self.fetch_outdated_outlines(cx);
self.autoscroll(cx);
}
fn update_search_matches(&mut self, cx: &mut ViewContext<OutlinePanel>) {
if !self.active {
return;
}
let project_search = self
.active_item()
.and_then(|item| item.downcast::<ProjectSearchView>());
let project_search_matches = project_search
.as_ref()
.map(|project_search| project_search.read(cx).get_matches(cx))
.unwrap_or_default();
let buffer_search = self
.active_item()
.as_deref()
.and_then(|active_item| {
self.workspace
.upgrade()
.and_then(|workspace| workspace.read(cx).pane_for(active_item))
})
.and_then(|pane| {
pane.read(cx)
.toolbar()
.read(cx)
.item_of_type::<BufferSearchBar>()
});
let buffer_search_matches = self
.active_editor()
.map(|active_editor| active_editor.update(cx, |editor, cx| editor.get_matches(cx)))
.unwrap_or_default();
let mut update_cached_entries = false;
if buffer_search_matches.is_empty() && project_search_matches.is_empty() {
if matches!(self.mode, ItemsDisplayMode::Search(_)) {
self.mode = ItemsDisplayMode::Outline;
update_cached_entries = true;
}
} else {
let (kind, new_search_matches, new_search_query) = if buffer_search_matches.is_empty() {
(
SearchKind::Project,
project_search_matches,
project_search
.map(|project_search| project_search.read(cx).search_query_text(cx))
.unwrap_or_default(),
)
} else {
(
SearchKind::Buffer,
buffer_search_matches,
buffer_search
.map(|buffer_search| buffer_search.read(cx).query(cx))
.unwrap_or_default(),
)
};
update_cached_entries = match &self.mode {
ItemsDisplayMode::Search(current_search_state) => {
current_search_state.query != new_search_query
|| current_search_state.kind != kind
|| current_search_state.matches.is_empty()
|| current_search_state.matches.iter().enumerate().any(
|(i, (match_range, _))| new_search_matches.get(i) != Some(match_range),
)
}
ItemsDisplayMode::Outline => true,
};
self.mode = ItemsDisplayMode::Search(SearchState::new(
kind,
new_search_query,
new_search_matches,
cx.theme().syntax().clone(),
cx,
));
}
if update_cached_entries {
self.selected_entry.invalidate();
self.update_cached_entries(Some(UPDATE_DEBOUNCE), cx);
}
}
#[allow(clippy::too_many_arguments)]
fn add_excerpt_entries(
&self,
buffer_id: BufferId,
entries_to_add: &[ExcerptId],
parent_depth: usize,
track_matches: bool,
is_singleton: bool,
query: Option<&str>,
entries: &mut Vec<CachedEntry>,
match_candidates: &mut Vec<StringMatchCandidate>,
cx: &mut ViewContext<Self>,
) {
if let Some(excerpts) = self.excerpts.get(&buffer_id) {
for &excerpt_id in entries_to_add {
let Some(excerpt) = excerpts.get(&excerpt_id) else {
continue;
};
let excerpt_depth = parent_depth + 1;
self.push_entry(
entries,
match_candidates,
track_matches,
PanelEntry::Outline(OutlineEntry::Excerpt(
buffer_id,
excerpt_id,
excerpt.range.clone(),
)),
excerpt_depth,
cx,
);
let mut outline_base_depth = excerpt_depth + 1;
if is_singleton {
outline_base_depth = 0;
entries.clear();
match_candidates.clear();
} else if query.is_none()
&& self
.collapsed_entries
.contains(&CollapsedEntry::Excerpt(buffer_id, excerpt_id))
{
continue;
}
for outline in excerpt.iter_outlines() {
self.push_entry(
entries,
match_candidates,
track_matches,
PanelEntry::Outline(OutlineEntry::Outline(
buffer_id,
excerpt_id,
outline.clone(),
)),
outline_base_depth + outline.depth,
cx,
);
}
}
}
}
#[allow(clippy::too_many_arguments)]
fn add_search_entries(
&mut self,
entries: &mut Vec<CachedEntry>,
match_candidates: &mut Vec<StringMatchCandidate>,
parent_entry: FsEntry,
parent_depth: usize,
filter_query: Option<String>,
is_singleton: bool,
cx: &mut ViewContext<Self>,
) {
let Some(active_editor) = self.active_editor() else {
return;
};
let ItemsDisplayMode::Search(search_state) = &mut self.mode else {
return;
};
let kind = search_state.kind;
let related_excerpts = match &parent_entry {
FsEntry::Directory(_, _) => return,
FsEntry::ExternalFile(_, excerpts) => excerpts,
FsEntry::File(_, _, _, excerpts) => excerpts,
}
.iter()
.copied()
.collect::<HashSet<_>>();
let depth = if is_singleton { 0 } else { parent_depth + 1 };
let multi_buffer_snapshot = active_editor.read(cx).buffer().read(cx).snapshot(cx);
let new_search_matches = search_state.matches.iter().filter(|(match_range, _)| {
related_excerpts.contains(&match_range.start.excerpt_id)
|| related_excerpts.contains(&match_range.end.excerpt_id)
});
let previous_search_matches = entries
.iter()
.skip_while(|entry| {
if let PanelEntry::Fs(entry) = &entry.entry {
entry == &parent_entry
} else {
true
}
})
.take_while(|entry| matches!(entry.entry, PanelEntry::Search(_)))
.fold(
HashMap::default(),
|mut previous_matches, previous_entry| match &previous_entry.entry {
PanelEntry::Search(search_entry) => {
previous_matches.insert(
(search_entry.kind, &search_entry.match_range),
&search_entry.render_data,
);
previous_matches
}
_ => previous_matches,
},
);
let new_search_entries = new_search_matches
.map(|(match_range, search_data)| {
let previous_search_data =
previous_search_matches.get(&(kind, match_range)).copied();
let render_data = search_data
.get()
.or(previous_search_data)
.unwrap_or_else(|| {
search_data.get_or_init(|| {
Arc::new(SearchData::new(match_range, &multi_buffer_snapshot))
})
});
if let (Some(previous_highlights), None) = (
previous_search_data.and_then(|data| data.highlights_data.get()),
render_data.highlights_data.get(),
) {
render_data
.highlights_data
.set(previous_highlights.clone())
.ok();
}
SearchEntry {
match_range: match_range.clone(),
kind,
render_data: Arc::clone(render_data),
}
})
.collect::<Vec<_>>();
for new_search_entry in new_search_entries {
self.push_entry(
entries,
match_candidates,
filter_query.is_some(),
PanelEntry::Search(new_search_entry),
depth,
cx,
);
}
}
fn active_editor(&self) -> Option<View<Editor>> {
self.active_item.as_ref()?.active_editor.upgrade()
}
fn active_item(&self) -> Option<Box<dyn ItemHandle>> {
self.active_item.as_ref()?.item_handle.upgrade()
}
fn should_replace_active_item(&self, new_active_item: &dyn ItemHandle) -> bool {
self.active_item().map_or(true, |active_item| {
!self.pinned && active_item.item_id() != new_active_item.item_id()
})
}
pub fn toggle_active_editor_pin(
&mut self,
_: &ToggleActiveEditorPin,
cx: &mut ViewContext<Self>,
) {
self.pinned = !self.pinned;
if !self.pinned {
if let Some((active_item, active_editor)) = self
.workspace
.upgrade()
.and_then(|workspace| workspace_active_editor(workspace.read(cx), cx))
{
if self.should_replace_active_item(active_item.as_ref()) {
self.replace_active_editor(active_item, active_editor, cx);
}
}
}
cx.notify();
}
fn selected_entry(&self) -> Option<&PanelEntry> {
match &self.selected_entry {
SelectedEntry::Invalidated(entry) => entry.as_ref(),
SelectedEntry::Valid(entry, _) => Some(entry),
SelectedEntry::None => None,
}
}
fn select_entry(&mut self, entry: PanelEntry, focus: bool, cx: &mut ViewContext<Self>) {
if focus {
self.focus_handle.focus(cx);
}
let ix = self
.cached_entries
.iter()
.enumerate()
.find(|(_, cached_entry)| &cached_entry.entry == &entry)
.map(|(i, _)| i)
.unwrap_or_default();
self.selected_entry = SelectedEntry::Valid(entry, ix);
self.autoscroll(cx);
cx.notify();
}
}
fn workspace_active_editor(
workspace: &Workspace,
cx: &AppContext,
) -> Option<(Box<dyn ItemHandle>, View<Editor>)> {
let active_item = workspace.active_item(cx)?;
let active_editor = active_item
.act_as::<Editor>(cx)
.filter(|editor| editor.read(cx).mode() == EditorMode::Full)?;
Some((active_item, active_editor))
}
fn back_to_common_visited_parent(
visited_dirs: &mut Vec<(ProjectEntryId, Arc<Path>)>,
worktree_id: &WorktreeId,
new_entry: &Entry,
) -> Option<(WorktreeId, ProjectEntryId)> {
while let Some((visited_dir_id, visited_path)) = visited_dirs.last() {
match new_entry.path.parent() {
Some(parent_path) => {
if parent_path == visited_path.as_ref() {
return Some((*worktree_id, *visited_dir_id));
}
}
None => {
break;
}
}
visited_dirs.pop();
}
None
}
fn file_name(path: &Path) -> String {
let mut current_path = path;
loop {
if let Some(file_name) = current_path.file_name() {
return file_name.to_string_lossy().into_owned();
}
match current_path.parent() {
Some(parent) => current_path = parent,
None => return path.to_string_lossy().into_owned(),
}
}
}
impl Panel for OutlinePanel {
fn persistent_name() -> &'static str {
"Outline Panel"
}
fn position(&self, cx: &WindowContext) -> DockPosition {
match OutlinePanelSettings::get_global(cx).dock {
OutlinePanelDockPosition::Left => DockPosition::Left,
OutlinePanelDockPosition::Right => DockPosition::Right,
}
}
fn position_is_valid(&self, position: DockPosition) -> bool {
matches!(position, DockPosition::Left | DockPosition::Right)
}
fn set_position(&mut self, position: DockPosition, cx: &mut ViewContext<Self>) {
settings::update_settings_file::<OutlinePanelSettings>(
self.fs.clone(),
cx,
move |settings, _| {
let dock = match position {
DockPosition::Left | DockPosition::Bottom => OutlinePanelDockPosition::Left,
DockPosition::Right => OutlinePanelDockPosition::Right,
};
settings.dock = Some(dock);
},
);
}
fn size(&self, cx: &WindowContext) -> Pixels {
self.width
.unwrap_or_else(|| OutlinePanelSettings::get_global(cx).default_width)
}
fn set_size(&mut self, size: Option<Pixels>, cx: &mut ViewContext<Self>) {
self.width = size;
self.serialize(cx);
cx.notify();
}
fn icon(&self, cx: &WindowContext) -> Option<IconName> {
OutlinePanelSettings::get_global(cx)
.button
.then_some(IconName::ListTree)
}
fn icon_tooltip(&self, _: &WindowContext) -> Option<&'static str> {
Some("Outline Panel")
}
fn toggle_action(&self) -> Box<dyn Action> {
Box::new(ToggleFocus)
}
fn starts_open(&self, _: &WindowContext) -> bool {
self.active
}
fn set_active(&mut self, active: bool, cx: &mut ViewContext<Self>) {
cx.spawn(|outline_panel, mut cx| async move {
outline_panel
.update(&mut cx, |outline_panel, cx| {
let old_active = outline_panel.active;
outline_panel.active = active;
if active && old_active != active {
if let Some((active_item, active_editor)) = outline_panel
.workspace
.upgrade()
.and_then(|workspace| workspace_active_editor(workspace.read(cx), cx))
{
if outline_panel.should_replace_active_item(active_item.as_ref()) {
outline_panel.replace_active_editor(active_item, active_editor, cx);
} else {
outline_panel.update_fs_entries(
&active_editor,
HashSet::default(),
None,
cx,
)
}
} else if !outline_panel.pinned {
outline_panel.clear_previous(cx);
}
}
outline_panel.serialize(cx);
})
.ok();
})
.detach()
}
}
impl FocusableView for OutlinePanel {
fn focus_handle(&self, cx: &AppContext) -> FocusHandle {
self.filter_editor.focus_handle(cx).clone()
}
}
impl EventEmitter<Event> for OutlinePanel {}
impl EventEmitter<PanelEvent> for OutlinePanel {}
impl Render for OutlinePanel {
fn render(&mut self, cx: &mut ViewContext<Self>) -> impl IntoElement {
let project = self.project.read(cx);
let query = self.query(cx);
let pinned = self.pinned;
let settings = OutlinePanelSettings::get_global(cx);
let indent_size = settings.indent_size;
let show_indent_guides = settings.indent_guides.show == ShowIndentGuides::Always;
let outline_panel = v_flex()
.id("outline-panel")
.size_full()
.relative()
.key_context(self.dispatch_context(cx))
.on_action(cx.listener(Self::open))
.on_action(cx.listener(Self::cancel))
.on_action(cx.listener(Self::select_next))
.on_action(cx.listener(Self::select_prev))
.on_action(cx.listener(Self::select_first))
.on_action(cx.listener(Self::select_last))
.on_action(cx.listener(Self::select_parent))
.on_action(cx.listener(Self::expand_selected_entry))
.on_action(cx.listener(Self::collapse_selected_entry))
.on_action(cx.listener(Self::expand_all_entries))
.on_action(cx.listener(Self::collapse_all_entries))
.on_action(cx.listener(Self::copy_path))
.on_action(cx.listener(Self::copy_relative_path))
.on_action(cx.listener(Self::toggle_active_editor_pin))
.on_action(cx.listener(Self::unfold_directory))
.on_action(cx.listener(Self::fold_directory))
.when(project.is_local(), |el| {
el.on_action(cx.listener(Self::reveal_in_finder))
})
.when(project.is_local() || project.is_via_ssh(), |el| {
el.on_action(cx.listener(Self::open_in_terminal))
})
.on_mouse_down(
MouseButton::Right,
cx.listener(move |outline_panel, event: &MouseDownEvent, cx| {
if let Some(entry) = outline_panel.selected_entry().cloned() {
outline_panel.deploy_context_menu(event.position, entry, cx)
} else if let Some(entry) = outline_panel.fs_entries.first().cloned() {
outline_panel.deploy_context_menu(event.position, PanelEntry::Fs(entry), cx)
}
}),
)
.track_focus(&self.focus_handle(cx));
if self.cached_entries.is_empty() {
let header = if self.updating_fs_entries {
"Loading outlines"
} else if query.is_some() {
"No matches for query"
} else {
"No outlines available"
};
outline_panel.child(
v_flex()
.justify_center()
.size_full()
.child(h_flex().justify_center().child(Label::new(header)))
.when_some(query.clone(), |panel, query| {
panel.child(h_flex().justify_center().child(Label::new(query)))
})
.child(
h_flex()
.pt(Spacing::Small.rems(cx))
.justify_center()
.child({
let keystroke = match self.position(cx) {
DockPosition::Left => {
cx.keystroke_text_for(&workspace::ToggleLeftDock)
}
DockPosition::Bottom => {
cx.keystroke_text_for(&workspace::ToggleBottomDock)
}
DockPosition::Right => {
cx.keystroke_text_for(&workspace::ToggleRightDock)
}
};
Label::new(format!("Toggle this panel with {keystroke}"))
}),
),
)
} else {
let search_query = match &self.mode {
ItemsDisplayMode::Search(search_query) => Some(search_query),
_ => None,
};
outline_panel
.when_some(search_query, |outline_panel, search_state| {
outline_panel.child(
div()
.mx_2()
.child(
Label::new(format!("Searching: '{}'", search_state.query))
.color(Color::Muted),
)
.child(horizontal_separator(cx)),
)
})
.child({
let items_len = self.cached_entries.len();
let multi_buffer_snapshot = self
.active_editor()
.map(|editor| editor.read(cx).buffer().read(cx).snapshot(cx));
uniform_list(cx.view().clone(), "entries", items_len, {
move |outline_panel, range, cx| {
let entries = outline_panel.cached_entries.get(range);
entries
.map(|entries| entries.to_vec())
.unwrap_or_default()
.into_iter()
.filter_map(|cached_entry| match cached_entry.entry {
PanelEntry::Fs(entry) => Some(outline_panel.render_entry(
&entry,
cached_entry.depth,
cached_entry.string_match.as_ref(),
cx,
)),
PanelEntry::FoldedDirs(worktree_id, entries) => {
Some(outline_panel.render_folded_dirs(
worktree_id,
&entries,
cached_entry.depth,
cached_entry.string_match.as_ref(),
cx,
))
}
PanelEntry::Outline(OutlineEntry::Excerpt(
buffer_id,
excerpt_id,
excerpt,
)) => outline_panel.render_excerpt(
buffer_id,
excerpt_id,
&excerpt,
cached_entry.depth,
cx,
),
PanelEntry::Outline(OutlineEntry::Outline(
buffer_id,
excerpt_id,
outline,
)) => Some(outline_panel.render_outline(
buffer_id,
excerpt_id,
&outline,
cached_entry.depth,
cached_entry.string_match.as_ref(),
cx,
)),
PanelEntry::Search(SearchEntry {
match_range,
render_data,
kind,
..
}) => Some(outline_panel.render_search_match(
multi_buffer_snapshot.as_ref(),
&match_range,
&render_data,
kind,
cached_entry.depth,
cached_entry.string_match.as_ref(),
cx,
)),
})
.collect()
}
})
.size_full()
.track_scroll(self.scroll_handle.clone())
.when(show_indent_guides, |list| {
list.with_decoration(
ui::indent_guides(
cx.view().clone(),
px(indent_size),
IndentGuideColors::panel(cx),
|outline_panel, range, _| {
let entries = outline_panel.cached_entries.get(range);
if let Some(entries) = entries {
entries.into_iter().map(|item| item.depth).collect()
} else {
smallvec::SmallVec::new()
}
},
)
.with_render_fn(
cx.view().clone(),
move |outline_panel, params, _| {
const LEFT_OFFSET: f32 = 14.;
let indent_size = params.indent_size;
let item_height = params.item_height;
let active_indent_guide_ix = find_active_indent_guide_ix(
outline_panel,
&params.indent_guides,
);
params
.indent_guides
.into_iter()
.enumerate()
.map(|(ix, layout)| {
let bounds = Bounds::new(
point(
px(layout.offset.x as f32) * indent_size
+ px(LEFT_OFFSET),
px(layout.offset.y as f32) * item_height,
),
size(
px(1.),
px(layout.length as f32) * item_height,
),
);
ui::RenderedIndentGuide {
bounds,
layout,
is_active: active_indent_guide_ix == Some(ix),
hitbox: None,
}
})
.collect()
},
),
)
})
})
}
.children(self.context_menu.as_ref().map(|(menu, position, _)| {
deferred(
anchored()
.position(*position)
.anchor(gpui::AnchorCorner::TopLeft)
.child(menu.clone()),
)
.with_priority(1)
}))
.child(
v_flex().child(horizontal_separator(cx)).child(
h_flex().p_2().child(self.filter_editor.clone()).child(
div().child(
IconButton::new(
"outline-panel-menu",
if pinned {
IconName::Unpin
} else {
IconName::Pin
},
)
.tooltip(move |cx| {
Tooltip::text(
if pinned {
"Unpin Outline"
} else {
"Pin Active Outline"
},
cx,
)
})
.shape(IconButtonShape::Square)
.on_click(cx.listener(|outline_panel, _, cx| {
outline_panel.toggle_active_editor_pin(&ToggleActiveEditorPin, cx);
})),
),
),
),
)
}
}
fn find_active_indent_guide_ix(
outline_panel: &OutlinePanel,
candidates: &[IndentGuideLayout],
) -> Option<usize> {
let SelectedEntry::Valid(_, target_ix) = &outline_panel.selected_entry else {
return None;
};
let target_depth = outline_panel
.cached_entries
.get(*target_ix)
.map(|cached_entry| cached_entry.depth)?;
let (target_ix, target_depth) = if let Some(target_depth) = outline_panel
.cached_entries
.get(target_ix + 1)
.filter(|cached_entry| cached_entry.depth > target_depth)
.map(|entry| entry.depth)
{
(target_ix + 1, target_depth.saturating_sub(1))
} else {
(*target_ix, target_depth.saturating_sub(1))
};
candidates
.iter()
.enumerate()
.find(|(_, guide)| {
guide.offset.y <= target_ix
&& target_ix < guide.offset.y + guide.length
&& guide.offset.x == target_depth
})
.map(|(ix, _)| ix)
}
fn subscribe_for_editor_events(
editor: &View<Editor>,
cx: &mut ViewContext<OutlinePanel>,
) -> Subscription {
let debounce = Some(UPDATE_DEBOUNCE);
cx.subscribe(
editor,
move |outline_panel, editor, e: &EditorEvent, cx| match e {
EditorEvent::SelectionsChanged { local: true } => {
outline_panel.reveal_entry_for_selection(&editor, cx);
cx.notify();
}
EditorEvent::ExcerptsAdded { excerpts, .. } => {
outline_panel.update_fs_entries(
&editor,
excerpts.iter().map(|&(excerpt_id, _)| excerpt_id).collect(),
debounce,
cx,
);
}
EditorEvent::ExcerptsRemoved { ids } => {
let mut ids = ids.iter().collect::<HashSet<_>>();
for excerpts in outline_panel.excerpts.values_mut() {
excerpts.retain(|excerpt_id, _| !ids.remove(excerpt_id));
if ids.is_empty() {
break;
}
}
outline_panel.update_fs_entries(&editor, HashSet::default(), debounce, cx);
}
EditorEvent::ExcerptsExpanded { ids } => {
outline_panel.invalidate_outlines(ids);
outline_panel.update_non_fs_items(cx);
}
EditorEvent::ExcerptsEdited { ids } => {
outline_panel.invalidate_outlines(ids);
outline_panel.update_non_fs_items(cx);
}
EditorEvent::Reparsed(buffer_id) => {
if let Some(excerpts) = outline_panel.excerpts.get_mut(buffer_id) {
for (_, excerpt) in excerpts {
excerpt.invalidate_outlines();
}
}
outline_panel.update_non_fs_items(cx);
}
_ => {}
},
)
}
fn empty_icon() -> AnyElement {
h_flex()
.size(IconSize::default().rems())
.invisible()
.flex_none()
.into_any_element()
}
fn horizontal_separator(cx: &mut WindowContext) -> Div {
div().mx_2().border_primary(cx).border_t_1()
}
#[cfg(test)]
mod tests {
use gpui::{TestAppContext, VisualTestContext, WindowHandle};
use language::{tree_sitter_rust, Language, LanguageConfig, LanguageMatcher};
use pretty_assertions::assert_eq;
use project::FakeFs;
use search::project_search::{self, perform_project_search};
use serde_json::json;
use super::*;
const SELECTED_MARKER: &str = " <==== selected";
#[gpui::test]
async fn test_project_search_results_toggling(cx: &mut TestAppContext) {
init_test(cx);
let fs = FakeFs::new(cx.background_executor.clone());
populate_with_test_ra_project(&fs, "/rust-analyzer").await;
let project = Project::test(fs.clone(), ["/rust-analyzer".as_ref()], cx).await;
project.read_with(cx, |project, _| {
project.languages().add(Arc::new(rust_lang()))
});
let workspace = add_outline_panel(&project, cx).await;
let cx = &mut VisualTestContext::from_window(*workspace, cx);
let outline_panel = outline_panel(&workspace, cx);
outline_panel.update(cx, |outline_panel, cx| outline_panel.set_active(true, cx));
workspace
.update(cx, |workspace, cx| {
ProjectSearchView::deploy_search(workspace, &workspace::DeploySearch::default(), cx)
})
.unwrap();
let search_view = workspace
.update(cx, |workspace, cx| {
workspace
.active_pane()
.read(cx)
.items()
.find_map(|item| item.downcast::<ProjectSearchView>())
.expect("Project search view expected to appear after new search event trigger")
})
.unwrap();
let query = "param_names_for_lifetime_elision_hints";
perform_project_search(&search_view, query, cx);
search_view.update(cx, |search_view, cx| {
search_view
.results_editor()
.update(cx, |results_editor, cx| {
assert_eq!(
results_editor.display_text(cx).match_indices(query).count(),
9
);
});
});
let all_matches = r#"/
crates/
ide/src/
inlay_hints/
fn_lifetime_fn.rs
search: match config.param_names_for_lifetime_elision_hints {
search: allocated_lifetimes.push(if config.param_names_for_lifetime_elision_hints {
search: Some(it) if config.param_names_for_lifetime_elision_hints => {
search: InlayHintsConfig { param_names_for_lifetime_elision_hints: true, ..TEST_CONFIG },
inlay_hints.rs
search: pub param_names_for_lifetime_elision_hints: bool,
search: param_names_for_lifetime_elision_hints: self
static_index.rs
search: param_names_for_lifetime_elision_hints: false,
rust-analyzer/src/
cli/
analysis_stats.rs
search: param_names_for_lifetime_elision_hints: true,
config.rs
search: param_names_for_lifetime_elision_hints: self"#;
let select_first_in_all_matches = |line_to_select: &str| {
assert!(all_matches.contains(line_to_select));
all_matches.replacen(
line_to_select,
&format!("{line_to_select}{SELECTED_MARKER}"),
1,
)
};
cx.executor()
.advance_clock(UPDATE_DEBOUNCE + Duration::from_millis(100));
cx.run_until_parked();
outline_panel.update(cx, |outline_panel, _| {
assert_eq!(
display_entries(
&outline_panel.cached_entries,
outline_panel.selected_entry()
),
select_first_in_all_matches(
"search: match config.param_names_for_lifetime_elision_hints {"
)
);
});
outline_panel.update(cx, |outline_panel, cx| {
outline_panel.select_parent(&SelectParent, cx);
assert_eq!(
display_entries(
&outline_panel.cached_entries,
outline_panel.selected_entry()
),
select_first_in_all_matches("fn_lifetime_fn.rs")
);
});
outline_panel.update(cx, |outline_panel, cx| {
outline_panel.collapse_selected_entry(&CollapseSelectedEntry, cx);
});
cx.run_until_parked();
outline_panel.update(cx, |outline_panel, _| {
assert_eq!(
display_entries(
&outline_panel.cached_entries,
outline_panel.selected_entry()
),
format!(
r#"/
crates/
ide/src/
inlay_hints/
fn_lifetime_fn.rs{SELECTED_MARKER}
inlay_hints.rs
search: pub param_names_for_lifetime_elision_hints: bool,
search: param_names_for_lifetime_elision_hints: self
static_index.rs
search: param_names_for_lifetime_elision_hints: false,
rust-analyzer/src/
cli/
analysis_stats.rs
search: param_names_for_lifetime_elision_hints: true,
config.rs
search: param_names_for_lifetime_elision_hints: self"#,
)
);
});
outline_panel.update(cx, |outline_panel, cx| {
outline_panel.expand_all_entries(&ExpandAllEntries, cx);
});
cx.run_until_parked();
outline_panel.update(cx, |outline_panel, cx| {
outline_panel.select_parent(&SelectParent, cx);
assert_eq!(
display_entries(
&outline_panel.cached_entries,
outline_panel.selected_entry()
),
select_first_in_all_matches("inlay_hints/")
);
});
outline_panel.update(cx, |outline_panel, cx| {
outline_panel.select_parent(&SelectParent, cx);
assert_eq!(
display_entries(
&outline_panel.cached_entries,
outline_panel.selected_entry()
),
select_first_in_all_matches("ide/src/")
);
});
outline_panel.update(cx, |outline_panel, cx| {
outline_panel.collapse_selected_entry(&CollapseSelectedEntry, cx);
});
cx.run_until_parked();
outline_panel.update(cx, |outline_panel, _| {
assert_eq!(
display_entries(
&outline_panel.cached_entries,
outline_panel.selected_entry()
),
format!(
r#"/
crates/
ide/src/{SELECTED_MARKER}
rust-analyzer/src/
cli/
analysis_stats.rs
search: param_names_for_lifetime_elision_hints: true,
config.rs
search: param_names_for_lifetime_elision_hints: self"#,
)
);
});
outline_panel.update(cx, |outline_panel, cx| {
outline_panel.expand_selected_entry(&ExpandSelectedEntry, cx);
});
cx.run_until_parked();
outline_panel.update(cx, |outline_panel, _| {
assert_eq!(
display_entries(
&outline_panel.cached_entries,
outline_panel.selected_entry()
),
select_first_in_all_matches("ide/src/")
);
});
}
#[gpui::test]
async fn test_item_filtering(cx: &mut TestAppContext) {
init_test(cx);
let fs = FakeFs::new(cx.background_executor.clone());
populate_with_test_ra_project(&fs, "/rust-analyzer").await;
let project = Project::test(fs.clone(), ["/rust-analyzer".as_ref()], cx).await;
project.read_with(cx, |project, _| {
project.languages().add(Arc::new(rust_lang()))
});
let workspace = add_outline_panel(&project, cx).await;
let cx = &mut VisualTestContext::from_window(*workspace, cx);
let outline_panel = outline_panel(&workspace, cx);
outline_panel.update(cx, |outline_panel, cx| outline_panel.set_active(true, cx));
workspace
.update(cx, |workspace, cx| {
ProjectSearchView::deploy_search(workspace, &workspace::DeploySearch::default(), cx)
})
.unwrap();
let search_view = workspace
.update(cx, |workspace, cx| {
workspace
.active_pane()
.read(cx)
.items()
.find_map(|item| item.downcast::<ProjectSearchView>())
.expect("Project search view expected to appear after new search event trigger")
})
.unwrap();
let query = "param_names_for_lifetime_elision_hints";
perform_project_search(&search_view, query, cx);
search_view.update(cx, |search_view, cx| {
search_view
.results_editor()
.update(cx, |results_editor, cx| {
assert_eq!(
results_editor.display_text(cx).match_indices(query).count(),
9
);
});
});
let all_matches = r#"/
crates/
ide/src/
inlay_hints/
fn_lifetime_fn.rs
search: match config.param_names_for_lifetime_elision_hints {
search: allocated_lifetimes.push(if config.param_names_for_lifetime_elision_hints {
search: Some(it) if config.param_names_for_lifetime_elision_hints => {
search: InlayHintsConfig { param_names_for_lifetime_elision_hints: true, ..TEST_CONFIG },
inlay_hints.rs
search: pub param_names_for_lifetime_elision_hints: bool,
search: param_names_for_lifetime_elision_hints: self
static_index.rs
search: param_names_for_lifetime_elision_hints: false,
rust-analyzer/src/
cli/
analysis_stats.rs
search: param_names_for_lifetime_elision_hints: true,
config.rs
search: param_names_for_lifetime_elision_hints: self"#;
cx.executor()
.advance_clock(UPDATE_DEBOUNCE + Duration::from_millis(100));
cx.run_until_parked();
outline_panel.update(cx, |outline_panel, _| {
assert_eq!(
display_entries(&outline_panel.cached_entries, None,),
all_matches,
);
});
let filter_text = "a";
outline_panel.update(cx, |outline_panel, cx| {
outline_panel.filter_editor.update(cx, |filter_editor, cx| {
filter_editor.set_text(filter_text, cx);
});
});
cx.executor()
.advance_clock(UPDATE_DEBOUNCE + Duration::from_millis(100));
cx.run_until_parked();
outline_panel.update(cx, |outline_panel, _| {
assert_eq!(
display_entries(&outline_panel.cached_entries, None),
all_matches
.lines()
.filter(|item| item.contains(filter_text))
.collect::<Vec<_>>()
.join("\n"),
);
});
outline_panel.update(cx, |outline_panel, cx| {
outline_panel.filter_editor.update(cx, |filter_editor, cx| {
filter_editor.set_text("", cx);
});
});
cx.executor()
.advance_clock(UPDATE_DEBOUNCE + Duration::from_millis(100));
cx.run_until_parked();
outline_panel.update(cx, |outline_panel, _| {
assert_eq!(
display_entries(&outline_panel.cached_entries, None,),
all_matches,
);
});
}
#[gpui::test]
async fn test_frontend_repo_structure(cx: &mut TestAppContext) {
init_test(cx);
let root = "/frontend-project";
let fs = FakeFs::new(cx.background_executor.clone());
fs.insert_tree(
root,
json!({
"public": {
"lottie": {
"syntax-tree.json": r#"{ "something": "static" }"#
}
},
"src": {
"app": {
"(site)": {
"(about)": {
"jobs": {
"[slug]": {
"page.tsx": r#"static"#
}
}
},
"(blog)": {
"post": {
"[slug]": {
"page.tsx": r#"static"#
}
}
},
}
},
"components": {
"ErrorBoundary.tsx": r#"static"#,
}
}
}),
)
.await;
let project = Project::test(fs.clone(), [root.as_ref()], cx).await;
let workspace = add_outline_panel(&project, cx).await;
let cx = &mut VisualTestContext::from_window(*workspace, cx);
let outline_panel = outline_panel(&workspace, cx);
outline_panel.update(cx, |outline_panel, cx| outline_panel.set_active(true, cx));
workspace
.update(cx, |workspace, cx| {
ProjectSearchView::deploy_search(workspace, &workspace::DeploySearch::default(), cx)
})
.unwrap();
let search_view = workspace
.update(cx, |workspace, cx| {
workspace
.active_pane()
.read(cx)
.items()
.find_map(|item| item.downcast::<ProjectSearchView>())
.expect("Project search view expected to appear after new search event trigger")
})
.unwrap();
let query = "static";
perform_project_search(&search_view, query, cx);
search_view.update(cx, |search_view, cx| {
search_view
.results_editor()
.update(cx, |results_editor, cx| {
assert_eq!(
results_editor.display_text(cx).match_indices(query).count(),
4
);
});
});
cx.executor()
.advance_clock(UPDATE_DEBOUNCE + Duration::from_millis(100));
cx.run_until_parked();
outline_panel.update(cx, |outline_panel, _| {
assert_eq!(
display_entries(
&outline_panel.cached_entries,
outline_panel.selected_entry()
),
r#"/
public/lottie/
syntax-tree.json
search: { "something": "static" } <==== selected
src/
app/(site)/
(about)/jobs/[slug]/
page.tsx
search: static
(blog)/post/[slug]/
page.tsx
search: static
components/
ErrorBoundary.tsx
search: static"#
);
});
outline_panel.update(cx, |outline_panel, cx| {
outline_panel.select_next(&SelectNext, cx);
outline_panel.select_next(&SelectNext, cx);
outline_panel.collapse_selected_entry(&CollapseSelectedEntry, cx);
});
cx.run_until_parked();
outline_panel.update(cx, |outline_panel, _| {
assert_eq!(
display_entries(
&outline_panel.cached_entries,
outline_panel.selected_entry()
),
r#"/
public/lottie/
syntax-tree.json
search: { "something": "static" }
src/
app/(site)/ <==== selected
components/
ErrorBoundary.tsx
search: static"#
);
});
}
async fn add_outline_panel(
project: &Model<Project>,
cx: &mut TestAppContext,
) -> WindowHandle<Workspace> {
let window = cx.add_window(|cx| Workspace::test_new(project.clone(), cx));
let outline_panel = window
.update(cx, |_, cx| cx.spawn(OutlinePanel::load))
.unwrap()
.await
.expect("Failed to load outline panel");
window
.update(cx, |workspace, cx| {
workspace.add_panel(outline_panel, cx);
})
.unwrap();
window
}
fn outline_panel(
workspace: &WindowHandle<Workspace>,
cx: &mut TestAppContext,
) -> View<OutlinePanel> {
workspace
.update(cx, |workspace, cx| {
workspace
.panel::<OutlinePanel>(cx)
.expect("no outline panel")
})
.unwrap()
}
fn display_entries(
cached_entries: &[CachedEntry],
selected_entry: Option<&PanelEntry>,
) -> String {
let mut display_string = String::new();
for entry in cached_entries {
if !display_string.is_empty() {
display_string += "\n";
}
for _ in 0..entry.depth {
display_string += " ";
}
display_string += &match &entry.entry {
PanelEntry::Fs(entry) => match entry {
FsEntry::ExternalFile(_, _) => {
panic!("Did not cover external files with tests")
}
FsEntry::Directory(_, dir_entry) => format!(
"{}/",
dir_entry
.path
.file_name()
.map(|name| name.to_string_lossy().to_string())
.unwrap_or_default()
),
FsEntry::File(_, file_entry, ..) => file_entry
.path
.file_name()
.map(|name| name.to_string_lossy().to_string())
.unwrap_or_default(),
},
PanelEntry::FoldedDirs(_, dirs) => dirs
.iter()
.filter_map(|dir| dir.path.file_name())
.map(|name| name.to_string_lossy().to_string() + "/")
.collect(),
PanelEntry::Outline(outline_entry) => match outline_entry {
OutlineEntry::Excerpt(_, _, _) => continue,
OutlineEntry::Outline(_, _, outline) => format!("outline: {}", outline.text),
},
PanelEntry::Search(SearchEntry { render_data, .. }) => {
format!("search: {}", render_data.context_text)
}
};
if Some(&entry.entry) == selected_entry {
display_string += SELECTED_MARKER;
}
}
display_string
}
fn init_test(cx: &mut TestAppContext) {
cx.update(|cx| {
let settings = SettingsStore::test(cx);
cx.set_global(settings);
theme::init(theme::LoadThemes::JustBase, cx);
language::init(cx);
editor::init(cx);
workspace::init_settings(cx);
Project::init_settings(cx);
project_search::init(cx);
super::init((), cx);
});
}
// Based on https://github.com/rust-lang/rust-analyzer/
async fn populate_with_test_ra_project(fs: &FakeFs, root: &str) {
fs.insert_tree(
root,
json!({
"crates": {
"ide": {
"src": {
"inlay_hints": {
"fn_lifetime_fn.rs": r##"
pub(super) fn hints(
acc: &mut Vec<InlayHint>,
config: &InlayHintsConfig,
func: ast::Fn,
) -> Option<()> {
// ... snip
let mut used_names: FxHashMap<SmolStr, usize> =
match config.param_names_for_lifetime_elision_hints {
true => generic_param_list
.iter()
.flat_map(|gpl| gpl.lifetime_params())
.filter_map(|param| param.lifetime())
.filter_map(|lt| Some((SmolStr::from(lt.text().as_str().get(1..)?), 0)))
.collect(),
false => Default::default(),
};
{
let mut potential_lt_refs = potential_lt_refs.iter().filter(|&&(.., is_elided)| is_elided);
if self_param.is_some() && potential_lt_refs.next().is_some() {
allocated_lifetimes.push(if config.param_names_for_lifetime_elision_hints {
// self can't be used as a lifetime, so no need to check for collisions
"'self".into()
} else {
gen_idx_name()
});
}
potential_lt_refs.for_each(|(name, ..)| {
let name = match name {
Some(it) if config.param_names_for_lifetime_elision_hints => {
if let Some(c) = used_names.get_mut(it.text().as_str()) {
*c += 1;
SmolStr::from(format!("'{text}{c}", text = it.text().as_str()))
} else {
used_names.insert(it.text().as_str().into(), 0);
SmolStr::from_iter(["\'", it.text().as_str()])
}
}
_ => gen_idx_name(),
};
allocated_lifetimes.push(name);
});
}
// ... snip
}
// ... snip
#[test]
fn hints_lifetimes_named() {
check_with_config(
InlayHintsConfig { param_names_for_lifetime_elision_hints: true, ..TEST_CONFIG },
r#"
fn nested_in<'named>(named: & &X< &()>) {}
// ^'named1, 'named2, 'named3, $
//^'named1 ^'named2 ^'named3
"#,
);
}
// ... snip
"##,
},
"inlay_hints.rs": r#"
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct InlayHintsConfig {
// ... snip
pub param_names_for_lifetime_elision_hints: bool,
pub max_length: Option<usize>,
// ... snip
}
impl Config {
pub fn inlay_hints(&self) -> InlayHintsConfig {
InlayHintsConfig {
// ... snip
param_names_for_lifetime_elision_hints: self
.inlayHints_lifetimeElisionHints_useParameterNames()
.to_owned(),
max_length: self.inlayHints_maxLength().to_owned(),
// ... snip
}
}
}
"#,
"static_index.rs": r#"
// ... snip
fn add_file(&mut self, file_id: FileId) {
let current_crate = crates_for(self.db, file_id).pop().map(Into::into);
let folds = self.analysis.folding_ranges(file_id).unwrap();
let inlay_hints = self
.analysis
.inlay_hints(
&InlayHintsConfig {
// ... snip
closure_style: hir::ClosureStyle::ImplFn,
param_names_for_lifetime_elision_hints: false,
binding_mode_hints: false,
max_length: Some(25),
closure_capture_hints: false,
// ... snip
},
file_id,
None,
)
.unwrap();
// ... snip
}
// ... snip
"#
}
},
"rust-analyzer": {
"src": {
"cli": {
"analysis_stats.rs": r#"
// ... snip
for &file_id in &file_ids {
_ = analysis.inlay_hints(
&InlayHintsConfig {
// ... snip
implicit_drop_hints: true,
lifetime_elision_hints: ide::LifetimeElisionHints::Always,
param_names_for_lifetime_elision_hints: true,
hide_named_constructor_hints: false,
hide_closure_initialization_hints: false,
closure_style: hir::ClosureStyle::ImplFn,
max_length: Some(25),
closing_brace_hints_min_lines: Some(20),
fields_to_resolve: InlayFieldsToResolve::empty(),
range_exclusive_hints: true,
},
file_id.into(),
None,
);
}
// ... snip
"#,
},
"config.rs": r#"
config_data! {
/// Configs that only make sense when they are set by a client. As such they can only be defined
/// by setting them using client's settings (e.g `settings.json` on VS Code).
client: struct ClientDefaultConfigData <- ClientConfigInput -> {
// ... snip
/// Maximum length for inlay hints. Set to null to have an unlimited length.
inlayHints_maxLength: Option<usize> = Some(25),
// ... snip
/// Whether to prefer using parameter names as the name for elided lifetime hints if possible.
inlayHints_lifetimeElisionHints_useParameterNames: bool = false,
// ... snip
}
}
impl Config {
// ... snip
pub fn inlay_hints(&self) -> InlayHintsConfig {
InlayHintsConfig {
// ... snip
param_names_for_lifetime_elision_hints: self
.inlayHints_lifetimeElisionHints_useParameterNames()
.to_owned(),
max_length: self.inlayHints_maxLength().to_owned(),
// ... snip
}
}
// ... snip
}
"#
}
}
}
}),
)
.await;
}
fn rust_lang() -> Language {
Language::new(
LanguageConfig {
name: "Rust".into(),
matcher: LanguageMatcher {
path_suffixes: vec!["rs".to_string()],
..Default::default()
},
..Default::default()
},
Some(tree_sitter_rust::LANGUAGE.into()),
)
.with_highlights_query(
r#"
(field_identifier) @field
(struct_expression) @struct
"#,
)
.unwrap()
.with_injection_query(
r#"
(macro_invocation
(token_tree) @content
(#set! "language" "rust"))
"#,
)
.unwrap()
}
}