wcsmbs/uchar.h

   1 /* Copyright (C) 2011-2024 Free Software Foundation, Inc.
   2    This file is part of the GNU C Library.
   3
   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.
   8
   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.
  13
  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/>.  */
  17
  18 /*
  19  *      ISO C11 Standard: 7.28
  20  *      Unicode utilities       <uchar.h>
  21  */
  22
  23 #ifndef _UCHAR_H
  24 #define _UCHAR_H        1
  25
  26 #include <features.h>
  27
  28 #define __need_size_t
  29 #include <stddef.h>
  30
  31 #include <bits/types.h>
  32 #include <bits/types/mbstate_t.h>
  33
  34 /* Declare the C23 char8_t typedef in C23 modes, but only if the C++
  35   __cpp_char8_t feature test macro is not defined.  */
  36 #if __GLIBC_USE (ISOC23) && !defined __cpp_char8_t
  37 #if __GNUC_PREREQ (10, 0) && defined __cplusplus
  38 /* Suppress the diagnostic regarding char8_t being a keyword in C++20.  */
  39 # pragma GCC diagnostic push
  40 # pragma GCC diagnostic ignored "-Wc++20-compat"
  41 #endif
  42 /* Define the 8-bit character type.  */
  43 typedef unsigned char char8_t;
  44 #if __GNUC_PREREQ (10, 0) && defined __cplusplus
  45 # pragma GCC diagnostic pop
  46 #endif
  47 #endif
  48
  49 #ifndef __USE_ISOCXX11
  50 /* Define the 16-bit and 32-bit character types.  */
  51 typedef __uint_least16_t char16_t;
  52 typedef __uint_least32_t char32_t;
  53 #endif
  54
  55
  56 __BEGIN_DECLS
  57
  58 /* Declare the C23 mbrtoc8() and c8rtomb() functions in C23 modes or if
  59    the C++ __cpp_char8_t feature test macro is defined.  */
  60 #if __GLIBC_USE (ISOC23) || defined __cpp_char8_t
  61 /* Write char8_t representation of multibyte character pointed
  62    to by S to PC8.  */
  63 extern size_t mbrtoc8  (char8_t *__restrict __pc8,
  64                         const char *__restrict __s, size_t __n,
  65                         mbstate_t *__restrict __p) __THROW;
  66
  67 /* Write multibyte representation of char8_t C8 to S.  */
  68 extern size_t c8rtomb  (char *__restrict __s, char8_t __c8,
  69                         mbstate_t *__restrict __ps) __THROW;
  70 #endif
  71
  72 /* Write char16_t representation of multibyte character pointed
  73    to by S to PC16.  */
  74 extern size_t mbrtoc16 (char16_t *__restrict __pc16,
  75                         const char *__restrict __s, size_t __n,
  76                         mbstate_t *__restrict __p) __THROW;
  77
  78 /* Write multibyte representation of char16_t C16 to S.  */
  79 extern size_t c16rtomb (char *__restrict __s, char16_t __c16,
  80                         mbstate_t *__restrict __ps) __THROW;
  81
  82
  83
  84 /* Write char32_t representation of multibyte character pointed
  85    to by S to PC32.  */
  86 extern size_t mbrtoc32 (char32_t *__restrict __pc32,
  87                         const char *__restrict __s, size_t __n,
  88                         mbstate_t *__restrict __p) __THROW;
  89
  90 /* Write multibyte representation of char32_t C32 to S.  */
  91 extern size_t c32rtomb (char *__restrict __s, char32_t __c32,
  92                         mbstate_t *__restrict __ps) __THROW;
  93
  94 __END_DECLS
  95
  96 #endif  /* uchar.h */