-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathExtensions.Generic.cs
448 lines (392 loc) · 14.2 KB
/
Extensions.Generic.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
using System;
using System.Collections.Generic;
using System.Diagnostics.Contracts;
using System.Runtime.CompilerServices;
namespace Open.Collections;
public static partial class Extensions
{
/// <summary>
/// Will remove an entry if the value is null or matches the default type value.
/// Otherwise will set the value.
/// </summary>
public static void SetOrRemove<TKey, T>(
this IDictionary<TKey, T> target,
TKey key,
T value)
{
if (target is null) throw new ArgumentNullException(nameof(target));
if (key is null) throw new ArgumentNullException(nameof(key));
Contract.EndContractBlock();
if (value is null || value.Equals(default(T)))
target.Remove(key);
else
target[key] = value;
}
/// <summary>
/// Adds a value to list only if it does not exist.
/// </summary>
/// <remarks>NOT THREAD SAFE: Use only when a dictionary is assured to be single threaded.</remarks>
public static void Register<T>(this ICollection<T> target, T value)
{
if (target is null) throw new ArgumentNullException(nameof(target));
Contract.EndContractBlock();
if (!target.Contains(value))
target.Add(value);
}
/// <summary>
/// Adds each value to the end of the <paramref name="target"/> collection.
/// </summary>
/// <exception cref="ArgumentNullException">If the <paramref name="target"/> is null.</exception>
public static void AddRange<T>(
this ICollection<T> target,
IEnumerable<T> values)
{
if (target is null) throw new ArgumentNullException(nameof(target));
Contract.EndContractBlock();
if (values is null)
return;
foreach (T? value in values)
target.Add(value);
}
/// <inheritdoc cref="AddRange{T}(ICollection{T}, IEnumerable{T})"/>
#if NET9_0_OR_GREATER
[OverloadResolutionPriority(1)]
#endif
public static void AddRange<T>(
this ICollection<T> target,
ReadOnlySpan<T> values)
{
if (target is null) throw new ArgumentNullException(nameof(target));
Contract.EndContractBlock();
foreach (T value in values)
target.Add(value);
}
/// <summary>
/// Adds each value to the end of the <paramref name="target"/> collection.
/// </summary>
#if NET9_0_OR_GREATER
public static void AddThese<T>(this ICollection<T> target, T a, T b, params ReadOnlySpan<T> more)
#else
public static void AddThese<T>(this ICollection<T> target, T a, T b, params T[] more)
#endif
{
target.Add(a);
target.Add(b);
foreach (T value in more)
target.Add(value);
}
/// <summary>
/// Removes each value from the <paramref name="target"/> collection.
/// </summary>
public static int Remove<T>(this ICollection<T> target, IEnumerable<T> values)
{
if (target is null) throw new ArgumentNullException(nameof(target));
Contract.EndContractBlock();
int count = 0;
if (values is not null)
{
foreach (T? value in values)
{
if (target.Remove(value))
count++;
}
}
return count;
}
/// <summary>
/// Shortcut for adding a value or updating based on exising value.
/// If no value exists, it adds the provided value.
/// If a value exists, it sets the value using the updateValueFactory.
/// </summary>
/// <remarks>NOT THREAD SAFE: Use only when a dictionary is assured to be single threaded.</remarks>
public static T AddOrUpdate<TKey, T>(this IDictionary<TKey, T> target, TKey key,
T value,
T updateValue)
where TKey : notnull
{
if (target is null) throw new ArgumentNullException(nameof(target));
if (key is null) throw new ArgumentNullException(nameof(key));
Contract.EndContractBlock();
#if NET9_0_OR_GREATER
if (target is Dictionary<TKey, T> d)
{
ref var val = ref System.Runtime.InteropServices.CollectionsMarshal.GetValueRefOrNullRef(d, key);
return System.Runtime.CompilerServices.Unsafe.IsNullRef(ref val)
? (val = value)
: (val = updateValue);
}
#endif
T valueUsed;
if (target.TryGetValue(key, out _))
target[key] = valueUsed = updateValue;
else
target.Add(key, valueUsed = value);
return valueUsed;
}
/// <summary>
/// Shortcut for adding a value or updating based on exising value.
/// If no value exists, it adds the provided value.
/// If a value exists, it sets the value using the updateValueFactory.
/// </summary>
/// <remarks>NOT THREAD SAFE: Use only when a dictionary is assured to be single threaded.</remarks>
public static T AddOrUpdate<TKey, T>(this IDictionary<TKey, T> target, TKey key, T value,
Func<TKey, T, T> updateValueFactory)
where TKey : notnull
{
if (target is null) throw new ArgumentNullException(nameof(target));
if (key is null) throw new ArgumentNullException(nameof(key));
if (updateValueFactory is null) throw new ArgumentNullException(nameof(updateValueFactory));
Contract.EndContractBlock();
#if NET9_0_OR_GREATER
if (target is Dictionary<TKey, T> d)
{
ref var val = ref System.Runtime.InteropServices.CollectionsMarshal.GetValueRefOrNullRef(d, key);
return System.Runtime.CompilerServices.Unsafe.IsNullRef(ref val)
? (val = value)
: (val = updateValueFactory(key, val));
}
#endif
T valueUsed;
if (target.TryGetValue(key, out T? old))
target[key] = valueUsed = updateValueFactory(key, old);
else
target.Add(key, valueUsed = value);
return valueUsed;
}
/// <summary>
/// Shortcut for adding a value or updating based on exising value.
/// If no value exists, it adds the value using the newValueFactory.
/// If a value exists, it sets the value using the updateValueFactory.
/// </summary>
/// <remarks>NOT THREAD SAFE: Use only when a dictionary is assured to be single threaded.</remarks>
public static T AddOrUpdate<TKey, T>(this IDictionary<TKey, T> target, TKey key,
Func<TKey, T> newValueFactory,
Func<TKey, T, T> updateValueFactory)
where TKey : notnull
{
if (target is null) throw new ArgumentNullException(nameof(target));
if (key is null) throw new ArgumentNullException(nameof(key));
if (newValueFactory is null) throw new ArgumentNullException(nameof(newValueFactory));
if (updateValueFactory is null) throw new ArgumentNullException(nameof(updateValueFactory));
Contract.EndContractBlock();
#if NET9_0_OR_GREATER
if (target is Dictionary<TKey, T> d)
{
ref var val = ref System.Runtime.InteropServices.CollectionsMarshal.GetValueRefOrNullRef(d, key);
return System.Runtime.CompilerServices.Unsafe.IsNullRef(ref val)
? (val = newValueFactory(key))
: (val = updateValueFactory(key, val));
}
#endif
T valueUsed;
if (target.TryGetValue(key, out T? old))
target[key] = valueUsed = updateValueFactory(key, old);
else
target.Add(key, valueUsed = newValueFactory(key));
return valueUsed;
}
/// <summary>
/// Shortcut for adding a value to list within a dictionary.
/// </summary>
public static void AddTo<TKey, TValue>(this IDictionary<TKey, IList<TValue>> c, TKey key, TValue value)
where TKey : notnull
{
if (c is null) throw new ArgumentNullException(nameof(c));
if (key is null) throw new ArgumentNullException(nameof(key));
Contract.EndContractBlock();
IList<TValue>? list = c.GetOrAdd(key, _ => []);
list.Add(value);
}
/// <summary>
/// Shortcut for ensuring a cacheKey contains a action. If no value exists, it adds the provided defaultValue.
/// </summary>
/// <remarks>NOT THREAD SAFE: Use only when a dictionary is assured to be single threaded.</remarks>
[Obsolete("Use TryAdd instead.")]
public static void EnsureDefault<TKey, T>(this IDictionary<TKey, T> target, TKey key, T defaultValue)
where TKey : notnull
=> TryAdd(target, key, defaultValue);
/// <summary>
/// Shortcut for ensuring a cacheKey contains a Value. If no value exists, it adds it using the provided defaultValueFactory.
/// </summary>
/// <remarks>NOT THREAD SAFE: Use only when a dictionary is assured to be single threaded.</remarks>
[Obsolete("Use TryAdd instead.")]
public static void EnsureDefault<TKey, T>(this IDictionary<TKey, T> target, TKey key,
Func<TKey, T> defaultValueFactory)
where TKey : notnull
=> TryAdd(target, key, defaultValueFactory);
/// <summary>
/// Attempts to add a value to a dictionary if it does not already exist.
/// </summary>
/// <remarks>NOT THREAD SAFE: Use only when a dictionary is assured to be single threaded.</remarks>
public static bool TryAdd<TKey, T>(this IDictionary<TKey, T> target, TKey key, T value)
where TKey : notnull
{
if (target is null) throw new ArgumentNullException(nameof(target));
if (key is null) throw new ArgumentNullException(nameof(key));
Contract.EndContractBlock();
#if NET9_0_OR_GREATER
if (target is Dictionary<TKey, T> d)
{
ref var val = ref System.Runtime.InteropServices.CollectionsMarshal.GetValueRefOrAddDefault(d, key, out bool exists);
if (!exists) val = value;
return !exists;
}
#endif
if (target.ContainsKey(key))
return false;
target.Add(key, value);
return true;
}
/// <inheritdoc cref="TryAdd{TKey, T}(IDictionary{TKey, T}, TKey, T)"/>
public static bool TryAdd<TKey, T>(this IDictionary<TKey, T> target, TKey key,
Func<TKey, T> defaultValueFactory)
where TKey : notnull
{
if (target is null) throw new ArgumentNullException(nameof(target));
if (key is null) throw new ArgumentNullException(nameof(key));
if (defaultValueFactory is null) throw new ArgumentNullException(nameof(defaultValueFactory));
Contract.EndContractBlock();
#if NET9_0_OR_GREATER
if (target is Dictionary<TKey, T> d)
{
ref var val = ref System.Runtime.InteropServices.CollectionsMarshal.GetValueRefOrAddDefault(d, key, out bool exists);
if (!exists) val = defaultValueFactory(key);
return !exists;
}
#endif
if (target.ContainsKey(key))
return false;
target.Add(key, defaultValueFactory(key));
return true;
}
/// <summary>
/// Attempts to get a value from a dictionary and if no value is present, it returns the default.
/// </summary>
public static T GetOrDefault<TKey, T>(
this IDictionary<TKey, T> target,
TKey key)
where TKey : notnull
{
if (target is null) throw new ArgumentNullException(nameof(target));
if (key is null) throw new ArgumentNullException(nameof(key));
Contract.EndContractBlock();
return target.GetOrDefault(key, default(T)!);
}
/// <summary>
/// Attempts to get a value from a dictionary and if no value is present, it returns the provided defaultValue.
/// </summary>
public static T GetOrDefault<TKey, T>(
this IDictionary<TKey, T> target,
TKey key,
T defaultValue)
where TKey : notnull
{
if (target is null) throw new ArgumentNullException(nameof(target));
if (key is null) throw new ArgumentNullException(nameof(key));
Contract.EndContractBlock();
return target.TryGetValue(key, out T? value) ? value : defaultValue;
}
/// <summary>
/// Attempts to get a value from a dictionary and if no value is present, it returns the response of the valueFactory.
/// </summary>
public static T GetOrDefault<TKey, T>(
this IDictionary<TKey, T> target,
TKey key,
Func<TKey, T> valueFactory)
where TKey : notnull
{
if (target is null) throw new ArgumentNullException(nameof(target));
if (key is null) throw new ArgumentNullException(nameof(key));
if (valueFactory is null) throw new ArgumentNullException(nameof(valueFactory));
Contract.EndContractBlock();
return target.TryGetValue(key, out T? value) ? value : valueFactory(key);
}
/// <summary>
/// Tries to acquire a value from the dictionary. If no value is present it adds it using the valueFactory response.
/// </summary>
/// <remarks>NOT THREAD SAFE: Use only when a dictionary is assured to be single threaded.</remarks>
public static T GetOrAdd<TKey, T>(
this IDictionary<TKey, T> target,
TKey key,
Func<TKey, T> valueFactory)
where TKey : notnull
{
if (target is null) throw new ArgumentNullException(nameof(target));
if (key is null) throw new ArgumentNullException(nameof(key));
if (valueFactory is null) throw new ArgumentNullException(nameof(valueFactory));
Contract.EndContractBlock();
#if NET9_0_OR_GREATER
if (target is Dictionary<TKey, T> d)
{
ref var val = ref System.Runtime.InteropServices.CollectionsMarshal.GetValueRefOrAddDefault(d, key, out bool exists);
if(!exists) val = valueFactory(key);
return val!;
}
#endif
if (!target.TryGetValue(key, out var value))
target.Add(key, value = valueFactory(key));
return value;
}
/// <summary>
/// Tries to acquire a value from the dictionary. If no value is present it adds the value provided.
/// </summary>
/// <remarks>NOT THREAD SAFE: Use only when a dictionary is assured to be single threaded.</remarks>
public static T GetOrAdd<TKey, T>(
this IDictionary<TKey, T> target,
TKey key, T value)
where TKey : notnull
{
if (target is null) throw new ArgumentNullException(nameof(target));
if (key is null) throw new ArgumentNullException(nameof(key));
Contract.EndContractBlock();
#if NET9_0_OR_GREATER
if (target is Dictionary<TKey, T> d)
{
ref var val = ref System.Runtime.InteropServices.CollectionsMarshal.GetValueRefOrAddDefault(d, key, out bool exists);
if (!exists) val = value;
return val!;
}
#endif
if (!target.TryGetValue(key, out T? v))
target.Add(key, v = value);
return v;
}
/// <summary>
/// Tries to update an existing value in the dictionary.
/// </summary>
/// <remarks>NOT THREAD SAFE: Use only when a dictionary is assured to be single threaded.</remarks>
/// <returns>
/// <see langword="true"/> if the value was overwritten;
/// <see langword="false"/> if there was no original value
/// or if <paramref name="compareExisting"/> is <see langword="true"/> and the values are equal.
/// </returns>
public static bool TryUpdate<TKey, T>(
this IDictionary<TKey, T> target,
TKey key, T value,
bool compareExisting = false)
where TKey : notnull
{
if (target is null) throw new ArgumentNullException(nameof(target));
if (key is null) throw new ArgumentNullException(nameof(key));
Contract.EndContractBlock();
#if NET9_0_OR_GREATER
if (target is Dictionary<TKey, T> d)
{
ref var val = ref System.Runtime.InteropServices.CollectionsMarshal.GetValueRefOrNullRef(d, key);
if(System.Runtime.CompilerServices.Unsafe.IsNullRef(ref val))
return false;
if(compareExisting && !AreEqual(val, value))
return false;
val = value;
return true;
}
#endif
if (!target.TryGetValue(key, out var v))
return false;
if (compareExisting && !AreEqual(v, value))
return false;
target[key] = value;
return true;
static bool AreEqual(T a, T b) => a is null ? b is null : a.Equals(b);
}
}