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