mirror of
https://github.com/dolphin-emu/dolphin.git
synced 2024-11-14 21:37:52 -07:00
c296c34e00
This will assist with finding the source of a panic alert based on logs; before, Common\MsgHandler.cpp:113 (or similar) was always used.
144 lines
3.9 KiB
C++
144 lines
3.9 KiB
C++
// Copyright 2008 Dolphin Emulator Project
|
|
// SPDX-License-Identifier: GPL-2.0-or-later
|
|
|
|
#include "Common/MsgHandler.h"
|
|
|
|
#include <cstdarg>
|
|
#include <cstdlib>
|
|
#include <string>
|
|
|
|
#ifdef _WIN32
|
|
#include <windows.h>
|
|
#else
|
|
#include <cstdio>
|
|
#include <fmt/format.h>
|
|
#endif
|
|
|
|
#include "Common/Common.h"
|
|
#include "Common/CommonTypes.h"
|
|
#include "Common/Logging/Log.h"
|
|
#include "Common/StringUtil.h"
|
|
|
|
namespace Common
|
|
{
|
|
namespace
|
|
{
|
|
// Default non library dependent panic alert
|
|
bool DefaultMsgHandler(const char* caption, const char* text, bool yes_no, MsgType style)
|
|
{
|
|
#ifdef _WIN32
|
|
int window_style = MB_ICONINFORMATION;
|
|
if (style == MsgType::Question)
|
|
window_style = MB_ICONQUESTION;
|
|
if (style == MsgType::Warning)
|
|
window_style = MB_ICONWARNING;
|
|
|
|
return IDYES == MessageBox(0, UTF8ToTStr(text).c_str(), UTF8ToTStr(caption).c_str(),
|
|
window_style | (yes_no ? MB_YESNO : MB_OK));
|
|
#else
|
|
fmt::print(stderr, "{}\n", text);
|
|
|
|
// Return no to any question (which will in general crash the emulator)
|
|
return false;
|
|
#endif
|
|
}
|
|
|
|
// Default (non) translator
|
|
std::string DefaultStringTranslator(const char* text)
|
|
{
|
|
return text;
|
|
}
|
|
|
|
MsgAlertHandler s_msg_handler = DefaultMsgHandler;
|
|
StringTranslator s_str_translator = DefaultStringTranslator;
|
|
bool s_alert_enabled = true;
|
|
bool s_abort_on_panic_alert = false;
|
|
|
|
const char* GetCaption(MsgType style)
|
|
{
|
|
static const std::string info_caption = GetStringT("Information");
|
|
static const std::string ques_caption = GetStringT("Question");
|
|
static const std::string warn_caption = GetStringT("Warning");
|
|
static const std::string crit_caption = GetStringT("Critical");
|
|
|
|
switch (style)
|
|
{
|
|
case MsgType::Information:
|
|
return info_caption.c_str();
|
|
case MsgType::Question:
|
|
return ques_caption.c_str();
|
|
case MsgType::Warning:
|
|
return warn_caption.c_str();
|
|
case MsgType::Critical:
|
|
return crit_caption.c_str();
|
|
default:
|
|
return "Unhandled caption";
|
|
}
|
|
}
|
|
} // Anonymous namespace
|
|
|
|
// Select which of these functions that are used for message boxes. If
|
|
// Qt is enabled we will use QtMsgAlertHandler() that is defined in Main.cpp
|
|
void RegisterMsgAlertHandler(MsgAlertHandler handler)
|
|
{
|
|
s_msg_handler = handler;
|
|
}
|
|
|
|
// Select translation function.
|
|
void RegisterStringTranslator(StringTranslator translator)
|
|
{
|
|
s_str_translator = translator;
|
|
}
|
|
|
|
// enable/disable the alert handler
|
|
void SetEnableAlert(bool enable)
|
|
{
|
|
s_alert_enabled = enable;
|
|
}
|
|
|
|
void SetAbortOnPanicAlert(bool should_abort)
|
|
{
|
|
s_abort_on_panic_alert = should_abort;
|
|
}
|
|
|
|
std::string GetStringT(const char* string)
|
|
{
|
|
return s_str_translator(string);
|
|
}
|
|
|
|
static bool ShowMessageAlert(std::string_view text, bool yes_no, Common::Log::LogType log_type,
|
|
MsgType style, const char* file, int line)
|
|
{
|
|
const char* caption = GetCaption(style);
|
|
// Directly call GenericLogFmt rather than using the normal log macros so that we can use the
|
|
// caller's line file and line number
|
|
Common::Log::GenericLogFmt<2>(Common::Log::LogLevel::LERROR, log_type, file, line,
|
|
FMT_STRING("{}: {}"), caption, text);
|
|
|
|
// Panic alerts.
|
|
if (style == MsgType::Warning && s_abort_on_panic_alert)
|
|
{
|
|
std::abort();
|
|
}
|
|
|
|
// Don't ignore questions, especially AskYesNo, PanicYesNo could be ignored
|
|
if (s_msg_handler != nullptr &&
|
|
(s_alert_enabled || style == MsgType::Question || style == MsgType::Critical))
|
|
{
|
|
return s_msg_handler(caption, text.data(), yes_no, style);
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
// This is the first stop for gui alerts where the log is updated and the
|
|
// correct window is shown, when using fmt
|
|
bool MsgAlertFmtImpl(bool yes_no, MsgType style, Common::Log::LogType log_type, const char* file,
|
|
int line, fmt::string_view format, const fmt::format_args& args)
|
|
{
|
|
const auto message = fmt::vformat(format, args);
|
|
|
|
return ShowMessageAlert(message, yes_no, log_type, style, file, line);
|
|
}
|
|
} // namespace Common
|