forked from elastic/crd-ref-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
types.go
256 lines (221 loc) · 5.49 KB
/
types.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
// Licensed to Elasticsearch B.V. under one or more contributor
// license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright
// ownership. Elasticsearch B.V. licenses this file to you under
// the Apache License, Version 2.0 (the "License"); you may
// not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.
package types
import (
"encoding/json"
"fmt"
"sort"
"strings"
"k8s.io/apimachinery/pkg/runtime/schema"
)
// Kind describes the kind of the type (alias, array, etc.)
type Kind int
const (
AliasKind Kind = iota
ArrayKind
BasicKind
InterfaceKind
MapKind
PointerKind
SliceKind
StructKind
UnknownKind
UnsupportedKind
)
func (k *Kind) UnmarshalJSON(b []byte) error {
var s string
if err := json.Unmarshal(b, &s); err != nil {
return err
}
switch strings.ToUpper(s) {
case "ALIAS":
*k = AliasKind
case "ARRAY":
*k = ArrayKind
case "BASIC":
*k = BasicKind
case "INTERFACE":
*k = InterfaceKind
case "MAP":
*k = MapKind
case "POINTER":
*k = PointerKind
case "SLICE":
*k = SliceKind
case "STRUCT":
*k = StructKind
case "UNKNOWN":
*k = UnknownKind
default:
return fmt.Errorf("unknown kind %s", s)
}
return nil
}
func (k Kind) MarshalJSON() ([]byte, error) {
kindStr := "UNKNOWN"
switch k {
case AliasKind:
kindStr = "ALIAS"
case ArrayKind:
kindStr = "ARRAY"
case BasicKind:
kindStr = "BASIC"
case InterfaceKind:
kindStr = "INTERFACE"
case MapKind:
kindStr = "MAP"
case PointerKind:
kindStr = "POINTER"
case SliceKind:
kindStr = "SLICE"
case StructKind:
kindStr = "STRUCT"
}
return json.Marshal(kindStr)
}
// Type describes a declared type
type Type struct {
Name string `json:"name"`
Package string `json:"package"`
Doc string `json:"doc"`
GVK *schema.GroupVersionKind `json:"gvk"`
Kind Kind `json:"kind"`
Imported bool `json:"imported"`
UnderlyingType *Type `json:"underlyingType"` // for aliases, slices and pointers
KeyType *Type `json:"keyType"` // for maps
ValueType *Type `json:"valueType"` // for maps
Fields []*Field `json:"fields"` // for structs
References []*Type `json:"-"` // other types that refer to this type
}
func (t *Type) IsBasic() bool {
switch t.Kind {
case BasicKind:
return true
case SliceKind, ArrayKind, PointerKind:
return t.UnderlyingType != nil && t.UnderlyingType.IsBasic()
case MapKind:
return t.KeyType != nil && t.KeyType.IsBasic() && t.ValueType != nil && t.ValueType.IsBasic()
case InterfaceKind:
return true
default:
return false
}
}
func (t *Type) Members() []*Field {
if t == nil {
return nil
}
if len(t.Fields) > 0 {
return t.Fields
}
switch t.Kind {
case AliasKind, SliceKind, ArrayKind, PointerKind:
return t.UnderlyingType.Members()
default:
return nil
}
}
func (t *Type) String() string {
if t == nil {
return "<unknown>"
}
var sb strings.Builder
switch t.Kind {
case MapKind:
sb.WriteString("map[")
sb.WriteString(t.KeyType.String())
sb.WriteString("]")
sb.WriteString(t.ValueType.String())
return sb.String()
case ArrayKind, SliceKind:
sb.WriteString("[]")
case PointerKind:
sb.WriteString("*")
}
if t.Package != "" {
sb.WriteString(t.Package)
sb.WriteString(".")
}
sb.WriteString(t.Name)
return sb.String()
}
func (t *Type) IsAlias() bool {
return t.Kind == AliasKind
}
func (t *Type) SortedReferences() []*Type {
if t == nil || len(t.References) == 0 {
return nil
}
sort.Slice(t.References, func(i, j int) bool {
if t.References[i].Name < t.References[j].Name {
return true
}
if t.References[i].Name == t.References[j].Name {
return t.References[i].Package < t.References[j].Package
}
return false
})
return t.References
}
// Field describes a field in a struct.
type Field struct {
Name string
Embedded bool
Doc string
Type *Type
}
// Key generates the unique name for the give type.
func Key(t *Type) string {
if t.Package == "" {
return t.Name
}
return fmt.Sprintf("%s.%s", t.Package, t.Name)
}
// GroupVersionDetails encapsulates details about a discovered API group.
type GroupVersionDetails struct {
schema.GroupVersion
Doc string
Kinds []string
Types map[string]*Type
}
func (gvd GroupVersionDetails) GroupVersionString() string {
return gvd.GroupVersion.String()
}
func (gvd GroupVersionDetails) TypeForKind(k string) *Type {
return gvd.Types[k]
}
func (gvd GroupVersionDetails) SortedTypes() []*Type {
typeList := make([]*Type, len(gvd.Types))
i := 0
for _, t := range gvd.Types {
typeList[i] = t
i++
}
sort.Slice(typeList, func(i, j int) bool {
return typeList[i].Name < typeList[j].Name
})
return typeList
}
func (gvd GroupVersionDetails) SortedKinds() []string {
if len(gvd.Kinds) <= 1 {
return gvd.Kinds
}
kindsList := make([]string, len(gvd.Kinds))
copy(kindsList, gvd.Kinds)
sort.Strings(kindsList)
return kindsList
}