master
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// Most of these functions are only required when building the library. Functions that are also
27// 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_t
30// TODO: Eliminate the need for any of these functions from the headers.
31//
32// Locale management
33// -----------------
34// namespace __locale {
35// using __locale_t = implementation-defined; // required by the headers
36// 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 headers
44// #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 functions
54// ------------------
55// namespace __locale {
56// // required by the headers
57// 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// long long __strtoll(const char*, char**, __locale_t);
61// unsigned long long __strtoull(const char*, char**, __locale_t);
62// }
63//
64// Character manipulation functions
65// --------------------------------
66// namespace __locale {
67// int __isdigit(int, __locale_t); // required by the headers
68// int __isxdigit(int, __locale_t); // required by the headers
69// int __toupper(int, __locale_t);
70// int __tolower(int, __locale_t);
71// int __strcoll(const char*, const char*, __locale_t);
72// size_t __strxfrm(char*, const char*, size_t, __locale_t);
73//
74// int __iswctype(wint_t, wctype_t, __locale_t);
75// int __iswspace(wint_t, __locale_t);
76// int __iswprint(wint_t, __locale_t);
77// int __iswcntrl(wint_t, __locale_t);
78// int __iswupper(wint_t, __locale_t);
79// int __iswlower(wint_t, __locale_t);
80// int __iswalpha(wint_t, __locale_t);
81// int __iswblank(wint_t, __locale_t);
82// int __iswdigit(wint_t, __locale_t);
83// int __iswpunct(wint_t, __locale_t);
84// int __iswxdigit(wint_t, __locale_t);
85// wint_t __towupper(wint_t, __locale_t);
86// wint_t __towlower(wint_t, __locale_t);
87// int __wcscoll(const wchar_t*, const wchar_t*, __locale_t);
88// size_t __wcsxfrm(wchar_t*, const wchar_t*, size_t, __locale_t);
89//
90// size_t __strftime(char*, size_t, const char*, const tm*, __locale_t);
91// }
92//
93// Other functions
94// ---------------
95// namespace __locale {
96// implementation-defined __mb_len_max(__locale_t);
97// wint_t __btowc(int, __locale_t);
98// int __wctob(wint_t, __locale_t);
99// size_t __wcsnrtombs(char*, const wchar_t**, size_t, size_t, mbstate_t*, __locale_t);
100// size_t __wcrtomb(char*, wchar_t, mbstate_t*, __locale_t);
101// size_t __mbsnrtowcs(wchar_t*, const char**, size_t, size_t, mbstate_t*, __locale_t);
102// size_t __mbrtowc(wchar_t*, const char*, size_t, mbstate_t*, __locale_t);
103// int __mbtowc(wchar_t*, const char*, size_t, __locale_t);
104// size_t __mbrlen(const char*, size_t, mbstate_t*, __locale_t);
105// size_t __mbsrtowcs(wchar_t*, const char**, size_t, mbstate_t*, __locale_t);
106//
107// int __snprintf(char*, size_t, __locale_t, const char*, ...); // required by the headers
108// int __asprintf(char**, __locale_t, const char*, ...); // required by the headers
109// int __sscanf(const char*, __locale_t, const char*, ...); // required by the headers
110// }
111
112#if _LIBCPP_HAS_LOCALIZATION
113
114# if defined(__APPLE__)
115# include <__locale_dir/support/apple.h>
116# elif defined(__FreeBSD__)
117# include <__locale_dir/support/freebsd.h>
118/* zig patch: https://github.com/llvm/llvm-project/pull/143055 */
119# elif defined(__NetBSD__)
120# include <__locale_dir/support/netbsd.h>
121# elif defined(_LIBCPP_MSVCRT_LIKE)
122# include <__locale_dir/support/windows.h>
123# elif defined(__Fuchsia__)
124# include <__locale_dir/support/fuchsia.h>
125# elif defined(__linux__)
126# include <__locale_dir/support/linux.h>
127# else
128
129// TODO: This is a temporary definition to bridge between the old way we defined the locale base API
130// (by providing global non-reserved names) and the new API. As we move individual platforms
131// towards the new way of defining the locale base API, this should disappear since each platform
132// will define those directly.
133# if defined(_AIX) || defined(__MVS__)
134# include <__locale_dir/locale_base_api/ibm.h>
135# elif defined(__ANDROID__)
136# include <__locale_dir/locale_base_api/android.h>
137# elif defined(__OpenBSD__)
138# include <__locale_dir/locale_base_api/openbsd.h>
139# elif defined(__wasi__) || _LIBCPP_HAS_MUSL_LIBC
140# include <__locale_dir/locale_base_api/musl.h>
141# endif
142
143# include <__locale_dir/locale_base_api/bsd_locale_fallbacks.h>
144
145# include <__cstddef/size_t.h>
146# include <__utility/forward.h>
147# include <ctype.h>
148# include <string.h>
149# include <time.h>
150# if _LIBCPP_HAS_WIDE_CHARACTERS
151# include <wctype.h>
152# endif
153_LIBCPP_BEGIN_NAMESPACE_STD
154namespace __locale {
155//
156// Locale management
157//
158# define _LIBCPP_COLLATE_MASK LC_COLLATE_MASK
159# define _LIBCPP_CTYPE_MASK LC_CTYPE_MASK
160# define _LIBCPP_MONETARY_MASK LC_MONETARY_MASK
161# define _LIBCPP_NUMERIC_MASK LC_NUMERIC_MASK
162# define _LIBCPP_TIME_MASK LC_TIME_MASK
163# define _LIBCPP_MESSAGES_MASK LC_MESSAGES_MASK
164# define _LIBCPP_ALL_MASK LC_ALL_MASK
165# define _LIBCPP_LC_ALL LC_ALL
166
167using __locale_t _LIBCPP_NODEBUG = locale_t;
168
169# if defined(_LIBCPP_BUILDING_LIBRARY)
170using __lconv_t _LIBCPP_NODEBUG = lconv;
171
172inline _LIBCPP_HIDE_FROM_ABI __locale_t __newlocale(int __category_mask, const char* __name, __locale_t __loc) {
173 return newlocale(__category_mask, __name, __loc);
174}
175
176inline _LIBCPP_HIDE_FROM_ABI char* __setlocale(int __category, char const* __locale) {
177 return ::setlocale(__category, __locale);
178}
179
180inline _LIBCPP_HIDE_FROM_ABI void __freelocale(__locale_t __loc) { freelocale(__loc); }
181
182inline _LIBCPP_HIDE_FROM_ABI __lconv_t* __localeconv(__locale_t& __loc) { return __libcpp_localeconv_l(__loc); }
183# endif // _LIBCPP_BUILDING_LIBRARY
184
185//
186// Strtonum functions
187//
188inline _LIBCPP_HIDE_FROM_ABI float __strtof(const char* __nptr, char** __endptr, __locale_t __loc) {
189 return strtof_l(__nptr, __endptr, __loc);
190}
191
192inline _LIBCPP_HIDE_FROM_ABI double __strtod(const char* __nptr, char** __endptr, __locale_t __loc) {
193 return strtod_l(__nptr, __endptr, __loc);
194}
195
196inline _LIBCPP_HIDE_FROM_ABI long double __strtold(const char* __nptr, char** __endptr, __locale_t __loc) {
197 return strtold_l(__nptr, __endptr, __loc);
198}
199
200inline _LIBCPP_HIDE_FROM_ABI long long __strtoll(const char* __nptr, char** __endptr, int __base, __locale_t __loc) {
201 return strtoll_l(__nptr, __endptr, __base, __loc);
202}
203
204inline _LIBCPP_HIDE_FROM_ABI unsigned long long
205__strtoull(const char* __nptr, char** __endptr, int __base, __locale_t __loc) {
206 return strtoull_l(__nptr, __endptr, __base, __loc);
207}
208
209//
210// Character manipulation functions
211//
212inline _LIBCPP_HIDE_FROM_ABI int __isdigit(int __ch, __locale_t __loc) { return isdigit_l(__ch, __loc); }
213inline _LIBCPP_HIDE_FROM_ABI int __isxdigit(int __ch, __locale_t __loc) { return isxdigit_l(__ch, __loc); }
214
215# if defined(_LIBCPP_BUILDING_LIBRARY)
216inline _LIBCPP_HIDE_FROM_ABI int __strcoll(const char* __s1, const char* __s2, __locale_t __loc) {
217 return strcoll_l(__s1, __s2, __loc);
218}
219inline _LIBCPP_HIDE_FROM_ABI size_t __strxfrm(char* __dest, const char* __src, size_t __n, __locale_t __loc) {
220 return strxfrm_l(__dest, __src, __n, __loc);
221}
222inline _LIBCPP_HIDE_FROM_ABI int __toupper(int __ch, __locale_t __loc) { return toupper_l(__ch, __loc); }
223inline _LIBCPP_HIDE_FROM_ABI int __tolower(int __ch, __locale_t __loc) { return tolower_l(__ch, __loc); }
224
225# if _LIBCPP_HAS_WIDE_CHARACTERS
226inline _LIBCPP_HIDE_FROM_ABI int __wcscoll(const wchar_t* __s1, const wchar_t* __s2, __locale_t __loc) {
227 return wcscoll_l(__s1, __s2, __loc);
228}
229inline _LIBCPP_HIDE_FROM_ABI size_t __wcsxfrm(wchar_t* __dest, const wchar_t* __src, size_t __n, __locale_t __loc) {
230 return wcsxfrm_l(__dest, __src, __n, __loc);
231}
232inline _LIBCPP_HIDE_FROM_ABI int __iswctype(wint_t __ch, wctype_t __type, __locale_t __loc) {
233 return iswctype_l(__ch, __type, __loc);
234}
235inline _LIBCPP_HIDE_FROM_ABI int __iswspace(wint_t __ch, __locale_t __loc) { return iswspace_l(__ch, __loc); }
236inline _LIBCPP_HIDE_FROM_ABI int __iswprint(wint_t __ch, __locale_t __loc) { return iswprint_l(__ch, __loc); }
237inline _LIBCPP_HIDE_FROM_ABI int __iswcntrl(wint_t __ch, __locale_t __loc) { return iswcntrl_l(__ch, __loc); }
238inline _LIBCPP_HIDE_FROM_ABI int __iswupper(wint_t __ch, __locale_t __loc) { return iswupper_l(__ch, __loc); }
239inline _LIBCPP_HIDE_FROM_ABI int __iswlower(wint_t __ch, __locale_t __loc) { return iswlower_l(__ch, __loc); }
240inline _LIBCPP_HIDE_FROM_ABI int __iswalpha(wint_t __ch, __locale_t __loc) { return iswalpha_l(__ch, __loc); }
241inline _LIBCPP_HIDE_FROM_ABI int __iswblank(wint_t __ch, __locale_t __loc) { return iswblank_l(__ch, __loc); }
242inline _LIBCPP_HIDE_FROM_ABI int __iswdigit(wint_t __ch, __locale_t __loc) { return iswdigit_l(__ch, __loc); }
243inline _LIBCPP_HIDE_FROM_ABI int __iswpunct(wint_t __ch, __locale_t __loc) { return iswpunct_l(__ch, __loc); }
244inline _LIBCPP_HIDE_FROM_ABI int __iswxdigit(wint_t __ch, __locale_t __loc) { return iswxdigit_l(__ch, __loc); }
245inline _LIBCPP_HIDE_FROM_ABI wint_t __towupper(wint_t __ch, __locale_t __loc) { return towupper_l(__ch, __loc); }
246inline _LIBCPP_HIDE_FROM_ABI wint_t __towlower(wint_t __ch, __locale_t __loc) { return towlower_l(__ch, __loc); }
247# endif
248
249inline _LIBCPP_HIDE_FROM_ABI size_t
250__strftime(char* __s, size_t __max, const char* __format, const tm* __tm, __locale_t __loc) {
251 return strftime_l(__s, __max, __format, __tm, __loc);
252}
253
254//
255// Other functions
256//
257inline _LIBCPP_HIDE_FROM_ABI decltype(__libcpp_mb_cur_max_l(__locale_t())) __mb_len_max(__locale_t __loc) {
258 return __libcpp_mb_cur_max_l(__loc);
259}
260# if _LIBCPP_HAS_WIDE_CHARACTERS
261inline _LIBCPP_HIDE_FROM_ABI wint_t __btowc(int __ch, __locale_t __loc) { return __libcpp_btowc_l(__ch, __loc); }
262inline _LIBCPP_HIDE_FROM_ABI int __wctob(wint_t __ch, __locale_t __loc) { return __libcpp_wctob_l(__ch, __loc); }
263inline _LIBCPP_HIDE_FROM_ABI size_t
264__wcsnrtombs(char* __dest, const wchar_t** __src, size_t __nwc, size_t __len, mbstate_t* __ps, __locale_t __loc) {
265 return __libcpp_wcsnrtombs_l(__dest, __src, __nwc, __len, __ps, __loc);
266}
267inline _LIBCPP_HIDE_FROM_ABI size_t __wcrtomb(char* __s, wchar_t __ch, mbstate_t* __ps, __locale_t __loc) {
268 return __libcpp_wcrtomb_l(__s, __ch, __ps, __loc);
269}
270inline _LIBCPP_HIDE_FROM_ABI size_t
271__mbsnrtowcs(wchar_t* __dest, const char** __src, size_t __nms, size_t __len, mbstate_t* __ps, __locale_t __loc) {
272 return __libcpp_mbsnrtowcs_l(__dest, __src, __nms, __len, __ps, __loc);
273}
274inline _LIBCPP_HIDE_FROM_ABI size_t
275__mbrtowc(wchar_t* __pwc, const char* __s, size_t __n, mbstate_t* __ps, __locale_t __loc) {
276 return __libcpp_mbrtowc_l(__pwc, __s, __n, __ps, __loc);
277}
278inline _LIBCPP_HIDE_FROM_ABI int __mbtowc(wchar_t* __pwc, const char* __pmb, size_t __max, __locale_t __loc) {
279 return __libcpp_mbtowc_l(__pwc, __pmb, __max, __loc);
280}
281inline _LIBCPP_HIDE_FROM_ABI size_t __mbrlen(const char* __s, size_t __n, mbstate_t* __ps, __locale_t __loc) {
282 return __libcpp_mbrlen_l(__s, __n, __ps, __loc);
283}
284inline _LIBCPP_HIDE_FROM_ABI size_t
285__mbsrtowcs(wchar_t* __dest, const char** __src, size_t __len, mbstate_t* __ps, __locale_t __loc) {
286 return __libcpp_mbsrtowcs_l(__dest, __src, __len, __ps, __loc);
287}
288# endif // _LIBCPP_HAS_WIDE_CHARACTERS
289# endif // _LIBCPP_BUILDING_LIBRARY
290
291_LIBCPP_DIAGNOSTIC_PUSH
292_LIBCPP_CLANG_DIAGNOSTIC_IGNORED("-Wgcc-compat")
293_LIBCPP_GCC_DIAGNOSTIC_IGNORED("-Wformat-nonliteral") // GCC doesn't support [[gnu::format]] on variadic templates
294# ifdef _LIBCPP_COMPILER_CLANG_BASED
295# define _LIBCPP_VARIADIC_ATTRIBUTE_FORMAT(...) _LIBCPP_ATTRIBUTE_FORMAT(__VA_ARGS__)
296# else
297# define _LIBCPP_VARIADIC_ATTRIBUTE_FORMAT(...) /* nothing */
298# endif
299
300template <class... _Args>
301_LIBCPP_HIDE_FROM_ABI _LIBCPP_VARIADIC_ATTRIBUTE_FORMAT(__printf__, 4, 5) int __snprintf(
302 char* __s, size_t __n, __locale_t __loc, const char* __format, _Args&&... __args) {
303 return std::__libcpp_snprintf_l(__s, __n, __loc, __format, std::forward<_Args>(__args)...);
304}
305template <class... _Args>
306_LIBCPP_HIDE_FROM_ABI _LIBCPP_VARIADIC_ATTRIBUTE_FORMAT(__printf__, 3, 4) int __asprintf(
307 char** __s, __locale_t __loc, const char* __format, _Args&&... __args) {
308 return std::__libcpp_asprintf_l(__s, __loc, __format, std::forward<_Args>(__args)...);
309}
310template <class... _Args>
311_LIBCPP_HIDE_FROM_ABI _LIBCPP_VARIADIC_ATTRIBUTE_FORMAT(__scanf__, 3, 4) int __sscanf(
312 const char* __s, __locale_t __loc, const char* __format, _Args&&... __args) {
313 return std::__libcpp_sscanf_l(__s, __loc, __format, std::forward<_Args>(__args)...);
314}
315_LIBCPP_DIAGNOSTIC_POP
316# undef _LIBCPP_VARIADIC_ATTRIBUTE_FORMAT
317
318} // namespace __locale
319_LIBCPP_END_NAMESPACE_STD
320
321# endif // Compatibility definition of locale base APIs
322
323#endif // _LIBCPP_HAS_LOCALIZATION
324
325#endif // _LIBCPP___LOCALE_DIR_LOCALE_BASE_API_H