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 internal: 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}
182
183#[derive(Clone, Debug, Deserialize, PartialEq, Eq, JsonSchema)]
184#[serde(rename_all = "snake_case")]
185pub struct LspSettings {
186 pub initialization_options: Option<Value>,
187}
188
189impl Settings {
190 pub fn defaults(
191 assets: impl AssetSource,
192 font_cache: &FontCache,
193 themes: &ThemeRegistry,
194 ) -> Self {
195 fn required<T>(value: Option<T>) -> Option<T> {
196 assert!(value.is_some(), "missing default setting value");
197 value
198 }
199
200 let defaults: SettingsFileContent = parse_json_with_comments(
201 str::from_utf8(assets.load("settings/default.json").unwrap().as_ref()).unwrap(),
202 )
203 .unwrap();
204
205 Self {
206 experiments: FeatureFlags::default(),
207 buffer_font_family: font_cache
208 .load_family(&[defaults.buffer_font_family.as_ref().unwrap()])
209 .unwrap(),
210 buffer_font_size: defaults.buffer_font_size.unwrap(),
211 default_buffer_font_size: defaults.buffer_font_size.unwrap(),
212 hover_popover_enabled: defaults.hover_popover_enabled.unwrap(),
213 show_completions_on_input: defaults.show_completions_on_input.unwrap(),
214 projects_online_by_default: defaults.projects_online_by_default.unwrap(),
215 vim_mode: defaults.vim_mode.unwrap(),
216 autosave: defaults.autosave.unwrap(),
217 editor_defaults: EditorSettings {
218 tab_size: required(defaults.editor.tab_size),
219 hard_tabs: required(defaults.editor.hard_tabs),
220 soft_wrap: required(defaults.editor.soft_wrap),
221 preferred_line_length: required(defaults.editor.preferred_line_length),
222 format_on_save: required(defaults.editor.format_on_save),
223 enable_language_server: required(defaults.editor.enable_language_server),
224 },
225 editor_overrides: Default::default(),
226 terminal_defaults: Default::default(),
227 terminal_overrides: Default::default(),
228 language_defaults: defaults.languages,
229 language_overrides: Default::default(),
230 lsp: defaults.lsp.clone(),
231 theme: themes.get(&defaults.theme.unwrap()).unwrap(),
232 internal: false,
233 }
234 }
235
236 pub fn set_user_settings(
237 &mut self,
238 data: SettingsFileContent,
239 theme_registry: &ThemeRegistry,
240 font_cache: &FontCache,
241 internal: bool,
242 ) {
243 if let Some(value) = &data.buffer_font_family {
244 if let Some(id) = font_cache.load_family(&[value]).log_err() {
245 self.buffer_font_family = id;
246 }
247 }
248 if let Some(value) = &data.theme {
249 if let Some(theme) = theme_registry.get(value).log_err() {
250 self.theme = theme;
251 }
252 }
253
254 merge(
255 &mut self.projects_online_by_default,
256 data.projects_online_by_default,
257 );
258 merge(&mut self.buffer_font_size, data.buffer_font_size);
259 merge(&mut self.default_buffer_font_size, data.buffer_font_size);
260 merge(&mut self.hover_popover_enabled, data.hover_popover_enabled);
261 merge(
262 &mut self.show_completions_on_input,
263 data.show_completions_on_input,
264 );
265 merge(&mut self.vim_mode, data.vim_mode);
266 merge(&mut self.autosave, data.autosave);
267 merge(&mut self.experiments, data.experiments);
268
269 // Ensure terminal font is loaded, so we can request it in terminal_element layout
270 if let Some(terminal_font) = &data.terminal.font_family {
271 font_cache.load_family(&[terminal_font]).log_err();
272 }
273
274 self.editor_overrides = data.editor;
275 self.terminal_defaults.font_size = data.terminal.font_size;
276 self.terminal_overrides = data.terminal;
277 self.language_overrides = data.languages;
278 self.lsp = data.lsp;
279 self.internal = internal
280 }
281
282 pub fn with_language_defaults(
283 mut self,
284 language_name: impl Into<Arc<str>>,
285 overrides: EditorSettings,
286 ) -> Self {
287 self.language_defaults
288 .insert(language_name.into(), overrides);
289 self
290 }
291
292 pub fn tab_size(&self, language: Option<&str>) -> NonZeroU32 {
293 self.language_setting(language, |settings| settings.tab_size)
294 }
295
296 pub fn hard_tabs(&self, language: Option<&str>) -> bool {
297 self.language_setting(language, |settings| settings.hard_tabs)
298 }
299
300 pub fn soft_wrap(&self, language: Option<&str>) -> SoftWrap {
301 self.language_setting(language, |settings| settings.soft_wrap)
302 }
303
304 pub fn preferred_line_length(&self, language: Option<&str>) -> u32 {
305 self.language_setting(language, |settings| settings.preferred_line_length)
306 }
307
308 pub fn format_on_save(&self, language: Option<&str>) -> FormatOnSave {
309 self.language_setting(language, |settings| settings.format_on_save.clone())
310 }
311
312 pub fn enable_language_server(&self, language: Option<&str>) -> bool {
313 self.language_setting(language, |settings| settings.enable_language_server)
314 }
315
316 fn language_setting<F, R>(&self, language: Option<&str>, f: F) -> R
317 where
318 F: Fn(&EditorSettings) -> Option<R>,
319 {
320 None.or_else(|| language.and_then(|l| self.language_overrides.get(l).and_then(&f)))
321 .or_else(|| f(&self.editor_overrides))
322 .or_else(|| language.and_then(|l| self.language_defaults.get(l).and_then(&f)))
323 .or_else(|| f(&self.editor_defaults))
324 .expect("missing default")
325 }
326
327 #[cfg(any(test, feature = "test-support"))]
328 pub fn test(cx: &gpui::AppContext) -> Settings {
329 Settings {
330 experiments: FeatureFlags::default(),
331 buffer_font_family: cx.font_cache().load_family(&["Monaco"]).unwrap(),
332 buffer_font_size: 14.,
333 default_buffer_font_size: 14.,
334 hover_popover_enabled: true,
335 show_completions_on_input: true,
336 vim_mode: false,
337 autosave: Autosave::Off,
338 editor_defaults: EditorSettings {
339 tab_size: Some(4.try_into().unwrap()),
340 hard_tabs: Some(false),
341 soft_wrap: Some(SoftWrap::None),
342 preferred_line_length: Some(80),
343 format_on_save: Some(FormatOnSave::LanguageServer),
344 enable_language_server: Some(true),
345 },
346 editor_overrides: Default::default(),
347 terminal_defaults: Default::default(),
348 terminal_overrides: Default::default(),
349 language_defaults: Default::default(),
350 language_overrides: Default::default(),
351 lsp: Default::default(),
352 projects_online_by_default: true,
353 theme: gpui::fonts::with_font_cache(cx.font_cache().clone(), Default::default),
354 internal: false,
355 }
356 }
357
358 #[cfg(any(test, feature = "test-support"))]
359 pub fn test_async(cx: &mut gpui::TestAppContext) {
360 cx.update(|cx| {
361 let settings = Self::test(cx);
362 cx.set_global(settings);
363 });
364 }
365}
366
367pub fn settings_file_json_schema(
368 theme_names: Vec<String>,
369 language_names: &[String],
370) -> serde_json::Value {
371 let settings = SchemaSettings::draft07().with(|settings| {
372 settings.option_add_null_type = false;
373 });
374 let generator = SchemaGenerator::new(settings);
375 let mut root_schema = generator.into_root_schema_for::<SettingsFileContent>();
376
377 // Create a schema for a theme name.
378 let theme_name_schema = SchemaObject {
379 instance_type: Some(SingleOrVec::Single(Box::new(InstanceType::String))),
380 enum_values: Some(theme_names.into_iter().map(Value::String).collect()),
381 ..Default::default()
382 };
383
384 // Create a schema for a 'languages overrides' object, associating editor
385 // settings with specific langauges.
386 assert!(root_schema.definitions.contains_key("EditorSettings"));
387 let languages_object_schema = SchemaObject {
388 instance_type: Some(SingleOrVec::Single(Box::new(InstanceType::Object))),
389 object: Some(Box::new(ObjectValidation {
390 properties: language_names
391 .iter()
392 .map(|name| {
393 (
394 name.clone(),
395 Schema::new_ref("#/definitions/EditorSettings".into()),
396 )
397 })
398 .collect(),
399 ..Default::default()
400 })),
401 ..Default::default()
402 };
403
404 // Add these new schemas as definitions, and modify properties of the root
405 // schema to reference them.
406 root_schema.definitions.extend([
407 ("ThemeName".into(), theme_name_schema.into()),
408 ("Languages".into(), languages_object_schema.into()),
409 ]);
410 root_schema
411 .schema
412 .object
413 .as_mut()
414 .unwrap()
415 .properties
416 .extend([
417 (
418 "theme".to_owned(),
419 Schema::new_ref("#/definitions/ThemeName".into()),
420 ),
421 (
422 "languages".to_owned(),
423 Schema::new_ref("#/definitions/Languages".into()),
424 ),
425 // For backward compatibility
426 (
427 "language_overrides".to_owned(),
428 Schema::new_ref("#/definitions/Languages".into()),
429 ),
430 ]);
431
432 serde_json::to_value(root_schema).unwrap()
433}
434
435fn merge<T: Copy>(target: &mut T, value: Option<T>) {
436 if let Some(value) = value {
437 *target = value;
438 }
439}
440
441pub fn parse_json_with_comments<T: DeserializeOwned>(content: &str) -> Result<T> {
442 Ok(serde_json::from_reader(
443 json_comments::CommentSettings::c_style().strip_comments(content.as_bytes()),
444 )?)
445}