Update install.texi, and regenerate INSTALL.
[glibc.git] / wcsmbs / uchar.h
blobc37e8619a004fa04bfeb9b83b6f0f5aff09bc1fc
1 /* Copyright (C) 2011-2022 Free Software Foundation, Inc.
2 This file is part of the GNU C Library.
4 The GNU C Library is free software; you can redistribute it and/or
5 modify it under the terms of the GNU Lesser General Public
6 License as published by the Free Software Foundation; either
7 version 2.1 of the License, or (at your option) any later version.
9 The GNU C Library is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 Lesser General Public License for more details.
14 You should have received a copy of the GNU Lesser General Public
15 License along with the GNU C Library; if not, see
16 <https://www.gnu.org/licenses/>. */
19 * ISO C11 Standard: 7.28
20 * Unicode utilities <uchar.h>
23 #ifndef _UCHAR_H
24 #define _UCHAR_H 1
26 #include <features.h>
28 #define __need_size_t
29 #include <stddef.h>
31 #include <bits/types.h>
32 #include <bits/types/mbstate_t.h>
34 /* Declare the C2x char8_t typedef in C2x modes, but only if the C++
35 __cpp_char8_t feature test macro is not defined. */
36 #if __GLIBC_USE (ISOC2X) && !defined __cpp_char8_t
37 /* Define the 8-bit character type. */
38 typedef unsigned char char8_t;
39 #endif
41 #ifndef __USE_ISOCXX11
42 /* Define the 16-bit and 32-bit character types. */
43 typedef __uint_least16_t char16_t;
44 typedef __uint_least32_t char32_t;
45 #endif
48 __BEGIN_DECLS
50 /* Declare the C2x mbrtoc8() and c8rtomb() functions in C2x modes or if
51 the C++ __cpp_char8_t feature test macro is defined. */
52 #if __GLIBC_USE (ISOC2X) || defined __cpp_char8_t
53 /* Write char8_t representation of multibyte character pointed
54 to by S to PC8. */
55 extern size_t mbrtoc8 (char8_t *__restrict __pc8,
56 const char *__restrict __s, size_t __n,
57 mbstate_t *__restrict __p) __THROW;
59 /* Write multibyte representation of char8_t C8 to S. */
60 extern size_t c8rtomb (char *__restrict __s, char8_t __c8,
61 mbstate_t *__restrict __ps) __THROW;
62 #endif
64 /* Write char16_t representation of multibyte character pointed
65 to by S to PC16. */
66 extern size_t mbrtoc16 (char16_t *__restrict __pc16,
67 const char *__restrict __s, size_t __n,
68 mbstate_t *__restrict __p) __THROW;
70 /* Write multibyte representation of char16_t C16 to S. */
71 extern size_t c16rtomb (char *__restrict __s, char16_t __c16,
72 mbstate_t *__restrict __ps) __THROW;
76 /* Write char32_t representation of multibyte character pointed
77 to by S to PC32. */
78 extern size_t mbrtoc32 (char32_t *__restrict __pc32,
79 const char *__restrict __s, size_t __n,
80 mbstate_t *__restrict __p) __THROW;
82 /* Write multibyte representation of char32_t C32 to S. */
83 extern size_t c32rtomb (char *__restrict __s, char32_t __c32,
84 mbstate_t *__restrict __ps) __THROW;
86 __END_DECLS
88 #endif /* uchar.h */