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