summaryrefslogtreecommitdiff
path: root/internal/jsonstring/encode_string.go
blob: 76bbb3848371d6c1273549cdf5d6a5124a26e2b8 (plain)
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
// Copyright (C) 2022-2023  Luke Shumaker <lukeshu@lukeshu.com>
//
// SPDX-License-Identifier: GPL-2.0-or-later

package jsonstring

import (
	"encoding/json"
	"fmt"
	"io"
	"reflect"
	"unicode/utf8"

	"git.lukeshu.com/go/lowmemjson/internal/fastio"
	"git.lukeshu.com/go/lowmemjson/internal/fastio/noescape"
)

// InvalidUTF8Mode is describe in the main lowmemjson package docs.
type InvalidUTF8Mode uint8

const (
	InvalidUTF8Replace InvalidUTF8Mode = iota
	InvalidUTF8Preserve
	InvalidUTF8Error
)

// BackslashEscapeMode is describe in the main lowmemjson package
// docs.
type BackslashEscapeMode uint8

const (
	BackslashEscapeNone BackslashEscapeMode = iota
	BackslashEscapeShort
	BackslashEscapeUnicode
	BackslashEscapeRawByte
)

// BackslashEscaper is describe in the main lowmemjson package docs.
type BackslashEscaper = func(rune, BackslashEscapeMode) BackslashEscapeMode

func writeStringUnicodeEscape(w io.Writer, c rune) error {
	const alphabet = "0123456789abcdef"
	buf := [6]byte{
		'\\',
		'u',
		alphabet[(c>>12)&0xf],
		alphabet[(c>>8)&0xf],
		alphabet[(c>>4)&0xf],
		alphabet[(c>>0)&0xf],
	}
	_, err := noescape.Write(w, buf[:])
	return err
}

func writeStringShortEscape(w io.Writer, c rune) error {
	var b byte
	switch c {
	case '"', '\\', '/':
		b = byte(c)
	case '\b':
		b = 'b'
	case '\f':
		b = 'f'
	case '\n':
		b = 'n'
	case '\r':
		b = 'r'
	case '\t':
		b = 't'
	default:
		panic(fmt.Errorf("should not happen: writeStringShortEscape called with invalid rune: %q", c))
	}
	buf := [2]byte{'\\', b}
	_, err := noescape.Write(w, buf[:])
	return err
}

func WriteStringChar(w fastio.AllWriter, c rune, escape BackslashEscapeMode) error {
	switch escape {
	case BackslashEscapeNone:
		switch {
		case c < 0x0020: // override, gotta escape these
			switch c {
			case '\b', '\f', '\n', '\r', '\t': // short-escape if possible
				return writeStringShortEscape(w, c)
			default:
				return writeStringUnicodeEscape(w, c)
			}
		case c == '"' || c == '\\': // override, gotta escape these
			return writeStringShortEscape(w, c)
		default: // obey
			_, err := w.WriteRune(c)
			return err
		}
	case BackslashEscapeShort:
		switch c {
		case '"', '\\', '/', '\b', '\f', '\n', '\r', '\t': // obey
			return writeStringShortEscape(w, c)
		default: // override, can't short-escape these
			_, err := w.WriteRune(c)
			return err
		}
	case BackslashEscapeUnicode:
		switch {
		case c > 0xFFFF: // override, can't escape these (TODO: unless we use UTF-16 surrogates?)
			_, err := w.WriteRune(c)
			return err
		default: // obey
			return writeStringUnicodeEscape(w, c)
		}
	case BackslashEscapeRawByte:
		switch {
		case c < utf8.RuneSelf:
			panic(fmt.Errorf("escaper returned BackslashEscapeRawByte for a character=%q < utf8.RuneSelf", c))
		case c > 0xFF:
			panic(fmt.Errorf("escaper returned BackslashEscapeRawByte for a character=%q > 0xFF", c))
		default:
			return w.WriteByte(byte(c))
		}
	default:
		panic(fmt.Errorf("escaper returned an invalid escape mode=%d", escape))
	}
}

func EncodeStringFromString(w fastio.AllWriter, escaper BackslashEscaper, utf InvalidUTF8Mode, val reflect.Value, str string) error {
	if err := w.WriteByte('"'); err != nil {
		return err
	}
	for i := 0; i < len(str); {
		escaped := BackslashEscapeNone
		c, size := utf8.DecodeRuneInString(str[i:])
		if c == utf8.RuneError && size == 1 {
			switch utf {
			case InvalidUTF8Replace:
				escaped = BackslashEscapeUnicode
			case InvalidUTF8Preserve:
				escaped = BackslashEscapeRawByte
				c = rune(str[i])
			case InvalidUTF8Error:
				return &json.UnsupportedValueError{
					Value: val,
					Str:   fmt.Sprintf("invalid UTF-8 at byte offset %d: %#02x", i, str[i]),
				}
			}
		}
		if err := WriteStringChar(w, c, escaper(c, escaped)); err != nil {
			return err
		}
		i += size
	}
	if err := w.WriteByte('"'); err != nil {
		return err
	}
	return nil
}

func EncodeStringFromBytes(w fastio.AllWriter, escaper BackslashEscaper, utf InvalidUTF8Mode, val reflect.Value, str []byte) error {
	if err := w.WriteByte('"'); err != nil {
		return err
	}
	for i := 0; i < len(str); {
		escaped := BackslashEscapeNone
		c, size := utf8.DecodeRune(str[i:])
		if c == utf8.RuneError && size == 1 {
			switch utf {
			case InvalidUTF8Replace:
				escaped = BackslashEscapeUnicode
			case InvalidUTF8Preserve:
				escaped = BackslashEscapeRawByte
				c = rune(str[i])
			case InvalidUTF8Error:
				return &json.UnsupportedValueError{
					Value: val,
					Str:   fmt.Sprintf("invalid UTF-8 at byte offset %d: %#02x", i, str[i]),
				}
			}
		}
		if err := WriteStringChar(w, c, escaper(c, escaped)); err != nil {
			return err
		}
		i += size
	}
	if err := w.WriteByte('"'); err != nil {
		return err
	}
	return nil
}