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// }
61//
62// Character manipulation functions
63// --------------------------------
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 functions
90// ---------------
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 headers
104// int __asprintf(char**, __locale_t, const char*, ...); // required by the headers
105// }
106
107#if _LIBCPP_HAS_LOCALIZATION
108
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# elif _LIBCPP_LIBC_NEWLIB
122# include <__locale_dir/support/newlib.h>
123# elif defined(_AIX)
124# include <__locale_dir/support/aix.h>
125# else
126
127// TODO: This is a temporary definition to bridge between the old way we defined the locale base API
128// (by providing global non-reserved names) and the new API. As we move individual platforms
129// towards the new way of defining the locale base API, this should disappear since each platform
130// will define those directly.
131# if defined(__MVS__)
132# include <__locale_dir/locale_base_api/ibm.h>
133# elif defined(__OpenBSD__)
134# include <__locale_dir/locale_base_api/openbsd.h>
135# endif
136
137# include <__locale_dir/locale_base_api/bsd_locale_fallbacks.h>
138
139# include <__cstddef/size_t.h>
140# include <__utility/forward.h>
141# include <ctype.h>
142# include <string.h>
143# include <time.h>
144# if _LIBCPP_HAS_WIDE_CHARACTERS
145# include <wctype.h>
146# endif
147_LIBCPP_BEGIN_NAMESPACE_STD
148namespace __locale {
149//
150// Locale management
151//
152# define _LIBCPP_COLLATE_MASK LC_COLLATE_MASK
153# define _LIBCPP_CTYPE_MASK LC_CTYPE_MASK
154# define _LIBCPP_MONETARY_MASK LC_MONETARY_MASK
155# define _LIBCPP_NUMERIC_MASK LC_NUMERIC_MASK
156# define _LIBCPP_TIME_MASK LC_TIME_MASK
157# define _LIBCPP_MESSAGES_MASK LC_MESSAGES_MASK
158# define _LIBCPP_ALL_MASK LC_ALL_MASK
159# define _LIBCPP_LC_ALL LC_ALL
160
161using __locale_t _LIBCPP_NODEBUG = locale_t;
162
163# if defined(_LIBCPP_BUILDING_LIBRARY)
164using __lconv_t _LIBCPP_NODEBUG = lconv;
165
166inline _LIBCPP_HIDE_FROM_ABI __locale_t __newlocale(int __category_mask, const char* __name, __locale_t __loc) {
167 return newlocale(__category_mask, __name, __loc);
168}
169
170inline _LIBCPP_HIDE_FROM_ABI char* __setlocale(int __category, char const* __locale) {
171 return ::setlocale(__category, __locale);
172}
173
174inline _LIBCPP_HIDE_FROM_ABI void __freelocale(__locale_t __loc) { freelocale(__loc); }
175
176inline _LIBCPP_HIDE_FROM_ABI __lconv_t* __localeconv(__locale_t& __loc) { return __libcpp_localeconv_l(__loc); }
177# endif // _LIBCPP_BUILDING_LIBRARY
178
179//
180// Strtonum functions
181//
182inline _LIBCPP_HIDE_FROM_ABI float __strtof(const char* __nptr, char** __endptr, __locale_t __loc) {
183 return strtof_l(__nptr, __endptr, __loc);
184}
185
186inline _LIBCPP_HIDE_FROM_ABI double __strtod(const char* __nptr, char** __endptr, __locale_t __loc) {
187 return strtod_l(__nptr, __endptr, __loc);
188}
189
190inline _LIBCPP_HIDE_FROM_ABI long double __strtold(const char* __nptr, char** __endptr, __locale_t __loc) {
191 return strtold_l(__nptr, __endptr, __loc);
192}
193
194//
195// Character manipulation functions
196//
197# if defined(_LIBCPP_BUILDING_LIBRARY)
198inline _LIBCPP_HIDE_FROM_ABI int __strcoll(const char* __s1, const char* __s2, __locale_t __loc) {
199 return strcoll_l(__s1, __s2, __loc);
200}
201inline _LIBCPP_HIDE_FROM_ABI size_t __strxfrm(char* __dest, const char* __src, size_t __n, __locale_t __loc) {
202 return strxfrm_l(__dest, __src, __n, __loc);
203}
204inline _LIBCPP_HIDE_FROM_ABI int __toupper(int __ch, __locale_t __loc) { return toupper_l(__ch, __loc); }
205inline _LIBCPP_HIDE_FROM_ABI int __tolower(int __ch, __locale_t __loc) { return tolower_l(__ch, __loc); }
206
207# if _LIBCPP_HAS_WIDE_CHARACTERS
208inline _LIBCPP_HIDE_FROM_ABI int __wcscoll(const wchar_t* __s1, const wchar_t* __s2, __locale_t __loc) {
209 return wcscoll_l(__s1, __s2, __loc);
210}
211inline _LIBCPP_HIDE_FROM_ABI size_t __wcsxfrm(wchar_t* __dest, const wchar_t* __src, size_t __n, __locale_t __loc) {
212 return wcsxfrm_l(__dest, __src, __n, __loc);
213}
214inline _LIBCPP_HIDE_FROM_ABI int __iswctype(wint_t __ch, wctype_t __type, __locale_t __loc) {
215 return iswctype_l(__ch, __type, __loc);
216}
217inline _LIBCPP_HIDE_FROM_ABI int __iswspace(wint_t __ch, __locale_t __loc) { return iswspace_l(__ch, __loc); }
218inline _LIBCPP_HIDE_FROM_ABI int __iswprint(wint_t __ch, __locale_t __loc) { return iswprint_l(__ch, __loc); }
219inline _LIBCPP_HIDE_FROM_ABI int __iswcntrl(wint_t __ch, __locale_t __loc) { return iswcntrl_l(__ch, __loc); }
220inline _LIBCPP_HIDE_FROM_ABI int __iswupper(wint_t __ch, __locale_t __loc) { return iswupper_l(__ch, __loc); }
221inline _LIBCPP_HIDE_FROM_ABI int __iswlower(wint_t __ch, __locale_t __loc) { return iswlower_l(__ch, __loc); }
222inline _LIBCPP_HIDE_FROM_ABI int __iswalpha(wint_t __ch, __locale_t __loc) { return iswalpha_l(__ch, __loc); }
223inline _LIBCPP_HIDE_FROM_ABI int __iswblank(wint_t __ch, __locale_t __loc) { return iswblank_l(__ch, __loc); }
224inline _LIBCPP_HIDE_FROM_ABI int __iswdigit(wint_t __ch, __locale_t __loc) { return iswdigit_l(__ch, __loc); }
225inline _LIBCPP_HIDE_FROM_ABI int __iswpunct(wint_t __ch, __locale_t __loc) { return iswpunct_l(__ch, __loc); }
226inline _LIBCPP_HIDE_FROM_ABI int __iswxdigit(wint_t __ch, __locale_t __loc) { return iswxdigit_l(__ch, __loc); }
227inline _LIBCPP_HIDE_FROM_ABI wint_t __towupper(wint_t __ch, __locale_t __loc) { return towupper_l(__ch, __loc); }
228inline _LIBCPP_HIDE_FROM_ABI wint_t __towlower(wint_t __ch, __locale_t __loc) { return towlower_l(__ch, __loc); }
229# endif
230
231inline _LIBCPP_HIDE_FROM_ABI size_t
232__strftime(char* __s, size_t __max, const char* __format, const tm* __tm, __locale_t __loc) {
233 return strftime_l(__s, __max, __format, __tm, __loc);
234}
235
236//
237// Other functions
238//
239inline _LIBCPP_HIDE_FROM_ABI decltype(__libcpp_mb_cur_max_l(__locale_t())) __mb_len_max(__locale_t __loc) {
240 return __libcpp_mb_cur_max_l(__loc);
241}
242# if _LIBCPP_HAS_WIDE_CHARACTERS
243inline _LIBCPP_HIDE_FROM_ABI wint_t __btowc(int __ch, __locale_t __loc) { return __libcpp_btowc_l(__ch, __loc); }
244inline _LIBCPP_HIDE_FROM_ABI int __wctob(wint_t __ch, __locale_t __loc) { return __libcpp_wctob_l(__ch, __loc); }
245inline _LIBCPP_HIDE_FROM_ABI size_t
246__wcsnrtombs(char* __dest, const wchar_t** __src, size_t __nwc, size_t __len, mbstate_t* __ps, __locale_t __loc) {
247 return __libcpp_wcsnrtombs_l(__dest, __src, __nwc, __len, __ps, __loc);
248}
249inline _LIBCPP_HIDE_FROM_ABI size_t __wcrtomb(char* __s, wchar_t __ch, mbstate_t* __ps, __locale_t __loc) {
250 return __libcpp_wcrtomb_l(__s, __ch, __ps, __loc);
251}
252inline _LIBCPP_HIDE_FROM_ABI size_t
253__mbsnrtowcs(wchar_t* __dest, const char** __src, size_t __nms, size_t __len, mbstate_t* __ps, __locale_t __loc) {
254 return __libcpp_mbsnrtowcs_l(__dest, __src, __nms, __len, __ps, __loc);
255}
256inline _LIBCPP_HIDE_FROM_ABI size_t
257__mbrtowc(wchar_t* __pwc, const char* __s, size_t __n, mbstate_t* __ps, __locale_t __loc) {
258 return __libcpp_mbrtowc_l(__pwc, __s, __n, __ps, __loc);
259}
260inline _LIBCPP_HIDE_FROM_ABI int __mbtowc(wchar_t* __pwc, const char* __pmb, size_t __max, __locale_t __loc) {
261 return __libcpp_mbtowc_l(__pwc, __pmb, __max, __loc);
262}
263inline _LIBCPP_HIDE_FROM_ABI size_t __mbrlen(const char* __s, size_t __n, mbstate_t* __ps, __locale_t __loc) {
264 return __libcpp_mbrlen_l(__s, __n, __ps, __loc);
265}
266inline _LIBCPP_HIDE_FROM_ABI size_t
267__mbsrtowcs(wchar_t* __dest, const char** __src, size_t __len, mbstate_t* __ps, __locale_t __loc) {
268 return __libcpp_mbsrtowcs_l(__dest, __src, __len, __ps, __loc);
269}
270# endif // _LIBCPP_HAS_WIDE_CHARACTERS
271# endif // _LIBCPP_BUILDING_LIBRARY
272
273_LIBCPP_DIAGNOSTIC_PUSH
274_LIBCPP_CLANG_DIAGNOSTIC_IGNORED("-Wgcc-compat")
275_LIBCPP_GCC_DIAGNOSTIC_IGNORED("-Wformat-nonliteral") // GCC doesn't support [[gnu::format]] on variadic templates
276# ifdef _LIBCPP_COMPILER_CLANG_BASED
277# define _LIBCPP_VARIADIC_ATTRIBUTE_FORMAT(...) _LIBCPP_ATTRIBUTE_FORMAT(__VA_ARGS__)
278# else
279# define _LIBCPP_VARIADIC_ATTRIBUTE_FORMAT(...) /* nothing */
280# endif
281
282template <class... _Args>
283_LIBCPP_HIDE_FROM_ABI _LIBCPP_VARIADIC_ATTRIBUTE_FORMAT(__printf__, 4, 5) int __snprintf(
284 char* __s, size_t __n, __locale_t __loc, const char* __format, _Args&&... __args) {
285 return std::__libcpp_snprintf_l(__s, __n, __loc, __format, std::forward<_Args>(__args)...);
286}
287template <class... _Args>
288_LIBCPP_HIDE_FROM_ABI _LIBCPP_VARIADIC_ATTRIBUTE_FORMAT(__printf__, 3, 4) int __asprintf(
289 char** __s, __locale_t __loc, const char* __format, _Args&&... __args) {
290 return std::__libcpp_asprintf_l(__s, __loc, __format, std::forward<_Args>(__args)...);
291}
292_LIBCPP_DIAGNOSTIC_POP
293# undef _LIBCPP_VARIADIC_ATTRIBUTE_FORMAT
294
295} // namespace __locale
296_LIBCPP_END_NAMESPACE_STD
297
298# endif // Compatibility definition of locale base APIs
299
300#endif // _LIBCPP_HAS_LOCALIZATION
301
302#endif // _LIBCPP___LOCALE_DIR_LOCALE_BASE_API_H
303