Files
zed/crates/toolchain_selector/src/active_toolchain.rs
Max Brunsfeld 03f9cf4414 Represent relative paths using a dedicated, separator-agnostic type (#38744)
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>
2025-09-24 18:57:33 -04:00

264 lines
9.8 KiB
Rust

use std::sync::Arc;
use editor::Editor;
use gpui::{
AsyncWindowContext, Context, Entity, IntoElement, ParentElement, Render, Subscription, Task,
WeakEntity, Window, div,
};
use language::{Buffer, BufferEvent, LanguageName, Toolchain, ToolchainScope};
use project::{Project, ProjectPath, Toolchains, WorktreeId, toolchain_store::ToolchainStoreEvent};
use ui::{Button, ButtonCommon, Clickable, FluentBuilder, LabelSize, SharedString, Tooltip};
use util::{maybe, rel_path::RelPath};
use workspace::{StatusItemView, Workspace, item::ItemHandle};
use crate::ToolchainSelector;
pub struct ActiveToolchain {
active_toolchain: Option<Toolchain>,
term: SharedString,
workspace: WeakEntity<Workspace>,
active_buffer: Option<(WorktreeId, WeakEntity<Buffer>, Subscription)>,
_update_toolchain_task: Task<Option<()>>,
}
impl ActiveToolchain {
pub fn new(workspace: &Workspace, window: &mut Window, cx: &mut Context<Self>) -> Self {
if let Some(store) = workspace.project().read(cx).toolchain_store() {
cx.subscribe_in(
&store,
window,
|this, _, _: &ToolchainStoreEvent, window, cx| {
let editor = this
.workspace
.update(cx, |workspace, cx| {
workspace
.active_item(cx)
.and_then(|item| item.downcast::<Editor>())
})
.ok()
.flatten();
if let Some(editor) = editor {
this.update_lister(editor, window, cx);
}
},
)
.detach();
}
Self {
active_toolchain: None,
active_buffer: None,
term: SharedString::new_static("Toolchain"),
workspace: workspace.weak_handle(),
_update_toolchain_task: Self::spawn_tracker_task(window, cx),
}
}
fn spawn_tracker_task(window: &mut Window, cx: &mut Context<Self>) -> Task<Option<()>> {
cx.spawn_in(window, async move |this, cx| {
let did_set_toolchain = maybe!(async {
let active_file = this
.read_with(cx, |this, _| {
this.active_buffer
.as_ref()
.map(|(_, buffer, _)| buffer.clone())
})
.ok()
.flatten()?;
let workspace = this.read_with(cx, |this, _| this.workspace.clone()).ok()?;
let language_name = active_file
.read_with(cx, |this, _| Some(this.language()?.name()))
.ok()
.flatten()?;
let meta = workspace
.update(cx, |workspace, cx| {
let languages = workspace.project().read(cx).languages();
Project::toolchain_metadata(languages.clone(), language_name.clone())
})
.ok()?
.await?;
let _ = this.update(cx, |this, cx| {
this.term = meta.term;
cx.notify();
});
let (worktree_id, path) = active_file
.update(cx, |this, cx| {
this.file().and_then(|file| {
Some((file.worktree_id(cx), file.path().parent()?.into()))
})
})
.ok()
.flatten()?;
let toolchain =
Self::active_toolchain(workspace, worktree_id, path, language_name, cx).await?;
this.update(cx, |this, cx| {
this.active_toolchain = Some(toolchain);
cx.notify();
})
.ok()
})
.await
.is_some();
if !did_set_toolchain {
this.update(cx, |this, cx| {
this.active_toolchain = None;
cx.notify();
})
.ok();
}
did_set_toolchain.then_some(())
})
}
fn update_lister(
&mut self,
editor: Entity<Editor>,
window: &mut Window,
cx: &mut Context<Self>,
) {
let editor = editor.read(cx);
if let Some((_, buffer, _)) = editor.active_excerpt(cx)
&& let Some(worktree_id) = buffer.read(cx).file().map(|file| file.worktree_id(cx))
{
let subscription = cx.subscribe_in(
&buffer,
window,
|this, _, event: &BufferEvent, window, cx| {
if matches!(event, BufferEvent::LanguageChanged) {
this._update_toolchain_task = Self::spawn_tracker_task(window, cx);
}
},
);
self.active_buffer = Some((worktree_id, buffer.downgrade(), subscription));
self._update_toolchain_task = Self::spawn_tracker_task(window, cx);
}
cx.notify();
}
fn active_toolchain(
workspace: WeakEntity<Workspace>,
worktree_id: WorktreeId,
relative_path: Arc<RelPath>,
language_name: LanguageName,
cx: &mut AsyncWindowContext,
) -> Task<Option<Toolchain>> {
cx.spawn(async move |cx| {
let workspace_id = workspace
.read_with(cx, |this, _| this.database_id())
.ok()
.flatten()?;
let selected_toolchain = workspace
.update(cx, |this, cx| {
this.project().read(cx).active_toolchain(
ProjectPath {
worktree_id,
path: relative_path.clone(),
},
language_name.clone(),
cx,
)
})
.ok()?
.await;
if let Some(toolchain) = selected_toolchain {
Some(toolchain)
} else {
let project = workspace
.read_with(cx, |this, _| this.project().clone())
.ok()?;
let Toolchains {
toolchains,
root_path: relative_path,
user_toolchains,
} = cx
.update(|_, cx| {
project.read(cx).available_toolchains(
ProjectPath {
worktree_id,
path: relative_path.clone(),
},
language_name,
cx,
)
})
.ok()?
.await?;
// Since we don't have a selected toolchain, pick one for user here.
let default_choice = user_toolchains
.iter()
.find_map(|(scope, toolchains)| {
if scope == &ToolchainScope::Global {
// Ignore global toolchains when making a default choice. They're unlikely to be the right choice.
None
} else {
toolchains.first()
}
})
.or_else(|| toolchains.toolchains.first())
.cloned();
if let Some(toolchain) = &default_choice {
workspace::WORKSPACE_DB
.set_toolchain(
workspace_id,
worktree_id,
relative_path.clone(),
toolchain.clone(),
)
.await
.ok()?;
project
.update(cx, |this, cx| {
this.activate_toolchain(
ProjectPath {
worktree_id,
path: relative_path,
},
toolchain.clone(),
cx,
)
})
.ok()?
.await;
}
default_choice
}
})
}
}
impl Render for ActiveToolchain {
fn render(&mut self, _window: &mut Window, cx: &mut Context<Self>) -> impl IntoElement {
div().when_some(self.active_toolchain.as_ref(), |el, active_toolchain| {
let term = self.term.clone();
el.child(
Button::new("change-toolchain", active_toolchain.name.clone())
.label_size(LabelSize::Small)
.on_click(cx.listener(|this, _, window, cx| {
if let Some(workspace) = this.workspace.upgrade() {
workspace.update(cx, |workspace, cx| {
ToolchainSelector::toggle(workspace, window, cx)
});
}
}))
.tooltip(Tooltip::text(format!("Select {}", &term))),
)
})
}
}
impl StatusItemView for ActiveToolchain {
fn set_active_pane_item(
&mut self,
active_pane_item: Option<&dyn ItemHandle>,
window: &mut Window,
cx: &mut Context<Self>,
) {
if let Some(editor) = active_pane_item.and_then(|item| item.downcast::<Editor>()) {
self.update_lister(editor, window, cx);
}
cx.notify();
}
}