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