toolchain.rs

 1//! Provides support for language toolchains.
 2//!
 3//! A language can have associated toolchains,
 4//! which is a set of tools used to interact with the projects written in said language.
 5//! For example, a Python project can have an associated virtual environment; a Rust project can have a toolchain override.
 6
 7use std::{path::PathBuf, sync::Arc};
 8
 9use async_trait::async_trait;
10use collections::HashMap;
11use gpui::{AsyncAppContext, SharedString};
12use settings::WorktreeId;
13
14use crate::LanguageName;
15
16/// Represents a single toolchain.
17#[derive(Clone, Debug, PartialEq)]
18pub struct Toolchain {
19    /// User-facing label
20    pub name: SharedString,
21    pub path: SharedString,
22    pub language_name: LanguageName,
23    /// Full toolchain data (including language-specific details)
24    pub as_json: serde_json::Value,
25}
26
27#[async_trait(?Send)]
28pub trait ToolchainLister: Send + Sync {
29    async fn list(
30        &self,
31        worktree_root: PathBuf,
32        project_env: Option<HashMap<String, String>>,
33    ) -> ToolchainList;
34}
35
36#[async_trait(?Send)]
37pub trait LanguageToolchainStore {
38    async fn active_toolchain(
39        self: Arc<Self>,
40        worktree_id: WorktreeId,
41        language_name: LanguageName,
42        cx: &mut AsyncAppContext,
43    ) -> Option<Toolchain>;
44}
45
46type DefaultIndex = usize;
47#[derive(Default, Clone)]
48pub struct ToolchainList {
49    pub toolchains: Vec<Toolchain>,
50    pub default: Option<DefaultIndex>,
51    pub groups: Box<[(usize, SharedString)]>,
52}
53
54impl ToolchainList {
55    pub fn toolchains(&self) -> &[Toolchain] {
56        &self.toolchains
57    }
58    pub fn default_toolchain(&self) -> Option<Toolchain> {
59        self.default.and_then(|ix| self.toolchains.get(ix)).cloned()
60    }
61    pub fn group_for_index(&self, index: usize) -> Option<(usize, SharedString)> {
62        if index >= self.toolchains.len() {
63            return None;
64        }
65        let first_equal_or_greater = self
66            .groups
67            .partition_point(|(group_lower_bound, _)| group_lower_bound <= &index);
68        self.groups
69            .get(first_equal_or_greater.checked_sub(1)?)
70            .cloned()
71    }
72}