blob: 6e779fe7a714cef59b98dbc600a0665481390c9a [file] [log] [blame]
Mark de Weverdf5fd832020-11-26 19:12:18 +01001// -*- C++ -*-
2//===--------------------------- format -----------------------------------===//
3//
4// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
5// See https://llvm.org/LICENSE.txt for license information.
6// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7//
8//===----------------------------------------------------------------------===//
9
10#ifndef _LIBCPP_FORMAT
11#define _LIBCPP_FORMAT
12
13/*
14
15namespace std {
Mark de Wevercba61372020-12-05 11:45:21 +010016 // [format.context], class template basic_format_context
17 template<class Out, class charT>
18 class basic_format_context {
19 basic_format_args<basic_format_context> args_; // exposition only
20 Out out_; // exposition only
21
22 public:
23 using iterator = Out;
24 using char_type = charT;
25 template<class T> using formatter_type = formatter<T, charT>;
26
27 basic_format_arg<basic_format_context> arg(size_t id) const;
28 std::locale locale();
29
30 iterator out();
31 void advance_to(iterator it);
32 };
33 using format_context = basic_format_context<unspecified, char>;
34 using wformat_context = basic_format_context<unspecified, wchar_t>;
35
36 // [format.args], class template basic_format_args
37 template<class Context>
38 class basic_format_args {
39 size_t size_; // exposition only
40 const basic_format_arg<Context>* data_; // exposition only
41
42 public:
43 basic_format_args() noexcept;
44
45 template<class... Args>
46 basic_format_args(const format-arg-store<Context, Args...>& store) noexcept;
47
48 basic_format_arg<Context> get(size_t i) const noexcept;
49 };
50 using format_args = basic_format_args<format_context>;
51 using wformat_args = basic_format_args<wformat_context>;
52
53
54 template<class Out, class charT>
55 using format_args_t = basic_format_args<basic_format_context<Out, charT>>;
56
Mark de Wevercb50a052020-12-19 13:52:07 +010057 // [format.functions], formatting functions
58 template<class... Args>
59 string format(string_view fmt, const Args&... args);
60 template<class... Args>
61 wstring format(wstring_view fmt, const Args&... args);
62 template<class... Args>
63 string format(const locale& loc, string_view fmt, const Args&... args);
64 template<class... Args>
65 wstring format(const locale& loc, wstring_view fmt, const Args&... args);
66
67 string vformat(string_view fmt, format_args args);
68 wstring vformat(wstring_view fmt, wformat_args args);
69 string vformat(const locale& loc, string_view fmt, format_args args);
70 wstring vformat(const locale& loc, wstring_view fmt, wformat_args args);
71
72 template<class Out, class... Args>
73 Out format_to(Out out, string_view fmt, const Args&... args);
74 template<class Out, class... Args>
75 Out format_to(Out out, wstring_view fmt, const Args&... args);
76 template<class Out, class... Args>
77 Out format_to(Out out, const locale& loc, string_view fmt, const Args&... args);
78 template<class Out, class... Args>
79 Out format_to(Out out, const locale& loc, wstring_view fmt, const Args&... args);
80
81 template<class Out>
82 Out vformat_to(Out out, string_view fmt,
83 format_args_t<type_identity_t<Out>, char> args);
84 template<class Out>
85 Out vformat_to(Out out, wstring_view fmt,
86 format_args_t<type_identity_t<Out>, wchar_t> args);
87 template<class Out>
88 Out vformat_to(Out out, const locale& loc, string_view fmt,
89 format_args_t<type_identity_t<Out>, char> args);
90 template<class Out>
91 Out vformat_to(Out out, const locale& loc, wstring_view fmt,
92 format_args_t<type_identity_t<Out>, wchar_t> args);
93
94 template<class Out> struct format_to_n_result {
95 Out out;
96 iter_difference_t<Out> size;
97 };
98
99 template<class Out, class... Args>
100 format_to_n_result<Out> format_to_n(Out out, iter_difference_t<Out> n,
101 string_view fmt, const Args&... args);
102 template<class Out, class... Args>
103 format_to_n_result<Out> format_to_n(Out out, iter_difference_t<Out> n,
104 wstring_view fmt, const Args&... args);
105 template<class Out, class... Args>
106 format_to_n_result<Out> format_to_n(Out out, iter_difference_t<Out> n,
107 const locale& loc, string_view fmt,
108 const Args&... args);
109 template<class Out, class... Args>
110 format_to_n_result<Out> format_to_n(Out out, iter_difference_t<Out> n,
111 const locale& loc, wstring_view fmt,
112 const Args&... args);
113
114 template<class... Args>
115 size_t formatted_size(string_view fmt, const Args&... args);
116 template<class... Args>
117 size_t formatted_size(wstring_view fmt, const Args&... args);
118 template<class... Args>
119 size_t formatted_size(const locale& loc, string_view fmt, const Args&... args);
120 template<class... Args>
121 size_t formatted_size(const locale& loc, wstring_view fmt, const Args&... args);
122
123 // [format.formatter], formatter
124 template<> struct formatter<char, char>;
125 template<> struct formatter<char, wchar_t>;
126 template<> struct formatter<wchar_t, wchar_t>;
127
128 template<> struct formatter<charT*, charT>;
129 template<> struct formatter<const charT*, charT>;
130 template<size_t N> struct formatter<const charT[N], charT>;
131 template<class traits, class Allocator>
132 struct formatter<basic_string<charT, traits, Allocator>, charT>;
133 template<class traits>
134 struct formatter<basic_string_view<charT, traits>, charT>;
135
Mark de Wevercba61372020-12-05 11:45:21 +0100136 // [format.parse.ctx], class template basic_format_parse_context
137 template<class charT>
138 class basic_format_parse_context {
139 public:
140 using char_type = charT;
141 using const_iterator = typename basic_string_view<charT>::const_iterator;
142 using iterator = const_iterator;
143
144 private:
145 iterator begin_; // exposition only
146 iterator end_; // exposition only
147 enum indexing { unknown, manual, automatic }; // exposition only
148 indexing indexing_; // exposition only
149 size_t next_arg_id_; // exposition only
150 size_t num_args_; // exposition only
151
152 public:
153 constexpr explicit basic_format_parse_context(basic_string_view<charT> fmt,
154 size_t num_args = 0) noexcept;
155 basic_format_parse_context(const basic_format_parse_context&) = delete;
156 basic_format_parse_context& operator=(const basic_format_parse_context&) = delete;
157
158 constexpr const_iterator begin() const noexcept;
159 constexpr const_iterator end() const noexcept;
160 constexpr void advance_to(const_iterator it);
161
162 constexpr size_t next_arg_id();
163 constexpr void check_arg_id(size_t id);
164 };
165 using format_parse_context = basic_format_parse_context<char>;
166 using wformat_parse_context = basic_format_parse_context<wchar_t>;
167
168 // [format.arguments], arguments
169 // [format.arg], class template basic_format_arg
170 template<class Context>
171 class basic_format_arg {
172 public:
173 class handle;
174
175 private:
176 using char_type = typename Context::char_type; // exposition only
177
178 variant<monostate, bool, char_type,
179 int, unsigned int, long long int, unsigned long long int,
180 float, double, long double,
181 const char_type*, basic_string_view<char_type>,
182 const void*, handle> value; // exposition only
183
184 template<class T> explicit basic_format_arg(const T& v) noexcept; // exposition only
185 explicit basic_format_arg(float n) noexcept; // exposition only
186 explicit basic_format_arg(double n) noexcept; // exposition only
187 explicit basic_format_arg(long double n) noexcept; // exposition only
188 explicit basic_format_arg(const char_type* s); // exposition only
189
190 template<class traits>
191 explicit basic_format_arg(
192 basic_string_view<char_type, traits> s) noexcept; // exposition only
193
194 template<class traits, class Allocator>
195 explicit basic_format_arg(
196 const basic_string<char_type, traits, Allocator>& s) noexcept; // exposition only
197
198 explicit basic_format_arg(nullptr_t) noexcept; // exposition only
199
200 template<class T>
201 explicit basic_format_arg(const T* p) noexcept; // exposition only
202
203 public:
204 basic_format_arg() noexcept;
205
206 explicit operator bool() const noexcept;
207 };
208
209 template<class Visitor, class Context>
210 see below visit_format_arg(Visitor&& vis, basic_format_arg<Context> arg);
211
212 // [format.arg.store], class template format-arg-store
213 template<class Context, class... Args>
214 struct format-arg-store { // exposition only
215 array<basic_format_arg<Context>, sizeof...(Args)> args;
216 };
217
218 template<class Context = format_context, class... Args>
219 format-arg-store<Context, Args...>
220 make_format_args(const Args&... args);
221 template<class... Args>
222 format-arg-store<wformat_context, Args...>
223 make_wformat_args(const Args&... args);
224
Mark de Weverdf5fd832020-11-26 19:12:18 +0100225 // [format.error], class format_error
226 class format_error : public runtime_error {
227 public:
228 explicit format_error(const string& what_arg);
229 explicit format_error(const char* what_arg);
230 };
Mark de Wever6a67a5f2021-02-02 18:10:33 +0100231
232 // [format.parse.ctx], class template basic_format_parse_context
233 template<class charT>
234 class basic_format_parse_context {
235 public:
236 using char_type = charT;
237 using const_iterator = typename basic_string_view<charT>::const_iterator;
238 using iterator = const_iterator;
239
240 private:
241 iterator begin_; // exposition only
242 iterator end_; // exposition only
243 enum indexing { unknown, manual, automatic }; // exposition only
244 indexing indexing_; // exposition only
245 size_t next_arg_id_; // exposition only
246 size_t num_args_; // exposition only
247
248 public:
249 constexpr explicit basic_format_parse_context(basic_string_view<charT> fmt,
250 size_t num_args = 0) noexcept;
251 basic_format_parse_context(const basic_format_parse_context&) = delete;
252 basic_format_parse_context& operator=(const basic_format_parse_context&) = delete;
253
254 constexpr const_iterator begin() const noexcept;
255 constexpr const_iterator end() const noexcept;
256 constexpr void advance_to(const_iterator it);
257
258 constexpr size_t next_arg_id();
259 constexpr void check_arg_id(size_t id);
260 };
261 using format_parse_context = basic_format_parse_context<char>;
262 using wformat_parse_context = basic_format_parse_context<wchar_t>;
Mark de Weverdf5fd832020-11-26 19:12:18 +0100263}
264
265*/
266
Mark de Weverbe38c382021-08-11 17:33:54 +0200267// Make sure all feature-test macros are available.
Mark de Wever14151d22021-07-30 14:35:37 -0400268#include <version>
Mark de Weverbe38c382021-08-11 17:33:54 +0200269// Enable the contents of the header only when libc++ was built with LIBCXX_ENABLE_INCOMPLETE_FEATURES.
Mark de Wever14151d22021-07-30 14:35:37 -0400270#if !defined(_LIBCPP_HAS_NO_INCOMPLETE_FORMAT)
271
Mark de Weverdf5fd832020-11-26 19:12:18 +0100272#include <__config>
Mark de Wevercb50a052020-12-19 13:52:07 +0100273#include <__debug>
Mark de Wevercba61372020-12-05 11:45:21 +0100274#include <__format/format_arg.h>
275#include <__format/format_args.h>
276#include <__format/format_context.h>
Mark de Wever1aef5d02021-04-25 17:58:03 +0200277#include <__format/format_error.h>
Mark de Wever29307fd2020-12-14 17:39:15 +0100278#include <__format/format_fwd.h>
Mark de Wevere26bdbb2021-04-25 18:23:42 +0200279#include <__format/format_parse_context.h>
Mark de Wevercb50a052020-12-19 13:52:07 +0100280#include <__format/format_string.h>
281#include <__format/formatter.h>
Mark de Wever29307fd2020-12-14 17:39:15 +0100282#include <__format/formatter_integer.h>
Mark de Weverf82551e2020-12-14 17:39:15 +0100283#include <__format/formatter_string.h>
284#include <__format/parser_std_format_spec.h>
Mark de Wevercb50a052020-12-19 13:52:07 +0100285#include <__variant/monostate.h>
Mark de Wevercba61372020-12-05 11:45:21 +0100286#include <array>
Mark de Wevercb50a052020-12-19 13:52:07 +0100287#include <concepts>
288#include <string>
289#include <string_view>
290#include <type_traits>
291
292#ifndef _LIBCPP_HAS_NO_LOCALIZATION
293#include <locale>
294#endif
Mark de Wever8a0a1882021-07-25 09:18:53 +0200295
Mark de Weverdf5fd832020-11-26 19:12:18 +0100296#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
Mark de Wevercba61372020-12-05 11:45:21 +0100297#pragma GCC system_header
Mark de Weverdf5fd832020-11-26 19:12:18 +0100298#endif
299
Mark de Wevercb50a052020-12-19 13:52:07 +0100300_LIBCPP_PUSH_MACROS
301#include <__undef_macros>
302
Mark de Wevercba61372020-12-05 11:45:21 +0100303_LIBCPP_BEGIN_NAMESPACE_STD
304
305#if _LIBCPP_STD_VER > 17
306
307// TODO FMT Remove this once we require compilers with proper C++20 support.
308// If the compiler has no concepts support, the format header will be disabled.
309// Without concepts support enable_if needs to be used and that too much effort
310// to support compilers with partial C++20 support.
311#if !defined(_LIBCPP_HAS_NO_CONCEPTS)
312
313// TODO FMT Evaluate which templates should be external templates. This
314// improves the efficiency of the header. However since the header is still
315// under heavy development and not all classes are stable it makes no sense
316// to do this optimization now.
317
318using format_args = basic_format_args<format_context>;
319using wformat_args = basic_format_args<wformat_context>;
320
321template <class _OutIt, class _CharT>
322using format_args_t = basic_format_args<basic_format_context<_OutIt, _CharT>>;
323
324template <class _Context, class... _Args>
325struct _LIBCPP_TEMPLATE_VIS __format_arg_store {
326 // TODO FMT Use a built-in array.
327 array<basic_format_arg<_Context>, sizeof...(_Args)> __args;
328};
329
330template <class _Context = format_context, class... _Args>
331_LIBCPP_HIDE_FROM_ABI __format_arg_store<_Context, _Args...>
332make_format_args(const _Args&... __args) {
333 return {basic_format_arg<_Context>(__args)...};
334}
335
336template <class... _Args>
337_LIBCPP_HIDE_FROM_ABI __format_arg_store<wformat_context, _Args...>
338make_wformat_args(const _Args&... __args) {
339 return _VSTD::make_format_args<wformat_context>(__args...);
340}
341
Mark de Wevercb50a052020-12-19 13:52:07 +0100342namespace __format {
343template <class _Tp, class _CharT>
344struct _LIBCPP_TEMPLATE_VIS __formatter_char {
345 _LIBCPP_HIDE_FROM_ABI
346 auto parse(auto& __parse_ctx) -> decltype(__parse_ctx.begin()) {
347 // TODO FMT Implement this function.
348 return __parse_ctx.begin();
349 }
350
351 _LIBCPP_HIDE_FROM_ABI
352 auto format(_Tp __c, auto& __ctx) -> decltype(__ctx.out()) {
353 // TODO FMT Implement the parsed formatting arguments.
354 auto __out_it = __ctx.out();
355 *__out_it++ = _CharT(__c);
356 return __out_it;
357 }
358};
359
Mark de Wevercb50a052020-12-19 13:52:07 +0100360template <class _Tp, class _CharT>
361requires(is_arithmetic_v<_Tp> &&
362 !same_as<_Tp, bool>) struct _LIBCPP_HIDE_FROM_ABI
363 __formatter_arithmetic {
364 _LIBCPP_HIDE_FROM_ABI
365 auto parse(auto& __parse_ctx) -> decltype(__parse_ctx.begin()) {
366 // TODO FMT Implement
367 return __parse_ctx.begin();
368 }
369
370 _LIBCPP_HIDE_FROM_ABI
371 auto format(_Tp __value, auto& __ctx) -> decltype(__ctx.out()) {
372 return __handle_format(__value, __ctx);
373 }
374
375private:
376 template <class _Uv>
377 _LIBCPP_HIDDEN static string
378 __convert(_Uv __value) requires(same_as<_CharT, char>) {
379 return _VSTD::to_string(__value);
380 }
381 template <class _Uv>
382 _LIBCPP_HIDDEN static wstring
383 __convert(_Uv __value) requires(same_as<_CharT, wchar_t>) {
384 return _VSTD::to_wstring(__value);
385 }
386
387 template <class _Uv>
388 _LIBCPP_HIDDEN auto __handle_format(_Uv __value, auto& __ctx)
389 -> decltype(__ctx.out())
Mark de Wevercb50a052020-12-19 13:52:07 +0100390 {
391 // TODO FMT Implement using formatting arguments
392 // TODO FMT Improve PoC since using std::to_string is inefficient.
393 // Note the code doesn't use std::string::iterator since the unit tests
394 // test with debug iterators and they fail with strings created from
395 // std::to_string.
396 auto __str = __convert(__value);
397 auto __out_it = __ctx.out();
398 for (size_t __i = 0, __e = __str.size(); __i != __e; ++__i)
399 *__out_it++ = __str[__i];
400 return __out_it;
401 }
Mark de Wevercb50a052020-12-19 13:52:07 +0100402};
403} // namespace __format
404
405// These specializations are helper stubs and not proper formatters.
406// TODO FMT Implement the proper formatter specializations.
407
408// [format.formatter.spec]/2.1 The specializations
409
410template <>
411struct _LIBCPP_TEMPLATE_VIS formatter<char, char>
412 : public __format::__formatter_char<char, char> {};
413
414template <>
415struct _LIBCPP_TEMPLATE_VIS formatter<char, wchar_t>
416 : public __format::__formatter_char<char, wchar_t> {};
417
418template <>
419struct _LIBCPP_TEMPLATE_VIS formatter<wchar_t, wchar_t>
420 : public __format::__formatter_char<wchar_t, wchar_t> {};
421
Mark de Wevercb50a052020-12-19 13:52:07 +0100422// [format.formatter.spec]/2.3
423// For each charT, for each cv-unqualified arithmetic type ArithmeticT other
424// than char, wchar_t, char8_t, char16_t, or char32_t, a specialization
425
426// Boolean.
427template <class _CharT>
428struct _LIBCPP_TEMPLATE_VIS formatter<bool, _CharT> {
429 _LIBCPP_HIDE_FROM_ABI
430 auto parse(auto& __parse_ctx) -> decltype(__parse_ctx.begin()) {
431 // TODO FMT Implement
432 return __parse_ctx.begin();
433 }
434
435 _LIBCPP_HIDE_FROM_ABI
436 auto format(bool __b, auto& __ctx) -> decltype(__ctx.out()) {
437 // TODO FMT Implement using formatting arguments
438 auto __out_it = __ctx.out();
439 *__out_it++ = _CharT('0') + __b;
440 return __out_it;
441 }
442};
443
Mark de Wevercb50a052020-12-19 13:52:07 +0100444// Floating point types.
445// TODO FMT There are no replacements for the floating point stubs due to not
446// having floating point support in std::to_chars yet. These stubs aren't
447// removed since they are useful for developing the real versions.
448// Ultimately the stubs should be implemented properly and this code can be
449// removed.
450#if 0
451template <class _CharT>
452struct _LIBCPP_TEMPLATE_VIS _LIBCPP_AVAILABILITY_FORMAT formatter<float, _CharT>
453 : public __format::__formatter_arithmetic<float, _CharT> {};
454template <class _CharT>
455struct _LIBCPP_TEMPLATE_VIS _LIBCPP_AVAILABILITY_FORMAT
456 formatter<double, _CharT>
457 : public __format::__formatter_arithmetic<double, _CharT> {};
458template <class _CharT>
459struct _LIBCPP_TEMPLATE_VIS _LIBCPP_AVAILABILITY_FORMAT
460 formatter<long double, _CharT>
461 : public __format::__formatter_arithmetic<long double, _CharT> {};
462#endif
463
464namespace __format {
465
466template <class _CharT, class _ParseCtx, class _Ctx>
467_LIBCPP_HIDE_FROM_ABI const _CharT*
468__handle_replacement_field(const _CharT* __begin, const _CharT* __end,
469 _ParseCtx& __parse_ctx, _Ctx& __ctx) {
470 __format::__parse_number_result __r =
471 __format::__parse_arg_id(__begin, __end, __parse_ctx);
472
473 switch (*__r.__ptr) {
474 case _CharT(':'):
475 // The arg-id has a format-specifier, advance the input to the format-spec.
476 __parse_ctx.advance_to(__r.__ptr + 1);
477 break;
478 case _CharT('}'):
479 // The arg-id has no format-specifier.
480 __parse_ctx.advance_to(__r.__ptr);
481 break;
482 default:
483 __throw_format_error(
484 "The replacement field arg-id should terminate at a ':' or '}'");
485 }
486
487 _VSTD::visit_format_arg(
488 [&](auto __arg) {
489 if constexpr (same_as<decltype(__arg), monostate>)
490 __throw_format_error("Argument index out of bounds");
491 else {
492 formatter<decltype(__arg), _CharT> __formatter;
493 __parse_ctx.advance_to(__formatter.parse(__parse_ctx));
494 __ctx.advance_to(__formatter.format(__arg, __ctx));
495 }
496 },
497 __ctx.arg(__r.__value));
498
499 __begin = __parse_ctx.begin();
500 if (__begin == __end || *__begin != _CharT('}'))
501 __throw_format_error("The replacement field misses a terminating '}'");
502
503 return ++__begin;
504}
505
506template <class _ParseCtx, class _Ctx>
507_LIBCPP_HIDE_FROM_ABI typename _Ctx::iterator
508__vformat_to(_ParseCtx&& __parse_ctx, _Ctx&& __ctx) {
509 using _CharT = typename _ParseCtx::char_type;
510 static_assert(same_as<typename _Ctx::char_type, _CharT>);
511
512 const _CharT* __begin = __parse_ctx.begin();
513 const _CharT* __end = __parse_ctx.end();
514 typename _Ctx::iterator __out_it = __ctx.out();
515 while (__begin != __end) {
516 switch (*__begin) {
517 case _CharT('{'):
518 ++__begin;
519 if (__begin == __end)
520 __throw_format_error("The format string terminates at a '{'");
521
522 if (*__begin != _CharT('{')) [[likely]] {
523 __ctx.advance_to(_VSTD::move(__out_it));
524 __begin =
525 __handle_replacement_field(__begin, __end, __parse_ctx, __ctx);
526 __out_it = __ctx.out();
527
528 // The output is written and __begin points to the next character. So
529 // start the next iteration.
530 continue;
531 }
532 // The string is an escape character.
533 break;
534
535 case _CharT('}'):
536 ++__begin;
537 if (__begin == __end || *__begin != _CharT('}'))
538 __throw_format_error(
539 "The format string contains an invalid escape sequence");
540
541 break;
542 }
543
544 // Copy the character to the output verbatim.
545 *__out_it++ = *__begin++;
546 }
547 return __out_it;
548}
549
550} // namespace __format
551
552template <class _OutIt, class _CharT>
553requires(output_iterator<_OutIt, const _CharT&>) _LIBCPP_HIDE_FROM_ABI _OutIt
554 __vformat_to(_OutIt __out_it, basic_string_view<_CharT> __fmt,
555 format_args_t<type_identity_t<_OutIt>, _CharT> __args) {
556 return __format::__vformat_to(
557 basic_format_parse_context{__fmt, __args.__size()},
558 _VSTD::__format_context_create(_VSTD::move(__out_it), __args));
559}
560
561template <output_iterator<const char&> _OutIt>
562_LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT _OutIt
563vformat_to(_OutIt __out_it, string_view __fmt,
564 format_args_t<type_identity_t<_OutIt>, char> __args) {
565 return _VSTD::__vformat_to(_VSTD::move(__out_it), __fmt, __args);
566}
567
568template <output_iterator<const wchar_t&> _OutIt>
569_LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT _OutIt
570vformat_to(_OutIt __out_it, wstring_view __fmt,
571 format_args_t<type_identity_t<_OutIt>, wchar_t> __args) {
572 return _VSTD::__vformat_to(_VSTD::move(__out_it), __fmt, __args);
573}
574
575template <output_iterator<const char&> _OutIt, class... _Args>
576_LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT _OutIt
577format_to(_OutIt __out_it, string_view __fmt, const _Args&... __args) {
578 return _VSTD::vformat_to(
579 _VSTD::move(__out_it), __fmt,
580 _VSTD::make_format_args<basic_format_context<_OutIt, char>>(__args...));
581}
582
583template <output_iterator<const wchar_t&> _OutIt, class... _Args>
584_LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT _OutIt
585format_to(_OutIt __out_it, wstring_view __fmt, const _Args&... __args) {
586 return _VSTD::vformat_to(
587 _VSTD::move(__out_it), __fmt,
588 _VSTD::make_format_args<basic_format_context<_OutIt, wchar_t>>(
589 __args...));
590}
591
592inline _LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT string
593vformat(string_view __fmt, format_args __args) {
594 string __res;
595 _VSTD::vformat_to(_VSTD::back_inserter(__res), __fmt, __args);
596 return __res;
597}
598
599inline _LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT wstring
600vformat(wstring_view __fmt, wformat_args __args) {
601 wstring __res;
602 _VSTD::vformat_to(_VSTD::back_inserter(__res), __fmt, __args);
603 return __res;
604}
605
606template <class... _Args>
607_LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT string
608format(string_view __fmt, const _Args&... __args) {
609 return _VSTD::vformat(__fmt, _VSTD::make_format_args(__args...));
610}
611
612template <class... _Args>
613_LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT wstring
614format(wstring_view __fmt, const _Args&... __args) {
615 return _VSTD::vformat(__fmt, _VSTD::make_wformat_args(__args...));
616}
617
618template <class _OutIt>
619struct _LIBCPP_TEMPLATE_VIS format_to_n_result {
620 _OutIt out;
621 iter_difference_t<_OutIt> size;
622};
623
624template <output_iterator<const char&> _OutIt, class... _Args>
625_LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT format_to_n_result<_OutIt>
626format_to_n(_OutIt __out_it, iter_difference_t<_OutIt> __n, string_view __fmt,
627 const _Args&... __args) {
628 // TODO FMT Improve PoC: using std::string is inefficient.
629 string __str = _VSTD::vformat(__fmt, _VSTD::make_format_args(__args...));
630 iter_difference_t<_OutIt> __s = __str.size();
631 iter_difference_t<_OutIt> __m =
632 _VSTD::clamp(__n, iter_difference_t<_OutIt>(0), __s);
633 __out_it = _VSTD::copy_n(__str.begin(), __m, _VSTD::move(__out_it));
634 return {_VSTD::move(__out_it), __s};
635}
636
637template <output_iterator<const wchar_t&> _OutIt, class... _Args>
638_LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT format_to_n_result<_OutIt>
639format_to_n(_OutIt __out_it, iter_difference_t<_OutIt> __n, wstring_view __fmt,
640 const _Args&... __args) {
641 // TODO FMT Improve PoC: using std::string is inefficient.
642 wstring __str = _VSTD::vformat(__fmt, _VSTD::make_wformat_args(__args...));
643 iter_difference_t<_OutIt> __s = __str.size();
644 iter_difference_t<_OutIt> __m =
645 _VSTD::clamp(__n, iter_difference_t<_OutIt>(0), __s);
646 __out_it = _VSTD::copy_n(__str.begin(), __m, _VSTD::move(__out_it));
647 return {_VSTD::move(__out_it), __s};
648}
649
650template <class... _Args>
651_LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT size_t
652formatted_size(string_view __fmt, const _Args&... __args) {
653 // TODO FMT Improve PoC: using std::string is inefficient.
654 return _VSTD::vformat(__fmt, _VSTD::make_format_args(__args...)).size();
655}
656
657template <class... _Args>
658_LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT size_t
659formatted_size(wstring_view __fmt, const _Args&... __args) {
660 // TODO FMT Improve PoC: using std::string is inefficient.
661 return _VSTD::vformat(__fmt, _VSTD::make_wformat_args(__args...)).size();
662}
663
664#ifndef _LIBCPP_HAS_NO_LOCALIZATION
665
666template <class _OutIt, class _CharT>
667requires(output_iterator<_OutIt, const _CharT&>) _LIBCPP_HIDE_FROM_ABI _OutIt
668 __vformat_to(_OutIt __out_it, locale __loc, basic_string_view<_CharT> __fmt,
669 format_args_t<type_identity_t<_OutIt>, _CharT> __args) {
670 return __format::__vformat_to(
671 basic_format_parse_context{__fmt, __args.__size()},
672 _VSTD::__format_context_create(_VSTD::move(__out_it), __args,
673 _VSTD::move(__loc)));
674}
675
676template <output_iterator<const char&> _OutIt>
677_LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT _OutIt
678vformat_to(_OutIt __out_it, locale __loc, string_view __fmt,
679 format_args_t<type_identity_t<_OutIt>, char> __args) {
680 return _VSTD::__vformat_to(_VSTD::move(__out_it), _VSTD::move(__loc), __fmt,
681 __args);
682}
683
684template <output_iterator<const wchar_t&> _OutIt>
685_LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT _OutIt
686vformat_to(_OutIt __out_it, locale __loc, wstring_view __fmt,
687 format_args_t<type_identity_t<_OutIt>, wchar_t> __args) {
688 return _VSTD::__vformat_to(_VSTD::move(__out_it), _VSTD::move(__loc), __fmt,
689 __args);
690}
691
692template <output_iterator<const char&> _OutIt, class... _Args>
693_LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT _OutIt format_to(
694 _OutIt __out_it, locale __loc, string_view __fmt, const _Args&... __args) {
695 return _VSTD::vformat_to(
696 _VSTD::move(__out_it), _VSTD::move(__loc), __fmt,
697 _VSTD::make_format_args<basic_format_context<_OutIt, char>>(__args...));
698}
699
700template <output_iterator<const wchar_t&> _OutIt, class... _Args>
701_LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT _OutIt format_to(
702 _OutIt __out_it, locale __loc, wstring_view __fmt, const _Args&... __args) {
703 return _VSTD::vformat_to(
704 _VSTD::move(__out_it), _VSTD::move(__loc), __fmt,
705 _VSTD::make_format_args<basic_format_context<_OutIt, wchar_t>>(
706 __args...));
707}
708
709inline _LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT string
710vformat(locale __loc, string_view __fmt, format_args __args) {
711 string __res;
712 _VSTD::vformat_to(_VSTD::back_inserter(__res), _VSTD::move(__loc), __fmt,
713 __args);
714 return __res;
715}
716
717inline _LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT wstring
718vformat(locale __loc, wstring_view __fmt, wformat_args __args) {
719 wstring __res;
720 _VSTD::vformat_to(_VSTD::back_inserter(__res), _VSTD::move(__loc), __fmt,
721 __args);
722 return __res;
723}
724
725template <class... _Args>
726_LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT string
727format(locale __loc, string_view __fmt, const _Args&... __args) {
728 return _VSTD::vformat(_VSTD::move(__loc), __fmt,
729 _VSTD::make_format_args(__args...));
730}
731
732template <class... _Args>
733_LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT wstring
734format(locale __loc, wstring_view __fmt, const _Args&... __args) {
735 return _VSTD::vformat(_VSTD::move(__loc), __fmt,
736 _VSTD::make_wformat_args(__args...));
737}
738
739template <output_iterator<const char&> _OutIt, class... _Args>
740_LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT format_to_n_result<_OutIt>
741format_to_n(_OutIt __out_it, iter_difference_t<_OutIt> __n, locale __loc,
742 string_view __fmt, const _Args&... __args) {
743 // TODO FMT Improve PoC: using std::string is inefficient.
744 string __str = _VSTD::vformat(_VSTD::move(__loc), __fmt,
745 _VSTD::make_format_args(__args...));
746 iter_difference_t<_OutIt> __s = __str.size();
747 iter_difference_t<_OutIt> __m =
748 _VSTD::clamp(__n, iter_difference_t<_OutIt>(0), __s);
749 __out_it = _VSTD::copy_n(__str.begin(), __m, _VSTD::move(__out_it));
750 return {_VSTD::move(__out_it), __s};
751}
752
753template <output_iterator<const wchar_t&> _OutIt, class... _Args>
754_LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT format_to_n_result<_OutIt>
755format_to_n(_OutIt __out_it, iter_difference_t<_OutIt> __n, locale __loc,
756 wstring_view __fmt, const _Args&... __args) {
757 // TODO FMT Improve PoC: using std::string is inefficient.
758 wstring __str = _VSTD::vformat(_VSTD::move(__loc), __fmt,
759 _VSTD::make_wformat_args(__args...));
760 iter_difference_t<_OutIt> __s = __str.size();
761 iter_difference_t<_OutIt> __m =
762 _VSTD::clamp(__n, iter_difference_t<_OutIt>(0), __s);
763 __out_it = _VSTD::copy_n(__str.begin(), __m, _VSTD::move(__out_it));
764 return {_VSTD::move(__out_it), __s};
765}
766
767template <class... _Args>
768_LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT size_t
769formatted_size(locale __loc, string_view __fmt, const _Args&... __args) {
770 // TODO FMT Improve PoC: using std::string is inefficient.
771 return _VSTD::vformat(_VSTD::move(__loc), __fmt,
772 _VSTD::make_format_args(__args...))
773 .size();
774}
775
776template <class... _Args>
777_LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT size_t
778formatted_size(locale __loc, wstring_view __fmt, const _Args&... __args) {
779 // TODO FMT Improve PoC: using std::string is inefficient.
780 return _VSTD::vformat(_VSTD::move(__loc), __fmt,
781 _VSTD::make_wformat_args(__args...))
782 .size();
783}
784
Louis Dionneaf2c8142021-09-09 14:43:02 -0400785#endif // _LIBCPP_HAS_NO_LOCALIZATION
Mark de Wevercb50a052020-12-19 13:52:07 +0100786
Mark de Wevercba61372020-12-05 11:45:21 +0100787#endif // !defined(_LIBCPP_HAS_NO_CONCEPTS)
788#endif //_LIBCPP_STD_VER > 17
789
790_LIBCPP_END_NAMESPACE_STD
791
Mark de Wevercb50a052020-12-19 13:52:07 +0100792_LIBCPP_POP_MACROS
793
Mark de Wever14151d22021-07-30 14:35:37 -0400794#endif // !defined(_LIBCPP_HAS_NO_INCOMPLETE_FORMAT)
795
Mark de Weverdf5fd832020-11-26 19:12:18 +0100796#endif // _LIBCPP_FORMAT