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