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