13#include <system_error>
18#include <userver/formats/common/meta.hpp>
19#include <userver/logging/fwd.hpp>
20#include <userver/logging/level.hpp>
21#include <userver/logging/log_extra.hpp>
22#include <userver/utils/impl/source_location.hpp>
23#include <userver/utils/meta.hpp>
25USERVER_NAMESPACE_BEGIN
38 template <
typename Unsigned,
typename = std::enable_if_t<std::is_unsigned_v<Unsigned>>>
39 explicit constexpr HexBase(Unsigned value)
noexcept : value(value) {
40 static_assert(
sizeof(Unsigned) <=
sizeof(value));
44 explicit HexBase(T* pointer)
noexcept : HexBase(
reinterpret_cast<std::uintptr_t>(pointer)) {
45 static_assert(
sizeof(std::uintptr_t) <=
sizeof(value));
52struct Hex
final : impl::HexBase {
53 using impl::HexBase::HexBase;
58struct HexShort
final : impl::HexBase {
59 using impl::HexBase::HexBase;
64 std::string_view string;
77class LogHelper
final {
87 LogClass log_class = LogClass::kLog,
88 const utils::impl::SourceLocation& location =
utils::impl::SourceLocation::Current()
97 const LoggerPtr& logger,
99 LogClass log_class = LogClass::kLog,
100 const utils::impl::SourceLocation& location =
utils::impl::SourceLocation::Current()
105 LogHelper(LogHelper&&) =
delete;
106 LogHelper(
const LogHelper&) =
delete;
107 LogHelper& operator=(LogHelper&&) =
delete;
108 LogHelper& operator=(
const LogHelper&) =
delete;
111 LogHelper& AsLvalue()
noexcept {
return *
this; }
114 template <
typename... Args>
115 LogHelper& AsLvalue(fmt::format_string<Args...> fmt, Args&&... args)
noexcept {
116 VFormat(fmt::string_view(fmt), fmt::make_format_args(args...));
121 bool IsLimitReached()
const noexcept;
123 template <
typename T>
124 LogHelper& operator<<(
const T& value) {
125 if constexpr (std::is_constructible_v<std::string_view, T>) {
127 *
this << std::string_view{value};
128 }
else if constexpr (std::is_signed_v<T>) {
129 using LongLong =
long long;
130 *
this << LongLong{value};
131 }
else if constexpr (std::is_unsigned_v<T>) {
132 using UnsignedLongLong =
unsigned long long;
133 *
this << UnsignedLongLong{value};
134 }
else if constexpr (std::is_base_of_v<std::exception, T>) {
135 *
this <<
static_cast<
const std::exception&>(value);
136 }
else if constexpr (meta::kIsOstreamWritable<T>) {
140 }
else if constexpr (meta::kIsRange<T> && !
formats::
common::kIsFormatValue<T>) {
144 VFormat(
"{}", fmt::make_format_args(value));
150 LogHelper& operator<<(
char value)
noexcept;
151 LogHelper& operator<<(std::string_view value)
noexcept;
152 LogHelper& operator<<(
float value)
noexcept;
153 LogHelper& operator<<(
double value)
noexcept;
154 LogHelper& operator<<(
long double value)
noexcept;
155 LogHelper& operator<<(
unsigned long long value)
noexcept;
156 LogHelper& operator<<(
long long value)
noexcept;
157 LogHelper& operator<<(
bool value)
noexcept;
158 LogHelper& operator<<(
const std::exception& value)
noexcept;
161 LogHelper& operator<<(
const LogExtra& extra)
noexcept;
164 LogHelper& operator<<(LogExtra&& extra)
noexcept;
166 LogHelper& operator<<(Hex hex)
noexcept;
168 LogHelper& operator<<(HexShort hex)
noexcept;
170 LogHelper& operator<<(Quoted value)
noexcept;
172 LogHelper& PutTag(std::string_view key,
const LogExtra::Value& value)
noexcept;
173 LogHelper& PutSwTag(std::string_view key, std::string_view value)
noexcept;
179 template <
typename... Args>
180 LogHelper&
Format(fmt::format_string<Args...> fmt, Args&&... args)
noexcept;
184 operator impl::Noop()
const noexcept {
return {}; }
189 impl::TagWriter GetTagWriter();
194 friend class impl::TagWriter;
196 void DoLog()
noexcept;
198 void InternalLoggingError(std::string_view message)
noexcept;
200 void PutFloatingPoint(
float value);
201 void PutFloatingPoint(
double value);
202 void PutFloatingPoint(
long double value);
203 void PutUnsigned(
unsigned long long value);
204 void PutSigned(
long long value);
205 void PutBoolean(
bool value);
206 void Put(std::string_view value);
207 void Put(
char value);
209 void PutRaw(std::string_view value_needs_no_escaping);
210 void PutException(
const std::exception& ex);
211 void PutQuoted(std::string_view value);
213 void VFormat(fmt::string_view fmt, fmt::format_args args)
noexcept;
215 template <
typename T>
216 void PutRangeElement(
const T& value);
218 template <
typename T,
typename U>
219 void PutMapElement(
const std::pair<
const T, U>& value);
221 template <
typename T>
222 void PutRange(
const T& range);
224 std::ostream& Stream();
228 std::unique_ptr<Impl> pimpl_;
231inline LogHelper& operator<<(LogHelper& lh, std::error_code ec) {
232 lh << ec.category().name() <<
':' << ec.value() <<
" (" << ec.message() <<
')';
237LogHelper& operator<<(LogHelper& lh,
const std::atomic<T>& value) {
238 return lh << value.load();
242LogHelper& operator<<(LogHelper& lh,
const T* value)
noexcept {
243 if (value ==
nullptr) {
244 lh << std::string_view{
"(null)"};
245 }
else if constexpr (std::is_same_v<T,
char>) {
246 lh << std::string_view{value};
254LogHelper& operator<<(LogHelper& lh, T* value) {
256 !std::is_function_v<T>,
257 "An attempt to log the function address is denied. If you really know what you're doing, cast it to void*."
259 return lh <<
static_cast<
const T*>(value);
263LogHelper& operator<<(LogHelper& lh,
const std::optional<T>& value) {
271template <
typename Fun,
typename = std::enable_if_t<std::is_invocable_r_v<
void, Fun, LogHelper&>>>
272LogHelper& operator<<(LogHelper& lh, Fun&& value) {
273 std::forward<Fun>(value)(lh);
277template <
class Result,
class... Args>
278LogHelper& operator<<(LogHelper& lh, Result (*)(Args...)) {
279 static_assert(!
sizeof(Result),
"Outputting functions or std::ostream formatters is forbidden");
283LogHelper& operator<<(LogHelper& lh, std::chrono::system_clock::time_point tp);
284LogHelper& operator<<(LogHelper& lh, std::chrono::seconds value);
285LogHelper& operator<<(LogHelper& lh, std::chrono::milliseconds value);
286LogHelper& operator<<(LogHelper& lh, std::chrono::microseconds value);
287LogHelper& operator<<(LogHelper& lh, std::chrono::nanoseconds value);
288LogHelper& operator<<(LogHelper& lh, std::chrono::minutes value);
289LogHelper& operator<<(LogHelper& lh, std::chrono::nanoseconds value);
290LogHelper& operator<<(LogHelper& lh, std::chrono::hours value);
293void LogHelper::PutRangeElement(
const T& value) {
294 if constexpr (std::is_constructible_v<std::string_view, T>) {
295 *
this << Quoted{value};
301template <
typename T,
typename U>
302void LogHelper::PutMapElement(
const std::pair<
const T, U>& value) {
303 PutRangeElement(value.first);
305 PutRangeElement(value.second);
309void LogHelper::PutRange(
const T& range) {
310 static_assert(meta::kIsRange<T>);
315 !std::is_same_v<meta::RangeValueType<T>,
char>,
316 "You should either manually convert type to 'std::string_view' or provide 'operator<<' specialization for your "
317 "type: 'logging::LogHelper& operator<<(logging::LogHelper& lh, const T& value)' or make your type convertible "
318 "to 'std::string_view'"
321 constexpr std::string_view kSeparator =
", ";
324 bool is_first =
true;
325 auto curr = begin(range);
326 const auto end_iter = end(range);
328 while (curr != end_iter) {
329 if (IsLimitReached()) {
338 if constexpr (meta::kIsMap<T>) {
339 PutMapElement(*curr);
341 PutRangeElement(*curr);
346 const auto extra_elements = std::distance(curr, end_iter);
348 if (extra_elements != 0) {
352 *
this <<
"..." << extra_elements <<
" more";
358template <
typename... Args>
359LogHelper& LogHelper::
Format(fmt::format_string<Args...> fmt, Args&&... args)
noexcept {
360 VFormat(fmt::string_view(fmt), fmt::make_format_args(args...));