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