oak-team/oak-gpui
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Represent relative paths using a dedicated, separator-agnostic type (#38744)

Browse Source 
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>
This commit is contained in:
Max Brunsfeld
2025-09-24 18:57:33 -04:00
committed by GitHub
co-authored by Cole Miller Piotr Osiewicz Peter Tripp Smit Barmase Lukas Wirth
parent 3c626f3758
commit 03f9cf4414
216 changed files with 5873 additions and 5257 deletions
Download Patch File Download Diff File Expand all files Collapse all files
crates/git_ui/src/commit_view.rs
+22 -13
View File
@@ -14,13 +14,12 @@ use multi_buffer::PathKey;
use project::{Project, WorktreeId, git_store::Repository};
use std::{
any::{Any, TypeId},
ffi::OsStr,
fmt::Write as _,
path::{Path, PathBuf},
path::PathBuf,
sync::Arc,
};
use ui::{Color, Icon, IconName, Label, LabelCommon as _, SharedString};
use util::{ResultExt, truncate_and_trailoff};
use util::{ResultExt, paths::PathStyle, rel_path::RelPath, truncate_and_trailoff};
use workspace::{
Item, ItemHandle as _, ItemNavHistory, ToolbarItemLocation, Workspace,
item::{BreadcrumbText, ItemEvent, TabContentParams},
@@ -40,7 +39,7 @@ struct GitBlob {
}
struct CommitMetadataFile {
title: Arc<Path>,
title: Arc<RelPath>,
worktree_id: WorktreeId,
}
@@ -129,7 +128,9 @@ impl CommitView {
let mut metadata_buffer_id = None;
if let Some(worktree_id) = first_worktree_id {
let file = Arc::new(CommitMetadataFile {
title: PathBuf::from(format!("commit {}", commit.sha)).into(),
title: RelPath::new(&format!("commit {}", commit.sha))
.unwrap()
.into(),
worktree_id,
});
let buffer = cx.new(|cx| {
@@ -144,7 +145,7 @@ impl CommitView {
});
multibuffer.update(cx, |multibuffer, cx| {
multibuffer.set_excerpts_for_path(
PathKey::namespaced(COMMIT_METADATA_NAMESPACE, file.title.clone()),
PathKey::namespaced(COMMIT_METADATA_NAMESPACE, file.title.as_str().into()),
buffer.clone(),
vec![Point::zero()..buffer.read(cx).max_point()],
0,
@@ -192,7 +193,7 @@ impl CommitView {
.collect::<Vec<_>>();
let path = snapshot.file().unwrap().path().clone();
let _is_newly_added = multibuffer.set_excerpts_for_path(
PathKey::namespaced(FILE_NAMESPACE, path),
PathKey::namespaced(FILE_NAMESPACE, path.as_str().into()),
buffer,
diff_hunk_ranges,
multibuffer_context_lines(cx),
@@ -227,15 +228,19 @@ impl language::File for GitBlob {
}
}
fn path(&self) -> &Arc<Path> {
fn path_style(&self, _: &App) -> PathStyle {
PathStyle::Posix
}
fn path(&self) -> &Arc<RelPath> {
&self.path.0
}
fn full_path(&self, _: &App) -> PathBuf {
self.path.to_path_buf()
self.path.as_std_path().to_path_buf()
}
fn file_name<'a>(&'a self, _: &'a App) -> &'a OsStr {
fn file_name<'a>(&'a self, _: &'a App) -> &'a str {
self.path.file_name().unwrap()
}
@@ -261,15 +266,19 @@ impl language::File for CommitMetadataFile {
DiskState::New
}
fn path(&self) -> &Arc<Path> {
fn path_style(&self, _: &App) -> PathStyle {
PathStyle::Posix
}
fn path(&self) -> &Arc<RelPath> {
&self.title
}
fn full_path(&self, _: &App) -> PathBuf {
self.title.as_ref().into()
PathBuf::from(self.title.as_str().to_owned())
}
fn file_name<'a>(&'a self, _: &'a App) -> &'a OsStr {
fn file_name<'a>(&'a self, _: &'a App) -> &'a str {
self.title.file_name().unwrap()
}
crates/git_ui/src/git_panel.rs
+44 -52
View File
@@ -53,7 +53,7 @@ use serde::{Deserialize, Serialize};
use settings::{Settings, SettingsStore, StatusStyle};
use std::future::Future;
use std::ops::Range;
use std::path::{Path, PathBuf};
use std::path::Path;
use std::{collections::HashSet, sync::Arc, time::Duration, usize};
use strum::{IntoEnumIterator, VariantNames};
use time::OffsetDateTime;
@@ -61,6 +61,7 @@ use ui::{
Checkbox, CommonAnimationExt, ContextMenu, ElevationIndex, IconPosition, Label, LabelSize,
PopoverMenu, ScrollAxes, Scrollbars, SplitButton, Tooltip, WithScrollbar, prelude::*,
};
use util::paths::PathStyle;
use util::{ResultExt, TryFutureExt, maybe};
use workspace::SERIALIZATION_THROTTLE_TIME;
@@ -251,23 +252,22 @@ impl GitListEntry {
#[derive(Debug, PartialEq, Eq, Clone)]
pub struct GitStatusEntry {
pub(crate) repo_path: RepoPath,
pub(crate) abs_path: PathBuf,
pub(crate) status: FileStatus,
pub(crate) staging: StageStatus,
}
impl GitStatusEntry {
fn display_name(&self) -> String {
fn display_name(&self, path_style: PathStyle) -> String {
self.repo_path
.file_name()
.map(|name| name.to_string_lossy().into_owned())
.unwrap_or_else(|| self.repo_path.to_string_lossy().into_owned())
.map(|name| name.to_owned())
.unwrap_or_else(|| self.repo_path.display(path_style).to_string())
}
fn parent_dir(&self) -> Option<String> {
fn parent_dir(&self, path_style: PathStyle) -> Option<String> {
self.repo_path
.parent()
.map(|parent| parent.to_string_lossy().into_owned())
.map(|parent| parent.display(path_style).to_string())
}
}
@@ -826,6 +826,7 @@ impl GitPanel {
window: &mut Window,
cx: &mut Context<Self>,
) {
let path_style = self.project.read(cx).path_style(cx);
maybe!({
let list_entry = self.entries.get(self.selected_entry?)?.clone();
let entry = list_entry.status_entry()?.to_owned();
@@ -841,8 +842,7 @@ impl GitPanel {
entry
.repo_path
.file_name()
.unwrap_or(entry.repo_path.as_os_str())
.to_string_lossy()
.unwrap_or(entry.repo_path.display(path_style).as_ref()),
),
None,
&["Restore", "Cancel"],
@@ -885,7 +885,7 @@ impl GitPanel {
if entry.status.staging().has_staged() {
self.change_file_stage(false, vec![entry.clone()], cx);
}
let filename = path.path.file_name()?.to_string_lossy();
let filename = path.path.file_name()?.to_string();
if !entry.status.is_created() {
self.perform_checkout(vec![entry.clone()], window, cx);
@@ -1028,7 +1028,7 @@ impl GitPanel {
let mut details = entries
.iter()
.filter_map(|entry| entry.repo_path.0.file_name())
.map(|filename| filename.to_string_lossy())
.map(|filename| filename.to_string())
.take(5)
.join("\n");
if entries.len() > 5 {
@@ -1084,7 +1084,7 @@ impl GitPanel {
.repo_path
.0
.file_name()
.map(|f| f.to_string_lossy())
.map(|f| f.to_string())
.unwrap_or_default()
})
.take(5)
@@ -1721,7 +1721,7 @@ impl GitPanel {
.repo_path
.file_name()
.unwrap_or_default()
.to_string_lossy();
.to_string();
Some(format!("{} {}", action_text, file_name))
}
@@ -1973,11 +1973,7 @@ impl GitPanel {
cx.spawn_in(window, async move |this, cx| {
let mut paths = path.await.ok()?.ok()??;
let mut path = paths.pop()?;
let repo_name = repo
.split(std::path::MAIN_SEPARATOR_STR)
.last()?
.strip_suffix(".git")?
.to_owned();
let repo_name = repo.split("/").last()?.strip_suffix(".git")?.to_owned();
let fs = this.read_with(cx, |this, _| this.fs.clone()).ok()?;
@@ -2558,6 +2554,7 @@ impl GitPanel {
}
fn update_visible_entries(&mut self, window: &mut Window, cx: &mut Context<Self>) {
let path_style = self.project.read(cx).path_style(cx);
let bulk_staging = self.bulk_staging.take();
let last_staged_path_prev_index = bulk_staging
.as_ref()
@@ -2609,10 +2606,8 @@ impl GitPanel {
continue;
}
let abs_path = repo.work_directory_abs_path.join(&entry.repo_path.0);
let entry = GitStatusEntry {
repo_path: entry.repo_path.clone(),
abs_path,
status: entry.status,
staging,
};
@@ -2623,8 +2618,8 @@ impl GitPanel {
}
let width_estimate = Self::item_width_estimate(
entry.parent_dir().map(|s| s.len()).unwrap_or(0),
entry.display_name().len(),
entry.parent_dir(path_style).map(|s| s.len()).unwrap_or(0),
entry.display_name(path_style).len(),
);
match max_width_item.as_mut() {
@@ -3634,7 +3629,7 @@ impl GitPanel {
cx: &App,
) -> Option<AnyElement> {
let repo = self.active_repository.as_ref()?.read(cx);
let project_path = (file.worktree_id(cx), file.path()).into();
let project_path = (file.worktree_id(cx), file.path().clone()).into();
let repo_path = repo.project_path_to_repo_path(&project_path, cx)?;
let ix = self.entry_by_path(&repo_path, cx)?;
let entry = self.entries.get(ix)?;
@@ -3887,7 +3882,8 @@ impl GitPanel {
window: &Window,
cx: &Context<Self>,
) -> AnyElement {
let display_name = entry.display_name();
let path_style = self.project.read(cx).path_style(cx);
let display_name = entry.display_name(path_style);
let selected = self.selected_entry == Some(ix);
let marked = self.marked_entries.contains(&ix);
@@ -4060,11 +4056,14 @@ impl GitPanel {
.items_center()
.flex_1()
// .overflow_hidden()
.when_some(entry.parent_dir(), |this, parent| {
.when_some(entry.parent_dir(path_style), |this, parent| {
if !parent.is_empty() {
this.child(
self.entry_label(format!("{}/", parent), path_color)
.when(status.is_deleted(), |this| this.strikethrough()),
self.entry_label(
format!("{parent}{}", path_style.separator()),
path_color,
)
.when(status.is_deleted(), |this| this.strikethrough()),
)
} else {
this
@@ -4889,7 +4888,10 @@ impl Component for PanelRepoFooter {
#[cfg(test)]
mod tests {
use git::status::{StatusCode, UnmergedStatus, UnmergedStatusCode};
use git::{
repository::repo_path,
status::{StatusCode, UnmergedStatus, UnmergedStatusCode},
};
use gpui::{TestAppContext, VisualTestContext};
use project::{FakeFs, WorktreeSettings};
use serde_json::json;
@@ -4941,14 +4943,8 @@ mod tests {
fs.set_status_for_repo(
Path::new(path!("/root/zed/.git")),
&[
(
Path::new("crates/gpui/gpui.rs"),
StatusCode::Modified.worktree(),
),
(
Path::new("crates/util/util.rs"),
StatusCode::Modified.worktree(),
),
("crates/gpui/gpui.rs", StatusCode::Modified.worktree()),
("crates/util/util.rs", StatusCode::Modified.worktree()),
],
);
@@ -4989,14 +4985,12 @@ mod tests {
header: Section::Tracked
}),
GitListEntry::Status(GitStatusEntry {
abs_path: path!("/root/zed/crates/gpui/gpui.rs").into(),
repo_path: "crates/gpui/gpui.rs".into(),
repo_path: repo_path("crates/gpui/gpui.rs"),
status: StatusCode::Modified.worktree(),
staging: StageStatus::Unstaged,
}),
GitListEntry::Status(GitStatusEntry {
abs_path: path!("/root/zed/crates/util/util.rs").into(),
repo_path: "crates/util/util.rs".into(),
repo_path: repo_path("crates/util/util.rs"),
status: StatusCode::Modified.worktree(),
staging: StageStatus::Unstaged,
},),
@@ -5016,14 +5010,12 @@ mod tests {
header: Section::Tracked
}),
GitListEntry::Status(GitStatusEntry {
abs_path: path!("/root/zed/crates/gpui/gpui.rs").into(),
repo_path: "crates/gpui/gpui.rs".into(),
repo_path: repo_path("crates/gpui/gpui.rs"),
status: StatusCode::Modified.worktree(),
staging: StageStatus::Unstaged,
}),
GitListEntry::Status(GitStatusEntry {
abs_path: path!("/root/zed/crates/util/util.rs").into(),
repo_path: "crates/util/util.rs".into(),
repo_path: repo_path("crates/util/util.rs"),
status: StatusCode::Modified.worktree(),
staging: StageStatus::Unstaged,
},),
@@ -5061,14 +5053,14 @@ mod tests {
fs.set_status_for_repo(
Path::new(path!("/root/project/.git")),
&[
(Path::new("src/main.rs"), StatusCode::Modified.worktree()),
(Path::new("src/lib.rs"), StatusCode::Modified.worktree()),
(Path::new("tests/test.rs"), StatusCode::Modified.worktree()),
(Path::new("new_file.txt"), FileStatus::Untracked),
(Path::new("another_new.rs"), FileStatus::Untracked),
(Path::new("src/utils.rs"), FileStatus::Untracked),
("src/main.rs", StatusCode::Modified.worktree()),
("src/lib.rs", StatusCode::Modified.worktree()),
("tests/test.rs", StatusCode::Modified.worktree()),
("new_file.txt", FileStatus::Untracked),
("another_new.rs", FileStatus::Untracked),
("src/utils.rs", FileStatus::Untracked),
(
Path::new("conflict.txt"),
"conflict.txt",
UnmergedStatus {
first_head: UnmergedStatusCode::Updated,
second_head: UnmergedStatusCode::Updated,
@@ -5242,7 +5234,7 @@ mod tests {
fs.set_status_for_repo(
Path::new(path!("/root/project/.git")),
&[(Path::new("src/main.rs"), StatusCode::Modified.worktree())],
&[("src/main.rs", StatusCode::Modified.worktree())],
);
let project = Project::test(fs.clone(), [Path::new(path!("/root/project"))], cx).await;
crates/git_ui/src/project_diff.rs
+16 -19
View File
@@ -243,7 +243,7 @@ impl ProjectDiff {
TRACKED_NAMESPACE
};
let path_key = PathKey::namespaced(namespace, entry.repo_path.0);
let path_key = PathKey::namespaced(namespace, entry.repo_path.as_str().into());
self.move_to_path(path_key, window, cx)
}
@@ -397,7 +397,7 @@ impl ProjectDiff {
} else {
TRACKED_NAMESPACE
};
let path_key = PathKey::namespaced(namespace, entry.repo_path.0.clone());
let path_key = PathKey::namespaced(namespace, entry.repo_path.as_str().into());
previous_paths.remove(&path_key);
let load_buffer = self
@@ -535,7 +535,7 @@ impl ProjectDiff {
self.multibuffer
.read(cx)
.excerpt_paths()
.map(|key| key.path().to_string_lossy().to_string())
.map(|key| key.path().to_string())
.collect()
}
}
@@ -1406,12 +1406,12 @@ mod tests {
fs.set_head_for_repo(
path!("/project/.git").as_ref(),
&[("foo.txt".into(), "foo\n".into())],
&[("foo.txt", "foo\n".into())],
"deadbeef",
);
fs.set_index_for_repo(
path!("/project/.git").as_ref(),
&[("foo.txt".into(), "foo\n".into())],
&[("foo.txt", "foo\n".into())],
);
cx.run_until_parked();
@@ -1461,16 +1461,13 @@ mod tests {
fs.set_head_and_index_for_repo(
path!("/project/.git").as_ref(),
&[
("bar".into(), "bar\n".into()),
("foo".into(), "foo\n".into()),
],
&[("bar", "bar\n".into()), ("foo", "foo\n".into())],
);
cx.run_until_parked();
let editor = cx.update_window_entity(&diff, |diff, window, cx| {
diff.move_to_path(
PathKey::namespaced(TRACKED_NAMESPACE, Path::new("foo").into()),
PathKey::namespaced(TRACKED_NAMESPACE, "foo".into()),
window,
cx,
);
@@ -1491,7 +1488,7 @@ mod tests {
let editor = cx.update_window_entity(&diff, |diff, window, cx| {
diff.move_to_path(
PathKey::namespaced(TRACKED_NAMESPACE, Path::new("bar").into()),
PathKey::namespaced(TRACKED_NAMESPACE, "bar".into()),
window,
cx,
);
@@ -1543,7 +1540,7 @@ mod tests {
fs.set_head_for_repo(
path!("/project/.git").as_ref(),
&[("foo".into(), "original\n".into())],
&[("foo", "original\n".into())],
"deadbeef",
);
cx.run_until_parked();
@@ -1646,12 +1643,12 @@ mod tests {
)
.await;
fs.set_git_content_for_repo(
fs.set_head_and_index_for_repo(
Path::new("/a/.git"),
&[
("b.txt".into(), "before\n".to_string(), None),
("c.txt".into(), "unchanged\n".to_string(), None),
("d.txt".into(), "deleted\n".to_string(), None),
("b.txt", "before\n".to_string()),
("c.txt", "unchanged\n".to_string()),
("d.txt", "deleted\n".to_string()),
],
);
@@ -1764,9 +1761,9 @@ mod tests {
)
.await;
fs.set_git_content_for_repo(
fs.set_head_and_index_for_repo(
Path::new("/a/.git"),
&[("main.rs".into(), git_contents.to_owned(), None)],
&[("main.rs", git_contents.to_owned())],
);
let project = Project::test(fs, [Path::new("/a")], cx).await;
@@ -1816,7 +1813,7 @@ mod tests {
fs.set_status_for_repo(
Path::new(path!("/project/.git")),
&[(
Path::new("foo"),
"foo",
UnmergedStatus {
first_head: UnmergedStatusCode::Updated,
second_head: UnmergedStatusCode::Updated,