stereokit-rust 0.4.0-alpha.22

High-Level Rust bindings around the StereoKitC library for XR
Documentation
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
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
#include "unicode.h"

#include <stdint.h>
#include <string.h>

///////////////////////////////////////////

// Previously:
// https://github.com/skeeto/branchless-utf8
// Should switch this to a SIMD implementation later, possibly:
// https://dirtyhandscoding.github.io/posts/utf8lut-vectorized-utf-8-converter-decoding-utf-8.html

// Copyright (c) 2008-2010 Bjoern Hoehrmann <bjoern@hoehrmann.de>
// See http://bjoern.hoehrmann.de/utf-8/decoder/dfa/ for details.
#define UTF8_ACCEPT 0
#define UTF8_REJECT 12
static const uint8_t utf8d[] = {
	// The first part of the table maps bytes to character classes that
	// to reduce the size of the transition table and create bitmasks.
	 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,  0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
	 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,  0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
	 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,  0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
	 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,  0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
	 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,  9,9,9,9,9,9,9,9,9,9,9,9,9,9,9,9,
	 7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,  7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,
	 8,8,2,2,2,2,2,2,2,2,2,2,2,2,2,2,  2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
	10,3,3,3,3,3,3,3,3,3,3,3,3,4,3,3, 11,6,6,6,5,8,8,8,8,8,8,8,8,8,8,8,

	// The second part is a transition table that maps a combination
	// of a state of the automaton and a character class to a state.
	 0,12,24,36,60,96,84,12,12,12,48,72, 12,12,12,12,12,12,12,12,12,12,12,12,
	12, 0,12,12,12,12,12, 0,12, 0,12,12, 12,24,12,12,12,12,12,24,12,24,12,12,
	12,12,12,12,12,12,12,24,12,12,12,12, 12,24,12,12,12,12,12,12,12,24,12,12,
	12,12,12,12,12,12,12,36,12,36,12,12, 12,36,12,12,12,12,12,36,12,36,12,12,
	12,36,12,12,12,12,12,12,12,12,12,12,
};

int32_t inline utf8_decode_byte(uint32_t* state, uint32_t* codep, uint8_t byte) {
	uint32_t type = utf8d[byte];

	*codep = (*state != UTF8_ACCEPT)
		? (byte & 0x3fu) | (*codep << 6)
		: (0xff >> type) & (byte);

	*state = utf8d[256 + *state + type];
	return *state;
}

char32_t utf8_decode_fast(const char* utf8_str, const char** out_next_char) {
	uint32_t codepoint;
	uint32_t state = UTF8_ACCEPT;
	for (; *utf8_str; utf8_str += 1)
		if (!utf8_decode_byte(&state, &codepoint, *utf8_str)) {
			*out_next_char = utf8_str+1;
			return codepoint;
		}

	*out_next_char = nullptr;
	return 0;
}

///////////////////////////////////////////

bool utf8_decode_fast_b(const char *utf8_str, const char **out_next_char, char32_t *out_char) {
	if (*utf8_str == 0) { *out_char = 0; return false; }
	*out_char = utf8_decode_fast(utf8_str, out_next_char);
	return *out_char != 0;
}

///////////////////////////////////////////

char32_t utf8_decode(const char *utf8_str, const char **out_next_char, int32_t *out_err) {
	static const char lengths[] = {
		1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
		0, 0, 0, 0, 0, 0, 0, 0, 2, 2, 2, 2, 3, 3, 4, 0
	};
	static const int32_t  masks[]  = {0x00, 0x7f, 0x1f, 0x0f, 0x07};
	static const uint32_t mins[]   = {4194304, 0, 128, 2048, 65536};
	static const int32_t  shiftc[] = {0, 18, 12, 6, 0};
	static const int32_t  shifte[] = {0, 6, 4, 2, 0};

	const char *s   = utf8_str;
	int32_t     len = lengths[s[0] >> 3];

	// Compute the pointer to the next character early so that the next
	// iteration can start working on the next character. Neither Clang
	// nor GCC figure out this reordering on their own.
	const char *next = s + len + !len;

	// Assume a four-byte character and load four bytes. Unused bits are
	// shifted out.
	char32_t result = (char32_t)(s[0] & masks[len]) << 18;
	result |= (char32_t)(s[1] & 0x3f) << 12;
	result |= (char32_t)(s[2] & 0x3f) <<  6;
	result |= (char32_t)(s[3] & 0x3f) <<  0;
	result >>= shiftc[len];

	// Accumulate the various error conditions.
	*out_err  = (result < mins[len]) << 6; // non-canonical encoding
	*out_err |= ((result >> 11) == 0x1b) << 7;  // surrogate half?
	*out_err |= (result > 0x10FFFF) << 8;  // out of range?
	*out_err |= (s[1] & 0xc0) >> 2;
	*out_err |= (s[2] & 0xc0) >> 4;
	*out_err |= (s[3]       ) >> 6;
	*out_err ^= 0x2a; // top two bits of each tail byte correct?
	*out_err >>= shifte[len];

	*out_next_char = next;
	return result;
}

///////////////////////////////////////////

int32_t utf8_encode_units(char32_t ch) {
	if      (ch <= 0x7F)     return 1;
	else if (ch <= 0x07FF)   return 2;
	else if (ch <= 0xFFFF)   return 3;
	else if (ch <= 0x10FFFF) return 4;
	else                     return 0;
}

///////////////////////////////////////////

int32_t utf16_encode_units(char32_t ch) {
	if (ch < 0x00010000L) return 1;
	if (ch < 0x00110000L) return 2;
	return 0;
}

///////////////////////////////////////////

int32_t utf8_encode(char *out, char32_t utf) {
	if (utf <= 0x7F) {
		// Plain ASCII
		out[0] = (char) utf;
		return 1;
	} else if (utf <= 0x07FF) {
		// 2-byte unicode
		out[0] = (char) (((utf >> 6) & 0x1F) | 0xC0);
		out[1] = (char) (((utf >> 0) & 0x3F) | 0x80);
		return 2;
	} else if (utf <= 0xFFFF) {
		// 3-byte unicode
		out[0] = (char) (((utf >> 12) & 0x0F) | 0xE0);
		out[1] = (char) (((utf >>  6) & 0x3F) | 0x80);
		out[2] = (char) (((utf >>  0) & 0x3F) | 0x80);
		return 3;
	} else if (utf <= 0x10FFFF) {
		// 4-byte unicode
		out[0] = (char) (((utf >> 18) & 0x07) | 0xF0);
		out[1] = (char) (((utf >> 12) & 0x3F) | 0x80);
		out[2] = (char) (((utf >>  6) & 0x3F) | 0x80);
		out[3] = (char) (((utf >>  0) & 0x3F) | 0x80);
		return 4;
	}
	return 0;
}

///////////////////////////////////////////

int32_t utf8_encode_append(char *buffer, size_t size, char32_t ch) {
	int32_t count = utf8_encode_units(ch);
	size_t  len   = strlen(buffer);
	if (len + count + 1 >= size) {
		return 0;
	} else {
		count = utf8_encode(&buffer[len], ch);
		buffer[len + count] = '\0';
		return count;
	}
}

///////////////////////////////////////////

bool utf8_is_start(char ch) {
	return 
		(ch & 0x80) == 0 ||
		(ch & 0xC0) == 0xC0;
}

///////////////////////////////////////////

size_t strlen(const char16_t *str) {
	if(!str) return 0;
	const char16_t* curr = str;
	while (*curr) curr++;
	return curr-str;
}

///////////////////////////////////////////

size_t utf_charlen(const char* str_utf8) {
	if (!str_utf8) return 0;
	
	// Single byte UTF8 characters all start with 0b0, so anything smaller than
	// 0b1 must be single byte!
	const unsigned char single_byte = (unsigned char)0b10000000;
	// The first byte of multibyte UTF8 characters all begin with 0b11, so
	// anything larger than 0b10111111 is a multibye character indicator!
	const unsigned char multi_byte = (unsigned char)0b10111111;
	
	size_t               result = 0;
	const unsigned char* curr   = (unsigned char*)str_utf8;
	while (*curr != '\0') {
		if (*curr < single_byte || *curr > multi_byte) { result += 1; }
		curr++;
	}
	return result;
}

///////////////////////////////////////////

size_t utf_charlen(const char16_t* str_utf16) {
	if (!str_utf16) return 0;
	
	size_t          result = 0;
	const char16_t* curr   = str_utf16;
	while (*curr != '\0') {
		// Pairs start with a value in the 0xD800-0xDBFF range
		// Singles have a value in the 0x0000-0xD7FF, 0xE000-0xFFFF ranges
		if (*curr < 0xDC00 || *curr > 0xDFFF) { result += 1; }
		curr++;
	}
	return result;
}

///////////////////////////////////////////

const char* utf_at_char(const char* str_utf8, int32_t index) {
	if (!str_utf8) return nullptr;

	// Single byte UTF8 characters all start with 0b0, so anything smaller than
	// 0b1 must be single byte!
	const unsigned char single_byte = (unsigned char)0b10000000;
	// The first byte of multibyte UTF8 characters all begin with 0b11, so
	// anything larger than 0b10111111 is a multibye character indicator!
	const unsigned char multi_byte = (unsigned char)0b10111111;

	size_t               result = 0;
	const unsigned char* curr   = (unsigned char*)str_utf8;
	while (*curr != '\0') {
		if (result == index) return (char*)curr;
		if (*curr < single_byte || *curr > multi_byte) { result += 1; }
		curr++;
	}
	return nullptr;
}

///////////////////////////////////////////

const char16_t* utf_at_char(const char16_t* str_utf16, int32_t index) {
	if (!str_utf16) return nullptr;

	size_t          result = 0;
	const char16_t* curr = str_utf16;
	while (*curr != '\0') {
		if (result == index) return curr;
		// Pairs start with a value in the 0xD800-0xDBFF range
		// Singles have a value in the 0x0000-0xD7FF, 0xE000-0xFFFF ranges
		if (*curr < 0xDC00 || *curr > 0xDFFF) { result += 1; }
		curr++;
	}
	return nullptr;
}

///////////////////////////////////////////

bool utf_remove_chars(char* at_utf8, int32_t count) {
	if (!at_utf8) return false;

	size_t remove = 0;
	char*  curr   = at_utf8;
	for (size_t i = 0; i < count; i++) {
		if      (*curr == '\0')                      break;
		else if ((*curr & 0b10000000) == 0         ) remove += 1;
		else if ((*curr & 0b11100000) == 0b11000000) remove += 2;
		else if ((*curr & 0b11110000) == 0b11100000) remove += 3;
		else if ((*curr & 0b11111000) == 0b11110000) remove += 4;
		curr = at_utf8 + remove;
	}

	size_t len  = strlen(at_utf8)+1;
	size_t copy = len < remove ? remove : len;
	for (size_t i = 0; i < copy; i++)
		at_utf8[i] = at_utf8[i + remove];

	return remove != 0;
}

///////////////////////////////////////////

char* utf_advance_chars(char* from_utf8, int32_t codepoint_count) {
	if (!from_utf8) return nullptr;

	char* curr = from_utf8;
	for (size_t i = 0; i < codepoint_count; i++) {
		if      (*curr == '\0')                      break;
		else if ((*curr & 0b10000000) == 0         ) curr += 1;
		else if ((*curr & 0b11100000) == 0b11000000) curr += 2;
		else if ((*curr & 0b11110000) == 0b11100000) curr += 3;
		else if ((*curr & 0b11111000) == 0b11110000) curr += 4;
	}
	return curr;
}

///////////////////////////////////////////

bool utf_insert_char(const char* buffer_utf8_start, size_t buffer_length, char* at_utf8, char32_t character) {
	int32_t units = utf8_encode_units(character);

	// Ensure there's enough memory in the string
	if (buffer_length - (at_utf8 - buffer_utf8_start) < units) return false;

	// Shift the string to make room for the new character
	int32_t len = (int32_t)strlen(at_utf8);
	for (int32_t i = len + units; i >= units; i--)
		at_utf8[i] = at_utf8[i - units];

	// And insert the new character
	utf8_encode(at_utf8, character);
	return true;
}

///////////////////////////////////////////

bool utf_remove_chars(char16_t* at_utf16, int32_t codepoint_count) {
	if (!at_utf16) return false;

	size_t    remove = 0;
	char16_t* curr   = at_utf16;
	for (size_t i = 0; i < codepoint_count; i++)
	{
		if      (*curr == '\0')                    break;
		else if (*curr < 0xD800 || *curr > 0xDFFF) remove += 1;
		else                                       remove += 2;
		curr = at_utf16 + remove;
	}
	
	size_t len  = strlen(at_utf16)+1;
	size_t copy = len < remove ? remove : len;
	for (size_t i = 0; i < copy; i++) 
		at_utf16[i] = at_utf16[i + remove];

	return remove != 0;
}

///////////////////////////////////////////

char16_t* utf_advance_chars(char16_t* from_utf16, int32_t codepoint_count) {
	if (!from_utf16) return nullptr;

	char16_t* curr = from_utf16;
	for (size_t i = 0; i < codepoint_count; i++)
	{
		if (*curr == '\0')                         break;
		else if (*curr < 0xD800 || *curr > 0xDFFF) curr += 1;
		else                                       curr += 2;
	}
	return curr;
}

///////////////////////////////////////////

char32_t utf16_decode_fast(const char16_t *utf16_str, const char16_t **out_next) {
	if (utf16_str[0] < 0xd800 || utf16_str[0] > 0xdfff) {
		char32_t result = utf16_str[0];
		*out_next = utf16_str + 1;
		return result;

	} else if (utf16_str[0] >= 0xd800 && utf16_str[0] <= 0xdbff &&
	           utf16_str[1] >= 0xdc00 && utf16_str[1] <= 0xdfff) {

		char32_t result = (((utf16_str[0] & 0x03ffL) << 10) | ((utf16_str[1] & 0x03ffL) <<  0)) + 0x00010000L;
		*out_next = utf16_str + 2;
		return result;
	}
	return 0;
}

///////////////////////////////////////////

bool utf16_decode_fast_b(const char16_t *utf16_str, const char16_t **out_next_char, char32_t *out_char) {
	if (*utf16_str == 0) { *out_char = 0; return false; }
	*out_char = utf16_decode_fast(utf16_str, out_next_char);
	return *out_char != 0;
}

///////////////////////////////////////////

int32_t utf16_encode(char16_t *out, char32_t utf) {
	if (utf < 0x00010000L) {
		out[0] = (char16_t)utf;
		return 1;
	} else if (utf < 0x00110000L) {
		utf -= 0x00010000L;

		out[0] = ((utf >> 10) & 0x3ff) | 0xd800;
		out[1] = ((utf >> 0 ) & 0x3ff) | 0xdc00;
		return 2;
	}
	return 0;
}

///////////////////////////////////////////

bool utf_insert_char(const char16_t* buffer_utf16_start, size_t buffer_length, char16_t* at_utf16, char32_t character) {
	int32_t units = utf16_encode_units(character);

	// Ensure there's enough memory in the string
	if (buffer_length - (at_utf16 - buffer_utf16_start) < units) return false;

	// Shift the string to make room for the new character
	int32_t len = (int32_t)strlen(at_utf16);
	for (int32_t i = len+units; i >= units; i--)
		at_utf16[i] = at_utf16[i - units];

	// And insert the new character
	utf16_encode(at_utf16, character);
	return true;
}

///////////////////////////////////////////

int32_t utf16_encode_append(char16_t *buffer, size_t size, char32_t ch) {
	int32_t count = utf16_encode_units(ch);
	size_t  len   = strlen(buffer);
	if (len + count + 1 >= size) {
		return 0;
	} else {
		count = utf16_encode(&buffer[len], ch);
		buffer[len + count] = '\0';
		return count;
	}
}

///////////////////////////////////////////

bool utf16_is_start(char16_t ch) {
	return !(ch >= 0xdc00 && ch <= 0xdfff);
}