mirror of
https://github.com/OpenMW/openmw.git
synced 2025-01-16 20:29:57 +00:00
Move implementation details of debugging.hpp to cpp, reduce includes
This commit is contained in:
parent
e6fcb8bd2d
commit
14bf9af056
2 changed files with 156 additions and 167 deletions
|
@ -7,12 +7,14 @@
|
||||||
#include <filesystem>
|
#include <filesystem>
|
||||||
|
|
||||||
#include <components/crashcatcher/crashcatcher.hpp>
|
#include <components/crashcatcher/crashcatcher.hpp>
|
||||||
|
#include <components/files/configurationmanager.hpp>
|
||||||
#ifdef _WIN32
|
#ifdef _WIN32
|
||||||
#include <components/crashcatcher/windows_crashcatcher.hpp>
|
#include <components/crashcatcher/windows_crashcatcher.hpp>
|
||||||
#include <components/windows.hpp>
|
#include <components/windows.hpp>
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
#include <SDL_messagebox.h>
|
||||||
|
|
||||||
namespace Debug
|
namespace Debug
|
||||||
{
|
{
|
||||||
#ifdef _WIN32
|
#ifdef _WIN32
|
||||||
|
@ -66,79 +68,177 @@ namespace Debug
|
||||||
static LogListener logListener;
|
static LogListener logListener;
|
||||||
void setLogListener(LogListener listener) { logListener = std::move(listener); }
|
void setLogListener(LogListener listener) { logListener = std::move(listener); }
|
||||||
|
|
||||||
std::streamsize DebugOutputBase::write(const char *str, std::streamsize size)
|
class DebugOutputBase : public boost::iostreams::sink
|
||||||
{
|
{
|
||||||
if (size <= 0)
|
public:
|
||||||
|
DebugOutputBase()
|
||||||
|
{
|
||||||
|
if (CurrentDebugLevel == NoLevel)
|
||||||
|
fillCurrentDebugLevel();
|
||||||
|
}
|
||||||
|
|
||||||
|
virtual std::streamsize write(const char* str, std::streamsize size)
|
||||||
|
{
|
||||||
|
if (size <= 0)
|
||||||
|
return size;
|
||||||
|
std::string_view msg{ str, size_t(size) };
|
||||||
|
|
||||||
|
// Skip debug level marker
|
||||||
|
Level level = getLevelMarker(str);
|
||||||
|
if (level != NoLevel)
|
||||||
|
msg = msg.substr(1);
|
||||||
|
|
||||||
|
char prefix[32];
|
||||||
|
int prefixSize;
|
||||||
|
{
|
||||||
|
prefix[0] = '[';
|
||||||
|
const auto now = std::chrono::system_clock::now();
|
||||||
|
const auto time = std::chrono::system_clock::to_time_t(now);
|
||||||
|
prefixSize = std::strftime(prefix + 1, sizeof(prefix) - 1, "%T", std::localtime(&time)) + 1;
|
||||||
|
char levelLetter = " EWIVD*"[int(level)];
|
||||||
|
const auto ms = std::chrono::duration_cast<std::chrono::milliseconds>(now.time_since_epoch()).count();
|
||||||
|
prefixSize += snprintf(prefix + prefixSize, sizeof(prefix) - prefixSize,
|
||||||
|
".%03u %c] ", static_cast<unsigned>(ms % 1000), levelLetter);
|
||||||
|
}
|
||||||
|
|
||||||
|
while (!msg.empty())
|
||||||
|
{
|
||||||
|
if (msg[0] == 0)
|
||||||
|
break;
|
||||||
|
size_t lineSize = 1;
|
||||||
|
while (lineSize < msg.size() && msg[lineSize - 1] != '\n')
|
||||||
|
lineSize++;
|
||||||
|
writeImpl(prefix, prefixSize, level);
|
||||||
|
writeImpl(msg.data(), lineSize, level);
|
||||||
|
if (logListener)
|
||||||
|
logListener(level, std::string_view(prefix, prefixSize), std::string_view(msg.data(), lineSize));
|
||||||
|
msg = msg.substr(lineSize);
|
||||||
|
}
|
||||||
|
|
||||||
return size;
|
return size;
|
||||||
std::string_view msg{str, size_t(size)};
|
|
||||||
|
|
||||||
// Skip debug level marker
|
|
||||||
Level level = getLevelMarker(str);
|
|
||||||
if (level != NoLevel)
|
|
||||||
msg = msg.substr(1);
|
|
||||||
|
|
||||||
char prefix[32];
|
|
||||||
int prefixSize;
|
|
||||||
{
|
|
||||||
prefix[0] = '[';
|
|
||||||
const auto now = std::chrono::system_clock::now();
|
|
||||||
const auto time = std::chrono::system_clock::to_time_t(now);
|
|
||||||
prefixSize = std::strftime(prefix + 1, sizeof(prefix) - 1, "%T", std::localtime(&time)) + 1;
|
|
||||||
char levelLetter = " EWIVD*"[int(level)];
|
|
||||||
const auto ms = std::chrono::duration_cast<std::chrono::milliseconds>(now.time_since_epoch()).count();
|
|
||||||
prefixSize += snprintf(prefix + prefixSize, sizeof(prefix) - prefixSize,
|
|
||||||
".%03u %c] ", static_cast<unsigned>(ms % 1000), levelLetter);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
while (!msg.empty())
|
virtual ~DebugOutputBase() = default;
|
||||||
|
|
||||||
|
protected:
|
||||||
|
static Level getLevelMarker(const char* str)
|
||||||
{
|
{
|
||||||
if (msg[0] == 0)
|
if (unsigned(*str) <= unsigned(Marker))
|
||||||
break;
|
{
|
||||||
size_t lineSize = 1;
|
return Level(*str);
|
||||||
while (lineSize < msg.size() && msg[lineSize - 1] != '\n')
|
}
|
||||||
lineSize++;
|
|
||||||
writeImpl(prefix, prefixSize, level);
|
return NoLevel;
|
||||||
writeImpl(msg.data(), lineSize, level);
|
|
||||||
if (logListener)
|
|
||||||
logListener(level, std::string_view(prefix, prefixSize), std::string_view(msg.data(), lineSize));
|
|
||||||
msg = msg.substr(lineSize);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return size;
|
static void fillCurrentDebugLevel()
|
||||||
}
|
{
|
||||||
|
const char* env = getenv("OPENMW_DEBUG_LEVEL");
|
||||||
|
if (env)
|
||||||
|
{
|
||||||
|
std::string value(env);
|
||||||
|
if (value == "ERROR")
|
||||||
|
CurrentDebugLevel = Error;
|
||||||
|
else if (value == "WARNING")
|
||||||
|
CurrentDebugLevel = Warning;
|
||||||
|
else if (value == "INFO")
|
||||||
|
CurrentDebugLevel = Info;
|
||||||
|
else if (value == "VERBOSE")
|
||||||
|
CurrentDebugLevel = Verbose;
|
||||||
|
else if (value == "DEBUG")
|
||||||
|
CurrentDebugLevel = Debug;
|
||||||
|
|
||||||
Level DebugOutputBase::getLevelMarker(const char *str)
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
CurrentDebugLevel = Verbose;
|
||||||
|
}
|
||||||
|
|
||||||
|
virtual std::streamsize writeImpl(const char* str, std::streamsize size, Level debugLevel)
|
||||||
|
{
|
||||||
|
return size;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
#if defined _WIN32 && defined _DEBUG
|
||||||
|
class DebugOutput : public DebugOutputBase
|
||||||
{
|
{
|
||||||
if (unsigned(*str) <= unsigned(Marker))
|
public:
|
||||||
|
std::streamsize writeImpl(const char* str, std::streamsize size, Level debugLevel)
|
||||||
{
|
{
|
||||||
return Level(*str);
|
// Make a copy for null termination
|
||||||
|
std::string tmp(str, static_cast<unsigned int>(size));
|
||||||
|
// Write string to Visual Studio Debug output
|
||||||
|
OutputDebugString(tmp.c_str());
|
||||||
|
return size;
|
||||||
}
|
}
|
||||||
|
|
||||||
return NoLevel;
|
virtual ~DebugOutput() = default;
|
||||||
}
|
};
|
||||||
|
#else
|
||||||
|
|
||||||
void DebugOutputBase::fillCurrentDebugLevel()
|
class Tee : public DebugOutputBase
|
||||||
{
|
{
|
||||||
const char* env = getenv("OPENMW_DEBUG_LEVEL");
|
public:
|
||||||
if (env)
|
Tee(std::ostream& stream, std::ostream& stream2)
|
||||||
|
: out(stream), out2(stream2)
|
||||||
{
|
{
|
||||||
std::string value(env);
|
// TODO: check which stream is stderr?
|
||||||
if (value == "ERROR")
|
mUseColor = useColoredOutput();
|
||||||
CurrentDebugLevel = Error;
|
|
||||||
else if (value == "WARNING")
|
|
||||||
CurrentDebugLevel = Warning;
|
|
||||||
else if (value == "INFO")
|
|
||||||
CurrentDebugLevel = Info;
|
|
||||||
else if (value == "VERBOSE")
|
|
||||||
CurrentDebugLevel = Verbose;
|
|
||||||
else if (value == "DEBUG")
|
|
||||||
CurrentDebugLevel = Debug;
|
|
||||||
|
|
||||||
return;
|
mColors[Error] = Red;
|
||||||
|
mColors[Warning] = Yellow;
|
||||||
|
mColors[Info] = Reset;
|
||||||
|
mColors[Verbose] = DarkGray;
|
||||||
|
mColors[Debug] = DarkGray;
|
||||||
|
mColors[NoLevel] = Reset;
|
||||||
}
|
}
|
||||||
|
|
||||||
CurrentDebugLevel = Verbose;
|
std::streamsize writeImpl(const char* str, std::streamsize size, Level debugLevel) override
|
||||||
}
|
{
|
||||||
|
out.write(str, size);
|
||||||
|
out.flush();
|
||||||
|
|
||||||
|
if (mUseColor)
|
||||||
|
{
|
||||||
|
out2 << "\033[0;" << mColors[debugLevel] << "m";
|
||||||
|
out2.write(str, size);
|
||||||
|
out2 << "\033[0;" << Reset << "m";
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
out2.write(str, size);
|
||||||
|
}
|
||||||
|
out2.flush();
|
||||||
|
|
||||||
|
return size;
|
||||||
|
}
|
||||||
|
|
||||||
|
virtual ~Tee() = default;
|
||||||
|
|
||||||
|
private:
|
||||||
|
|
||||||
|
static bool useColoredOutput()
|
||||||
|
{
|
||||||
|
// Note: cmd.exe in Win10 should support ANSI colors, but in its own way.
|
||||||
|
#if defined(_WIN32)
|
||||||
|
return 0;
|
||||||
|
#else
|
||||||
|
char* term = getenv("TERM");
|
||||||
|
bool useColor = term && !getenv("NO_COLOR") && isatty(fileno(stderr));
|
||||||
|
|
||||||
|
return useColor;
|
||||||
|
#endif
|
||||||
|
}
|
||||||
|
|
||||||
|
std::ostream& out;
|
||||||
|
std::ostream& out2;
|
||||||
|
bool mUseColor;
|
||||||
|
|
||||||
|
std::map<Level, int> mColors;
|
||||||
|
};
|
||||||
|
#endif
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
static std::unique_ptr<std::ostream> rawStdout = nullptr;
|
static std::unique_ptr<std::ostream> rawStdout = nullptr;
|
||||||
|
|
|
@ -4,17 +4,10 @@
|
||||||
#include <boost/filesystem/fstream.hpp>
|
#include <boost/filesystem/fstream.hpp>
|
||||||
#include <boost/iostreams/stream.hpp>
|
#include <boost/iostreams/stream.hpp>
|
||||||
|
|
||||||
#include <components/files/configurationmanager.hpp>
|
|
||||||
#include <components/misc/guarded.hpp>
|
#include <components/misc/guarded.hpp>
|
||||||
|
|
||||||
#include <SDL_messagebox.h>
|
|
||||||
|
|
||||||
#include "debuglog.hpp"
|
#include "debuglog.hpp"
|
||||||
|
|
||||||
#if defined _WIN32 && defined _DEBUG
|
|
||||||
#include <components/windows.hpp>
|
|
||||||
#endif
|
|
||||||
|
|
||||||
namespace Debug
|
namespace Debug
|
||||||
{
|
{
|
||||||
// ANSI colors for terminal
|
// ANSI colors for terminal
|
||||||
|
@ -26,116 +19,12 @@ namespace Debug
|
||||||
Yellow = 93
|
Yellow = 93
|
||||||
};
|
};
|
||||||
|
|
||||||
class DebugOutputBase : public boost::iostreams::sink
|
|
||||||
{
|
|
||||||
public:
|
|
||||||
DebugOutputBase()
|
|
||||||
{
|
|
||||||
if (CurrentDebugLevel == NoLevel)
|
|
||||||
fillCurrentDebugLevel();
|
|
||||||
}
|
|
||||||
|
|
||||||
virtual std::streamsize write(const char *str, std::streamsize size);
|
|
||||||
|
|
||||||
virtual ~DebugOutputBase() = default;
|
|
||||||
|
|
||||||
protected:
|
|
||||||
static Level getLevelMarker(const char *str);
|
|
||||||
|
|
||||||
static void fillCurrentDebugLevel();
|
|
||||||
|
|
||||||
virtual std::streamsize writeImpl(const char *str, std::streamsize size, Level debugLevel)
|
|
||||||
{
|
|
||||||
return size;
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
#ifdef _WIN32
|
#ifdef _WIN32
|
||||||
bool attachParentConsole();
|
bool attachParentConsole();
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#if defined _WIN32 && defined _DEBUG
|
|
||||||
class DebugOutput : public DebugOutputBase
|
|
||||||
{
|
|
||||||
public:
|
|
||||||
std::streamsize writeImpl(const char *str, std::streamsize size, Level debugLevel)
|
|
||||||
{
|
|
||||||
// Make a copy for null termination
|
|
||||||
std::string tmp (str, static_cast<unsigned int>(size));
|
|
||||||
// Write string to Visual Studio Debug output
|
|
||||||
OutputDebugString (tmp.c_str ());
|
|
||||||
return size;
|
|
||||||
}
|
|
||||||
|
|
||||||
virtual ~DebugOutput() {}
|
|
||||||
};
|
|
||||||
#else
|
|
||||||
|
|
||||||
class Tee : public DebugOutputBase
|
|
||||||
{
|
|
||||||
public:
|
|
||||||
Tee(std::ostream &stream, std::ostream &stream2)
|
|
||||||
: out(stream), out2(stream2)
|
|
||||||
{
|
|
||||||
// TODO: check which stream is stderr?
|
|
||||||
mUseColor = useColoredOutput();
|
|
||||||
|
|
||||||
mColors[Error] = Red;
|
|
||||||
mColors[Warning] = Yellow;
|
|
||||||
mColors[Info] = Reset;
|
|
||||||
mColors[Verbose] = DarkGray;
|
|
||||||
mColors[Debug] = DarkGray;
|
|
||||||
mColors[NoLevel] = Reset;
|
|
||||||
}
|
|
||||||
|
|
||||||
std::streamsize writeImpl(const char *str, std::streamsize size, Level debugLevel) override
|
|
||||||
{
|
|
||||||
out.write (str, size);
|
|
||||||
out.flush();
|
|
||||||
|
|
||||||
if(mUseColor)
|
|
||||||
{
|
|
||||||
out2 << "\033[0;" << mColors[debugLevel] << "m";
|
|
||||||
out2.write (str, size);
|
|
||||||
out2 << "\033[0;" << Reset << "m";
|
|
||||||
}
|
|
||||||
else
|
|
||||||
{
|
|
||||||
out2.write(str, size);
|
|
||||||
}
|
|
||||||
out2.flush();
|
|
||||||
|
|
||||||
return size;
|
|
||||||
}
|
|
||||||
|
|
||||||
virtual ~Tee() {}
|
|
||||||
|
|
||||||
private:
|
|
||||||
|
|
||||||
static bool useColoredOutput()
|
|
||||||
{
|
|
||||||
// Note: cmd.exe in Win10 should support ANSI colors, but in its own way.
|
|
||||||
#if defined(_WIN32)
|
|
||||||
return 0;
|
|
||||||
#else
|
|
||||||
char *term = getenv("TERM");
|
|
||||||
bool useColor = term && !getenv("NO_COLOR") && isatty(fileno(stderr));
|
|
||||||
|
|
||||||
return useColor;
|
|
||||||
#endif
|
|
||||||
}
|
|
||||||
|
|
||||||
std::ostream &out;
|
|
||||||
std::ostream &out2;
|
|
||||||
bool mUseColor;
|
|
||||||
|
|
||||||
std::map<Level, int> mColors;
|
|
||||||
};
|
|
||||||
#endif
|
|
||||||
|
|
||||||
using LogListener = std::function<void(Debug::Level, std::string_view prefix, std::string_view msg)>;
|
using LogListener = std::function<void(Debug::Level, std::string_view prefix, std::string_view msg)>;
|
||||||
void setLogListener(LogListener);
|
void setLogListener(LogListener);
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Can be used to print messages without timestamps
|
// Can be used to print messages without timestamps
|
||||||
|
|
Loading…
Reference in a new issue