libcxx/include/__locale_dir/locale_base_api.h

   1 //===-----------------------------------------------------------------------===//
   2 //
   3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
   4 // See https://llvm.org/LICENSE.txt for license information.
   5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
   6 //
   7 //===----------------------------------------------------------------------===//
   8
   9 #ifndef _LIBCPP___LOCALE_DIR_LOCALE_BASE_API_H
  10 #define _LIBCPP___LOCALE_DIR_LOCALE_BASE_API_H
  11
  12 #include <__config>
  13
  14 #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
  15 #  pragma GCC system_header
  16 #endif
  17
  18 // The platform-specific headers have to provide the following interface.
  19 //
  20 // These functions are equivalent to their C counterparts, except that __locale::__locale_t
  21 // is used instead of the current global locale.
  22 //
  23 // Variadic functions may be implemented as templates with a parameter pack instead
  24 // of C-style variadic functions.
  25 //
  26 // TODO: I think __uselocale() is not necessary if we refactor a bit.
  27 // TODO: __localeconv shouldn't take a reference, but the Windows implementation doesn't allow copying __locale_t
  28 //
  29 // Locale management
  30 // -----------------
  31 // namespace __locale {
  32 //  using __locale_t = implementation-defined;
  33 //  __locale_t  __uselocale(__locale_t);
  34 //  __locale_t  __newlocale(int, const char*, __locale_t);
  35 //  void        __freelocale(__locale_t);
  36 //  lconv*      __localeconv(__locale_t&);
  37 // }
  38 //
  39 // Strtonum functions
  40 // ------------------
  41 // namespace __locale {
  42 //  float               __strtof(const char*, char**, __locale_t);
  43 //  double              __strtod(const char*, char**, __locale_t);
  44 //  long double         __strtold(const char*, char**, __locale_t);
  45 //  long long           __strtoll(const char*, char**, __locale_t);
  46 //  unsigned long long  __strtoull(const char*, char**, __locale_t);
  47 // }
  48 //
  49 // Character manipulation functions
  50 // --------------------------------
  51 // namespace __locale {
  52 //  int     __islower(int, __locale_t);
  53 //  int     __isupper(int, __locale_t);
  54 //  int     __isdigit(int, __locale_t);
  55 //  int     __isxdigit(int, __locale_t);
  56 //  int     __toupper(int, __locale_t);
  57 //  int     __tolower(int, __locale_t);
  58 //  int     __strcoll(const char*, const char*, __locale_t);
  59 //  size_t  __strxfrm(char*, const char*, size_t, __locale_t);
  60 //
  61 //  int     __iswspace(wint_t, __locale_t);
  62 //  int     __iswprint(wint_t, __locale_t);
  63 //  int     __iswcntrl(wint_t, __locale_t);
  64 //  int     __iswupper(wint_t, __locale_t);
  65 //  int     __iswlower(wint_t, __locale_t);
  66 //  int     __iswalpha(wint_t, __locale_t);
  67 //  int     __iswblank(wint_t, __locale_t);
  68 //  int     __iswdigit(wint_t, __locale_t);
  69 //  int     __iswpunct(wint_t, __locale_t);
  70 //  int     __iswxdigit(wint_t, __locale_t);
  71 //  wint_t  __towupper(wint_t, __locale_t);
  72 //  wint_t  __towlower(wint_t, __locale_t);
  73 //  int     __wcscoll(const wchar_t*, const wchar_t*, __locale_t);
  74 //  size_t  __wcsxfrm(wchar_t*, const wchar_t*, size_t, __locale_t);
  75 //
  76 //  size_t  __strftime(char*, size_t, const char*, const tm*, __locale_t);
  77 // }
  78 //
  79 // Other functions
  80 // ---------------
  81 // namespace __locale {
  82 //  implementation-defined __mb_len_max(__locale_t);
  83 //  wint_t  __btowc(int, __locale_t);
  84 //  int     __wctob(wint_t, __locale_t);
  85 //  size_t  __wcsnrtombs(char*, const wchar_t**, size_t, size_t, mbstate_t*, __locale_t);
  86 //  size_t  __wcrtomb(char*, wchar_t, mbstate_t*, __locale_t);
  87 //  size_t  __mbsnrtowcs(wchar_t*, const char**, size_t, size_t, mbstate_t*, __locale_t);
  88 //  size_t  __mbrtowc(wchar_t*, const char*, size_t, mbstate_t*, __locale_t);
  89 //  int     __mbtowc(wchar_t*, const char*, size_t, __locale_t);
  90 //  size_t  __mbrlen(const char*, size_t, mbstate_t*, __locale_t);
  91 //  size_t  __mbsrtowcs(wchar_t*, const char**, size_t, mbstate_t*, __locale_t);
  92 //  int     __snprintf(char*, size_t, __locale_t, const char*, ...);
  93 //  int     __asprintf(char**, __locale_t, const char*, ...);
  94 //  int     __sscanf(const char*, __locale_t, const char*, ...);
  95 // }
  96
  97 #if defined(__APPLE__)
  98 #  include <__locale_dir/support/apple.h>
  99 #elif defined(__FreeBSD__)
 100 #  include <__locale_dir/support/freebsd.h>
 101 #else
 102
 103 // TODO: This is a temporary definition to bridge between the old way we defined the locale base API
 104 //       (by providing global non-reserved names) and the new API. As we move individual platforms
 105 //       towards the new way of defining the locale base API, this should disappear since each platform
 106 //       will define those directly.
 107 #  if defined(_LIBCPP_MSVCRT_LIKE)
 108 #    include <__locale_dir/locale_base_api/win32.h>
 109 #  elif defined(_AIX) || defined(__MVS__)
 110 #    include <__locale_dir/locale_base_api/ibm.h>
 111 #  elif defined(__ANDROID__)
 112 #    include <__locale_dir/locale_base_api/android.h>
 113 #  elif defined(__OpenBSD__)
 114 #    include <__locale_dir/locale_base_api/openbsd.h>
 115 #  elif defined(__Fuchsia__)
 116 #    include <__locale_dir/locale_base_api/fuchsia.h>
 117 #  elif defined(__wasi__) || _LIBCPP_HAS_MUSL_LIBC
 118 #    include <__locale_dir/locale_base_api/musl.h>
 119 #  endif
 120
 121 #  ifdef _LIBCPP_LOCALE__L_EXTENSIONS
 122 #    include <__locale_dir/locale_base_api/bsd_locale_defaults.h>
 123 #  else
 124 #    include <__locale_dir/locale_base_api/bsd_locale_fallbacks.h>
 125 #  endif
 126
 127 #  include <__cstddef/size_t.h>
 128 #  include <__utility/forward.h>
 129 #  include <ctype.h>
 130 #  include <string.h>
 131 #  include <time.h>
 132 #  if _LIBCPP_HAS_WIDE_CHARACTERS
 133 #    include <wctype.h>
 134 #  endif
 135 _LIBCPP_BEGIN_NAMESPACE_STD
 136 namespace __locale {
 137 //
 138 // Locale management
 139 //
 140 using __locale_t = locale_t;
 141
 142 #  ifndef _LIBCPP_MSVCRT_LIKE
 143 inline _LIBCPP_HIDE_FROM_ABI __locale_t __uselocale(__locale_t __loc) { return uselocale(__loc); }
 144 #  endif
 145
 146 inline _LIBCPP_HIDE_FROM_ABI __locale_t __newlocale(int __category_mask, const char* __name, __locale_t __loc) {
 147   return newlocale(__category_mask, __name, __loc);
 148 }
 149
 150 inline _LIBCPP_HIDE_FROM_ABI void __freelocale(__locale_t __loc) { freelocale(__loc); }
 151
 152 inline _LIBCPP_HIDE_FROM_ABI lconv* __localeconv(__locale_t& __loc) { return __libcpp_localeconv_l(__loc); }
 153
 154 //
 155 // Strtonum functions
 156 //
 157 inline _LIBCPP_HIDE_FROM_ABI float __strtof(const char* __nptr, char** __endptr, __locale_t __loc) {
 158   return strtof_l(__nptr, __endptr, __loc);
 159 }
 160
 161 inline _LIBCPP_HIDE_FROM_ABI double __strtod(const char* __nptr, char** __endptr, __locale_t __loc) {
 162   return strtod_l(__nptr, __endptr, __loc);
 163 }
 164
 165 inline _LIBCPP_HIDE_FROM_ABI long double __strtold(const char* __nptr, char** __endptr, __locale_t __loc) {
 166   return strtold_l(__nptr, __endptr, __loc);
 167 }
 168
 169 inline _LIBCPP_HIDE_FROM_ABI long long __strtoll(const char* __nptr, char** __endptr, int __base, __locale_t __loc) {
 170   return strtoll_l(__nptr, __endptr, __base, __loc);
 171 }
 172
 173 inline _LIBCPP_HIDE_FROM_ABI unsigned long long
 174 __strtoull(const char* __nptr, char** __endptr, int __base, __locale_t __loc) {
 175   return strtoull_l(__nptr, __endptr, __base, __loc);
 176 }
 177
 178 //
 179 // Character manipulation functions
 180 //
 181 inline _LIBCPP_HIDE_FROM_ABI int __islower(int __ch, __locale_t __loc) { return islower_l(__ch, __loc); }
 182 inline _LIBCPP_HIDE_FROM_ABI int __isupper(int __ch, __locale_t __loc) { return isupper_l(__ch, __loc); }
 183 inline _LIBCPP_HIDE_FROM_ABI int __isdigit(int __ch, __locale_t __loc) { return isdigit_l(__ch, __loc); }
 184 inline _LIBCPP_HIDE_FROM_ABI int __isxdigit(int __ch, __locale_t __loc) { return isxdigit_l(__ch, __loc); }
 185 inline _LIBCPP_HIDE_FROM_ABI int __strcoll(const char* __s1, const char* __s2, __locale_t __loc) {
 186   return strcoll_l(__s1, __s2, __loc);
 187 }
 188 inline _LIBCPP_HIDE_FROM_ABI size_t __strxfrm(char* __dest, const char* __src, size_t __n, __locale_t __loc) {
 189   return strxfrm_l(__dest, __src, __n, __loc);
 190 }
 191 inline _LIBCPP_HIDE_FROM_ABI int __toupper(int __ch, __locale_t __loc) { return toupper_l(__ch, __loc); }
 192 inline _LIBCPP_HIDE_FROM_ABI int __tolower(int __ch, __locale_t __loc) { return tolower_l(__ch, __loc); }
 193
 194 #  if _LIBCPP_HAS_WIDE_CHARACTERS
 195 inline _LIBCPP_HIDE_FROM_ABI int __wcscoll(const wchar_t* __s1, const wchar_t* __s2, __locale_t __loc) {
 196   return wcscoll_l(__s1, __s2, __loc);
 197 }
 198 inline _LIBCPP_HIDE_FROM_ABI size_t __wcsxfrm(wchar_t* __dest, const wchar_t* __src, size_t __n, __locale_t __loc) {
 199   return wcsxfrm_l(__dest, __src, __n, __loc);
 200 }
 201 inline _LIBCPP_HIDE_FROM_ABI int __iswspace(wint_t __ch, __locale_t __loc) { return iswspace_l(__ch, __loc); }
 202 inline _LIBCPP_HIDE_FROM_ABI int __iswprint(wint_t __ch, __locale_t __loc) { return iswprint_l(__ch, __loc); }
 203 inline _LIBCPP_HIDE_FROM_ABI int __iswcntrl(wint_t __ch, __locale_t __loc) { return iswcntrl_l(__ch, __loc); }
 204 inline _LIBCPP_HIDE_FROM_ABI int __iswupper(wint_t __ch, __locale_t __loc) { return iswupper_l(__ch, __loc); }
 205 inline _LIBCPP_HIDE_FROM_ABI int __iswlower(wint_t __ch, __locale_t __loc) { return iswlower_l(__ch, __loc); }
 206 inline _LIBCPP_HIDE_FROM_ABI int __iswalpha(wint_t __ch, __locale_t __loc) { return iswalpha_l(__ch, __loc); }
 207 inline _LIBCPP_HIDE_FROM_ABI int __iswblank(wint_t __ch, __locale_t __loc) { return iswblank_l(__ch, __loc); }
 208 inline _LIBCPP_HIDE_FROM_ABI int __iswdigit(wint_t __ch, __locale_t __loc) { return iswdigit_l(__ch, __loc); }
 209 inline _LIBCPP_HIDE_FROM_ABI int __iswpunct(wint_t __ch, __locale_t __loc) { return iswpunct_l(__ch, __loc); }
 210 inline _LIBCPP_HIDE_FROM_ABI int __iswxdigit(wint_t __ch, __locale_t __loc) { return iswxdigit_l(__ch, __loc); }
 211 inline _LIBCPP_HIDE_FROM_ABI wint_t __towupper(wint_t __ch, __locale_t __loc) { return towupper_l(__ch, __loc); }
 212 inline _LIBCPP_HIDE_FROM_ABI wint_t __towlower(wint_t __ch, __locale_t __loc) { return towlower_l(__ch, __loc); }
 213 #  endif
 214
 215 inline _LIBCPP_HIDE_FROM_ABI size_t
 216 __strftime(char* __s, size_t __max, const char* __format, const tm* __tm, __locale_t __loc) {
 217   return strftime_l(__s, __max, __format, __tm, __loc);
 218 }
 219
 220 //
 221 // Other functions
 222 //
 223 inline _LIBCPP_HIDE_FROM_ABI decltype(__libcpp_mb_cur_max_l(__locale_t())) __mb_len_max(__locale_t __loc) {
 224   return __libcpp_mb_cur_max_l(__loc);
 225 }
 226 #  if _LIBCPP_HAS_WIDE_CHARACTERS
 227 inline _LIBCPP_HIDE_FROM_ABI wint_t __btowc(int __ch, __locale_t __loc) { return __libcpp_btowc_l(__ch, __loc); }
 228 inline _LIBCPP_HIDE_FROM_ABI int __wctob(wint_t __ch, __locale_t __loc) { return __libcpp_wctob_l(__ch, __loc); }
 229 inline _LIBCPP_HIDE_FROM_ABI size_t
 230 __wcsnrtombs(char* __dest, const wchar_t** __src, size_t __nwc, size_t __len, mbstate_t* __ps, __locale_t __loc) {
 231   return __libcpp_wcsnrtombs_l(__dest, __src, __nwc, __len, __ps, __loc);
 232 }
 233 inline _LIBCPP_HIDE_FROM_ABI size_t __wcrtomb(char* __s, wchar_t __ch, mbstate_t* __ps, __locale_t __loc) {
 234   return __libcpp_wcrtomb_l(__s, __ch, __ps, __loc);
 235 }
 236 inline _LIBCPP_HIDE_FROM_ABI size_t
 237 __mbsnrtowcs(wchar_t* __dest, const char** __src, size_t __nms, size_t __len, mbstate_t* __ps, __locale_t __loc) {
 238   return __libcpp_mbsnrtowcs_l(__dest, __src, __nms, __len, __ps, __loc);
 239 }
 240 inline _LIBCPP_HIDE_FROM_ABI size_t
 241 __mbrtowc(wchar_t* __pwc, const char* __s, size_t __n, mbstate_t* __ps, __locale_t __loc) {
 242   return __libcpp_mbrtowc_l(__pwc, __s, __n, __ps, __loc);
 243 }
 244 inline _LIBCPP_HIDE_FROM_ABI int __mbtowc(wchar_t* __pwc, const char* __pmb, size_t __max, __locale_t __loc) {
 245   return __libcpp_mbtowc_l(__pwc, __pmb, __max, __loc);
 246 }
 247 inline _LIBCPP_HIDE_FROM_ABI size_t __mbrlen(const char* __s, size_t __n, mbstate_t* __ps, __locale_t __loc) {
 248   return __libcpp_mbrlen_l(__s, __n, __ps, __loc);
 249 }
 250 inline _LIBCPP_HIDE_FROM_ABI size_t
 251 __mbsrtowcs(wchar_t* __dest, const char** __src, size_t __len, mbstate_t* __ps, __locale_t __loc) {
 252   return __libcpp_mbsrtowcs_l(__dest, __src, __len, __ps, __loc);
 253 }
 254 #  endif
 255
 256 _LIBCPP_DIAGNOSTIC_PUSH
 257 _LIBCPP_CLANG_DIAGNOSTIC_IGNORED("-Wgcc-compat")
 258 _LIBCPP_GCC_DIAGNOSTIC_IGNORED("-Wformat-nonliteral") // GCC doesn't support [[gnu::format]] on variadic templates
 259 #  ifdef _LIBCPP_COMPILER_CLANG_BASED
 260 #    define _LIBCPP_VARIADIC_ATTRIBUTE_FORMAT(...) _LIBCPP_ATTRIBUTE_FORMAT(__VA_ARGS__)
 261 #  else
 262 #    define _LIBCPP_VARIADIC_ATTRIBUTE_FORMAT(...) /* nothing */
 263 #  endif
 264
 265 template <class... _Args>
 266 _LIBCPP_HIDE_FROM_ABI _LIBCPP_VARIADIC_ATTRIBUTE_FORMAT(__printf__, 4, 5) int __snprintf(
 267     char* __s, size_t __n, __locale_t __loc, const char* __format, _Args&&... __args) {
 268   return std::__libcpp_snprintf_l(__s, __n, __loc, __format, std::forward<_Args>(__args)...);
 269 }
 270 template <class... _Args>
 271 _LIBCPP_HIDE_FROM_ABI _LIBCPP_VARIADIC_ATTRIBUTE_FORMAT(__printf__, 3, 4) int __asprintf(
 272     char** __s, __locale_t __loc, const char* __format, _Args&&... __args) {
 273   return std::__libcpp_asprintf_l(__s, __loc, __format, std::forward<_Args>(__args)...);
 274 }
 275 template <class... _Args>
 276 _LIBCPP_HIDE_FROM_ABI _LIBCPP_VARIADIC_ATTRIBUTE_FORMAT(__scanf__, 3, 4) int __sscanf(
 277     const char* __s, __locale_t __loc, const char* __format, _Args&&... __args) {
 278   return std::__libcpp_sscanf_l(__s, __loc, __format, std::forward<_Args>(__args)...);
 279 }
 280 _LIBCPP_DIAGNOSTIC_POP
 281 #  undef _LIBCPP_VARIADIC_ATTRIBUTE_FORMAT
 282
 283 } // namespace __locale
 284 _LIBCPP_END_NAMESPACE_STD
 285
 286 #endif // Compatibility definition of locale base APIs
 287
 288 #endif // _LIBCPP___LOCALE_DIR_LOCALE_BASE_API_H