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
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
|
/***
* simdutf_c.h.h - C API for simdutf
* This is currently experimental.
* We are committed to keeping the C API, but there might be mistakes in our
* implementation. Please report any issues you find.
*/
#ifndef SIMDUTF_C_H
#define SIMDUTF_C_H
#include <stddef.h>
#include <stdbool.h>
#include <stdint.h>
#ifdef __has_include
#if __has_include(<uchar.h>)
#include <uchar.h>
#else // __has_include(<uchar.h>)
#define char16_t uint16_t
#define char32_t uint32_t
#endif // __has_include(<uchar.h>)
#else // __has_include(<uchar.h>)
#define char16_t uint16_t
#define char32_t uint32_t
#endif // __has_include
#ifdef __cplusplus
extern "C" {
#endif
/* C-friendly subset of simdutf errors */
typedef enum simdutf_error_code {
SIMDUTF_ERROR_SUCCESS = 0,
SIMDUTF_ERROR_HEADER_BITS,
SIMDUTF_ERROR_TOO_SHORT,
SIMDUTF_ERROR_TOO_LONG,
SIMDUTF_ERROR_OVERLONG,
SIMDUTF_ERROR_TOO_LARGE,
SIMDUTF_ERROR_SURROGATE,
SIMDUTF_ERROR_INVALID_BASE64_CHARACTER,
SIMDUTF_ERROR_BASE64_INPUT_REMAINDER,
SIMDUTF_ERROR_BASE64_EXTRA_BITS,
SIMDUTF_ERROR_OUTPUT_BUFFER_TOO_SMALL,
SIMDUTF_ERROR_OTHER
} simdutf_error_code;
typedef struct simdutf_result {
simdutf_error_code error;
size_t count; /* position of error or number of code units validated */
} simdutf_result;
typedef enum simdutf_encoding_type {
SIMDUTF_ENCODING_UNSPECIFIED = 0,
SIMDUTF_ENCODING_UTF8 = 1,
SIMDUTF_ENCODING_UTF16_LE = 2,
SIMDUTF_ENCODING_UTF16_BE = 4,
SIMDUTF_ENCODING_UTF32_LE = 8,
SIMDUTF_ENCODING_UTF32_BE = 16
} simdutf_encoding_type;
/* Validate UTF-8: returns true iff input is valid UTF-8 */
bool simdutf_validate_utf8(const char *buf, size_t len);
/* Validate UTF-8 with detailed result */
simdutf_result simdutf_validate_utf8_with_errors(const char *buf, size_t len);
/* Encoding detection */
simdutf_encoding_type simdutf_autodetect_encoding(const char *input,
size_t length);
int simdutf_detect_encodings(const char *input, size_t length);
/* ASCII validation */
bool simdutf_validate_ascii(const char *buf, size_t len);
simdutf_result simdutf_validate_ascii_with_errors(const char *buf, size_t len);
/* UTF-16 ASCII checks */
bool simdutf_validate_utf16_as_ascii(const char16_t *buf, size_t len);
bool simdutf_validate_utf16be_as_ascii(const char16_t *buf, size_t len);
bool simdutf_validate_utf16le_as_ascii(const char16_t *buf, size_t len);
/* UTF-16/UTF-8/UTF-32 validation (native/endian-specific) */
bool simdutf_validate_utf16(const char16_t *buf, size_t len);
bool simdutf_validate_utf16le(const char16_t *buf, size_t len);
bool simdutf_validate_utf16be(const char16_t *buf, size_t len);
simdutf_result simdutf_validate_utf16_with_errors(const char16_t *buf,
size_t len);
simdutf_result simdutf_validate_utf16le_with_errors(const char16_t *buf,
size_t len);
simdutf_result simdutf_validate_utf16be_with_errors(const char16_t *buf,
size_t len);
bool simdutf_validate_utf32(const char32_t *buf, size_t len);
simdutf_result simdutf_validate_utf32_with_errors(const char32_t *buf,
size_t len);
/* to_well_formed UTF-16 helpers */
void simdutf_to_well_formed_utf16le(const char16_t *input, size_t len,
char16_t *output);
void simdutf_to_well_formed_utf16be(const char16_t *input, size_t len,
char16_t *output);
void simdutf_to_well_formed_utf16(const char16_t *input, size_t len,
char16_t *output);
/* Counting */
size_t simdutf_count_utf16(const char16_t *input, size_t length);
size_t simdutf_count_utf16le(const char16_t *input, size_t length);
size_t simdutf_count_utf16be(const char16_t *input, size_t length);
size_t simdutf_count_utf8(const char *input, size_t length);
/* Length estimators */
size_t simdutf_utf8_length_from_latin1(const char *input, size_t length);
size_t simdutf_latin1_length_from_utf8(const char *input, size_t length);
size_t simdutf_latin1_length_from_utf16(size_t length);
size_t simdutf_latin1_length_from_utf32(size_t length);
size_t simdutf_utf16_length_from_utf8(const char *input, size_t length);
size_t simdutf_utf32_length_from_utf8(const char *input, size_t length);
size_t simdutf_utf8_length_from_utf16(const char16_t *input, size_t length);
simdutf_result
simdutf_utf8_length_from_utf16_with_replacement(const char16_t *input,
size_t length);
size_t simdutf_utf8_length_from_utf16le(const char16_t *input, size_t length);
size_t simdutf_utf8_length_from_utf16be(const char16_t *input, size_t length);
simdutf_result
simdutf_utf8_length_from_utf16le_with_replacement(const char16_t *input,
size_t length);
simdutf_result
simdutf_utf8_length_from_utf16be_with_replacement(const char16_t *input,
size_t length);
/* Conversions: latin1 <-> utf8, utf8 <-> utf16/utf32, utf16 <-> utf8, etc. */
size_t simdutf_convert_latin1_to_utf8(const char *input, size_t length,
char *output);
size_t simdutf_convert_latin1_to_utf8_safe(const char *input, size_t length,
char *output, size_t utf8_len);
size_t simdutf_convert_latin1_to_utf16le(const char *input, size_t length,
char16_t *output);
size_t simdutf_convert_latin1_to_utf16be(const char *input, size_t length,
char16_t *output);
size_t simdutf_convert_latin1_to_utf32(const char *input, size_t length,
char32_t *output);
size_t simdutf_convert_utf8_to_latin1(const char *input, size_t length,
char *output);
size_t simdutf_convert_utf8_to_utf16le(const char *input, size_t length,
char16_t *output);
size_t simdutf_convert_utf8_to_utf16be(const char *input, size_t length,
char16_t *output);
size_t simdutf_convert_utf8_to_utf16(const char *input, size_t length,
char16_t *output);
size_t simdutf_convert_utf8_to_utf32(const char *input, size_t length,
char32_t *output);
simdutf_result simdutf_convert_utf8_to_latin1_with_errors(const char *input,
size_t length,
char *output);
simdutf_result simdutf_convert_utf8_to_utf16_with_errors(const char *input,
size_t length,
char16_t *output);
simdutf_result simdutf_convert_utf8_to_utf16le_with_errors(const char *input,
size_t length,
char16_t *output);
simdutf_result simdutf_convert_utf8_to_utf16be_with_errors(const char *input,
size_t length,
char16_t *output);
simdutf_result simdutf_convert_utf8_to_utf32_with_errors(const char *input,
size_t length,
char32_t *output);
/* Conversions assuming valid input */
size_t simdutf_convert_valid_utf8_to_latin1(const char *input, size_t length,
char *output);
size_t simdutf_convert_valid_utf8_to_utf16le(const char *input, size_t length,
char16_t *output);
size_t simdutf_convert_valid_utf8_to_utf16be(const char *input, size_t length,
char16_t *output);
size_t simdutf_convert_valid_utf8_to_utf32(const char *input, size_t length,
char32_t *output);
/* UTF-16 -> UTF-8 and related conversions */
size_t simdutf_convert_utf16_to_utf8(const char16_t *input, size_t length,
char *output);
size_t simdutf_convert_utf16le_to_utf8(const char16_t *input, size_t length,
char *output);
size_t simdutf_convert_utf16be_to_utf8(const char16_t *input, size_t length,
char *output);
size_t simdutf_convert_utf16_to_utf8_safe(const char16_t *input, size_t length,
char *output, size_t utf8_len);
size_t simdutf_convert_utf16_to_latin1(const char16_t *input, size_t length,
char *output);
size_t simdutf_convert_utf16le_to_latin1(const char16_t *input, size_t length,
char *output);
size_t simdutf_convert_utf16be_to_latin1(const char16_t *input, size_t length,
char *output);
simdutf_result
simdutf_convert_utf16_to_latin1_with_errors(const char16_t *input,
size_t length, char *output);
simdutf_result
simdutf_convert_utf16le_to_latin1_with_errors(const char16_t *input,
size_t length, char *output);
simdutf_result
simdutf_convert_utf16be_to_latin1_with_errors(const char16_t *input,
size_t length, char *output);
simdutf_result simdutf_convert_utf16_to_utf8_with_errors(const char16_t *input,
size_t length,
char *output);
simdutf_result
simdutf_convert_utf16le_to_utf8_with_errors(const char16_t *input,
size_t length, char *output);
simdutf_result
simdutf_convert_utf16be_to_utf8_with_errors(const char16_t *input,
size_t length, char *output);
size_t simdutf_convert_valid_utf16_to_utf8(const char16_t *input, size_t length,
char *output);
size_t simdutf_convert_valid_utf16_to_latin1(const char16_t *input,
size_t length, char *output);
size_t simdutf_convert_valid_utf16le_to_latin1(const char16_t *input,
size_t length, char *output);
size_t simdutf_convert_valid_utf16be_to_latin1(const char16_t *input,
size_t length, char *output);
size_t simdutf_convert_valid_utf16le_to_utf8(const char16_t *input,
size_t length, char *output);
size_t simdutf_convert_valid_utf16be_to_utf8(const char16_t *input,
size_t length, char *output);
/* UTF-16 <-> UTF-32 conversions */
size_t simdutf_convert_utf16_to_utf32(const char16_t *input, size_t length,
char32_t *output);
size_t simdutf_convert_utf16le_to_utf32(const char16_t *input, size_t length,
char32_t *output);
size_t simdutf_convert_utf16be_to_utf32(const char16_t *input, size_t length,
char32_t *output);
simdutf_result simdutf_convert_utf16_to_utf32_with_errors(const char16_t *input,
size_t length,
char32_t *output);
simdutf_result
simdutf_convert_utf16le_to_utf32_with_errors(const char16_t *input,
size_t length, char32_t *output);
simdutf_result
simdutf_convert_utf16be_to_utf32_with_errors(const char16_t *input,
size_t length, char32_t *output);
/* Valid UTF-16 conversions */
size_t simdutf_convert_valid_utf16_to_utf32(const char16_t *input,
size_t length, char32_t *output);
size_t simdutf_convert_valid_utf16le_to_utf32(const char16_t *input,
size_t length, char32_t *output);
size_t simdutf_convert_valid_utf16be_to_utf32(const char16_t *input,
size_t length, char32_t *output);
/* UTF-32 -> ... conversions */
size_t simdutf_convert_utf32_to_utf8(const char32_t *input, size_t length,
char *output);
simdutf_result simdutf_convert_utf32_to_utf8_with_errors(const char32_t *input,
size_t length,
char *output);
size_t simdutf_convert_valid_utf32_to_utf8(const char32_t *input, size_t length,
char *output);
size_t simdutf_convert_utf32_to_utf16(const char32_t *input, size_t length,
char16_t *output);
size_t simdutf_convert_utf32_to_utf16le(const char32_t *input, size_t length,
char16_t *output);
size_t simdutf_convert_utf32_to_utf16be(const char32_t *input, size_t length,
char16_t *output);
simdutf_result
simdutf_convert_utf32_to_latin1_with_errors(const char32_t *input,
size_t length, char *output);
/* --- Find helpers --- */
const char *simdutf_find(const char *start, const char *end, char character);
const char16_t *simdutf_find_utf16(const char16_t *start, const char16_t *end,
char16_t character);
/* --- Base64 enums and helpers --- */
typedef enum simdutf_base64_options {
SIMDUTF_BASE64_DEFAULT = 0,
SIMDUTF_BASE64_URL = 1,
SIMDUTF_BASE64_DEFAULT_NO_PADDING = 2,
SIMDUTF_BASE64_URL_WITH_PADDING = 3,
SIMDUTF_BASE64_DEFAULT_ACCEPT_GARBAGE = 4,
SIMDUTF_BASE64_URL_ACCEPT_GARBAGE = 5,
SIMDUTF_BASE64_DEFAULT_OR_URL = 8,
SIMDUTF_BASE64_DEFAULT_OR_URL_ACCEPT_GARBAGE = 12
} simdutf_base64_options;
typedef enum simdutf_last_chunk_handling_options {
SIMDUTF_LAST_CHUNK_LOOSE = 0,
SIMDUTF_LAST_CHUNK_STRICT = 1,
SIMDUTF_LAST_CHUNK_STOP_BEFORE_PARTIAL = 2,
SIMDUTF_LAST_CHUNK_ONLY_FULL_CHUNKS = 3
} simdutf_last_chunk_handling_options;
/* maximal binary length estimators */
size_t simdutf_maximal_binary_length_from_base64(const char *input,
size_t length);
size_t simdutf_maximal_binary_length_from_base64_utf16(const char16_t *input,
size_t length);
/* base64 decoding/encoding */
simdutf_result simdutf_base64_to_binary(
const char *input, size_t length, char *output,
simdutf_base64_options options,
simdutf_last_chunk_handling_options last_chunk_options);
simdutf_result simdutf_base64_to_binary_utf16(
const char16_t *input, size_t length, char *output,
simdutf_base64_options options,
simdutf_last_chunk_handling_options last_chunk_options);
size_t simdutf_base64_length_from_binary(size_t length,
simdutf_base64_options options);
size_t simdutf_base64_length_from_binary_with_lines(
size_t length, simdutf_base64_options options, size_t line_length);
size_t simdutf_binary_to_base64(const char *input, size_t length, char *output,
simdutf_base64_options options);
size_t simdutf_binary_to_base64_with_lines(const char *input, size_t length,
char *output, size_t line_length,
simdutf_base64_options options);
/* safe decoding that provides an in/out outlen parameter */
simdutf_result simdutf_base64_to_binary_safe(
const char *input, size_t length, char *output, size_t *outlen,
simdutf_base64_options options,
simdutf_last_chunk_handling_options last_chunk_options,
bool decode_up_to_bad_char);
simdutf_result simdutf_base64_to_binary_safe_utf16(
const char16_t *input, size_t length, char *output, size_t *outlen,
simdutf_base64_options options,
simdutf_last_chunk_handling_options last_chunk_options,
bool decode_up_to_bad_char);
#ifdef __cplusplus
} /* extern "C" */
#endif
#endif /* SIMDUTF_C_H */
|
