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}
24
25#[async_trait(?Send)]
26pub trait ToolchainLister: Send + Sync {
27    async fn list(
28        &self,
29        worktree_root: PathBuf,
30        project_env: Option<HashMap<String, String>>,
31    ) -> ToolchainList;
32}
33
34#[async_trait(?Send)]
35pub trait LanguageToolchainStore {
36    async fn active_toolchain(
37        self: Arc<Self>,
38        worktree_id: WorktreeId,
39        language_name: LanguageName,
40        cx: &mut AsyncAppContext,
41    ) -> Option<Toolchain>;
42}
43
44type DefaultIndex = usize;
45#[derive(Default, Clone)]
46pub struct ToolchainList {
47    pub toolchains: Vec<Toolchain>,
48    pub default: Option<DefaultIndex>,
49    pub groups: Box<[(usize, SharedString)]>,
50}
51
52impl ToolchainList {
53    pub fn toolchains(&self) -> &[Toolchain] {
54        &self.toolchains
55    }
56    pub fn default_toolchain(&self) -> Option<Toolchain> {
57        self.default.and_then(|ix| self.toolchains.get(ix)).cloned()
58    }
59    pub fn group_for_index(&self, index: usize) -> Option<(usize, SharedString)> {
60        if index >= self.toolchains.len() {
61            return None;
62        }
63        let first_equal_or_greater = self
64            .groups
65            .partition_point(|(group_lower_bound, _)| group_lower_bound <= &index);
66        self.groups
67            .get(first_equal_or_greater.checked_sub(1)?)
68            .cloned()
69    }
70}