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 gpui::{AsyncAppContext, SharedString};
11use settings::WorktreeId;
12
13use crate::LanguageName;
14
15/// Represents a single toolchain.
16#[derive(Clone, Debug, PartialEq)]
17pub struct Toolchain {
18    /// User-facing label
19    pub name: SharedString,
20    pub path: SharedString,
21    pub language_name: LanguageName,
22}
23
24#[async_trait(?Send)]
25pub trait ToolchainLister: Send + Sync {
26    async fn list(&self, _: PathBuf) -> ToolchainList;
27}
28
29#[async_trait(?Send)]
30pub trait LanguageToolchainStore {
31    async fn active_toolchain(
32        self: Arc<Self>,
33        worktree_id: WorktreeId,
34        language_name: LanguageName,
35        cx: &mut AsyncAppContext,
36    ) -> Option<Toolchain>;
37}
38
39type DefaultIndex = usize;
40#[derive(Default, Clone)]
41pub struct ToolchainList {
42    pub toolchains: Vec<Toolchain>,
43    pub default: Option<DefaultIndex>,
44    pub groups: Box<[(usize, SharedString)]>,
45}
46
47impl ToolchainList {
48    pub fn toolchains(&self) -> &[Toolchain] {
49        &self.toolchains
50    }
51    pub fn default_toolchain(&self) -> Option<Toolchain> {
52        self.default.and_then(|ix| self.toolchains.get(ix)).cloned()
53    }
54    pub fn group_for_index(&self, index: usize) -> Option<(usize, SharedString)> {
55        if index >= self.toolchains.len() {
56            return None;
57        }
58        let first_equal_or_greater = self
59            .groups
60            .partition_point(|(group_lower_bound, _)| group_lower_bound <= &index);
61        self.groups
62            .get(first_equal_or_greater.checked_sub(1)?)
63            .cloned()
64    }
65}