1use anyhow::{anyhow, Context, Result};
2use collections::{btree_map, hash_map, BTreeMap, HashMap};
3use gpui::AppContext;
4use lazy_static::lazy_static;
5use schemars::{gen::SchemaGenerator, schema::RootSchema, JsonSchema};
6use serde::{de::DeserializeOwned, Deserialize as _, Serialize};
7use smallvec::SmallVec;
8use std::{
9 any::{type_name, Any, TypeId},
10 fmt::Debug,
11 ops::Range,
12 path::Path,
13 str,
14 sync::Arc,
15};
16use util::{merge_non_null_json_value_into, RangeExt, ResultExt as _};
17
18/// A value that can be defined as a user setting.
19///
20/// Settings can be loaded from a combination of multiple JSON files.
21pub trait Settings: 'static + Send + Sync {
22 /// The name of a key within the JSON file from which this setting should
23 /// be deserialized. If this is `None`, then the setting will be deserialized
24 /// from the root object.
25 const KEY: Option<&'static str>;
26
27 /// The type that is stored in an individual JSON file.
28 type FileContent: Clone + Default + Serialize + DeserializeOwned + JsonSchema;
29
30 /// The logic for combining together values from one or more JSON files into the
31 /// final value for this setting.
32 ///
33 /// The user values are ordered from least specific (the global settings file)
34 /// to most specific (the innermost local settings file).
35 fn load(
36 default_value: &Self::FileContent,
37 user_values: &[&Self::FileContent],
38 cx: &mut AppContext,
39 ) -> Result<Self>
40 where
41 Self: Sized;
42
43 fn json_schema(
44 generator: &mut SchemaGenerator,
45 _: &SettingsJsonSchemaParams,
46 _: &AppContext,
47 ) -> RootSchema {
48 generator.root_schema_for::<Self::FileContent>()
49 }
50
51 fn json_merge(
52 default_value: &Self::FileContent,
53 user_values: &[&Self::FileContent],
54 ) -> Result<Self::FileContent> {
55 let mut merged = serde_json::Value::Null;
56 for value in [default_value].iter().chain(user_values) {
57 merge_non_null_json_value_into(serde_json::to_value(value).unwrap(), &mut merged);
58 }
59 Ok(serde_json::from_value(merged)?)
60 }
61
62 fn load_via_json_merge(
63 default_value: &Self::FileContent,
64 user_values: &[&Self::FileContent],
65 ) -> Result<Self>
66 where
67 Self: DeserializeOwned,
68 {
69 let mut merged = serde_json::Value::Null;
70 for value in [default_value].iter().chain(user_values) {
71 merge_non_null_json_value_into(serde_json::to_value(value).unwrap(), &mut merged);
72 }
73 Ok(serde_json::from_value(merged)?)
74 }
75
76 fn missing_default() -> anyhow::Error {
77 anyhow::anyhow!("missing default")
78 }
79
80 fn register(cx: &mut AppContext)
81 where
82 Self: Sized,
83 {
84 cx.update_global(|store: &mut SettingsStore, cx| {
85 store.register_setting::<Self>(cx);
86 });
87 }
88
89 #[track_caller]
90 fn get<'a>(path: Option<(usize, &Path)>, cx: &'a AppContext) -> &'a Self
91 where
92 Self: Sized,
93 {
94 cx.global::<SettingsStore>().get(path)
95 }
96
97 #[track_caller]
98 fn get_global<'a>(cx: &'a AppContext) -> &'a Self
99 where
100 Self: Sized,
101 {
102 cx.global::<SettingsStore>().get(None)
103 }
104
105 #[track_caller]
106 fn override_global<'a>(settings: Self, cx: &'a mut AppContext)
107 where
108 Self: Sized,
109 {
110 cx.global_mut::<SettingsStore>().override_global(settings)
111 }
112}
113
114pub struct SettingsJsonSchemaParams<'a> {
115 pub staff_mode: bool,
116 pub language_names: &'a [String],
117 pub font_names: &'a [String],
118}
119
120/// A set of strongly-typed setting values defined via multiple JSON files.
121pub struct SettingsStore {
122 setting_values: HashMap<TypeId, Box<dyn AnySettingValue>>,
123 raw_default_settings: serde_json::Value,
124 raw_user_settings: serde_json::Value,
125 raw_local_settings: BTreeMap<(usize, Arc<Path>), serde_json::Value>,
126 tab_size_callback: Option<(
127 TypeId,
128 Box<dyn Fn(&dyn Any) -> Option<usize> + Send + Sync + 'static>,
129 )>,
130}
131
132impl Default for SettingsStore {
133 fn default() -> Self {
134 SettingsStore {
135 setting_values: Default::default(),
136 raw_default_settings: serde_json::json!({}),
137 raw_user_settings: serde_json::json!({}),
138 raw_local_settings: Default::default(),
139 tab_size_callback: Default::default(),
140 }
141 }
142}
143
144#[derive(Debug)]
145struct SettingValue<T> {
146 global_value: Option<T>,
147 local_values: Vec<(usize, Arc<Path>, T)>,
148}
149
150trait AnySettingValue: 'static + Send + Sync {
151 fn key(&self) -> Option<&'static str>;
152 fn setting_type_name(&self) -> &'static str;
153 fn deserialize_setting(&self, json: &serde_json::Value) -> Result<DeserializedSetting>;
154 fn load_setting(
155 &self,
156 default_value: &DeserializedSetting,
157 custom: &[DeserializedSetting],
158 cx: &mut AppContext,
159 ) -> Result<Box<dyn Any>>;
160 fn value_for_path(&self, path: Option<(usize, &Path)>) -> &dyn Any;
161 fn set_global_value(&mut self, value: Box<dyn Any>);
162 fn set_local_value(&mut self, root_id: usize, path: Arc<Path>, value: Box<dyn Any>);
163 fn json_schema(
164 &self,
165 generator: &mut SchemaGenerator,
166 _: &SettingsJsonSchemaParams,
167 cx: &AppContext,
168 ) -> RootSchema;
169}
170
171struct DeserializedSetting(Box<dyn Any>);
172
173impl SettingsStore {
174 /// Add a new type of setting to the store.
175 pub fn register_setting<T: Settings>(&mut self, cx: &mut AppContext) {
176 let setting_type_id = TypeId::of::<T>();
177 let entry = self.setting_values.entry(setting_type_id);
178 if matches!(entry, hash_map::Entry::Occupied(_)) {
179 return;
180 }
181
182 let setting_value = entry.or_insert(Box::new(SettingValue::<T> {
183 global_value: None,
184 local_values: Vec::new(),
185 }));
186
187 if let Some(default_settings) = setting_value
188 .deserialize_setting(&self.raw_default_settings)
189 .log_err()
190 {
191 let mut user_values_stack = Vec::new();
192
193 if let Some(user_settings) = setting_value
194 .deserialize_setting(&self.raw_user_settings)
195 .log_err()
196 {
197 user_values_stack = vec![user_settings];
198 }
199
200 if let Some(setting) = setting_value
201 .load_setting(&default_settings, &user_values_stack, cx)
202 .context("A default setting must be added to the `default.json` file")
203 .log_err()
204 {
205 setting_value.set_global_value(setting);
206 }
207 }
208 }
209
210 /// Get the value of a setting.
211 ///
212 /// Panics if the given setting type has not been registered, or if there is no
213 /// value for this setting.
214 pub fn get<T: Settings>(&self, path: Option<(usize, &Path)>) -> &T {
215 self.setting_values
216 .get(&TypeId::of::<T>())
217 .unwrap_or_else(|| panic!("unregistered setting type {}", type_name::<T>()))
218 .value_for_path(path)
219 .downcast_ref::<T>()
220 .expect("no default value for setting type")
221 }
222
223 /// Override the global value for a setting.
224 ///
225 /// The given value will be overwritten if the user settings file changes.
226 pub fn override_global<T: Settings>(&mut self, value: T) {
227 self.setting_values
228 .get_mut(&TypeId::of::<T>())
229 .unwrap_or_else(|| panic!("unregistered setting type {}", type_name::<T>()))
230 .set_global_value(Box::new(value))
231 }
232
233 /// Get the user's settings as a raw JSON value.
234 ///
235 /// This is only for debugging and reporting. For user-facing functionality,
236 /// use the typed setting interface.
237 pub fn raw_user_settings(&self) -> &serde_json::Value {
238 &self.raw_user_settings
239 }
240
241 #[cfg(any(test, feature = "test-support"))]
242 pub fn test(cx: &mut AppContext) -> Self {
243 let mut this = Self::default();
244 this.set_default_settings(&crate::test_settings(), cx)
245 .unwrap();
246 this.set_user_settings("{}", cx).unwrap();
247 this
248 }
249
250 /// Updates the value of a setting in the user's global configuration.
251 ///
252 /// This is only for tests. Normally, settings are only loaded from
253 /// JSON files.
254 #[cfg(any(test, feature = "test-support"))]
255 pub fn update_user_settings<T: Settings>(
256 &mut self,
257 cx: &mut AppContext,
258 update: impl FnOnce(&mut T::FileContent),
259 ) {
260 let old_text = serde_json::to_string(&self.raw_user_settings).unwrap();
261 let new_text = self.new_text_for_update::<T>(old_text, update);
262 self.set_user_settings(&new_text, cx).unwrap();
263 }
264
265 /// Updates the value of a setting in a JSON file, returning the new text
266 /// for that JSON file.
267 pub fn new_text_for_update<T: Settings>(
268 &self,
269 old_text: String,
270 update: impl FnOnce(&mut T::FileContent),
271 ) -> String {
272 let edits = self.edits_for_update::<T>(&old_text, update);
273 let mut new_text = old_text;
274 for (range, replacement) in edits.into_iter() {
275 new_text.replace_range(range, &replacement);
276 }
277 new_text
278 }
279
280 /// Updates the value of a setting in a JSON file, returning a list
281 /// of edits to apply to the JSON file.
282 pub fn edits_for_update<T: Settings>(
283 &self,
284 text: &str,
285 update: impl FnOnce(&mut T::FileContent),
286 ) -> Vec<(Range<usize>, String)> {
287 let setting_type_id = TypeId::of::<T>();
288
289 let setting = self
290 .setting_values
291 .get(&setting_type_id)
292 .unwrap_or_else(|| panic!("unregistered setting type {}", type_name::<T>()));
293 let raw_settings = parse_json_with_comments::<serde_json::Value>(text).unwrap_or_default();
294 let old_content = match setting.deserialize_setting(&raw_settings) {
295 Ok(content) => content.0.downcast::<T::FileContent>().unwrap(),
296 Err(_) => Box::new(T::FileContent::default()),
297 };
298 let mut new_content = old_content.clone();
299 update(&mut new_content);
300
301 let old_value = serde_json::to_value(&old_content).unwrap();
302 let new_value = serde_json::to_value(new_content).unwrap();
303
304 let mut key_path = Vec::new();
305 if let Some(key) = T::KEY {
306 key_path.push(key);
307 }
308
309 let mut edits = Vec::new();
310 let tab_size = self.json_tab_size();
311 let mut text = text.to_string();
312 update_value_in_json_text(
313 &mut text,
314 &mut key_path,
315 tab_size,
316 &old_value,
317 &new_value,
318 &mut edits,
319 );
320 return edits;
321 }
322
323 /// Configure the tab sized when updating JSON files.
324 pub fn set_json_tab_size_callback<T: Settings>(
325 &mut self,
326 get_tab_size: fn(&T) -> Option<usize>,
327 ) {
328 self.tab_size_callback = Some((
329 TypeId::of::<T>(),
330 Box::new(move |value| get_tab_size(value.downcast_ref::<T>().unwrap())),
331 ));
332 }
333
334 fn json_tab_size(&self) -> usize {
335 const DEFAULT_JSON_TAB_SIZE: usize = 2;
336
337 if let Some((setting_type_id, callback)) = &self.tab_size_callback {
338 let setting_value = self.setting_values.get(setting_type_id).unwrap();
339 let value = setting_value.value_for_path(None);
340 if let Some(value) = callback(value) {
341 return value;
342 }
343 }
344
345 DEFAULT_JSON_TAB_SIZE
346 }
347
348 /// Sets the default settings via a JSON string.
349 ///
350 /// The string should contain a JSON object with a default value for every setting.
351 pub fn set_default_settings(
352 &mut self,
353 default_settings_content: &str,
354 cx: &mut AppContext,
355 ) -> Result<()> {
356 let settings: serde_json::Value = parse_json_with_comments(default_settings_content)?;
357 if settings.is_object() {
358 self.raw_default_settings = settings;
359 self.recompute_values(None, cx)?;
360 Ok(())
361 } else {
362 Err(anyhow!("settings must be an object"))
363 }
364 }
365
366 /// Sets the user settings via a JSON string.
367 pub fn set_user_settings(
368 &mut self,
369 user_settings_content: &str,
370 cx: &mut AppContext,
371 ) -> Result<()> {
372 let settings: serde_json::Value = parse_json_with_comments(user_settings_content)?;
373 if settings.is_object() {
374 self.raw_user_settings = settings;
375 self.recompute_values(None, cx)?;
376 Ok(())
377 } else {
378 Err(anyhow!("settings must be an object"))
379 }
380 }
381
382 /// Add or remove a set of local settings via a JSON string.
383 pub fn set_local_settings(
384 &mut self,
385 root_id: usize,
386 path: Arc<Path>,
387 settings_content: Option<&str>,
388 cx: &mut AppContext,
389 ) -> Result<()> {
390 if let Some(content) = settings_content {
391 self.raw_local_settings
392 .insert((root_id, path.clone()), parse_json_with_comments(content)?);
393 } else {
394 self.raw_local_settings.remove(&(root_id, path.clone()));
395 }
396 self.recompute_values(Some((root_id, &path)), cx)?;
397 Ok(())
398 }
399
400 /// Add or remove a set of local settings via a JSON string.
401 pub fn clear_local_settings(&mut self, root_id: usize, cx: &mut AppContext) -> Result<()> {
402 self.raw_local_settings.retain(|k, _| k.0 != root_id);
403 self.recompute_values(Some((root_id, "".as_ref())), cx)?;
404 Ok(())
405 }
406
407 pub fn local_settings(&self, root_id: usize) -> impl '_ + Iterator<Item = (Arc<Path>, String)> {
408 self.raw_local_settings
409 .range((root_id, Path::new("").into())..(root_id + 1, Path::new("").into()))
410 .map(|((_, path), content)| (path.clone(), serde_json::to_string(content).unwrap()))
411 }
412
413 pub fn json_schema(
414 &self,
415 schema_params: &SettingsJsonSchemaParams,
416 cx: &AppContext,
417 ) -> serde_json::Value {
418 use schemars::{
419 gen::SchemaSettings,
420 schema::{Schema, SchemaObject},
421 };
422
423 let settings = SchemaSettings::draft07().with(|settings| {
424 settings.option_add_null_type = false;
425 });
426 let mut generator = SchemaGenerator::new(settings);
427 let mut combined_schema = RootSchema::default();
428
429 for setting_value in self.setting_values.values() {
430 let setting_schema = setting_value.json_schema(&mut generator, schema_params, cx);
431 combined_schema
432 .definitions
433 .extend(setting_schema.definitions);
434
435 let target_schema = if let Some(key) = setting_value.key() {
436 let key_schema = combined_schema
437 .schema
438 .object()
439 .properties
440 .entry(key.to_string())
441 .or_insert_with(|| Schema::Object(SchemaObject::default()));
442 if let Schema::Object(key_schema) = key_schema {
443 key_schema
444 } else {
445 continue;
446 }
447 } else {
448 &mut combined_schema.schema
449 };
450
451 merge_schema(target_schema, setting_schema.schema);
452 }
453
454 fn merge_schema(target: &mut SchemaObject, source: SchemaObject) {
455 if let Some(source) = source.object {
456 let target_properties = &mut target.object().properties;
457 for (key, value) in source.properties {
458 match target_properties.entry(key) {
459 btree_map::Entry::Vacant(e) => {
460 e.insert(value);
461 }
462 btree_map::Entry::Occupied(e) => {
463 if let (Schema::Object(target), Schema::Object(src)) =
464 (e.into_mut(), value)
465 {
466 merge_schema(target, src);
467 }
468 }
469 }
470 }
471 }
472
473 overwrite(&mut target.instance_type, source.instance_type);
474 overwrite(&mut target.string, source.string);
475 overwrite(&mut target.number, source.number);
476 overwrite(&mut target.reference, source.reference);
477 overwrite(&mut target.array, source.array);
478 overwrite(&mut target.enum_values, source.enum_values);
479
480 fn overwrite<T>(target: &mut Option<T>, source: Option<T>) {
481 if let Some(source) = source {
482 *target = Some(source);
483 }
484 }
485 }
486
487 serde_json::to_value(&combined_schema).unwrap()
488 }
489
490 fn recompute_values(
491 &mut self,
492 changed_local_path: Option<(usize, &Path)>,
493 cx: &mut AppContext,
494 ) -> Result<()> {
495 // Reload the global and local values for every setting.
496 let mut user_settings_stack = Vec::<DeserializedSetting>::new();
497 let mut paths_stack = Vec::<Option<(usize, &Path)>>::new();
498 for setting_value in self.setting_values.values_mut() {
499 let default_settings = setting_value.deserialize_setting(&self.raw_default_settings)?;
500
501 user_settings_stack.clear();
502 paths_stack.clear();
503
504 if let Some(user_settings) = setting_value
505 .deserialize_setting(&self.raw_user_settings)
506 .log_err()
507 {
508 user_settings_stack.push(user_settings);
509 paths_stack.push(None);
510 }
511
512 // If the global settings file changed, reload the global value for the field.
513 if changed_local_path.is_none() {
514 if let Some(value) = setting_value
515 .load_setting(&default_settings, &user_settings_stack, cx)
516 .log_err()
517 {
518 setting_value.set_global_value(value);
519 }
520 }
521
522 // Reload the local values for the setting.
523 for ((root_id, path), local_settings) in &self.raw_local_settings {
524 // Build a stack of all of the local values for that setting.
525 while let Some(prev_entry) = paths_stack.last() {
526 if let Some((prev_root_id, prev_path)) = prev_entry {
527 if root_id != prev_root_id || !path.starts_with(prev_path) {
528 paths_stack.pop();
529 user_settings_stack.pop();
530 continue;
531 }
532 }
533 break;
534 }
535
536 if let Some(local_settings) =
537 setting_value.deserialize_setting(local_settings).log_err()
538 {
539 paths_stack.push(Some((*root_id, path.as_ref())));
540 user_settings_stack.push(local_settings);
541
542 // If a local settings file changed, then avoid recomputing local
543 // settings for any path outside of that directory.
544 if changed_local_path.map_or(false, |(changed_root_id, changed_local_path)| {
545 *root_id != changed_root_id || !path.starts_with(changed_local_path)
546 }) {
547 continue;
548 }
549
550 if let Some(value) = setting_value
551 .load_setting(&default_settings, &user_settings_stack, cx)
552 .log_err()
553 {
554 setting_value.set_local_value(*root_id, path.clone(), value);
555 }
556 }
557 }
558 }
559 Ok(())
560 }
561}
562
563impl Debug for SettingsStore {
564 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
565 f.debug_struct("SettingsStore")
566 .field(
567 "types",
568 &self
569 .setting_values
570 .values()
571 .map(|value| value.setting_type_name())
572 .collect::<Vec<_>>(),
573 )
574 .field("default_settings", &self.raw_default_settings)
575 .field("user_settings", &self.raw_user_settings)
576 .field("local_settings", &self.raw_local_settings)
577 .finish_non_exhaustive()
578 }
579}
580
581impl<T: Settings> AnySettingValue for SettingValue<T> {
582 fn key(&self) -> Option<&'static str> {
583 T::KEY
584 }
585
586 fn setting_type_name(&self) -> &'static str {
587 type_name::<T>()
588 }
589
590 fn load_setting(
591 &self,
592 default_value: &DeserializedSetting,
593 user_values: &[DeserializedSetting],
594 cx: &mut AppContext,
595 ) -> Result<Box<dyn Any>> {
596 let default_value = default_value.0.downcast_ref::<T::FileContent>().unwrap();
597 let values: SmallVec<[&T::FileContent; 6]> = user_values
598 .iter()
599 .map(|value| value.0.downcast_ref().unwrap())
600 .collect();
601 Ok(Box::new(T::load(default_value, &values, cx)?))
602 }
603
604 fn deserialize_setting(&self, mut json: &serde_json::Value) -> Result<DeserializedSetting> {
605 if let Some(key) = T::KEY {
606 if let Some(value) = json.get(key) {
607 json = value;
608 } else {
609 let value = T::FileContent::default();
610 return Ok(DeserializedSetting(Box::new(value)));
611 }
612 }
613 let value = T::FileContent::deserialize(json)?;
614 Ok(DeserializedSetting(Box::new(value)))
615 }
616
617 fn value_for_path(&self, path: Option<(usize, &Path)>) -> &dyn Any {
618 if let Some((root_id, path)) = path {
619 for (settings_root_id, settings_path, value) in self.local_values.iter().rev() {
620 if root_id == *settings_root_id && path.starts_with(&settings_path) {
621 return value;
622 }
623 }
624 }
625 self.global_value
626 .as_ref()
627 .unwrap_or_else(|| panic!("no default value for setting {}", self.setting_type_name()))
628 }
629
630 fn set_global_value(&mut self, value: Box<dyn Any>) {
631 self.global_value = Some(*value.downcast().unwrap());
632 }
633
634 fn set_local_value(&mut self, root_id: usize, path: Arc<Path>, value: Box<dyn Any>) {
635 let value = *value.downcast().unwrap();
636 match self
637 .local_values
638 .binary_search_by_key(&(root_id, &path), |e| (e.0, &e.1))
639 {
640 Ok(ix) => self.local_values[ix].2 = value,
641 Err(ix) => self.local_values.insert(ix, (root_id, path, value)),
642 }
643 }
644
645 fn json_schema(
646 &self,
647 generator: &mut SchemaGenerator,
648 params: &SettingsJsonSchemaParams,
649 cx: &AppContext,
650 ) -> RootSchema {
651 T::json_schema(generator, params, cx)
652 }
653}
654
655fn update_value_in_json_text<'a>(
656 text: &mut String,
657 key_path: &mut Vec<&'a str>,
658 tab_size: usize,
659 old_value: &'a serde_json::Value,
660 new_value: &'a serde_json::Value,
661 edits: &mut Vec<(Range<usize>, String)>,
662) {
663 // If the old and new values are both objects, then compare them key by key,
664 // preserving the comments and formatting of the unchanged parts. Otherwise,
665 // replace the old value with the new value.
666 if let (serde_json::Value::Object(old_object), serde_json::Value::Object(new_object)) =
667 (old_value, new_value)
668 {
669 for (key, old_sub_value) in old_object.iter() {
670 key_path.push(key);
671 let new_sub_value = new_object.get(key).unwrap_or(&serde_json::Value::Null);
672 update_value_in_json_text(
673 text,
674 key_path,
675 tab_size,
676 old_sub_value,
677 new_sub_value,
678 edits,
679 );
680 key_path.pop();
681 }
682 for (key, new_sub_value) in new_object.iter() {
683 key_path.push(key);
684 if !old_object.contains_key(key) {
685 update_value_in_json_text(
686 text,
687 key_path,
688 tab_size,
689 &serde_json::Value::Null,
690 new_sub_value,
691 edits,
692 );
693 }
694 key_path.pop();
695 }
696 } else if old_value != new_value {
697 let mut new_value = new_value.clone();
698 if let Some(new_object) = new_value.as_object_mut() {
699 new_object.retain(|_, v| !v.is_null());
700 }
701 let (range, replacement) = replace_value_in_json_text(text, key_path, tab_size, &new_value);
702 text.replace_range(range.clone(), &replacement);
703 edits.push((range, replacement));
704 }
705}
706
707fn replace_value_in_json_text(
708 text: &str,
709 key_path: &[&str],
710 tab_size: usize,
711 new_value: &serde_json::Value,
712) -> (Range<usize>, String) {
713 const LANGUAGE_OVERRIDES: &'static str = "language_overrides";
714 const LANGUAGES: &'static str = "languages";
715
716 lazy_static! {
717 static ref PAIR_QUERY: tree_sitter::Query = tree_sitter::Query::new(
718 &tree_sitter_json::language(),
719 "(pair key: (string) @key value: (_) @value)",
720 )
721 .unwrap();
722 }
723
724 let mut parser = tree_sitter::Parser::new();
725 parser.set_language(&tree_sitter_json::language()).unwrap();
726 let syntax_tree = parser.parse(text, None).unwrap();
727
728 let mut cursor = tree_sitter::QueryCursor::new();
729
730 let has_language_overrides = text.contains(LANGUAGE_OVERRIDES);
731
732 let mut depth = 0;
733 let mut last_value_range = 0..0;
734 let mut first_key_start = None;
735 let mut existing_value_range = 0..text.len();
736 let matches = cursor.matches(&PAIR_QUERY, syntax_tree.root_node(), text.as_bytes());
737 for mat in matches {
738 if mat.captures.len() != 2 {
739 continue;
740 }
741
742 let key_range = mat.captures[0].node.byte_range();
743 let value_range = mat.captures[1].node.byte_range();
744
745 // Don't enter sub objects until we find an exact
746 // match for the current keypath
747 if last_value_range.contains_inclusive(&value_range) {
748 continue;
749 }
750
751 last_value_range = value_range.clone();
752
753 if key_range.start > existing_value_range.end {
754 break;
755 }
756
757 first_key_start.get_or_insert_with(|| key_range.start);
758
759 let found_key = text
760 .get(key_range.clone())
761 .map(|key_text| {
762 if key_path[depth] == LANGUAGES && has_language_overrides {
763 return key_text == format!("\"{}\"", LANGUAGE_OVERRIDES);
764 } else {
765 return key_text == format!("\"{}\"", key_path[depth]);
766 }
767 })
768 .unwrap_or(false);
769
770 if found_key {
771 existing_value_range = value_range;
772 // Reset last value range when increasing in depth
773 last_value_range = existing_value_range.start..existing_value_range.start;
774 depth += 1;
775
776 if depth == key_path.len() {
777 break;
778 } else {
779 first_key_start = None;
780 }
781 }
782 }
783
784 // We found the exact key we want, insert the new value
785 if depth == key_path.len() {
786 let new_val = to_pretty_json(&new_value, tab_size, tab_size * depth);
787 (existing_value_range, new_val)
788 } else {
789 // We have key paths, construct the sub objects
790 let new_key = if has_language_overrides && key_path[depth] == LANGUAGES {
791 LANGUAGE_OVERRIDES
792 } else {
793 key_path[depth]
794 };
795
796 // We don't have the key, construct the nested objects
797 let mut new_value = serde_json::to_value(new_value).unwrap();
798 for key in key_path[(depth + 1)..].iter().rev() {
799 if has_language_overrides && key == &LANGUAGES {
800 new_value = serde_json::json!({ LANGUAGE_OVERRIDES.to_string(): new_value });
801 } else {
802 new_value = serde_json::json!({ key.to_string(): new_value });
803 }
804 }
805
806 if let Some(first_key_start) = first_key_start {
807 let mut row = 0;
808 let mut column = 0;
809 for (ix, char) in text.char_indices() {
810 if ix == first_key_start {
811 break;
812 }
813 if char == '\n' {
814 row += 1;
815 column = 0;
816 } else {
817 column += char.len_utf8();
818 }
819 }
820
821 if row > 0 {
822 // depth is 0 based, but division needs to be 1 based.
823 let new_val = to_pretty_json(&new_value, column / (depth + 1), column);
824 let space = ' ';
825 let content = format!("\"{new_key}\": {new_val},\n{space:width$}", width = column);
826 (first_key_start..first_key_start, content)
827 } else {
828 let new_val = serde_json::to_string(&new_value).unwrap();
829 let mut content = format!(r#""{new_key}": {new_val},"#);
830 content.push(' ');
831 (first_key_start..first_key_start, content)
832 }
833 } else {
834 new_value = serde_json::json!({ new_key.to_string(): new_value });
835 let indent_prefix_len = 4 * depth;
836 let mut new_val = to_pretty_json(&new_value, 4, indent_prefix_len);
837 if depth == 0 {
838 new_val.push('\n');
839 }
840
841 (existing_value_range, new_val)
842 }
843 }
844}
845
846fn to_pretty_json(value: &impl Serialize, indent_size: usize, indent_prefix_len: usize) -> String {
847 const SPACES: [u8; 32] = [b' '; 32];
848
849 debug_assert!(indent_size <= SPACES.len());
850 debug_assert!(indent_prefix_len <= SPACES.len());
851
852 let mut output = Vec::new();
853 let mut ser = serde_json::Serializer::with_formatter(
854 &mut output,
855 serde_json::ser::PrettyFormatter::with_indent(&SPACES[0..indent_size.min(SPACES.len())]),
856 );
857
858 value.serialize(&mut ser).unwrap();
859 let text = String::from_utf8(output).unwrap();
860
861 let mut adjusted_text = String::new();
862 for (i, line) in text.split('\n').enumerate() {
863 if i > 0 {
864 adjusted_text.push_str(str::from_utf8(&SPACES[0..indent_prefix_len]).unwrap());
865 }
866 adjusted_text.push_str(line);
867 adjusted_text.push('\n');
868 }
869 adjusted_text.pop();
870 adjusted_text
871}
872
873pub fn parse_json_with_comments<T: DeserializeOwned>(content: &str) -> Result<T> {
874 Ok(serde_json_lenient::from_str(content)?)
875}
876
877#[cfg(test)]
878mod tests {
879 use super::*;
880 use serde_derive::Deserialize;
881 use unindent::Unindent;
882
883 #[gpui::test]
884 fn test_settings_store_basic(cx: &mut AppContext) {
885 let mut store = SettingsStore::default();
886 store.register_setting::<UserSettings>(cx);
887 store.register_setting::<TurboSetting>(cx);
888 store.register_setting::<MultiKeySettings>(cx);
889 store
890 .set_default_settings(
891 r#"{
892 "turbo": false,
893 "user": {
894 "name": "John Doe",
895 "age": 30,
896 "staff": false
897 }
898 }"#,
899 cx,
900 )
901 .unwrap();
902
903 assert_eq!(store.get::<TurboSetting>(None), &TurboSetting(false));
904 assert_eq!(
905 store.get::<UserSettings>(None),
906 &UserSettings {
907 name: "John Doe".to_string(),
908 age: 30,
909 staff: false,
910 }
911 );
912 assert_eq!(
913 store.get::<MultiKeySettings>(None),
914 &MultiKeySettings {
915 key1: String::new(),
916 key2: String::new(),
917 }
918 );
919
920 store
921 .set_user_settings(
922 r#"{
923 "turbo": true,
924 "user": { "age": 31 },
925 "key1": "a"
926 }"#,
927 cx,
928 )
929 .unwrap();
930
931 assert_eq!(store.get::<TurboSetting>(None), &TurboSetting(true));
932 assert_eq!(
933 store.get::<UserSettings>(None),
934 &UserSettings {
935 name: "John Doe".to_string(),
936 age: 31,
937 staff: false
938 }
939 );
940
941 store
942 .set_local_settings(
943 1,
944 Path::new("/root1").into(),
945 Some(r#"{ "user": { "staff": true } }"#),
946 cx,
947 )
948 .unwrap();
949 store
950 .set_local_settings(
951 1,
952 Path::new("/root1/subdir").into(),
953 Some(r#"{ "user": { "name": "Jane Doe" } }"#),
954 cx,
955 )
956 .unwrap();
957
958 store
959 .set_local_settings(
960 1,
961 Path::new("/root2").into(),
962 Some(r#"{ "user": { "age": 42 }, "key2": "b" }"#),
963 cx,
964 )
965 .unwrap();
966
967 assert_eq!(
968 store.get::<UserSettings>(Some((1, Path::new("/root1/something")))),
969 &UserSettings {
970 name: "John Doe".to_string(),
971 age: 31,
972 staff: true
973 }
974 );
975 assert_eq!(
976 store.get::<UserSettings>(Some((1, Path::new("/root1/subdir/something")))),
977 &UserSettings {
978 name: "Jane Doe".to_string(),
979 age: 31,
980 staff: true
981 }
982 );
983 assert_eq!(
984 store.get::<UserSettings>(Some((1, Path::new("/root2/something")))),
985 &UserSettings {
986 name: "John Doe".to_string(),
987 age: 42,
988 staff: false
989 }
990 );
991 assert_eq!(
992 store.get::<MultiKeySettings>(Some((1, Path::new("/root2/something")))),
993 &MultiKeySettings {
994 key1: "a".to_string(),
995 key2: "b".to_string(),
996 }
997 );
998 }
999
1000 #[gpui::test]
1001 fn test_setting_store_assign_json_before_register(cx: &mut AppContext) {
1002 let mut store = SettingsStore::default();
1003 store
1004 .set_default_settings(
1005 r#"{
1006 "turbo": true,
1007 "user": {
1008 "name": "John Doe",
1009 "age": 30,
1010 "staff": false
1011 },
1012 "key1": "x"
1013 }"#,
1014 cx,
1015 )
1016 .unwrap();
1017 store
1018 .set_user_settings(r#"{ "turbo": false }"#, cx)
1019 .unwrap();
1020 store.register_setting::<UserSettings>(cx);
1021 store.register_setting::<TurboSetting>(cx);
1022
1023 assert_eq!(store.get::<TurboSetting>(None), &TurboSetting(false));
1024 assert_eq!(
1025 store.get::<UserSettings>(None),
1026 &UserSettings {
1027 name: "John Doe".to_string(),
1028 age: 30,
1029 staff: false,
1030 }
1031 );
1032
1033 store.register_setting::<MultiKeySettings>(cx);
1034 assert_eq!(
1035 store.get::<MultiKeySettings>(None),
1036 &MultiKeySettings {
1037 key1: "x".into(),
1038 key2: String::new(),
1039 }
1040 );
1041 }
1042
1043 #[gpui::test]
1044 fn test_setting_store_update(cx: &mut AppContext) {
1045 let mut store = SettingsStore::default();
1046 store.register_setting::<MultiKeySettings>(cx);
1047 store.register_setting::<UserSettings>(cx);
1048 store.register_setting::<LanguageSettings>(cx);
1049
1050 // entries added and updated
1051 check_settings_update::<LanguageSettings>(
1052 &mut store,
1053 r#"{
1054 "languages": {
1055 "JSON": {
1056 "language_setting_1": true
1057 }
1058 }
1059 }"#
1060 .unindent(),
1061 |settings| {
1062 settings
1063 .languages
1064 .get_mut("JSON")
1065 .unwrap()
1066 .language_setting_1 = Some(false);
1067 settings.languages.insert(
1068 "Rust".into(),
1069 LanguageSettingEntry {
1070 language_setting_2: Some(true),
1071 ..Default::default()
1072 },
1073 );
1074 },
1075 r#"{
1076 "languages": {
1077 "Rust": {
1078 "language_setting_2": true
1079 },
1080 "JSON": {
1081 "language_setting_1": false
1082 }
1083 }
1084 }"#
1085 .unindent(),
1086 cx,
1087 );
1088
1089 // weird formatting
1090 check_settings_update::<UserSettings>(
1091 &mut store,
1092 r#"{
1093 "user": { "age": 36, "name": "Max", "staff": true }
1094 }"#
1095 .unindent(),
1096 |settings| settings.age = Some(37),
1097 r#"{
1098 "user": { "age": 37, "name": "Max", "staff": true }
1099 }"#
1100 .unindent(),
1101 cx,
1102 );
1103
1104 // single-line formatting, other keys
1105 check_settings_update::<MultiKeySettings>(
1106 &mut store,
1107 r#"{ "one": 1, "two": 2 }"#.unindent(),
1108 |settings| settings.key1 = Some("x".into()),
1109 r#"{ "key1": "x", "one": 1, "two": 2 }"#.unindent(),
1110 cx,
1111 );
1112
1113 // empty object
1114 check_settings_update::<UserSettings>(
1115 &mut store,
1116 r#"{
1117 "user": {}
1118 }"#
1119 .unindent(),
1120 |settings| settings.age = Some(37),
1121 r#"{
1122 "user": {
1123 "age": 37
1124 }
1125 }"#
1126 .unindent(),
1127 cx,
1128 );
1129
1130 // no content
1131 check_settings_update::<UserSettings>(
1132 &mut store,
1133 r#""#.unindent(),
1134 |settings| settings.age = Some(37),
1135 r#"{
1136 "user": {
1137 "age": 37
1138 }
1139 }
1140 "#
1141 .unindent(),
1142 cx,
1143 );
1144
1145 check_settings_update::<UserSettings>(
1146 &mut store,
1147 r#"{
1148 }
1149 "#
1150 .unindent(),
1151 |settings| settings.age = Some(37),
1152 r#"{
1153 "user": {
1154 "age": 37
1155 }
1156 }
1157 "#
1158 .unindent(),
1159 cx,
1160 );
1161 }
1162
1163 fn check_settings_update<T: Settings>(
1164 store: &mut SettingsStore,
1165 old_json: String,
1166 update: fn(&mut T::FileContent),
1167 expected_new_json: String,
1168 cx: &mut AppContext,
1169 ) {
1170 store.set_user_settings(&old_json, cx).ok();
1171 let edits = store.edits_for_update::<T>(&old_json, update);
1172 let mut new_json = old_json;
1173 for (range, replacement) in edits.into_iter() {
1174 new_json.replace_range(range, &replacement);
1175 }
1176 pretty_assertions::assert_eq!(new_json, expected_new_json);
1177 }
1178
1179 #[derive(Debug, PartialEq, Deserialize)]
1180 struct UserSettings {
1181 name: String,
1182 age: u32,
1183 staff: bool,
1184 }
1185
1186 #[derive(Default, Clone, Serialize, Deserialize, JsonSchema)]
1187 struct UserSettingsJson {
1188 name: Option<String>,
1189 age: Option<u32>,
1190 staff: Option<bool>,
1191 }
1192
1193 impl Settings for UserSettings {
1194 const KEY: Option<&'static str> = Some("user");
1195 type FileContent = UserSettingsJson;
1196
1197 fn load(
1198 default_value: &UserSettingsJson,
1199 user_values: &[&UserSettingsJson],
1200 _: &mut AppContext,
1201 ) -> Result<Self> {
1202 Self::load_via_json_merge(default_value, user_values)
1203 }
1204 }
1205
1206 #[derive(Debug, Deserialize, PartialEq)]
1207 struct TurboSetting(bool);
1208
1209 impl Settings for TurboSetting {
1210 const KEY: Option<&'static str> = Some("turbo");
1211 type FileContent = Option<bool>;
1212
1213 fn load(
1214 default_value: &Option<bool>,
1215 user_values: &[&Option<bool>],
1216 _: &mut AppContext,
1217 ) -> Result<Self> {
1218 Self::load_via_json_merge(default_value, user_values)
1219 }
1220 }
1221
1222 #[derive(Clone, Debug, PartialEq, Deserialize)]
1223 struct MultiKeySettings {
1224 #[serde(default)]
1225 key1: String,
1226 #[serde(default)]
1227 key2: String,
1228 }
1229
1230 #[derive(Clone, Default, Serialize, Deserialize, JsonSchema)]
1231 struct MultiKeySettingsJson {
1232 key1: Option<String>,
1233 key2: Option<String>,
1234 }
1235
1236 impl Settings for MultiKeySettings {
1237 const KEY: Option<&'static str> = None;
1238
1239 type FileContent = MultiKeySettingsJson;
1240
1241 fn load(
1242 default_value: &MultiKeySettingsJson,
1243 user_values: &[&MultiKeySettingsJson],
1244 _: &mut AppContext,
1245 ) -> Result<Self> {
1246 Self::load_via_json_merge(default_value, user_values)
1247 }
1248 }
1249
1250 #[derive(Debug, Deserialize)]
1251 struct JournalSettings {
1252 pub path: String,
1253 pub hour_format: HourFormat,
1254 }
1255
1256 #[derive(Clone, Debug, Serialize, Deserialize, JsonSchema)]
1257 #[serde(rename_all = "snake_case")]
1258 enum HourFormat {
1259 Hour12,
1260 Hour24,
1261 }
1262
1263 #[derive(Clone, Default, Debug, Serialize, Deserialize, JsonSchema)]
1264 struct JournalSettingsJson {
1265 pub path: Option<String>,
1266 pub hour_format: Option<HourFormat>,
1267 }
1268
1269 impl Settings for JournalSettings {
1270 const KEY: Option<&'static str> = Some("journal");
1271
1272 type FileContent = JournalSettingsJson;
1273
1274 fn load(
1275 default_value: &JournalSettingsJson,
1276 user_values: &[&JournalSettingsJson],
1277 _: &mut AppContext,
1278 ) -> Result<Self> {
1279 Self::load_via_json_merge(default_value, user_values)
1280 }
1281 }
1282
1283 #[derive(Clone, Debug, Default, Serialize, Deserialize, JsonSchema)]
1284 struct LanguageSettings {
1285 #[serde(default)]
1286 languages: HashMap<String, LanguageSettingEntry>,
1287 }
1288
1289 #[derive(Clone, Debug, Default, Serialize, Deserialize, JsonSchema)]
1290 struct LanguageSettingEntry {
1291 language_setting_1: Option<bool>,
1292 language_setting_2: Option<bool>,
1293 }
1294
1295 impl Settings for LanguageSettings {
1296 const KEY: Option<&'static str> = None;
1297
1298 type FileContent = Self;
1299
1300 fn load(default_value: &Self, user_values: &[&Self], _: &mut AppContext) -> Result<Self> {
1301 Self::load_via_json_merge(default_value, user_values)
1302 }
1303 }
1304}