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