2018-01-06 17:09:50 +00:00
|
|
|
// Formatting library for C++ - std::ostream support
|
|
|
|
//
|
2018-11-14 17:39:37 +00:00
|
|
|
// Copyright (c) 2012 - present, Victor Zverovich
|
2018-01-06 17:09:50 +00:00
|
|
|
// All rights reserved.
|
|
|
|
//
|
|
|
|
// For the license information refer to format.h.
|
2016-05-06 14:37:20 +00:00
|
|
|
|
|
|
|
#ifndef FMT_OSTREAM_H_
|
|
|
|
#define FMT_OSTREAM_H_
|
|
|
|
|
2024-04-10 18:48:32 +00:00
|
|
|
#ifndef FMT_IMPORT_STD
|
|
|
|
# include <fstream> // std::filebuf
|
|
|
|
#endif
|
2023-03-26 15:40:12 +00:00
|
|
|
|
2023-10-25 20:13:31 +00:00
|
|
|
#ifdef _WIN32
|
|
|
|
# ifdef __GLIBCXX__
|
|
|
|
# include <ext/stdio_filebuf.h>
|
|
|
|
# include <ext/stdio_sync_filebuf.h>
|
|
|
|
# endif
|
|
|
|
# include <io.h>
|
2022-07-23 15:03:31 +00:00
|
|
|
#endif
|
2020-04-12 14:38:54 +00:00
|
|
|
|
2024-01-13 18:29:34 +00:00
|
|
|
#include "chrono.h" // formatbuf
|
2016-05-06 14:37:20 +00:00
|
|
|
|
2018-05-12 15:33:51 +00:00
|
|
|
FMT_BEGIN_NAMESPACE
|
2020-05-10 14:25:42 +00:00
|
|
|
namespace detail {
|
2016-05-06 14:37:20 +00:00
|
|
|
|
2022-04-10 16:32:44 +00:00
|
|
|
// Generate a unique explicit instantion in every translation unit using a tag
|
|
|
|
// type in an anonymous namespace.
|
|
|
|
namespace {
|
2022-07-30 13:49:21 +00:00
|
|
|
struct file_access_tag {};
|
2022-04-10 16:32:44 +00:00
|
|
|
} // namespace
|
2023-02-18 18:23:42 +00:00
|
|
|
template <typename Tag, typename BufType, FILE* BufType::*FileMemberPtr>
|
2022-07-30 13:49:21 +00:00
|
|
|
class file_access {
|
|
|
|
friend auto get_file(BufType& obj) -> FILE* { return obj.*FileMemberPtr; }
|
2022-04-10 16:32:44 +00:00
|
|
|
};
|
2022-07-30 13:49:21 +00:00
|
|
|
|
|
|
|
#if FMT_MSC_VERSION
|
|
|
|
template class file_access<file_access_tag, std::filebuf,
|
|
|
|
&std::filebuf::_Myfile>;
|
|
|
|
auto get_file(std::filebuf&) -> FILE*;
|
|
|
|
#endif
|
2022-04-10 16:32:44 +00:00
|
|
|
|
2023-12-20 01:51:41 +00:00
|
|
|
inline auto write_ostream_unicode(std::ostream& os, fmt::string_view data)
|
|
|
|
-> bool {
|
2023-10-25 20:13:31 +00:00
|
|
|
FILE* f = nullptr;
|
2024-05-19 18:21:55 +00:00
|
|
|
#if FMT_MSC_VERSION && FMT_USE_RTTI
|
2022-07-23 15:03:31 +00:00
|
|
|
if (auto* buf = dynamic_cast<std::filebuf*>(os.rdbuf()))
|
2023-10-25 20:13:31 +00:00
|
|
|
f = get_file(*buf);
|
|
|
|
else
|
|
|
|
return false;
|
2024-05-19 18:21:55 +00:00
|
|
|
#elif defined(_WIN32) && defined(__GLIBCXX__) && FMT_USE_RTTI
|
2022-07-23 15:03:31 +00:00
|
|
|
auto* rdbuf = os.rdbuf();
|
2022-09-11 09:22:26 +00:00
|
|
|
if (auto* sfbuf = dynamic_cast<__gnu_cxx::stdio_sync_filebuf<char>*>(rdbuf))
|
2023-10-25 20:13:31 +00:00
|
|
|
f = sfbuf->file();
|
2022-07-23 15:03:31 +00:00
|
|
|
else if (auto* fbuf = dynamic_cast<__gnu_cxx::stdio_filebuf<char>*>(rdbuf))
|
2023-10-25 20:13:31 +00:00
|
|
|
f = fbuf->file();
|
2022-07-23 15:03:31 +00:00
|
|
|
else
|
|
|
|
return false;
|
|
|
|
#else
|
2023-10-25 20:13:31 +00:00
|
|
|
ignore_unused(os, data, f);
|
|
|
|
#endif
|
|
|
|
#ifdef _WIN32
|
|
|
|
if (f) {
|
|
|
|
int fd = _fileno(f);
|
|
|
|
if (_isatty(fd)) {
|
|
|
|
os.flush();
|
|
|
|
return write_console(fd, data);
|
|
|
|
}
|
|
|
|
}
|
2022-07-23 15:03:31 +00:00
|
|
|
#endif
|
|
|
|
return false;
|
2022-04-10 16:32:44 +00:00
|
|
|
}
|
2023-12-20 01:51:41 +00:00
|
|
|
inline auto write_ostream_unicode(std::wostream&,
|
|
|
|
fmt::basic_string_view<wchar_t>) -> bool {
|
2022-04-10 16:32:44 +00:00
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2017-02-14 21:29:47 +00:00
|
|
|
// Write the content of buf to os.
|
2021-09-03 19:47:33 +00:00
|
|
|
// It is a separate function rather than a part of vprint to simplify testing.
|
2017-12-17 17:33:12 +00:00
|
|
|
template <typename Char>
|
2020-06-08 14:23:18 +00:00
|
|
|
void write_buffer(std::basic_ostream<Char>& os, buffer<Char>& buf) {
|
2019-05-03 14:03:14 +00:00
|
|
|
const Char* buf_data = buf.data();
|
2019-07-07 14:21:20 +00:00
|
|
|
using unsigned_streamsize = std::make_unsigned<std::streamsize>::type;
|
|
|
|
unsigned_streamsize size = buf.size();
|
2019-09-08 16:04:09 +00:00
|
|
|
unsigned_streamsize max_size = to_unsigned(max_value<std::streamsize>());
|
2017-12-17 17:33:12 +00:00
|
|
|
do {
|
2019-07-07 14:21:20 +00:00
|
|
|
unsigned_streamsize n = size <= max_size ? size : max_size;
|
2019-05-03 14:03:14 +00:00
|
|
|
os.write(buf_data, static_cast<std::streamsize>(n));
|
|
|
|
buf_data += n;
|
2017-12-17 17:33:12 +00:00
|
|
|
size -= n;
|
|
|
|
} while (size != 0);
|
|
|
|
}
|
2016-10-21 13:46:21 +00:00
|
|
|
|
|
|
|
template <typename Char, typename T>
|
2023-11-24 17:23:58 +00:00
|
|
|
void format_value(buffer<Char>& buf, const T& value) {
|
2021-12-04 19:02:31 +00:00
|
|
|
auto&& format_buf = formatbuf<std::basic_streambuf<Char>>(buf);
|
2021-09-03 19:47:33 +00:00
|
|
|
auto&& output = std::basic_ostream<Char>(&format_buf);
|
2020-04-12 14:38:54 +00:00
|
|
|
#if !defined(FMT_STATIC_THOUSANDS_SEPARATOR)
|
2023-12-13 14:56:42 +00:00
|
|
|
output.imbue(std::locale::classic()); // The default is always unlocalized.
|
2020-04-12 14:38:54 +00:00
|
|
|
#endif
|
2016-10-21 13:46:21 +00:00
|
|
|
output << value;
|
2020-05-07 00:15:46 +00:00
|
|
|
output.exceptions(std::ios_base::failbit | std::ios_base::badbit);
|
2016-10-21 13:46:21 +00:00
|
|
|
}
|
2022-06-24 16:26:24 +00:00
|
|
|
|
2023-10-14 13:52:43 +00:00
|
|
|
template <typename T> struct streamed_view {
|
|
|
|
const T& value;
|
|
|
|
};
|
2022-06-24 16:26:24 +00:00
|
|
|
|
2022-02-05 02:33:55 +00:00
|
|
|
} // namespace detail
|
2018-08-22 14:40:06 +00:00
|
|
|
|
2017-08-13 20:09:02 +00:00
|
|
|
// Formats an object of type T that has an overloaded ostream operator<<.
|
2022-02-05 02:33:55 +00:00
|
|
|
template <typename Char>
|
|
|
|
struct basic_ostream_formatter : formatter<basic_string_view<Char>, Char> {
|
2022-07-29 20:55:16 +00:00
|
|
|
void set_debug_format() = delete;
|
|
|
|
|
2024-01-08 13:56:07 +00:00
|
|
|
template <typename T, typename Context>
|
|
|
|
auto format(const T& value, Context& ctx) const -> decltype(ctx.out()) {
|
2021-09-03 19:47:33 +00:00
|
|
|
auto buffer = basic_memory_buffer<Char>();
|
2023-11-24 17:23:58 +00:00
|
|
|
detail::format_value(buffer, value);
|
2021-09-03 19:47:33 +00:00
|
|
|
return formatter<basic_string_view<Char>, Char>::format(
|
|
|
|
{buffer.data(), buffer.size()}, ctx);
|
2017-08-13 20:09:02 +00:00
|
|
|
}
|
2022-02-05 02:33:55 +00:00
|
|
|
};
|
2021-09-03 16:33:24 +00:00
|
|
|
|
2022-02-05 02:33:55 +00:00
|
|
|
using ostream_formatter = basic_ostream_formatter<char>;
|
|
|
|
|
2022-07-03 13:42:08 +00:00
|
|
|
template <typename T, typename Char>
|
|
|
|
struct formatter<detail::streamed_view<T>, Char>
|
|
|
|
: basic_ostream_formatter<Char> {
|
2024-01-08 13:56:07 +00:00
|
|
|
template <typename Context>
|
|
|
|
auto format(detail::streamed_view<T> view, Context& ctx) const
|
|
|
|
-> decltype(ctx.out()) {
|
2022-07-03 13:42:08 +00:00
|
|
|
return basic_ostream_formatter<Char>::format(view.value, ctx);
|
2022-06-24 16:26:24 +00:00
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2022-06-25 15:33:57 +00:00
|
|
|
/**
|
2024-06-02 21:20:41 +00:00
|
|
|
* Returns a view that formats `value` via an ostream `operator<<`.
|
|
|
|
*
|
|
|
|
* **Example**:
|
|
|
|
*
|
|
|
|
* fmt::print("Current thread id: {}\n",
|
|
|
|
* fmt::streamed(std::this_thread::get_id()));
|
2022-06-25 15:33:57 +00:00
|
|
|
*/
|
2022-06-24 16:26:24 +00:00
|
|
|
template <typename T>
|
2023-09-19 15:42:34 +00:00
|
|
|
constexpr auto streamed(const T& value) -> detail::streamed_view<T> {
|
2022-06-24 16:26:24 +00:00
|
|
|
return {value};
|
|
|
|
}
|
|
|
|
|
2022-02-05 02:33:55 +00:00
|
|
|
namespace detail {
|
|
|
|
|
2022-08-05 20:26:39 +00:00
|
|
|
inline void vprint_directly(std::ostream& os, string_view format_str,
|
|
|
|
format_args args) {
|
|
|
|
auto buffer = memory_buffer();
|
|
|
|
detail::vformat_to(buffer, format_str, args);
|
|
|
|
detail::write_buffer(os, buffer);
|
|
|
|
}
|
|
|
|
|
2020-05-10 14:25:42 +00:00
|
|
|
} // namespace detail
|
2019-01-21 15:11:49 +00:00
|
|
|
|
2023-05-17 14:37:53 +00:00
|
|
|
FMT_EXPORT template <typename Char>
|
2022-03-18 04:55:32 +00:00
|
|
|
void vprint(std::basic_ostream<Char>& os,
|
|
|
|
basic_string_view<type_identity_t<Char>> format_str,
|
2024-01-09 03:20:10 +00:00
|
|
|
typename detail::vformat_args<Char>::type args) {
|
2021-09-03 16:33:24 +00:00
|
|
|
auto buffer = basic_memory_buffer<Char>();
|
2020-05-10 14:25:42 +00:00
|
|
|
detail::vformat_to(buffer, format_str, args);
|
2022-08-05 20:26:39 +00:00
|
|
|
if (detail::write_ostream_unicode(os, {buffer.data(), buffer.size()})) return;
|
2020-06-08 14:23:18 +00:00
|
|
|
detail::write_buffer(os, buffer);
|
2017-12-17 17:33:12 +00:00
|
|
|
}
|
2019-06-01 19:32:24 +00:00
|
|
|
|
2016-05-06 14:37:20 +00:00
|
|
|
/**
|
2024-06-02 21:20:41 +00:00
|
|
|
* Prints formatted data to the stream `os`.
|
|
|
|
*
|
|
|
|
* **Example**:
|
|
|
|
*
|
|
|
|
* fmt::print(cerr, "Don't {}!", "panic");
|
2016-05-06 14:37:20 +00:00
|
|
|
*/
|
2023-05-17 14:37:53 +00:00
|
|
|
FMT_EXPORT template <typename... T>
|
2022-03-22 23:05:30 +00:00
|
|
|
void print(std::ostream& os, format_string<T...> fmt, T&&... args) {
|
2022-08-05 20:26:39 +00:00
|
|
|
const auto& vargs = fmt::make_format_args(args...);
|
2024-05-12 02:34:32 +00:00
|
|
|
if (detail::use_utf8())
|
2022-08-05 20:26:39 +00:00
|
|
|
vprint(os, fmt, vargs);
|
|
|
|
else
|
|
|
|
detail::vprint_directly(os, fmt, vargs);
|
2018-04-26 18:32:14 +00:00
|
|
|
}
|
2022-03-18 04:55:32 +00:00
|
|
|
|
2023-05-17 14:37:53 +00:00
|
|
|
FMT_EXPORT
|
2022-03-18 04:55:32 +00:00
|
|
|
template <typename... Args>
|
2022-03-18 17:46:50 +00:00
|
|
|
void print(std::wostream& os,
|
|
|
|
basic_format_string<wchar_t, type_identity_t<Args>...> fmt,
|
|
|
|
Args&&... args) {
|
2024-01-10 21:09:55 +00:00
|
|
|
vprint(os, fmt, fmt::make_format_args<buffered_context<wchar_t>>(args...));
|
2022-03-18 04:55:32 +00:00
|
|
|
}
|
|
|
|
|
2023-05-17 14:37:53 +00:00
|
|
|
FMT_EXPORT template <typename... T>
|
2023-01-24 20:30:00 +00:00
|
|
|
void println(std::ostream& os, format_string<T...> fmt, T&&... args) {
|
2023-04-11 13:27:28 +00:00
|
|
|
fmt::print(os, "{}\n", fmt::format(fmt, std::forward<T>(args)...));
|
2023-01-24 20:30:00 +00:00
|
|
|
}
|
|
|
|
|
2023-05-17 14:37:53 +00:00
|
|
|
FMT_EXPORT
|
2023-01-24 20:30:00 +00:00
|
|
|
template <typename... Args>
|
|
|
|
void println(std::wostream& os,
|
|
|
|
basic_format_string<wchar_t, type_identity_t<Args>...> fmt,
|
|
|
|
Args&&... args) {
|
|
|
|
print(os, L"{}\n", fmt::format(fmt, std::forward<Args>(args)...));
|
|
|
|
}
|
|
|
|
|
2018-05-12 15:33:51 +00:00
|
|
|
FMT_END_NAMESPACE
|
2016-05-06 14:37:20 +00:00
|
|
|
|
|
|
|
#endif // FMT_OSTREAM_H_
|