zed/crates/settings/src/settings_ui_core.rs

use std::{
    any::TypeId,
    num::{NonZeroU32, NonZeroUsize},
    rc::Rc,
};

use anyhow::Context as _;
use fs::Fs;
use gpui::{AnyElement, App, AppContext as _, ReadGlobal as _, SharedString, Window};
use smallvec::SmallVec;

use crate::SettingsStore;

pub trait SettingsUi {
    fn settings_ui_item() -> SettingsUiItem {
        // todo(settings_ui): remove this default impl, only entry should have a default impl
        // because it's expected that the macro or custom impl use the item and the known paths to create the entry
        SettingsUiItem::None
    }

    fn settings_ui_entry() -> SettingsUiEntry {
        SettingsUiEntry {
            path: None,
            title: "None entry",
            item: SettingsUiItem::None,
            documentation: None,
        }
    }
}

#[derive(Clone)]
pub struct SettingsUiEntry {
    /// The path in the settings JSON file for this setting. Relative to parent
    /// None implies `#[serde(flatten)]` or `Settings::KEY.is_none()` for top level settings
    pub path: Option<&'static str>,
    /// What is displayed for the text for this entry
    pub title: &'static str,
    /// documentation for this entry. Constructed from the documentation comment above the struct or field
    pub documentation: Option<&'static str>,
    pub item: SettingsUiItem,
}

#[derive(Clone)]
pub enum SettingsUiItemSingle {
    SwitchField,
    TextField,
    /// A numeric stepper for a specific type of number
    NumericStepper(NumType),
    ToggleGroup {
        /// Must be the same length as `labels`
        variants: &'static [&'static str],
        /// Must be the same length as `variants`
        labels: &'static [&'static str],
    },
    /// This should be used when toggle group size > 6
    DropDown {
        /// Must be the same length as `labels`
        variants: &'static [&'static str],
        /// Must be the same length as `variants`
        labels: &'static [&'static str],
    },
    Custom(Rc<dyn Fn(SettingsValue<serde_json::Value>, &mut Window, &mut App) -> AnyElement>),
}

pub struct SettingsValue<T> {
    pub title: SharedString,
    pub documentation: Option<SharedString>,
    pub path: SmallVec<[SharedString; 1]>,
    pub value: Option<T>,
    pub default_value: T,
}

impl<T> SettingsValue<T> {
    pub fn read(&self) -> &T {
        match &self.value {
            Some(value) => value,
            None => &self.default_value,
        }
    }
}

impl SettingsValue<serde_json::Value> {
    pub fn write_value(path: &SmallVec<[SharedString; 1]>, value: serde_json::Value, cx: &mut App) {
        let settings_store = SettingsStore::global(cx);
        let fs = <dyn Fs>::global(cx);

        let rx = settings_store.update_settings_file_at_path(fs.clone(), path.as_slice(), value);

        let path = path.clone();
        cx.background_spawn(async move {
            rx.await?
                .with_context(|| format!("Failed to update setting at path `{:?}`", path.join(".")))
        })
        .detach_and_log_err(cx);
    }
}

impl<T: serde::Serialize> SettingsValue<T> {
    pub fn write(
        path: &SmallVec<[SharedString; 1]>,
        value: T,
        cx: &mut App,
    ) -> Result<(), serde_json::Error> {
        SettingsValue::write_value(path, serde_json::to_value(value)?, cx);
        Ok(())
    }
}

#[derive(Clone)]
pub struct SettingsUiItemUnion {
    /// Must be the same length as `labels` and `options`
    pub defaults: Box<[serde_json::Value]>,
    /// Must be the same length as defaults` and `options`
    pub labels: &'static [&'static str],
    /// Must be the same length as `defaults` and `labels`
    pub options: Box<[Option<SettingsUiEntry>]>,
    pub determine_option: fn(&serde_json::Value, &App) -> usize,
}

// todo(settings_ui): use in ToggleGroup and Dropdown
#[derive(Clone)]
pub struct SettingsEnumVariants {}

pub struct SettingsUiEntryMetaData {
    pub title: SharedString,
    pub path: SharedString,
    pub documentation: Option<SharedString>,
}

#[derive(Clone)]
pub struct SettingsUiItemDynamicMap {
    pub item: fn() -> SettingsUiItem,
    pub determine_items: fn(&serde_json::Value, &App) -> Vec<SettingsUiEntryMetaData>,
    pub defaults_path: &'static [&'static str],
}

#[derive(Clone)]
pub struct SettingsUiItemGroup {
    pub items: Vec<SettingsUiEntry>,
}

#[derive(Clone)]
pub enum SettingsUiItem {
    Group(SettingsUiItemGroup),
    Single(SettingsUiItemSingle),
    Union(SettingsUiItemUnion),
    DynamicMap(SettingsUiItemDynamicMap),
    // Array(SettingsUiItemArray), // code-actions: array of objects, array of string
    None,
}

impl SettingsUi for bool {
    fn settings_ui_item() -> SettingsUiItem {
        SettingsUiItem::Single(SettingsUiItemSingle::SwitchField)
    }
}

impl SettingsUi for Option<bool> {
    fn settings_ui_item() -> SettingsUiItem {
        SettingsUiItem::Single(SettingsUiItemSingle::SwitchField)
    }
}

impl SettingsUi for String {
    fn settings_ui_item() -> SettingsUiItem {
        SettingsUiItem::Single(SettingsUiItemSingle::TextField)
    }
}

impl SettingsUi for SettingsUiItem {
    fn settings_ui_item() -> SettingsUiItem {
        SettingsUiItem::Single(SettingsUiItemSingle::TextField)
    }
}

#[repr(u8)]
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum NumType {
    U64 = 0,
    U32 = 1,
    F32 = 2,
    USIZE = 3,
    U32NONZERO = 4,
}

pub static NUM_TYPE_NAMES: std::sync::LazyLock<[&'static str; NumType::COUNT]> =
    std::sync::LazyLock::new(|| NumType::ALL.map(NumType::type_name));
pub static NUM_TYPE_IDS: std::sync::LazyLock<[TypeId; NumType::COUNT]> =
    std::sync::LazyLock::new(|| NumType::ALL.map(NumType::type_id));

impl NumType {
    const COUNT: usize = 3;
    const ALL: [NumType; Self::COUNT] = [NumType::U64, NumType::U32, NumType::F32];

    pub fn type_id(self) -> TypeId {
        match self {
            NumType::U64 => TypeId::of::<u64>(),
            NumType::U32 => TypeId::of::<u32>(),
            NumType::F32 => TypeId::of::<f32>(),
            NumType::USIZE => TypeId::of::<usize>(),
            NumType::U32NONZERO => TypeId::of::<NonZeroU32>(),
        }
    }

    pub fn type_name(self) -> &'static str {
        match self {
            NumType::U64 => std::any::type_name::<u64>(),
            NumType::U32 => std::any::type_name::<u32>(),
            NumType::F32 => std::any::type_name::<f32>(),
            NumType::USIZE => std::any::type_name::<usize>(),
            NumType::U32NONZERO => std::any::type_name::<NonZeroU32>(),
        }
    }
}

macro_rules! numeric_stepper_for_num_type {
    ($type:ty, $num_type:ident) => {
        impl SettingsUi for $type {
            fn settings_ui_item() -> SettingsUiItem {
                SettingsUiItem::Single(SettingsUiItemSingle::NumericStepper(NumType::$num_type))
            }
        }

        impl SettingsUi for Option<$type> {
            fn settings_ui_item() -> SettingsUiItem {
                SettingsUiItem::Single(SettingsUiItemSingle::NumericStepper(NumType::$num_type))
            }
        }
    };
}

numeric_stepper_for_num_type!(u64, U64);
numeric_stepper_for_num_type!(u32, U32);
// todo(settings_ui) is there a better ui for f32?
numeric_stepper_for_num_type!(f32, F32);
numeric_stepper_for_num_type!(usize, USIZE);
numeric_stepper_for_num_type!(NonZeroUsize, U32NONZERO);