~niemeyer/strepr/trunk

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
// Package strepr is an implementation of the strepr stable representation algorithm.
//
// For details on strepr, see the specification at:
//
//     http://blog.labix.org/2013/06/25/strepr-v1
//
package strepr

import (
	"bytes"
	"fmt"
	"io"
	"math"
	"reflect"
	"sort"
)

// Encoder streams the strepr stable representation for provided values
// into an io.Writer.
type Encoder struct {
	w io.Writer
	b [148]byte
}

// NewEncoder returns a new strepr encoder for writing the stable
// representation for provided values into w.
func NewEncoder(w io.Writer) *Encoder {
	return &Encoder{w: w}
}

// Encode serializes v's stable representation into e's writer.
func (e *Encoder) Encode(v interface{}) error {
	var err error
	var kind byte
	var uval uint64
	switch v := v.(type) {
	case nil:
		_, err = e.w.Write([]byte{'z'})
	case bool:
		if v {
			_, err = e.w.Write([]byte{'t'})
		} else {
			_, err = e.w.Write([]byte{'f'})
		}
	case string:
		err = e.varint('s', uint64(len(v)))
		if err == nil {
			_, err = e.w.Write([]byte(v))
		}
	case []byte:
		err = e.varint('s', uint64(len(v)))
		if err == nil {
			_, err = e.w.Write(v)
		}
	case int:
		if v < 0 {
			kind = 'n'
			uval = uint64(-v)
		} else {
			kind = 'p'
			uval = uint64(v)
		}
	case int8:
		if v < 0 {
			kind = 'n'
			uval = uint64(-v)
		} else {
			kind = 'p'
			uval = uint64(v)
		}
	case int16:
		if v < 0 {
			kind = 'n'
			uval = uint64(-v)
		} else {
			kind = 'p'
			uval = uint64(v)
		}
	case int32:
		if v < 0 {
			kind = 'n'
			uval = uint64(-v)
		} else {
			kind = 'p'
			uval = uint64(v)
		}
	case int64:
		if v < 0 {
			kind = 'n'
			uval = uint64(-v)
		} else {
			kind = 'p'
			uval = uint64(v)
		}
	case uint:
		kind = 'p'
		uval = uint64(v)
	case uint8:
		kind = 'p'
		uval = uint64(v)
	case uint16:
		kind = 'p'
		uval = uint64(v)
	case uint32:
		kind = 'p'
		uval = uint64(v)
	case uint64:
		kind = 'p'
		uval = uint64(v)
	case float32:
		err = e.float(float64(v))
	case float64:
		err = e.float(v)
	default:
		// Maps and slices may have keys and values with any of the above types.
		rv := reflect.ValueOf(v)
		switch rv.Kind() {
		case reflect.Array:
			if rv.Type().Elem() == byteType {
				return fmt.Errorf("byte arrays are not supported at this time")
			}
			return e.list(rv)
		case reflect.Slice:
			return e.list(rv)
		case reflect.Map:
			return e.dict(rv)
		default:
			return fmt.Errorf("strepr cannot encode %T", v)
		}
	}
	if kind != 0 {
		err = e.varint(kind, uval)
	}
	return err
}

var byteType = reflect.TypeOf(byte(0))

func (e *Encoder) varint(kind byte, v uint64) error {
	i := len(e.b) - 1
	e.b[i] = byte(v & 0x7f)
	v >>= 7
	for v > 0 {
		i--
		e.b[i] = byte(0x80 | (v & 0x7f))
		v >>= 7
	}
	i--
	e.b[i] = kind
	_, err := e.w.Write(e.b[i:])
	return err
}

const (
	mask = 0x7ff
	bias = 1023
	unan = 0x7ff8000000000000
)

func (e *Encoder) float(f float64) error {
	if f == 0 {
		_, err := e.w.Write([]byte{'p', 0})
		return err
	}
	if math.IsNaN(f) {
		f = math.Float64frombits(unan)
	}

	bits := math.Float64bits(f)
	sign := bits & (1 << 63)
	frac := (bits & ((1 << 52) - 1)) | (1 << 52)
	exp := int((bits>>52)&0x7ff) - bias - 52

	if math.IsNaN(f) || math.IsInf(f, 0) || exp < -52 || exp < 0 && (frac&(1<<uint64(-exp)-1)) != 0 {
		// It's not an integer.
		for i := 8; i > 0; i-- {
			e.b[i] = byte(bits & 0xff)
			bits >>= 8
		}
		e.b[0] = 'd'
		_, err := e.w.Write(e.b[:9])
		return err
	}

	// It's an integer. Encode as such.
	if exp > 0 {
		// Having exp as a multiple of 7 simplifies the logic below.
		frac <<= uint64(exp % 7)
		exp -= exp % 7
	}
	i := len(e.b) - 1
	if exp <= 0 {
		frac >>= uint64(-exp)
		e.b[i] = byte(frac & 0x7f)
		frac >>= 7
	} else {
		e.b[i] = 0
		exp -= 7
		for exp > 0 {
			i--
			e.b[i] = 0x80
			exp -= 7
		}
	}
	for frac > 0 {
		i--
		e.b[i] = byte(0x80 | (frac & 0x7f))
		frac >>= 7
	}
	i--
	if sign == 0 {
		e.b[i] = 'p'
	} else {
		e.b[i] = 'n'
	}
	_, err := e.w.Write(e.b[i:])
	return err
}

func (e *Encoder) list(v reflect.Value) error {
	l := v.Len()
	err := e.varint('l', uint64(l))
	if err != nil {
		return err
	}
	for i := 0; i < l; i++ {
		err := e.Encode(v.Index(i).Interface())
		if err != nil {
			return err
		}
	}
	return nil
}

func (e *Encoder) dict(v reflect.Value) error {
	buf := bytes.Buffer{}
	encoder := Encoder{w: &buf}
	ksorter := keySorter{keys: v.MapKeys()}
	ksorter.bufs = make([][]byte, len(ksorter.keys))

	err := e.varint('m', uint64(len(ksorter.keys)))
	if err != nil {
		return err
	}

	// Write all keys in a single buffer.
	pos := 0
	for i := range ksorter.keys {
		err := encoder.Encode(ksorter.keys[i].Interface())
		if err != nil {
			return err
		}
		ksorter.bufs[i] = buf.Bytes()[pos:buf.Len()]
		pos = buf.Len()
	}

	// Sort just the indexes.
	sort.Sort(&ksorter)

	// Write each previously serialized key along with the
	// encoding of its respective value.
	for i := range ksorter.keys {
		_, err := e.w.Write(ksorter.bufs[i])
		if err != nil {
			return err
		}
		err = e.Encode(v.MapIndex(ksorter.keys[i]).Interface())
		if err != nil {
			return err
		}
	}
	return nil
}

type keySorter struct {
	keys []reflect.Value
	bufs [][]byte
}

func (ks *keySorter) Len() int { return len(ks.keys) }

func (ks *keySorter) Swap(i, j int) {
	ks.keys[i], ks.keys[j] = ks.keys[j], ks.keys[i]
	ks.bufs[i], ks.bufs[j] = ks.bufs[j], ks.bufs[i]
}

func (ks *keySorter) Less(i, j int) bool {
	return bytes.Compare(ks.bufs[i], ks.bufs[j]) == -1
}