blob: 917bbe84ec8063bce2ae0df29db8982d56a01dd4 [file] [log] [blame]
Matthias Andreas Benkard832a54e2019-01-29 09:27:38 +01001package jsoniter
2
3import (
4 "fmt"
5 "github.com/modern-go/reflect2"
6 "reflect"
7 "sort"
8 "strings"
9 "unicode"
10 "unsafe"
11)
12
13var typeDecoders = map[string]ValDecoder{}
14var fieldDecoders = map[string]ValDecoder{}
15var typeEncoders = map[string]ValEncoder{}
16var fieldEncoders = map[string]ValEncoder{}
17var extensions = []Extension{}
18
19// StructDescriptor describe how should we encode/decode the struct
20type StructDescriptor struct {
21 Type reflect2.Type
22 Fields []*Binding
23}
24
25// GetField get one field from the descriptor by its name.
26// Can not use map here to keep field orders.
27func (structDescriptor *StructDescriptor) GetField(fieldName string) *Binding {
28 for _, binding := range structDescriptor.Fields {
29 if binding.Field.Name() == fieldName {
30 return binding
31 }
32 }
33 return nil
34}
35
36// Binding describe how should we encode/decode the struct field
37type Binding struct {
38 levels []int
39 Field reflect2.StructField
40 FromNames []string
41 ToNames []string
42 Encoder ValEncoder
43 Decoder ValDecoder
44}
45
46// Extension the one for all SPI. Customize encoding/decoding by specifying alternate encoder/decoder.
47// Can also rename fields by UpdateStructDescriptor.
48type Extension interface {
49 UpdateStructDescriptor(structDescriptor *StructDescriptor)
50 CreateMapKeyDecoder(typ reflect2.Type) ValDecoder
51 CreateMapKeyEncoder(typ reflect2.Type) ValEncoder
52 CreateDecoder(typ reflect2.Type) ValDecoder
53 CreateEncoder(typ reflect2.Type) ValEncoder
54 DecorateDecoder(typ reflect2.Type, decoder ValDecoder) ValDecoder
55 DecorateEncoder(typ reflect2.Type, encoder ValEncoder) ValEncoder
56}
57
58// DummyExtension embed this type get dummy implementation for all methods of Extension
59type DummyExtension struct {
60}
61
62// UpdateStructDescriptor No-op
63func (extension *DummyExtension) UpdateStructDescriptor(structDescriptor *StructDescriptor) {
64}
65
66// CreateMapKeyDecoder No-op
67func (extension *DummyExtension) CreateMapKeyDecoder(typ reflect2.Type) ValDecoder {
68 return nil
69}
70
71// CreateMapKeyEncoder No-op
72func (extension *DummyExtension) CreateMapKeyEncoder(typ reflect2.Type) ValEncoder {
73 return nil
74}
75
76// CreateDecoder No-op
77func (extension *DummyExtension) CreateDecoder(typ reflect2.Type) ValDecoder {
78 return nil
79}
80
81// CreateEncoder No-op
82func (extension *DummyExtension) CreateEncoder(typ reflect2.Type) ValEncoder {
83 return nil
84}
85
86// DecorateDecoder No-op
87func (extension *DummyExtension) DecorateDecoder(typ reflect2.Type, decoder ValDecoder) ValDecoder {
88 return decoder
89}
90
91// DecorateEncoder No-op
92func (extension *DummyExtension) DecorateEncoder(typ reflect2.Type, encoder ValEncoder) ValEncoder {
93 return encoder
94}
95
96type EncoderExtension map[reflect2.Type]ValEncoder
97
98// UpdateStructDescriptor No-op
99func (extension EncoderExtension) UpdateStructDescriptor(structDescriptor *StructDescriptor) {
100}
101
102// CreateDecoder No-op
103func (extension EncoderExtension) CreateDecoder(typ reflect2.Type) ValDecoder {
104 return nil
105}
106
107// CreateEncoder get encoder from map
108func (extension EncoderExtension) CreateEncoder(typ reflect2.Type) ValEncoder {
109 return extension[typ]
110}
111
112// CreateMapKeyDecoder No-op
113func (extension EncoderExtension) CreateMapKeyDecoder(typ reflect2.Type) ValDecoder {
114 return nil
115}
116
117// CreateMapKeyEncoder No-op
118func (extension EncoderExtension) CreateMapKeyEncoder(typ reflect2.Type) ValEncoder {
119 return nil
120}
121
122// DecorateDecoder No-op
123func (extension EncoderExtension) DecorateDecoder(typ reflect2.Type, decoder ValDecoder) ValDecoder {
124 return decoder
125}
126
127// DecorateEncoder No-op
128func (extension EncoderExtension) DecorateEncoder(typ reflect2.Type, encoder ValEncoder) ValEncoder {
129 return encoder
130}
131
132type DecoderExtension map[reflect2.Type]ValDecoder
133
134// UpdateStructDescriptor No-op
135func (extension DecoderExtension) UpdateStructDescriptor(structDescriptor *StructDescriptor) {
136}
137
138// CreateMapKeyDecoder No-op
139func (extension DecoderExtension) CreateMapKeyDecoder(typ reflect2.Type) ValDecoder {
140 return nil
141}
142
143// CreateMapKeyEncoder No-op
144func (extension DecoderExtension) CreateMapKeyEncoder(typ reflect2.Type) ValEncoder {
145 return nil
146}
147
148// CreateDecoder get decoder from map
149func (extension DecoderExtension) CreateDecoder(typ reflect2.Type) ValDecoder {
150 return extension[typ]
151}
152
153// CreateEncoder No-op
154func (extension DecoderExtension) CreateEncoder(typ reflect2.Type) ValEncoder {
155 return nil
156}
157
158// DecorateDecoder No-op
159func (extension DecoderExtension) DecorateDecoder(typ reflect2.Type, decoder ValDecoder) ValDecoder {
160 return decoder
161}
162
163// DecorateEncoder No-op
164func (extension DecoderExtension) DecorateEncoder(typ reflect2.Type, encoder ValEncoder) ValEncoder {
165 return encoder
166}
167
168type funcDecoder struct {
169 fun DecoderFunc
170}
171
172func (decoder *funcDecoder) Decode(ptr unsafe.Pointer, iter *Iterator) {
173 decoder.fun(ptr, iter)
174}
175
176type funcEncoder struct {
177 fun EncoderFunc
178 isEmptyFunc func(ptr unsafe.Pointer) bool
179}
180
181func (encoder *funcEncoder) Encode(ptr unsafe.Pointer, stream *Stream) {
182 encoder.fun(ptr, stream)
183}
184
185func (encoder *funcEncoder) IsEmpty(ptr unsafe.Pointer) bool {
186 if encoder.isEmptyFunc == nil {
187 return false
188 }
189 return encoder.isEmptyFunc(ptr)
190}
191
192// DecoderFunc the function form of TypeDecoder
193type DecoderFunc func(ptr unsafe.Pointer, iter *Iterator)
194
195// EncoderFunc the function form of TypeEncoder
196type EncoderFunc func(ptr unsafe.Pointer, stream *Stream)
197
198// RegisterTypeDecoderFunc register TypeDecoder for a type with function
199func RegisterTypeDecoderFunc(typ string, fun DecoderFunc) {
200 typeDecoders[typ] = &funcDecoder{fun}
201}
202
203// RegisterTypeDecoder register TypeDecoder for a typ
204func RegisterTypeDecoder(typ string, decoder ValDecoder) {
205 typeDecoders[typ] = decoder
206}
207
208// RegisterFieldDecoderFunc register TypeDecoder for a struct field with function
209func RegisterFieldDecoderFunc(typ string, field string, fun DecoderFunc) {
210 RegisterFieldDecoder(typ, field, &funcDecoder{fun})
211}
212
213// RegisterFieldDecoder register TypeDecoder for a struct field
214func RegisterFieldDecoder(typ string, field string, decoder ValDecoder) {
215 fieldDecoders[fmt.Sprintf("%s/%s", typ, field)] = decoder
216}
217
218// RegisterTypeEncoderFunc register TypeEncoder for a type with encode/isEmpty function
219func RegisterTypeEncoderFunc(typ string, fun EncoderFunc, isEmptyFunc func(unsafe.Pointer) bool) {
220 typeEncoders[typ] = &funcEncoder{fun, isEmptyFunc}
221}
222
223// RegisterTypeEncoder register TypeEncoder for a type
224func RegisterTypeEncoder(typ string, encoder ValEncoder) {
225 typeEncoders[typ] = encoder
226}
227
228// RegisterFieldEncoderFunc register TypeEncoder for a struct field with encode/isEmpty function
229func RegisterFieldEncoderFunc(typ string, field string, fun EncoderFunc, isEmptyFunc func(unsafe.Pointer) bool) {
230 RegisterFieldEncoder(typ, field, &funcEncoder{fun, isEmptyFunc})
231}
232
233// RegisterFieldEncoder register TypeEncoder for a struct field
234func RegisterFieldEncoder(typ string, field string, encoder ValEncoder) {
235 fieldEncoders[fmt.Sprintf("%s/%s", typ, field)] = encoder
236}
237
238// RegisterExtension register extension
239func RegisterExtension(extension Extension) {
240 extensions = append(extensions, extension)
241}
242
243func getTypeDecoderFromExtension(ctx *ctx, typ reflect2.Type) ValDecoder {
244 decoder := _getTypeDecoderFromExtension(ctx, typ)
245 if decoder != nil {
246 for _, extension := range extensions {
247 decoder = extension.DecorateDecoder(typ, decoder)
248 }
249 for _, extension := range ctx.extensions {
250 decoder = extension.DecorateDecoder(typ, decoder)
251 }
252 }
253 return decoder
254}
255func _getTypeDecoderFromExtension(ctx *ctx, typ reflect2.Type) ValDecoder {
256 for _, extension := range extensions {
257 decoder := extension.CreateDecoder(typ)
258 if decoder != nil {
259 return decoder
260 }
261 }
262 for _, extension := range ctx.extensions {
263 decoder := extension.CreateDecoder(typ)
264 if decoder != nil {
265 return decoder
266 }
267 }
268 typeName := typ.String()
269 decoder := typeDecoders[typeName]
270 if decoder != nil {
271 return decoder
272 }
273 if typ.Kind() == reflect.Ptr {
274 ptrType := typ.(*reflect2.UnsafePtrType)
275 decoder := typeDecoders[ptrType.Elem().String()]
276 if decoder != nil {
277 return &OptionalDecoder{ptrType.Elem(), decoder}
278 }
279 }
280 return nil
281}
282
283func getTypeEncoderFromExtension(ctx *ctx, typ reflect2.Type) ValEncoder {
284 encoder := _getTypeEncoderFromExtension(ctx, typ)
285 if encoder != nil {
286 for _, extension := range extensions {
287 encoder = extension.DecorateEncoder(typ, encoder)
288 }
289 for _, extension := range ctx.extensions {
290 encoder = extension.DecorateEncoder(typ, encoder)
291 }
292 }
293 return encoder
294}
295
296func _getTypeEncoderFromExtension(ctx *ctx, typ reflect2.Type) ValEncoder {
297 for _, extension := range extensions {
298 encoder := extension.CreateEncoder(typ)
299 if encoder != nil {
300 return encoder
301 }
302 }
303 for _, extension := range ctx.extensions {
304 encoder := extension.CreateEncoder(typ)
305 if encoder != nil {
306 return encoder
307 }
308 }
309 typeName := typ.String()
310 encoder := typeEncoders[typeName]
311 if encoder != nil {
312 return encoder
313 }
314 if typ.Kind() == reflect.Ptr {
315 typePtr := typ.(*reflect2.UnsafePtrType)
316 encoder := typeEncoders[typePtr.Elem().String()]
317 if encoder != nil {
318 return &OptionalEncoder{encoder}
319 }
320 }
321 return nil
322}
323
324func describeStruct(ctx *ctx, typ reflect2.Type) *StructDescriptor {
325 structType := typ.(*reflect2.UnsafeStructType)
326 embeddedBindings := []*Binding{}
327 bindings := []*Binding{}
328 for i := 0; i < structType.NumField(); i++ {
329 field := structType.Field(i)
330 tag, hastag := field.Tag().Lookup(ctx.getTagKey())
331 if ctx.onlyTaggedField && !hastag {
332 continue
333 }
334 tagParts := strings.Split(tag, ",")
335 if tag == "-" {
336 continue
337 }
338 if field.Anonymous() && (tag == "" || tagParts[0] == "") {
339 if field.Type().Kind() == reflect.Struct {
340 structDescriptor := describeStruct(ctx, field.Type())
341 for _, binding := range structDescriptor.Fields {
342 binding.levels = append([]int{i}, binding.levels...)
343 omitempty := binding.Encoder.(*structFieldEncoder).omitempty
344 binding.Encoder = &structFieldEncoder{field, binding.Encoder, omitempty}
345 binding.Decoder = &structFieldDecoder{field, binding.Decoder}
346 embeddedBindings = append(embeddedBindings, binding)
347 }
348 continue
349 } else if field.Type().Kind() == reflect.Ptr {
350 ptrType := field.Type().(*reflect2.UnsafePtrType)
351 if ptrType.Elem().Kind() == reflect.Struct {
352 structDescriptor := describeStruct(ctx, ptrType.Elem())
353 for _, binding := range structDescriptor.Fields {
354 binding.levels = append([]int{i}, binding.levels...)
355 omitempty := binding.Encoder.(*structFieldEncoder).omitempty
356 binding.Encoder = &dereferenceEncoder{binding.Encoder}
357 binding.Encoder = &structFieldEncoder{field, binding.Encoder, omitempty}
358 binding.Decoder = &dereferenceDecoder{ptrType.Elem(), binding.Decoder}
359 binding.Decoder = &structFieldDecoder{field, binding.Decoder}
360 embeddedBindings = append(embeddedBindings, binding)
361 }
362 continue
363 }
364 }
365 }
366 fieldNames := calcFieldNames(field.Name(), tagParts[0], tag)
367 fieldCacheKey := fmt.Sprintf("%s/%s", typ.String(), field.Name())
368 decoder := fieldDecoders[fieldCacheKey]
369 if decoder == nil {
370 decoder = decoderOfType(ctx.append(field.Name()), field.Type())
371 }
372 encoder := fieldEncoders[fieldCacheKey]
373 if encoder == nil {
374 encoder = encoderOfType(ctx.append(field.Name()), field.Type())
375 }
376 binding := &Binding{
377 Field: field,
378 FromNames: fieldNames,
379 ToNames: fieldNames,
380 Decoder: decoder,
381 Encoder: encoder,
382 }
383 binding.levels = []int{i}
384 bindings = append(bindings, binding)
385 }
386 return createStructDescriptor(ctx, typ, bindings, embeddedBindings)
387}
388func createStructDescriptor(ctx *ctx, typ reflect2.Type, bindings []*Binding, embeddedBindings []*Binding) *StructDescriptor {
389 structDescriptor := &StructDescriptor{
390 Type: typ,
391 Fields: bindings,
392 }
393 for _, extension := range extensions {
394 extension.UpdateStructDescriptor(structDescriptor)
395 }
396 for _, extension := range ctx.extensions {
397 extension.UpdateStructDescriptor(structDescriptor)
398 }
399 processTags(structDescriptor, ctx.frozenConfig)
400 // merge normal & embedded bindings & sort with original order
401 allBindings := sortableBindings(append(embeddedBindings, structDescriptor.Fields...))
402 sort.Sort(allBindings)
403 structDescriptor.Fields = allBindings
404 return structDescriptor
405}
406
407type sortableBindings []*Binding
408
409func (bindings sortableBindings) Len() int {
410 return len(bindings)
411}
412
413func (bindings sortableBindings) Less(i, j int) bool {
414 left := bindings[i].levels
415 right := bindings[j].levels
416 k := 0
417 for {
418 if left[k] < right[k] {
419 return true
420 } else if left[k] > right[k] {
421 return false
422 }
423 k++
424 }
425}
426
427func (bindings sortableBindings) Swap(i, j int) {
428 bindings[i], bindings[j] = bindings[j], bindings[i]
429}
430
431func processTags(structDescriptor *StructDescriptor, cfg *frozenConfig) {
432 for _, binding := range structDescriptor.Fields {
433 shouldOmitEmpty := false
434 tagParts := strings.Split(binding.Field.Tag().Get(cfg.getTagKey()), ",")
435 for _, tagPart := range tagParts[1:] {
436 if tagPart == "omitempty" {
437 shouldOmitEmpty = true
438 } else if tagPart == "string" {
439 if binding.Field.Type().Kind() == reflect.String {
440 binding.Decoder = &stringModeStringDecoder{binding.Decoder, cfg}
441 binding.Encoder = &stringModeStringEncoder{binding.Encoder, cfg}
442 } else {
443 binding.Decoder = &stringModeNumberDecoder{binding.Decoder}
444 binding.Encoder = &stringModeNumberEncoder{binding.Encoder}
445 }
446 }
447 }
448 binding.Decoder = &structFieldDecoder{binding.Field, binding.Decoder}
449 binding.Encoder = &structFieldEncoder{binding.Field, binding.Encoder, shouldOmitEmpty}
450 }
451}
452
453func calcFieldNames(originalFieldName string, tagProvidedFieldName string, wholeTag string) []string {
454 // ignore?
455 if wholeTag == "-" {
456 return []string{}
457 }
458 // rename?
459 var fieldNames []string
460 if tagProvidedFieldName == "" {
461 fieldNames = []string{originalFieldName}
462 } else {
463 fieldNames = []string{tagProvidedFieldName}
464 }
465 // private?
466 isNotExported := unicode.IsLower(rune(originalFieldName[0]))
467 if isNotExported {
468 fieldNames = []string{}
469 }
470 return fieldNames
471}