blob: 91160151489aafc10647819fd93363fc508e8de5 [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 Wever68a67712020-12-14 17:39:15 +0100282#include <__format/formatter_bool.h>
Mark de Weverb9d8e2f2020-12-14 17:39:15 +0100283#include <__format/formatter_char.h>
Mark de Wever29307fd2020-12-14 17:39:15 +0100284#include <__format/formatter_integer.h>
Mark de Weverf82551e2020-12-14 17:39:15 +0100285#include <__format/formatter_string.h>
286#include <__format/parser_std_format_spec.h>
Mark de Wevercb50a052020-12-19 13:52:07 +0100287#include <__variant/monostate.h>
Mark de Wevercba61372020-12-05 11:45:21 +0100288#include <array>
Mark de Wevercb50a052020-12-19 13:52:07 +0100289#include <concepts>
290#include <string>
291#include <string_view>
292#include <type_traits>
293
294#ifndef _LIBCPP_HAS_NO_LOCALIZATION
295#include <locale>
296#endif
Mark de Wever8a0a1882021-07-25 09:18:53 +0200297
Mark de Weverdf5fd832020-11-26 19:12:18 +0100298#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
Mark de Wevercba61372020-12-05 11:45:21 +0100299#pragma GCC system_header
Mark de Weverdf5fd832020-11-26 19:12:18 +0100300#endif
301
Mark de Wevercb50a052020-12-19 13:52:07 +0100302_LIBCPP_PUSH_MACROS
303#include <__undef_macros>
304
Mark de Wevercba61372020-12-05 11:45:21 +0100305_LIBCPP_BEGIN_NAMESPACE_STD
306
307#if _LIBCPP_STD_VER > 17
308
309// TODO FMT Remove this once we require compilers with proper C++20 support.
310// If the compiler has no concepts support, the format header will be disabled.
311// Without concepts support enable_if needs to be used and that too much effort
312// to support compilers with partial C++20 support.
313#if !defined(_LIBCPP_HAS_NO_CONCEPTS)
314
315// TODO FMT Evaluate which templates should be external templates. This
316// improves the efficiency of the header. However since the header is still
317// under heavy development and not all classes are stable it makes no sense
318// to do this optimization now.
319
320using format_args = basic_format_args<format_context>;
321using wformat_args = basic_format_args<wformat_context>;
322
323template <class _OutIt, class _CharT>
324using format_args_t = basic_format_args<basic_format_context<_OutIt, _CharT>>;
325
326template <class _Context, class... _Args>
327struct _LIBCPP_TEMPLATE_VIS __format_arg_store {
328 // TODO FMT Use a built-in array.
329 array<basic_format_arg<_Context>, sizeof...(_Args)> __args;
330};
331
332template <class _Context = format_context, class... _Args>
333_LIBCPP_HIDE_FROM_ABI __format_arg_store<_Context, _Args...>
334make_format_args(const _Args&... __args) {
335 return {basic_format_arg<_Context>(__args)...};
336}
337
338template <class... _Args>
339_LIBCPP_HIDE_FROM_ABI __format_arg_store<wformat_context, _Args...>
340make_wformat_args(const _Args&... __args) {
341 return _VSTD::make_format_args<wformat_context>(__args...);
342}
Mark de Wevercb50a052020-12-19 13:52:07 +0100343namespace __format {
Mark de Wevercb50a052020-12-19 13:52:07 +0100344
Mark de Wevercb50a052020-12-19 13:52:07 +0100345template <class _Tp, class _CharT>
346requires(is_arithmetic_v<_Tp> &&
347 !same_as<_Tp, bool>) struct _LIBCPP_HIDE_FROM_ABI
348 __formatter_arithmetic {
349 _LIBCPP_HIDE_FROM_ABI
350 auto parse(auto& __parse_ctx) -> decltype(__parse_ctx.begin()) {
351 // TODO FMT Implement
352 return __parse_ctx.begin();
353 }
354
355 _LIBCPP_HIDE_FROM_ABI
356 auto format(_Tp __value, auto& __ctx) -> decltype(__ctx.out()) {
357 return __handle_format(__value, __ctx);
358 }
359
360private:
361 template <class _Uv>
362 _LIBCPP_HIDDEN static string
363 __convert(_Uv __value) requires(same_as<_CharT, char>) {
364 return _VSTD::to_string(__value);
365 }
366 template <class _Uv>
367 _LIBCPP_HIDDEN static wstring
368 __convert(_Uv __value) requires(same_as<_CharT, wchar_t>) {
369 return _VSTD::to_wstring(__value);
370 }
371
372 template <class _Uv>
373 _LIBCPP_HIDDEN auto __handle_format(_Uv __value, auto& __ctx)
374 -> decltype(__ctx.out())
Mark de Wevercb50a052020-12-19 13:52:07 +0100375 {
376 // TODO FMT Implement using formatting arguments
377 // TODO FMT Improve PoC since using std::to_string is inefficient.
378 // Note the code doesn't use std::string::iterator since the unit tests
379 // test with debug iterators and they fail with strings created from
380 // std::to_string.
381 auto __str = __convert(__value);
382 auto __out_it = __ctx.out();
383 for (size_t __i = 0, __e = __str.size(); __i != __e; ++__i)
384 *__out_it++ = __str[__i];
385 return __out_it;
386 }
Mark de Wevercb50a052020-12-19 13:52:07 +0100387};
388} // namespace __format
389
390// These specializations are helper stubs and not proper formatters.
391// TODO FMT Implement the proper formatter specializations.
392
Mark de Wevercb50a052020-12-19 13:52:07 +0100393// Floating point types.
394// TODO FMT There are no replacements for the floating point stubs due to not
395// having floating point support in std::to_chars yet. These stubs aren't
396// removed since they are useful for developing the real versions.
397// Ultimately the stubs should be implemented properly and this code can be
398// removed.
399#if 0
400template <class _CharT>
401struct _LIBCPP_TEMPLATE_VIS _LIBCPP_AVAILABILITY_FORMAT formatter<float, _CharT>
402 : public __format::__formatter_arithmetic<float, _CharT> {};
403template <class _CharT>
404struct _LIBCPP_TEMPLATE_VIS _LIBCPP_AVAILABILITY_FORMAT
405 formatter<double, _CharT>
406 : public __format::__formatter_arithmetic<double, _CharT> {};
407template <class _CharT>
408struct _LIBCPP_TEMPLATE_VIS _LIBCPP_AVAILABILITY_FORMAT
409 formatter<long double, _CharT>
410 : public __format::__formatter_arithmetic<long double, _CharT> {};
411#endif
412
413namespace __format {
414
415template <class _CharT, class _ParseCtx, class _Ctx>
416_LIBCPP_HIDE_FROM_ABI const _CharT*
417__handle_replacement_field(const _CharT* __begin, const _CharT* __end,
418 _ParseCtx& __parse_ctx, _Ctx& __ctx) {
419 __format::__parse_number_result __r =
420 __format::__parse_arg_id(__begin, __end, __parse_ctx);
421
422 switch (*__r.__ptr) {
423 case _CharT(':'):
424 // The arg-id has a format-specifier, advance the input to the format-spec.
425 __parse_ctx.advance_to(__r.__ptr + 1);
426 break;
427 case _CharT('}'):
428 // The arg-id has no format-specifier.
429 __parse_ctx.advance_to(__r.__ptr);
430 break;
431 default:
432 __throw_format_error(
433 "The replacement field arg-id should terminate at a ':' or '}'");
434 }
435
436 _VSTD::visit_format_arg(
437 [&](auto __arg) {
438 if constexpr (same_as<decltype(__arg), monostate>)
439 __throw_format_error("Argument index out of bounds");
440 else {
441 formatter<decltype(__arg), _CharT> __formatter;
442 __parse_ctx.advance_to(__formatter.parse(__parse_ctx));
443 __ctx.advance_to(__formatter.format(__arg, __ctx));
444 }
445 },
446 __ctx.arg(__r.__value));
447
448 __begin = __parse_ctx.begin();
449 if (__begin == __end || *__begin != _CharT('}'))
450 __throw_format_error("The replacement field misses a terminating '}'");
451
452 return ++__begin;
453}
454
455template <class _ParseCtx, class _Ctx>
456_LIBCPP_HIDE_FROM_ABI typename _Ctx::iterator
457__vformat_to(_ParseCtx&& __parse_ctx, _Ctx&& __ctx) {
458 using _CharT = typename _ParseCtx::char_type;
459 static_assert(same_as<typename _Ctx::char_type, _CharT>);
460
461 const _CharT* __begin = __parse_ctx.begin();
462 const _CharT* __end = __parse_ctx.end();
463 typename _Ctx::iterator __out_it = __ctx.out();
464 while (__begin != __end) {
465 switch (*__begin) {
466 case _CharT('{'):
467 ++__begin;
468 if (__begin == __end)
469 __throw_format_error("The format string terminates at a '{'");
470
471 if (*__begin != _CharT('{')) [[likely]] {
472 __ctx.advance_to(_VSTD::move(__out_it));
473 __begin =
474 __handle_replacement_field(__begin, __end, __parse_ctx, __ctx);
475 __out_it = __ctx.out();
476
477 // The output is written and __begin points to the next character. So
478 // start the next iteration.
479 continue;
480 }
481 // The string is an escape character.
482 break;
483
484 case _CharT('}'):
485 ++__begin;
486 if (__begin == __end || *__begin != _CharT('}'))
487 __throw_format_error(
488 "The format string contains an invalid escape sequence");
489
490 break;
491 }
492
493 // Copy the character to the output verbatim.
494 *__out_it++ = *__begin++;
495 }
496 return __out_it;
497}
498
499} // namespace __format
500
501template <class _OutIt, class _CharT>
502requires(output_iterator<_OutIt, const _CharT&>) _LIBCPP_HIDE_FROM_ABI _OutIt
503 __vformat_to(_OutIt __out_it, basic_string_view<_CharT> __fmt,
504 format_args_t<type_identity_t<_OutIt>, _CharT> __args) {
505 return __format::__vformat_to(
506 basic_format_parse_context{__fmt, __args.__size()},
507 _VSTD::__format_context_create(_VSTD::move(__out_it), __args));
508}
509
510template <output_iterator<const char&> _OutIt>
511_LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT _OutIt
512vformat_to(_OutIt __out_it, string_view __fmt,
513 format_args_t<type_identity_t<_OutIt>, char> __args) {
514 return _VSTD::__vformat_to(_VSTD::move(__out_it), __fmt, __args);
515}
516
517template <output_iterator<const wchar_t&> _OutIt>
518_LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT _OutIt
519vformat_to(_OutIt __out_it, wstring_view __fmt,
520 format_args_t<type_identity_t<_OutIt>, wchar_t> __args) {
521 return _VSTD::__vformat_to(_VSTD::move(__out_it), __fmt, __args);
522}
523
524template <output_iterator<const char&> _OutIt, class... _Args>
525_LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT _OutIt
526format_to(_OutIt __out_it, string_view __fmt, const _Args&... __args) {
527 return _VSTD::vformat_to(
528 _VSTD::move(__out_it), __fmt,
529 _VSTD::make_format_args<basic_format_context<_OutIt, char>>(__args...));
530}
531
532template <output_iterator<const wchar_t&> _OutIt, class... _Args>
533_LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT _OutIt
534format_to(_OutIt __out_it, wstring_view __fmt, const _Args&... __args) {
535 return _VSTD::vformat_to(
536 _VSTD::move(__out_it), __fmt,
537 _VSTD::make_format_args<basic_format_context<_OutIt, wchar_t>>(
538 __args...));
539}
540
541inline _LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT string
542vformat(string_view __fmt, format_args __args) {
543 string __res;
544 _VSTD::vformat_to(_VSTD::back_inserter(__res), __fmt, __args);
545 return __res;
546}
547
548inline _LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT wstring
549vformat(wstring_view __fmt, wformat_args __args) {
550 wstring __res;
551 _VSTD::vformat_to(_VSTD::back_inserter(__res), __fmt, __args);
552 return __res;
553}
554
555template <class... _Args>
556_LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT string
557format(string_view __fmt, const _Args&... __args) {
558 return _VSTD::vformat(__fmt, _VSTD::make_format_args(__args...));
559}
560
561template <class... _Args>
562_LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT wstring
563format(wstring_view __fmt, const _Args&... __args) {
564 return _VSTD::vformat(__fmt, _VSTD::make_wformat_args(__args...));
565}
566
567template <class _OutIt>
568struct _LIBCPP_TEMPLATE_VIS format_to_n_result {
569 _OutIt out;
570 iter_difference_t<_OutIt> size;
571};
572
573template <output_iterator<const char&> _OutIt, class... _Args>
574_LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT format_to_n_result<_OutIt>
575format_to_n(_OutIt __out_it, iter_difference_t<_OutIt> __n, string_view __fmt,
576 const _Args&... __args) {
577 // TODO FMT Improve PoC: using std::string is inefficient.
578 string __str = _VSTD::vformat(__fmt, _VSTD::make_format_args(__args...));
579 iter_difference_t<_OutIt> __s = __str.size();
580 iter_difference_t<_OutIt> __m =
581 _VSTD::clamp(__n, iter_difference_t<_OutIt>(0), __s);
582 __out_it = _VSTD::copy_n(__str.begin(), __m, _VSTD::move(__out_it));
583 return {_VSTD::move(__out_it), __s};
584}
585
586template <output_iterator<const wchar_t&> _OutIt, class... _Args>
587_LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT format_to_n_result<_OutIt>
588format_to_n(_OutIt __out_it, iter_difference_t<_OutIt> __n, wstring_view __fmt,
589 const _Args&... __args) {
590 // TODO FMT Improve PoC: using std::string is inefficient.
591 wstring __str = _VSTD::vformat(__fmt, _VSTD::make_wformat_args(__args...));
592 iter_difference_t<_OutIt> __s = __str.size();
593 iter_difference_t<_OutIt> __m =
594 _VSTD::clamp(__n, iter_difference_t<_OutIt>(0), __s);
595 __out_it = _VSTD::copy_n(__str.begin(), __m, _VSTD::move(__out_it));
596 return {_VSTD::move(__out_it), __s};
597}
598
599template <class... _Args>
600_LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT size_t
601formatted_size(string_view __fmt, const _Args&... __args) {
602 // TODO FMT Improve PoC: using std::string is inefficient.
603 return _VSTD::vformat(__fmt, _VSTD::make_format_args(__args...)).size();
604}
605
606template <class... _Args>
607_LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT size_t
608formatted_size(wstring_view __fmt, const _Args&... __args) {
609 // TODO FMT Improve PoC: using std::string is inefficient.
610 return _VSTD::vformat(__fmt, _VSTD::make_wformat_args(__args...)).size();
611}
612
613#ifndef _LIBCPP_HAS_NO_LOCALIZATION
614
615template <class _OutIt, class _CharT>
616requires(output_iterator<_OutIt, const _CharT&>) _LIBCPP_HIDE_FROM_ABI _OutIt
617 __vformat_to(_OutIt __out_it, locale __loc, basic_string_view<_CharT> __fmt,
618 format_args_t<type_identity_t<_OutIt>, _CharT> __args) {
619 return __format::__vformat_to(
620 basic_format_parse_context{__fmt, __args.__size()},
621 _VSTD::__format_context_create(_VSTD::move(__out_it), __args,
622 _VSTD::move(__loc)));
623}
624
625template <output_iterator<const char&> _OutIt>
626_LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT _OutIt
627vformat_to(_OutIt __out_it, locale __loc, string_view __fmt,
628 format_args_t<type_identity_t<_OutIt>, char> __args) {
629 return _VSTD::__vformat_to(_VSTD::move(__out_it), _VSTD::move(__loc), __fmt,
630 __args);
631}
632
633template <output_iterator<const wchar_t&> _OutIt>
634_LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT _OutIt
635vformat_to(_OutIt __out_it, locale __loc, wstring_view __fmt,
636 format_args_t<type_identity_t<_OutIt>, wchar_t> __args) {
637 return _VSTD::__vformat_to(_VSTD::move(__out_it), _VSTD::move(__loc), __fmt,
638 __args);
639}
640
641template <output_iterator<const char&> _OutIt, class... _Args>
642_LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT _OutIt format_to(
643 _OutIt __out_it, locale __loc, string_view __fmt, const _Args&... __args) {
644 return _VSTD::vformat_to(
645 _VSTD::move(__out_it), _VSTD::move(__loc), __fmt,
646 _VSTD::make_format_args<basic_format_context<_OutIt, char>>(__args...));
647}
648
649template <output_iterator<const wchar_t&> _OutIt, class... _Args>
650_LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT _OutIt format_to(
651 _OutIt __out_it, locale __loc, wstring_view __fmt, const _Args&... __args) {
652 return _VSTD::vformat_to(
653 _VSTD::move(__out_it), _VSTD::move(__loc), __fmt,
654 _VSTD::make_format_args<basic_format_context<_OutIt, wchar_t>>(
655 __args...));
656}
657
658inline _LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT string
659vformat(locale __loc, string_view __fmt, format_args __args) {
660 string __res;
661 _VSTD::vformat_to(_VSTD::back_inserter(__res), _VSTD::move(__loc), __fmt,
662 __args);
663 return __res;
664}
665
666inline _LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT wstring
667vformat(locale __loc, wstring_view __fmt, wformat_args __args) {
668 wstring __res;
669 _VSTD::vformat_to(_VSTD::back_inserter(__res), _VSTD::move(__loc), __fmt,
670 __args);
671 return __res;
672}
673
674template <class... _Args>
675_LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT string
676format(locale __loc, string_view __fmt, const _Args&... __args) {
677 return _VSTD::vformat(_VSTD::move(__loc), __fmt,
678 _VSTD::make_format_args(__args...));
679}
680
681template <class... _Args>
682_LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT wstring
683format(locale __loc, wstring_view __fmt, const _Args&... __args) {
684 return _VSTD::vformat(_VSTD::move(__loc), __fmt,
685 _VSTD::make_wformat_args(__args...));
686}
687
688template <output_iterator<const char&> _OutIt, class... _Args>
689_LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT format_to_n_result<_OutIt>
690format_to_n(_OutIt __out_it, iter_difference_t<_OutIt> __n, locale __loc,
691 string_view __fmt, const _Args&... __args) {
692 // TODO FMT Improve PoC: using std::string is inefficient.
693 string __str = _VSTD::vformat(_VSTD::move(__loc), __fmt,
694 _VSTD::make_format_args(__args...));
695 iter_difference_t<_OutIt> __s = __str.size();
696 iter_difference_t<_OutIt> __m =
697 _VSTD::clamp(__n, iter_difference_t<_OutIt>(0), __s);
698 __out_it = _VSTD::copy_n(__str.begin(), __m, _VSTD::move(__out_it));
699 return {_VSTD::move(__out_it), __s};
700}
701
702template <output_iterator<const wchar_t&> _OutIt, class... _Args>
703_LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT format_to_n_result<_OutIt>
704format_to_n(_OutIt __out_it, iter_difference_t<_OutIt> __n, locale __loc,
705 wstring_view __fmt, const _Args&... __args) {
706 // TODO FMT Improve PoC: using std::string is inefficient.
707 wstring __str = _VSTD::vformat(_VSTD::move(__loc), __fmt,
708 _VSTD::make_wformat_args(__args...));
709 iter_difference_t<_OutIt> __s = __str.size();
710 iter_difference_t<_OutIt> __m =
711 _VSTD::clamp(__n, iter_difference_t<_OutIt>(0), __s);
712 __out_it = _VSTD::copy_n(__str.begin(), __m, _VSTD::move(__out_it));
713 return {_VSTD::move(__out_it), __s};
714}
715
716template <class... _Args>
717_LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT size_t
718formatted_size(locale __loc, string_view __fmt, const _Args&... __args) {
719 // TODO FMT Improve PoC: using std::string is inefficient.
720 return _VSTD::vformat(_VSTD::move(__loc), __fmt,
721 _VSTD::make_format_args(__args...))
722 .size();
723}
724
725template <class... _Args>
726_LIBCPP_HIDE_FROM_ABI _LIBCPP_AVAILABILITY_FORMAT size_t
727formatted_size(locale __loc, wstring_view __fmt, const _Args&... __args) {
728 // TODO FMT Improve PoC: using std::string is inefficient.
729 return _VSTD::vformat(_VSTD::move(__loc), __fmt,
730 _VSTD::make_wformat_args(__args...))
731 .size();
732}
733
Louis Dionneaf2c8142021-09-09 14:43:02 -0400734#endif // _LIBCPP_HAS_NO_LOCALIZATION
Mark de Wevercb50a052020-12-19 13:52:07 +0100735
Mark de Wevercba61372020-12-05 11:45:21 +0100736#endif // !defined(_LIBCPP_HAS_NO_CONCEPTS)
737#endif //_LIBCPP_STD_VER > 17
738
739_LIBCPP_END_NAMESPACE_STD
740
Mark de Wevercb50a052020-12-19 13:52:07 +0100741_LIBCPP_POP_MACROS
742
Mark de Wever14151d22021-07-30 14:35:37 -0400743#endif // !defined(_LIBCPP_HAS_NO_INCOMPLETE_FORMAT)
744
Mark de Weverdf5fd832020-11-26 19:12:18 +0100745#endif // _LIBCPP_FORMAT