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