mirror/openmw
1
0
Fork 0
mirror of https://github.com/OpenMW/openmw.git synced 2025-01-30 01:15:35 +00:00
Code Issues Releases Wiki Activity

Move "debugging" function into Debug namespace

Browse source
This commit is contained in:
elsid 2024-06-15 12:42:50 +02:00
parent ea84d1ce0c
commit 1bdc01273e
No known key found for this signature in database
GPG key ID: 4DE04C198CBA7625
10 changed files with 119 additions and 117 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
apps/bulletobjecttool/main.cpp
View file

@ -121,14 +121,14 @@ namespace
if (variables.find("help") != variables.end())
{
getRawStdout() << desc << std::endl;
Debug::getRawStdout() << desc << std::endl;
return 0;
}
Files::ConfigurationManager config;
config.readConfiguration(variables, desc);
setupLogging(config.getLogPath(), applicationName);
Debug::setupLogging(config.getLogPath(), applicationName);
const std::string encoding(variables["encoding"].as<std::string>());
Log(Debug::Info) << ToUTF8::encodingUsingMessage(encoding);
@ -202,5 +202,5 @@ namespace
int main(int argc, char* argv[])
{
return wrapApplication(runBulletObjectTool, argc, argv, applicationName);
return Debug::wrapApplication(runBulletObjectTool, argc, argv, applicationName);
}

4
apps/launcher/main.cpp
View file

@ -30,7 +30,7 @@ int runLauncher(int argc, char* argv[])
configurationManager.addCommonOptions(description);
configurationManager.readConfiguration(variables, description, true);
setupLogging(configurationManager.getLogPath(), "Launcher");
Debug::setupLogging(configurationManager.getLogPath(), "Launcher");
try
{
@ -66,5 +66,5 @@ int runLauncher(int argc, char* argv[])
int main(int argc, char* argv[])
{
return wrapApplication(runLauncher, argc, argv, "Launcher");
return Debug::wrapApplication(runLauncher, argc, argv, "Launcher");
}

6
apps/navmeshtool/main.cpp
View file

@ -140,14 +140,14 @@ namespace NavMeshTool
if (variables.find("help") != variables.end())
{
getRawStdout() << desc << std::endl;
Debug::getRawStdout() << desc << std::endl;
return 0;
}
Files::ConfigurationManager config;
config.readConfiguration(variables, desc);
setupLogging(config.getLogPath(), applicationName);
Debug::setupLogging(config.getLogPath(), applicationName);
const std::string encoding(variables["encoding"].as<std::string>());
Log(Debug::Info) << ToUTF8::encodingUsingMessage(encoding);
@ -260,5 +260,5 @@ namespace NavMeshTool
int main(int argc, char* argv[])
{
return wrapApplication(NavMeshTool::runNavMeshTool, argc, argv, NavMeshTool::applicationName);
return Debug::wrapApplication(NavMeshTool::runNavMeshTool, argc, argv, NavMeshTool::applicationName);
}

2
apps/navmeshtool/navmesh.cpp
View file

@ -59,7 +59,7 @@ namespace NavMeshTool
void serializeToStderr(const T& value)
{
const std::vector<std::byte> data = serialize(value);
getLockedRawStderr()->write(
Debug::getLockedRawStderr()->write(
reinterpret_cast<const char*>(data.data()), static_cast<std::streamsize>(data.size()));
}

3
apps/navmeshtool/worldspacedata.cpp
View file

@ -219,7 +219,8 @@ namespace NavMeshTool
void serializeToStderr(const T& value)
{
const std::vector<std::byte> data = serialize(value);
getRawStderr().write(reinterpret_cast<const char*>(data.data()), static_cast<std::streamsize>(data.size()));
Debug::getRawStderr().write(
reinterpret_cast<const char*>(data.data()), static_cast<std::streamsize>(data.size()));
}
std::string makeAddObjectErrorMessage(

2
apps/opencs/editor.cpp
View file

@ -139,7 +139,7 @@ boost::program_options::variables_map CS::Editor::readConfiguration()
mCfgMgr.readConfiguration(variables, desc, false);
Settings::Manager::load(mCfgMgr, true);
setupLogging(mCfgMgr.getLogPath(), "OpenMW-CS");
Debug::setupLogging(mCfgMgr.getLogPath(), "OpenMW-CS");
return variables;
}

2
apps/opencs/main.cpp
View file

@ -78,5 +78,5 @@ int runApplication(int argc, char* argv[])
int main(int argc, char* argv[])
{
return wrapApplication(&runApplication, argc, argv, "OpenMW-CS");
return Debug::wrapApplication(&runApplication, argc, argv, "OpenMW-CS");
}

8
apps/openmw/main.cpp
View file

@ -53,19 +53,19 @@ bool parseOptions(int argc, char** argv, OMW::Engine& engine, Files::Configurati
if (variables.count("help"))
{
getRawStdout() << desc << std::endl;
Debug::getRawStdout() << desc << std::endl;
return false;
}
if (variables.count("version"))
{
getRawStdout() << Version::getOpenmwVersionDescription() << std::endl;
Debug::getRawStdout() << Version::getOpenmwVersionDescription() << std::endl;
return false;
}
cfgMgr.readConfiguration(variables, desc);
setupLogging(cfgMgr.getLogPath(), "OpenMW");
Debug::setupLogging(cfgMgr.getLogPath(), "OpenMW");
Log(Debug::Info) << Version::getOpenmwVersionDescription();
Settings::Manager::load(cfgMgr);
@ -245,7 +245,7 @@ extern "C" int SDL_main(int argc, char** argv)
int main(int argc, char** argv)
#endif
{
return wrapApplication(&runApplication, argc, argv, "OpenMW");
return Debug::wrapApplication(&runApplication, argc, argv, "OpenMW");
}
// Platform specific for Windows when there is no console built into the executable.

178
components/debug/debugging.cpp
View file

@ -352,130 +352,130 @@ namespace Debug
}
#endif
}
static std::unique_ptr<std::ostream> rawStdout = nullptr;
static std::unique_ptr<std::ostream> rawStderr = nullptr;
static std::unique_ptr<std::mutex> rawStderrMutex = nullptr;
static std::ofstream logfile;
static std::unique_ptr<std::ostream> rawStdout = nullptr;
static std::unique_ptr<std::ostream> rawStderr = nullptr;
static std::unique_ptr<std::mutex> rawStderrMutex = nullptr;
static std::ofstream logfile;
#if defined(_WIN32) && defined(_DEBUG)
static boost::iostreams::stream_buffer<Debug::DebugOutput> sb;
static boost::iostreams::stream_buffer<DebugOutput> sb;
#else
static boost::iostreams::stream_buffer<Debug::Tee<Debug::Identity, Debug::Coloured>> standardOut;
static boost::iostreams::stream_buffer<Debug::Tee<Debug::Identity, Debug::Coloured>> standardErr;
static boost::iostreams::stream_buffer<Debug::Tee<Debug::Buffer, Debug::Coloured>> bufferedOut;
static boost::iostreams::stream_buffer<Debug::Tee<Debug::Buffer, Debug::Coloured>> bufferedErr;
static boost::iostreams::stream_buffer<Tee<Identity, Coloured>> standardOut;
static boost::iostreams::stream_buffer<Tee<Identity, Coloured>> standardErr;
static boost::iostreams::stream_buffer<Tee<Buffer, Coloured>> bufferedOut;
static boost::iostreams::stream_buffer<Tee<Buffer, Coloured>> bufferedErr;
#endif
std::ostream& getRawStdout()
{
return rawStdout ? *rawStdout : std::cout;
}
std::ostream& getRawStdout()
{
return rawStdout ? *rawStdout : std::cout;
}
std::ostream& getRawStderr()
{
return rawStderr ? *rawStderr : std::cerr;
}
std::ostream& getRawStderr()
{
return rawStderr ? *rawStderr : std::cerr;
}
Misc::Locked<std::ostream&> getLockedRawStderr()
{
return Misc::Locked<std::ostream&>(*rawStderrMutex, getRawStderr());
}
Misc::Locked<std::ostream&> getLockedRawStderr()
{
return Misc::Locked<std::ostream&>(*rawStderrMutex, getRawStderr());
}
void setupLogging(const std::filesystem::path& logDir, std::string_view appName)
{
void setupLogging(const std::filesystem::path& logDir, std::string_view appName)
{
#if !(defined(_WIN32) && defined(_DEBUG))
const std::string logName = Misc::StringUtils::lowerCase(appName) + ".log";
logfile.open(logDir / logName, std::ios::out);
const std::string logName = Misc::StringUtils::lowerCase(appName) + ".log";
logfile.open(logDir / logName, std::ios::out);
Debug::Identity log(logfile);
Identity log(logfile);
for (const Debug::Record& v : Debug::globalBuffer)
log.write(v.mValue.data(), v.mValue.size(), v.mLevel);
for (const Record& v : globalBuffer)
log.write(v.mValue.data(), v.mValue.size(), v.mLevel);
Debug::globalBuffer.clear();
globalBuffer.clear();
standardOut.open(Debug::Tee(log, Debug::Coloured(*rawStdout)));
standardErr.open(Debug::Tee(log, Debug::Coloured(*rawStderr)));
standardOut.open(Tee(log, Coloured(*rawStdout)));
standardErr.open(Tee(log, Coloured(*rawStderr)));
std::cout.rdbuf(&standardOut);
std::cerr.rdbuf(&standardErr);
std::cout.rdbuf(&standardOut);
std::cerr.rdbuf(&standardErr);
#endif
#ifdef _WIN32
if (Crash::CrashCatcher::instance())
{
Crash::CrashCatcher::instance()->updateDumpPath(logDir);
if (Crash::CrashCatcher::instance())
{
Crash::CrashCatcher::instance()->updateDumpPath(logDir);
}
#endif
}
#endif
}
int wrapApplication(int (*innerApplication)(int argc, char* argv[]), int argc, char* argv[], std::string_view appName)
{
int wrapApplication(
int (*innerApplication)(int argc, char* argv[]), int argc, char* argv[], std::string_view appName)
{
#if defined _WIN32
(void)Debug::attachParentConsole();
(void)attachParentConsole();
#endif
rawStdout = std::make_unique<std::ostream>(std::cout.rdbuf());
rawStderr = std::make_unique<std::ostream>(std::cerr.rdbuf());
rawStderrMutex = std::make_unique<std::mutex>();
rawStdout = std::make_unique<std::ostream>(std::cout.rdbuf());
rawStderr = std::make_unique<std::ostream>(std::cerr.rdbuf());
rawStderrMutex = std::make_unique<std::mutex>();
#if defined(_WIN32) && defined(_DEBUG)
// Redirect cout and cerr to VS debug output when running in debug mode
sb.open(Debug::DebugOutput());
std::cout.rdbuf(&sb);
std::cerr.rdbuf(&sb);
// Redirect cout and cerr to VS debug output when running in debug mode
sb.open(DebugOutput());
std::cout.rdbuf(&sb);
std::cerr.rdbuf(&sb);
#else
bufferedOut.open(Debug::Tee(Debug::Buffer(Debug::globalBuffer), Debug::Coloured(*rawStdout)));
bufferedErr.open(Debug::Tee(Debug::Buffer(Debug::globalBuffer), Debug::Coloured(*rawStderr)));
bufferedOut.open(Tee(Buffer(globalBuffer), Coloured(*rawStdout)));
bufferedErr.open(Tee(Buffer(globalBuffer), Coloured(*rawStderr)));
std::cout.rdbuf(&bufferedOut);
std::cerr.rdbuf(&bufferedErr);
std::cout.rdbuf(&bufferedOut);
std::cerr.rdbuf(&bufferedErr);
#endif
int ret = 0;
try
{
if (const auto env = std::getenv("OPENMW_DISABLE_CRASH_CATCHER");
env == nullptr || Misc::StringUtils::toNumeric<int>(env, 0) == 0)
int ret = 0;
try
{
#if defined(_WIN32)
const std::string crashDumpName = Misc::StringUtils::lowerCase(appName) + "-crash.dmp";
const std::string freezeDumpName = Misc::StringUtils::lowerCase(appName) + "-freeze.dmp";
std::filesystem::path dumpDirectory = std::filesystem::temp_directory_path();
PWSTR userProfile = nullptr;
if (SUCCEEDED(SHGetKnownFolderPath(FOLDERID_Profile, 0, nullptr, &userProfile)))
if (const auto env = std::getenv("OPENMW_DISABLE_CRASH_CATCHER");
env == nullptr || Misc::StringUtils::toNumeric<int>(env, 0) == 0)
{
dumpDirectory = userProfile;
}
CoTaskMemFree(userProfile);
Crash::CrashCatcher crashy(argc, argv, dumpDirectory, crashDumpName, freezeDumpName);
#if defined(_WIN32)
const std::string crashDumpName = Misc::StringUtils::lowerCase(appName) + "-crash.dmp";
const std::string freezeDumpName = Misc::StringUtils::lowerCase(appName) + "-freeze.dmp";
std::filesystem::path dumpDirectory = std::filesystem::temp_directory_path();
PWSTR userProfile = nullptr;
if (SUCCEEDED(SHGetKnownFolderPath(FOLDERID_Profile, 0, nullptr, &userProfile)))
{
dumpDirectory = userProfile;
}
CoTaskMemFree(userProfile);
Crash::CrashCatcher crashy(argc, argv, dumpDirectory, crashDumpName, freezeDumpName);
#else
const std::string crashLogName = Misc::StringUtils::lowerCase(appName) + "-crash.log";
// install the crash handler as soon as possible.
crashCatcherInstall(argc, argv, std::filesystem::temp_directory_path() / crashLogName);
const std::string crashLogName = Misc::StringUtils::lowerCase(appName) + "-crash.log";
// install the crash handler as soon as possible.
crashCatcherInstall(argc, argv, std::filesystem::temp_directory_path() / crashLogName);
#endif
ret = innerApplication(argc, argv);
ret = innerApplication(argc, argv);
}
else
ret = innerApplication(argc, argv);
}
else
ret = innerApplication(argc, argv);
}
catch (const std::exception& e)
{
catch (const std::exception& e)
{
#if (defined(__APPLE__) || defined(__linux) || defined(__unix) || defined(__posix))
if (!isatty(fileno(stdin)))
if (!isatty(fileno(stdin)))
#endif
SDL_ShowSimpleMessageBox(0, (std::string(appName) + ": Fatal error").c_str(), e.what(), nullptr);
SDL_ShowSimpleMessageBox(0, (std::string(appName) + ": Fatal error").c_str(), e.what(), nullptr);
Log(Debug::Error) << "Fatal error: " << e.what();
Log(Debug::Error) << "Fatal error: " << e.what();
ret = 1;
ret = 1;
}
// Restore cout and cerr
std::cout.rdbuf(rawStdout->rdbuf());
std::cerr.rdbuf(rawStderr->rdbuf());
CurrentDebugLevel = NoLevel;
return ret;
}
// Restore cout and cerr
std::cout.rdbuf(rawStdout->rdbuf());
std::cerr.rdbuf(rawStderr->rdbuf());
Debug::CurrentDebugLevel = Debug::NoLevel;
return ret;
}

25
components/debug/debugging.hpp
View file

@ -26,18 +26,19 @@ namespace Debug
using LogListener = std::function<void(Debug::Level, std::string_view prefix, std::string_view msg)>;
void setLogListener(LogListener);
// Can be used to print messages without timestamps
std::ostream& getRawStdout();
std::ostream& getRawStderr();
Misc::Locked<std::ostream&> getLockedRawStderr();
// Redirect cout and cerr to the log file
void setupLogging(const std::filesystem::path& logDir, std::string_view appName);
int wrapApplication(
int (*innerApplication)(int argc, char* argv[]), int argc, char* argv[], std::string_view appName);
}
// Can be used to print messages without timestamps
std::ostream& getRawStdout();
std::ostream& getRawStderr();
Misc::Locked<std::ostream&> getLockedRawStderr();
// Redirect cout and cerr to the log file
void setupLogging(const std::filesystem::path& logDir, std::string_view appName);
int wrapApplication(int (*innerApplication)(int argc, char* argv[]), int argc, char* argv[], std::string_view appName);
#endif