1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
|
// Copyright Epic Games, Inc. All Rights Reserved.
#include "zencore/logging.h"
#include <zencore/string.h>
#include <zencore/testing.h>
#include <spdlog/sinks/stdout_color_sinks.h>
namespace zen {
// We shadow the underlying spdlog default logger, in order to avoid a bunch of overhead
spdlog::logger* TheDefaultLogger;
} // namespace zen
namespace zen::logging {
spdlog::logger&
Default()
{
return *TheDefaultLogger;
}
void
SetDefault(std::shared_ptr<spdlog::logger> NewDefaultLogger)
{
spdlog::set_default_logger(NewDefaultLogger);
TheDefaultLogger = spdlog::default_logger_raw();
}
spdlog::logger&
Get(std::string_view Name)
{
std::shared_ptr<spdlog::logger> Logger = spdlog::get(std::string(Name));
if (!Logger)
{
Logger = Default().clone(std::string(Name));
spdlog::register_logger(Logger);
}
return *Logger;
}
std::once_flag ConsoleInitFlag;
std::shared_ptr<spdlog::logger> ConLogger;
spdlog::logger&
ConsoleLog()
{
std::call_once(ConsoleInitFlag, [&] {
ConLogger = spdlog::stdout_color_mt("console");
ConLogger->set_pattern("%v");
});
return *ConLogger;
}
std::shared_ptr<spdlog::logger> TheErrorLogger;
spdlog::logger*
ErrorLog()
{
return TheErrorLogger.get();
}
void
SetErrorLog(std::shared_ptr<spdlog::logger>&& NewErrorLogger)
{
TheErrorLogger = std::move(NewErrorLogger);
}
void
InitializeLogging()
{
TheDefaultLogger = spdlog::default_logger_raw();
}
void
ShutdownLogging()
{
spdlog::drop_all();
spdlog::shutdown();
}
bool
EnableVTMode()
{
#if ZEN_PLATFORM_WINDOWS
// Set output mode to handle virtual terminal sequences
HANDLE hOut = GetStdHandle(STD_OUTPUT_HANDLE);
if (hOut == INVALID_HANDLE_VALUE)
{
return false;
}
DWORD dwMode = 0;
if (!GetConsoleMode(hOut, &dwMode))
{
return false;
}
dwMode |= ENABLE_VIRTUAL_TERMINAL_PROCESSING;
if (!SetConsoleMode(hOut, dwMode))
{
return false;
}
#endif
return true;
}
} // namespace zen::logging
namespace zen {
thread_local ScopedActivityBase* t_ScopeStack = nullptr;
ScopedActivityBase*
GetThreadActivity()
{
return t_ScopeStack;
}
ScopedActivityBase::ScopedActivityBase() : m_NextScope{t_ScopeStack}
{
t_ScopeStack = this;
}
ScopedActivityBase::~ScopedActivityBase()
{
if (t_ScopeStack != this)
{
ZEN_ERROR("invalid t_ScopeStack in ~ScopedActivityBase(). Expected {:#x}, found {:#x}", (uintptr_t)this, (uintptr_t)t_ScopeStack);
return;
}
t_ScopeStack = m_NextScope;
}
std::string_view
EmitActivitiesForLogging(StringBuilderBase& OutString)
{
OutString.Reset();
for (auto Bread = GetThreadActivity(); Bread; Bread = Bread->GetNext())
{
OutString.Append("\n|>|>|> ");
Bread->Emit(OutString);
}
return OutString.ToView();
}
//////////////////////////////////////////////////////////////////////////
ScopedActivityString::~ScopedActivityString()
{
}
void
ScopedActivityString::Emit(StringBuilderBase& Target)
{
Target.Append(m_Text);
}
#if ZEN_WITH_TESTS
void
logging_forcelink()
{
}
using namespace std::literals;
TEST_CASE("simple.bread")
{
ExtendableStringBuilder<256> Crumbs;
auto EmitBreadcrumbs = [&] {
Crumbs.Reset();
for (auto Bread = GetThreadActivity(); Bread; Bread = Bread->GetNext())
{
Bread->Emit(Crumbs);
}
return Crumbs.ToView();
};
SUBCASE("single")
{
ScopedActivityString _{"hello"};
EmitBreadcrumbs();
CHECK_EQ(Crumbs.ToView(), "hello"sv);
}
SUBCASE("multi")
{
ScopedActivityString $1{"hello"};
ScopedActivityString $2{"world"};
ScopedActivityString $3{"amaze"};
CHECK_EQ(EmitBreadcrumbs(), "amazeworldhello"sv);
}
SUBCASE("multi_defer")
{
int n = 42;
ScopedActivityString $1{"hello"};
ScopedActivityString $2{"world"};
ScopedActivityString $3{"amaze"};
ScopedLazyActivity $4{[&](StringBuilderBase& Out) { Out << "plant"; }};
{
ScopedLazyActivity $5{[&](StringBuilderBase& Out) { Out << n; }};
ZEN_LOG_SCOPE("{}:{}", "abc", "def");
CHECK_EQ(EmitBreadcrumbs(), "abc:def42plantamazeworldhello"sv);
}
CHECK_EQ(EmitBreadcrumbs(), "plantamazeworldhello"sv);
}
}
#endif
} // namespace zen
|