format 8.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206
  1. // -*- C++ -*-
  2. //===----------------------------------------------------------------------===//
  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. #ifndef _LIBCPP_FORMAT
  10. #define _LIBCPP_FORMAT
  11. /*
  12. namespace std {
  13. // [format.context], class template basic_format_context
  14. template<class Out, class charT> class basic_format_context;
  15. using format_context = basic_format_context<unspecified, char>;
  16. using wformat_context = basic_format_context<unspecified, wchar_t>;
  17. // [format.args], class template basic_format_args
  18. template<class Context> class basic_format_args;
  19. using format_args = basic_format_args<format_context>;
  20. using wformat_args = basic_format_args<wformat_context>;
  21. // [format.fmt.string], class template basic_format_string
  22. template<class charT, class... Args>
  23. struct basic_format_string { // since C++23, exposition only before C++23
  24. private:
  25. basic_string_view<charT> str; // exposition only
  26. public:
  27. template<class T> consteval basic_format_string(const T& s);
  28. constexpr basic_string_view<charT> get() const noexcept { return str; }
  29. };
  30. template<class... Args>
  31. using format_string = // since C++23, exposition only before C++23
  32. basic_format_string<char, type_identity_t<Args>...>;
  33. template<class... Args>
  34. using wformat_string = // since C++23, exposition only before C++23
  35. basic_format_string<wchar_t, type_identity_t<Args>...>;
  36. // [format.functions], formatting functions
  37. template<class... Args>
  38. string format(format-string<Args...> fmt, Args&&... args);
  39. template<class... Args>
  40. wstring format(wformat-string<Args...> fmt, Args&&... args);
  41. template<class... Args>
  42. string format(const locale& loc, format-string<Args...> fmt, Args&&... args);
  43. template<class... Args>
  44. wstring format(const locale& loc, wformat-string<Args...> fmt, Args&&... args);
  45. string vformat(string_view fmt, format_args args);
  46. wstring vformat(wstring_view fmt, wformat_args args);
  47. string vformat(const locale& loc, string_view fmt, format_args args);
  48. wstring vformat(const locale& loc, wstring_view fmt, wformat_args args);
  49. template<class Out, class... Args>
  50. Out format_to(Out out, format-string<Args...> fmt, Args&&... args);
  51. template<class Out, class... Args>
  52. Out format_to(Out out, wformat-string<Args...> fmt, Args&&... args);
  53. template<class Out, class... Args>
  54. Out format_to(Out out, const locale& loc, format-string<Args...> fmt, Args&&... args);
  55. template<class Out, class... Args>
  56. Out format_to(Out out, const locale& loc, wformat-string<Args...> fmt, Args&&... args);
  57. template<class Out>
  58. Out vformat_to(Out out, string_view fmt, format_args args);
  59. template<class Out>
  60. Out vformat_to(Out out, wstring_view fmt, wformat_args args);
  61. template<class Out>
  62. Out vformat_to(Out out, const locale& loc, string_view fmt,
  63. format_args char> args);
  64. template<class Out>
  65. Out vformat_to(Out out, const locale& loc, wstring_view fmt,
  66. wformat_args args);
  67. template<class Out> struct format_to_n_result {
  68. Out out;
  69. iter_difference_t<Out> size;
  70. };
  71. template<class Out, class... Args>
  72. format_to_n_result<Out> format_to_n(Out out, iter_difference_t<Out> n,
  73. format-string<Args...> fmt, Args&&... args);
  74. template<class Out, class... Args>
  75. format_to_n_result<Out> format_to_n(Out out, iter_difference_t<Out> n,
  76. wformat-string<Args...> fmt, Args&&... args);
  77. template<class Out, class... Args>
  78. format_to_n_result<Out> format_to_n(Out out, iter_difference_t<Out> n,
  79. const locale& loc, format-string<Args...> fmt,
  80. Args&&... args);
  81. template<class Out, class... Args>
  82. format_to_n_result<Out> format_to_n(Out out, iter_difference_t<Out> n,
  83. const locale& loc, wformat-string<Args...> fmt,
  84. Args&&... args);
  85. template<class... Args>
  86. size_t formatted_size(format-string<Args...> fmt, Args&&... args);
  87. template<class... Args>
  88. size_t formatted_size(wformat-string<Args...> fmt, Args&&... args);
  89. template<class... Args>
  90. size_t formatted_size(const locale& loc, format-string<Args...> fmt, Args&&... args);
  91. template<class... Args>
  92. size_t formatted_size(const locale& loc, wformat-string<Args...> fmt, Args&&... args);
  93. // [format.formatter], formatter
  94. template<class T, class charT = char> struct formatter;
  95. // [format.parse.ctx], class template basic_format_parse_context
  96. template<class charT> class basic_format_parse_context;
  97. using format_parse_context = basic_format_parse_context<char>;
  98. using wformat_parse_context = basic_format_parse_context<wchar_t>;
  99. // [format.range], formatting of ranges
  100. // [format.range.fmtkind], variable template format_kind
  101. enum class range_format { // since C++23
  102. disabled,
  103. map,
  104. set,
  105. sequence,
  106. string,
  107. debug_string
  108. };
  109. template<class R>
  110. constexpr unspecified format_kind = unspecified; // since C++23
  111. template<ranges::input_range R>
  112. requires same_as<R, remove_cvref_t<R>>
  113. constexpr range_format format_kind<R> = see below; // since C++23
  114. // [format.range.formatter], class template range_formatter
  115. template<class T, class charT = char>
  116. requires same_as<remove_cvref_t<T>, T> && formattable<T, charT>
  117. class range_formatter; // since C++23
  118. // [format.range.fmtdef], class template range-default-formatter
  119. template<range_format K, ranges::input_range R, class charT>
  120. struct range-default-formatter; // exposition only, since C++23
  121. // [format.range.fmtmap], [format.range.fmtset], [format.range.fmtstr],
  122. // specializations for maps, sets, and strings
  123. template<ranges::input_range R, class charT>
  124. requires (format_kind<R> != range_format::disabled) &&
  125. formattable<ranges::range_reference_t<R>, charT>
  126. struct formatter<R, charT> : range-default-formatter<format_kind<R>, R, charT> { }; // since C++23
  127. // [format.arguments], arguments
  128. // [format.arg], class template basic_format_arg
  129. template<class Context> class basic_format_arg;
  130. template<class Visitor, class Context>
  131. see below visit_format_arg(Visitor&& vis, basic_format_arg<Context> arg);
  132. // [format.arg.store], class template format-arg-store
  133. template<class Context, class... Args> struct format-arg-store; // exposition only
  134. template<class Context = format_context, class... Args>
  135. format-arg-store<Context, Args...>
  136. make_format_args(Args&&... args);
  137. template<class... Args>
  138. format-arg-store<wformat_context, Args...>
  139. make_wformat_args(Args&&... args);
  140. // [format.error], class format_error
  141. class format_error;
  142. }
  143. */
  144. #include <__assert> // all public C++ headers provide the assertion handler
  145. #include <__config>
  146. #include <__format/buffer.h>
  147. #include <__format/concepts.h>
  148. #include <__format/container_adaptor.h>
  149. #include <__format/enable_insertable.h>
  150. #include <__format/format_arg.h>
  151. #include <__format/format_arg_store.h>
  152. #include <__format/format_args.h>
  153. #include <__format/format_context.h>
  154. #include <__format/format_error.h>
  155. #include <__format/format_functions.h>
  156. #include <__format/format_fwd.h>
  157. #include <__format/format_parse_context.h>
  158. #include <__format/format_string.h>
  159. #include <__format/format_to_n_result.h>
  160. #include <__format/formatter.h>
  161. #include <__format/formatter_bool.h>
  162. #include <__format/formatter_char.h>
  163. #include <__format/formatter_floating_point.h>
  164. #include <__format/formatter_integer.h>
  165. #include <__format/formatter_pointer.h>
  166. #include <__format/formatter_string.h>
  167. #include <__format/formatter_tuple.h>
  168. #include <__format/parser_std_format_spec.h>
  169. #include <__format/range_default_formatter.h>
  170. #include <__format/range_formatter.h>
  171. #include <__format/unicode.h>
  172. #include <version>
  173. #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
  174. # pragma GCC system_header
  175. #endif
  176. #endif // _LIBCPP_FORMAT