Closes https://github.com/zed-industries/zed/issues/38690 Closes #37353 ### Background On Windows, paths are normally separated by `\`, unlike mac and linux where they are separated by `/`. When editing code in a project that uses a different path style than your local system (e.g. remoting from Windows to Linux, using WSL, and collaboration between windows and unix users), the correct separator for a path may differ from the "native" separator. Previously, to work around this, Zed converted paths' separators in numerous places. This was applied to both absolute and relative paths, leading to incorrect conversions in some cases. ### Solution Many code paths in Zed use paths that are *relative* to either a worktree root or a git repository. This PR introduces a dedicated type for these paths called `RelPath`, which stores the path in the same way regardless of host platform, and offers `Path`-like manipulation APIs. RelPath supports *displaying* the path using either separator, so that we can display paths in a style that is determined at runtime based on the current project. The representation of absolute paths is left untouched, for now. Absolute paths are different from relative paths because (except in contexts where we know that the path refers to the local filesystem) they should generally be treated as opaque strings. Currently we use a mix of types for these paths (std::path::Path, String, SanitizedPath). Release Notes: - N/A --------- Co-authored-by: Cole Miller <cole@zed.dev> Co-authored-by: Piotr Osiewicz <24362066+osiewicz@users.noreply.github.com> Co-authored-by: Peter Tripp <petertripp@gmail.com> Co-authored-by: Smit Barmase <heysmitbarmase@gmail.com> Co-authored-by: Lukas Wirth <me@lukaswirth.dev>
368 lines
11 KiB
Rust
368 lines
11 KiB
Rust
use std::sync::Arc;
|
|
use std::sync::atomic::AtomicBool;
|
|
|
|
use file_icons::FileIcons;
|
|
use fuzzy::PathMatch;
|
|
use gpui::{
|
|
App, AppContext, DismissEvent, Entity, FocusHandle, Focusable, Stateful, Task, WeakEntity,
|
|
};
|
|
use picker::{Picker, PickerDelegate};
|
|
use project::{PathMatchCandidateSet, ProjectPath, WorktreeId};
|
|
use ui::{ListItem, Tooltip, prelude::*};
|
|
use util::{ResultExt as _, paths::PathStyle, rel_path::RelPath};
|
|
use workspace::Workspace;
|
|
|
|
use crate::context_picker::ContextPicker;
|
|
use agent::context_store::{ContextStore, FileInclusion};
|
|
|
|
pub struct FileContextPicker {
|
|
picker: Entity<Picker<FileContextPickerDelegate>>,
|
|
}
|
|
|
|
impl FileContextPicker {
|
|
pub fn new(
|
|
context_picker: WeakEntity<ContextPicker>,
|
|
workspace: WeakEntity<Workspace>,
|
|
context_store: WeakEntity<ContextStore>,
|
|
window: &mut Window,
|
|
cx: &mut Context<Self>,
|
|
) -> Self {
|
|
let delegate = FileContextPickerDelegate::new(context_picker, workspace, context_store);
|
|
let picker = cx.new(|cx| Picker::uniform_list(delegate, window, cx));
|
|
|
|
Self { picker }
|
|
}
|
|
}
|
|
|
|
impl Focusable for FileContextPicker {
|
|
fn focus_handle(&self, cx: &App) -> FocusHandle {
|
|
self.picker.focus_handle(cx)
|
|
}
|
|
}
|
|
|
|
impl Render for FileContextPicker {
|
|
fn render(&mut self, _window: &mut Window, _cx: &mut Context<Self>) -> impl IntoElement {
|
|
self.picker.clone()
|
|
}
|
|
}
|
|
|
|
pub struct FileContextPickerDelegate {
|
|
context_picker: WeakEntity<ContextPicker>,
|
|
workspace: WeakEntity<Workspace>,
|
|
context_store: WeakEntity<ContextStore>,
|
|
matches: Vec<FileMatch>,
|
|
selected_index: usize,
|
|
}
|
|
|
|
impl FileContextPickerDelegate {
|
|
pub fn new(
|
|
context_picker: WeakEntity<ContextPicker>,
|
|
workspace: WeakEntity<Workspace>,
|
|
context_store: WeakEntity<ContextStore>,
|
|
) -> Self {
|
|
Self {
|
|
context_picker,
|
|
workspace,
|
|
context_store,
|
|
matches: Vec::new(),
|
|
selected_index: 0,
|
|
}
|
|
}
|
|
}
|
|
|
|
impl PickerDelegate for FileContextPickerDelegate {
|
|
type ListItem = ListItem;
|
|
|
|
fn match_count(&self) -> usize {
|
|
self.matches.len()
|
|
}
|
|
|
|
fn selected_index(&self) -> usize {
|
|
self.selected_index
|
|
}
|
|
|
|
fn set_selected_index(
|
|
&mut self,
|
|
ix: usize,
|
|
_window: &mut Window,
|
|
_cx: &mut Context<Picker<Self>>,
|
|
) {
|
|
self.selected_index = ix;
|
|
}
|
|
|
|
fn placeholder_text(&self, _window: &mut Window, _cx: &mut App) -> Arc<str> {
|
|
"Search files & directories…".into()
|
|
}
|
|
|
|
fn update_matches(
|
|
&mut self,
|
|
query: String,
|
|
window: &mut Window,
|
|
cx: &mut Context<Picker<Self>>,
|
|
) -> Task<()> {
|
|
let Some(workspace) = self.workspace.upgrade() else {
|
|
return Task::ready(());
|
|
};
|
|
|
|
let search_task = search_files(query, Arc::<AtomicBool>::default(), &workspace, cx);
|
|
|
|
cx.spawn_in(window, async move |this, cx| {
|
|
// TODO: This should be probably be run in the background.
|
|
let paths = search_task.await;
|
|
|
|
this.update(cx, |this, _cx| {
|
|
this.delegate.matches = paths;
|
|
})
|
|
.log_err();
|
|
})
|
|
}
|
|
|
|
fn confirm(&mut self, _secondary: bool, _window: &mut Window, cx: &mut Context<Picker<Self>>) {
|
|
let Some(FileMatch { mat, .. }) = self.matches.get(self.selected_index) else {
|
|
return;
|
|
};
|
|
|
|
let project_path = ProjectPath {
|
|
worktree_id: WorktreeId::from_usize(mat.worktree_id),
|
|
path: mat.path.clone(),
|
|
};
|
|
|
|
let is_directory = mat.is_dir;
|
|
|
|
self.context_store
|
|
.update(cx, |context_store, cx| {
|
|
if is_directory {
|
|
context_store
|
|
.add_directory(&project_path, true, cx)
|
|
.log_err();
|
|
} else {
|
|
context_store
|
|
.add_file_from_path(project_path.clone(), true, cx)
|
|
.detach_and_log_err(cx);
|
|
}
|
|
})
|
|
.ok();
|
|
}
|
|
|
|
fn dismissed(&mut self, _: &mut Window, cx: &mut Context<Picker<Self>>) {
|
|
self.context_picker
|
|
.update(cx, |_, cx| {
|
|
cx.emit(DismissEvent);
|
|
})
|
|
.ok();
|
|
}
|
|
|
|
fn render_match(
|
|
&self,
|
|
ix: usize,
|
|
selected: bool,
|
|
_window: &mut Window,
|
|
cx: &mut Context<Picker<Self>>,
|
|
) -> Option<Self::ListItem> {
|
|
let FileMatch { mat, .. } = &self.matches.get(ix)?;
|
|
let workspace = self.workspace.upgrade()?;
|
|
let path_style = workspace.read(cx).path_style(cx);
|
|
|
|
Some(
|
|
ListItem::new(ix)
|
|
.inset(true)
|
|
.toggle_state(selected)
|
|
.child(render_file_context_entry(
|
|
ElementId::named_usize("file-ctx-picker", ix),
|
|
WorktreeId::from_usize(mat.worktree_id),
|
|
&mat.path,
|
|
&mat.path_prefix,
|
|
mat.is_dir,
|
|
path_style,
|
|
self.context_store.clone(),
|
|
cx,
|
|
)),
|
|
)
|
|
}
|
|
}
|
|
|
|
pub struct FileMatch {
|
|
pub mat: PathMatch,
|
|
pub is_recent: bool,
|
|
}
|
|
|
|
pub(crate) fn search_files(
|
|
query: String,
|
|
cancellation_flag: Arc<AtomicBool>,
|
|
workspace: &Entity<Workspace>,
|
|
cx: &App,
|
|
) -> Task<Vec<FileMatch>> {
|
|
if query.is_empty() {
|
|
let workspace = workspace.read(cx);
|
|
let project = workspace.project().read(cx);
|
|
let recent_matches = workspace
|
|
.recent_navigation_history(Some(10), cx)
|
|
.into_iter()
|
|
.filter_map(|(project_path, _)| {
|
|
let worktree = project.worktree_for_id(project_path.worktree_id, cx)?;
|
|
Some(FileMatch {
|
|
mat: PathMatch {
|
|
score: 0.,
|
|
positions: Vec::new(),
|
|
worktree_id: project_path.worktree_id.to_usize(),
|
|
path: project_path.path,
|
|
path_prefix: worktree.read(cx).root_name().into(),
|
|
distance_to_relative_ancestor: 0,
|
|
is_dir: false,
|
|
},
|
|
is_recent: true,
|
|
})
|
|
});
|
|
|
|
let file_matches = project.worktrees(cx).flat_map(|worktree| {
|
|
let worktree = worktree.read(cx);
|
|
worktree.entries(false, 0).map(move |entry| FileMatch {
|
|
mat: PathMatch {
|
|
score: 0.,
|
|
positions: Vec::new(),
|
|
worktree_id: worktree.id().to_usize(),
|
|
path: entry.path.clone(),
|
|
path_prefix: worktree.root_name().into(),
|
|
distance_to_relative_ancestor: 0,
|
|
is_dir: entry.is_dir(),
|
|
},
|
|
is_recent: false,
|
|
})
|
|
});
|
|
|
|
Task::ready(recent_matches.chain(file_matches).collect())
|
|
} else {
|
|
let worktrees = workspace.read(cx).visible_worktrees(cx).collect::<Vec<_>>();
|
|
let candidate_sets = worktrees
|
|
.into_iter()
|
|
.map(|worktree| {
|
|
let worktree = worktree.read(cx);
|
|
|
|
PathMatchCandidateSet {
|
|
snapshot: worktree.snapshot(),
|
|
include_ignored: worktree.root_entry().is_some_and(|entry| entry.is_ignored),
|
|
include_root_name: true,
|
|
candidates: project::Candidates::Entries,
|
|
}
|
|
})
|
|
.collect::<Vec<_>>();
|
|
|
|
let executor = cx.background_executor().clone();
|
|
cx.foreground_executor().spawn(async move {
|
|
fuzzy::match_path_sets(
|
|
candidate_sets.as_slice(),
|
|
query.as_str(),
|
|
&None,
|
|
false,
|
|
100,
|
|
&cancellation_flag,
|
|
executor,
|
|
)
|
|
.await
|
|
.into_iter()
|
|
.map(|mat| FileMatch {
|
|
mat,
|
|
is_recent: false,
|
|
})
|
|
.collect::<Vec<_>>()
|
|
})
|
|
}
|
|
}
|
|
|
|
pub fn extract_file_name_and_directory(
|
|
path: &RelPath,
|
|
path_prefix: &RelPath,
|
|
path_style: PathStyle,
|
|
) -> (SharedString, Option<SharedString>) {
|
|
let full_path = path_prefix.join(path);
|
|
let file_name = full_path.file_name().unwrap_or_default();
|
|
let display_path = full_path.display(path_style);
|
|
let (directory, file_name) = display_path.split_at(display_path.len() - file_name.len());
|
|
(
|
|
file_name.to_string().into(),
|
|
Some(SharedString::new(directory)).filter(|dir| !dir.is_empty()),
|
|
)
|
|
}
|
|
|
|
pub fn render_file_context_entry(
|
|
id: ElementId,
|
|
worktree_id: WorktreeId,
|
|
path: &Arc<RelPath>,
|
|
path_prefix: &Arc<RelPath>,
|
|
is_directory: bool,
|
|
path_style: PathStyle,
|
|
context_store: WeakEntity<ContextStore>,
|
|
cx: &App,
|
|
) -> Stateful<Div> {
|
|
let (file_name, directory) = extract_file_name_and_directory(path, path_prefix, path_style);
|
|
|
|
let added = context_store.upgrade().and_then(|context_store| {
|
|
let project_path = ProjectPath {
|
|
worktree_id,
|
|
path: path.clone(),
|
|
};
|
|
if is_directory {
|
|
context_store
|
|
.read(cx)
|
|
.path_included_in_directory(&project_path, cx)
|
|
} else {
|
|
context_store.read(cx).file_path_included(&project_path, cx)
|
|
}
|
|
});
|
|
|
|
let file_icon = if is_directory {
|
|
FileIcons::get_folder_icon(false, path.as_std_path(), cx)
|
|
} else {
|
|
FileIcons::get_icon(path.as_std_path(), cx)
|
|
}
|
|
.map(Icon::from_path)
|
|
.unwrap_or_else(|| Icon::new(IconName::File));
|
|
|
|
h_flex()
|
|
.id(id)
|
|
.gap_1p5()
|
|
.w_full()
|
|
.child(file_icon.size(IconSize::Small).color(Color::Muted))
|
|
.child(
|
|
h_flex()
|
|
.gap_1()
|
|
.child(Label::new(file_name))
|
|
.children(directory.map(|directory| {
|
|
Label::new(directory)
|
|
.size(LabelSize::Small)
|
|
.color(Color::Muted)
|
|
})),
|
|
)
|
|
.when_some(added, |el, added| match added {
|
|
FileInclusion::Direct => el.child(
|
|
h_flex()
|
|
.w_full()
|
|
.justify_end()
|
|
.gap_0p5()
|
|
.child(
|
|
Icon::new(IconName::Check)
|
|
.size(IconSize::Small)
|
|
.color(Color::Success),
|
|
)
|
|
.child(Label::new("Added").size(LabelSize::Small)),
|
|
),
|
|
FileInclusion::InDirectory { full_path } => {
|
|
let directory_full_path = full_path.to_string_lossy().into_owned();
|
|
|
|
el.child(
|
|
h_flex()
|
|
.w_full()
|
|
.justify_end()
|
|
.gap_0p5()
|
|
.child(
|
|
Icon::new(IconName::Check)
|
|
.size(IconSize::Small)
|
|
.color(Color::Success),
|
|
)
|
|
.child(Label::new("Included").size(LabelSize::Small)),
|
|
)
|
|
.tooltip(Tooltip::text(format!("in {directory_full_path}")))
|
|
}
|
|
})
|
|
}
|