1mod keymap_file;
2
3use anyhow::Result;
4use gpui::{
5 font_cache::{FamilyId, FontCache},
6 AssetSource,
7};
8use schemars::{
9 gen::{SchemaGenerator, SchemaSettings},
10 schema::{InstanceType, ObjectValidation, Schema, SchemaObject, SingleOrVec},
11 JsonSchema,
12};
13use serde::{de::DeserializeOwned, Deserialize};
14use serde_json::Value;
15use std::{collections::HashMap, num::NonZeroU32, str, sync::Arc};
16use theme::{Theme, ThemeRegistry};
17use util::ResultExt as _;
18
19pub use keymap_file::{keymap_file_json_schema, KeymapFileContent};
20
21#[derive(Clone)]
22pub struct Settings {
23 pub experiments: FeatureFlags,
24 pub projects_online_by_default: bool,
25 pub buffer_font_family: FamilyId,
26 pub default_buffer_font_size: f32,
27 pub buffer_font_size: f32,
28 pub hover_popover_enabled: bool,
29 pub show_completions_on_input: bool,
30 pub vim_mode: bool,
31 pub autosave: Autosave,
32 pub editor_defaults: EditorSettings,
33 pub editor_overrides: EditorSettings,
34 pub terminal_defaults: TerminalSettings,
35 pub terminal_overrides: TerminalSettings,
36 pub language_defaults: HashMap<Arc<str>, EditorSettings>,
37 pub language_overrides: HashMap<Arc<str>, EditorSettings>,
38 pub lsp: HashMap<Arc<str>, LspSettings>,
39 pub theme: Arc<Theme>,
40 pub staff_mode: bool,
41}
42
43#[derive(Copy, Clone, Debug, Default, Deserialize, JsonSchema)]
44pub struct FeatureFlags {
45 pub experimental_themes: bool,
46}
47
48impl FeatureFlags {
49 pub fn keymap_files(&self) -> Vec<&'static str> {
50 vec![]
51 }
52}
53
54#[derive(Clone, Debug, Default, Deserialize, JsonSchema)]
55pub struct EditorSettings {
56 pub tab_size: Option<NonZeroU32>,
57 pub hard_tabs: Option<bool>,
58 pub soft_wrap: Option<SoftWrap>,
59 pub preferred_line_length: Option<u32>,
60 pub format_on_save: Option<FormatOnSave>,
61 pub enable_language_server: Option<bool>,
62}
63
64#[derive(Copy, Clone, Debug, Deserialize, PartialEq, Eq, JsonSchema)]
65#[serde(rename_all = "snake_case")]
66pub enum SoftWrap {
67 None,
68 EditorWidth,
69 PreferredLineLength,
70}
71
72#[derive(Clone, Debug, Deserialize, PartialEq, Eq, JsonSchema)]
73#[serde(rename_all = "snake_case")]
74pub enum FormatOnSave {
75 Off,
76 LanguageServer,
77 External {
78 command: String,
79 arguments: Vec<String>,
80 },
81}
82
83#[derive(Copy, Clone, Debug, Deserialize, PartialEq, Eq, JsonSchema)]
84#[serde(rename_all = "snake_case")]
85pub enum Autosave {
86 Off,
87 AfterDelay { milliseconds: u64 },
88 OnFocusChange,
89 OnWindowChange,
90}
91
92#[derive(Clone, Debug, Default, Deserialize, JsonSchema)]
93pub struct TerminalSettings {
94 pub shell: Option<Shell>,
95 pub working_directory: Option<WorkingDirectory>,
96 pub font_size: Option<f32>,
97 pub font_family: Option<String>,
98 pub env: Option<HashMap<String, String>>,
99 pub blinking: Option<TerminalBlink>,
100 pub alternate_scroll: Option<AlternateScroll>,
101}
102
103#[derive(Clone, Debug, Deserialize, PartialEq, Eq, JsonSchema)]
104#[serde(rename_all = "snake_case")]
105pub enum TerminalBlink {
106 Off,
107 TerminalControlled,
108 On,
109}
110
111impl Default for TerminalBlink {
112 fn default() -> Self {
113 TerminalBlink::TerminalControlled
114 }
115}
116
117#[derive(Clone, Debug, Deserialize, PartialEq, Eq, JsonSchema)]
118#[serde(rename_all = "snake_case")]
119pub enum Shell {
120 System,
121 Program(String),
122 WithArguments { program: String, args: Vec<String> },
123}
124
125impl Default for Shell {
126 fn default() -> Self {
127 Shell::System
128 }
129}
130
131#[derive(Clone, Debug, Deserialize, PartialEq, Eq, JsonSchema)]
132#[serde(rename_all = "snake_case")]
133pub enum AlternateScroll {
134 On,
135 Off,
136}
137
138impl Default for AlternateScroll {
139 fn default() -> Self {
140 AlternateScroll::On
141 }
142}
143
144#[derive(Clone, Debug, Deserialize, PartialEq, Eq, JsonSchema)]
145#[serde(rename_all = "snake_case")]
146pub enum WorkingDirectory {
147 CurrentProjectDirectory,
148 FirstProjectDirectory,
149 AlwaysHome,
150 Always { directory: String },
151}
152
153#[derive(Clone, Debug, Default, Deserialize, JsonSchema)]
154pub struct SettingsFileContent {
155 pub experiments: Option<FeatureFlags>,
156 #[serde(default)]
157 pub projects_online_by_default: Option<bool>,
158 #[serde(default)]
159 pub buffer_font_family: Option<String>,
160 #[serde(default)]
161 pub buffer_font_size: Option<f32>,
162 #[serde(default)]
163 pub hover_popover_enabled: Option<bool>,
164 #[serde(default)]
165 pub show_completions_on_input: Option<bool>,
166 #[serde(default)]
167 pub vim_mode: Option<bool>,
168 #[serde(default)]
169 pub autosave: Option<Autosave>,
170 #[serde(flatten)]
171 pub editor: EditorSettings,
172 #[serde(default)]
173 pub terminal: TerminalSettings,
174 #[serde(default)]
175 #[serde(alias = "language_overrides")]
176 pub languages: HashMap<Arc<str>, EditorSettings>,
177 #[serde(default)]
178 pub lsp: HashMap<Arc<str>, LspSettings>,
179 #[serde(default)]
180 pub theme: Option<String>,
181 #[serde(default)]
182 pub staff_mode: Option<bool>,
183}
184
185#[derive(Clone, Debug, Deserialize, PartialEq, Eq, JsonSchema)]
186#[serde(rename_all = "snake_case")]
187pub struct LspSettings {
188 pub initialization_options: Option<Value>,
189}
190
191impl Settings {
192 pub fn defaults(
193 assets: impl AssetSource,
194 font_cache: &FontCache,
195 themes: &ThemeRegistry,
196 ) -> Self {
197 fn required<T>(value: Option<T>) -> Option<T> {
198 assert!(value.is_some(), "missing default setting value");
199 value
200 }
201
202 let defaults: SettingsFileContent = parse_json_with_comments(
203 str::from_utf8(assets.load("settings/default.json").unwrap().as_ref()).unwrap(),
204 )
205 .unwrap();
206
207 Self {
208 experiments: FeatureFlags::default(),
209 buffer_font_family: font_cache
210 .load_family(&[defaults.buffer_font_family.as_ref().unwrap()])
211 .unwrap(),
212 buffer_font_size: defaults.buffer_font_size.unwrap(),
213 default_buffer_font_size: defaults.buffer_font_size.unwrap(),
214 hover_popover_enabled: defaults.hover_popover_enabled.unwrap(),
215 show_completions_on_input: defaults.show_completions_on_input.unwrap(),
216 projects_online_by_default: defaults.projects_online_by_default.unwrap(),
217 vim_mode: defaults.vim_mode.unwrap(),
218 autosave: defaults.autosave.unwrap(),
219 editor_defaults: EditorSettings {
220 tab_size: required(defaults.editor.tab_size),
221 hard_tabs: required(defaults.editor.hard_tabs),
222 soft_wrap: required(defaults.editor.soft_wrap),
223 preferred_line_length: required(defaults.editor.preferred_line_length),
224 format_on_save: required(defaults.editor.format_on_save),
225 enable_language_server: required(defaults.editor.enable_language_server),
226 },
227 editor_overrides: Default::default(),
228 terminal_defaults: Default::default(),
229 terminal_overrides: Default::default(),
230 language_defaults: defaults.languages,
231 language_overrides: Default::default(),
232 lsp: defaults.lsp.clone(),
233 theme: themes.get(&defaults.theme.unwrap()).unwrap(),
234
235 staff_mode: false,
236 }
237 }
238
239 pub fn set_user_settings(
240 &mut self,
241 data: SettingsFileContent,
242 theme_registry: &ThemeRegistry,
243 font_cache: &FontCache,
244 ) {
245 if let Some(value) = &data.buffer_font_family {
246 if let Some(id) = font_cache.load_family(&[value]).log_err() {
247 self.buffer_font_family = id;
248 }
249 }
250 if let Some(value) = &data.theme {
251 if let Some(theme) = theme_registry.get(value).log_err() {
252 self.theme = theme;
253 }
254 }
255
256 merge(
257 &mut self.projects_online_by_default,
258 data.projects_online_by_default,
259 );
260 merge(&mut self.buffer_font_size, data.buffer_font_size);
261 merge(&mut self.default_buffer_font_size, data.buffer_font_size);
262 merge(&mut self.hover_popover_enabled, data.hover_popover_enabled);
263 merge(
264 &mut self.show_completions_on_input,
265 data.show_completions_on_input,
266 );
267 merge(&mut self.vim_mode, data.vim_mode);
268 merge(&mut self.autosave, data.autosave);
269 merge(&mut self.experiments, data.experiments);
270 merge(&mut self.staff_mode, data.staff_mode);
271 // Ensure terminal font is loaded, so we can request it in terminal_element layout
272 if let Some(terminal_font) = &data.terminal.font_family {
273 font_cache.load_family(&[terminal_font]).log_err();
274 }
275
276 self.editor_overrides = data.editor;
277 self.terminal_defaults.font_size = data.terminal.font_size;
278 self.terminal_overrides = data.terminal;
279 self.language_overrides = data.languages;
280 self.lsp = data.lsp;
281 }
282
283 pub fn with_language_defaults(
284 mut self,
285 language_name: impl Into<Arc<str>>,
286 overrides: EditorSettings,
287 ) -> Self {
288 self.language_defaults
289 .insert(language_name.into(), overrides);
290 self
291 }
292
293 pub fn tab_size(&self, language: Option<&str>) -> NonZeroU32 {
294 self.language_setting(language, |settings| settings.tab_size)
295 }
296
297 pub fn hard_tabs(&self, language: Option<&str>) -> bool {
298 self.language_setting(language, |settings| settings.hard_tabs)
299 }
300
301 pub fn soft_wrap(&self, language: Option<&str>) -> SoftWrap {
302 self.language_setting(language, |settings| settings.soft_wrap)
303 }
304
305 pub fn preferred_line_length(&self, language: Option<&str>) -> u32 {
306 self.language_setting(language, |settings| settings.preferred_line_length)
307 }
308
309 pub fn format_on_save(&self, language: Option<&str>) -> FormatOnSave {
310 self.language_setting(language, |settings| settings.format_on_save.clone())
311 }
312
313 pub fn enable_language_server(&self, language: Option<&str>) -> bool {
314 self.language_setting(language, |settings| settings.enable_language_server)
315 }
316
317 fn language_setting<F, R>(&self, language: Option<&str>, f: F) -> R
318 where
319 F: Fn(&EditorSettings) -> Option<R>,
320 {
321 None.or_else(|| language.and_then(|l| self.language_overrides.get(l).and_then(&f)))
322 .or_else(|| f(&self.editor_overrides))
323 .or_else(|| language.and_then(|l| self.language_defaults.get(l).and_then(&f)))
324 .or_else(|| f(&self.editor_defaults))
325 .expect("missing default")
326 }
327
328 #[cfg(any(test, feature = "test-support"))]
329 pub fn test(cx: &gpui::AppContext) -> Settings {
330 Settings {
331 experiments: FeatureFlags::default(),
332 buffer_font_family: cx.font_cache().load_family(&["Monaco"]).unwrap(),
333 buffer_font_size: 14.,
334 default_buffer_font_size: 14.,
335 hover_popover_enabled: true,
336 show_completions_on_input: true,
337 vim_mode: false,
338 autosave: Autosave::Off,
339 editor_defaults: EditorSettings {
340 tab_size: Some(4.try_into().unwrap()),
341 hard_tabs: Some(false),
342 soft_wrap: Some(SoftWrap::None),
343 preferred_line_length: Some(80),
344 format_on_save: Some(FormatOnSave::LanguageServer),
345 enable_language_server: Some(true),
346 },
347 editor_overrides: Default::default(),
348 terminal_defaults: Default::default(),
349 terminal_overrides: Default::default(),
350 language_defaults: Default::default(),
351 language_overrides: Default::default(),
352 lsp: Default::default(),
353 projects_online_by_default: true,
354 theme: gpui::fonts::with_font_cache(cx.font_cache().clone(), Default::default),
355 staff_mode: false,
356 }
357 }
358
359 #[cfg(any(test, feature = "test-support"))]
360 pub fn test_async(cx: &mut gpui::TestAppContext) {
361 cx.update(|cx| {
362 let settings = Self::test(cx);
363 cx.set_global(settings);
364 });
365 }
366}
367
368pub fn settings_file_json_schema(
369 theme_names: Vec<String>,
370 language_names: &[String],
371) -> serde_json::Value {
372 let settings = SchemaSettings::draft07().with(|settings| {
373 settings.option_add_null_type = false;
374 });
375 let generator = SchemaGenerator::new(settings);
376 let mut root_schema = generator.into_root_schema_for::<SettingsFileContent>();
377
378 // Create a schema for a theme name.
379 let theme_name_schema = SchemaObject {
380 instance_type: Some(SingleOrVec::Single(Box::new(InstanceType::String))),
381 enum_values: Some(theme_names.into_iter().map(Value::String).collect()),
382 ..Default::default()
383 };
384
385 // Create a schema for a 'languages overrides' object, associating editor
386 // settings with specific langauges.
387 assert!(root_schema.definitions.contains_key("EditorSettings"));
388 let languages_object_schema = SchemaObject {
389 instance_type: Some(SingleOrVec::Single(Box::new(InstanceType::Object))),
390 object: Some(Box::new(ObjectValidation {
391 properties: language_names
392 .iter()
393 .map(|name| {
394 (
395 name.clone(),
396 Schema::new_ref("#/definitions/EditorSettings".into()),
397 )
398 })
399 .collect(),
400 ..Default::default()
401 })),
402 ..Default::default()
403 };
404
405 // Add these new schemas as definitions, and modify properties of the root
406 // schema to reference them.
407 root_schema.definitions.extend([
408 ("ThemeName".into(), theme_name_schema.into()),
409 ("Languages".into(), languages_object_schema.into()),
410 ]);
411 let root_schema_object = &mut root_schema.schema.object.as_mut().unwrap();
412
413 // Avoid automcomplete for non-user facing settings
414 root_schema_object.properties.remove("staff_mode");
415 root_schema_object.properties.extend([
416 (
417 "theme".to_owned(),
418 Schema::new_ref("#/definitions/ThemeName".into()),
419 ),
420 (
421 "languages".to_owned(),
422 Schema::new_ref("#/definitions/Languages".into()),
423 ),
424 // For backward compatibility
425 (
426 "language_overrides".to_owned(),
427 Schema::new_ref("#/definitions/Languages".into()),
428 ),
429 ]);
430
431 serde_json::to_value(root_schema).unwrap()
432}
433
434fn merge<T: Copy>(target: &mut T, value: Option<T>) {
435 if let Some(value) = value {
436 *target = value;
437 }
438}
439
440pub fn parse_json_with_comments<T: DeserializeOwned>(content: &str) -> Result<T> {
441 Ok(serde_json::from_reader(
442 json_comments::CommentSettings::c_style().strip_comments(content.as_bytes()),
443 )?)
444}