Commit | Line | Data |
---|---|---|
3719602c PC |
1 | /* Copyright (C) 2010-2020 The RetroArch team |
2 | * | |
3 | * --------------------------------------------------------------------------------------- | |
4 | * The following license statement only applies to this file (utf.h). | |
5 | * --------------------------------------------------------------------------------------- | |
6 | * | |
7 | * Permission is hereby granted, free of charge, | |
8 | * to any person obtaining a copy of this software and associated documentation files (the "Software"), | |
9 | * to deal in the Software without restriction, including without limitation the rights to | |
10 | * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, | |
11 | * and to permit persons to whom the Software is furnished to do so, subject to the following conditions: | |
12 | * | |
13 | * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. | |
14 | * | |
15 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, | |
16 | * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
17 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. | |
18 | * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, | |
19 | * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
20 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | |
21 | */ | |
22 | ||
23 | #ifndef _LIBRETRO_ENCODINGS_UTF_H | |
24 | #define _LIBRETRO_ENCODINGS_UTF_H | |
25 | ||
26 | #include <stdint.h> | |
27 | #include <stddef.h> | |
28 | ||
29 | #include <boolean.h> | |
30 | ||
31 | #include <retro_common_api.h> | |
32 | ||
33 | RETRO_BEGIN_DECLS | |
34 | ||
35 | enum CodePage | |
36 | { | |
37 | CODEPAGE_LOCAL = 0, /* CP_ACP */ | |
38 | CODEPAGE_UTF8 = 65001 /* CP_UTF8 */ | |
39 | }; | |
40 | ||
41 | /** | |
42 | * utf8_conv_utf32: | |
43 | * | |
44 | * Simple implementation. Assumes the sequence is | |
45 | * properly synchronized and terminated. | |
46 | **/ | |
47 | size_t utf8_conv_utf32(uint32_t *out, size_t out_chars, | |
48 | const char *in, size_t in_size); | |
49 | ||
50 | /** | |
51 | * utf16_conv_utf8: | |
52 | * | |
53 | * Leaf function. | |
54 | **/ | |
55 | bool utf16_conv_utf8(uint8_t *out, size_t *out_chars, | |
56 | const uint16_t *in, size_t in_size); | |
57 | ||
58 | /** | |
59 | * utf8len: | |
60 | * | |
61 | * Leaf function. | |
62 | **/ | |
63 | size_t utf8len(const char *string); | |
64 | ||
65 | /** | |
66 | * utf8cpy: | |
67 | * | |
68 | * Acts mostly like strlcpy. | |
69 | * | |
70 | * Copies the given number of UTF-8 characters, | |
71 | * but at most @d_len bytes. | |
72 | * | |
73 | * Always NULL terminates. Does not copy half a character. | |
74 | * @s is assumed valid UTF-8. | |
75 | * Use only if @chars is considerably less than @d_len. | |
76 | * | |
77 | * Hidden non-leaf function cost: | |
78 | * - Calls memcpy | |
79 | * | |
80 | * @return Number of bytes. | |
81 | **/ | |
82 | size_t utf8cpy(char *d, size_t d_len, const char *s, size_t chars); | |
83 | ||
84 | /** | |
85 | * utf8skip: | |
86 | * | |
87 | * Leaf function | |
88 | **/ | |
89 | const char *utf8skip(const char *str, size_t chars); | |
90 | ||
91 | /** | |
92 | * utf8_walk: | |
93 | * | |
94 | * Does not validate the input. | |
95 | * | |
96 | * Leaf function. | |
97 | * | |
98 | * @return Returns garbage if it's not UTF-8. | |
99 | **/ | |
100 | uint32_t utf8_walk(const char **string); | |
101 | ||
102 | /** | |
103 | * utf16_to_char_string: | |
104 | **/ | |
105 | bool utf16_to_char_string(const uint16_t *in, char *s, size_t len); | |
106 | ||
107 | /** | |
108 | * utf8_to_local_string_alloc: | |
109 | * | |
110 | * @return Returned pointer MUST be freed by the caller if non-NULL. | |
111 | **/ | |
112 | char *utf8_to_local_string_alloc(const char *str); | |
113 | ||
114 | /** | |
115 | * local_to_utf8_string_alloc: | |
116 | * | |
117 | * @return Returned pointer MUST be freed by the caller if non-NULL. | |
118 | **/ | |
119 | char *local_to_utf8_string_alloc(const char *str); | |
120 | ||
121 | /** | |
122 | * utf8_to_utf16_string_alloc: | |
123 | * | |
124 | * @return Returned pointer MUST be freed by the caller if non-NULL. | |
125 | **/ | |
126 | wchar_t *utf8_to_utf16_string_alloc(const char *str); | |
127 | ||
128 | /** | |
129 | * utf16_to_utf8_string_alloc: | |
130 | * | |
131 | * @return Returned pointer MUST be freed by the caller if non-NULL. | |
132 | **/ | |
133 | char *utf16_to_utf8_string_alloc(const wchar_t *str); | |
134 | ||
135 | RETRO_END_DECLS | |
136 | ||
137 | #endif |