1 /* Copyright (C) 2010-2020 The RetroArch team
3 * ---------------------------------------------------------------------------------------
4 * The following license statement only applies to this file (utf.h).
5 * ---------------------------------------------------------------------------------------
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:
13 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
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.
23 #ifndef _LIBRETRO_ENCODINGS_UTF_H
24 #define _LIBRETRO_ENCODINGS_UTF_H
31 #include <retro_common_api.h>
37 CODEPAGE_LOCAL = 0, /* CP_ACP */
38 CODEPAGE_UTF8 = 65001 /* CP_UTF8 */
44 * Simple implementation. Assumes the sequence is
45 * properly synchronized and terminated.
47 size_t utf8_conv_utf32(uint32_t *out, size_t out_chars,
48 const char *in, size_t in_size);
55 bool utf16_conv_utf8(uint8_t *out, size_t *out_chars,
56 const uint16_t *in, size_t in_size);
63 size_t utf8len(const char *string);
68 * Acts mostly like strlcpy.
70 * Copies the given number of UTF-8 characters,
71 * but at most @d_len bytes.
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.
77 * Hidden non-leaf function cost:
80 * @return Number of bytes.
82 size_t utf8cpy(char *d, size_t d_len, const char *s, size_t chars);
89 const char *utf8skip(const char *str, size_t chars);
94 * Does not validate the input.
98 * @return Returns garbage if it's not UTF-8.
100 uint32_t utf8_walk(const char **string);
103 * utf16_to_char_string:
105 bool utf16_to_char_string(const uint16_t *in, char *s, size_t len);
108 * utf8_to_local_string_alloc:
110 * @return Returned pointer MUST be freed by the caller if non-NULL.
112 char *utf8_to_local_string_alloc(const char *str);
115 * local_to_utf8_string_alloc:
117 * @return Returned pointer MUST be freed by the caller if non-NULL.
119 char *local_to_utf8_string_alloc(const char *str);
122 * utf8_to_utf16_string_alloc:
124 * @return Returned pointer MUST be freed by the caller if non-NULL.
126 wchar_t *utf8_to_utf16_string_alloc(const char *str);
129 * utf16_to_utf8_string_alloc:
131 * @return Returned pointer MUST be freed by the caller if non-NULL.
133 char *utf16_to_utf8_string_alloc(const wchar_t *str);