299 lines · c
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-exception6//7//===----------------------------------------------------------------------===//8 9#ifndef _LIBCPP___LOCALE_DIR_LOCALE_BASE_API_H10#define _LIBCPP___LOCALE_DIR_LOCALE_BASE_API_H11 12#include <__config>13 14#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)15# pragma GCC system_header16#endif17 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_t21// is used instead of the current global locale.22//23// Variadic functions may be implemented as templates with a parameter pack instead24// of C-style variadic functions.25//26// Most of these functions are only required when building the library. Functions that are also27// required when merely using the headers are marked as such below.28//29// TODO: __localeconv shouldn't take a reference, but the Windows implementation doesn't allow copying __locale_t30// TODO: Eliminate the need for any of these functions from the headers.31//32// Locale management33// -----------------34// namespace __locale {35// using __locale_t = implementation-defined; // required by the headers36// using __lconv_t = implementation-defined;37// __locale_t __newlocale(int, const char*, __locale_t);38// void __freelocale(__locale_t);39// char* __setlocale(int, const char*);40// __lconv_t* __localeconv(__locale_t&);41// }42//43// // required by the headers44// #define _LIBCPP_COLLATE_MASK /* implementation-defined */45// #define _LIBCPP_CTYPE_MASK /* implementation-defined */46// #define _LIBCPP_MONETARY_MASK /* implementation-defined */47// #define _LIBCPP_NUMERIC_MASK /* implementation-defined */48// #define _LIBCPP_TIME_MASK /* implementation-defined */49// #define _LIBCPP_MESSAGES_MASK /* implementation-defined */50// #define _LIBCPP_ALL_MASK /* implementation-defined */51// #define _LIBCPP_LC_ALL /* implementation-defined */52//53// Strtonum functions54// ------------------55// namespace __locale {56// // required by the headers57// float __strtof(const char*, char**, __locale_t);58// double __strtod(const char*, char**, __locale_t);59// long double __strtold(const char*, char**, __locale_t);60// }61//62// Character manipulation functions63// --------------------------------64// namespace __locale {65// int __toupper(int, __locale_t);66// int __tolower(int, __locale_t);67// int __strcoll(const char*, const char*, __locale_t);68// size_t __strxfrm(char*, const char*, size_t, __locale_t);69//70// int __iswctype(wint_t, wctype_t, __locale_t);71// int __iswspace(wint_t, __locale_t);72// int __iswprint(wint_t, __locale_t);73// int __iswcntrl(wint_t, __locale_t);74// int __iswupper(wint_t, __locale_t);75// int __iswlower(wint_t, __locale_t);76// int __iswalpha(wint_t, __locale_t);77// int __iswblank(wint_t, __locale_t);78// int __iswdigit(wint_t, __locale_t);79// int __iswpunct(wint_t, __locale_t);80// int __iswxdigit(wint_t, __locale_t);81// wint_t __towupper(wint_t, __locale_t);82// wint_t __towlower(wint_t, __locale_t);83// int __wcscoll(const wchar_t*, const wchar_t*, __locale_t);84// size_t __wcsxfrm(wchar_t*, const wchar_t*, size_t, __locale_t);85//86// size_t __strftime(char*, size_t, const char*, const tm*, __locale_t);87// }88//89// Other functions90// ---------------91// namespace __locale {92// implementation-defined __mb_len_max(__locale_t);93// wint_t __btowc(int, __locale_t);94// int __wctob(wint_t, __locale_t);95// size_t __wcsnrtombs(char*, const wchar_t**, size_t, size_t, mbstate_t*, __locale_t);96// size_t __wcrtomb(char*, wchar_t, mbstate_t*, __locale_t);97// size_t __mbsnrtowcs(wchar_t*, const char**, size_t, size_t, mbstate_t*, __locale_t);98// size_t __mbrtowc(wchar_t*, const char*, size_t, mbstate_t*, __locale_t);99// int __mbtowc(wchar_t*, const char*, size_t, __locale_t);100// size_t __mbrlen(const char*, size_t, mbstate_t*, __locale_t);101// size_t __mbsrtowcs(wchar_t*, const char**, size_t, mbstate_t*, __locale_t);102//103// int __snprintf(char*, size_t, __locale_t, const char*, ...); // required by the headers104// int __asprintf(char**, __locale_t, const char*, ...); // required by the headers105// }106 107#if _LIBCPP_HAS_LOCALIZATION108 109# if defined(__APPLE__)110# include <__locale_dir/support/apple.h>111# elif defined(__FreeBSD__)112# include <__locale_dir/support/freebsd.h>113# elif defined(__NetBSD__)114# include <__locale_dir/support/netbsd.h>115# elif defined(_LIBCPP_MSVCRT_LIKE)116# include <__locale_dir/support/windows.h>117# elif defined(__Fuchsia__)118# include <__locale_dir/support/fuchsia.h>119# elif defined(__linux__)120# include <__locale_dir/support/linux.h>121# else122 123// TODO: This is a temporary definition to bridge between the old way we defined the locale base API124// (by providing global non-reserved names) and the new API. As we move individual platforms125// towards the new way of defining the locale base API, this should disappear since each platform126// will define those directly.127# if defined(_AIX) || defined(__MVS__)128# include <__locale_dir/locale_base_api/ibm.h>129# elif defined(__OpenBSD__)130# include <__locale_dir/locale_base_api/openbsd.h>131# endif132 133# include <__locale_dir/locale_base_api/bsd_locale_fallbacks.h>134 135# include <__cstddef/size_t.h>136# include <__utility/forward.h>137# include <ctype.h>138# include <string.h>139# include <time.h>140# if _LIBCPP_HAS_WIDE_CHARACTERS141# include <wctype.h>142# endif143_LIBCPP_BEGIN_NAMESPACE_STD144namespace __locale {145//146// Locale management147//148# define _LIBCPP_COLLATE_MASK LC_COLLATE_MASK149# define _LIBCPP_CTYPE_MASK LC_CTYPE_MASK150# define _LIBCPP_MONETARY_MASK LC_MONETARY_MASK151# define _LIBCPP_NUMERIC_MASK LC_NUMERIC_MASK152# define _LIBCPP_TIME_MASK LC_TIME_MASK153# define _LIBCPP_MESSAGES_MASK LC_MESSAGES_MASK154# define _LIBCPP_ALL_MASK LC_ALL_MASK155# define _LIBCPP_LC_ALL LC_ALL156 157using __locale_t _LIBCPP_NODEBUG = locale_t;158 159# if defined(_LIBCPP_BUILDING_LIBRARY)160using __lconv_t _LIBCPP_NODEBUG = lconv;161 162inline _LIBCPP_HIDE_FROM_ABI __locale_t __newlocale(int __category_mask, const char* __name, __locale_t __loc) {163 return newlocale(__category_mask, __name, __loc);164}165 166inline _LIBCPP_HIDE_FROM_ABI char* __setlocale(int __category, char const* __locale) {167 return ::setlocale(__category, __locale);168}169 170inline _LIBCPP_HIDE_FROM_ABI void __freelocale(__locale_t __loc) { freelocale(__loc); }171 172inline _LIBCPP_HIDE_FROM_ABI __lconv_t* __localeconv(__locale_t& __loc) { return __libcpp_localeconv_l(__loc); }173# endif // _LIBCPP_BUILDING_LIBRARY174 175//176// Strtonum functions177//178inline _LIBCPP_HIDE_FROM_ABI float __strtof(const char* __nptr, char** __endptr, __locale_t __loc) {179 return strtof_l(__nptr, __endptr, __loc);180}181 182inline _LIBCPP_HIDE_FROM_ABI double __strtod(const char* __nptr, char** __endptr, __locale_t __loc) {183 return strtod_l(__nptr, __endptr, __loc);184}185 186inline _LIBCPP_HIDE_FROM_ABI long double __strtold(const char* __nptr, char** __endptr, __locale_t __loc) {187 return strtold_l(__nptr, __endptr, __loc);188}189 190//191// Character manipulation functions192//193# if defined(_LIBCPP_BUILDING_LIBRARY)194inline _LIBCPP_HIDE_FROM_ABI int __strcoll(const char* __s1, const char* __s2, __locale_t __loc) {195 return strcoll_l(__s1, __s2, __loc);196}197inline _LIBCPP_HIDE_FROM_ABI size_t __strxfrm(char* __dest, const char* __src, size_t __n, __locale_t __loc) {198 return strxfrm_l(__dest, __src, __n, __loc);199}200inline _LIBCPP_HIDE_FROM_ABI int __toupper(int __ch, __locale_t __loc) { return toupper_l(__ch, __loc); }201inline _LIBCPP_HIDE_FROM_ABI int __tolower(int __ch, __locale_t __loc) { return tolower_l(__ch, __loc); }202 203# if _LIBCPP_HAS_WIDE_CHARACTERS204inline _LIBCPP_HIDE_FROM_ABI int __wcscoll(const wchar_t* __s1, const wchar_t* __s2, __locale_t __loc) {205 return wcscoll_l(__s1, __s2, __loc);206}207inline _LIBCPP_HIDE_FROM_ABI size_t __wcsxfrm(wchar_t* __dest, const wchar_t* __src, size_t __n, __locale_t __loc) {208 return wcsxfrm_l(__dest, __src, __n, __loc);209}210inline _LIBCPP_HIDE_FROM_ABI int __iswctype(wint_t __ch, wctype_t __type, __locale_t __loc) {211 return iswctype_l(__ch, __type, __loc);212}213inline _LIBCPP_HIDE_FROM_ABI int __iswspace(wint_t __ch, __locale_t __loc) { return iswspace_l(__ch, __loc); }214inline _LIBCPP_HIDE_FROM_ABI int __iswprint(wint_t __ch, __locale_t __loc) { return iswprint_l(__ch, __loc); }215inline _LIBCPP_HIDE_FROM_ABI int __iswcntrl(wint_t __ch, __locale_t __loc) { return iswcntrl_l(__ch, __loc); }216inline _LIBCPP_HIDE_FROM_ABI int __iswupper(wint_t __ch, __locale_t __loc) { return iswupper_l(__ch, __loc); }217inline _LIBCPP_HIDE_FROM_ABI int __iswlower(wint_t __ch, __locale_t __loc) { return iswlower_l(__ch, __loc); }218inline _LIBCPP_HIDE_FROM_ABI int __iswalpha(wint_t __ch, __locale_t __loc) { return iswalpha_l(__ch, __loc); }219inline _LIBCPP_HIDE_FROM_ABI int __iswblank(wint_t __ch, __locale_t __loc) { return iswblank_l(__ch, __loc); }220inline _LIBCPP_HIDE_FROM_ABI int __iswdigit(wint_t __ch, __locale_t __loc) { return iswdigit_l(__ch, __loc); }221inline _LIBCPP_HIDE_FROM_ABI int __iswpunct(wint_t __ch, __locale_t __loc) { return iswpunct_l(__ch, __loc); }222inline _LIBCPP_HIDE_FROM_ABI int __iswxdigit(wint_t __ch, __locale_t __loc) { return iswxdigit_l(__ch, __loc); }223inline _LIBCPP_HIDE_FROM_ABI wint_t __towupper(wint_t __ch, __locale_t __loc) { return towupper_l(__ch, __loc); }224inline _LIBCPP_HIDE_FROM_ABI wint_t __towlower(wint_t __ch, __locale_t __loc) { return towlower_l(__ch, __loc); }225# endif226 227inline _LIBCPP_HIDE_FROM_ABI size_t228__strftime(char* __s, size_t __max, const char* __format, const tm* __tm, __locale_t __loc) {229 return strftime_l(__s, __max, __format, __tm, __loc);230}231 232//233// Other functions234//235inline _LIBCPP_HIDE_FROM_ABI decltype(__libcpp_mb_cur_max_l(__locale_t())) __mb_len_max(__locale_t __loc) {236 return __libcpp_mb_cur_max_l(__loc);237}238# if _LIBCPP_HAS_WIDE_CHARACTERS239inline _LIBCPP_HIDE_FROM_ABI wint_t __btowc(int __ch, __locale_t __loc) { return __libcpp_btowc_l(__ch, __loc); }240inline _LIBCPP_HIDE_FROM_ABI int __wctob(wint_t __ch, __locale_t __loc) { return __libcpp_wctob_l(__ch, __loc); }241inline _LIBCPP_HIDE_FROM_ABI size_t242__wcsnrtombs(char* __dest, const wchar_t** __src, size_t __nwc, size_t __len, mbstate_t* __ps, __locale_t __loc) {243 return __libcpp_wcsnrtombs_l(__dest, __src, __nwc, __len, __ps, __loc);244}245inline _LIBCPP_HIDE_FROM_ABI size_t __wcrtomb(char* __s, wchar_t __ch, mbstate_t* __ps, __locale_t __loc) {246 return __libcpp_wcrtomb_l(__s, __ch, __ps, __loc);247}248inline _LIBCPP_HIDE_FROM_ABI size_t249__mbsnrtowcs(wchar_t* __dest, const char** __src, size_t __nms, size_t __len, mbstate_t* __ps, __locale_t __loc) {250 return __libcpp_mbsnrtowcs_l(__dest, __src, __nms, __len, __ps, __loc);251}252inline _LIBCPP_HIDE_FROM_ABI size_t253__mbrtowc(wchar_t* __pwc, const char* __s, size_t __n, mbstate_t* __ps, __locale_t __loc) {254 return __libcpp_mbrtowc_l(__pwc, __s, __n, __ps, __loc);255}256inline _LIBCPP_HIDE_FROM_ABI int __mbtowc(wchar_t* __pwc, const char* __pmb, size_t __max, __locale_t __loc) {257 return __libcpp_mbtowc_l(__pwc, __pmb, __max, __loc);258}259inline _LIBCPP_HIDE_FROM_ABI size_t __mbrlen(const char* __s, size_t __n, mbstate_t* __ps, __locale_t __loc) {260 return __libcpp_mbrlen_l(__s, __n, __ps, __loc);261}262inline _LIBCPP_HIDE_FROM_ABI size_t263__mbsrtowcs(wchar_t* __dest, const char** __src, size_t __len, mbstate_t* __ps, __locale_t __loc) {264 return __libcpp_mbsrtowcs_l(__dest, __src, __len, __ps, __loc);265}266# endif // _LIBCPP_HAS_WIDE_CHARACTERS267# endif // _LIBCPP_BUILDING_LIBRARY268 269_LIBCPP_DIAGNOSTIC_PUSH270_LIBCPP_CLANG_DIAGNOSTIC_IGNORED("-Wgcc-compat")271_LIBCPP_GCC_DIAGNOSTIC_IGNORED("-Wformat-nonliteral") // GCC doesn't support [[gnu::format]] on variadic templates272# ifdef _LIBCPP_COMPILER_CLANG_BASED273# define _LIBCPP_VARIADIC_ATTRIBUTE_FORMAT(...) _LIBCPP_ATTRIBUTE_FORMAT(__VA_ARGS__)274# else275# define _LIBCPP_VARIADIC_ATTRIBUTE_FORMAT(...) /* nothing */276# endif277 278template <class... _Args>279_LIBCPP_HIDE_FROM_ABI _LIBCPP_VARIADIC_ATTRIBUTE_FORMAT(__printf__, 4, 5) int __snprintf(280 char* __s, size_t __n, __locale_t __loc, const char* __format, _Args&&... __args) {281 return std::__libcpp_snprintf_l(__s, __n, __loc, __format, std::forward<_Args>(__args)...);282}283template <class... _Args>284_LIBCPP_HIDE_FROM_ABI _LIBCPP_VARIADIC_ATTRIBUTE_FORMAT(__printf__, 3, 4) int __asprintf(285 char** __s, __locale_t __loc, const char* __format, _Args&&... __args) {286 return std::__libcpp_asprintf_l(__s, __loc, __format, std::forward<_Args>(__args)...);287}288_LIBCPP_DIAGNOSTIC_POP289# undef _LIBCPP_VARIADIC_ATTRIBUTE_FORMAT290 291} // namespace __locale292_LIBCPP_END_NAMESPACE_STD293 294# endif // Compatibility definition of locale base APIs295 296#endif // _LIBCPP_HAS_LOCALIZATION297 298#endif // _LIBCPP___LOCALE_DIR_LOCALE_BASE_API_H299