xref: /aosp_15_r20/bionic/libc/include/uchar.h (revision 8d67ca893c1523eb926b9080dbe4e2ffd2a27ba1)
1 /*
2  * Copyright (C) 2014 The Android Open Source Project
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *  * Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  *  * Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in
12  *    the documentation and/or other materials provided with the
13  *    distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
18  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
19  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
22  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
25  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #pragma once
30 
31 /**
32  * @file uchar.h
33  * @brief Unicode functions.
34  */
35 
36 #include <sys/cdefs.h>
37 
38 #include <stddef.h>
39 
40 #include <bits/bionic_multibyte_result.h>
41 #include <bits/mbstate_t.h>
42 
43 __BEGIN_DECLS
44 
45 #if !defined(__cplusplus)
46 /** The UTF-16 character type. */
47 typedef __CHAR16_TYPE__ char16_t;
48 /** The UTF-32 character type. */
49 typedef __CHAR32_TYPE__ char32_t;
50 #endif
51 
52 /** On Android, char16_t is UTF-16. */
53 #define __STD_UTF_16__ 1
54 
55 /** On Android, char32_t is UTF-32. */
56 #define __STD_UTF_32__ 1
57 
58 /**
59  * [c16rtomb(3)](https://man7.org/linux/man-pages/man3/c16rtomb.3.html) converts a single UTF-16
60  * character to UTF-8.
61  *
62  * Returns the number of bytes written to `__buf` on success, and returns -1 and sets `errno`
63  * on failure.
64  */
65 size_t c16rtomb(char* _Nullable __buf, char16_t __ch16, mbstate_t* _Nullable __ps);
66 
67 /**
68  * [c32rtomb(3)](https://man7.org/linux/man-pages/man3/c32rtomb.3.html) converts a single UTF-32
69  * character to UTF-8.
70  *
71  * Returns the number of bytes written to `__buf` on success, and returns -1 and sets `errno`
72  * on failure.
73  */
74 size_t c32rtomb(char* _Nullable __buf, char32_t __ch32, mbstate_t* _Nullable __ps);
75 
76 /**
77  * [mbrtoc16(3)](https://man7.org/linux/man-pages/man3/mbrtoc16.3.html) converts the next UTF-8
78  * sequence to a UTF-16 code point.
79  */
80 size_t mbrtoc16(char16_t* _Nullable __ch16, const char* _Nullable __s, size_t __n, mbstate_t* _Nullable __ps);
81 
82 /**
83  * [mbrtoc32(3)](https://man7.org/linux/man-pages/man3/mbrtoc32.3.html) converts the next UTF-8
84  * sequence to a UTF-32 code point.
85  */
86 size_t mbrtoc32(char32_t* _Nullable __ch32, const char* _Nullable __s, size_t __n, mbstate_t* _Nullable __ps);
87 
88 __END_DECLS
89