settings_file.rs

  1use crate::{settings_store::SettingsStore, Settings};
  2use anyhow::{Context, Result};
  3use fs::Fs;
  4use futures::{channel::mpsc, StreamExt};
  5use gpui::{AppContext, BackgroundExecutor, UpdateGlobal};
  6use std::{io::ErrorKind, path::PathBuf, sync::Arc, time::Duration};
  7use util::ResultExt;
  8
  9pub const EMPTY_THEME_NAME: &str = "empty-theme";
 10
 11#[cfg(any(test, feature = "test-support"))]
 12pub fn test_settings() -> String {
 13    let mut value = crate::settings_store::parse_json_with_comments::<serde_json::Value>(
 14        crate::default_settings().as_ref(),
 15    )
 16    .unwrap();
 17    util::merge_non_null_json_value_into(
 18        serde_json::json!({
 19            "ui_font_family": "Courier",
 20            "ui_font_features": {},
 21            "ui_font_size": 14,
 22            "buffer_font_family": "Courier",
 23            "buffer_font_features": {},
 24            "buffer_font_size": 14,
 25            "theme": EMPTY_THEME_NAME,
 26        }),
 27        &mut value,
 28    );
 29    value.as_object_mut().unwrap().remove("languages");
 30    serde_json::to_string(&value).unwrap()
 31}
 32
 33pub fn watch_config_file(
 34    executor: &BackgroundExecutor,
 35    fs: Arc<dyn Fs>,
 36    path: PathBuf,
 37) -> mpsc::UnboundedReceiver<String> {
 38    let (tx, rx) = mpsc::unbounded();
 39    executor
 40        .spawn(async move {
 41            let (events, _) = fs.watch(&path, Duration::from_millis(100)).await;
 42            futures::pin_mut!(events);
 43
 44            let contents = fs.load(&path).await.unwrap_or_default();
 45            if tx.unbounded_send(contents).is_err() {
 46                return;
 47            }
 48
 49            loop {
 50                if events.next().await.is_none() {
 51                    break;
 52                }
 53
 54                if let Ok(contents) = fs.load(&path).await {
 55                    if tx.unbounded_send(contents).is_err() {
 56                        break;
 57                    }
 58                }
 59            }
 60        })
 61        .detach();
 62    rx
 63}
 64
 65pub fn handle_settings_file_changes(
 66    mut user_settings_file_rx: mpsc::UnboundedReceiver<String>,
 67    cx: &mut AppContext,
 68) {
 69    let user_settings_content = cx
 70        .background_executor()
 71        .block(user_settings_file_rx.next())
 72        .unwrap();
 73    SettingsStore::update_global(cx, |store, cx| {
 74        store
 75            .set_user_settings(&user_settings_content, cx)
 76            .log_err();
 77    });
 78    cx.spawn(move |mut cx| async move {
 79        while let Some(user_settings_content) = user_settings_file_rx.next().await {
 80            let result = cx.update_global(|store: &mut SettingsStore, cx| {
 81                store
 82                    .set_user_settings(&user_settings_content, cx)
 83                    .log_err();
 84                cx.refresh();
 85            });
 86            if result.is_err() {
 87                break; // App dropped
 88            }
 89        }
 90    })
 91    .detach();
 92}
 93
 94async fn load_settings(fs: &Arc<dyn Fs>) -> Result<String> {
 95    match fs.load(paths::settings_file()).await {
 96        result @ Ok(_) => result,
 97        Err(err) => {
 98            if let Some(e) = err.downcast_ref::<std::io::Error>() {
 99                if e.kind() == ErrorKind::NotFound {
100                    return Ok(crate::initial_user_settings_content().to_string());
101                }
102            }
103            Err(err)
104        }
105    }
106}
107
108pub fn update_settings_file<T: Settings>(
109    fs: Arc<dyn Fs>,
110    cx: &mut AppContext,
111    update: impl 'static + Send + FnOnce(&mut T::FileContent),
112) {
113    cx.spawn(|cx| async move {
114        let old_text = load_settings(&fs).await?;
115        let new_text = cx.read_global(|store: &SettingsStore, _cx| {
116            store.new_text_for_update::<T>(old_text, update)
117        })?;
118        let initial_path = paths::settings_file().as_path();
119        if fs.is_file(initial_path).await {
120            let resolved_path = fs.canonicalize(initial_path).await.with_context(|| {
121                format!("Failed to canonicalize settings path {:?}", initial_path)
122            })?;
123
124            fs.atomic_write(resolved_path.clone(), new_text)
125                .await
126                .with_context(|| format!("Failed to write settings to file {:?}", resolved_path))?;
127        } else {
128            fs.atomic_write(initial_path.to_path_buf(), new_text)
129                .await
130                .with_context(|| format!("Failed to write settings to file {:?}", initial_path))?;
131        }
132
133        anyhow::Ok(())
134    })
135    .detach_and_log_err(cx);
136}