-
Notifications
You must be signed in to change notification settings - Fork 0
/
map.go
325 lines (282 loc) · 8.29 KB
/
map.go
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
package geko
// DuplicatedKeyStrategy controls the behavior of [Map.Add] when meet a
// duplicate key. Default strategy is [UpdateValueKeepOrder].
//
// If you want store all values of duplicated key, use [Pairs] instead.
type DuplicatedKeyStrategy uint8
const (
// UpdateValueKeepOrder will use new value, but do not change key order.
//
// {"a": 1, "b": 2, "a": 3} => {"a": 3, "b": 2}
//
// This is the default strategy.
UpdateValueKeepOrder DuplicatedKeyStrategy = iota
// UpdateValueUpdateOrder will use new value, and move the key to last.
//
// {"a": 1, "b": 2, "a": 3} => {"b": 2, "a": 3}
UpdateValueUpdateOrder
// KeepValueUpdateOrder will keep the value not change, but move the key to
// last.
//
// {"a": 1, "b": 2, "a": 3} => {"b": 2, "a": 1}
KeepValueUpdateOrder
// Ignore will do nothing, keeps old key order and value.
//
// {"a": 1, "b": 2, "a": 3} => {"a": 1, "b": 2}
Ignore
)
// Map is a map, in which the kv pairs will keep order of their insertion.
//
// In JSON unmarshal, it will use the order of appearance in input JSON data,
// and marshal output will use the same order.
//
// When unmarshal from JSON into a [Object], all JSON object will be
// stored in [Object], all JSON array will be stored in [Array],
// instead of normal map[string]any and []any from std lib.
//
// You can use [Map.SetDuplicatedKeyStrategy] before call [json.Unmarshal] to
// control the behavior when object has duplicated key in your JSON string data.
//
// If you can't make sure the outmost item is object, try [JSONUnmarshal].
type Map[K comparable, V any] struct {
order []K
inner map[K]V
duplicatedKeyStrategy DuplicatedKeyStrategy
}
// Object is a [Map], whose type parameters are specialized as
// [string, any], used to represent dynamic objects in JSON.
type Object = *Map[string, any]
// NewMap creates a new empty map.
func NewMap[K comparable, V any]() *Map[K, V] {
return &Map[K, V]{}
}
// NewMapWithCapacity likes [NewMap], but init the inner container with a
// capacity to optimize memory allocate.
func NewMapWithCapacity[K comparable, V any](capacity int) *Map[K, V] {
m := NewMap[K, V]()
m.order = make([]K, 0, capacity)
m.inner = make(map[K]V, capacity)
return m
}
// DuplicatedKeyStrategy get current strategy when [Map.Add] with a duplicated
// key.
//
// See document of [DuplicatedKeyStrategy] and its enum value for detail.
func (m *Map[K, V]) DuplicatedKeyStrategy() DuplicatedKeyStrategy {
return m.duplicatedKeyStrategy
}
// SetDuplicatedKeyStrategy set strategy when [Map.Add] with a duplicated key.
//
// See document of [DuplicatedKeyStrategy] and its enum value for detail.
func (m *Map[K, V]) SetDuplicatedKeyStrategy(strategy DuplicatedKeyStrategy) {
m.duplicatedKeyStrategy = strategy
}
// Get a value by key. The second return value tells if the key exists. If
// not, first return value will be zero value of type V.
func (m *Map[K, V]) Get(key K) (V, bool) {
v, exist := m.inner[key]
return v, exist
}
// Has checks if key exist in the map.
func (m *Map[K, V]) Has(key K) bool {
_, exist := m.inner[key]
return exist
}
// GetOrZeroValue return value by key, or the zero value of type V
// if key not exist.
func (m *Map[K, V]) GetOrZeroValue(key K) V {
return m.inner[key]
}
// GetKeyByIndex get key by index of key order.
//
// You should make sure 0 <= i < Len(), panic if out of bound.
func (m *Map[K, V]) GetKeyByIndex(index int) K {
return m.order[index]
}
// GetByIndex get the key and value by index of key order.
//
// You should make sure 0 <= i < Len(), panic if out of bound.
func (m *Map[K, V]) GetByIndex(index int) Pair[K, V] {
k := m.GetKeyByIndex(index)
return CreatePair(k, m.GetOrZeroValue(k))
}
// GetValueByIndex get the value by index of key order.
//
// You should make sure 0 <= i < Len(), panic if out of bound.
func (m *Map[K, V]) GetValueByIndex(index int) V {
k := m.GetKeyByIndex(index)
return m.GetOrZeroValue(k)
}
func (m *Map[K, V]) set(key K, value V, alreadyExist bool) {
if m.inner == nil {
m.inner = make(map[K]V)
}
if !alreadyExist {
m.order = append(m.order, key)
}
m.inner[key] = value
}
// Set a value by key without change its order, or place it at end if key is
// not exist.
//
// This operation is the same as [Map.Add] when duplicate key strategy is
// [UpdateValueKeepOrder].
func (m *Map[K, V]) Set(key K, value V) {
m.set(key, value, m.Has(key))
}
// Add a key value pair.
//
// If the key is already exist in map, the behavior is controlled by
// [Map.DuplicatedKeyStrategy].
func (m *Map[K, V]) Add(key K, value V) {
var alreadyExist bool
switch m.duplicatedKeyStrategy {
default:
fallthrough
case UpdateValueKeepOrder:
{
alreadyExist = m.Has(key)
}
case UpdateValueUpdateOrder:
{
m.Delete(key)
// alreadyExist = false
}
case KeepValueUpdateOrder:
{
oldValue, exist := m.Get(key)
if exist {
value = oldValue
m.Delete(key)
}
// alreadyExist = false
}
case Ignore:
{
if m.Has(key) {
return
}
// alreadyExist = false
}
}
m.set(key, value, alreadyExist)
}
// Append a series of kv pairs into map.
//
// The effect is consistent with calling [Map.Add](k, v) multi times.
func (m *Map[K, V]) Append(pairs ...Pair[K, V]) {
for _, pair := range pairs {
m.Add(pair.Key, pair.Value)
}
}
// Delete a item by key.
//
// Performance: causes O(n) operation, avoid heavy use.
func (m *Map[K, V]) Delete(key K) {
_, exist := m.inner[key]
if !exist {
return
}
for i, k := range m.order {
if k == key {
m.order = append(m.order[:i], m.order[i+1:]...)
break
}
}
delete(m.inner, key)
}
// DeleteByIndex delete a item by it's index in order.
//
// You should make sure 0 <= i < Len(), panic if out of bound.
//
// Performance: causes O(n) operation, avoid heavy use.
func (m *Map[K, V]) DeleteByIndex(index int) {
key := m.order[index]
m.order = append(m.order[:index], m.order[index+1:]...)
delete(m.inner, key)
}
// Clear this map.
func (m *Map[K, V]) Clear() {
m.order = nil
m.inner = nil
}
// Len returns the size of map.
func (m *Map[K, V]) Len() int {
return len(m.inner)
}
// Keys returns a copy of all keys of the map, in current order.
//
// Performance: O(n) operation. If you want iterate over the map,
// maybe [Map.Len] + [Map.GetKeyByIndex] is a better choice.
func (m *Map[K, V]) Keys() []K {
// copy to avoid user modify the order.
keys := make([]K, m.Len())
copy(keys, m.order)
return keys
}
// Values returns a copy of all values of the map, in current order.
//
// Performance: O(n) operation. If you want iterate over the map,
// maybe [Map.Len] + [Map.GetValueByIndex] is a better choice.
func (m *Map[K, V]) Values() []V {
length := m.Len()
values := make([]V, 0, length)
for i := 0; i < length; i++ {
values = append(values, m.GetValueByIndex(i))
}
return values
}
// Pairs gives you all data the map stored as a list of pair, in current order.
//
// Performance: O(n) operation. If you want iterate over the map,
// maybe [Map.Len] + [Map.GetByIndex] is a better choice.
func (m *Map[K, V]) Pairs() *Pairs[K, V] {
length := m.Len()
pairs := NewPairsWithCapacity[K, V](length)
for i := 0; i < length; i++ {
pairs.List = append(pairs.List, m.GetByIndex(i))
}
return pairs
}
// Sort will reorder the map using the given less function.
func (m *Map[K, V]) Sort(lessFunc PairLessFunc[K, V]) {
pairs := m.Pairs()
pairs.Sort(lessFunc)
for i, length := 0, m.Len(); i < length; i++ {
m.order[i] = pairs.List[i].Key
}
}
// Filter remove all item which make pred func return false.
//
// Performance: O(n) operation. More efficient then [Map.GetByIndex] +
// [Map.DeleteByIndex] in a loop, which is O(n^2).
func (m *Map[K, V]) Filter(pred PairFilterFunc[K, V]) {
n := 0
for i, length := 0, m.Len(); i < length; i++ {
pair := m.GetByIndex(i)
if pred(&pair) {
m.order[n] = m.order[i]
n++
} else {
delete(m.inner, pair.Key)
}
}
m.order = m.order[:n]
}
// MarshalJSON implements [json.Marshaler] interface.
//
// You should not call this directly, use [json.Marshal] instead.
func (m Map[K, V]) MarshalJSON() ([]byte, error) {
return marshalObject[K, V](&m)
}
// UnmarshalJSON implements [json.Unmarshaler] interface.
//
// You shouldn't call this directly, use [json.Unmarshal]/[JSONUnmarshal]
// instead.
func (m *Map[K, V]) UnmarshalJSON(data []byte) error {
return unmarshalObject[K, V](
data, m,
UseObject(),
ObjectOnDuplicatedKey(m.duplicatedKeyStrategy),
)
}