1
// Copyright (c) 2012-2020 Ugorji Nwoke. All rights reserved.
2
// Use of this source code is governed by a MIT license found in the LICENSE file.
20
// each lasts for 4 (ie n, n+1, n+2, n+3)
26
// containers: each lasts for 4 (ie n, n+1, n+2, ... n+7)
28
simpleVdByteArray = 224
34
var simpledescNames = map[byte]string{
36
simpleVdFalse: "false",
38
simpleVdFloat32: "float32",
39
simpleVdFloat64: "float64",
41
simpleVdPosInt: "+int",
42
simpleVdNegInt: "-int",
46
simpleVdString: "string",
47
simpleVdByteArray: "binary",
48
simpleVdArray: "array",
53
func simpledesc(bd byte) (s string) {
54
s = simpledescNames[bd]
61
type simpleEncDriver struct {
63
encDriverNoopContainerWriter
70
func (e *simpleEncDriver) encoder() *Encoder {
74
func (e *simpleEncDriver) EncodeNil() {
75
e.e.encWr.writen1(simpleVdNil)
78
func (e *simpleEncDriver) EncodeBool(b bool) {
79
if e.h.EncZeroValuesAsNil && e.e.c != containerMapKey && !b {
84
e.e.encWr.writen1(simpleVdTrue)
86
e.e.encWr.writen1(simpleVdFalse)
90
func (e *simpleEncDriver) EncodeFloat32(f float32) {
91
if e.h.EncZeroValuesAsNil && e.e.c != containerMapKey && f == 0.0 {
95
e.e.encWr.writen1(simpleVdFloat32)
96
bigen.writeUint32(e.e.w(), math.Float32bits(f))
99
func (e *simpleEncDriver) EncodeFloat64(f float64) {
100
if e.h.EncZeroValuesAsNil && e.e.c != containerMapKey && f == 0.0 {
104
e.e.encWr.writen1(simpleVdFloat64)
105
bigen.writeUint64(e.e.w(), math.Float64bits(f))
108
func (e *simpleEncDriver) EncodeInt(v int64) {
110
e.encUint(uint64(-v), simpleVdNegInt)
112
e.encUint(uint64(v), simpleVdPosInt)
116
func (e *simpleEncDriver) EncodeUint(v uint64) {
117
e.encUint(v, simpleVdPosInt)
120
func (e *simpleEncDriver) encUint(v uint64, bd uint8) {
121
if e.h.EncZeroValuesAsNil && e.e.c != containerMapKey && v == 0 {
125
if v <= math.MaxUint8 {
126
e.e.encWr.writen2(bd, uint8(v))
127
} else if v <= math.MaxUint16 {
128
e.e.encWr.writen1(bd + 1)
129
bigen.writeUint16(e.e.w(), uint16(v))
130
} else if v <= math.MaxUint32 {
131
e.e.encWr.writen1(bd + 2)
132
bigen.writeUint32(e.e.w(), uint32(v))
133
} else { // if v <= math.MaxUint64 {
134
e.e.encWr.writen1(bd + 3)
135
bigen.writeUint64(e.e.w(), v)
139
func (e *simpleEncDriver) encLen(bd byte, length int) {
141
e.e.encWr.writen1(bd)
142
} else if length <= math.MaxUint8 {
143
e.e.encWr.writen1(bd + 1)
144
e.e.encWr.writen1(uint8(length))
145
} else if length <= math.MaxUint16 {
146
e.e.encWr.writen1(bd + 2)
147
bigen.writeUint16(e.e.w(), uint16(length))
148
} else if int64(length) <= math.MaxUint32 {
149
e.e.encWr.writen1(bd + 3)
150
bigen.writeUint32(e.e.w(), uint32(length))
152
e.e.encWr.writen1(bd + 4)
153
bigen.writeUint64(e.e.w(), uint64(length))
157
func (e *simpleEncDriver) EncodeExt(v interface{}, basetype reflect.Type, xtag uint64, ext Ext) {
160
bs0 = e.e.blist.get(1024)
162
e.e.sideEncode(v, basetype, &bs)
170
e.encodeExtPreamble(uint8(xtag), len(bs))
175
if !byteSliceSameData(bs0, bs) {
181
func (e *simpleEncDriver) EncodeRawExt(re *RawExt) {
182
e.encodeExtPreamble(uint8(re.Tag), len(re.Data))
183
e.e.encWr.writeb(re.Data)
186
func (e *simpleEncDriver) encodeExtPreamble(xtag byte, length int) {
187
e.encLen(simpleVdExt, length)
188
e.e.encWr.writen1(xtag)
191
func (e *simpleEncDriver) WriteArrayStart(length int) {
192
e.encLen(simpleVdArray, length)
195
func (e *simpleEncDriver) WriteMapStart(length int) {
196
e.encLen(simpleVdMap, length)
199
func (e *simpleEncDriver) EncodeString(v string) {
200
if e.h.EncZeroValuesAsNil && e.e.c != containerMapKey && v == "" {
205
e.encLen(simpleVdByteArray, len(v))
207
e.encLen(simpleVdString, len(v))
209
e.e.encWr.writestr(v)
212
func (e *simpleEncDriver) EncodeStringBytesRaw(v []byte) {
213
// if e.h.EncZeroValuesAsNil && e.c != containerMapKey && v == nil {
218
e.encLen(simpleVdByteArray, len(v))
222
func (e *simpleEncDriver) EncodeTime(t time.Time) {
223
// if e.h.EncZeroValuesAsNil && e.c != containerMapKey && t.IsZero() {
228
v, err := t.MarshalBinary()
230
e.e.encWr.writen2(simpleVdTime, uint8(len(v)))
234
//------------------------------------
236
type simpleDecDriver struct {
241
decDriverNoopContainerReader
242
decDriverNoopNumberHelper
246
func (d *simpleDecDriver) decoder() *Decoder {
250
func (d *simpleDecDriver) descBd() string {
251
return sprintf("%v (%s)", d.bd, simpledesc(d.bd))
254
func (d *simpleDecDriver) readNextBd() {
255
d.bd = d.d.decRd.readn1()
259
func (d *simpleDecDriver) advanceNil() (null bool) {
263
if d.bd == simpleVdNil {
265
return true // null = true
270
func (d *simpleDecDriver) ContainerType() (vt valueType) {
278
case simpleVdByteArray, simpleVdByteArray + 1,
279
simpleVdByteArray + 2, simpleVdByteArray + 3, simpleVdByteArray + 4:
280
return valueTypeBytes
281
case simpleVdString, simpleVdString + 1,
282
simpleVdString + 2, simpleVdString + 3, simpleVdString + 4:
283
return valueTypeString
284
case simpleVdArray, simpleVdArray + 1,
285
simpleVdArray + 2, simpleVdArray + 3, simpleVdArray + 4:
286
return valueTypeArray
287
case simpleVdMap, simpleVdMap + 1,
288
simpleVdMap + 2, simpleVdMap + 3, simpleVdMap + 4:
291
return valueTypeUnset
294
func (d *simpleDecDriver) TryNil() bool {
295
return d.advanceNil()
298
func (d *simpleDecDriver) decFloat() (f float64, ok bool) {
301
case simpleVdFloat32:
302
f = float64(math.Float32frombits(bigen.Uint32(d.d.decRd.readn4())))
303
case simpleVdFloat64:
304
f = math.Float64frombits(bigen.Uint64(d.d.decRd.readn8()))
311
func (d *simpleDecDriver) decInteger() (ui uint64, neg, ok bool) {
315
ui = uint64(d.d.decRd.readn1())
316
case simpleVdPosInt + 1:
317
ui = uint64(bigen.Uint16(d.d.decRd.readn2()))
318
case simpleVdPosInt + 2:
319
ui = uint64(bigen.Uint32(d.d.decRd.readn4()))
320
case simpleVdPosInt + 3:
321
ui = uint64(bigen.Uint64(d.d.decRd.readn8()))
323
ui = uint64(d.d.decRd.readn1())
325
case simpleVdNegInt + 1:
326
ui = uint64(bigen.Uint16(d.d.decRd.readn2()))
328
case simpleVdNegInt + 2:
329
ui = uint64(bigen.Uint32(d.d.decRd.readn4()))
331
case simpleVdNegInt + 3:
332
ui = uint64(bigen.Uint64(d.d.decRd.readn8()))
336
// d.d.errorf("integer only valid from pos/neg integer1..8. Invalid descriptor: %v", d.bd)
338
// DO NOT do this check below, because callers may only want the unsigned value:
340
// if ui > math.MaxInt64 {
341
// d.d.errorf("decIntAny: Integer out of range for signed int64: %v", ui)
347
func (d *simpleDecDriver) DecodeInt64() (i int64) {
351
i = decNegintPosintFloatNumberHelper{&d.d}.int64(d.decInteger())
356
func (d *simpleDecDriver) DecodeUint64() (ui uint64) {
360
ui = decNegintPosintFloatNumberHelper{&d.d}.uint64(d.decInteger())
365
func (d *simpleDecDriver) DecodeFloat64() (f float64) {
369
f = decNegintPosintFloatNumberHelper{&d.d}.float64(d.decFloat())
374
// bool can be decoded from bool only (single byte).
375
func (d *simpleDecDriver) DecodeBool() (b bool) {
379
if d.bd == simpleVdFalse {
380
} else if d.bd == simpleVdTrue {
383
d.d.errorf("cannot decode bool - %s: %x", msgBadDesc, d.bd)
389
func (d *simpleDecDriver) ReadMapStart() (length int) {
391
return containerLenNil
397
func (d *simpleDecDriver) ReadArrayStart() (length int) {
399
return containerLenNil
405
func (d *simpleDecDriver) uint2Len(ui uint64) int {
406
if chkOvf.Uint(ui, intBitsize) {
407
d.d.errorf("overflow integer: %v", ui)
412
func (d *simpleDecDriver) decLen() int {
413
switch d.bd & 7 { // d.bd % 8 {
417
return int(d.d.decRd.readn1())
419
return int(bigen.Uint16(d.d.decRd.readn2()))
421
return d.uint2Len(uint64(bigen.Uint32(d.d.decRd.readn4())))
423
return d.uint2Len(bigen.Uint64(d.d.decRd.readn8()))
425
d.d.errorf("cannot read length: bd%%8 must be in range 0..4. Got: %d", d.bd%8)
429
func (d *simpleDecDriver) DecodeStringAsBytes() (s []byte) {
430
return d.DecodeBytes(nil)
433
func (d *simpleDecDriver) DecodeBytes(bs []byte) (bsOut []byte) {
434
d.d.decByteState = decByteStateNone
438
// check if an "array" of uint8's (see ContainerType for how to infer if an array)
439
if d.bd >= simpleVdArray && d.bd <= simpleVdMap+4 {
441
d.d.decByteState = decByteStateReuseBuf
444
slen := d.ReadArrayStart()
446
if bs, changed = usableByteSlice(bs, slen); changed {
447
d.d.decByteState = decByteStateNone
449
for i := 0; i < len(bs); i++ {
450
bs[i] = uint8(chkOvf.UintV(d.DecodeUint64(), 8))
452
for i := len(bs); i < slen; i++ {
453
bs = append(bs, uint8(chkOvf.UintV(d.DecodeUint64(), 8)))
461
d.d.decByteState = decByteStateZerocopy
462
return d.d.decRd.rb.readx(uint(clen))
465
d.d.decByteState = decByteStateReuseBuf
468
return decByteSlice(d.d.r(), clen, d.d.h.MaxInitLen, bs)
471
func (d *simpleDecDriver) DecodeTime() (t time.Time) {
475
if d.bd != simpleVdTime {
476
d.d.errorf("invalid descriptor for time.Time - expect 0x%x, received 0x%x", simpleVdTime, d.bd)
479
clen := uint(d.d.decRd.readn1())
480
b := d.d.decRd.readx(clen)
481
d.d.onerror((&t).UnmarshalBinary(b))
485
func (d *simpleDecDriver) DecodeExt(rv interface{}, basetype reflect.Type, xtag uint64, ext Ext) {
487
d.d.errorf("ext: tag must be <= 0xff; got: %v", xtag)
492
xbs, realxtag1, zerocopy := d.decodeExtV(ext != nil, uint8(xtag))
493
realxtag := uint64(realxtag1)
497
re.setData(xbs, zerocopy)
498
} else if ext == SelfExt {
499
d.d.sideDecode(rv, basetype, xbs)
505
func (d *simpleDecDriver) decodeExtV(verifyTag bool, tag byte) (xbs []byte, xtag byte, zerocopy bool) {
507
case simpleVdExt, simpleVdExt + 1, simpleVdExt + 2, simpleVdExt + 3, simpleVdExt + 4:
509
xtag = d.d.decRd.readn1()
510
if verifyTag && xtag != tag {
511
d.d.errorf("wrong extension tag. Got %b. Expecting: %v", xtag, tag)
514
xbs = d.d.decRd.rb.readx(uint(l))
517
xbs = decByteSlice(d.d.r(), l, d.d.h.MaxInitLen, d.d.b[:])
519
case simpleVdByteArray, simpleVdByteArray + 1,
520
simpleVdByteArray + 2, simpleVdByteArray + 3, simpleVdByteArray + 4:
521
xbs = d.DecodeBytes(nil)
523
d.d.errorf("ext - %s - expecting extensions/bytearray, got: 0x%x", msgBadDesc, d.bd)
529
func (d *simpleDecDriver) DecodeNaked() {
535
var decodeFurther bool
546
case simpleVdPosInt, simpleVdPosInt + 1, simpleVdPosInt + 2, simpleVdPosInt + 3:
547
if d.h.SignedInteger {
549
n.i = d.DecodeInt64()
552
n.u = d.DecodeUint64()
554
case simpleVdNegInt, simpleVdNegInt + 1, simpleVdNegInt + 2, simpleVdNegInt + 3:
556
n.i = d.DecodeInt64()
557
case simpleVdFloat32:
559
n.f = d.DecodeFloat64()
560
case simpleVdFloat64:
562
n.f = d.DecodeFloat64()
566
case simpleVdString, simpleVdString + 1,
567
simpleVdString + 2, simpleVdString + 3, simpleVdString + 4:
568
n.v = valueTypeString
569
n.s = d.d.stringZC(d.DecodeStringAsBytes())
570
case simpleVdByteArray, simpleVdByteArray + 1,
571
simpleVdByteArray + 2, simpleVdByteArray + 3, simpleVdByteArray + 4:
572
d.d.fauxUnionReadRawBytes(false)
573
case simpleVdExt, simpleVdExt + 1, simpleVdExt + 2, simpleVdExt + 3, simpleVdExt + 4:
576
n.u = uint64(d.d.decRd.readn1())
578
n.l = d.d.decRd.rb.readx(uint(l))
580
n.l = decByteSlice(d.d.r(), l, d.d.h.MaxInitLen, d.d.b[:])
582
case simpleVdArray, simpleVdArray + 1, simpleVdArray + 2,
583
simpleVdArray + 3, simpleVdArray + 4:
586
case simpleVdMap, simpleVdMap + 1, simpleVdMap + 2, simpleVdMap + 3, simpleVdMap + 4:
590
d.d.errorf("cannot infer value - %s 0x%x", msgBadDesc, d.bd)
598
func (d *simpleDecDriver) nextValueBytes(v0 []byte) (v []byte) {
603
var h = decNextValueBytesHelper{d: &d.d}
604
var cursor = d.d.rb.c - 1
606
v = d.nextValueBytesBdReadR(v)
608
h.bytesRdV(&v, cursor)
612
func (d *simpleDecDriver) nextValueBytesR(v0 []byte) (v []byte) {
615
var h = decNextValueBytesHelper{d: &d.d}
617
return d.nextValueBytesBdReadR(v)
620
func (d *simpleDecDriver) nextValueBytesBdReadR(v0 []byte) (v []byte) {
622
var h = decNextValueBytesHelper{d: &d.d}
629
case simpleVdNil, simpleVdFalse, simpleVdTrue, simpleVdString, simpleVdByteArray:
631
case simpleVdPosInt, simpleVdNegInt:
632
h.append1(&v, d.d.decRd.readn1())
633
case simpleVdPosInt + 1, simpleVdNegInt + 1:
634
h.appendN(&v, d.d.decRd.readx(2)...)
635
case simpleVdPosInt + 2, simpleVdNegInt + 2, simpleVdFloat32:
636
h.appendN(&v, d.d.decRd.readx(4)...)
637
case simpleVdPosInt + 3, simpleVdNegInt + 3, simpleVdFloat64:
638
h.appendN(&v, d.d.decRd.readx(8)...)
640
c = d.d.decRd.readn1()
642
h.appendN(&v, d.d.decRd.readx(uint(c))...)
645
switch c & 7 { // c % 8 {
649
b := d.d.decRd.readn1()
653
x := d.d.decRd.readn2()
654
length = uint(bigen.Uint16(x))
655
h.appendN(&v, x[:]...)
657
x := d.d.decRd.readn4()
658
length = uint(bigen.Uint32(x))
659
h.appendN(&v, x[:]...)
661
x := d.d.decRd.readn8()
662
length = uint(bigen.Uint64(x))
663
h.appendN(&v, x[:]...)
666
bExt := c >= simpleVdExt && c <= simpleVdExt+7
667
bStr := c >= simpleVdString && c <= simpleVdString+7
668
bByteArray := c >= simpleVdByteArray && c <= simpleVdByteArray+7
669
bArray := c >= simpleVdArray && c <= simpleVdArray+7
670
bMap := c >= simpleVdMap && c <= simpleVdMap+7
672
if !(bExt || bStr || bByteArray || bArray || bMap) {
673
d.d.errorf("cannot infer value - %s 0x%x", msgBadDesc, c)
677
h.append1(&v, d.d.decRd.readn1()) // tag
685
for i := uint(0); i < length; i++ {
686
v = d.nextValueBytesR(v)
689
for i := uint(0); i < length; i++ {
690
v = d.nextValueBytesR(v)
691
v = d.nextValueBytesR(v)
694
h.appendN(&v, d.d.decRd.readx(length)...)
700
//------------------------------------
702
// SimpleHandle is a Handle for a very simple encoding format.
704
// simple is a simplistic codec similar to binc, but not as compact.
705
// - Encoding of a value is always preceded by the descriptor byte (bd)
706
// - True, false, nil are encoded fully in 1 byte (the descriptor)
707
// - Integers (intXXX, uintXXX) are encoded in 1, 2, 4 or 8 bytes (plus a descriptor byte).
708
// There are positive (uintXXX and intXXX >= 0) and negative (intXXX < 0) integers.
709
// - Floats are encoded in 4 or 8 bytes (plus a descriptor byte)
710
// - Length of containers (strings, bytes, array, map, extensions)
711
// are encoded in 0, 1, 2, 4 or 8 bytes.
712
// Zero-length containers have no length encoded.
713
// For others, the number of bytes is given by pow(2, bd%3)
714
// - maps are encoded as [bd] [length] [[key][value]]...
715
// - arrays are encoded as [bd] [length] [value]...
716
// - extensions are encoded as [bd] [length] [tag] [byte]...
717
// - strings/bytearrays are encoded as [bd] [length] [byte]...
718
// - time.Time are encoded as [bd] [length] [byte]...
720
// The full spec will be published soon.
721
type SimpleHandle struct {
724
// EncZeroValuesAsNil says to encode zero values for numbers, bool, string, etc as nil
725
EncZeroValuesAsNil bool
728
// Name returns the name of the handle: simple
729
func (h *SimpleHandle) Name() string { return "simple" }
731
func (h *SimpleHandle) desc(bd byte) string { return simpledesc(bd) }
733
func (h *SimpleHandle) newEncDriver() encDriver {
734
var e = &simpleEncDriver{h: h}
741
func (h *SimpleHandle) newDecDriver() decDriver {
742
d := &simpleDecDriver{h: h}
749
var _ decDriver = (*simpleDecDriver)(nil)
750
var _ encDriver = (*simpleEncDriver)(nil)