/
map.go
218 lines (188 loc) · 4.54 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
/*
* === This file is part of ALICE O² ===
*
* Copyright 2020 CERN and copyright holders of ALICE O².
* Author: Teo Mrnjavac <teo.mrnjavac@cern.ch>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* In applying this license CERN does not waive the privileges and
* immunities granted to it by virtue of its status as an
* Intergovernmental Organization or submit itself to any jurisdiction.
*/
// Package gera implements a hierarchical key-value store.
//
// A gera.Map uses a map[string]interface{} as backing store, and it can wrap other gera.Map instances.
// Values in child maps override any value provided by a gera.Map that's wrapped in the hierarchy.
package gera
import (
"github.com/imdario/mergo"
)
type Map interface {
Wrap(m Map) Map
IsHierarchyRoot() bool
HierarchyContains(m Map) bool
Unwrap() Map
Has(key string) bool
Len() int
Get(key string) (interface{}, bool)
Set(key string, value interface{}) bool
Flattened() (map[string]interface{}, error)
WrappedAndFlattened(m Map) (map[string]interface{}, error)
Raw() map[string]interface{}
}
func MakeMap() Map {
return &WrapMap{
theMap: make(map[string]interface{}),
parent: nil,
}
}
func MakeMapWithMap(fromMap map[string]interface{}) Map {
myMap := &WrapMap{
theMap: fromMap,
parent: nil,
}
return myMap
}
func MakeMapWithMapCopy(fromMap map[string]interface{}) Map {
newBackingMap := make(map[string]interface{})
for k, v := range fromMap {
newBackingMap[k] = v
}
return MakeMapWithMap(newBackingMap)
}
type WrapMap struct {
theMap map[string]interface{}
parent Map
}
func (w *WrapMap) UnmarshalYAML(unmarshal func(interface{}) error) error {
m := make(map[string]interface{})
err := unmarshal(&m)
if err == nil {
*w = WrapMap{
theMap: m,
parent: nil,
}
}
return err
}
func (w *WrapMap) IsHierarchyRoot() bool {
if w == nil || w.parent != nil {
return false
}
return true
}
func (w *WrapMap) HierarchyContains(m Map) bool {
if w == nil || w.parent == nil {
return false
}
if w.parent == m {
return true
}
return w.parent.HierarchyContains(m)
}
// Wraps this map around the gera.Map m, which becomes the new parent.
// Returns a pointer to the composite map (i.e. to itself in its new state).
func (w *WrapMap) Wrap(m Map) Map {
if w == nil {
return nil
}
w.parent = m
return w
}
// Unwraps this map from its parent.
// Returns a pointer to the former parent which was just unwrapped.
func (w *WrapMap) Unwrap() Map {
if w == nil {
return nil
}
p := w.parent
w.parent = nil
return p
}
func (w *WrapMap) Get(key string) (value interface{}, ok bool) {
if w == nil || w.theMap == nil {
return nil, false
}
if val, ok := w.theMap[key]; ok {
return val, true
}
if w.parent != nil {
return w.parent.Get(key)
}
return nil, false
}
func (w *WrapMap) Set(key string, value interface{}) (ok bool) {
if w == nil || w.theMap == nil {
return false
}
w.theMap[key] = value
return true
}
func (w *WrapMap) Has(key string) bool {
_, ok := w.Get(key)
return ok
}
func (w *WrapMap) Len() int {
if w == nil || w.theMap == nil {
return 0
}
flattened, err := w.Flattened()
if err != nil {
return 0
}
return len(flattened)
}
func (w *WrapMap) Flattened() (map[string]interface{}, error) {
if w == nil {
return nil, nil
}
out := make(map[string]interface{})
for k, v := range w.theMap {
out[k] = v
}
if w.parent == nil {
return out, nil
}
flattenedParent, err := w.parent.Flattened()
if err != nil {
return out, err
}
err = mergo.Merge(&out, flattenedParent)
return out, err
}
func (w *WrapMap) WrappedAndFlattened(m Map) (map[string]interface{}, error) {
if w == nil {
return nil, nil
}
out := make(map[string]interface{})
for k, v := range w.theMap {
out[k] = v
}
if m == nil {
return out, nil
}
flattenedM, err := m.Flattened()
if err != nil {
return out, err
}
err = mergo.Merge(&out, flattenedM)
return out, err
}
func (w *WrapMap) Raw() map[string]interface{} {
if w == nil {
return nil
}
return w.theMap
}