1 // <format> Formatting -*- C++ -*-
3 // Copyright The GNU Toolchain Authors.
5 // This file is part of the GNU ISO C++ Library. This library is free
6 // software; you can redistribute it and/or modify it under the
7 // terms of the GNU General Public License as published by the
8 // Free Software Foundation; either version 3, or (at your option)
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 // GNU General Public License for more details.
16 // Under Section 7 of GPL version 3, you are granted additional
17 // permissions described in the GCC Runtime Library Exception, version
18 // 3.1, as published by the Free Software Foundation.
20 // You should have received a copy of the GNU General Public License and
21 // a copy of the GCC Runtime Library Exception along with this program;
22 // see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
23 // <http://www.gnu.org/licenses/>.
25 /** @file include/format
26 * This is a Standard C++ Library header.
29 #ifndef _GLIBCXX_FORMAT
30 #define _GLIBCXX_FORMAT 1
32 #ifdef _GLIBCXX_SYSHDR
33 #pragma GCC system_header
36 #include <bits/requires_hosted.h> // for std::string
38 #define __glibcxx_want_format
39 #define __glibcxx_want_format_ranges
40 #define __glibcxx_want_format_uchar
41 #define __glibcxx_want_constexpr_exceptions
42 #include <bits/version.h>
44 #ifdef __cpp_lib_format // C++ >= 20 && HOSTED
53 #include <string_view>
55 #include <bits/monostate.h>
56 #include <bits/formatfwd.h>
57 #include <bits/ranges_base.h> // input_range, range_reference_t
58 #include <bits/ranges_util.h> // subrange
59 #include <bits/ranges_algobase.h> // ranges::copy
60 #include <bits/stl_iterator.h> // counted_iterator
61 #include <bits/stl_pair.h> // __is_pair
62 #include <bits/unicode.h> // __is_scalar_value, _Utf_view, etc.
63 #include <bits/utility.h> // tuple_size_v
64 #include <ext/numeric_traits.h> // __int_traits
66 #if !__has_builtin(__builtin_toupper)
70 #pragma GCC diagnostic push
71 #pragma GCC diagnostic ignored "-Wpedantic" // __int128
72 #pragma GCC diagnostic ignored "-Wc++23-extensions" // bf16
74 namespace std _GLIBCXX_VISIBILITY(default)
76 _GLIBCXX_BEGIN_NAMESPACE_VERSION
78 // [format.fmt.string], class template basic_format_string
79 template<typename _CharT, typename... _Args> struct basic_format_string;
81 /// @cond undocumented
84 // STATICALLY-WIDEN, see C++20 [time.general]
85 // It doesn't matter for format strings (which can only be char or wchar_t)
86 // but this returns the narrow string for anything that isn't wchar_t. This
87 // is done because const char* can be inserted into any ostream type, and
88 // will be widened at runtime if necessary.
89 template<typename _CharT>
91 _Widen(const char* __narrow, const wchar_t* __wide)
93 if constexpr (is_same_v<_CharT, wchar_t>)
98 #define _GLIBCXX_WIDEN_(C, S) ::std::__format::_Widen<C>(S, L##S)
99 #define _GLIBCXX_WIDEN(S) _GLIBCXX_WIDEN_(_CharT, S)
101 // Size for stack located buffer
102 template<typename _CharT>
103 constexpr size_t __stackbuf_size = 32 * sizeof(void*) / sizeof(_CharT);
105 // Type-erased character sinks.
106 template<typename _CharT> class _Sink;
107 template<typename _CharT> class _Fixedbuf_sink;
108 template<typename _Out, typename _CharT> class _Padding_sink;
109 template<typename _Out, typename _CharT> class _Escaping_sink;
111 // Output iterator that writes to a type-erase character sink.
112 template<typename _CharT>
115 // Output iterator that ignores the characters
116 template<typename _CharT>
119 // An unspecified output iterator type used in the `formattable` concept.
120 template<typename _CharT>
122 { using type = _Drop_iter<_CharT>; };
124 template<typename _CharT>
125 using __format_context = basic_format_context<_Sink_iter<_CharT>, _CharT>;
127 template<typename _CharT>
128 struct _Dynamic_format_string
130 [[__gnu__::__always_inline__]]
131 _Dynamic_format_string(basic_string_view<_CharT> __s) noexcept
134 _Dynamic_format_string(const _Dynamic_format_string&) = delete;
135 void operator=(const _Dynamic_format_string&) = delete;
138 basic_string_view<_CharT> _M_str;
140 template<typename, typename...> friend struct std::basic_format_string;
143 } // namespace __format
146 using format_context = __format::__format_context<char>;
147 #ifdef _GLIBCXX_USE_WCHAR_T
148 using wformat_context = __format::__format_context<wchar_t>;
151 // [format.args], class template basic_format_args
152 template<typename _Context> class basic_format_args;
153 using format_args = basic_format_args<format_context>;
154 #ifdef _GLIBCXX_USE_WCHAR_T
155 using wformat_args = basic_format_args<wformat_context>;
158 // [format.arguments], arguments
159 // [format.arg], class template basic_format_arg
160 template<typename _Context>
161 class basic_format_arg;
163 /** A compile-time checked format string for the specified argument types.
165 * @since C++23 but available as an extension in C++20.
167 template<typename _CharT, typename... _Args>
168 struct basic_format_string
170 template<typename _Tp>
171 requires convertible_to<const _Tp&, basic_string_view<_CharT>>
173 basic_format_string(const _Tp& __s);
175 [[__gnu__::__always_inline__]]
176 basic_format_string(__format::_Dynamic_format_string<_CharT> __s) noexcept
180 [[__gnu__::__always_inline__]]
181 constexpr basic_string_view<_CharT>
186 basic_string_view<_CharT> _M_str;
189 template<typename... _Args>
190 using format_string = basic_format_string<char, type_identity_t<_Args>...>;
192 #ifdef _GLIBCXX_USE_WCHAR_T
193 template<typename... _Args>
195 = basic_format_string<wchar_t, type_identity_t<_Args>...>;
198 #if __cpp_lib_format >= 202603L // >= C++26
199 [[__gnu__::__always_inline__]]
200 inline __format::_Dynamic_format_string<char>
201 dynamic_format(string_view __fmt) noexcept
204 #ifdef _GLIBCXX_USE_WCHAR_T
205 [[__gnu__::__always_inline__]]
206 inline __format::_Dynamic_format_string<wchar_t>
207 dynamic_format(wstring_view __fmt) noexcept
212 // [format.formatter], formatter
214 /// The primary template of std::formatter is disabled.
215 template<typename _Tp, typename _CharT>
218 formatter() = delete; // No std::formatter specialization for this type.
219 formatter(const formatter&) = delete;
220 formatter& operator=(const formatter&) = delete;
223 #if __cpp_lib_constexpr_exceptions >= 202502L
224 #define _GLIBCXX_CONSTEXPR_FORMAT_ERROR constexpr
226 #define _GLIBCXX_CONSTEXPR_FORMAT_ERROR
229 // [format.error], class format_error
230 class format_error : public runtime_error
233 _GLIBCXX_CONSTEXPR_FORMAT_ERROR explicit format_error(const string& __what)
234 : runtime_error(__what) { }
235 _GLIBCXX_CONSTEXPR_FORMAT_ERROR explicit format_error(const char* __what)
236 : runtime_error(__what) { }
239 /// @cond undocumented
242 __throw_format_error(const char* __what)
243 { _GLIBCXX_THROW_OR_ABORT(format_error(__what)); }
245 #undef _GLIBCXX_CONSTEXPR_FORMAT_ERROR
249 // XXX use named functions for each constexpr error?
253 __unmatched_left_brace_in_format_string()
254 { __throw_format_error("format error: unmatched '{' in format string"); }
258 __unmatched_right_brace_in_format_string()
259 { __throw_format_error("format error: unmatched '}' in format string"); }
263 __conflicting_indexing_in_format_string()
264 { __throw_format_error("format error: conflicting indexing style in format string"); }
268 __invalid_arg_id_in_format_string()
269 { __throw_format_error("format error: invalid arg-id in format string"); }
273 __failed_to_parse_format_spec()
274 { __throw_format_error("format error: failed to parse format-spec"); }
276 template<typename _CharT> class _Scanner;
278 } // namespace __format
281 // [format.parse.ctx], class template basic_format_parse_context
282 template<typename _CharT> class basic_format_parse_context;
283 using format_parse_context = basic_format_parse_context<char>;
284 #ifdef _GLIBCXX_USE_WCHAR_T
285 using wformat_parse_context = basic_format_parse_context<wchar_t>;
288 template<typename _CharT>
289 class basic_format_parse_context
292 using char_type = _CharT;
293 using const_iterator = typename basic_string_view<_CharT>::const_iterator;
294 using iterator = const_iterator;
297 basic_format_parse_context(basic_string_view<_CharT> __fmt) noexcept
298 : _M_begin(__fmt.begin()), _M_end(__fmt.end())
301 basic_format_parse_context(const basic_format_parse_context&) = delete;
302 void operator=(const basic_format_parse_context&) = delete;
304 constexpr const_iterator begin() const noexcept { return _M_begin; }
305 constexpr const_iterator end() const noexcept { return _M_end; }
308 advance_to(const_iterator __it) noexcept
314 if (_M_indexing == _Manual)
315 __format::__conflicting_indexing_in_format_string();
318 // _GLIBCXX_RESOLVE_LIB_DEFECTS
319 // 3825. Missing compile-time argument id check in next_arg_id
320 if (std::is_constant_evaluated())
321 if (_M_next_arg_id == _M_num_args)
322 __format::__invalid_arg_id_in_format_string();
323 return _M_next_arg_id++;
327 check_arg_id(size_t __id)
329 if (_M_indexing == _Auto)
330 __format::__conflicting_indexing_in_format_string();
331 _M_indexing = _Manual;
333 if (std::is_constant_evaluated())
334 if (__id >= _M_num_args)
335 __format::__invalid_arg_id_in_format_string();
338 #if __cpp_lib_format >= 202305L
339 template<typename... _Ts>
341 check_dynamic_spec(size_t __id) noexcept
343 static_assert(__valid_types_for_check_dynamic_spec<_Ts...>(),
344 "template arguments for check_dynamic_spec<Ts...>(id) "
345 "must be unique and must be one of the allowed types");
347 __check_dynamic_spec<_Ts...>(__id);
352 check_dynamic_spec_integral(size_t __id) noexcept
355 __check_dynamic_spec<int, unsigned, long long,
356 unsigned long long>(__id);
361 check_dynamic_spec_string(size_t __id) noexcept
364 __check_dynamic_spec<const _CharT*, basic_string_view<_CharT>>(__id);
369 // True if _Tp occurs exactly once in _Ts.
370 template<typename _Tp, typename... _Ts>
371 static constexpr bool __once = (is_same_v<_Tp, _Ts> + ...) == 1;
373 template<typename... _Ts>
375 __valid_types_for_check_dynamic_spec()
377 // _GLIBCXX_RESOLVE_LIB_DEFECTS
378 // 4142. check_dynamic_spec should require at least one type
379 if constexpr (sizeof...(_Ts) == 0)
383 // The types in Ts... are unique. Each type in Ts... is one of
384 // bool, char_type, int, unsigned int, long long int,
385 // unsigned long long int, float, double, long double,
386 // const char_type*, basic_string_view<char_type>, or const void*.
388 = __once<bool, _Ts...>
389 + __once<char_type, _Ts...>
390 + __once<int, _Ts...>
391 + __once<unsigned int, _Ts...>
392 + __once<long long int, _Ts...>
393 + __once<unsigned long long int, _Ts...>
394 + __once<float, _Ts...>
395 + __once<double, _Ts...>
396 + __once<long double, _Ts...>
397 + __once<const char_type*, _Ts...>
398 + __once<basic_string_view<char_type>, _Ts...>
399 + __once<const void*, _Ts...>;
400 return __sum == sizeof...(_Ts);
404 template<typename... _Ts>
406 __check_dynamic_spec(size_t __id) noexcept;
408 // This must not be constexpr.
409 static void __invalid_dynamic_spec(const char*);
411 friend __format::_Scanner<_CharT>;
414 // This constructor should only be used by the implementation.
416 basic_format_parse_context(basic_string_view<_CharT> __fmt,
417 size_t __num_args) noexcept
418 : _M_begin(__fmt.begin()), _M_end(__fmt.end()), _M_num_args(__num_args)
424 enum _Indexing { _Unknown, _Manual, _Auto };
425 _Indexing _M_indexing = _Unknown;
426 size_t _M_next_arg_id = 0;
427 size_t _M_num_args = 0;
430 /// @cond undocumented
431 template<typename _Tp, template<typename...> class _Class>
432 constexpr bool __is_specialization_of = false;
433 template<template<typename...> class _Class, typename... _Args>
434 constexpr bool __is_specialization_of<_Class<_Args...>, _Class> = true;
438 // pre: first != last
439 template<typename _CharT>
440 constexpr pair<unsigned short, const _CharT*>
441 __parse_integer(const _CharT* __first, const _CharT* __last)
443 if (__first == __last)
444 __builtin_unreachable();
446 if constexpr (is_same_v<_CharT, char>)
448 const auto __start = __first;
449 unsigned short __val = 0;
450 // N.B. std::from_chars is not constexpr in C++20.
451 if (__detail::__from_chars_alnum<true>(__first, __last, __val, 10)
452 && __first != __start) [[likely]]
453 return {__val, __first};
457 constexpr int __n = 32;
459 for (int __i = 0; __i < __n && (__first + __i) != __last; ++__i)
460 __buf[__i] = __first[__i];
461 auto [__v, __ptr] = __format::__parse_integer(__buf, __buf + __n);
462 if (__ptr) [[likely]]
463 return {__v, __first + (__ptr - __buf)};
468 template<typename _CharT>
469 constexpr pair<unsigned short, const _CharT*>
470 __parse_arg_id(const _CharT* __first, const _CharT* __last)
472 if (__first == __last)
473 __builtin_unreachable();
476 return {0, __first + 1}; // No leading zeros allowed, so '0...' == 0
478 if ('1' <= *__first && *__first <= '9')
480 const unsigned short __id = *__first - '0';
481 const auto __next = __first + 1;
482 // Optimize for most likely case of single digit arg-id.
483 if (__next == __last || !('0' <= *__next && *__next <= '9'))
484 return {__id, __next};
486 return __format::__parse_integer(__first, __last);
491 enum class _Pres_type : unsigned char {
492 _Pres_none = 0, // Default type (not valid for integer presentation types).
493 _Pres_s = 1, // For strings, bool, ranges
494 // Presentation types for integral types (including bool and charT).
495 _Pres_c = 2, _Pres_x, _Pres_X, _Pres_d, _Pres_o, _Pres_b, _Pres_B,
496 // Presentation types for floating-point types
497 _Pres_g = 1, _Pres_G, _Pres_a, _Pres_A, _Pres_e, _Pres_E, _Pres_f, _Pres_F,
498 // For pointers, the value are same as hexadecimal presentations for integers
499 _Pres_p = _Pres_x, _Pres_P = _Pres_X,
502 using enum _Pres_type;
504 enum class _Sign : unsigned char {
507 _Sign_minus, // XXX does this need to be distinct from _Sign_default?
512 enum _WidthPrec : unsigned char {
513 _WP_none, // No width/prec specified.
514 _WP_value, // Fixed width/prec specified.
515 _WP_from_arg // Use a formatting argument for width/prec.
517 using enum _WidthPrec;
519 template<typename _Context>
521 __int_from_arg(const basic_format_arg<_Context>& __arg);
523 constexpr bool __is_digit(char __c)
524 { return std::__detail::__from_chars_alnum_to_val(__c) < 10; }
526 constexpr bool __is_xdigit(char __c)
527 { return std::__detail::__from_chars_alnum_to_val(__c) < 16; }
529 // Used to make _Spec a non-C++98 POD, so the tail-padding is used.
530 // https://itanium-cxx-abi.github.io/cxx-abi/abi.html#pod
534 template<typename _CharT>
535 struct _Spec : _SpecBase
537 unsigned short _M_width;
538 unsigned short _M_prec;
539 char32_t _M_fill = ' ';
543 unsigned _M_localized : 1;
544 unsigned _M_zero_fill : 1;
545 _WidthPrec _M_width_kind : 2;
546 _WidthPrec _M_prec_kind : 2;
547 unsigned _M_debug : 1;
548 _Pres_type _M_type : 4;
549 unsigned _M_reserved : 8;
550 // This class has 8 bits of tail padding, that can be used by
553 using iterator = typename basic_string_view<_CharT>::iterator;
555 static constexpr _Align
556 _S_align(_CharT __c) noexcept
560 case '<': return _Align_left;
561 case '>': return _Align_right;
562 case '^': return _Align_centre;
563 default: return _Align_default;
567 // pre: __first != __last
569 _M_parse_fill_and_align(iterator __first, iterator __last) noexcept
570 { return _M_parse_fill_and_align(__first, __last, "{"); }
572 // pre: __first != __last
574 _M_parse_fill_and_align(iterator __first, iterator __last, string_view __not_fill) noexcept
576 for (char __c : __not_fill)
577 if (*__first == static_cast<_CharT>(__c))
580 using namespace __unicode;
581 if constexpr (__literal_encoding_is_unicode<_CharT>())
583 // Accept any UCS scalar value as fill character.
584 _Utf32_view<ranges::subrange<iterator>> __uv({__first, __last});
587 auto __beg = __uv.begin();
588 char32_t __c = *__beg++;
589 if (__is_scalar_value(__c))
590 if (auto __next = __beg.base(); __next != __last)
591 if (_Align __align = _S_align(*__next); __align != _Align_default)
599 else if (__last - __first >= 2)
600 if (_Align __align = _S_align(__first[1]); __align != _Align_default)
607 if (_Align __align = _S_align(__first[0]); __align != _Align_default)
616 static constexpr _Sign
617 _S_sign(_CharT __c) noexcept
621 case '+': return _Sign_plus;
622 case '-': return _Sign_minus;
623 case ' ': return _Sign_space;
624 default: return _Sign_default;
628 // pre: __first != __last
630 _M_parse_sign(iterator __first, iterator) noexcept
632 if (_Sign __sign = _S_sign(*__first); __sign != _Sign_default)
640 // pre: *__first is valid
642 _M_parse_alternate_form(iterator __first, iterator) noexcept
652 // pre: __first != __last
654 _M_parse_zero_fill(iterator __first, iterator /* __last */) noexcept
664 // pre: __first != __last
665 static constexpr iterator
666 _S_parse_width_or_precision(iterator __first, iterator __last,
667 unsigned short& __val, bool& __arg_id,
668 basic_format_parse_context<_CharT>& __pc)
670 if (__format::__is_digit(*__first))
672 auto [__v, __ptr] = __format::__parse_integer(__first, __last);
674 __throw_format_error("format error: invalid width or precision "
679 else if (*__first == '{')
683 if (__first == __last)
684 __format::__unmatched_left_brace_in_format_string();
686 __val = __pc.next_arg_id();
689 auto [__v, __ptr] = __format::__parse_arg_id(__first, __last);
690 if (__ptr == nullptr || __ptr == __last || *__ptr != '}')
691 __format::__invalid_arg_id_in_format_string();
693 __pc.check_arg_id(__v);
696 #if __cpp_lib_format >= 202305L
697 __pc.check_dynamic_spec_integral(__val);
699 ++__first; // past the '}'
704 // pre: __first != __last
706 _M_parse_width(iterator __first, iterator __last,
707 basic_format_parse_context<_CharT>& __pc)
709 bool __arg_id = false;
711 __throw_format_error("format error: width must be non-zero in "
713 auto __next = _S_parse_width_or_precision(__first, __last, _M_width,
715 if (__next != __first)
716 _M_width_kind = __arg_id ? _WP_from_arg : _WP_value;
720 // pre: __first != __last
722 _M_parse_precision(iterator __first, iterator __last,
723 basic_format_parse_context<_CharT>& __pc)
725 if (__first[0] != '.')
728 iterator __next = ++__first;
729 bool __arg_id = false;
730 if (__next != __last)
731 __next = _S_parse_width_or_precision(__first, __last, _M_prec,
733 if (__next == __first)
734 __throw_format_error("format error: missing precision after '.' in "
736 _M_prec_kind = __arg_id ? _WP_from_arg : _WP_value;
740 // pre: __first != __last
742 _M_parse_locale(iterator __first, iterator /* __last */) noexcept
752 template<typename _Context>
754 _M_get_width(_Context& __ctx) const
757 if (_M_width_kind == _WP_value)
759 else if (_M_width_kind == _WP_from_arg)
760 __width = __format::__int_from_arg(__ctx.arg(_M_width));
764 template<typename _Context>
766 _M_get_precision(_Context& __ctx) const
769 if (_M_prec_kind == _WP_value)
771 else if (_M_prec_kind == _WP_from_arg)
772 __prec = __format::__int_from_arg(__ctx.arg(_M_prec));
777 template<typename _Int>
779 __put_sign(_Int __i, _Sign __sign, char* __dest) noexcept
783 else if (__sign == _Sign_plus)
785 else if (__sign == _Sign_space)
792 // Write STR to OUT (and do so efficiently if OUT is a _Sink_iter).
793 template<typename _Out, typename _CharT>
794 requires output_iterator<_Out, const _CharT&>
796 __write(_Out __out, basic_string_view<_CharT> __str)
798 if constexpr (is_same_v<_Out, _Sink_iter<_CharT>>)
804 for (_CharT __c : __str)
809 // Write STR to OUT with NFILL copies of FILL_CHAR specified by ALIGN.
810 // pre: __align != _Align_default
811 template<typename _Out, typename _CharT>
813 __write_padded(_Out __out, basic_string_view<_CharT> __str,
814 _Align __align, size_t __nfill, char32_t __fill_char)
816 const size_t __buflen = 0x20;
817 _CharT __padding_chars[__buflen];
818 __padding_chars[0] = _CharT();
819 basic_string_view<_CharT> __padding{__padding_chars, __buflen};
821 auto __pad = [&__padding] (size_t __n, _Out& __o) {
824 while (__n > __padding.size())
826 __o = __format::__write(std::move(__o), __padding);
827 __n -= __padding.size();
830 __o = __format::__write(std::move(__o), __padding.substr(0, __n));
833 size_t __l, __r, __max;
834 if (__align == _Align_centre)
837 __r = __l + (__nfill & 1);
840 else if (__align == _Align_right)
853 using namespace __unicode;
854 if constexpr (__literal_encoding_is_unicode<_CharT>())
855 if (!__is_single_code_unit<_CharT>(__fill_char)) [[unlikely]]
857 // Encode fill char as multiple code units of type _CharT.
858 const char32_t __arr[1]{ __fill_char };
859 _Utf_view<_CharT, span<const char32_t, 1>> __v(__arr);
860 basic_string<_CharT> __padstr(__v.begin(), __v.end());
861 __padding = __padstr;
863 __out = __format::__write(std::move(__out), __padding);
864 __out = __format::__write(std::move(__out), __str);
866 __out = __format::__write(std::move(__out), __padding);
870 if (__max < __buflen)
871 __padding.remove_suffix(__buflen - __max);
875 char_traits<_CharT>::assign(__padding_chars, __max, __fill_char);
877 __out = __format::__write(std::move(__out), __str);
883 // Write STR to OUT, with alignment and padding as determined by SPEC.
884 // pre: __spec._M_align != _Align_default || __align != _Align_default
885 template<typename _CharT, typename _Out>
887 __write_padded_as_spec(basic_string_view<type_identity_t<_CharT>> __str,
888 size_t __estimated_width,
889 basic_format_context<_Out, _CharT>& __fc,
890 const _Spec<_CharT>& __spec,
891 _Align __align = _Align_left)
893 size_t __width = __spec._M_get_width(__fc);
895 if (__width <= __estimated_width)
896 return __format::__write(__fc.out(), __str);
898 const size_t __nfill = __width - __estimated_width;
900 if (__spec._M_align != _Align_default)
901 __align = __spec._M_align;
903 return __format::__write_padded(__fc.out(), __str, __align, __nfill,
907 template<typename _CharT>
909 __truncate(basic_string_view<_CharT>& __s, size_t __prec)
911 if constexpr (__unicode::__literal_encoding_is_unicode<_CharT>())
913 if (__prec != (size_t)-1)
914 return __unicode::__truncate(__s, __prec);
916 return __unicode::__field_width(__s);
920 __s = __s.substr(0, __prec);
925 enum class _Term_char : unsigned char {
930 using enum _Term_char;
932 template<typename _CharT>
935 using _Str_view = basic_string_view<_CharT>;
939 { return _GLIBCXX_WIDEN("\t\\t\n\\n\r\\r\\\\\\\"\\\"'\\'\\u\\x"); }
943 { return _S_all().substr(0, 3); }
946 _Str_view _S_newline()
947 { return _S_all().substr(3, 3); }
950 _Str_view _S_return()
951 { return _S_all().substr(6, 3); }
954 _Str_view _S_bslash()
955 { return _S_all().substr(9, 3); }
959 { return _S_all().substr(12, 3); }
963 { return _S_all().substr(15, 3); }
967 { return _S_all().substr(18, 2); }
971 { return _S_all().substr(20, 2); }
974 _Str_view _S_term(_Term_char __term)
981 return _S_quote().substr(0, 1);
983 return _S_apos().substr(0, 1);
985 __builtin_unreachable();
989 template<typename _CharT>
992 using _Str_view = basic_string_view<_CharT>;
996 { return _GLIBCXX_WIDEN("[]{}(), : "); }
999 _Str_view _S_squares()
1000 { return _S_all().substr(0, 2); }
1003 _Str_view _S_braces()
1004 { return _S_all().substr(2, 2); }
1007 _Str_view _S_parens()
1008 { return _S_all().substr(4, 2); }
1011 _Str_view _S_comma()
1012 { return _S_all().substr(6, 2); }
1015 _Str_view _S_colon()
1016 { return _S_all().substr(8, 2); }
1019 template<typename _CharT>
1020 constexpr bool __should_escape_ascii(_CharT __c, _Term_char __term)
1022 using _Esc = _Escapes<_CharT>;
1025 case _Esc::_S_tab()[0]:
1026 case _Esc::_S_newline()[0]:
1027 case _Esc::_S_return()[0]:
1028 case _Esc::_S_bslash()[0]:
1030 case _Esc::_S_quote()[0]:
1031 return __term == _Term_quote;
1032 case _Esc::_S_apos()[0]:
1033 return __term == _Term_apos;
1035 return (__c >= 0 && __c < 0x20) || __c == 0x7f;
1039 // @pre __c <= 0x10FFFF
1040 constexpr bool __should_escape_unicode(char32_t __c, bool __prev_esc)
1042 if (__unicode::__should_escape_category(__c))
1046 return __unicode::__grapheme_cluster_break_property(__c)
1047 == __unicode::_Gcb_property::_Gcb_Extend;
1050 using uint_least32_t = __UINT_LEAST32_TYPE__;
1051 template<typename _Out, typename _CharT>
1053 __write_escape_seq(_Out __out, uint_least32_t __val,
1054 basic_string_view<_CharT> __prefix)
1056 using _Str_view = basic_string_view<_CharT>;
1057 constexpr size_t __max = 8;
1059 const string_view __narrow(
1061 std::__to_chars_i<uint_least32_t>(__buf, __buf + __max, __val, 16).ptr);
1063 __out = __format::__write(__out, __prefix);
1064 *__out = _Separators<_CharT>::_S_braces()[0];
1066 if constexpr (is_same_v<char, _CharT>)
1067 __out = __format::__write(__out, __narrow);
1068 #ifdef _GLIBCXX_USE_WCHAR_T
1071 _CharT __wbuf[__max];
1072 const size_t __n = __narrow.size();
1073 std::__to_wstring_numeric(__narrow.data(), __n, __wbuf);
1074 __out = __format::__write(__out, _Str_view(__wbuf, __n));
1077 *__out = _Separators<_CharT>::_S_braces()[1];
1081 template<typename _Out, typename _CharT>
1083 __write_escape_seqs(_Out __out, basic_string_view<_CharT> __units)
1085 using _UChar = make_unsigned_t<_CharT>;
1086 for (_CharT __c : __units)
1087 __out = __format::__write_escape_seq(
1088 __out, static_cast<_UChar>(__c), _Escapes<_CharT>::_S_x());
1092 template<typename _Out, typename _CharT>
1094 __write_escaped_char(_Out __out, _CharT __c)
1096 using _UChar = make_unsigned_t<_CharT>;
1097 using _Esc = _Escapes<_CharT>;
1100 case _Esc::_S_tab()[0]:
1101 return __format::__write(__out, _Esc::_S_tab().substr(1, 2));
1102 case _Esc::_S_newline()[0]:
1103 return __format::__write(__out, _Esc::_S_newline().substr(1, 2));
1104 case _Esc::_S_return()[0]:
1105 return __format::__write(__out, _Esc::_S_return().substr(1, 2));
1106 case _Esc::_S_bslash()[0]:
1107 return __format::__write(__out, _Esc::_S_bslash().substr(1, 2));
1108 case _Esc::_S_quote()[0]:
1109 return __format::__write(__out, _Esc::_S_quote().substr(1, 2));
1110 case _Esc::_S_apos()[0]:
1111 return __format::__write(__out, _Esc::_S_apos().substr(1, 2));
1113 return __format::__write_escape_seq(
1114 __out, static_cast<_UChar>(__c), _Esc::_S_u());
1118 template<typename _CharT, typename _Out>
1120 __write_escaped_ascii(_Out __out,
1121 basic_string_view<_CharT> __str,
1124 using _Str_view = basic_string_view<_CharT>;
1125 auto __first = __str.begin();
1126 auto const __last = __str.end();
1127 while (__first != __last)
1129 auto __print = __first;
1130 // assume anything outside ASCII is printable
1131 while (__print != __last
1132 && !__format::__should_escape_ascii(*__print, __term))
1135 if (__print != __first)
1136 __out = __format::__write(__out, _Str_view(__first, __print));
1138 if (__print == __last)
1142 __out = __format::__write_escaped_char(__out, *__first);
1148 template<typename _CharT, typename _Out>
1150 __write_escaped_unicode_part(_Out __out, basic_string_view<_CharT>& __str,
1151 bool& __prev_esc, _Term_char __term)
1153 using _Str_view = basic_string_view<_CharT>;
1154 using _Esc = _Escapes<_CharT>;
1156 static constexpr char32_t __replace = U'\uFFFD';
1157 static constexpr _Str_view __replace_rep = []
1159 // N.B. "\uFFFD" is ill-formed if encoding is not unicode.
1160 if constexpr (is_same_v<char, _CharT>)
1161 return "\xEF\xBF\xBD";
1166 __unicode::_Utf_view<char32_t, _Str_view> __v(std::move(__str));
1169 auto __first = __v.begin();
1170 auto const __last = __v.end();
1171 while (__first != __last)
1173 bool __esc_ascii = false;
1174 bool __esc_unicode = false;
1175 bool __esc_replace = false;
1176 auto __should_escape = [&](auto const& __it)
1180 = __format::__should_escape_ascii(*__it.base(), __term);
1181 if (__format::__should_escape_unicode(*__it, __prev_esc))
1182 return __esc_unicode = true;
1183 if (*__it == __replace)
1185 _Str_view __units(__it.base(), __it._M_units());
1186 return __esc_replace = (__units != __replace_rep);
1191 auto __print = __first;
1192 while (__print != __last && !__should_escape(__print))
1198 if (__print != __first)
1199 __out = __format::__write(__out, _Str_view(__first.base(), __print.base()));
1201 if (__print == __last)
1206 __out = __format::__write_escaped_char(__out, *__first.base());
1207 else if (__esc_unicode)
1208 __out = __format::__write_escape_seq(__out, *__first, _Esc::_S_u());
1210 else if (_Str_view __units(__first.base(), __first._M_units());
1211 __units.end() != __last.base())
1212 __out = __format::__write_escape_seqs(__out, __units);
1226 template<typename _CharT, typename _Out>
1228 __write_escaped_unicode(_Out __out, basic_string_view<_CharT> __str,
1231 bool __prev_escape = true;
1232 __out = __format::__write_escaped_unicode_part(__out, __str,
1233 __prev_escape, __term);
1234 __out = __format::__write_escape_seqs(__out, __str);
1238 template<typename _CharT, typename _Out>
1240 __write_escaped(_Out __out, basic_string_view<_CharT> __str, _Term_char __term)
1242 __out = __format::__write(__out, _Escapes<_CharT>::_S_term(__term));
1244 if constexpr (__unicode::__literal_encoding_is_unicode<_CharT>())
1245 __out = __format::__write_escaped_unicode(__out, __str, __term);
1246 else if constexpr (is_same_v<char, _CharT>
1247 && __unicode::__literal_encoding_is_extended_ascii())
1248 __out = __format::__write_escaped_ascii(__out, __str, __term);
1250 // TODO Handle non-ascii extended encoding
1251 __out = __format::__write_escaped_ascii(__out, __str, __term);
1253 return __format::__write(__out, _Escapes<_CharT>::_S_term(__term));
1256 // A lightweight optional<locale>.
1257 struct _Optional_locale
1259 [[__gnu__::__always_inline__]]
1260 _Optional_locale() : _M_dummy(), _M_hasval(false) { }
1262 _Optional_locale(const locale& __loc) noexcept
1263 : _M_loc(__loc), _M_hasval(true)
1266 _Optional_locale(const _Optional_locale& __l) noexcept
1267 : _M_dummy(), _M_hasval(__l._M_hasval)
1270 std::construct_at(&_M_loc, __l._M_loc);
1274 operator=(const _Optional_locale& __l) noexcept
1279 _M_loc = __l._M_loc;
1286 else if (__l._M_hasval)
1288 std::construct_at(&_M_loc, __l._M_loc);
1294 ~_Optional_locale() { if (_M_hasval) _M_loc.~locale(); }
1297 operator=(locale&& __loc) noexcept
1300 _M_loc = std::move(__loc);
1303 std::construct_at(&_M_loc, std::move(__loc));
1314 std::construct_at(&_M_loc);
1320 bool has_value() const noexcept { return _M_hasval; }
1323 char _M_dummy = '\0';
1326 bool _M_hasval = false;
1329 template<__char _CharT>
1330 struct __formatter_str
1332 __formatter_str() = default;
1335 __formatter_str(_Spec<_CharT> __spec) noexcept
1339 constexpr typename basic_format_parse_context<_CharT>::iterator
1340 parse(basic_format_parse_context<_CharT>& __pc)
1342 auto __first = __pc.begin();
1343 const auto __last = __pc.end();
1344 _Spec<_CharT> __spec{};
1346 auto __finalize = [this, &__spec] {
1350 auto __finished = [&] {
1351 if (__first == __last || *__first == '}')
1362 __first = __spec._M_parse_fill_and_align(__first, __last);
1366 __first = __spec._M_parse_width(__first, __last, __pc);
1370 __first = __spec._M_parse_precision(__first, __last, __pc);
1374 if (*__first == 's')
1376 __spec._M_type = _Pres_s;
1379 #if __glibcxx_format_ranges // C++ >= 23 && HOSTED
1380 else if (*__first == '?')
1382 __spec._M_debug = true;
1390 __format::__failed_to_parse_format_spec();
1393 template<typename _Out>
1395 format(basic_string_view<_CharT> __s,
1396 basic_format_context<_Out, _CharT>& __fc) const
1398 if (_M_spec._M_debug)
1399 return _M_format_escaped(__s, __fc);
1401 if (_M_spec._M_width_kind == _WP_none
1402 && _M_spec._M_prec_kind == _WP_none)
1403 return __format::__write(__fc.out(), __s);
1405 const size_t __maxwidth = _M_spec._M_get_precision(__fc);
1406 const size_t __width = __format::__truncate(__s, __maxwidth);
1407 return __format::__write_padded_as_spec(__s, __width, __fc, _M_spec);
1410 template<typename _Out>
1412 _M_format_escaped(basic_string_view<_CharT> __s,
1413 basic_format_context<_Out, _CharT>& __fc) const
1415 const size_t __padwidth = _M_spec._M_get_width(__fc);
1416 if (__padwidth == 0 && _M_spec._M_prec_kind == _WP_none)
1417 return __format::__write_escaped(__fc.out(), __s, _Term_quote);
1419 const size_t __maxwidth = _M_spec._M_get_precision(__fc);
1420 const size_t __width = __truncate(__s, __maxwidth);
1421 // N.B. Escaping only increases width
1422 if (__padwidth <= __width && _M_spec._M_prec_kind == _WP_none)
1423 return __format::__write_escaped(__fc.out(), __s, _Term_quote);
1425 // N.B. [tab:format.type.string] defines '?' as
1426 // Copies the escaped string ([format.string.escaped]) to the output,
1427 // so precision seem to appy to escaped string.
1428 _Padding_sink<_Out, _CharT> __sink(__fc.out(), __padwidth, __maxwidth);
1429 __format::__write_escaped(__sink.out(), __s, _Term_quote);
1430 return __sink._M_finish(_M_spec._M_align, _M_spec._M_fill);
1433 #if __glibcxx_format_ranges // C++ >= 23 && HOSTED
1434 template<ranges::input_range _Rg, typename _Out>
1435 requires same_as<remove_cvref_t<ranges::range_reference_t<_Rg>>, _CharT>
1437 _M_format_range(_Rg&& __rg, basic_format_context<_Out, _CharT>& __fc) const
1439 using _Range = remove_reference_t<_Rg>;
1440 using _String_view = basic_string_view<_CharT>;
1441 if constexpr (!is_lvalue_reference_v<_Rg>)
1442 return _M_format_range<_Range&>(__rg, __fc);
1443 else if constexpr (!is_const_v<_Range>
1444 && __simply_formattable_range<_Range, _CharT>)
1445 return _M_format_range<const _Range&>(__rg, __fc);
1446 else if constexpr (ranges::contiguous_range<_Rg>)
1448 _String_view __str(ranges::data(__rg),
1449 size_t(ranges::distance(__rg)));
1450 return format(__str, __fc);
1454 auto __handle_debug = [this, &__rg]<typename _NOut>(_NOut __nout)
1456 if (!_M_spec._M_debug)
1457 return ranges::copy(__rg, std::move(__nout)).out;
1459 _Escaping_sink<_NOut, _CharT>
1460 __sink(std::move(__nout), _Term_quote);
1461 ranges::copy(__rg, __sink.out());
1462 return __sink._M_finish();
1465 const size_t __padwidth = _M_spec._M_get_width(__fc);
1466 if (__padwidth == 0 && _M_spec._M_prec_kind == _WP_none)
1467 return __handle_debug(__fc.out());
1469 _Padding_sink<_Out, _CharT>
1470 __sink(__fc.out(), __padwidth, _M_spec._M_get_precision(__fc));
1471 __handle_debug(__sink.out());
1472 return __sink._M_finish(_M_spec._M_align, _M_spec._M_fill);
1477 set_debug_format() noexcept
1478 { _M_spec._M_debug = true; }
1482 _Spec<_CharT> _M_spec{};
1485 template<__char _CharT>
1486 struct __formatter_int
1488 // If no presentation type is specified, meaning of "none" depends
1489 // whether we are formatting an integer or a char or a bool.
1490 static constexpr _Pres_type _AsInteger = _Pres_d;
1491 static constexpr _Pres_type _AsBool = _Pres_s;
1492 static constexpr _Pres_type _AsChar = _Pres_c;
1494 __formatter_int() = default;
1497 __formatter_int(_Spec<_CharT> __spec) noexcept
1500 if (_M_spec._M_type == _Pres_none)
1501 _M_spec._M_type = _Pres_d;
1504 constexpr typename basic_format_parse_context<_CharT>::iterator
1505 _M_do_parse(basic_format_parse_context<_CharT>& __pc, _Pres_type __type)
1507 _Spec<_CharT> __spec{};
1508 __spec._M_type = __type;
1510 const auto __last = __pc.end();
1511 auto __first = __pc.begin();
1513 auto __finalize = [this, &__spec] {
1517 auto __finished = [&] {
1518 if (__first == __last || *__first == '}')
1529 __first = __spec._M_parse_fill_and_align(__first, __last);
1533 __first = __spec._M_parse_sign(__first, __last);
1537 __first = __spec._M_parse_alternate_form(__first, __last);
1541 __first = __spec._M_parse_zero_fill(__first, __last);
1545 __first = __spec._M_parse_width(__first, __last, __pc);
1549 __first = __spec._M_parse_locale(__first, __last);
1556 __spec._M_type = _Pres_b;
1560 __spec._M_type = _Pres_B;
1564 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1565 // 3586. format should not print bool with 'c'
1566 if (__type != _AsBool)
1568 __spec._M_type = _Pres_c;
1573 __spec._M_type = _Pres_d;
1577 __spec._M_type = _Pres_o;
1581 __spec._M_type = _Pres_x;
1585 __spec._M_type = _Pres_X;
1589 if (__type == _AsBool)
1591 __spec._M_type = _Pres_s; // same meaning as "none" for bool
1595 #if __glibcxx_format_ranges // C++ >= 23 && HOSTED
1597 if (__type == _AsChar)
1599 __spec._M_debug = true;
1609 __format::__failed_to_parse_format_spec();
1612 template<typename _Tp>
1613 constexpr typename basic_format_parse_context<_CharT>::iterator
1614 _M_parse(basic_format_parse_context<_CharT>& __pc)
1616 if constexpr (is_same_v<_Tp, bool>)
1618 auto __end = _M_do_parse(__pc, _AsBool);
1619 if (_M_spec._M_type == _Pres_s)
1620 if (_M_spec._M_sign != _Sign_default || _M_spec._M_alt
1621 || _M_spec._M_zero_fill)
1622 __throw_format_error("format error: format-spec contains "
1623 "invalid formatting options for "
1627 else if constexpr (__char<_Tp>)
1629 auto __end = _M_do_parse(__pc, _AsChar);
1630 if (_M_spec._M_type == _Pres_c)
1631 if (_M_spec._M_sign != _Sign_default || _M_spec._M_alt
1632 || _M_spec._M_zero_fill
1633 /* XXX should be invalid? || _M_spec._M_localized */)
1634 __throw_format_error("format error: format-spec contains "
1635 "invalid formatting options for "
1640 return _M_do_parse(__pc, _AsInteger);
1643 template<typename _Int, typename _Out>
1644 typename basic_format_context<_Out, _CharT>::iterator
1645 format(_Int __i, basic_format_context<_Out, _CharT>& __fc) const
1647 if (_M_spec._M_type == _Pres_c)
1648 return _M_format_character(_S_to_character(__i), __fc);
1650 constexpr size_t __buf_size = sizeof(_Int) * __CHAR_BIT__ + 3;
1651 char __buf[__buf_size];
1652 to_chars_result __res{};
1654 string_view __base_prefix;
1655 make_unsigned_t<_Int> __u;
1657 __u = -static_cast<make_unsigned_t<_Int>>(__i);
1661 char* __start = __buf + 3;
1662 char* const __end = __buf + sizeof(__buf);
1663 char* const __start_digits = __start;
1665 switch (_M_spec._M_type)
1669 __base_prefix = _M_spec._M_type == _Pres_b ? "0b" : "0B";
1670 __res = to_chars(__start, __end, __u, 2);
1674 return _M_format_character(_S_to_character(__i), __fc);
1677 // Should not reach here with _Pres_none for bool or charT, so:
1680 __res = to_chars(__start, __end, __u, 10);
1684 __base_prefix = "0";
1685 __res = to_chars(__start, __end, __u, 8);
1689 __base_prefix = _M_spec._M_type == _Pres_x ? "0x" : "0X";
1690 __res = to_chars(__start, __end, __u, 16);
1691 if (_M_spec._M_type == _Pres_X)
1692 for (auto __p = __start; __p != __res.ptr; ++__p)
1693 #if __has_builtin(__builtin_toupper)
1694 *__p = __builtin_toupper(*__p);
1696 *__p = std::toupper(*__p);
1700 __builtin_unreachable();
1703 if (_M_spec._M_alt && __base_prefix.size())
1705 __start -= __base_prefix.size();
1706 __builtin_memcpy(__start, __base_prefix.data(),
1707 __base_prefix.size());
1709 __start = __format::__put_sign(__i, _M_spec._M_sign, __start - 1);
1712 string_view __narrow_str(__start, __res.ptr - __start);
1713 size_t __prefix_len = __start_digits - __start;
1714 if constexpr (is_same_v<char, _CharT>)
1715 return _M_format_int(__narrow_str, __prefix_len, __fc);
1716 #ifdef _GLIBCXX_USE_WCHAR_T
1719 _CharT __wbuf[__buf_size];
1720 size_t __n = __narrow_str.size();
1721 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1722 // 4522. Clarify that `std::format` transcodes for `std::wformat_strings`
1723 std::__to_wstring_numeric(__narrow_str.data(), __n, __wbuf);
1724 return _M_format_int(basic_string_view<_CharT>(__wbuf, __n),
1725 __prefix_len, __fc);
1730 template<typename _Out>
1731 typename basic_format_context<_Out, _CharT>::iterator
1732 format(bool __i, basic_format_context<_Out, _CharT>& __fc) const
1734 if (_M_spec._M_type == _Pres_c)
1735 return _M_format_character(static_cast<unsigned char>(__i), __fc);
1736 if (_M_spec._M_type != _Pres_s)
1737 return format(static_cast<unsigned char>(__i), __fc);
1739 basic_string<_CharT> __s;
1741 if (_M_spec._M_localized) [[unlikely]]
1743 auto& __np = std::use_facet<numpunct<_CharT>>(__fc.locale());
1744 __s = __i ? __np.truename() : __np.falsename();
1745 __est_width = __s.size(); // TODO Unicode-aware estimate
1749 if constexpr (is_same_v<char, _CharT>)
1750 __s = __i ? "true" : "false";
1752 __s = __i ? L"true" : L"false";
1753 __est_width = __s.size();
1756 return __format::__write_padded_as_spec(__s, __est_width, __fc,
1760 template<typename _Out>
1761 typename basic_format_context<_Out, _CharT>::iterator
1762 _M_format_character(_CharT __c,
1763 basic_format_context<_Out, _CharT>& __fc) const
1765 basic_string_view<_CharT> __in(&__c, 1u);
1766 size_t __width = 1u;
1767 // N.B. single byte cannot encode character of width greater than 1
1768 if constexpr (sizeof(_CharT) > 1u &&
1769 __unicode::__literal_encoding_is_unicode<_CharT>())
1770 __width = __unicode::__field_width(__c);
1772 if (!_M_spec._M_debug)
1773 return __format::__write_padded_as_spec(__in, __width,
1777 if (_M_spec._M_get_width(__fc) <= __width)
1778 return __format::__write_escaped(__fc.out(), __in, _Term_apos);
1781 _Fixedbuf_sink<_CharT> __sink(__buf);
1782 __format::__write_escaped(__sink.out(), __in, _Term_apos);
1784 __in = __sink.view();
1785 if (__in[1] == _Escapes<_CharT>::_S_bslash()[0]) // escape sequence
1786 __width = __in.size();
1787 return __format::__write_padded_as_spec(__in, __width,
1791 template<typename _Int>
1793 _S_to_character(_Int __i)
1795 using _Traits = __gnu_cxx::__int_traits<_CharT>;
1796 if constexpr (is_signed_v<_Int> == is_signed_v<_CharT>)
1798 if (_Traits::__min <= __i && __i <= _Traits::__max)
1799 return static_cast<_CharT>(__i);
1801 else if constexpr (is_signed_v<_Int>)
1803 if (__i >= 0 && make_unsigned_t<_Int>(__i) <= _Traits::__max)
1804 return static_cast<_CharT>(__i);
1806 else if (__i <= make_unsigned_t<_CharT>(_Traits::__max))
1807 return static_cast<_CharT>(__i);
1808 __throw_format_error("format error: integer not representable as "
1812 template<typename _Out>
1813 typename basic_format_context<_Out, _CharT>::iterator
1814 _M_format_int(basic_string_view<_CharT> __str, size_t __prefix_len,
1815 basic_format_context<_Out, _CharT>& __fc) const
1817 size_t __width = _M_spec._M_get_width(__fc);
1818 if (_M_spec._M_localized)
1820 const auto& __l = __fc.locale();
1821 if (__l.name() != "C")
1823 auto& __np = use_facet<numpunct<_CharT>>(__l);
1824 string __grp = __np.grouping();
1827 size_t __n = __str.size() - __prefix_len;
1828 auto __p = (_CharT*)__builtin_alloca(2 * __n
1831 auto __s = __str.data();
1832 char_traits<_CharT>::copy(__p, __s, __prefix_len);
1833 __s += __prefix_len;
1834 auto __end = std::__add_grouping(__p + __prefix_len,
1835 __np.thousands_sep(),
1839 __str = {__p, size_t(__end - __p)};
1844 if (__width <= __str.size())
1845 return __format::__write(__fc.out(), __str);
1847 char32_t __fill_char = _M_spec._M_fill;
1848 _Align __align = _M_spec._M_align;
1850 size_t __nfill = __width - __str.size();
1851 auto __out = __fc.out();
1852 if (__align == _Align_default)
1854 __align = _Align_right;
1855 if (_M_spec._M_zero_fill)
1857 __fill_char = _CharT('0');
1858 // Write sign and base prefix before zero filling.
1859 if (__prefix_len != 0)
1861 __out = __format::__write(std::move(__out),
1862 __str.substr(0, __prefix_len));
1863 __str.remove_prefix(__prefix_len);
1867 __fill_char = _CharT(' ');
1869 return __format::__write_padded(std::move(__out), __str,
1870 __align, __nfill, __fill_char);
1873 _Spec<_CharT> _M_spec{};
1876 #ifdef __BFLT16_DIG__
1877 using __bflt16_t = decltype(0.0bf16);
1880 // Decide how 128-bit floating-point types should be formatted (or not).
1881 // When supported, the typedef __format::__flt128_t is the type that format
1882 // arguments should be converted to before passing them to __formatter_fp.
1883 // Define the macro _GLIBCXX_FORMAT_F128 to say they're supported.
1884 // The __float128, _Float128 will be formatted by converting them to:
1885 // __ieee128 (same as __float128) when _GLIBCXX_FORMAT_F128=1,
1886 // long double when _GLIBCXX_FORMAT_F128=2,
1887 // _Float128 when _GLIBCXX_FORMAT_F128=3.
1888 #undef _GLIBCXX_FORMAT_F128
1890 #ifdef _GLIBCXX_LONG_DOUBLE_ALT128_COMPAT
1892 // Format 128-bit floating-point types using __ieee128.
1893 using __flt128_t = __ieee128;
1894 # define _GLIBCXX_FORMAT_F128 1
1896 #ifdef __LONG_DOUBLE_IEEE128__
1897 // These overloads exist in the library, but are not declared.
1898 // Make them available as std::__format::to_chars.
1900 to_chars(char*, char*, __ibm128) noexcept
1901 __asm("_ZSt8to_charsPcS_e");
1904 to_chars(char*, char*, __ibm128, chars_format) noexcept
1905 __asm("_ZSt8to_charsPcS_eSt12chars_format");
1908 to_chars(char*, char*, __ibm128, chars_format, int) noexcept
1909 __asm("_ZSt8to_charsPcS_eSt12chars_formati");
1910 #elif __cplusplus == 202002L
1912 to_chars(char*, char*, __ieee128) noexcept
1913 __asm("_ZSt8to_charsPcS_u9__ieee128");
1916 to_chars(char*, char*, __ieee128, chars_format) noexcept
1917 __asm("_ZSt8to_charsPcS_u9__ieee128St12chars_format");
1920 to_chars(char*, char*, __ieee128, chars_format, int) noexcept
1921 __asm("_ZSt8to_charsPcS_u9__ieee128St12chars_formati");
1924 #elif defined _GLIBCXX_LDOUBLE_IS_IEEE_BINARY128
1926 // Format 128-bit floating-point types using long double.
1927 using __flt128_t = long double;
1928 # define _GLIBCXX_FORMAT_F128 2
1930 #elif __FLT128_DIG__ && defined(_GLIBCXX_HAVE_FLOAT128_MATH)
1932 // Format 128-bit floating-point types using _Float128.
1933 using __flt128_t = _Float128;
1934 # define _GLIBCXX_FORMAT_F128 3
1936 # if __cplusplus == 202002L
1937 // These overloads exist in the library, but are not declared for C++20.
1938 // Make them available as std::__format::to_chars.
1940 to_chars(char*, char*, _Float128) noexcept
1941 # if _GLIBCXX_INLINE_VERSION
1942 __asm("_ZNSt3__88to_charsEPcS0_DF128_");
1944 __asm("_ZSt8to_charsPcS_DF128_");
1948 to_chars(char*, char*, _Float128, chars_format) noexcept
1949 # if _GLIBCXX_INLINE_VERSION
1950 __asm("_ZNSt3__88to_charsEPcS0_DF128_NS_12chars_formatE");
1952 __asm("_ZSt8to_charsPcS_DF128_St12chars_format");
1956 to_chars(char*, char*, _Float128, chars_format, int) noexcept
1957 # if _GLIBCXX_INLINE_VERSION
1958 __asm("_ZNSt3__88to_charsEPcS0_DF128_NS_12chars_formatEi");
1960 __asm("_ZSt8to_charsPcS_DF128_St12chars_formati");
1965 using std::to_chars;
1967 // We can format a floating-point type iff it is usable with to_chars.
1968 template<typename _Tp>
1969 concept __formattable_float
1970 = is_same_v<remove_cv_t<_Tp>, _Tp> && requires (_Tp __t, char* __p)
1971 { __format::to_chars(__p, __p, __t, chars_format::scientific, 6); };
1973 template<__char _CharT>
1974 struct __formatter_fp
1976 constexpr typename basic_format_parse_context<_CharT>::iterator
1977 parse(basic_format_parse_context<_CharT>& __pc)
1979 _Spec<_CharT> __spec{};
1980 const auto __last = __pc.end();
1981 auto __first = __pc.begin();
1983 auto __finalize = [this, &__spec] {
1987 auto __finished = [&] {
1988 if (__first == __last || *__first == '}')
1999 __first = __spec._M_parse_fill_and_align(__first, __last);
2003 __first = __spec._M_parse_sign(__first, __last);
2007 __first = __spec._M_parse_alternate_form(__first, __last);
2011 __first = __spec._M_parse_zero_fill(__first, __last);
2015 if (__first[0] != '.')
2017 __first = __spec._M_parse_width(__first, __last, __pc);
2022 __first = __spec._M_parse_precision(__first, __last, __pc);
2026 __first = __spec._M_parse_locale(__first, __last);
2033 __spec._M_type = _Pres_a;
2037 __spec._M_type = _Pres_A;
2041 __spec._M_type = _Pres_e;
2045 __spec._M_type = _Pres_E;
2049 __spec._M_type = _Pres_f;
2053 __spec._M_type = _Pres_F;
2057 __spec._M_type = _Pres_g;
2061 __spec._M_type = _Pres_G;
2069 __format::__failed_to_parse_format_spec();
2072 template<typename _Fp, typename _Out>
2073 typename basic_format_context<_Out, _CharT>::iterator
2074 format(_Fp __v, basic_format_context<_Out, _CharT>& __fc) const
2076 std::string __dynbuf;
2078 to_chars_result __res{};
2081 bool __use_prec = _M_spec._M_prec_kind != _WP_none;
2083 __prec = _M_spec._M_get_precision(__fc);
2085 char* __start = __buf + 1; // reserve space for sign
2086 char* __end = __buf + sizeof(__buf);
2088 chars_format __fmt{};
2089 bool __upper = false;
2090 bool __trailing_zeros = false;
2093 switch (_M_spec._M_type)
2100 if (_M_spec._M_type != _Pres_A)
2102 __fmt = chars_format::hex;
2110 __fmt = chars_format::scientific;
2117 __fmt = chars_format::fixed;
2124 __trailing_zeros = true;
2126 __fmt = chars_format::general;
2130 __fmt = chars_format::general;
2133 __builtin_unreachable();
2136 // Write value into buffer using std::to_chars.
2137 auto __to_chars = [&](char* __b, char* __e) {
2139 return __format::to_chars(__b, __e, __v, __fmt, __prec);
2140 else if (__fmt != chars_format{})
2141 return __format::to_chars(__b, __e, __v, __fmt);
2143 return __format::to_chars(__b, __e, __v);
2146 // First try using stack buffer.
2147 __res = __to_chars(__start, __end);
2149 if (__builtin_expect(__res.ec == errc::value_too_large, 0))
2151 // If the buffer is too small it's probably because of a large
2152 // precision, or a very large value in fixed format.
2153 size_t __guess = 8 + __prec;
2154 if (__fmt == chars_format::fixed) // +ddd.prec
2156 if constexpr (is_same_v<_Fp, float> || is_same_v<_Fp, double>
2157 || is_same_v<_Fp, long double>)
2159 // The number of digits to the left of the decimal point
2160 // is floor(log10(max(abs(__v),1)))+1
2162 if constexpr (is_same_v<_Fp, float>)
2163 __builtin_frexpf(__v, &__exp);
2164 else if constexpr (is_same_v<_Fp, double>)
2165 __builtin_frexp(__v, &__exp);
2166 else if constexpr (is_same_v<_Fp, long double>)
2167 __builtin_frexpl(__v, &__exp);
2169 __guess += 1U + __exp * 4004U / 13301U; // log10(2) approx.
2172 __guess += numeric_limits<_Fp>::max_exponent10;
2174 if (__guess <= sizeof(__buf)) [[unlikely]]
2175 __guess = sizeof(__buf) * 2;
2176 __dynbuf.reserve(__guess);
2180 // Mangling of this lambda, and thus resize_and_overwrite
2181 // instantiated with it, was fixed in ABI 18 (G++ 13). Since
2182 // <format> was new in G++ 13, and is experimental, that
2184 auto __overwrite = [&__to_chars, &__res] (char* __p, size_t __n)
2186 __res = __to_chars(__p + 1, __p + __n - 1);
2187 return __res.ec == errc{} ? __res.ptr - __p : 0;
2190 __dynbuf.__resize_and_overwrite(__dynbuf.capacity() * 2,
2192 __start = __dynbuf.data() + 1; // reserve space for sign
2193 __end = __dynbuf.data() + __dynbuf.size();
2195 while (__builtin_expect(__res.ec == errc::value_too_large, 0));
2198 // Use uppercase for 'A', 'E', and 'G' formats.
2201 for (char* __p = __start; __p != __res.ptr; ++__p)
2202 *__p = std::toupper(*__p);
2205 bool __have_sign = true;
2206 // Add sign for non-negative values.
2207 if (!__builtin_signbit(__v))
2209 if (_M_spec._M_sign == _Sign_plus)
2211 else if (_M_spec._M_sign == _Sign_space)
2214 __have_sign = false;
2217 string_view __narrow_str(__start, __res.ptr - __start);
2219 // Use alternate form. Ensure decimal point is always present,
2220 // and add trailing zeros (up to precision) for g and G forms.
2221 if (_M_spec._M_alt && __builtin_isfinite(__v))
2223 string_view __s = __narrow_str;
2224 size_t __sigfigs; // Number of significant figures.
2225 size_t __z = 0; // Number of trailing zeros to add.
2226 size_t __p; // Position of the exponent character (if any).
2227 size_t __d = __s.find('.'); // Position of decimal point.
2228 if (__d != __s.npos) // Found decimal point.
2230 __p = __s.find(__expc, __d + 1);
2231 if (__p == __s.npos)
2234 // If presentation type is g or G we might need to add zeros.
2235 if (__trailing_zeros)
2237 // Find number of digits after first significant figure.
2238 if (__s[__have_sign] != '0')
2239 // A string like "D.D" or "-D.DDD"
2240 __sigfigs = __p - __have_sign - 1;
2242 // A string like "0.D" or "-0.0DD".
2243 // Safe to assume there is a non-zero digit, because
2244 // otherwise there would be no decimal point.
2245 __sigfigs = __p - __s.find_first_not_of('0', __d + 1);
2248 else // No decimal point, we need to insert one.
2250 __p = __s.find(__expc); // Find the exponent, if present.
2251 if (__p == __s.npos)
2253 __d = __p; // Position where '.' should be inserted.
2254 __sigfigs = __d - __have_sign;
2257 if (__trailing_zeros && __prec != 0)
2259 // For g and G presentation types std::to_chars produces
2260 // no more than prec significant figures. Insert this many
2261 // zeros so the result has exactly prec significant figures.
2262 __z = __prec - __sigfigs;
2265 if (size_t __extras = int(__d == __p) + __z) // How many to add.
2267 if (__dynbuf.empty() && __extras <= size_t(__end - __res.ptr))
2269 // The stack buffer is large enough for the result.
2270 // Move exponent to make space for extra chars.
2271 __builtin_memmove(__start + __p + __extras,
2275 __start[__p++] = '.';
2276 __builtin_memset(__start + __p, '0', __z);
2277 __narrow_str = {__s.data(), __s.size() + __extras};
2279 else // Need to switch to the dynamic buffer.
2281 __dynbuf.reserve(__s.size() + __extras);
2282 if (__dynbuf.empty())
2284 __dynbuf = __s.substr(0, __p);
2288 __dynbuf.append(__z, '0');
2289 __dynbuf.append(__s.substr(__p));
2293 __dynbuf.insert(__p, __extras, '0');
2295 __dynbuf[__p] = '.';
2297 __narrow_str = __dynbuf;
2302 basic_string<_CharT> __wstr;
2303 basic_string_view<_CharT> __str;
2304 if constexpr (is_same_v<_CharT, char>)
2305 __str = __narrow_str;
2306 #ifdef _GLIBCXX_USE_WCHAR_T
2309 // _GLIBCXX_RESOLVE_LIB_DEFECTS
2310 // 4522. Clarify that `std::format` transcodes for `std::wformat_strings`
2311 __wstr = std::__to_wstring_numeric(__narrow_str);
2316 if (_M_spec._M_localized && __builtin_isfinite(__v))
2318 auto __s = _M_localize(__str, __expc, __fc.locale());
2320 __str = __wstr = std::move(__s);
2323 size_t __width = _M_spec._M_get_width(__fc);
2325 if (__width <= __str.size())
2326 return __format::__write(__fc.out(), __str);
2328 char32_t __fill_char = _M_spec._M_fill;
2329 _Align __align = _M_spec._M_align;
2331 size_t __nfill = __width - __str.size();
2332 auto __out = __fc.out();
2333 if (__align == _Align_default)
2335 __align = _Align_right;
2336 if (_M_spec._M_zero_fill && __builtin_isfinite(__v))
2338 __fill_char = _CharT('0');
2339 // Write sign before zero filling.
2340 if (!__format::__is_xdigit(__narrow_str[0]))
2342 *__out++ = __str[0];
2343 __str.remove_prefix(1);
2347 __fill_char = _CharT(' ');
2349 return __format::__write_padded(std::move(__out), __str,
2350 __align, __nfill, __fill_char);
2353 // Locale-specific format.
2354 basic_string<_CharT>
2355 _M_localize(basic_string_view<_CharT> __str, char __expc,
2356 const locale& __loc) const
2358 basic_string<_CharT> __lstr;
2360 if (__loc == locale::classic())
2361 return __lstr; // Nothing to do.
2363 const auto& __np = use_facet<numpunct<_CharT>>(__loc);
2364 const _CharT __point = __np.decimal_point();
2365 const string __grp = __np.grouping();
2367 _CharT __dot, __exp;
2368 if constexpr (is_same_v<_CharT, char>)
2391 __builtin_unreachable();
2395 if (__grp.empty() && __point == __dot)
2396 return __lstr; // Locale uses '.' and no grouping.
2398 size_t __d = __str.find(__dot); // Index of radix character (if any).
2399 size_t __e = min(__d, __str.find(__exp)); // First of radix or exponent
2400 if (__e == __str.npos)
2402 const size_t __r = __str.size() - __e; // Length of remainder.
2403 auto __overwrite = [&](_CharT* __p, size_t) {
2404 // Apply grouping to the digits before the radix or exponent.
2406 if (auto __c = __str.front(); __c == '-' || __c == '+' || __c == ' ')
2411 auto __end = std::__add_grouping(__p + __off, __np.thousands_sep(),
2412 __grp.data(), __grp.size(),
2413 __str.data() + __off,
2414 __str.data() + __e);
2415 if (__r) // If there's a fractional part or exponent
2417 if (__d != __str.npos)
2419 *__end = __point; // Add the locale's radix character.
2423 const size_t __rlen = __str.size() - __e;
2424 // Append fractional digits and/or exponent:
2425 char_traits<_CharT>::copy(__end, __str.data() + __e, __rlen);
2428 return (__end - __p);
2430 __lstr.__resize_and_overwrite(__e * 2 + __r, __overwrite);
2434 _Spec<_CharT> _M_spec{};
2437 template<__format::__char _CharT>
2438 struct __formatter_ptr
2441 __formatter_ptr() noexcept
2444 _M_spec._M_type = _Pres_p;
2445 _M_spec._M_alt = true;
2449 __formatter_ptr(_Spec<_CharT> __spec) noexcept
2451 { _M_set_default(_Pres_p); }
2453 constexpr typename basic_format_parse_context<_CharT>::iterator
2454 parse(basic_format_parse_context<_CharT>& __pc, _Pres_type __type = _Pres_p)
2456 __format::_Spec<_CharT> __spec{};
2457 const auto __last = __pc.end();
2458 auto __first = __pc.begin();
2460 auto __finalize = [this, &__spec, __type] {
2462 _M_set_default(__type);
2465 auto __finished = [&] {
2466 if (__first == __last || *__first == '}')
2477 __first = __spec._M_parse_fill_and_align(__first, __last);
2481 // _GLIBCXX_RESOLVE_LIB_DEFECTS
2482 // P2510R3 Formatting pointers
2483 #if __glibcxx_format >= 202304L
2484 __first = __spec._M_parse_zero_fill(__first, __last);
2489 __first = __spec._M_parse_width(__first, __last, __pc);
2493 if (*__first == 'p')
2495 __spec._M_type = _Pres_p;
2496 __spec._M_alt = !__spec._M_alt;
2499 #if __glibcxx_format >= 202304L
2500 else if (*__first == 'P')
2502 __spec._M_type = _Pres_P;
2503 __spec._M_alt = !__spec._M_alt;
2511 __format::__failed_to_parse_format_spec();
2514 template<typename _Out>
2515 typename basic_format_context<_Out, _CharT>::iterator
2516 format(const void* __v, basic_format_context<_Out, _CharT>& __fc) const
2518 auto __u = reinterpret_cast<__UINTPTR_TYPE__>(__v);
2519 return __formatter_int<_CharT>(_M_spec).format(__u, __fc);
2523 [[__gnu__::__always_inline__]]
2525 _M_set_default(_Pres_type __type)
2527 if (_M_spec._M_type == _Pres_none && __type != _Pres_none)
2529 _M_spec._M_type = __type;
2530 _M_spec._M_alt = !_M_spec._M_alt;
2534 __format::_Spec<_CharT> _M_spec;
2537 } // namespace __format
2540 /// Format a character.
2541 template<__format::__char _CharT>
2542 struct formatter<_CharT, _CharT>
2544 formatter() = default;
2546 constexpr typename basic_format_parse_context<_CharT>::iterator
2547 parse(basic_format_parse_context<_CharT>& __pc)
2549 return _M_f.template _M_parse<_CharT>(__pc);
2552 template<typename _Out>
2553 typename basic_format_context<_Out, _CharT>::iterator
2554 format(_CharT __u, basic_format_context<_Out, _CharT>& __fc) const
2556 if (_M_f._M_spec._M_type == __format::_Pres_c)
2557 return _M_f._M_format_character(__u, __fc);
2559 return _M_f.format(static_cast<make_unsigned_t<_CharT>>(__u), __fc);
2562 #if __glibcxx_format_ranges // C++ >= 23 && HOSTED
2564 set_debug_format() noexcept
2565 { _M_f._M_spec._M_debug = true; }
2569 __format::__formatter_int<_CharT> _M_f;
2572 #if __glibcxx_print >= 202403L
2573 template<__format::__char _CharT>
2574 constexpr bool enable_nonlocking_formatter_optimization<_CharT> = true;
2577 #ifdef _GLIBCXX_USE_WCHAR_T
2578 /// Format a char value for wide character output.
2580 struct formatter<char, wchar_t>
2582 formatter() = default;
2584 constexpr typename basic_format_parse_context<wchar_t>::iterator
2585 parse(basic_format_parse_context<wchar_t>& __pc)
2587 return _M_f._M_parse<char>(__pc);
2590 template<typename _Out>
2591 typename basic_format_context<_Out, wchar_t>::iterator
2592 format(char __u, basic_format_context<_Out, wchar_t>& __fc) const
2594 if (_M_f._M_spec._M_type == __format::_Pres_c)
2595 return _M_f._M_format_character(__u, __fc);
2597 return _M_f.format(static_cast<unsigned char>(__u), __fc);
2600 #if __glibcxx_format_ranges // C++ >= 23 && HOSTED
2602 set_debug_format() noexcept
2603 { _M_f._M_spec._M_debug = true; }
2607 __format::__formatter_int<wchar_t> _M_f;
2609 #endif // USE_WCHAR_T
2611 /** Format a string.
2614 template<__format::__char _CharT>
2615 struct formatter<_CharT*, _CharT>
2617 formatter() = default;
2619 [[__gnu__::__always_inline__]]
2620 constexpr typename basic_format_parse_context<_CharT>::iterator
2621 parse(basic_format_parse_context<_CharT>& __pc)
2622 { return _M_f.parse(__pc); }
2624 template<typename _Out>
2625 [[__gnu__::__nonnull__]]
2626 typename basic_format_context<_Out, _CharT>::iterator
2627 format(_CharT* __u, basic_format_context<_Out, _CharT>& __fc) const
2628 { return _M_f.format(__u, __fc); }
2630 #if __glibcxx_format_ranges // C++ >= 23 && HOSTED
2631 constexpr void set_debug_format() noexcept { _M_f.set_debug_format(); }
2635 __format::__formatter_str<_CharT> _M_f;
2638 #if __glibcxx_print >= 202403L
2639 template<__format::__char _CharT>
2640 constexpr bool enable_nonlocking_formatter_optimization<_CharT*> = true;
2643 template<__format::__char _CharT>
2644 struct formatter<const _CharT*, _CharT>
2646 formatter() = default;
2648 [[__gnu__::__always_inline__]]
2649 constexpr typename basic_format_parse_context<_CharT>::iterator
2650 parse(basic_format_parse_context<_CharT>& __pc)
2651 { return _M_f.parse(__pc); }
2653 template<typename _Out>
2654 [[__gnu__::__nonnull__]]
2655 typename basic_format_context<_Out, _CharT>::iterator
2656 format(const _CharT* __u,
2657 basic_format_context<_Out, _CharT>& __fc) const
2658 { return _M_f.format(__u, __fc); }
2660 #if __glibcxx_format_ranges // C++ >= 23 && HOSTED
2661 constexpr void set_debug_format() noexcept { _M_f.set_debug_format(); }
2665 __format::__formatter_str<_CharT> _M_f;
2668 #if __glibcxx_print >= 202403L
2669 template<__format::__char _CharT>
2671 enable_nonlocking_formatter_optimization<const _CharT*> = true;
2674 template<__format::__char _CharT, size_t _Nm>
2675 struct formatter<_CharT[_Nm], _CharT>
2677 formatter() = default;
2679 [[__gnu__::__always_inline__]]
2680 constexpr typename basic_format_parse_context<_CharT>::iterator
2681 parse(basic_format_parse_context<_CharT>& __pc)
2682 { return _M_f.parse(__pc); }
2684 template<typename _Out>
2685 typename basic_format_context<_Out, _CharT>::iterator
2686 format(const _CharT (&__u)[_Nm],
2687 basic_format_context<_Out, _CharT>& __fc) const
2688 { return _M_f.format({__u, _Nm}, __fc); }
2690 #if __glibcxx_format_ranges // C++ >= 23 && HOSTED
2691 constexpr void set_debug_format() noexcept { _M_f.set_debug_format(); }
2695 __format::__formatter_str<_CharT> _M_f;
2698 #if __glibcxx_print >= 202403L
2699 template<__format::__char _CharT, size_t _Nm>
2700 constexpr bool enable_nonlocking_formatter_optimization<_CharT[_Nm]> = true;
2703 template<typename _Traits, typename _Alloc>
2704 struct formatter<basic_string<char, _Traits, _Alloc>, char>
2706 formatter() = default;
2708 [[__gnu__::__always_inline__]]
2709 constexpr typename basic_format_parse_context<char>::iterator
2710 parse(basic_format_parse_context<char>& __pc)
2711 { return _M_f.parse(__pc); }
2713 template<typename _Out>
2714 typename basic_format_context<_Out, char>::iterator
2715 format(const basic_string<char, _Traits, _Alloc>& __u,
2716 basic_format_context<_Out, char>& __fc) const
2717 { return _M_f.format(__u, __fc); }
2719 #if __glibcxx_format_ranges // C++ >= 23 && HOSTED
2720 constexpr void set_debug_format() noexcept { _M_f.set_debug_format(); }
2724 __format::__formatter_str<char> _M_f;
2727 #if __glibcxx_print >= 202403L
2728 template<typename _Tr, typename _Alloc>
2730 enable_nonlocking_formatter_optimization<basic_string<char, _Tr, _Alloc>>
2734 #ifdef _GLIBCXX_USE_WCHAR_T
2735 template<typename _Traits, typename _Alloc>
2736 struct formatter<basic_string<wchar_t, _Traits, _Alloc>, wchar_t>
2738 formatter() = default;
2740 [[__gnu__::__always_inline__]]
2741 constexpr typename basic_format_parse_context<wchar_t>::iterator
2742 parse(basic_format_parse_context<wchar_t>& __pc)
2743 { return _M_f.parse(__pc); }
2745 template<typename _Out>
2746 typename basic_format_context<_Out, wchar_t>::iterator
2747 format(const basic_string<wchar_t, _Traits, _Alloc>& __u,
2748 basic_format_context<_Out, wchar_t>& __fc) const
2749 { return _M_f.format(__u, __fc); }
2751 #if __glibcxx_format_ranges // C++ >= 23 && HOSTED
2752 constexpr void set_debug_format() noexcept { _M_f.set_debug_format(); }
2756 __format::__formatter_str<wchar_t> _M_f;
2759 #if __glibcxx_print >= 202403L
2760 template<typename _Tr, typename _Alloc>
2762 enable_nonlocking_formatter_optimization<basic_string<wchar_t, _Tr, _Alloc>>
2766 #endif // USE_WCHAR_T
2768 template<typename _Traits>
2769 struct formatter<basic_string_view<char, _Traits>, char>
2771 formatter() = default;
2773 [[__gnu__::__always_inline__]]
2774 constexpr typename basic_format_parse_context<char>::iterator
2775 parse(basic_format_parse_context<char>& __pc)
2776 { return _M_f.parse(__pc); }
2778 template<typename _Out>
2779 typename basic_format_context<_Out, char>::iterator
2780 format(basic_string_view<char, _Traits> __u,
2781 basic_format_context<_Out, char>& __fc) const
2782 { return _M_f.format(__u, __fc); }
2784 #if __glibcxx_format_ranges // C++ >= 23 && HOSTED
2785 constexpr void set_debug_format() noexcept { _M_f.set_debug_format(); }
2789 __format::__formatter_str<char> _M_f;
2792 #if __glibcxx_print >= 202403L
2793 template<typename _Tr>
2795 enable_nonlocking_formatter_optimization<basic_string_view<char, _Tr>>
2799 #ifdef _GLIBCXX_USE_WCHAR_T
2800 template<typename _Traits>
2801 struct formatter<basic_string_view<wchar_t, _Traits>, wchar_t>
2803 formatter() = default;
2805 [[__gnu__::__always_inline__]]
2806 constexpr typename basic_format_parse_context<wchar_t>::iterator
2807 parse(basic_format_parse_context<wchar_t>& __pc)
2808 { return _M_f.parse(__pc); }
2810 template<typename _Out>
2811 typename basic_format_context<_Out, wchar_t>::iterator
2812 format(basic_string_view<wchar_t, _Traits> __u,
2813 basic_format_context<_Out, wchar_t>& __fc) const
2814 { return _M_f.format(__u, __fc); }
2816 #if __glibcxx_format_ranges // C++ >= 23 && HOSTED
2817 constexpr void set_debug_format() noexcept { _M_f.set_debug_format(); }
2821 __format::__formatter_str<wchar_t> _M_f;
2824 #if __glibcxx_print >= 202403L
2825 template<typename _Tr>
2827 enable_nonlocking_formatter_optimization<basic_string_view<wchar_t, _Tr>>
2830 #endif // USE_WCHAR_T
2833 /// @cond undocumented
2836 // each cv-unqualified arithmetic type ArithmeticT other than
2837 // char, wchar_t, char8_t, char16_t, or char32_t
2838 template<typename _Tp>
2839 constexpr bool __is_formattable_integer = __is_integer<_Tp>::__value;
2841 #if defined __SIZEOF_INT128__
2842 template<> inline constexpr bool __is_formattable_integer<__int128> = true;
2843 template<> inline constexpr bool __is_formattable_integer<unsigned __int128>
2847 template<> inline constexpr bool __is_formattable_integer<char> = false;
2848 template<> inline constexpr bool __is_formattable_integer<wchar_t> = false;
2849 #ifdef _GLIBCXX_USE_CHAR8_T
2850 template<> inline constexpr bool __is_formattable_integer<char8_t> = false;
2852 template<> inline constexpr bool __is_formattable_integer<char16_t> = false;
2853 template<> inline constexpr bool __is_formattable_integer<char32_t> = false;
2855 template<typename _Tp>
2856 concept __formattable_integer = __is_formattable_integer<_Tp>;
2860 /// Format an integer.
2861 template<__format::__formattable_integer _Tp, __format::__char _CharT>
2862 struct formatter<_Tp, _CharT>
2864 formatter() = default;
2866 [[__gnu__::__always_inline__]]
2867 constexpr typename basic_format_parse_context<_CharT>::iterator
2868 parse(basic_format_parse_context<_CharT>& __pc)
2870 return _M_f.template _M_parse<_Tp>(__pc);
2873 template<typename _Out>
2874 typename basic_format_context<_Out, _CharT>::iterator
2875 format(_Tp __u, basic_format_context<_Out, _CharT>& __fc) const
2876 { return _M_f.format(__u, __fc); }
2879 __format::__formatter_int<_CharT> _M_f;
2882 #if __glibcxx_print >= 202403L
2883 template<__format::__formattable_integer _Tp>
2885 enable_nonlocking_formatter_optimization<_Tp> = true;
2888 #if defined __glibcxx_to_chars
2889 /// Format a floating-point value.
2890 template<__format::__formattable_float _Tp, __format::__char _CharT>
2891 struct formatter<_Tp, _CharT>
2893 formatter() = default;
2895 [[__gnu__::__always_inline__]]
2896 constexpr typename basic_format_parse_context<_CharT>::iterator
2897 parse(basic_format_parse_context<_CharT>& __pc)
2898 { return _M_f.parse(__pc); }
2900 template<typename _Out>
2901 typename basic_format_context<_Out, _CharT>::iterator
2902 format(_Tp __u, basic_format_context<_Out, _CharT>& __fc) const
2903 { return _M_f.format(__u, __fc); }
2906 __format::__formatter_fp<_CharT> _M_f;
2909 #if __glibcxx_print >= 202403L
2910 template<__format::__formattable_float _Tp>
2912 enable_nonlocking_formatter_optimization<_Tp> = true;
2915 #if __LDBL_MANT_DIG__ == __DBL_MANT_DIG__
2916 // Reuse __formatter_fp<C>::format<double, Out> for long double.
2917 template<__format::__char _CharT>
2918 struct formatter<long double, _CharT>
2920 formatter() = default;
2922 [[__gnu__::__always_inline__]]
2923 constexpr typename basic_format_parse_context<_CharT>::iterator
2924 parse(basic_format_parse_context<_CharT>& __pc)
2925 { return _M_f.parse(__pc); }
2927 template<typename _Out>
2928 typename basic_format_context<_Out, _CharT>::iterator
2929 format(long double __u, basic_format_context<_Out, _CharT>& __fc) const
2930 { return _M_f.format((double)__u, __fc); }
2933 __format::__formatter_fp<_CharT> _M_f;
2937 #if defined(__STDCPP_FLOAT16_T__) && defined(_GLIBCXX_FLOAT_IS_IEEE_BINARY32)
2938 // Reuse __formatter_fp<C>::format<float, Out> for _Float16.
2939 template<__format::__char _CharT>
2940 struct formatter<_Float16, _CharT>
2942 formatter() = default;
2944 [[__gnu__::__always_inline__]]
2945 constexpr typename basic_format_parse_context<_CharT>::iterator
2946 parse(basic_format_parse_context<_CharT>& __pc)
2947 { return _M_f.parse(__pc); }
2949 template<typename _Out>
2950 typename basic_format_context<_Out, _CharT>::iterator
2951 format(_Float16 __u, basic_format_context<_Out, _CharT>& __fc) const
2952 { return _M_f.format((float)__u, __fc); }
2955 __format::__formatter_fp<_CharT> _M_f;
2959 #if defined(__FLT32_DIG__) && defined(_GLIBCXX_FLOAT_IS_IEEE_BINARY32)
2960 // Reuse __formatter_fp<C>::format<float, Out> for _Float32.
2961 template<__format::__char _CharT>
2962 struct formatter<_Float32, _CharT>
2964 formatter() = default;
2966 [[__gnu__::__always_inline__]]
2967 constexpr typename basic_format_parse_context<_CharT>::iterator
2968 parse(basic_format_parse_context<_CharT>& __pc)
2969 { return _M_f.parse(__pc); }
2971 template<typename _Out>
2972 typename basic_format_context<_Out, _CharT>::iterator
2973 format(_Float32 __u, basic_format_context<_Out, _CharT>& __fc) const
2974 { return _M_f.format((float)__u, __fc); }
2977 __format::__formatter_fp<_CharT> _M_f;
2981 #if defined(__FLT64_DIG__) && defined(_GLIBCXX_DOUBLE_IS_IEEE_BINARY64)
2982 // Reuse __formatter_fp<C>::format<double, Out> for _Float64.
2983 template<__format::__char _CharT>
2984 struct formatter<_Float64, _CharT>
2986 formatter() = default;
2988 [[__gnu__::__always_inline__]]
2989 constexpr typename basic_format_parse_context<_CharT>::iterator
2990 parse(basic_format_parse_context<_CharT>& __pc)
2991 { return _M_f.parse(__pc); }
2993 template<typename _Out>
2994 typename basic_format_context<_Out, _CharT>::iterator
2995 format(_Float64 __u, basic_format_context<_Out, _CharT>& __fc) const
2996 { return _M_f.format((double)__u, __fc); }
2999 __format::__formatter_fp<_CharT> _M_f;
3003 #if defined(__FLT128_DIG__) && _GLIBCXX_FORMAT_F128
3004 // Use __formatter_fp<C>::format<__format::__flt128_t, Out> for _Float128.
3005 template<__format::__char _CharT>
3006 struct formatter<_Float128, _CharT>
3008 formatter() = default;
3010 [[__gnu__::__always_inline__]]
3011 constexpr typename basic_format_parse_context<_CharT>::iterator
3012 parse(basic_format_parse_context<_CharT>& __pc)
3013 { return _M_f.parse(__pc); }
3015 template<typename _Out>
3016 typename basic_format_context<_Out, _CharT>::iterator
3017 format(_Float128 __u, basic_format_context<_Out, _CharT>& __fc) const
3018 { return _M_f.format((__format::__flt128_t)__u, __fc); }
3021 __format::__formatter_fp<_CharT> _M_f;
3025 #if defined(__SIZEOF_FLOAT128__) && _GLIBCXX_FORMAT_F128 == 2
3026 // Use __formatter_fp<C>::format<__format::__flt128_t, Out> for __float128,
3027 // when long double is not 128bit IEEE type.
3028 template<__format::__char _CharT>
3029 struct formatter<__float128, _CharT>
3031 formatter() = default;
3033 [[__gnu__::__always_inline__]]
3034 constexpr typename basic_format_parse_context<_CharT>::iterator
3035 parse(basic_format_parse_context<_CharT>& __pc)
3036 { return _M_f.parse(__pc); }
3038 template<typename _Out>
3039 typename basic_format_context<_Out, _CharT>::iterator
3040 format(__float128 __u, basic_format_context<_Out, _CharT>& __fc) const
3041 { return _M_f.format((__format::__flt128_t)__u, __fc); }
3044 __format::__formatter_fp<_CharT> _M_f;
3048 #if defined(__STDCPP_BFLOAT16_T__) && defined(_GLIBCXX_FLOAT_IS_IEEE_BINARY32)
3049 // Reuse __formatter_fp<C>::format<float, Out> for bfloat16_t.
3050 template<__format::__char _CharT>
3051 struct formatter<__format::__bflt16_t, _CharT>
3053 formatter() = default;
3055 [[__gnu__::__always_inline__]]
3056 constexpr typename basic_format_parse_context<_CharT>::iterator
3057 parse(basic_format_parse_context<_CharT>& __pc)
3058 { return _M_f.parse(__pc); }
3060 template<typename _Out>
3061 typename basic_format_context<_Out, _CharT>::iterator
3062 format(__gnu_cxx::__bfloat16_t __u,
3063 basic_format_context<_Out, _CharT>& __fc) const
3064 { return _M_f.format((float)__u, __fc); }
3067 __format::__formatter_fp<_CharT> _M_f;
3070 #endif // __cpp_lib_to_chars
3072 /** Format a pointer.
3075 template<__format::__char _CharT>
3076 struct formatter<const void*, _CharT>
3078 formatter() = default;
3080 constexpr typename basic_format_parse_context<_CharT>::iterator
3081 parse(basic_format_parse_context<_CharT>& __pc)
3082 { return _M_f.parse(__pc); }
3084 template<typename _Out>
3085 typename basic_format_context<_Out, _CharT>::iterator
3086 format(const void* __v, basic_format_context<_Out, _CharT>& __fc) const
3087 { return _M_f.format(__v, __fc); }
3090 __format::__formatter_ptr<_CharT> _M_f;
3093 #if __glibcxx_print >= 202403L
3095 inline constexpr bool
3096 enable_nonlocking_formatter_optimization<const void*> = true;
3099 template<__format::__char _CharT>
3100 struct formatter<void*, _CharT>
3102 formatter() = default;
3104 [[__gnu__::__always_inline__]]
3105 constexpr typename basic_format_parse_context<_CharT>::iterator
3106 parse(basic_format_parse_context<_CharT>& __pc)
3107 { return _M_f.parse(__pc); }
3109 template<typename _Out>
3110 typename basic_format_context<_Out, _CharT>::iterator
3111 format(void* __v, basic_format_context<_Out, _CharT>& __fc) const
3112 { return _M_f.format(__v, __fc); }
3115 __format::__formatter_ptr<_CharT> _M_f;
3118 #if __glibcxx_print >= 202403l
3120 inline constexpr bool
3121 enable_nonlocking_formatter_optimization<void*> = true;
3124 template<__format::__char _CharT>
3125 struct formatter<nullptr_t, _CharT>
3127 formatter() = default;
3129 [[__gnu__::__always_inline__]]
3130 constexpr typename basic_format_parse_context<_CharT>::iterator
3131 parse(basic_format_parse_context<_CharT>& __pc)
3132 { return _M_f.parse(__pc); }
3134 template<typename _Out>
3135 typename basic_format_context<_Out, _CharT>::iterator
3136 format(nullptr_t, basic_format_context<_Out, _CharT>& __fc) const
3137 { return _M_f.format(nullptr, __fc); }
3140 __format::__formatter_ptr<_CharT> _M_f;
3144 #if __glibcxx_print >= 202403L
3146 inline constexpr bool
3147 enable_nonlocking_formatter_optimization<nullptr_t> = true;
3150 #if defined _GLIBCXX_USE_WCHAR_T && __glibcxx_format_ranges
3151 // _GLIBCXX_RESOLVE_LIB_DEFECTS
3152 // 3944. Formatters converting sequences of char to sequences of wchar_t
3154 struct __formatter_disabled
3156 __formatter_disabled() = delete; // Cannot format char sequence to wchar_t
3157 __formatter_disabled(const __formatter_disabled&) = delete;
3158 __formatter_disabled& operator=(const __formatter_disabled&) = delete;
3162 struct formatter<char*, wchar_t>
3163 : private __formatter_disabled { };
3165 struct formatter<const char*, wchar_t>
3166 : private __formatter_disabled { };
3167 template<size_t _Nm>
3168 struct formatter<char[_Nm], wchar_t>
3169 : private __formatter_disabled { };
3170 template<class _Traits, class _Allocator>
3171 struct formatter<basic_string<char, _Traits, _Allocator>, wchar_t>
3172 : private __formatter_disabled { };
3173 template<class _Traits>
3174 struct formatter<basic_string_view<char, _Traits>, wchar_t>
3175 : private __formatter_disabled { };
3178 /// An iterator after the last character written, and the number of
3179 /// characters that would have been written.
3180 template<typename _Out>
3181 struct format_to_n_result
3184 iter_difference_t<_Out> size;
3187 _GLIBCXX_BEGIN_NAMESPACE_CONTAINER
3188 template<typename, typename> class vector;
3189 _GLIBCXX_END_NAMESPACE_CONTAINER
3191 /// @cond undocumented
3194 template<typename _CharT>
3198 using iterator_category = output_iterator_tag;
3199 using value_type = void;
3200 using difference_type = ptrdiff_t;
3201 using pointer = void;
3202 using reference = void;
3204 _Drop_iter() = default;
3205 _Drop_iter(const _Drop_iter&) = default;
3206 _Drop_iter& operator=(const _Drop_iter&) = default;
3208 [[__gnu__::__always_inline__]]
3209 constexpr _Drop_iter&
3210 operator=(_CharT __c)
3213 [[__gnu__::__always_inline__]]
3214 constexpr _Drop_iter&
3215 operator=(basic_string_view<_CharT> __s)
3218 [[__gnu__::__always_inline__]]
3219 constexpr _Drop_iter&
3220 operator*() { return *this; }
3222 [[__gnu__::__always_inline__]]
3223 constexpr _Drop_iter&
3224 operator++() { return *this; }
3226 [[__gnu__::__always_inline__]]
3227 constexpr _Drop_iter
3228 operator++(int) { return *this; }
3231 template<typename _CharT>
3234 _Sink<_CharT>* _M_sink = nullptr;
3237 using iterator_category = output_iterator_tag;
3238 using value_type = void;
3239 using difference_type = ptrdiff_t;
3240 using pointer = void;
3241 using reference = void;
3243 _Sink_iter() = default;
3244 _Sink_iter(const _Sink_iter&) = default;
3245 _Sink_iter& operator=(const _Sink_iter&) = default;
3247 [[__gnu__::__always_inline__]]
3249 _Sink_iter(_Sink<_CharT>& __sink) : _M_sink(std::addressof(__sink)) { }
3251 [[__gnu__::__always_inline__]]
3252 constexpr _Sink_iter&
3253 operator=(_CharT __c)
3255 _M_sink->_M_write(__c);
3259 [[__gnu__::__always_inline__]]
3260 constexpr _Sink_iter&
3261 operator=(basic_string_view<_CharT> __s)
3263 _M_sink->_M_write(__s);
3267 [[__gnu__::__always_inline__]]
3268 constexpr _Sink_iter&
3269 operator*() { return *this; }
3271 [[__gnu__::__always_inline__]]
3272 constexpr _Sink_iter&
3273 operator++() { return *this; }
3275 [[__gnu__::__always_inline__]]
3276 constexpr _Sink_iter
3277 operator++(int) { return *this; }
3280 _M_reserve(size_t __n) const
3281 { return _M_sink->_M_reserve(__n); }
3284 _M_discarding() const
3285 { return _M_sink->_M_discarding(); }
3288 // Abstract base class for type-erased character sinks.
3289 // All formatting and output is done via this type's iterator,
3290 // to reduce the number of different template instantiations.
3291 template<typename _CharT>
3294 friend class _Sink_iter<_CharT>;
3296 span<_CharT> _M_span;
3297 typename span<_CharT>::iterator _M_next;
3299 // Called when the span is full, to make more space available.
3300 // Precondition: _M_next != _M_span.begin()
3301 // Postcondition: _M_next != _M_span.end()
3302 // TODO: remove the precondition? could make overflow handle it.
3303 virtual void _M_overflow() = 0;
3306 // Precondition: __span.size() != 0
3307 [[__gnu__::__always_inline__]]
3309 _Sink(span<_CharT> __span) noexcept
3310 : _M_span(__span), _M_next(__span.begin())
3313 // The portion of the span that has been written to.
3314 [[__gnu__::__always_inline__]]
3316 _M_used() const noexcept
3317 { return _M_span.first(_M_next - _M_span.begin()); }
3319 // The portion of the span that has not been written to.
3320 [[__gnu__::__always_inline__]]
3321 constexpr span<_CharT>
3322 _M_unused() const noexcept
3323 { return _M_span.subspan(_M_next - _M_span.begin()); }
3325 // Use the start of the span as the next write position.
3326 [[__gnu__::__always_inline__]]
3328 _M_rewind() noexcept
3329 { _M_next = _M_span.begin(); }
3331 // Replace the current output range.
3333 _M_reset(span<_CharT> __s, size_t __pos = 0) noexcept
3336 _M_next = __s.begin() + __pos;
3339 // Called by the iterator for *it++ = c
3341 _M_write(_CharT __c)
3344 if (_M_next - _M_span.begin() == std::ssize(_M_span)) [[unlikely]]
3349 _M_write(basic_string_view<_CharT> __s)
3351 span __to = _M_unused();
3352 while (__to.size() <= __s.size())
3354 __s.copy(__to.data(), __to.size());
3355 _M_next += __to.size();
3356 __s.remove_prefix(__to.size());
3362 __s.copy(__to.data(), __s.size());
3363 _M_next += __s.size();
3367 // A successful _Reservation can be used to directly write
3368 // up to N characters to the sink to avoid unwanted buffering.
3371 // True if the reservation was successful, false otherwise.
3372 explicit operator bool() const noexcept { return _M_sink; }
3373 // A pointer to write directly to the sink.
3374 _CharT* get() const noexcept { return _M_sink->_M_next.operator->(); }
3375 // Add n to the _M_next iterator for the sink.
3376 void _M_bump(size_t __n) { _M_sink->_M_bump(__n); }
3380 // Attempt to reserve space to write n characters to the sink.
3381 // If anything is written to the reservation then there must be a call
3382 // to _M_bump(N2) before any call to another member function of *this,
3383 // where N2 is the number of characters written.
3384 virtual _Reservation
3385 _M_reserve(size_t __n)
3387 if (__n <= _M_unused().size())
3390 if (__n <= _M_span.size()) // Cannot meet the request.
3392 _M_overflow(); // Make more space available.
3393 if (__n <= _M_unused().size())
3399 // Update the next output position after writing directly to the sink.
3400 // pre: no calls to _M_write or _M_overflow since _M_reserve.
3405 // Returns true if the _Sink is discarding incoming characters.
3407 _M_discarding() const
3411 _Sink(const _Sink&) = delete;
3412 _Sink& operator=(const _Sink&) = delete;
3414 [[__gnu__::__always_inline__]]
3415 constexpr _Sink_iter<_CharT>
3417 { return _Sink_iter<_CharT>(*this); }
3421 template<typename _CharT>
3422 class _Fixedbuf_sink final : public _Sink<_CharT>
3425 _M_overflow() override
3427 __glibcxx_assert(false);
3432 [[__gnu__::__always_inline__]]
3434 _Fixedbuf_sink(span<_CharT> __buf)
3435 : _Sink<_CharT>(__buf)
3438 constexpr basic_string_view<_CharT>
3441 auto __s = this->_M_used();
3442 return basic_string_view<_CharT>(__s.data(), __s.size());
3446 // A sink with an internal buffer. This is used to implement concrete sinks.
3447 template<typename _CharT>
3448 class _Buf_sink : public _Sink<_CharT>
3451 _CharT _M_buf[__stackbuf_size<_CharT>];
3453 [[__gnu__::__always_inline__]]
3455 _Buf_sink() noexcept
3456 : _Sink<_CharT>(_M_buf)
3460 using _GLIBCXX_STD_C::vector;
3462 // A sink that fills a sequence (e.g. std::string, std::vector, std::deque).
3463 // Writes to a buffer then appends that to the sequence when it fills up.
3464 template<typename _Seq>
3465 class _Seq_sink : public _Buf_sink<typename _Seq::value_type>
3467 using _CharT = typename _Seq::value_type;
3471 // Transfer buffer contents to the sequence, so buffer can be refilled.
3473 _M_overflow() override
3475 auto __s = this->_M_used();
3476 if (__s.empty()) [[unlikely]]
3477 return; // Nothing in the buffer to transfer to _M_seq.
3479 // If _M_reserve was called then _M_bump must have been called too.
3480 _GLIBCXX_DEBUG_ASSERT(__s.data() != _M_seq.data());
3482 if constexpr (__is_specialization_of<_Seq, basic_string>)
3483 _M_seq.append(__s.data(), __s.size());
3485 _M_seq.insert(_M_seq.end(), __s.begin(), __s.end());
3487 // Make the whole of _M_buf available for the next write:
3491 typename _Sink<_CharT>::_Reservation
3492 _M_reserve(size_t __n) override
3494 // We might already have n characters available in this->_M_unused(),
3495 // but the whole point of this function is to be an optimization for
3496 // the std::format("{}", x) case. We want to avoid writing to _M_buf
3497 // and then copying that into a basic_string if possible, so this
3498 // function prefers to create space directly in _M_seq rather than
3501 if constexpr (__is_specialization_of<_Seq, basic_string>
3502 || __is_specialization_of<_Seq, vector>)
3504 // Flush the buffer to _M_seq first (should not be needed).
3505 if (this->_M_used().size()) [[unlikely]]
3506 _Seq_sink::_M_overflow();
3508 // Expand _M_seq to make __n new characters available:
3509 const auto __sz = _M_seq.size();
3510 if constexpr (is_same_v<string, _Seq> || is_same_v<wstring, _Seq>)
3511 _M_seq.__resize_and_overwrite(__sz + __n,
3512 [](auto, auto __n2) {
3516 _M_seq.resize(__sz + __n);
3518 // Set _M_used() to be a span over the original part of _M_seq
3519 // and _M_unused() to be the extra capacity we just created:
3520 this->_M_reset(_M_seq, __sz);
3523 else // Try to use the base class' buffer.
3524 return _Sink<_CharT>::_M_reserve(__n);
3528 _M_bump(size_t __n) override
3530 if constexpr (__is_specialization_of<_Seq, basic_string>
3531 || __is_specialization_of<_Seq, vector>)
3533 auto __s = this->_M_used();
3534 _GLIBCXX_DEBUG_ASSERT(__s.data() == _M_seq.data());
3535 // Truncate the sequence to the part that was actually written to:
3536 _M_seq.resize(__s.size() + __n);
3537 // Switch back to using buffer:
3538 this->_M_reset(this->_M_buf);
3542 void _M_trim(span<const _CharT> __s)
3543 requires __is_specialization_of<_Seq, basic_string>
3545 _GLIBCXX_DEBUG_ASSERT(__s.data() == this->_M_buf
3546 || __s.data() == _M_seq.data());
3547 if (__s.data() == _M_seq.data())
3548 _M_seq.resize(__s.size());
3550 this->_M_reset(this->_M_buf, __s.size());
3554 // TODO: for SSO string, use SSO buffer as initial span, then switch
3555 // to _M_buf if it overflows? Or even do that for all unused capacity?
3557 [[__gnu__::__always_inline__]]
3558 _Seq_sink() noexcept(is_nothrow_default_constructible_v<_Seq>)
3561 _Seq_sink(_Seq&& __s) noexcept(is_nothrow_move_constructible_v<_Seq>)
3562 : _M_seq(std::move(__s))
3565 using _Sink<_CharT>::out;
3570 if (this->_M_used().size() != 0)
3571 _Seq_sink::_M_overflow();
3572 return std::move(_M_seq);
3575 // A writable span that views everything written to the sink.
3576 // Will be either a view over _M_seq or the used part of _M_buf.
3580 auto __s = this->_M_used();
3583 if (__s.size() != 0)
3584 _Seq_sink::_M_overflow();
3590 basic_string_view<_CharT>
3593 auto __span = _M_span();
3594 return basic_string_view<_CharT>(__span.data(), __span.size());
3598 template<typename _CharT, typename _Alloc = allocator<_CharT>>
3600 = _Seq_sink<basic_string<_CharT, char_traits<_CharT>, _Alloc>>;
3602 // template<typename _CharT, typename _Alloc = allocator<_CharT>>
3603 // using _Vec_sink = _Seq_sink<vector<_CharTthis-> sink that writes to an output iterator.
3604 // Writes to a fixed-size buffer and then flushes to the output iterator
3605 // when the buffer fills up.
3606 template<typename _CharT, typename _OutIter>
3607 class _Iter_sink : public _Buf_sink<_CharT>
3610 iter_difference_t<_OutIter> _M_max;
3613 size_t _M_count = 0;
3616 _M_overflow() override
3618 auto __s = this->_M_used();
3619 if (_M_max < 0) // No maximum.
3620 _M_out = ranges::copy(__s, std::move(_M_out)).out;
3621 else if (_M_count < static_cast<size_t>(_M_max))
3623 auto __max = _M_max - _M_count;
3624 span<_CharT> __first;
3625 if (__max < __s.size())
3626 __first = __s.first(static_cast<size_t>(__max));
3629 _M_out = ranges::copy(__first, std::move(_M_out)).out;
3632 _M_count += __s.size();
3636 _M_discarding() const override
3638 // format_to_n return total number of characters, that would be written,
3639 // see C++20 [format.functions] p20
3644 [[__gnu__::__always_inline__]]
3646 _Iter_sink(_OutIter __out, iter_difference_t<_OutIter> __max = -1)
3647 : _M_out(std::move(__out)), _M_max(__max)
3650 using _Sink<_CharT>::out;
3652 format_to_n_result<_OutIter>
3655 if (this->_M_used().size() != 0)
3656 _Iter_sink::_M_overflow();
3657 iter_difference_t<_OutIter> __count(_M_count);
3658 return { std::move(_M_out), __count };
3662 // Used for contiguous iterators.
3663 // No buffer is used, characters are written straight to the iterator.
3664 // We do not know the size of the output range, so the span size just grows
3665 // as needed. The end of the span might be an invalid pointer outside the
3666 // valid range, but we never actually call _M_span.end(). This class does
3667 // not introduce any invalid pointer arithmetic or overflows that would not
3668 // have happened anyway.
3669 template<typename _CharT>
3670 class _Ptr_sink : public _Sink<_CharT>
3672 static constexpr size_t _S_no_limit = size_t(-1);
3676 size_t _M_count = 0;
3678 _CharT _M_buf[64]; // Write here after outputting _M_max characters.
3682 _M_overflow() override
3684 if (this->_M_unused().size() != 0)
3685 return; // No need to switch to internal buffer yet.
3687 auto __s = this->_M_used();
3689 if (_M_max != _S_no_limit)
3691 _M_count += __s.size();
3692 // Span was already sized for the maximum character count,
3693 // if it overflows then any further output must go to the
3694 // internal buffer, to be discarded.
3695 this->_M_reset(this->_M_buf);
3699 // No maximum character count. Just extend the span to allow
3700 // writing more characters to it.
3701 _M_rebuf(__s.data(), __s.size() + 1024, __s.size());
3706 _M_discarding() const override
3708 // format_to_n return total number of characters, that would be written,
3709 // see C++20 [format.functions] p20
3713 typename _Sink<_CharT>::_Reservation
3714 _M_reserve(size_t __n) final
3716 auto __avail = this->_M_unused();
3717 if (__n > __avail.size())
3719 if (_M_max != _S_no_limit)
3720 return {}; // cannot grow
3722 auto __s = this->_M_used();
3723 _M_rebuf(__s.data(), __s.size() + __n, __s.size());
3729 template<typename _IterDifference>
3731 _S_trim_max(_IterDifference __max)
3735 if constexpr (!is_integral_v<_IterDifference> || sizeof(__max) > sizeof(size_t))
3736 // __int128 or __detail::__max_diff_type
3737 if (_IterDifference((size_t)-1) < __max)
3739 return size_t(__max);
3742 [[__gnu__::__always_inline__]]
3744 _M_rebuf(_CharT* __ptr, size_t __total, size_t __inuse = 0)
3746 std::span<_CharT> __span(__ptr, __total);
3747 this->_M_reset(__span, __inuse);
3752 _Ptr_sink(_CharT* __ptr, size_t __n = _S_no_limit) noexcept
3753 : _Sink<_CharT>(_M_buf), _M_max(__n)
3756 return; // Only write to the internal buffer.
3757 else if (__n != _S_no_limit)
3758 _M_rebuf(__ptr, __n);
3759 #if __has_builtin(__builtin_dynamic_object_size)
3760 else if (size_t __bytes = __builtin_dynamic_object_size(__ptr, 2))
3761 _M_rebuf(__ptr, __bytes / sizeof(_CharT));
3765 // Avoid forming a pointer to a different memory page.
3766 const auto __off = reinterpret_cast<__UINTPTR_TYPE__>(__ptr) % 1024;
3767 __n = (1024 - __off) / sizeof(_CharT);
3768 if (__n > 0) [[likely]]
3769 _M_rebuf(__ptr, __n);
3770 else // Misaligned/packed buffer of wchar_t?
3775 template<contiguous_iterator _OutIter>
3777 _Ptr_sink(_OutIter __out, iter_difference_t<_OutIter> __n = -1)
3778 : _Ptr_sink(std::to_address(__out), _S_trim_max(__n))
3781 template<contiguous_iterator _OutIter>
3782 format_to_n_result<_OutIter>
3783 _M_finish(_OutIter __first) const
3785 auto __s = this->_M_used();
3786 if (__s.data() == _M_buf)
3788 // Switched to internal buffer, so must have written _M_max.
3789 iter_difference_t<_OutIter> __m(_M_max);
3790 iter_difference_t<_OutIter> __count(_M_count + __s.size());
3791 return { __first + __m, __count };
3793 else // Not using internal buffer yet
3795 iter_difference_t<_OutIter> __count(__s.size());
3796 return { __first + __count, __count };
3801 template<typename _CharT, typename _OutIter>
3802 concept __contiguous_char_iter
3803 = contiguous_iterator<_OutIter>
3804 && same_as<iter_value_t<_OutIter>, _CharT>;
3806 // A sink for handling the padded outputs (_M_padwidth) or truncated
3807 // (_M_maxwidth). The handling is done by writting to buffer (_Str_strink)
3808 // until sufficient number of characters is written. After that if sequence
3809 // is longer than _M_padwidth it's written to _M_out, and further writes are
3811 // * buffered and forwarded to _M_out, if below _M_maxwidth,
3812 // * ignored otherwise
3813 // If field width of written sequence is no greater than _M_padwidth, the
3814 // sequence is written during _M_finish call.
3815 template<typename _Out, typename _CharT>
3816 class _Padding_sink : public _Str_sink<_CharT>
3821 size_t _M_printwidth;
3823 [[__gnu__::__always_inline__]]
3826 { return _M_printwidth >= _M_maxwidth; }
3828 [[__gnu__::__always_inline__]]
3830 _M_buffering() const
3832 if (_M_printwidth < _M_padwidth)
3834 if (_M_maxwidth != (size_t)-1)
3835 return _M_printwidth < _M_maxwidth;
3840 _M_sync_discarding()
3842 if constexpr (is_same_v<_Out, _Sink_iter<_CharT>>)
3843 if (_M_out._M_discarding())
3844 _M_maxwidth = _M_printwidth;
3850 span<_CharT> __new = this->_M_used();
3851 basic_string_view<_CharT> __str(__new.data(), __new.size());
3852 _M_out = __format::__write(std::move(_M_out), __str);
3853 _M_sync_discarding();
3860 auto __str = this->view();
3861 // Compute actual field width, possibly truncated.
3862 _M_printwidth = __format::__truncate(__str, _M_maxwidth);
3864 this->_M_trim(__str);
3868 // We have more characters than padidng, no padding is needed,
3869 // write direclty to _M_out.
3870 if (_M_printwidth >= _M_padwidth)
3872 _M_out = __format::__write(std::move(_M_out), __str);
3873 _M_sync_discarding();
3875 // We reached _M_maxwidth that is smaller than _M_padwidth.
3876 // Store the prefix sequence in _M_seq, and free _M_buf.
3878 _Str_sink<_CharT>::_M_overflow();
3880 // Use internal buffer for writes to _M_out.
3881 this->_M_reset(this->_M_buf);
3886 _M_update(size_t __new)
3888 _M_printwidth += __new;
3889 // Compute estimated width, to see if is not reduced.
3890 if (_M_printwidth >= _M_padwidth || _M_printwidth >= _M_maxwidth)
3891 return _M_force_update();
3896 _M_overflow() override
3898 // Ignore characters in buffer, and override it.
3901 // Write buffer to _M_out, and override it.
3902 else if (!_M_buffering())
3904 // Update written count, and if input still should be buffered,
3905 // flush the to _M_seq.
3906 else if (_M_update(this->_M_used().size()))
3907 _Str_sink<_CharT>::_M_overflow();
3911 _M_discarding() const override
3912 { return _M_ignoring(); }
3914 typename _Sink<_CharT>::_Reservation
3915 _M_reserve(size_t __n) override
3917 // Ignore characters in buffer, if any.
3920 else if constexpr (is_same_v<_Out, _Sink_iter<_CharT>>)
3921 if (!_M_buffering())
3923 // Write pending characters if any
3924 if (!this->_M_used().empty())
3926 // Try to reserve from _M_out sink.
3927 if (auto __reserved = _M_out._M_reserve(__n))
3930 return _Sink<_CharT>::_M_reserve(__n);
3934 _M_bump(size_t __n) override
3936 // Ignore the written characters.
3939 // If reservation was made directy sink associated _M_out,
3940 // _M_bump will be called on that sink.
3941 _Sink<_CharT>::_M_bump(__n);
3947 [[__gnu__::__always_inline__]]
3949 _Padding_sink(_Out __out, size_t __padwidth, size_t __maxwidth)
3950 : _M_padwidth(__padwidth), _M_maxwidth(__maxwidth),
3951 _M_out(std::move(__out)), _M_printwidth(0)
3952 { _M_sync_discarding(); }
3954 [[__gnu__::__always_inline__]]
3956 _Padding_sink(_Out __out, size_t __padwidth)
3957 : _Padding_sink(std::move(__out), __padwidth, (size_t)-1)
3961 _M_finish(_Align __align, char32_t __fill_char)
3963 // Handle any characters in the buffer.
3964 if (auto __rem = this->_M_used().size())
3968 else if (!_M_buffering())
3974 if (!_M_buffering() || !_M_force_update())
3975 // Characters were already written to _M_out.
3976 if (_M_printwidth >= _M_padwidth)
3977 return std::move(_M_out);
3979 const auto __str = this->view();
3980 if (_M_printwidth >= _M_padwidth)
3981 return __format::__write(std::move(_M_out), __str);
3983 const size_t __nfill = _M_padwidth - _M_printwidth;
3984 return __format::__write_padded(std::move(_M_out), __str,
3985 __align, __nfill, __fill_char);
3989 template<typename _Out, typename _CharT>
3990 class _Escaping_sink : public _Buf_sink<_CharT>
3992 using _Esc = _Escapes<_CharT>;
3995 _Term_char _M_term : 2;
3996 unsigned _M_prev_escape : 1;
3997 unsigned _M_out_discards : 1;
4000 _M_sync_discarding()
4002 if constexpr (is_same_v<_Out, _Sink_iter<_CharT>>)
4003 _M_out_discards = _M_out._M_discarding();
4009 span<_CharT> __bytes = this->_M_used();
4010 basic_string_view<_CharT> __str(__bytes.data(), __bytes.size());
4013 if constexpr (__unicode::__literal_encoding_is_unicode<_CharT>())
4015 bool __prev_escape = _M_prev_escape;
4016 _M_out = __format::__write_escaped_unicode_part(
4017 std::move(_M_out), __str, __prev_escape, _M_term);
4018 _M_prev_escape = __prev_escape;
4020 __rem = __str.size();
4021 if (__rem > 0 && __str.data() != this->_M_buf) [[unlikely]]
4022 ranges::move(__str, this->_M_buf);
4025 _M_out = __format::__write_escaped_ascii(
4026 std::move(_M_out), __str, _M_term);
4028 this->_M_reset(this->_M_buf, __rem);
4029 _M_sync_discarding();
4033 _M_overflow() override
4035 if (_M_out_discards)
4042 _M_discarding() const override
4043 { return _M_out_discards; }
4046 [[__gnu__::__always_inline__]]
4048 _Escaping_sink(_Out __out, _Term_char __term)
4049 : _M_out(std::move(__out)), _M_term(__term),
4050 _M_prev_escape(true), _M_out_discards(false)
4052 _M_out = __format::__write(std::move(_M_out), _Esc::_S_term(_M_term));
4053 _M_sync_discarding();
4059 if (_M_out_discards)
4060 return std::move(_M_out);
4062 if (!this->_M_used().empty())
4065 if constexpr (__unicode::__literal_encoding_is_unicode<_CharT>())
4066 if (auto __rem = this->_M_used(); !__rem.empty())
4068 basic_string_view<_CharT> __str(__rem.data(), __rem.size());
4069 _M_out = __format::__write_escape_seqs(std::move(_M_out), __str);
4072 return __format::__write(std::move(_M_out), _Esc::_S_term(_M_term));
4076 enum class _Arg_t : unsigned char {
4077 _Arg_none, _Arg_bool, _Arg_c, _Arg_i, _Arg_u, _Arg_ll, _Arg_ull,
4078 _Arg_flt, _Arg_dbl, _Arg_ldbl, _Arg_str, _Arg_sv, _Arg_ptr, _Arg_handle,
4079 _Arg_i128, _Arg_u128, _Arg_float128,
4080 _Arg_bf16, _Arg_f16, _Arg_f32, _Arg_f64,
4083 #ifdef _GLIBCXX_LONG_DOUBLE_ALT128_COMPAT
4084 _Arg_ibm128 = _Arg_ldbl,
4085 _Arg_ieee128 = _Arg_float128,
4090 template<typename _Context>
4093 using _CharT = typename _Context::char_type;
4097 using _CharT = typename _Context::char_type;
4098 using _Func = void(*)(basic_format_parse_context<_CharT>&,
4099 _Context&, const void*);
4101 // Format as const if possible, to reduce instantiations.
4102 template<typename _Tp>
4103 using __maybe_const_t
4104 = __conditional_t<__formattable_with<const _Tp, _Context>,
4107 template<typename _Tq>
4109 _S_format(basic_format_parse_context<_CharT>& __parse_ctx,
4110 _Context& __format_ctx, const void* __ptr)
4112 using _Td = remove_const_t<_Tq>;
4113 typename _Context::template formatter_type<_Td> __f;
4114 __parse_ctx.advance_to(__f.parse(__parse_ctx));
4115 _Tq& __val = *const_cast<_Tq*>(static_cast<const _Td*>(__ptr));
4116 __format_ctx.advance_to(__f.format(__val, __format_ctx));
4119 template<typename _Tp>
4120 requires (!is_same_v<remove_cv_t<_Tp>, handle>)
4122 handle(_Tp& __val) noexcept
4123 : _M_ptr(__builtin_addressof(__val))
4124 , _M_func(&_S_format<__maybe_const_t<_Tp>>)
4127 friend class basic_format_arg<_Context>;
4130 handle(const handle&) = default;
4131 handle& operator=(const handle&) = default;
4133 [[__gnu__::__always_inline__]]
4135 format(basic_format_parse_context<_CharT>& __pc, _Context& __fc) const
4136 { _M_func(__pc, __fc, this->_M_ptr); }
4151 unsigned long long _M_ull;
4154 #ifndef _GLIBCXX_LONG_DOUBLE_ALT128_COMPAT // No long double if it's ambiguous.
4155 long double _M_ldbl;
4158 __ieee128 _M_ieee128;
4160 #ifdef __SIZEOF_FLOAT128__
4161 __float128 _M_float128;
4163 const _CharT* _M_str;
4164 basic_string_view<_CharT> _M_sv;
4167 #ifdef __SIZEOF_INT128__
4169 unsigned __int128 _M_u128;
4171 #ifdef __BFLT16_DIG__
4174 #ifdef __FLT16_DIG__
4177 #ifdef __FLT32_DIG__
4180 #ifdef __FLT64_DIG__
4185 [[__gnu__::__always_inline__]]
4186 _Arg_value() : _M_none() { }
4189 template<typename _Tp>
4190 _Arg_value(in_place_type_t<_Tp>, _Tp __val)
4191 { _S_get<_Tp>() = __val; }
4194 // Returns reference to the _Arg_value member with the type _Tp.
4195 // Value of second argument (if provided), is assigned to that member.
4196 template<typename _Tp, typename _Self, typename... _Value>
4197 [[__gnu__::__always_inline__]]
4199 _S_access(_Self& __u, _Value... __value) noexcept
4201 static_assert(sizeof...(_Value) <= 1);
4202 if constexpr (is_same_v<_Tp, bool>)
4203 return (__u._M_bool = ... = __value);
4204 else if constexpr (is_same_v<_Tp, _CharT>)
4205 return (__u._M_c = ... = __value);
4206 else if constexpr (is_same_v<_Tp, int>)
4207 return (__u._M_i = ... = __value);
4208 else if constexpr (is_same_v<_Tp, unsigned>)
4209 return (__u._M_u = ... = __value);
4210 else if constexpr (is_same_v<_Tp, long long>)
4211 return (__u._M_ll = ... = __value);
4212 else if constexpr (is_same_v<_Tp, unsigned long long>)
4213 return (__u._M_ull = ... = __value);
4214 else if constexpr (is_same_v<_Tp, float>)
4215 return (__u._M_flt = ... = __value);
4216 else if constexpr (is_same_v<_Tp, double>)
4217 return (__u._M_dbl = ... = __value);
4218 #ifndef _GLIBCXX_LONG_DOUBLE_ALT128_COMPAT
4219 else if constexpr (is_same_v<_Tp, long double>)
4220 return (__u._M_ldbl = ... = __value);
4222 else if constexpr (is_same_v<_Tp, __ibm128>)
4223 return (__u._M_ibm128 = ... = __value);
4224 else if constexpr (is_same_v<_Tp, __ieee128>)
4225 return (__u._M_ieee128 = ... = __value);
4227 #ifdef __SIZEOF_FLOAT128__
4228 else if constexpr (is_same_v<_Tp, __float128>)
4229 return (__u._M_float128 = ... = __value);
4231 else if constexpr (is_same_v<_Tp, const _CharT*>)
4232 return (__u._M_str = ... = __value);
4233 else if constexpr (is_same_v<_Tp, basic_string_view<_CharT>>)
4234 return (__u._M_sv = ... = __value);
4235 else if constexpr (is_same_v<_Tp, const void*>)
4236 return (__u._M_ptr = ... = __value);
4237 #ifdef __SIZEOF_INT128__
4238 else if constexpr (is_same_v<_Tp, __int128>)
4239 return (__u._M_i128 = ... = __value);
4240 else if constexpr (is_same_v<_Tp, unsigned __int128>)
4241 return (__u._M_u128 = ... = __value);
4243 #ifdef __BFLT16_DIG__
4244 else if constexpr (is_same_v<_Tp, __bflt16_t>)
4245 return (__u._M_bf16 = ... = __value);
4247 #ifdef __FLT16_DIG__
4248 else if constexpr (is_same_v<_Tp, _Float16>)
4249 return (__u._M_f16 = ... = __value);
4251 #ifdef __FLT32_DIG__
4252 else if constexpr (is_same_v<_Tp, _Float32>)
4253 return (__u._M_f32 = ... = __value);
4255 #ifdef __FLT64_DIG__
4256 else if constexpr (is_same_v<_Tp, _Float64>)
4257 return (__u._M_f64 = ... = __value);
4259 else if constexpr (is_same_v<_Tp, handle>)
4260 return __u._M_handle;
4261 // Otherwise, ill-formed.
4264 template<typename _Tp>
4265 [[__gnu__::__always_inline__]]
4268 { return _S_access<_Tp>(*this); }
4270 template<typename _Tp>
4271 [[__gnu__::__always_inline__]]
4273 _M_get() const noexcept
4274 { return _S_access<_Tp>(*this); }
4276 template<typename _Tp>
4277 [[__gnu__::__always_inline__]]
4279 _M_set(_Tp __v) noexcept
4281 // Explicitly construct types without trivial default constructor.
4282 if constexpr (is_same_v<_Tp, basic_string_view<_CharT>>)
4283 std::construct_at(&_M_sv, __v);
4284 else if constexpr (is_same_v<_Tp, handle>)
4285 std::construct_at(&_M_handle, __v);
4287 // Builtin types are trivially default constructible, and assignment
4288 // changes active member per N5032 [class.union.general] p5.
4289 _S_access<_Tp>(*this, __v);
4293 // [format.arg.store], class template format-arg-store
4294 template<typename _Context, typename... _Args>
4297 template<typename _Visitor, typename _Ctx>
4298 decltype(auto) __visit_format_arg(_Visitor&&, basic_format_arg<_Ctx>);
4300 template<typename _Ch, typename _Tp>
4302 __to_arg_t_enum() noexcept;
4303 } // namespace __format
4306 template<typename _Context>
4307 class basic_format_arg
4309 using _CharT = typename _Context::char_type;
4312 using handle = __format::_Arg_value<_Context>::handle;
4314 [[__gnu__::__always_inline__]]
4315 basic_format_arg() noexcept : _M_type(__format::_Arg_none) { }
4317 [[nodiscard,__gnu__::__always_inline__]]
4318 explicit operator bool() const noexcept
4319 { return _M_type != __format::_Arg_none; }
4321 #if __cpp_lib_format >= 202306L // >= C++26
4322 template<typename _Visitor>
4324 visit(this basic_format_arg __arg, _Visitor&& __vis)
4325 { return __arg._M_visit_user(std::forward<_Visitor>(__vis), __arg._M_type); }
4327 template<typename _Res, typename _Visitor>
4329 visit(this basic_format_arg __arg, _Visitor&& __vis)
4330 { return __arg._M_visit_user(std::forward<_Visitor>(__vis), __arg._M_type); }
4334 template<typename _Ctx>
4335 friend class basic_format_args;
4337 template<typename _Ctx, typename... _Args>
4338 friend class __format::_Arg_store;
4340 static_assert(is_trivially_copyable_v<__format::_Arg_value<_Context>>);
4342 __format::_Arg_value<_Context> _M_val;
4343 __format::_Arg_t _M_type;
4345 // Transform incoming argument type to the type stored in _Arg_value.
4346 // e.g. short -> int, std::string -> std::string_view,
4347 // char[3] -> const char*.
4348 template<typename _Tp>
4349 static consteval auto
4352 using _Td = remove_const_t<_Tp>;
4353 if constexpr (is_same_v<_Td, bool>)
4354 return type_identity<bool>();
4355 else if constexpr (is_same_v<_Td, _CharT>)
4356 return type_identity<_CharT>();
4357 else if constexpr (is_same_v<_Td, char> && is_same_v<_CharT, wchar_t>)
4358 return type_identity<_CharT>();
4359 #ifdef __SIZEOF_INT128__ // Check before signed/unsigned integer
4360 else if constexpr (is_same_v<_Td, __int128>)
4361 return type_identity<__int128>();
4362 else if constexpr (is_same_v<_Td, unsigned __int128>)
4363 return type_identity<unsigned __int128>();
4365 else if constexpr (__is_signed_integer<_Td>::value)
4367 if constexpr (sizeof(_Td) <= sizeof(int))
4368 return type_identity<int>();
4369 else if constexpr (sizeof(_Td) <= sizeof(long long))
4370 return type_identity<long long>();
4372 else if constexpr (__is_unsigned_integer<_Td>::value)
4374 if constexpr (sizeof(_Td) <= sizeof(unsigned))
4375 return type_identity<unsigned>();
4376 else if constexpr (sizeof(_Td) <= sizeof(unsigned long long))
4377 return type_identity<unsigned long long>();
4379 else if constexpr (is_same_v<_Td, float>)
4380 return type_identity<float>();
4381 else if constexpr (is_same_v<_Td, double>)
4382 return type_identity<double>();
4383 #ifndef _GLIBCXX_LONG_DOUBLE_ALT128_COMPAT
4384 else if constexpr (is_same_v<_Td, long double>)
4385 return type_identity<long double>();
4387 else if constexpr (is_same_v<_Td, __ibm128>)
4388 return type_identity<__ibm128>();
4389 else if constexpr (is_same_v<_Td, __ieee128>)
4390 return type_identity<__ieee128>();
4392 #if defined(__SIZEOF_FLOAT128__) && _GLIBCXX_FORMAT_F128
4393 else if constexpr (is_same_v<_Td, __float128>)
4394 return type_identity<__float128>();
4396 #if defined(__STDCPP_BFLOAT16_T__) && defined(_GLIBCXX_FLOAT_IS_IEEE_BINARY32)
4397 else if constexpr (is_same_v<_Td, __format::__bflt16_t>)
4398 return type_identity<__format::__bflt16_t>();
4400 #if defined(__STDCPP_FLOAT16_T__) && defined(_GLIBCXX_FLOAT_IS_IEEE_BINARY32)
4401 else if constexpr (is_same_v<_Td, _Float16>)
4402 return type_identity<_Float16>();
4404 #if defined(__FLT32_DIG__) && defined(_GLIBCXX_FLOAT_IS_IEEE_BINARY32)
4405 else if constexpr (is_same_v<_Td, _Float32>)
4406 return type_identity<_Float32>();
4408 #if defined(__FLT64_DIG__) && defined(_GLIBCXX_DOUBLE_IS_IEEE_BINARY64)
4409 else if constexpr (is_same_v<_Td, _Float64>)
4410 return type_identity<_Float64>();
4412 else if constexpr (__is_specialization_of<_Td, basic_string_view>
4413 || __is_specialization_of<_Td, basic_string>)
4415 if constexpr (is_same_v<typename _Td::value_type, _CharT>)
4416 return type_identity<basic_string_view<_CharT>>();
4418 return type_identity<handle>();
4420 else if constexpr (is_same_v<decay_t<_Td>, const _CharT*>)
4421 return type_identity<const _CharT*>();
4422 else if constexpr (is_same_v<decay_t<_Td>, _CharT*>)
4423 return type_identity<const _CharT*>();
4424 else if constexpr (is_void_v<remove_pointer_t<_Td>>)
4425 return type_identity<const void*>();
4426 else if constexpr (is_same_v<_Td, nullptr_t>)
4427 return type_identity<const void*>();
4429 return type_identity<handle>();
4432 // Transform a formattable type to the appropriate storage type.
4433 template<typename _Tp>
4434 using _Normalize = typename decltype(_S_to_arg_type<_Tp>())::type;
4436 // Get the _Arg_t value corresponding to a normalized type.
4437 template<typename _Tp>
4438 static consteval __format::_Arg_t
4441 using namespace __format;
4442 if constexpr (is_same_v<_Tp, bool>)
4444 else if constexpr (is_same_v<_Tp, _CharT>)
4446 else if constexpr (is_same_v<_Tp, int>)
4448 else if constexpr (is_same_v<_Tp, unsigned>)
4450 else if constexpr (is_same_v<_Tp, long long>)
4452 else if constexpr (is_same_v<_Tp, unsigned long long>)
4454 else if constexpr (is_same_v<_Tp, float>)
4456 else if constexpr (is_same_v<_Tp, double>)
4458 #ifndef _GLIBCXX_LONG_DOUBLE_ALT128_COMPAT
4459 else if constexpr (is_same_v<_Tp, long double>)
4462 // Don't use _Arg_ldbl for this target, it's ambiguous.
4463 else if constexpr (is_same_v<_Tp, __ibm128>)
4465 else if constexpr (is_same_v<_Tp, __ieee128>)
4466 return _Arg_ieee128;
4468 #if defined(__SIZEOF_FLOAT128__) && _GLIBCXX_FORMAT_F128
4469 else if constexpr (is_same_v<_Tp, __float128>)
4470 return _Arg_float128;
4472 #if defined(__STDCPP_BFLOAT16_T__) && defined(_GLIBCXX_FLOAT_IS_IEEE_BINARY32)
4473 else if constexpr (is_same_v<_Tp, __format::__bflt16_t>)
4476 #if defined(__STDCPP_FLOAT16_T__) && defined(_GLIBCXX_FLOAT_IS_IEEE_BINARY32)
4477 else if constexpr (is_same_v<_Tp, _Float16>)
4480 #if defined(__FLT32_DIG__) && defined(_GLIBCXX_FLOAT_IS_IEEE_BINARY32)
4481 else if constexpr (is_same_v<_Tp, _Float32>)
4484 #if defined(__FLT64_DIG__) && defined(_GLIBCXX_DOUBLE_IS_IEEE_BINARY64)
4485 else if constexpr (is_same_v<_Tp, _Float64>)
4488 else if constexpr (is_same_v<_Tp, const _CharT*>)
4490 else if constexpr (is_same_v<_Tp, basic_string_view<_CharT>>)
4492 else if constexpr (is_same_v<_Tp, const void*>)
4494 #ifdef __SIZEOF_INT128__
4495 else if constexpr (is_same_v<_Tp, __int128>)
4497 else if constexpr (is_same_v<_Tp, unsigned __int128>)
4500 else if constexpr (is_same_v<_Tp, handle>)
4504 template<typename _Tp>
4506 _M_set(_Tp __v) noexcept
4508 _M_type = _S_to_enum<_Tp>();
4512 template<typename _Tp>
4513 requires __format::__formattable_with<_Tp, _Context>
4515 basic_format_arg(_Tp& __v) noexcept
4517 using _Td = _Normalize<_Tp>;
4518 if constexpr (is_same_v<_Td, basic_string_view<_CharT>>)
4519 _M_set(_Td{__v.data(), __v.size()});
4520 else if constexpr (is_same_v<remove_const_t<_Tp>, char>
4521 && is_same_v<_CharT, wchar_t>)
4522 _M_set(static_cast<_Td>(static_cast<unsigned char>(__v)));
4524 _M_set(static_cast<_Td>(__v));
4527 template<typename _Ctx, typename... _Argz>
4529 make_format_args(_Argz&...) noexcept;
4531 template<typename _Visitor, typename _Ctx>
4532 friend decltype(auto)
4533 visit_format_arg(_Visitor&& __vis, basic_format_arg<_Ctx>);
4535 template<typename _Visitor, typename _Ctx>
4536 friend decltype(auto)
4537 __format::__visit_format_arg(_Visitor&&, basic_format_arg<_Ctx>);
4539 template<typename _Ch, typename _Tp>
4540 friend consteval __format::_Arg_t
4541 __format::__to_arg_t_enum() noexcept;
4543 template<typename _Visitor>
4545 _M_visit(_Visitor&& __vis, __format::_Arg_t __type)
4547 using namespace __format;
4551 return std::forward<_Visitor>(__vis)(_M_val._M_none);
4553 return std::forward<_Visitor>(__vis)(_M_val._M_bool);
4555 return std::forward<_Visitor>(__vis)(_M_val._M_c);
4557 return std::forward<_Visitor>(__vis)(_M_val._M_i);
4559 return std::forward<_Visitor>(__vis)(_M_val._M_u);
4561 return std::forward<_Visitor>(__vis)(_M_val._M_ll);
4563 return std::forward<_Visitor>(__vis)(_M_val._M_ull);
4564 #if __glibcxx_to_chars // FIXME: need to be able to format these types!
4566 return std::forward<_Visitor>(__vis)(_M_val._M_flt);
4568 return std::forward<_Visitor>(__vis)(_M_val._M_dbl);
4569 #ifndef _GLIBCXX_LONG_DOUBLE_ALT128_COMPAT
4571 return std::forward<_Visitor>(__vis)(_M_val._M_ldbl);
4572 #if defined(__SIZEOF_FLOAT128__) && _GLIBCXX_FORMAT_F128
4574 return std::forward<_Visitor>(__vis)(_M_val._M_float128);
4578 return std::forward<_Visitor>(__vis)(_M_val._M_ibm128);
4580 return std::forward<_Visitor>(__vis)(_M_val._M_ieee128);
4582 #if defined(__STDCPP_BFLOAT16_T__) && defined(_GLIBCXX_FLOAT_IS_IEEE_BINARY32)
4584 return std::forward<_Visitor>(__vis)(_M_val._M_bf16);
4586 #if defined(__STDCPP_FLOAT16_T__) && defined(_GLIBCXX_FLOAT_IS_IEEE_BINARY32)
4588 return std::forward<_Visitor>(__vis)(_M_val._M_f16);
4590 #if defined(__FLT32_DIG__) && defined(_GLIBCXX_FLOAT_IS_IEEE_BINARY32)
4592 return std::forward<_Visitor>(__vis)(_M_val._M_f32);
4594 #if defined(__FLT64_DIG__) && defined(_GLIBCXX_DOUBLE_IS_IEEE_BINARY64)
4596 return std::forward<_Visitor>(__vis)(_M_val._M_f64);
4598 #endif // __glibcxx_to_chars
4600 return std::forward<_Visitor>(__vis)(_M_val._M_str);
4602 return std::forward<_Visitor>(__vis)(_M_val._M_sv);
4604 return std::forward<_Visitor>(__vis)(_M_val._M_ptr);
4606 return std::forward<_Visitor>(__vis)(_M_val._M_handle);
4607 #ifdef __SIZEOF_INT128__
4609 return std::forward<_Visitor>(__vis)(_M_val._M_i128);
4611 return std::forward<_Visitor>(__vis)(_M_val._M_u128);
4614 __builtin_unreachable();
4618 template<typename _Visitor>
4620 _M_visit_user(_Visitor&& __vis, __format::_Arg_t __type)
4622 return _M_visit([&__vis]<typename _Tp>(_Tp& __val) -> decltype(auto)
4624 constexpr bool __user_facing = __is_one_of<_Tp,
4625 monostate, bool, _CharT,
4626 int, unsigned int, long long int, unsigned long long int,
4627 float, double, long double,
4628 const _CharT*, basic_string_view<_CharT>,
4629 const void*, handle>::value;
4630 if constexpr (__user_facing)
4631 return std::forward<_Visitor>(__vis)(__val);
4635 return std::forward<_Visitor>(__vis)(__h);
4641 template<typename _Visitor, typename _Context>
4642 _GLIBCXX26_DEPRECATED_SUGGEST("std::basic_format_arg::visit")
4643 inline decltype(auto)
4644 visit_format_arg(_Visitor&& __vis, basic_format_arg<_Context> __arg)
4646 return __arg._M_visit_user(std::forward<_Visitor>(__vis), __arg._M_type);
4649 /// @cond undocumented
4652 template<typename _Visitor, typename _Ctx>
4653 inline decltype(auto)
4654 __visit_format_arg(_Visitor&& __vis, basic_format_arg<_Ctx> __arg)
4656 return __arg._M_visit(std::forward<_Visitor>(__vis), __arg._M_type);
4659 struct _WidthPrecVisitor
4661 template<typename _Tp>
4663 operator()(_Tp& __arg) const
4665 if constexpr (is_same_v<_Tp, monostate>)
4666 __format::__invalid_arg_id_in_format_string();
4667 // _GLIBCXX_RESOLVE_LIB_DEFECTS
4668 // 3720. Restrict the valid types of arg-id for width and precision
4669 // 3721. Allow an arg-id with a value of zero for width
4670 else if constexpr (sizeof(_Tp) <= sizeof(long long))
4672 // _GLIBCXX_RESOLVE_LIB_DEFECTS
4673 // 3720. Restrict the valid types of arg-id for width and precision
4674 if constexpr (__is_unsigned_integer<_Tp>::value)
4676 else if constexpr (__is_signed_integer<_Tp>::value)
4680 __throw_format_error("format error: argument used for width or "
4681 "precision must be a non-negative integer");
4685 #pragma GCC diagnostic push
4686 #pragma GCC diagnostic ignored "-Wdeprecated-declarations"
4687 template<typename _Context>
4689 __int_from_arg(const basic_format_arg<_Context>& __arg)
4690 { return __format::__visit_format_arg(_WidthPrecVisitor(), __arg); }
4692 // Pack _Arg_t enum values into a single 60-bit integer.
4693 template<int _Bits, size_t _Nm>
4695 __pack_arg_types(const array<_Arg_t, _Nm>& __types)
4697 __UINT64_TYPE__ __packed_types = 0;
4698 for (auto __i = __types.rbegin(); __i != __types.rend(); ++__i)
4699 __packed_types = (__packed_types << _Bits) | (unsigned)*__i;
4700 return __packed_types;
4702 } // namespace __format
4705 template<typename _Context>
4706 class basic_format_args
4708 static constexpr int _S_packed_type_bits = 5; // _Arg_t values [0,20]
4709 static constexpr int _S_packed_type_mask = 0b11111;
4710 static constexpr int _S_max_packed_args = 12;
4712 static_assert( (unsigned)__format::_Arg_max_ <= (1u << _S_packed_type_bits) );
4714 template<typename... _Args>
4715 using _Store = __format::_Arg_store<_Context, _Args...>;
4717 template<typename _Ctx, typename... _Args>
4718 friend class __format::_Arg_store;
4720 using uint64_t = __UINT64_TYPE__;
4721 using _Format_arg = basic_format_arg<_Context>;
4722 using _Format_arg_val = __format::_Arg_value<_Context>;
4724 // If args are packed then the number of args is in _M_packed_size and
4725 // the packed types are in _M_unpacked_size, accessed via _M_type(i).
4726 // If args are not packed then the number of args is in _M_unpacked_size
4727 // and _M_packed_size is zero.
4728 uint64_t _M_packed_size : 4;
4729 uint64_t _M_unpacked_size : 60;
4732 const _Format_arg_val* _M_values; // Active when _M_packed_size != 0
4733 const _Format_arg* _M_args; // Active when _M_packed_size == 0
4737 _M_size() const noexcept
4738 { return _M_packed_size ? _M_packed_size : _M_unpacked_size; }
4740 typename __format::_Arg_t
4741 _M_type(size_t __i) const noexcept
4743 uint64_t __t = _M_unpacked_size >> (__i * _S_packed_type_bits);
4744 return static_cast<__format::_Arg_t>(__t & _S_packed_type_mask);
4747 template<typename _Ctx, typename... _Args>
4749 make_format_args(_Args&...) noexcept;
4751 // An array of _Arg_t enums corresponding to _Args...
4752 template<typename... _Args>
4753 static consteval array<__format::_Arg_t, sizeof...(_Args)>
4755 { return {_Format_arg::template _S_to_enum<_Args>()...}; }
4758 template<typename... _Args>
4759 basic_format_args(const _Store<_Args...>& __store) noexcept;
4761 [[nodiscard,__gnu__::__always_inline__]]
4762 basic_format_arg<_Context>
4763 get(size_t __i) const noexcept
4765 basic_format_arg<_Context> __arg;
4766 if (__i < _M_packed_size)
4768 __arg._M_type = _M_type(__i);
4769 __arg._M_val = _M_values[__i];
4771 else if (_M_packed_size == 0 && __i < _M_unpacked_size)
4772 __arg = _M_args[__i];
4777 // _GLIBCXX_RESOLVE_LIB_DEFECTS
4778 // 3810. CTAD for std::basic_format_args
4779 template<typename _Context, typename... _Args>
4780 basic_format_args(__format::_Arg_store<_Context, _Args...>)
4781 -> basic_format_args<_Context>;
4783 template<typename _Context, typename... _Args>
4785 make_format_args(_Args&... __fmt_args) noexcept;
4787 // An array of type-erased formatting arguments.
4788 template<typename _Context, typename... _Args>
4789 class __format::_Arg_store
4791 friend std::basic_format_args<_Context>;
4793 template<typename _Ctx, typename... _Argz>
4795 #if _GLIBCXX_INLINE_VERSION
4796 __8:: // Needed for PR c++/59256
4798 make_format_args(_Argz&...) noexcept;
4800 // For a sufficiently small number of arguments we only store values.
4801 // basic_format_args can get the types from the _Args pack.
4802 static constexpr bool _S_values_only
4803 = sizeof...(_Args) <= basic_format_args<_Context>::_S_max_packed_args;
4806 = __conditional_t<_S_values_only,
4807 __format::_Arg_value<_Context>,
4808 basic_format_arg<_Context>>;
4810 _Element_t _M_args[sizeof...(_Args)];
4812 template<typename _Tp>
4814 _S_make_elt(_Tp& __v)
4816 using _Tq = remove_const_t<_Tp>;
4817 using _CharT = typename _Context::char_type;
4818 static_assert(is_default_constructible_v<formatter<_Tq, _CharT>>,
4819 "std::formatter must be specialized for the type "
4820 "of each format arg");
4821 using __format::__formattable_with;
4822 if constexpr (is_const_v<_Tp>)
4823 if constexpr (!__formattable_with<_Tp, _Context>)
4824 if constexpr (__formattable_with<_Tq, _Context>)
4825 static_assert(__formattable_with<_Tp, _Context>,
4826 "format arg must be non-const because its "
4827 "std::formatter specialization has a "
4828 "non-const reference parameter");
4829 basic_format_arg<_Context> __arg(__v);
4830 if constexpr (_S_values_only)
4831 return __arg._M_val;
4836 template<typename... _Tp>
4837 requires (sizeof...(_Tp) == sizeof...(_Args))
4838 [[__gnu__::__always_inline__]]
4839 _Arg_store(_Tp&... __a) noexcept
4840 : _M_args{_S_make_elt(__a)...}
4844 template<typename _Context>
4845 class __format::_Arg_store<_Context>
4848 template<typename _Context>
4849 template<typename... _Args>
4851 basic_format_args<_Context>::
4852 basic_format_args(const _Store<_Args...>& __store) noexcept
4854 if constexpr (sizeof...(_Args) == 0)
4857 _M_unpacked_size = 0;
4860 else if constexpr (sizeof...(_Args) <= _S_max_packed_args)
4862 // The number of packed arguments:
4863 _M_packed_size = sizeof...(_Args);
4864 // The packed type enums:
4866 = __format::__pack_arg_types<_S_packed_type_bits>(_S_types_to_pack<_Args...>());
4867 // The _Arg_value objects.
4868 _M_values = __store._M_args;
4872 // No packed arguments:
4874 // The number of unpacked arguments:
4875 _M_unpacked_size = sizeof...(_Args);
4876 // The basic_format_arg objects:
4877 _M_args = __store._M_args;
4881 /// Capture formatting arguments for use by `std::vformat`.
4882 template<typename _Context = format_context, typename... _Args>
4883 [[nodiscard,__gnu__::__always_inline__]]
4885 make_format_args(_Args&... __fmt_args) noexcept
4887 using _Fmt_arg = basic_format_arg<_Context>;
4888 using _Store = __format::_Arg_store<_Context, typename _Fmt_arg::template
4889 _Normalize<_Args>...>;
4890 return _Store(__fmt_args...);
4893 #ifdef _GLIBCXX_USE_WCHAR_T
4894 /// Capture formatting arguments for use by `std::vformat` (for wide output).
4895 template<typename... _Args>
4896 [[nodiscard,__gnu__::__always_inline__]]
4898 make_wformat_args(_Args&... __args) noexcept
4899 { return std::make_format_args<wformat_context>(__args...); }
4902 /// @cond undocumented
4905 template<typename _Out, typename _CharT, typename _Context>
4907 __do_vformat_to(_Out, basic_string_view<_CharT>,
4908 const basic_format_args<_Context>&,
4909 const locale* = nullptr);
4911 template<typename _CharT> struct __formatter_chrono;
4913 } // namespace __format
4916 /** Context for std::format and similar functions.
4918 * A formatting context contains an output iterator and locale to use
4919 * for the formatting operations. Most programs will never need to use
4920 * this class template explicitly. For typical uses of `std::format` the
4921 * library will use the specializations `std::format_context` (for `char`)
4922 * and `std::wformat_context` (for `wchar_t`).
4924 * You are not allowed to define partial or explicit specializations of
4925 * this class template.
4929 template<typename _Out, typename _CharT>
4930 class basic_format_context
4932 static_assert( output_iterator<_Out, const _CharT&> );
4934 basic_format_args<basic_format_context> _M_args;
4936 __format::_Optional_locale _M_loc;
4938 basic_format_context(basic_format_args<basic_format_context> __args,
4940 : _M_args(__args), _M_out(std::move(__out))
4943 basic_format_context(basic_format_args<basic_format_context> __args,
4944 _Out __out, const std::locale& __loc)
4945 : _M_args(__args), _M_out(std::move(__out)), _M_loc(__loc)
4948 // _GLIBCXX_RESOLVE_LIB_DEFECTS
4949 // 4061. Should std::basic_format_context be
4950 // default-constructible/copyable/movable?
4951 basic_format_context(const basic_format_context&) = delete;
4952 basic_format_context& operator=(const basic_format_context&) = delete;
4954 template<typename _Out2, typename _CharT2, typename _Context2>
4956 __format::__do_vformat_to(_Out2, basic_string_view<_CharT2>,
4957 const basic_format_args<_Context2>&,
4960 friend __format::__formatter_chrono<_CharT>;
4963 ~basic_format_context() = default;
4965 using iterator = _Out;
4966 using char_type = _CharT;
4967 template<typename _Tp>
4968 using formatter_type = formatter<_Tp, _CharT>;
4971 basic_format_arg<basic_format_context>
4972 arg(size_t __id) const noexcept
4973 { return _M_args.get(__id); }
4976 std::locale locale() { return _M_loc.value(); }
4979 iterator out() { return std::move(_M_out); }
4981 void advance_to(iterator __it) { _M_out = std::move(__it); }
4985 /// @cond undocumented
4988 // Abstract base class defining an interface for scanning format strings.
4989 // Scan the characters in a format string, dividing it up into strings of
4990 // ordinary characters, escape sequences, and replacement fields.
4991 // Call virtual functions for derived classes to parse format-specifiers
4992 // or write formatted output.
4993 template<typename _CharT>
4996 using iterator = typename basic_format_parse_context<_CharT>::iterator;
4998 struct _Parse_context : basic_format_parse_context<_CharT>
5000 using basic_format_parse_context<_CharT>::basic_format_parse_context;
5001 const _Arg_t* _M_types = nullptr;
5005 _Scanner(basic_string_view<_CharT> __str, size_t __nargs = (size_t)-1)
5006 : _M_pc(__str, __nargs)
5009 constexpr iterator begin() const noexcept { return _M_pc.begin(); }
5010 constexpr iterator end() const noexcept { return _M_pc.end(); }
5015 basic_string_view<_CharT> __fmt = _M_fmt_str();
5017 if (__fmt.size() == 2 && __fmt[0] == '{' && __fmt[1] == '}')
5019 _M_pc.advance_to(begin() + 1);
5020 _M_format_arg(_M_pc.next_arg_id());
5024 size_t __lbr = __fmt.find('{');
5025 size_t __rbr = __fmt.find('}');
5027 while (__fmt.size())
5029 auto __cmp = __lbr <=> __rbr;
5033 _M_pc.advance_to(end());
5038 if (__lbr + 1 == __fmt.size()
5039 || (__rbr == __fmt.npos && __fmt[__lbr + 1] != '{'))
5040 __format::__unmatched_left_brace_in_format_string();
5041 const bool __is_escape = __fmt[__lbr + 1] == '{';
5042 iterator __last = begin() + __lbr + int(__is_escape);
5043 _M_on_chars(__last);
5044 _M_pc.advance_to(__last + 1);
5045 __fmt = _M_fmt_str();
5048 if (__rbr != __fmt.npos)
5050 __lbr = __fmt.find('{');
5054 _M_on_replacement_field();
5055 __fmt = _M_fmt_str();
5056 __lbr = __fmt.find('{');
5057 __rbr = __fmt.find('}');
5062 if (++__rbr == __fmt.size() || __fmt[__rbr] != '}')
5063 __format::__unmatched_right_brace_in_format_string();
5064 iterator __last = begin() + __rbr;
5065 _M_on_chars(__last);
5066 _M_pc.advance_to(__last + 1);
5067 __fmt = _M_fmt_str();
5068 if (__lbr != __fmt.npos)
5070 __rbr = __fmt.find('}');
5075 constexpr basic_string_view<_CharT>
5076 _M_fmt_str() const noexcept
5077 { return {begin(), end()}; }
5079 constexpr virtual void _M_on_chars(iterator) { }
5081 constexpr void _M_on_replacement_field()
5083 auto __next = begin();
5087 __id = _M_pc.next_arg_id();
5088 else if (*__next == ':')
5090 __id = _M_pc.next_arg_id();
5091 _M_pc.advance_to(++__next);
5095 auto [__i, __ptr] = __format::__parse_arg_id(begin(), end());
5096 if (!__ptr || !(*__ptr == '}' || *__ptr == ':'))
5097 __format::__invalid_arg_id_in_format_string();
5098 _M_pc.check_arg_id(__id = __i);
5101 _M_pc.advance_to(++__ptr);
5104 _M_pc.advance_to(__ptr);
5106 _M_format_arg(__id);
5107 if (begin() == end() || *begin() != '}')
5108 __format::__unmatched_left_brace_in_format_string();
5109 _M_pc.advance_to(begin() + 1); // Move past '}'
5112 constexpr virtual void _M_format_arg(size_t __id) = 0;
5115 // Process a format string and format the arguments in the context.
5116 template<typename _Out, typename _CharT>
5117 class _Formatting_scanner : public _Scanner<_CharT>
5120 _Formatting_scanner(basic_format_context<_Out, _CharT>& __fc,
5121 basic_string_view<_CharT> __str)
5122 : _Scanner<_CharT>(__str), _M_fc(__fc)
5126 basic_format_context<_Out, _CharT>& _M_fc;
5128 using iterator = typename _Scanner<_CharT>::iterator;
5131 _M_on_chars(iterator __last) override
5133 basic_string_view<_CharT> __str(this->begin(), __last);
5134 _M_fc.advance_to(__format::__write(_M_fc.out(), __str));
5138 _M_format_arg(size_t __id) override
5140 using _Context = basic_format_context<_Out, _CharT>;
5141 using handle = typename basic_format_arg<_Context>::handle;
5143 __format::__visit_format_arg([this](auto& __arg) {
5144 using _Type = remove_reference_t<decltype(__arg)>;
5145 using _Formatter = typename _Context::template formatter_type<_Type>;
5146 if constexpr (is_same_v<_Type, monostate>)
5147 __format::__invalid_arg_id_in_format_string();
5148 else if constexpr (is_same_v<_Type, handle>)
5149 __arg.format(this->_M_pc, this->_M_fc);
5150 else if constexpr (is_default_constructible_v<_Formatter>)
5153 this->_M_pc.advance_to(__f.parse(this->_M_pc));
5154 this->_M_fc.advance_to(__f.format(__arg, this->_M_fc));
5157 static_assert(__format::__formattable_with<_Type, _Context>);
5158 }, _M_fc.arg(__id));
5162 template<typename _CharT, typename _Tp>
5164 __to_arg_t_enum() noexcept
5166 using _Context = __format::__format_context<_CharT>;
5167 using _Fmt_arg = basic_format_arg<_Context>;
5168 using _NormalizedTp = typename _Fmt_arg::template _Normalize<_Tp>;
5169 return _Fmt_arg::template _S_to_enum<_NormalizedTp>();
5172 // Validate a format string for Args.
5173 template<typename _CharT, typename... _Args>
5174 class _Checking_scanner : public _Scanner<_CharT>
5177 (is_default_constructible_v<formatter<_Args, _CharT>> && ...),
5178 "std::formatter must be specialized for each type being formatted");
5182 _Checking_scanner(basic_string_view<_CharT> __str)
5183 : _Scanner<_CharT>(__str, sizeof...(_Args))
5185 #if __cpp_lib_format >= 202305L
5186 this->_M_pc._M_types = _M_types.data();
5192 _M_format_arg(size_t __id) override
5194 if constexpr (sizeof...(_Args) != 0)
5196 if (__id < sizeof...(_Args))
5198 _M_parse_format_spec<_Args...>(__id);
5202 __builtin_unreachable();
5205 template<typename _Tp, typename... _OtherArgs>
5207 _M_parse_format_spec(size_t __id)
5211 formatter<_Tp, _CharT> __f;
5212 this->_M_pc.advance_to(__f.parse(this->_M_pc));
5214 else if constexpr (sizeof...(_OtherArgs) != 0)
5215 _M_parse_format_spec<_OtherArgs...>(__id - 1);
5217 __builtin_unreachable();
5220 #if __cpp_lib_format >= 202305L
5221 array<_Arg_t, sizeof...(_Args)>
5222 _M_types{ { __format::__to_arg_t_enum<_CharT, _Args>()... } };
5226 template<typename _CharT, unsigned = __unicode::__literal_encoding_is_unicode<_CharT>()>
5228 __do_vformat_to(_Sink_iter<_CharT> __out, basic_string_view<_CharT> __fmt,
5229 __format_context<_CharT>& __ctx)
5231 if constexpr (is_same_v<_CharT, char>)
5232 // Fast path for "{}" format strings and simple format arg types.
5233 if (__fmt.size() == 2 && __fmt[0] == '{' && __fmt[1] == '}')
5235 bool __done = false;
5236 __format::__visit_format_arg([&](auto& __arg) {
5237 using _Tp = remove_cvref_t<decltype(__arg)>;
5238 if constexpr (is_same_v<_Tp, bool>)
5240 size_t __len = 4 + !__arg;
5241 const char* __chars[] = { "false", "true" };
5242 if (auto __res = __out._M_reserve(__len))
5244 __builtin_memcpy(__res.get(), __chars[__arg], __len);
5245 __res._M_bump(__len);
5249 else if constexpr (is_same_v<_Tp, char>)
5251 if (auto __res = __out._M_reserve(1))
5253 *__res.get() = __arg;
5258 else if constexpr (is_integral_v<_Tp>)
5260 make_unsigned_t<_Tp> __uval;
5261 const bool __neg = __arg < 0;
5263 __uval = make_unsigned_t<_Tp>(~__arg) + 1u;
5266 const auto __n = __detail::__to_chars_len(__uval);
5267 if (auto __res = __out._M_reserve(__n + __neg))
5269 auto __ptr = __res.get();
5271 __detail::__to_chars_10_impl(__ptr + (int)__neg, __n,
5273 __res._M_bump(__n + __neg);
5277 else if constexpr (is_convertible_v<_Tp, string_view>)
5279 string_view __sv = __arg;
5280 if (auto __res = __out._M_reserve(__sv.size()))
5282 __builtin_memcpy(__res.get(), __sv.data(), __sv.size());
5283 __res._M_bump(__sv.size());
5293 _Formatting_scanner<_Sink_iter<_CharT>, _CharT> __scanner(__ctx, __fmt);
5294 __scanner._M_scan();
5298 // The behavior of the formatters (interpretation of fill character) depends
5299 // on the literal encoding. As explicit instantiation of __do_vformat_to
5300 // instantiates formatters for types stored in basic_format_arg, we can
5301 // support only single encoding, in this case unicode. This should cover
5302 // most common use cases.
5303 #if __cplusplus <= 202002L && _GLIBCXX_EXTERN_TEMPLATE > 0
5304 extern template _Sink_iter<char>
5305 __do_vformat_to<char, 1>(_Sink_iter<char>, string_view,
5307 # ifdef _GLIBCXX_USE_WCHAR_T
5308 extern template _Sink_iter<wchar_t>
5309 __do_vformat_to<wchar_t, 1>(_Sink_iter<wchar_t>, wstring_view,
5314 template<typename _Out, typename _CharT, typename _Context>
5316 __do_vformat_to(_Out __out, basic_string_view<_CharT> __fmt,
5317 const basic_format_args<_Context>& __args,
5318 const locale* __loc)
5320 if constexpr (is_same_v<_Out, _Sink_iter<_CharT>>)
5322 auto __ctx = __loc == nullptr
5323 ? _Context(__args, __out)
5324 : _Context(__args, __out, *__loc);
5325 return __format::__do_vformat_to(__out, __fmt, __ctx);
5327 else if constexpr (__contiguous_char_iter<_CharT, _Out>)
5329 _Ptr_sink<_CharT> __sink(__out);
5330 __format::__do_vformat_to(__sink.out(), __fmt, __args, __loc);
5331 return std::move(__sink)._M_finish(__out).out;
5335 _Iter_sink<_CharT, _Out> __sink(std::move(__out));
5336 __format::__do_vformat_to(__sink.out(), __fmt, __args, __loc);
5337 return std::move(__sink)._M_finish().out;
5341 template<typename _Out, typename _CharT>
5342 inline format_to_n_result<_Out>
5343 __do_vformat_to_n(_Out __out, iter_difference_t<_Out> __n,
5344 basic_string_view<_CharT> __fmt,
5345 const type_identity_t<
5346 basic_format_args<__format_context<_CharT>>>& __args,
5347 const locale* __loc = nullptr)
5349 if constexpr (__contiguous_char_iter<_CharT, _Out>)
5351 _Ptr_sink<_CharT> __sink(__out, __n);
5352 __format::__do_vformat_to(__sink.out(), __fmt, __args, __loc);
5353 return std::move(__sink)._M_finish(__out);
5357 _Iter_sink<_CharT, _Out> __sink(std::move(__out), __n);
5358 __format::__do_vformat_to(__sink.out(), __fmt, __args, __loc);
5359 return std::move(__sink)._M_finish();
5363 #pragma GCC diagnostic pop
5365 } // namespace __format
5368 #if __cpp_lib_format >= 202305L // >= C++26
5369 /// @cond undocumented
5370 // Common implementation of check_dynamic_spec{,_string,_integral}
5371 template<typename _CharT>
5372 template<typename... _Ts>
5374 basic_format_parse_context<_CharT>::
5375 __check_dynamic_spec(size_t __id) noexcept
5377 if (__id >= _M_num_args)
5378 __format::__invalid_arg_id_in_format_string();
5379 if constexpr (sizeof...(_Ts) != 0)
5381 using _Parse_ctx = __format::_Scanner<_CharT>::_Parse_context;
5382 auto __arg = static_cast<_Parse_ctx*>(this)->_M_types[__id];
5383 __format::_Arg_t __types[] = {
5384 __format::__to_arg_t_enum<_CharT, _Ts>()...
5386 for (auto __t : __types)
5390 __invalid_dynamic_spec("arg(id) type does not match");
5395 template<typename _CharT, typename... _Args>
5396 template<typename _Tp>
5397 requires convertible_to<const _Tp&, basic_string_view<_CharT>>
5399 basic_format_string<_CharT, _Args...>::
5400 basic_format_string(const _Tp& __s)
5403 __format::_Checking_scanner<_CharT, remove_cvref_t<_Args>...>
5405 __scanner._M_scan();
5408 // [format.functions], formatting functions
5410 template<typename _Out> requires output_iterator<_Out, const char&>
5411 [[__gnu__::__always_inline__]]
5413 vformat_to(_Out __out, string_view __fmt, format_args __args)
5414 { return __format::__do_vformat_to(std::move(__out), __fmt, __args); }
5416 #ifdef _GLIBCXX_USE_WCHAR_T
5417 template<typename _Out> requires output_iterator<_Out, const wchar_t&>
5418 [[__gnu__::__always_inline__]]
5420 vformat_to(_Out __out, wstring_view __fmt, wformat_args __args)
5421 { return __format::__do_vformat_to(std::move(__out), __fmt, __args); }
5424 template<typename _Out> requires output_iterator<_Out, const char&>
5425 [[__gnu__::__always_inline__]]
5427 vformat_to(_Out __out, const locale& __loc, string_view __fmt,
5430 return __format::__do_vformat_to(std::move(__out), __fmt, __args, &__loc);
5433 #ifdef _GLIBCXX_USE_WCHAR_T
5434 template<typename _Out> requires output_iterator<_Out, const wchar_t&>
5435 [[__gnu__::__always_inline__]]
5437 vformat_to(_Out __out, const locale& __loc, wstring_view __fmt,
5438 wformat_args __args)
5440 return __format::__do_vformat_to(std::move(__out), __fmt, __args, &__loc);
5446 vformat(string_view __fmt, format_args __args)
5448 __format::_Str_sink<char> __buf;
5449 std::vformat_to(__buf.out(), __fmt, __args);
5450 return std::move(__buf).get();
5453 #ifdef _GLIBCXX_USE_WCHAR_T
5456 vformat(wstring_view __fmt, wformat_args __args)
5458 __format::_Str_sink<wchar_t> __buf;
5459 std::vformat_to(__buf.out(), __fmt, __args);
5460 return std::move(__buf).get();
5466 vformat(const locale& __loc, string_view __fmt, format_args __args)
5468 __format::_Str_sink<char> __buf;
5469 std::vformat_to(__buf.out(), __loc, __fmt, __args);
5470 return std::move(__buf).get();
5473 #ifdef _GLIBCXX_USE_WCHAR_T
5476 vformat(const locale& __loc, wstring_view __fmt, wformat_args __args)
5478 __format::_Str_sink<wchar_t> __buf;
5479 std::vformat_to(__buf.out(), __loc, __fmt, __args);
5480 return std::move(__buf).get();
5484 template<typename... _Args>
5487 format(format_string<_Args...> __fmt, _Args&&... __args)
5488 { return std::vformat(__fmt.get(), std::make_format_args(__args...)); }
5490 #ifdef _GLIBCXX_USE_WCHAR_T
5491 template<typename... _Args>
5494 format(wformat_string<_Args...> __fmt, _Args&&... __args)
5495 { return std::vformat(__fmt.get(), std::make_wformat_args(__args...)); }
5498 template<typename... _Args>
5501 format(const locale& __loc, format_string<_Args...> __fmt,
5504 return std::vformat(__loc, __fmt.get(),
5505 std::make_format_args(__args...));
5508 #ifdef _GLIBCXX_USE_WCHAR_T
5509 template<typename... _Args>
5512 format(const locale& __loc, wformat_string<_Args...> __fmt,
5515 return std::vformat(__loc, __fmt.get(),
5516 std::make_wformat_args(__args...));
5520 template<typename _Out, typename... _Args>
5521 requires output_iterator<_Out, const char&>
5523 format_to(_Out __out, format_string<_Args...> __fmt, _Args&&... __args)
5525 return std::vformat_to(std::move(__out), __fmt.get(),
5526 std::make_format_args(__args...));
5529 #ifdef _GLIBCXX_USE_WCHAR_T
5530 template<typename _Out, typename... _Args>
5531 requires output_iterator<_Out, const wchar_t&>
5533 format_to(_Out __out, wformat_string<_Args...> __fmt, _Args&&... __args)
5535 return std::vformat_to(std::move(__out), __fmt.get(),
5536 std::make_wformat_args(__args...));
5540 template<typename _Out, typename... _Args>
5541 requires output_iterator<_Out, const char&>
5543 format_to(_Out __out, const locale& __loc, format_string<_Args...> __fmt,
5546 return std::vformat_to(std::move(__out), __loc, __fmt.get(),
5547 std::make_format_args(__args...));
5550 #ifdef _GLIBCXX_USE_WCHAR_T
5551 template<typename _Out, typename... _Args>
5552 requires output_iterator<_Out, const wchar_t&>
5554 format_to(_Out __out, const locale& __loc, wformat_string<_Args...> __fmt,
5557 return std::vformat_to(std::move(__out), __loc, __fmt.get(),
5558 std::make_wformat_args(__args...));
5562 template<typename _Out, typename... _Args>
5563 requires output_iterator<_Out, const char&>
5564 inline format_to_n_result<_Out>
5565 format_to_n(_Out __out, iter_difference_t<_Out> __n,
5566 format_string<_Args...> __fmt, _Args&&... __args)
5568 return __format::__do_vformat_to_n(
5569 std::move(__out), __n, __fmt.get(),
5570 std::make_format_args(__args...));
5573 #ifdef _GLIBCXX_USE_WCHAR_T
5574 template<typename _Out, typename... _Args>
5575 requires output_iterator<_Out, const wchar_t&>
5576 inline format_to_n_result<_Out>
5577 format_to_n(_Out __out, iter_difference_t<_Out> __n,
5578 wformat_string<_Args...> __fmt, _Args&&... __args)
5580 return __format::__do_vformat_to_n(
5581 std::move(__out), __n, __fmt.get(),
5582 std::make_wformat_args(__args...));
5586 template<typename _Out, typename... _Args>
5587 requires output_iterator<_Out, const char&>
5588 inline format_to_n_result<_Out>
5589 format_to_n(_Out __out, iter_difference_t<_Out> __n, const locale& __loc,
5590 format_string<_Args...> __fmt, _Args&&... __args)
5592 return __format::__do_vformat_to_n(
5593 std::move(__out), __n, __fmt.get(),
5594 std::make_format_args(__args...), &__loc);
5597 #ifdef _GLIBCXX_USE_WCHAR_T
5598 template<typename _Out, typename... _Args>
5599 requires output_iterator<_Out, const wchar_t&>
5600 inline format_to_n_result<_Out>
5601 format_to_n(_Out __out, iter_difference_t<_Out> __n, const locale& __loc,
5602 wformat_string<_Args...> __fmt, _Args&&... __args)
5604 return __format::__do_vformat_to_n(
5605 std::move(__out), __n, __fmt.get(),
5606 std::make_wformat_args(__args...), &__loc);
5610 /// @cond undocumented
5614 template<typename _CharT>
5615 class _Counting_sink final : public _Ptr_sink<_CharT>
5618 _Counting_sink() : _Ptr_sink<_CharT>(nullptr, 0) { }
5620 [[__gnu__::__always_inline__]]
5623 { return this->_M_count + this->_M_used().size(); }
5626 template<typename _CharT>
5627 class _Counting_sink : public _Buf_sink<_CharT>
5629 size_t _M_count = 0;
5632 _M_overflow() override
5634 if (!std::is_constant_evaluated())
5635 _M_count += this->_M_used().size();
5640 _Counting_sink() = default;
5642 [[__gnu__::__always_inline__]]
5646 _Counting_sink::_M_overflow();
5651 } // namespace __format
5654 template<typename... _Args>
5657 formatted_size(format_string<_Args...> __fmt, _Args&&... __args)
5659 __format::_Counting_sink<char> __buf;
5660 std::vformat_to(__buf.out(), __fmt.get(),
5661 std::make_format_args(__args...));
5662 return __buf.count();
5665 #ifdef _GLIBCXX_USE_WCHAR_T
5666 template<typename... _Args>
5669 formatted_size(wformat_string<_Args...> __fmt, _Args&&... __args)
5671 __format::_Counting_sink<wchar_t> __buf;
5672 std::vformat_to(__buf.out(), __fmt.get(),
5673 std::make_wformat_args(__args...));
5674 return __buf.count();
5678 template<typename... _Args>
5681 formatted_size(const locale& __loc, format_string<_Args...> __fmt,
5684 __format::_Counting_sink<char> __buf;
5685 std::vformat_to(__buf.out(), __loc, __fmt.get(),
5686 std::make_format_args(__args...));
5687 return __buf.count();
5690 #ifdef _GLIBCXX_USE_WCHAR_T
5691 template<typename... _Args>
5694 formatted_size(const locale& __loc, wformat_string<_Args...> __fmt,
5697 __format::_Counting_sink<wchar_t> __buf;
5698 std::vformat_to(__buf.out(), __loc, __fmt.get(),
5699 std::make_wformat_args(__args...));
5700 return __buf.count();
5704 #if __glibcxx_format_ranges // C++ >= 23 && HOSTED
5705 /// @cond undocumented
5706 template<typename _Tp>
5707 consteval range_format
5710 using _Ref = ranges::range_reference_t<_Tp>;
5711 if constexpr (is_same_v<remove_cvref_t<_Ref>, _Tp>)
5712 return range_format::disabled;
5713 else if constexpr (requires { typename _Tp::key_type; })
5715 if constexpr (requires { typename _Tp::mapped_type; })
5717 using _Up = remove_cvref_t<_Ref>;
5718 if constexpr (__is_pair<_Up>)
5719 return range_format::map;
5720 else if constexpr (__is_specialization_of<_Up, tuple>)
5721 if constexpr (tuple_size_v<_Up> == 2)
5722 return range_format::map;
5724 return range_format::set;
5727 return range_format::sequence;
5731 /// A constant determining how a range should be formatted.
5732 template<ranges::input_range _Rg> requires same_as<_Rg, remove_cvref_t<_Rg>>
5733 constexpr range_format format_kind<_Rg> = __fmt_kind<_Rg>();
5735 /// @cond undocumented
5738 template<typename _CharT, typename _Out, typename _Callback>
5739 typename basic_format_context<_Out, _CharT>::iterator
5740 __format_padded(basic_format_context<_Out, _CharT>& __fc,
5741 const _Spec<_CharT>& __spec,
5744 if constexpr (is_same_v<_Out, _Drop_iter<_CharT>>)
5748 // This is required to implement formatting with padding,
5749 // as we need to format to temporary buffer, using the same iterator.
5750 static_assert(is_same_v<_Out, _Sink_iter<_CharT>>);
5752 const size_t __padwidth = __spec._M_get_width(__fc);
5753 if (__padwidth == 0)
5754 return __call(__fc);
5758 _Restore_out(basic_format_context<_Sink_iter<_CharT>, _CharT>& __fc)
5759 : _M_ctx(std::addressof(__fc)), _M_out(__fc.out())
5764 { _M_ctx = nullptr; }
5769 _M_ctx->advance_to(_M_out);
5773 basic_format_context<_Sink_iter<_CharT>, _CharT>* _M_ctx;
5774 _Sink_iter<_CharT> _M_out;
5777 _Restore_out __restore(__fc);
5778 _Padding_sink<_Sink_iter<_CharT>, _CharT> __sink(__fc.out(), __padwidth);
5779 __fc.advance_to(__sink.out());
5781 __fc.advance_to(__sink._M_finish(__spec._M_align, __spec._M_fill));
5782 __restore._M_disarm();
5787 template<size_t _Pos, typename _Tp, typename _CharT>
5788 struct __indexed_formatter_storage
5793 basic_format_parse_context<_CharT> __pc({});
5794 if (_M_formatter.parse(__pc) != __pc.end())
5795 __format::__failed_to_parse_format_spec();
5798 template<typename _Out>
5800 _M_format(__maybe_const<_Tp, _CharT>& __elem,
5801 basic_format_context<_Out, _CharT>& __fc,
5802 basic_string_view<_CharT> __sep) const
5804 if constexpr (_Pos != 0)
5805 __fc.advance_to(__format::__write(__fc.out(), __sep));
5806 __fc.advance_to(_M_formatter.format(__elem, __fc));
5809 [[__gnu__::__always_inline__]]
5813 if constexpr (__has_debug_format<formatter<_Tp, _CharT>>)
5814 _M_formatter.set_debug_format();
5818 formatter<_Tp, _CharT> _M_formatter;
5821 template<typename _CharT, typename... _Tps>
5822 class __tuple_formatter
5824 using _String_view = basic_string_view<_CharT>;
5825 using _Seps = __format::_Separators<_CharT>;
5829 set_separator(basic_string_view<_CharT> __sep) noexcept
5833 set_brackets(basic_string_view<_CharT> __open,
5834 basic_string_view<_CharT> __close) noexcept
5840 // We deviate from standard, that declares this as template accepting
5841 // unconstrained ParseContext type, which seems unimplementable.
5842 constexpr typename basic_format_parse_context<_CharT>::iterator
5843 parse(basic_format_parse_context<_CharT>& __pc)
5845 auto __first = __pc.begin();
5846 const auto __last = __pc.end();
5847 __format::_Spec<_CharT> __spec{};
5849 auto __finished = [&]
5851 if (__first != __last && *__first != '}')
5855 _M_felems._M_parse();
5856 _M_felems.set_debug_format();
5863 __first = __spec._M_parse_fill_and_align(__first, __last, "{:");
5867 __first = __spec._M_parse_width(__first, __last, __pc);
5871 if (*__first == 'n')
5874 _M_open = _M_close = _String_view();
5876 else if (*__first == 'm')
5879 if constexpr (sizeof...(_Tps) == 2)
5881 _M_sep = _Seps::_S_colon();
5882 _M_open = _M_close = _String_view();
5885 __throw_format_error("format error: 'm' specifier requires range"
5886 " of pair or tuple of two elements");
5892 __format::__failed_to_parse_format_spec();
5896 template<typename _Tuple, typename _Out, size_t... _Ids>
5897 typename basic_format_context<_Out, _CharT>::iterator
5898 _M_format(_Tuple& __tuple, index_sequence<_Ids...>,
5899 basic_format_context<_Out, _CharT>& __fc) const
5900 { return _M_format_elems(std::get<_Ids>(__tuple)..., __fc); }
5902 template<typename _Out>
5903 typename basic_format_context<_Out, _CharT>::iterator
5904 _M_format_elems(__maybe_const<_Tps, _CharT>&... __elems,
5905 basic_format_context<_Out, _CharT>& __fc) const
5907 return __format::__format_padded(
5909 [this, &__elems...](basic_format_context<_Out, _CharT>& __nfc)
5911 __nfc.advance_to(__format::__write(__nfc.out(), _M_open));
5912 _M_felems._M_format(__elems..., __nfc, _M_sep);
5913 return __format::__write(__nfc.out(), _M_close);
5918 template<size_t... _Ids>
5919 struct __formatters_storage
5920 : __indexed_formatter_storage<_Ids, _Tps, _CharT>...
5922 template<size_t _Id, typename _Up>
5923 using _Base = __indexed_formatter_storage<_Id, _Up, _CharT>;
5928 (_Base<_Ids, _Tps>::_M_parse(), ...);
5931 template<typename _Out>
5933 _M_format(__maybe_const<_Tps, _CharT>&... __elems,
5934 basic_format_context<_Out, _CharT>& __fc,
5935 _String_view __sep) const
5937 (_Base<_Ids, _Tps>::_M_format(__elems, __fc, __sep), ...);
5943 (_Base<_Ids, _Tps>::set_debug_format(), ...);
5947 template<size_t... _Ids>
5949 _S_create_storage(index_sequence<_Ids...>)
5950 -> __formatters_storage<_Ids...>;
5952 = decltype(_S_create_storage(index_sequence_for<_Tps...>()));
5954 _Spec<_CharT> _M_spec{};
5955 _String_view _M_open = _Seps::_S_parens().substr(0, 1);
5956 _String_view _M_close = _Seps::_S_parens().substr(1, 1);
5957 _String_view _M_sep = _Seps::_S_comma();
5958 _Formatters _M_felems;
5961 template<typename _Tp>
5962 concept __is_map_formattable
5963 = __is_pair<_Tp> || (__is_tuple_v<_Tp> && tuple_size_v<_Tp> == 2);
5965 } // namespace __format
5968 // [format.tuple] Tuple formatter
5969 template<__format::__char _CharT, formattable<_CharT> _Fp,
5970 formattable<_CharT> _Sp>
5971 struct formatter<pair<_Fp, _Sp>, _CharT>
5972 : __format::__tuple_formatter<_CharT, remove_cvref_t<_Fp>,
5973 remove_cvref_t<_Sp>>
5976 using __maybe_const_pair
5977 = __conditional_t<formattable<const _Fp, _CharT>
5978 && formattable<const _Sp, _CharT>,
5979 const pair<_Fp, _Sp>, pair<_Fp, _Sp>>;
5981 // We deviate from standard, that declares this as template accepting
5982 // unconstrained FormatContext type, which seems unimplementable.
5983 template<typename _Out>
5984 typename basic_format_context<_Out, _CharT>::iterator
5985 format(__maybe_const_pair& __p,
5986 basic_format_context<_Out, _CharT>& __fc) const
5987 { return this->_M_format_elems(__p.first, __p.second, __fc); }
5990 #if __glibcxx_print >= 202406L
5991 // _GLIBCXX_RESOLVE_LIB_DEFECTS
5992 // 4399. enable_nonlocking_formatter_optimization for pair and tuple needs remove_cvref_t
5993 template<typename _Fp, typename _Sp>
5994 constexpr bool enable_nonlocking_formatter_optimization<pair<_Fp, _Sp>>
5995 = enable_nonlocking_formatter_optimization<remove_cvref_t<_Fp>>
5996 && enable_nonlocking_formatter_optimization<remove_cvref_t<_Sp>>;
5999 template<__format::__char _CharT, formattable<_CharT>... _Tps>
6000 struct formatter<tuple<_Tps...>, _CharT>
6001 : __format::__tuple_formatter<_CharT, remove_cvref_t<_Tps>...>
6004 using __maybe_const_tuple
6005 = __conditional_t<(formattable<const _Tps, _CharT> && ...),
6006 const tuple<_Tps...>, tuple<_Tps...>>;
6008 // We deviate from standard, that declares this as template accepting
6009 // unconstrained FormatContext type, which seems unimplementable.
6010 template<typename _Out>
6011 typename basic_format_context<_Out, _CharT>::iterator
6012 format(__maybe_const_tuple& __t,
6013 basic_format_context<_Out, _CharT>& __fc) const
6014 { return this->_M_format(__t, index_sequence_for<_Tps...>(), __fc); }
6017 #if __glibcxx_print >= 202406L
6018 // _GLIBCXX_RESOLVE_LIB_DEFECTS
6019 // 4399. enable_nonlocking_formatter_optimization for pair and tuple needs remove_cvref_t
6020 template<typename... _Tps>
6021 constexpr bool enable_nonlocking_formatter_optimization<tuple<_Tps...>>
6022 = (enable_nonlocking_formatter_optimization<remove_cvref_t<_Tps>> && ...);
6025 // [format.range.formatter], class template range_formatter
6026 template<typename _Tp, __format::__char _CharT>
6027 requires same_as<remove_cvref_t<_Tp>, _Tp> && formattable<_Tp, _CharT>
6028 class range_formatter
6030 using _String_view = basic_string_view<_CharT>;
6031 using _Seps = __format::_Separators<_CharT>;
6035 set_separator(basic_string_view<_CharT> __sep) noexcept
6039 set_brackets(basic_string_view<_CharT> __open,
6040 basic_string_view<_CharT> __close) noexcept
6046 constexpr formatter<_Tp, _CharT>&
6047 underlying() noexcept
6050 constexpr const formatter<_Tp, _CharT>&
6051 underlying() const noexcept
6054 // We deviate from standard, that declares this as template accepting
6055 // unconstrained ParseContext type, which seems unimplementable.
6056 constexpr typename basic_format_parse_context<_CharT>::iterator
6057 parse(basic_format_parse_context<_CharT>& __pc)
6059 auto __first = __pc.begin();
6060 const auto __last = __pc.end();
6061 __format::_Spec<_CharT> __spec{};
6062 bool __no_brace = false;
6064 auto __finished = [&]
6065 { return __first == __last || *__first == '}'; };
6067 auto __finalize = [&]
6073 auto __parse_val = [&](_String_view __nfs = _String_view())
6075 basic_format_parse_context<_CharT> __npc(__nfs);
6076 if (_M_fval.parse(__npc) != __npc.end())
6077 __format::__failed_to_parse_format_spec();
6078 if constexpr (__format::__has_debug_format<formatter<_Tp, _CharT>>)
6079 _M_fval.set_debug_format();
6080 return __finalize();
6084 return __parse_val();
6086 __first = __spec._M_parse_fill_and_align(__first, __last, "{:");
6088 return __parse_val();
6090 __first = __spec._M_parse_width(__first, __last, __pc);
6092 return __parse_val();
6094 if (*__first == '?')
6097 __spec._M_debug = true;
6098 if (__finished() || *__first != 's')
6099 __throw_format_error("format error: '?' is allowed only in"
6100 " combination with 's'");
6103 if (*__first == 's')
6106 if constexpr (same_as<_Tp, _CharT>)
6108 __spec._M_type = __format::_Pres_s;
6110 return __finalize();
6111 __throw_format_error("format error: element format specifier"
6112 " cannot be provided when 's' specifier is used");
6115 __throw_format_error("format error: 's' specifier requires"
6116 " range of character types");
6120 return __parse_val();
6122 if (*__first == 'n')
6125 _M_open = _M_close = _String_view();
6130 return __parse_val();
6132 if (*__first == 'm')
6134 _String_view __m(__first, 1);
6136 if constexpr (__format::__is_map_formattable<_Tp>)
6138 _M_sep = _Seps::_S_comma();
6141 _M_open = _Seps::_S_braces().substr(0, 1);
6142 _M_close = _Seps::_S_braces().substr(1, 1);
6145 return __parse_val(__m);
6146 __throw_format_error("format error: element format specifier"
6147 " cannot be provided when 'm' specifier is used");
6150 __throw_format_error("format error: 'm' specifier requires"
6151 " range of pairs or tuples of two elements");
6155 return __parse_val();
6157 if (*__first == ':')
6159 __pc.advance_to(++__first);
6160 __first = _M_fval.parse(__pc);
6164 return __finalize();
6166 __format::__failed_to_parse_format_spec();
6169 // We deviate from standard, that declares this as template accepting
6170 // unconstrained FormatContext type, which seems unimplementable.
6171 template<ranges::input_range _Rg, typename _Out>
6172 requires formattable<ranges::range_reference_t<_Rg>, _CharT> &&
6173 same_as<remove_cvref_t<ranges::range_reference_t<_Rg>>, _Tp>
6174 typename basic_format_context<_Out, _CharT>::iterator
6175 format(_Rg&& __rg, basic_format_context<_Out, _CharT>& __fc) const
6177 using _Range = remove_reference_t<_Rg>;
6178 if constexpr (__format::__simply_formattable_range<_Range, _CharT>)
6179 return _M_format<const _Range>(__rg, __fc);
6181 return _M_format(__rg, __fc);
6185 template<ranges::input_range _Rg, typename _Out>
6186 typename basic_format_context<_Out, _CharT>::iterator
6187 _M_format(_Rg& __rg, basic_format_context<_Out, _CharT>& __fc) const
6189 if constexpr (same_as<_Tp, _CharT>)
6190 if (_M_spec._M_type == __format::_Pres_s)
6192 __format::__formatter_str __fstr(_M_spec);
6193 return __fstr._M_format_range(__rg, __fc);
6195 return __format::__format_padded(
6197 [this, &__rg](basic_format_context<_Out, _CharT>& __nfc)
6198 { return _M_format_elems(__rg, __nfc); });
6202 template<ranges::input_range _Rg, typename _Out>
6203 typename basic_format_context<_Out, _CharT>::iterator
6204 _M_format_elems(_Rg& __rg,
6205 basic_format_context<_Out, _CharT>& __fc) const
6207 auto __out = __format::__write(__fc.out(), _M_open);
6209 auto __first = ranges::begin(__rg);
6210 auto const __last = ranges::end(__rg);
6211 if (__first == __last)
6212 return __format::__write(__out, _M_close);
6214 __fc.advance_to(__out);
6215 __out = _M_fval.format(*__first, __fc);
6216 for (++__first; __first != __last; ++__first)
6218 __out = __format::__write(__out, _M_sep);
6219 __fc.advance_to(__out);
6220 __out = _M_fval.format(*__first, __fc);
6223 return __format::__write(__out, _M_close);
6226 __format::_Spec<_CharT> _M_spec{};
6227 _String_view _M_open = _Seps::_S_squares().substr(0, 1);
6228 _String_view _M_close = _Seps::_S_squares().substr(1, 1);
6229 _String_view _M_sep = _Seps::_S_comma();
6230 formatter<_Tp, _CharT> _M_fval;
6233 // In standard this is shown as inheriting from specialization of
6234 // exposition only specialization for range-default-formatter for
6235 // each range_format. We opt for simpler implementation.
6236 // [format.range.fmtmap], [format.range.fmtset], [format.range.fmtstr],
6237 // specializations for maps, sets, and strings
6238 template<ranges::input_range _Rg, __format::__char _CharT>
6239 requires (format_kind<_Rg> != range_format::disabled)
6240 && formattable<ranges::range_reference_t<_Rg>, _CharT>
6241 struct formatter<_Rg, _CharT>
6244 static const bool _S_range_format_is_string =
6245 (format_kind<_Rg> == range_format::string)
6246 || (format_kind<_Rg> == range_format::debug_string);
6247 using _Vt = remove_cvref_t<
6248 ranges::range_reference_t<
6249 __format::__maybe_const_range<_Rg, _CharT>>>;
6251 static consteval bool _S_is_correct()
6253 if constexpr (_S_range_format_is_string)
6254 static_assert(same_as<_Vt, _CharT>);
6258 static_assert(_S_is_correct());
6261 constexpr formatter() noexcept
6263 using _Seps = __format::_Separators<_CharT>;
6264 if constexpr (format_kind<_Rg> == range_format::map)
6266 static_assert(__format::__is_map_formattable<_Vt>);
6267 _M_under.set_brackets(_Seps::_S_braces().substr(0, 1),
6268 _Seps::_S_braces().substr(1, 1));
6269 _M_under.underlying().set_brackets({}, {});
6270 _M_under.underlying().set_separator(_Seps::_S_colon());
6272 else if constexpr (format_kind<_Rg> == range_format::set)
6273 _M_under.set_brackets(_Seps::_S_braces().substr(0, 1),
6274 _Seps::_S_braces().substr(1, 1));
6278 set_separator(basic_string_view<_CharT> __sep) noexcept
6279 requires (format_kind<_Rg> == range_format::sequence)
6280 { _M_under.set_separator(__sep); }
6283 set_brackets(basic_string_view<_CharT> __open,
6284 basic_string_view<_CharT> __close) noexcept
6285 requires (format_kind<_Rg> == range_format::sequence)
6286 { _M_under.set_brackets(__open, __close); }
6288 // We deviate from standard, that declares this as template accepting
6289 // unconstrained ParseContext type, which seems unimplementable.
6290 constexpr typename basic_format_parse_context<_CharT>::iterator
6291 parse(basic_format_parse_context<_CharT>& __pc)
6293 auto __res = _M_under.parse(__pc);
6294 if constexpr (format_kind<_Rg> == range_format::debug_string)
6295 _M_under.set_debug_format();
6299 // We deviate from standard, that declares this as template accepting
6300 // unconstrained FormatContext type, which seems unimplementable.
6301 template<typename _Out>
6302 typename basic_format_context<_Out, _CharT>::iterator
6303 format(__format::__maybe_const_range<_Rg, _CharT>& __rg,
6304 basic_format_context<_Out, _CharT>& __fc) const
6306 if constexpr (_S_range_format_is_string)
6307 return _M_under._M_format_range(__rg, __fc);
6309 return _M_under.format(__rg, __fc);
6313 using _Formatter_under
6314 = __conditional_t<_S_range_format_is_string,
6315 __format::__formatter_str<_CharT>,
6316 range_formatter<_Vt, _CharT>>;
6317 _Formatter_under _M_under;
6320 #if __glibcxx_print >= 202406L
6321 template<ranges::input_range _Rg>
6322 requires (format_kind<_Rg> != range_format::disabled)
6323 constexpr bool enable_nonlocking_formatter_optimization<_Rg> = false;
6326 #endif // C++23 formatting ranges
6327 #undef _GLIBCXX_WIDEN
6329 _GLIBCXX_END_NAMESPACE_VERSION
6331 #endif // __cpp_lib_format
6332 #pragma GCC diagnostic pop
6333 #endif // _GLIBCXX_FORMAT