terminal_settings.rs

  1use std::{collections::HashMap, path::PathBuf};
  2
  3use gpui::{fonts, AppContext};
  4use schemars::JsonSchema;
  5use serde_derive::{Deserialize, Serialize};
  6
  7#[derive(Copy, Clone, Debug, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
  8#[serde(rename_all = "snake_case")]
  9pub enum TerminalDockPosition {
 10    Left,
 11    Bottom,
 12    Right,
 13}
 14
 15#[derive(Deserialize)]
 16pub struct TerminalSettings {
 17    pub shell: Shell,
 18    pub working_directory: WorkingDirectory,
 19    font_size: Option<f32>,
 20    pub font_family: Option<String>,
 21    pub line_height: TerminalLineHeight,
 22    pub font_features: Option<fonts::Features>,
 23    pub env: HashMap<String, String>,
 24    pub blinking: TerminalBlink,
 25    pub alternate_scroll: AlternateScroll,
 26    pub option_as_meta: bool,
 27    pub copy_on_select: bool,
 28    pub dock: TerminalDockPosition,
 29    pub default_width: f32,
 30    pub default_height: f32,
 31    pub detect_venv: VenvSettings,
 32}
 33
 34#[derive(Clone, Debug, Default, Serialize, Deserialize, JsonSchema)]
 35#[serde(rename_all = "snake_case")]
 36pub enum VenvSettings {
 37    #[default]
 38    Off,
 39    On {
 40        activate_script: Option<ActivateScript>,
 41        directories: Option<Vec<PathBuf>>,
 42    },
 43}
 44
 45pub struct VenvSettingsContent<'a> {
 46    pub activate_script: ActivateScript,
 47    pub directories: &'a [PathBuf],
 48}
 49
 50impl VenvSettings {
 51    pub fn as_option(&self) -> Option<VenvSettingsContent> {
 52        match self {
 53            VenvSettings::Off => None,
 54            VenvSettings::On {
 55                activate_script,
 56                directories,
 57            } => Some(VenvSettingsContent {
 58                activate_script: activate_script.unwrap_or(ActivateScript::Default),
 59                directories: directories.as_deref().unwrap_or(&[]),
 60            }),
 61        }
 62    }
 63}
 64
 65#[derive(Clone, Copy, Debug, Default, Serialize, Deserialize, JsonSchema)]
 66#[serde(rename_all = "snake_case")]
 67pub enum ActivateScript {
 68    #[default]
 69    Default,
 70    Csh,
 71    Fish,
 72    Nushell,
 73}
 74
 75#[derive(Clone, Debug, Default, Serialize, Deserialize, JsonSchema)]
 76pub struct TerminalSettingsContent {
 77    pub shell: Option<Shell>,
 78    pub working_directory: Option<WorkingDirectory>,
 79    pub font_size: Option<f32>,
 80    pub font_family: Option<String>,
 81    pub line_height: Option<TerminalLineHeight>,
 82    pub font_features: Option<fonts::Features>,
 83    pub env: Option<HashMap<String, String>>,
 84    pub blinking: Option<TerminalBlink>,
 85    pub alternate_scroll: Option<AlternateScroll>,
 86    pub option_as_meta: Option<bool>,
 87    pub copy_on_select: Option<bool>,
 88    pub dock: Option<TerminalDockPosition>,
 89    pub default_width: Option<f32>,
 90    pub default_height: Option<f32>,
 91    pub detect_venv: Option<VenvSettings>,
 92}
 93
 94impl TerminalSettings {
 95    pub fn font_size(&self, cx: &AppContext) -> Option<f32> {
 96        self.font_size
 97            .map(|size| theme::adjusted_font_size(size, cx))
 98    }
 99}
100
101impl settings::Setting for TerminalSettings {
102    const KEY: Option<&'static str> = Some("terminal");
103
104    type FileContent = TerminalSettingsContent;
105
106    fn load(
107        default_value: &Self::FileContent,
108        user_values: &[&Self::FileContent],
109        _: &AppContext,
110    ) -> anyhow::Result<Self> {
111        Self::load_via_json_merge(default_value, user_values)
112    }
113}
114
115#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, JsonSchema, Default)]
116#[serde(rename_all = "snake_case")]
117pub enum TerminalLineHeight {
118    #[default]
119    Comfortable,
120    Standard,
121    Custom(f32),
122}
123
124impl TerminalLineHeight {
125    pub fn value(&self) -> f32 {
126        match self {
127            TerminalLineHeight::Comfortable => 1.618,
128            TerminalLineHeight::Standard => 1.3,
129            TerminalLineHeight::Custom(line_height) => f32::max(*line_height, 1.),
130        }
131    }
132}
133
134#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
135#[serde(rename_all = "snake_case")]
136pub enum TerminalBlink {
137    Off,
138    TerminalControlled,
139    On,
140}
141
142#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
143#[serde(rename_all = "snake_case")]
144pub enum Shell {
145    System,
146    Program(String),
147    WithArguments { program: String, args: Vec<String> },
148}
149
150#[derive(Clone, Copy, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
151#[serde(rename_all = "snake_case")]
152pub enum AlternateScroll {
153    On,
154    Off,
155}
156
157#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
158#[serde(rename_all = "snake_case")]
159pub enum WorkingDirectory {
160    CurrentProjectDirectory,
161    FirstProjectDirectory,
162    AlwaysHome,
163    Always { directory: String },
164}