xchar.h 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368
  1. // Formatting library for C++ - optional wchar_t and exotic character support
  2. //
  3. // Copyright (c) 2012 - present, Victor Zverovich
  4. // All rights reserved.
  5. //
  6. // For the license information refer to format.h.
  7. #ifndef FMT_XCHAR_H_
  8. #define FMT_XCHAR_H_
  9. #include "color.h"
  10. #include "format.h"
  11. #include "ostream.h"
  12. #include "ranges.h"
  13. #ifndef FMT_MODULE
  14. # include <cwchar>
  15. # if FMT_USE_LOCALE
  16. # include <locale>
  17. # endif
  18. #endif
  19. FMT_BEGIN_NAMESPACE
  20. namespace detail {
  21. template <typename T>
  22. using is_exotic_char = bool_constant<!std::is_same<T, char>::value>;
  23. template <typename S, typename = void> struct format_string_char {};
  24. template <typename S>
  25. struct format_string_char<
  26. S, void_t<decltype(sizeof(detail::to_string_view(std::declval<S>())))>> {
  27. using type = char_t<S>;
  28. };
  29. template <typename S>
  30. struct format_string_char<
  31. S, enable_if_t<std::is_base_of<detail::compile_string, S>::value>> {
  32. using type = typename S::char_type;
  33. };
  34. template <typename S>
  35. using format_string_char_t = typename format_string_char<S>::type;
  36. inline auto write_loc(basic_appender<wchar_t> out, loc_value value,
  37. const format_specs& specs, locale_ref loc) -> bool {
  38. #if FMT_USE_LOCALE
  39. auto& numpunct =
  40. std::use_facet<std::numpunct<wchar_t>>(loc.get<std::locale>());
  41. auto separator = std::wstring();
  42. auto grouping = numpunct.grouping();
  43. if (!grouping.empty()) separator = std::wstring(1, numpunct.thousands_sep());
  44. return value.visit(loc_writer<wchar_t>{out, specs, separator, grouping, {}});
  45. #endif
  46. return false;
  47. }
  48. } // namespace detail
  49. FMT_BEGIN_EXPORT
  50. using wstring_view = basic_string_view<wchar_t>;
  51. using wformat_parse_context = parse_context<wchar_t>;
  52. using wformat_context = buffered_context<wchar_t>;
  53. using wformat_args = basic_format_args<wformat_context>;
  54. using wmemory_buffer = basic_memory_buffer<wchar_t>;
  55. template <typename Char, typename... T> struct basic_fstring {
  56. private:
  57. basic_string_view<Char> str_;
  58. static constexpr int num_static_named_args =
  59. detail::count_static_named_args<T...>();
  60. using checker = detail::format_string_checker<
  61. Char, static_cast<int>(sizeof...(T)), num_static_named_args,
  62. num_static_named_args != detail::count_named_args<T...>()>;
  63. using arg_pack = detail::arg_pack<T...>;
  64. public:
  65. using t = basic_fstring;
  66. template <typename S,
  67. FMT_ENABLE_IF(
  68. std::is_convertible<const S&, basic_string_view<Char>>::value)>
  69. FMT_CONSTEVAL FMT_ALWAYS_INLINE basic_fstring(const S& s) : str_(s) {
  70. if (FMT_USE_CONSTEVAL)
  71. detail::parse_format_string<Char>(s, checker(s, arg_pack()));
  72. }
  73. template <typename S,
  74. FMT_ENABLE_IF(std::is_base_of<detail::compile_string, S>::value&&
  75. std::is_same<typename S::char_type, Char>::value)>
  76. FMT_ALWAYS_INLINE basic_fstring(const S&) : str_(S()) {
  77. FMT_CONSTEXPR auto sv = basic_string_view<Char>(S());
  78. FMT_CONSTEXPR int ignore =
  79. (parse_format_string(sv, checker(sv, arg_pack())), 0);
  80. detail::ignore_unused(ignore);
  81. }
  82. basic_fstring(runtime_format_string<Char> fmt) : str_(fmt.str) {}
  83. operator basic_string_view<Char>() const { return str_; }
  84. auto get() const -> basic_string_view<Char> { return str_; }
  85. };
  86. template <typename Char, typename... T>
  87. using basic_format_string = basic_fstring<Char, T...>;
  88. template <typename... T>
  89. using wformat_string = typename basic_format_string<wchar_t, T...>::t;
  90. inline auto runtime(wstring_view s) -> runtime_format_string<wchar_t> {
  91. return {{s}};
  92. }
  93. template <> struct is_char<wchar_t> : std::true_type {};
  94. template <> struct is_char<char16_t> : std::true_type {};
  95. template <> struct is_char<char32_t> : std::true_type {};
  96. #ifdef __cpp_char8_t
  97. template <> struct is_char<char8_t> : bool_constant<detail::is_utf8_enabled> {};
  98. #endif
  99. template <typename... T>
  100. constexpr auto make_wformat_args(T&... args)
  101. -> decltype(fmt::make_format_args<wformat_context>(args...)) {
  102. return fmt::make_format_args<wformat_context>(args...);
  103. }
  104. #if !FMT_USE_NONTYPE_TEMPLATE_ARGS
  105. inline namespace literals {
  106. inline auto operator""_a(const wchar_t* s, size_t) -> detail::udl_arg<wchar_t> {
  107. return {s};
  108. }
  109. } // namespace literals
  110. #endif
  111. template <typename It, typename Sentinel>
  112. auto join(It begin, Sentinel end, wstring_view sep)
  113. -> join_view<It, Sentinel, wchar_t> {
  114. return {begin, end, sep};
  115. }
  116. template <typename Range, FMT_ENABLE_IF(!is_tuple_like<Range>::value)>
  117. auto join(Range&& range, wstring_view sep)
  118. -> join_view<decltype(std::begin(range)), decltype(std::end(range)),
  119. wchar_t> {
  120. return join(std::begin(range), std::end(range), sep);
  121. }
  122. template <typename T>
  123. auto join(std::initializer_list<T> list, wstring_view sep)
  124. -> join_view<const T*, const T*, wchar_t> {
  125. return join(std::begin(list), std::end(list), sep);
  126. }
  127. template <typename Tuple, FMT_ENABLE_IF(is_tuple_like<Tuple>::value)>
  128. auto join(const Tuple& tuple, basic_string_view<wchar_t> sep)
  129. -> tuple_join_view<wchar_t, Tuple> {
  130. return {tuple, sep};
  131. }
  132. template <typename Char, FMT_ENABLE_IF(!std::is_same<Char, char>::value)>
  133. auto vformat(basic_string_view<Char> fmt,
  134. typename detail::vformat_args<Char>::type args)
  135. -> std::basic_string<Char> {
  136. auto buf = basic_memory_buffer<Char>();
  137. detail::vformat_to(buf, fmt, args);
  138. return {buf.data(), buf.size()};
  139. }
  140. template <typename... T>
  141. auto format(wformat_string<T...> fmt, T&&... args) -> std::wstring {
  142. return vformat(fmt::wstring_view(fmt), fmt::make_wformat_args(args...));
  143. }
  144. template <typename OutputIt, typename... T>
  145. auto format_to(OutputIt out, wformat_string<T...> fmt, T&&... args)
  146. -> OutputIt {
  147. return vformat_to(out, fmt::wstring_view(fmt),
  148. fmt::make_wformat_args(args...));
  149. }
  150. // Pass char_t as a default template parameter instead of using
  151. // std::basic_string<char_t<S>> to reduce the symbol size.
  152. template <typename S, typename... T,
  153. typename Char = detail::format_string_char_t<S>,
  154. FMT_ENABLE_IF(!std::is_same<Char, char>::value &&
  155. !std::is_same<Char, wchar_t>::value)>
  156. auto format(const S& fmt, T&&... args) -> std::basic_string<Char> {
  157. return vformat(detail::to_string_view(fmt),
  158. fmt::make_format_args<buffered_context<Char>>(args...));
  159. }
  160. template <typename S, typename Char = detail::format_string_char_t<S>,
  161. FMT_ENABLE_IF(detail::is_exotic_char<Char>::value)>
  162. inline auto vformat(detail::locale_ref loc, const S& fmt,
  163. typename detail::vformat_args<Char>::type args)
  164. -> std::basic_string<Char> {
  165. auto buf = basic_memory_buffer<Char>();
  166. detail::vformat_to(buf, detail::to_string_view(fmt), args,
  167. detail::locale_ref(loc));
  168. return {buf.data(), buf.size()};
  169. }
  170. template <typename S, typename... T,
  171. typename Char = detail::format_string_char_t<S>,
  172. FMT_ENABLE_IF(detail::is_exotic_char<Char>::value)>
  173. inline auto format(detail::locale_ref loc, const S& fmt, T&&... args)
  174. -> std::basic_string<Char> {
  175. return vformat(loc, detail::to_string_view(fmt),
  176. fmt::make_format_args<buffered_context<Char>>(args...));
  177. }
  178. template <typename OutputIt, typename S,
  179. typename Char = detail::format_string_char_t<S>,
  180. FMT_ENABLE_IF(detail::is_output_iterator<OutputIt, Char>::value&&
  181. detail::is_exotic_char<Char>::value)>
  182. auto vformat_to(OutputIt out, const S& fmt,
  183. typename detail::vformat_args<Char>::type args) -> OutputIt {
  184. auto&& buf = detail::get_buffer<Char>(out);
  185. detail::vformat_to(buf, detail::to_string_view(fmt), args);
  186. return detail::get_iterator(buf, out);
  187. }
  188. template <typename OutputIt, typename S, typename... T,
  189. typename Char = detail::format_string_char_t<S>,
  190. FMT_ENABLE_IF(detail::is_output_iterator<OutputIt, Char>::value &&
  191. !std::is_same<Char, char>::value &&
  192. !std::is_same<Char, wchar_t>::value)>
  193. inline auto format_to(OutputIt out, const S& fmt, T&&... args) -> OutputIt {
  194. return vformat_to(out, detail::to_string_view(fmt),
  195. fmt::make_format_args<buffered_context<Char>>(args...));
  196. }
  197. template <typename S, typename OutputIt, typename... Args,
  198. typename Char = detail::format_string_char_t<S>,
  199. FMT_ENABLE_IF(detail::is_output_iterator<OutputIt, Char>::value&&
  200. detail::is_exotic_char<Char>::value)>
  201. inline auto vformat_to(OutputIt out, detail::locale_ref loc, const S& fmt,
  202. typename detail::vformat_args<Char>::type args)
  203. -> OutputIt {
  204. auto&& buf = detail::get_buffer<Char>(out);
  205. vformat_to(buf, detail::to_string_view(fmt), args, detail::locale_ref(loc));
  206. return detail::get_iterator(buf, out);
  207. }
  208. template <typename OutputIt, typename S, typename... T,
  209. typename Char = detail::format_string_char_t<S>,
  210. bool enable = detail::is_output_iterator<OutputIt, Char>::value &&
  211. detail::is_exotic_char<Char>::value>
  212. inline auto format_to(OutputIt out, detail::locale_ref loc, const S& fmt,
  213. T&&... args) ->
  214. typename std::enable_if<enable, OutputIt>::type {
  215. return vformat_to(out, loc, detail::to_string_view(fmt),
  216. fmt::make_format_args<buffered_context<Char>>(args...));
  217. }
  218. template <typename OutputIt, typename Char, typename... Args,
  219. FMT_ENABLE_IF(detail::is_output_iterator<OutputIt, Char>::value&&
  220. detail::is_exotic_char<Char>::value)>
  221. inline auto vformat_to_n(OutputIt out, size_t n, basic_string_view<Char> fmt,
  222. typename detail::vformat_args<Char>::type args)
  223. -> format_to_n_result<OutputIt> {
  224. using traits = detail::fixed_buffer_traits;
  225. auto buf = detail::iterator_buffer<OutputIt, Char, traits>(out, n);
  226. detail::vformat_to(buf, fmt, args);
  227. return {buf.out(), buf.count()};
  228. }
  229. template <typename OutputIt, typename S, typename... T,
  230. typename Char = detail::format_string_char_t<S>,
  231. FMT_ENABLE_IF(detail::is_output_iterator<OutputIt, Char>::value&&
  232. detail::is_exotic_char<Char>::value)>
  233. inline auto format_to_n(OutputIt out, size_t n, const S& fmt, T&&... args)
  234. -> format_to_n_result<OutputIt> {
  235. return vformat_to_n(out, n, fmt::basic_string_view<Char>(fmt),
  236. fmt::make_format_args<buffered_context<Char>>(args...));
  237. }
  238. template <typename S, typename... T,
  239. typename Char = detail::format_string_char_t<S>,
  240. FMT_ENABLE_IF(detail::is_exotic_char<Char>::value)>
  241. inline auto formatted_size(const S& fmt, T&&... args) -> size_t {
  242. auto buf = detail::counting_buffer<Char>();
  243. detail::vformat_to(buf, detail::to_string_view(fmt),
  244. fmt::make_format_args<buffered_context<Char>>(args...));
  245. return buf.count();
  246. }
  247. inline void vprint(std::FILE* f, wstring_view fmt, wformat_args args) {
  248. auto buf = wmemory_buffer();
  249. detail::vformat_to(buf, fmt, args);
  250. buf.push_back(L'\0');
  251. if (std::fputws(buf.data(), f) == -1)
  252. FMT_THROW(system_error(errno, FMT_STRING("cannot write to file")));
  253. }
  254. inline void vprint(wstring_view fmt, wformat_args args) {
  255. vprint(stdout, fmt, args);
  256. }
  257. template <typename... T>
  258. void print(std::FILE* f, wformat_string<T...> fmt, T&&... args) {
  259. return vprint(f, wstring_view(fmt), fmt::make_wformat_args(args...));
  260. }
  261. template <typename... T> void print(wformat_string<T...> fmt, T&&... args) {
  262. return vprint(wstring_view(fmt), fmt::make_wformat_args(args...));
  263. }
  264. template <typename... T>
  265. void println(std::FILE* f, wformat_string<T...> fmt, T&&... args) {
  266. return print(f, L"{}\n", fmt::format(fmt, std::forward<T>(args)...));
  267. }
  268. template <typename... T> void println(wformat_string<T...> fmt, T&&... args) {
  269. return print(L"{}\n", fmt::format(fmt, std::forward<T>(args)...));
  270. }
  271. inline auto vformat(const text_style& ts, wstring_view fmt, wformat_args args)
  272. -> std::wstring {
  273. auto buf = wmemory_buffer();
  274. detail::vformat_to(buf, ts, fmt, args);
  275. return {buf.data(), buf.size()};
  276. }
  277. template <typename... T>
  278. inline auto format(const text_style& ts, wformat_string<T...> fmt, T&&... args)
  279. -> std::wstring {
  280. return fmt::vformat(ts, fmt, fmt::make_wformat_args(args...));
  281. }
  282. template <typename... T>
  283. FMT_DEPRECATED void print(std::FILE* f, const text_style& ts,
  284. wformat_string<T...> fmt, const T&... args) {
  285. vprint(f, ts, fmt, fmt::make_wformat_args(args...));
  286. }
  287. template <typename... T>
  288. FMT_DEPRECATED void print(const text_style& ts, wformat_string<T...> fmt,
  289. const T&... args) {
  290. return print(stdout, ts, fmt, args...);
  291. }
  292. inline void vprint(std::wostream& os, wstring_view fmt, wformat_args args) {
  293. auto buffer = basic_memory_buffer<wchar_t>();
  294. detail::vformat_to(buffer, fmt, args);
  295. detail::write_buffer(os, buffer);
  296. }
  297. template <typename... T>
  298. void print(std::wostream& os, wformat_string<T...> fmt, T&&... args) {
  299. vprint(os, fmt, fmt::make_format_args<buffered_context<wchar_t>>(args...));
  300. }
  301. template <typename... T>
  302. void println(std::wostream& os, wformat_string<T...> fmt, T&&... args) {
  303. print(os, L"{}\n", fmt::format(fmt, std::forward<T>(args)...));
  304. }
  305. /// Converts `value` to `std::wstring` using the default format for type `T`.
  306. template <typename T> inline auto to_wstring(const T& value) -> std::wstring {
  307. return format(FMT_STRING(L"{}"), value);
  308. }
  309. FMT_END_EXPORT
  310. FMT_END_NAMESPACE
  311. #endif // FMT_XCHAR_H_