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 <stddef.h>
37 #include <sys/cdefs.h>
38 #include <bits/mbstate_t.h>
39 
40 __BEGIN_DECLS
41 
42 #if !defined(__cplusplus)
43 /** The UTF-16 character type. */
44 typedef __CHAR16_TYPE__ char16_t;
45 /** The UTF-32 character type. */
46 typedef __CHAR32_TYPE__ char32_t;
47 #endif
48 
49 /** On Android, char16_t is UTF-16. */
50 #define __STD_UTF_16__ 1
51 
52 /** On Android, char32_t is UTF-32. */
53 #define __STD_UTF_32__ 1
54 
55 /**
56  * [c16rtomb(3)](http://man7.org/linux/man-pages/man3/c16rtomb.3.html) converts a single UTF-16
57  * character to UTF-8.
58  *
59  * Returns the number of bytes written to `__buf` on success, and returns -1 and sets `errno`
60  * on failure.
61  *
62  * Available since API level 21.
63  */
64 size_t c16rtomb(char* _Nullable __buf, char16_t __ch16, mbstate_t* _Nullable __ps) __INTRODUCED_IN(21);
65 
66 /**
67  * [c32rtomb(3)](http://man7.org/linux/man-pages/man3/c32rtomb.3.html) converts a single UTF-32
68  * character to UTF-8.
69  *
70  * Returns the number of bytes written to `__buf` on success, and returns -1 and sets `errno`
71  * on failure.
72  *
73  * Available since API level 21.
74  */
75 size_t c32rtomb(char* _Nullable __buf, char32_t __ch32, mbstate_t* _Nullable __ps) __INTRODUCED_IN(21);
76 
77 /**
78  * [mbrtoc16(3)](http://man7.org/linux/man-pages/man3/mbrtoc16.3.html) converts the next UTF-8
79  * sequence to a UTF-16 code point.
80  *
81  * Available since API level 21.
82  */
83 size_t mbrtoc16(char16_t* _Nullable __ch16, const char* _Nullable __s, size_t __n, mbstate_t* _Nullable __ps) __INTRODUCED_IN(21);
84 
85 /**
86  * [mbrtoc32(3)](http://man7.org/linux/man-pages/man3/mbrtoc32.3.html) converts the next UTF-8
87  * sequence to a UTF-32 code point.
88  *
89  * Available since API level 21.
90  */
91 size_t mbrtoc32(char32_t* _Nullable __ch32, const char* _Nullable __s, size_t __n, mbstate_t* _Nullable __ps) __INTRODUCED_IN(21);
92 
93 __END_DECLS
94