feat: improve error messages

Author: shad0wshayd3

include/REL/IDDB.h

@@ -79,7 +79,10 @@ namespace REL
 				_stream(a_filename.data(), a_mode)
 			{
 				if (!_stream.is_open()) {
-					stl::report_and_fail("failed to open address library file"sv);
+					const auto str = std::format(
+						L"Failed to open Address Library file!\nPath: {}"sv,
+						a_filename);
+					stl::report_and_fail(str);
 				}
 
 				_stream.exceptions(std::ios::badbit | std::ios::failbit | std::ios::eofbit);

include/REL/Offset2ID.h

@@ -33,7 +33,7 @@ namespace REL
 		[[nodiscard]] std::uint64_t operator()(std::size_t a_offset) const
 		{
 			if (_offset2id.empty()) {
-				stl::report_and_fail("No Address Library has been loaded."sv);
+				stl::report_and_fail("No Address Library has been loaded!"sv);
 			}
 
 			const IDDB::mapping_t elem{ 0, a_offset };
@@ -45,7 +45,14 @@ namespace REL
                     return a_lhs.offset < a_rhs.offset;
                 });
 			if (it == _offset2id.end()) {
-				stl::report_and_fail("offset not found"sv);
+				const auto mod = Module::GetSingleton();
+				const auto version = mod->version();
+				const auto str = std::format(
+					"Failed to find Address Library ID for offset!\n"
+					"Invalid offset: 0x{:08X}\n"
+					"Game Version: {}"sv,
+					a_offset, version.string());
+				stl::report_and_fail(str);
 			}
 
 			return it->id;

include/REL/Pattern.h

@@ -139,16 +139,15 @@ namespace REL
 				const noexcept
 			{
 				if (!this->match(a_address)) {
-					const auto version = Module::get().version();
+					const auto mod = Module::GetSingleton();
+					const auto version = mod->version();
 					stl::report_and_fail(
 						std::format(
 							"A pattern has failed to match.\n"
 							"This means the plugin is incompatible with either the "
-							"current version of the game ({}.{}.{}), or another "
+							"current version of the game ({}), or another "
 							"installed mod."sv,
-							version[0],
-							version[1],
-							version[2]),
+							version.string()),
 						a_loc);
 				}
 			}

include/REX/Impl/PCH.h

@@ -543,6 +543,68 @@ namespace XSE
 			REX::W32::TerminateProcess(REX::W32::GetCurrentProcess(), EXIT_FAILURE);
 		}
 
+		[[noreturn]] inline void report_and_fail(std::wstring_view a_msg, std::source_location a_loc = std::source_location::current())
+		{
+			const auto body = [&]() {
+				constexpr std::array directories{
+					L"include/"sv,
+					L"src/"sv,
+				};
+
+				const std::filesystem::path p = a_loc.file_name();
+				const auto                  filename = p.generic_wstring();
+				std::wstring_view           fileview = filename;
+
+				constexpr auto npos = std::wstring::npos;
+				std::size_t    pos = npos;
+				std::size_t    off = 0;
+				for (const auto& dir : directories) {
+					pos = fileview.find(dir);
+					if (pos != npos) {
+						off = dir.length();
+						break;
+					}
+				}
+
+				if (pos != npos) {
+					fileview = fileview.substr(pos + off);
+				}
+
+				return std::format(L"{}({}): {}", fileview, a_loc.line(), a_msg);
+			}();
+
+			const auto caption = []() -> std::wstring {
+				std::vector<char> buf;
+				buf.reserve(REX::W32::MAX_PATH);
+				buf.resize(REX::W32::MAX_PATH / 2);
+				std::uint32_t result = 0;
+				do {
+					buf.resize(buf.size() * 2);
+					result = REX::W32::GetModuleFileNameA(
+						REX::W32::GetCurrentModule(),
+						buf.data(),
+						static_cast<std::uint32_t>(buf.size()));
+				} while (result && result == buf.size() && buf.size() <= std::numeric_limits<std::uint32_t>::max());
+
+				if (result && result != buf.size()) {
+					std::filesystem::path p(buf.begin(), buf.begin() + result);
+					return p.filename().wstring();
+				} else {
+					return {};
+				}
+			}();
+
+			spdlog::log(
+				spdlog::source_loc{
+					a_loc.file_name(),
+					static_cast<int>(a_loc.line()),
+					a_loc.function_name() },
+				spdlog::level::critical,
+				a_msg);
+			REX::W32::MessageBoxW(nullptr, body.c_str(), (caption.empty() ? nullptr : caption.c_str()), 0);
+			REX::W32::TerminateProcess(REX::W32::GetCurrentProcess(), EXIT_FAILURE);
+		}
+
 		template <class To, class From>
 		[[nodiscard]] To unrestricted_cast(From a_from)
 		{

src/REL/IDDB.cpp

@@ -21,7 +21,7 @@ namespace REL
 			const auto mod = Module::GetSingleton();
 			const auto version = mod->version();
 			const auto str = std::format(
-				"Failed to find Address Library ID!\n"
+				"Failed to find offset for Address Library ID!\n"
 				"Invalid ID: {}\n"
 				"Game Version: {}"sv,
 				a_id, version.string());
@@ -164,10 +164,9 @@ namespace REL
 			if (header.version() != mod->version()) {
 				const auto str = std::format(
 					"Address Library version mismatch!\n"
-					"Expected Version: {}\n",
+					"Expected Version: {}\n"
 					"Actual Version: {}"sv,
-					mod->version().string(),
-					header.version().string());
+					mod->version().string(), header.version().string());
 				stl::report_and_fail(str);
 			}
 
@@ -187,7 +186,10 @@ namespace REL
 				stl::report_and_fail("Failed to create shared mapping!"sv);
 			}
 		} catch (const std::system_error&) {
-			stl::report_and_fail("Failed to find Address Library file!"sv);
+			const auto str = std::format(
+				L"Failed to open Address Library file!\nPath: {}"sv,
+				filename);
+			stl::report_and_fail(str);
 		}
 	}
 
@@ -229,7 +231,7 @@ namespace REL
 					id = a_in.readout<std::uint32_t>();
 					break;
 				default:
-					stl::report_and_fail("Unhandled type while loading Address Library."sv);
+					stl::report_and_fail("Unhandled type while loading Address Library!"sv);
 			}
 
 			const std::uint64_t tmp = (hi & 8) != 0 ? (prevOffset / a_header.pointer_size()) : prevOffset;
@@ -260,7 +262,7 @@ namespace REL
 					offset = a_in.readout<std::uint32_t>();
 					break;
 				default:
-					stl::report_and_fail("Unhandled type while loading Address Library."sv);
+					stl::report_and_fail("Unhandled type while loading Address Library!"sv);
 			}
 
 			if ((hi & 8) != 0) {
@@ -285,7 +287,8 @@ namespace REL
 		const auto version = mod->version().string("-"sv);
 		const auto path = std::vformat(a_filename, std::make_format_args(version));
 		if (!_mmap.open(path)) {
-			stl::report_and_fail(std::format("failed to open: {}", path));
+			const auto str = std::format("Failed to open Address Library file!\nPath: {}"sv, path);
+			stl::report_and_fail(str);
 		}
 
 		_id2offset = std::span{

xmake.lua

@@ -13,31 +13,31 @@ add_rules("mode.debug", "mode.releasedbg")
 -- add options
 option("rex_ini", function()
     set_default(false)
-    set_description("enable ini config support for REX")
+    set_description("enable REX::INI settings support")
     add_defines("REX_OPTION_INI=1")
 end)
 
 option("rex_json", function()
     set_default(false)
-    set_description("enable json config support for REX")
+    set_description("enable REX::JSON settings support")
     add_defines("REX_OPTION_JSON=1")
 end)
 
 option("rex_toml", function()
     set_default(false)
-    set_description("enable toml config support for REX")
+    set_description("enable REX::TOML settings support")
     add_defines("REX_OPTION_TOML=1")
 end)
 
 option("xse_mmio", function()
     set_default(false)
-    set_description("enable mmio based address library support")
+    set_description("enable mmio based Address Library support")
     add_defines("XSE_MMIO_ADDRESSLIB=1")
 end)
 
 option("xse_xbyak", function()
     set_default(false)
-    set_description("enable xbyak support for trampoline")
+    set_description("enable xbyak support for Trampoline")
     add_defines("XSE_SUPPORT_XBYAK=1")
 end)