R5Reloaded/r5sdk
1
0
Fork 0
mirror of https://github.com/Mauler125/r5sdk.git synced 2025-02-09 19:15:03 +01:00
Code Issues Packages Projects Releases Wiki Activity

Start of logger refactor

Browse Source 
Start of refactoring entire logging system. This refactor should remove all duplicate code across all loggers. The logic behind DevMsg, Warning and Error has now been successfully refactored into a single helper function.
This commit is contained in:
Kawe Mazidjatari 2023-03-25 21:27:49 +01:00
parent d9a6ab5cf6
commit 0f76c864fd
7 changed files with 182 additions and 291 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
r5dev/core/logdef.cpp
View File

@ -19,7 +19,7 @@ void SpdLog_Init(void)
* IMGUI LOGGER SETUP *
************************/
{
auto iconsole = std::make_shared<spdlog::logger>("game_console", g_spd_sys_p_ostream_sink);
auto iconsole = std::make_shared<spdlog::logger>("game_console", g_LogSink);
spdlog::register_logger(iconsole); // in-game console logger.
iconsole->set_pattern("[0.000] %v");
iconsole->set_level(spdlog::level::trace);

4
r5dev/core/logdef.h
View File

@ -10,8 +10,8 @@ inline string g_svLogSessionDirectory;
//-------------------------------------------------------------------------
// IMGUI CONSOLE SINK |
inline std::ostringstream g_spd_sys_w_oss;
inline auto g_spd_sys_p_ostream_sink = std::make_shared<spdlog::sinks::ostream_sink_st>(g_spd_sys_w_oss);
inline std::ostringstream g_LogStream;
inline auto g_LogSink = std::make_shared<spdlog::sinks::ostream_sink_st>(g_LogStream);
void SpdLog_Init(void);
void SpdLog_PostInit(void);

6
r5dev/filesystem/basefilesystem.cpp
View File

@ -43,10 +43,10 @@ void CBaseFileSystem::Warning(CBaseFileSystem* pFileSystem, FileWarningLevel_t l
wconsole->debug(szBuf);
#ifndef DEDICATED
iconsole->debug(szBuf);
g_pConsole->AddLog(ConLog_t(g_spd_sys_w_oss.str(), ImVec4(1.00f, 1.00f, 0.00f, 1.00f)));
g_pConsole->AddLog(ConLog_t(g_LogStream.str(), ImVec4(1.00f, 1.00f, 0.00f, 1.00f)));
g_spd_sys_w_oss.str("");
g_spd_sys_w_oss.clear();
g_LogStream.str("");
g_LogStream.clear();
#endif // !DEDICATED
}
}

16
r5dev/squirrel/sqvm.cpp
View File

@ -196,14 +196,14 @@ SQRESULT SQVM_PrintFunc(HSQUIRRELVM v, SQChar* fmt, ...)
}
}
g_pConsole->AddLog(ConLog_t(g_spd_sys_w_oss.str(), color));
g_pOverlay->AddLog(static_cast<EGlobalContext_t>(nResponseId), g_spd_sys_w_oss.str());
g_pConsole->AddLog(ConLog_t(g_LogStream.str(), color));
g_pOverlay->AddLog(static_cast<EGlobalContext_t>(nResponseId), g_LogStream.str());
}
#endif // !DEDICATED
}
g_spd_sys_w_oss.str("");
g_spd_sys_w_oss.clear();
g_LogStream.str("");
g_LogStream.clear();
g_LogMutex.unlock();
return SQ_OK;
@ -289,13 +289,13 @@ SQRESULT SQVM_WarningFunc(HSQUIRRELVM v, SQInteger a2, SQInteger a3, SQInteger*
#ifndef DEDICATED
iconsole->debug(vmStr); // Emit to in-game console.
g_pConsole->AddLog(ConLog_t(g_spd_sys_w_oss.str(), ImVec4(1.00f, 1.00f, 0.00f, 0.80f)));
g_pOverlay->AddLog(EGlobalContext_t::WARNING_C, g_spd_sys_w_oss.str());
g_pConsole->AddLog(ConLog_t(g_LogStream.str(), ImVec4(1.00f, 1.00f, 0.00f, 0.80f)));
g_pOverlay->AddLog(EGlobalContext_t::WARNING_C, g_LogStream.str());
#endif // !DEDICATED
}
g_spd_sys_w_oss.str("");
g_spd_sys_w_oss.clear();
g_LogStream.str("");
g_LogStream.clear();
g_LogMutex.unlock();
return result;

423
r5dev/tier0/dbg.cpp
View File

@ -172,11 +172,11 @@ void NetMsg(EGlobalContext_t context, const char* fmt, ...)
ntlogger->debug(svOut);
iconsole->debug(svOut);
g_pConsole->AddLog(ConLog_t(g_spd_sys_w_oss.str(), color));
g_pOverlay->AddLog(static_cast<EGlobalContext_t>(context), g_spd_sys_w_oss.str());
g_pConsole->AddLog(ConLog_t(g_LogStream.str(), color));
g_pOverlay->AddLog(static_cast<EGlobalContext_t>(context), g_LogStream.str());
g_spd_sys_w_oss.str("");
g_spd_sys_w_oss.clear();
g_LogStream.str("");
g_LogStream.clear();
g_LogMutex.unlock();
@ -279,11 +279,11 @@ void NetMsg(EGlobalContext_t context, const char* fmt, ...)
ntlogger->debug(svOut);
iconsole->info(svOut);
g_pConsole->AddLog(ConLog_t(g_spd_sys_w_oss.str(), color));
g_pOverlay->AddLog(context, g_spd_sys_w_oss.str());
g_pConsole->AddLog(ConLog_t(g_LogStream.str(), color));
g_pOverlay->AddLog(context, g_LogStream.str());
g_spd_sys_w_oss.str("");
g_spd_sys_w_oss.clear();
g_LogStream.str("");
g_LogStream.clear();
g_LogMutex.unlock();
break;
}
@ -291,6 +291,138 @@ void NetMsg(EGlobalContext_t context, const char* fmt, ...)
#endif // !DEDICATED
}
#ifndef DEDICATED
ImVec4 GetColorForContext(eDLL_T context)
{
switch (context)
{
case eDLL_T::SERVER:
return ImVec4(0.23f, 0.47f, 0.85f, 1.00f);
case eDLL_T::CLIENT:
return ImVec4(0.46f, 0.46f, 0.46f, 1.00f);
case eDLL_T::UI:
return ImVec4(0.59f, 0.35f, 0.46f, 1.00f);
case eDLL_T::ENGINE:
return ImVec4(0.70f, 0.70f, 0.70f, 1.00f);
case eDLL_T::FS:
return ImVec4(0.32f, 0.64f, 0.72f, 1.00f);
case eDLL_T::RTECH:
return ImVec4(0.36f, 0.70f, 0.35f, 1.00f);
case eDLL_T::MS:
return ImVec4(0.75f, 0.30f, 0.68f, 1.00f);
case eDLL_T::AUDIO:
return ImVec4(0.93f, 0.42f, 0.12f, 1.00f);
case eDLL_T::VIDEO:
return ImVec4(0.73f, 0.00f, 0.92f, 1.00f);
case eDLL_T::NETCON:
return ImVec4(0.81f, 0.81f, 0.81f, 1.00f);
case eDLL_T::COMMON:
return ImVec4(1.00f, 0.80f, 0.60f, 1.00f);
default:
return ImVec4(0.81f, 0.81f, 0.81f, 1.00f);
}
}
#endif // !DEDICATED
string MsgInternal(LogType_t type, eDLL_T context, const char* fmt, va_list args, const UINT code = NULL)
{
std::lock_guard<std::mutex> lock(g_LogMutex);
static std::shared_ptr<spdlog::logger> iconsole = spdlog::get("game_console");
static std::shared_ptr<spdlog::logger> wconsole = spdlog::get("win_console");
static std::shared_ptr<spdlog::logger> ntlogger; // <-- Obtained by logger context.
const char* pszUpTime = Plat_GetProcessUpTime();
string result = pszUpTime;
const char* pszContext = sANSI_DLL_T[static_cast<int>(context)];
if (!g_bSpdLog_UseAnsiClr)
{
// Shift # chars to skip ansi row.
pszContext += sizeof(s_DefaultAnsiColor)-1;
}
result.append(pszContext);
#ifndef DEDICATED
ImVec4 color;
EGlobalContext_t tLog;
#endif // !DEDICATED
switch (type)
{
case LogType_t::LOG_INFO:
#ifndef DEDICATED
color = GetColorForContext(context);
tLog = static_cast<EGlobalContext_t>(context);
#endif // !DEDICATED
ntlogger = spdlog::get("sdk_info");
break;
case LogType_t::LOG_WARNING:
#ifndef DEDICATED
color = ImVec4(1.00f, 1.00f, 0.00f, 0.80f);
tLog = EGlobalContext_t::WARNING_C;
#endif // !DEDICATED
ntlogger = spdlog::get("sdk_warn");
if (g_bSpdLog_UseAnsiClr)
{
result.append(g_svYellowF);
}
break;
case LogType_t::LOG_ERROR:
#ifndef DEDICATED
color = ImVec4(1.00f, 0.00f, 0.00f, 1.00f);
tLog = EGlobalContext_t::ERROR_C;
#endif // !DEDICATED
ntlogger = spdlog::get("sdk_error");
if (g_bSpdLog_UseAnsiClr)
{
result.append(g_svRedF);
}
break;
}
va_list argsCopy;
va_copy(argsCopy, args);
result.append(FormatV(fmt, argsCopy));
va_end(argsCopy);
if (result.back() != '\n')
{
result.append("\n");
}
#ifndef CLIENT_DLL
RCONServer()->Send(result, "", sv_rcon::response_t::SERVERDATA_RESPONSE_CONSOLE_LOG, static_cast<int>(context));
#endif // !CLIENT_DLL
wconsole->debug(result);
result = std::regex_replace(result, rANSI_EXP, "");
ntlogger->debug(result);
#ifndef DEDICATED
iconsole->debug(result);
if (g_bSpdLog_PostInit)
{
g_pConsole->AddLog(ConLog_t(g_LogStream.str(), color));
g_pOverlay->AddLog(tLog, g_LogStream.str());
}
g_LogStream.str("");
g_LogStream.clear();
#endif // !DEDICATED
if (code) // Terminate the process if an exit code was passed.
{
if (MessageBoxA(NULL, Format("%s- %s", pszUpTime, result.c_str()).c_str(), "SDK Error", MB_ICONERROR | MB_OK))
{
TerminateProcess(GetCurrentProcess(), code);
}
}
return result;
}
//-----------------------------------------------------------------------------
// Purpose: Show logs to all console interfaces
// Input : context -
@ -298,198 +430,23 @@ void NetMsg(EGlobalContext_t context, const char* fmt, ...)
//-----------------------------------------------------------------------------
void DevMsg(eDLL_T context, const char* fmt, ...)
{
static char szBuf[4096] = {};
static std::string svOut;
static std::string svAnsiOut;
static std::shared_ptr<spdlog::logger> iconsole = spdlog::get("game_console");
static std::shared_ptr<spdlog::logger> wconsole = spdlog::get("win_console");
static std::shared_ptr<spdlog::logger> sqlogger = spdlog::get("sdk_info");
g_LogMutex.lock();
const char* pszUpTime = Plat_GetProcessUpTime();
{/////////////////////////////
va_list args{};
va_start(args, fmt);
vsnprintf(szBuf, sizeof(szBuf), fmt, args);
szBuf[sizeof(szBuf) - 1] = '\0';
va_end(args);
}/////////////////////////////
svOut = g_bSpdLog_PostInit ? pszUpTime : "";
svOut.append(sDLL_T[static_cast<int>(context)]);
svOut.append(szBuf);
svOut = std::regex_replace(svOut, rANSI_EXP, "");
if (svOut.back() != '\n')
{
svOut.append("\n");
}
if (!g_bSpdLog_UseAnsiClr)
{
wconsole->debug(svOut);
#ifndef CLIENT_DLL
RCONServer()->Send(svOut, "", sv_rcon::response_t::SERVERDATA_RESPONSE_CONSOLE_LOG, static_cast<int>(context));
#endif // !CLIENT_DLL
}
else
{
svAnsiOut = g_bSpdLog_PostInit ? pszUpTime : "";
svAnsiOut.append(sANSI_DLL_T[static_cast<int>(context)]);
svAnsiOut.append(szBuf);
if (svAnsiOut.back() != '\n')
{
svAnsiOut.append("\n");
}
wconsole->debug(svAnsiOut);
#ifndef CLIENT_DLL
RCONServer()->Send(svAnsiOut, "", sv_rcon::response_t::SERVERDATA_RESPONSE_CONSOLE_LOG, static_cast<int>(context));
#endif // !CLIENT_DLL
}
sqlogger->debug(svOut);
#ifndef DEDICATED
iconsole->info(svOut);
EGlobalContext_t tLog = static_cast<EGlobalContext_t>(context);
ImVec4 color;
switch (context)
{
case eDLL_T::SERVER:
color = ImVec4(0.23f, 0.47f, 0.85f, 1.00f);
break;
case eDLL_T::CLIENT:
color = ImVec4(0.46f, 0.46f, 0.46f, 1.00f);
break;
case eDLL_T::UI:
color = ImVec4(0.59f, 0.35f, 0.46f, 1.00f);
break;
case eDLL_T::ENGINE:
color = ImVec4(0.70f, 0.70f, 0.70f, 1.00f);
break;
case eDLL_T::FS:
color = ImVec4(0.32f, 0.64f, 0.72f, 1.00f);
break;
case eDLL_T::RTECH:
color = ImVec4(0.36f, 0.70f, 0.35f, 1.00f);
break;
case eDLL_T::MS:
color = ImVec4(0.75f, 0.30f, 0.68f, 1.00f);
break;
case eDLL_T::AUDIO:
color = ImVec4(0.93f, 0.42f, 0.12f, 1.00f);
break;
case eDLL_T::VIDEO:
color = ImVec4(0.73f, 0.00f, 0.92f, 1.00f);
break;
case eDLL_T::NETCON:
color = ImVec4(0.81f, 0.81f, 0.81f, 1.00f);
break;
case eDLL_T::COMMON:
color = ImVec4(1.00f, 0.80f, 0.60f, 1.00f);
break;
default:
color = ImVec4(0.81f, 0.81f, 0.81f, 1.00f);
break;
}
if (g_bSpdLog_PostInit)
{
g_pConsole->AddLog(ConLog_t(g_spd_sys_w_oss.str(), color));
g_pOverlay->AddLog(tLog, g_spd_sys_w_oss.str());
}
g_spd_sys_w_oss.str("");
g_spd_sys_w_oss.clear();
#endif // !DEDICATED
g_LogMutex.unlock();
va_list args;
va_start(args, fmt);
MsgInternal(LogType_t::LOG_INFO, context, fmt, args);
va_end(args);
}
//-----------------------------------------------------------------------------
// Purpose: Print engine and SDK errors
// Purpose: Print engine and SDK warnings
// Input : context -
// *fmt - ... -
//-----------------------------------------------------------------------------
void Warning(eDLL_T context, const char* fmt, ...)
{
static char szBuf[4096] = {};
static std::string svOut;
static std::string svAnsiOut;
static std::shared_ptr<spdlog::logger> iconsole = spdlog::get("game_console");
static std::shared_ptr<spdlog::logger> wconsole = spdlog::get("win_console");
static std::shared_ptr<spdlog::logger> sqlogger = spdlog::get("sdk_warn");
g_LogMutex.lock();
const char* pszUpTime = Plat_GetProcessUpTime();
{/////////////////////////////
va_list args{};
va_start(args, fmt);
vsnprintf(szBuf, sizeof(szBuf), fmt, args);
szBuf[sizeof(szBuf) - 1] = '\0';
va_end(args);
}/////////////////////////////
svOut = g_bSpdLog_PostInit ? pszUpTime : "";
svOut.append(sDLL_T[static_cast<int>(context)]);
svOut.append(szBuf);
svOut = std::regex_replace(svOut, rANSI_EXP, "");
if (svOut.back() != '\n')
{
svOut.append("\n");
}
if (!g_bSpdLog_UseAnsiClr)
{
wconsole->debug(svOut);
#ifndef CLIENT_DLL
RCONServer()->Send(svOut, "", sv_rcon::response_t::SERVERDATA_RESPONSE_CONSOLE_LOG, static_cast<int>(context));
#endif // !CLIENT_DLL
}
else
{
svAnsiOut = g_bSpdLog_PostInit ? pszUpTime : "";
svAnsiOut.append(sANSI_DLL_T[static_cast<int>(context)]);
svAnsiOut.append(g_svYellowF);
svAnsiOut.append(szBuf);
if (svAnsiOut.back() != '\n')
{
svAnsiOut.append("\n");
}
wconsole->debug(svAnsiOut);
#ifndef CLIENT_DLL
RCONServer()->Send(svAnsiOut, "", sv_rcon::response_t::SERVERDATA_RESPONSE_CONSOLE_LOG, static_cast<int>(context));
#endif // !CLIENT_DLL
}
sqlogger->debug(svOut);
#ifndef DEDICATED
iconsole->info(svOut);
if (g_bSpdLog_PostInit)
{
g_pConsole->AddLog(ConLog_t(g_spd_sys_w_oss.str(), ImVec4(1.00f, 1.00f, 0.00f, 0.80f)));
g_pOverlay->AddLog(EGlobalContext_t::WARNING_C, g_spd_sys_w_oss.str());
}
g_spd_sys_w_oss.str("");
g_spd_sys_w_oss.clear();
#endif // !DEDICATED
g_LogMutex.unlock();
va_list args;
va_start(args, fmt);
MsgInternal(LogType_t::LOG_WARNING, context, fmt, args);
va_end(args);
}
//-----------------------------------------------------------------------------
@ -500,82 +457,8 @@ void Warning(eDLL_T context, const char* fmt, ...)
//-----------------------------------------------------------------------------
void Error(eDLL_T context, const UINT code, const char* fmt, ...)
{
static char szBuf[4096] = {};
static std::string svOut;
static std::string svAnsiOut;
static std::shared_ptr<spdlog::logger> iconsole = spdlog::get("game_console");
static std::shared_ptr<spdlog::logger> wconsole = spdlog::get("win_console");
static std::shared_ptr<spdlog::logger> sqlogger = spdlog::get("sdk_error");
g_LogMutex.lock();
const char* pszUpTime = Plat_GetProcessUpTime();
{/////////////////////////////
va_list args{};
va_start(args, fmt);
vsnprintf(szBuf, sizeof(szBuf), fmt, args);
szBuf[sizeof(szBuf) - 1] = '\0';
va_end(args);
}/////////////////////////////
svOut = g_bSpdLog_PostInit ? pszUpTime : "";
svOut.append(sDLL_T[static_cast<int>(context)]);
svOut.append(szBuf);
svOut = std::regex_replace(svOut, rANSI_EXP, "");
if (svOut.back() != '\n')
{
svOut.append("\n");
}
if (!g_bSpdLog_UseAnsiClr)
{
wconsole->debug(svOut);
#ifndef CLIENT_DLL
RCONServer()->Send(svOut, "", sv_rcon::response_t::SERVERDATA_RESPONSE_CONSOLE_LOG, static_cast<int>(context));
#endif // !CLIENT_DLL
}
else
{
svAnsiOut = g_bSpdLog_PostInit ? pszUpTime : "";
svAnsiOut.append(sANSI_DLL_T[static_cast<int>(context)]);
svAnsiOut.append(g_svRedF);
svAnsiOut.append(szBuf);
if (svAnsiOut.back() != '\n')
{
svAnsiOut.append("\n");
}
wconsole->debug(svAnsiOut);
#ifndef CLIENT_DLL
RCONServer()->Send(svAnsiOut, "", sv_rcon::response_t::SERVERDATA_RESPONSE_CONSOLE_LOG, static_cast<int>(context));
#endif // !CLIENT_DLL
}
sqlogger->debug(svOut);
#ifndef DEDICATED
iconsole->info(svOut);
if (g_bSpdLog_PostInit)
{
g_pConsole->AddLog(ConLog_t(g_spd_sys_w_oss.str(), ImVec4(1.00f, 0.00f, 0.00f, 1.00f)));
g_pOverlay->AddLog(EGlobalContext_t::ERROR_C, g_spd_sys_w_oss.str());
}
g_spd_sys_w_oss.str("");
g_spd_sys_w_oss.clear();
#endif // !DEDICATED
if (code) // Terminate the process if an exit code was passed.
{
if (MessageBoxA(NULL, fmt::format("{:s}- {:s}", pszUpTime, szBuf).c_str(), "SDK Error", MB_ICONERROR | MB_OK))
{
TerminateProcess(GetCurrentProcess(), code);
}
}
g_LogMutex.unlock();
va_list args;
va_start(args, fmt);
MsgInternal(LogType_t::LOG_ERROR, context, fmt, args, code);
va_end(args);
}

16
r5dev/tier0/dbg.h
View File

@ -50,7 +50,15 @@ enum class eDLL_T : int
COMMON = 10 // general (No specific subsystem)
};
static const string sDLL_T[11] =
enum class LogType_t
{
LOG_INFO = 0,
LOG_NET,
LOG_WARNING,
LOG_ERROR
};
static const char* sDLL_T[11] =
{
"Native(S):",
"Native(C):",
@ -65,7 +73,8 @@ static const string sDLL_T[11] =
""
};
static const string sANSI_DLL_T[11] =
constexpr const char s_DefaultAnsiColor[] = "\033[38;2;255;204;153m";
constexpr const char* sANSI_DLL_T[11] =
{
"\033[38;2;059;120;218mNative(S):",
"\033[38;2;118;118;118mNative(C):",
@ -77,10 +86,9 @@ static const string sANSI_DLL_T[11] =
"\033[38;2;238;108;030mNative(A):",
"\033[38;2;185;000;235mNative(V):",
"\033[38;2;204;204;204mNetcon(X):",
"\033[38;2;255;204;153m"
s_DefaultAnsiColor
};
static const std::regex rANSI_EXP("\\\033\\[.*?m");
extern std::mutex g_LogMutex;

6
r5dev/vphysics/QHull.cpp
View File

@ -32,10 +32,10 @@ int HQHull_PrintFunc(const char* fmt, ...)
#ifndef DEDICATED
iconsole->debug(buf);
g_pConsole->AddLog(ConLog_t(g_spd_sys_w_oss.str(), ImVec4(0.81f, 0.81f, 0.81f, 1.00f)));
g_pConsole->AddLog(ConLog_t(g_LogStream.str(), ImVec4(0.81f, 0.81f, 0.81f, 1.00f)));
g_spd_sys_w_oss.str("");
g_spd_sys_w_oss.clear();
g_LogStream.str("");
g_LogStream.clear();
#endif // !DEDICATED
g_LogMutex.unlock();