1/// Trait for recursively merging settings structures.
2///
3/// When Zed starts it loads settinsg from `default.json` to initialize
4/// everything. These may be further refined by loading the user's settings,
5/// and any settings profiles; and then further refined by loading any
6/// local project settings.
7///
8/// The default behaviour of merging is:
9/// * For objects with named keys (HashMap, structs, etc.). The values are merged deeply
10/// (so if the default settings has languages.JSON.prettier.allowed = true, and the user's settings has
11/// languages.JSON.tab_size = 4; the merged settings file will have both settings).
12/// * For options, a None value is ignored, but Some values are merged recursively.
13/// * For other types (including Vec), a merge overwrites the current value.
14///
15/// If you want to break the rules you can (e.g. ExtendingVec, or SaturatingBool).
16#[allow(unused)]
17pub trait MergeFrom {
18 /// Merge from a source of the same type.
19 fn merge_from(&mut self, other: &Self);
20
21 /// Merge from an optional source of the same type.
22 fn merge_from_option(&mut self, other: Option<&Self>) {
23 if let Some(other) = other {
24 self.merge_from(other);
25 }
26 }
27}
28
29macro_rules! merge_from_overwrites {
30 ($($type:ty),+) => {
31 $(
32 impl MergeFrom for $type {
33 fn merge_from(&mut self, other: &Self) {
34 *self = other.clone();
35 }
36 }
37 )+
38 }
39}
40
41merge_from_overwrites!(
42 u16,
43 u32,
44 u64,
45 usize,
46 i16,
47 i32,
48 i64,
49 bool,
50 f64,
51 f32,
52 char,
53 std::num::NonZeroUsize,
54 std::num::NonZeroU32,
55 String,
56 std::sync::Arc<str>,
57 gpui::SharedString,
58 std::path::PathBuf,
59 gpui::Modifiers,
60 gpui::FontFeatures
61);
62
63impl<T: Clone + MergeFrom> MergeFrom for Option<T> {
64 fn merge_from(&mut self, other: &Self) {
65 let Some(other) = other else {
66 return;
67 };
68 if let Some(this) = self {
69 this.merge_from(other);
70 } else {
71 self.replace(other.clone());
72 }
73 }
74}
75
76impl<T: Clone> MergeFrom for Vec<T> {
77 fn merge_from(&mut self, other: &Self) {
78 *self = other.clone()
79 }
80}
81
82impl<T: MergeFrom> MergeFrom for Box<T> {
83 fn merge_from(&mut self, other: &Self) {
84 self.as_mut().merge_from(other.as_ref())
85 }
86}
87
88// Implementations for collections that extend/merge their contents
89impl<K, V> MergeFrom for collections::HashMap<K, V>
90where
91 K: Clone + std::hash::Hash + Eq,
92 V: Clone + MergeFrom,
93{
94 fn merge_from(&mut self, other: &Self) {
95 for (k, v) in other {
96 if let Some(existing) = self.get_mut(k) {
97 existing.merge_from(v);
98 } else {
99 self.insert(k.clone(), v.clone());
100 }
101 }
102 }
103}
104
105impl<K, V> MergeFrom for collections::BTreeMap<K, V>
106where
107 K: Clone + std::hash::Hash + Eq + Ord,
108 V: Clone + MergeFrom,
109{
110 fn merge_from(&mut self, other: &Self) {
111 for (k, v) in other {
112 if let Some(existing) = self.get_mut(k) {
113 existing.merge_from(v);
114 } else {
115 self.insert(k.clone(), v.clone());
116 }
117 }
118 }
119}
120
121impl<K, V> MergeFrom for collections::IndexMap<K, V>
122where
123 K: std::hash::Hash + Eq + Clone,
124 // Q: ?Sized + std::hash::Hash + collections::Equivalent<K> + Eq,
125 V: Clone + MergeFrom,
126{
127 fn merge_from(&mut self, other: &Self) {
128 for (k, v) in other {
129 if let Some(existing) = self.get_mut(k) {
130 existing.merge_from(v);
131 } else {
132 self.insert(k.clone(), v.clone());
133 }
134 }
135 }
136}
137
138impl<T> MergeFrom for collections::BTreeSet<T>
139where
140 T: Clone + Ord,
141{
142 fn merge_from(&mut self, other: &Self) {
143 for item in other {
144 self.insert(item.clone());
145 }
146 }
147}
148
149impl<T> MergeFrom for collections::HashSet<T>
150where
151 T: Clone + std::hash::Hash + Eq,
152{
153 fn merge_from(&mut self, other: &Self) {
154 for item in other {
155 self.insert(item.clone());
156 }
157 }
158}
159
160impl MergeFrom for serde_json::Value {
161 fn merge_from(&mut self, other: &Self) {
162 match (self, other) {
163 (serde_json::Value::Object(this), serde_json::Value::Object(other)) => {
164 for (k, v) in other {
165 if let Some(existing) = this.get_mut(k) {
166 existing.merge_from(v);
167 } else {
168 this.insert(k.clone(), v.clone());
169 }
170 }
171 }
172 (this, other) => *this = other.clone(),
173 }
174 }
175}