Merge pull request #101 from AGH-Code-Industry/twarug/exceptions

Refactor Archimedes Exceptions

include/Exception.h

@@ -1,20 +1,61 @@
 #pragma once
 
 #include <exception>
-#include <string>
+#include <source_location>
+
+#include "Logger.h"
 
 namespace arch {
 
+/// Base class for all exceptions in the project.
+/// Do not use this class directly, use derived classes instead. (@see InitException)
+///
 class Exception: public std::exception {
+protected:
+
+	/// Constructor.
+	/// @param title Title of the exception.
+	/// @param location Source location of the exception.
+	///
+	Exception(const std::string& title, const std::source_location& location);
+
+	/// Constructor.
+	/// @param title Title of the exception.
+	/// @param message Message of the exception.
+	/// @param location Source location of the exception.
+	///
+	Exception(const std::string& title, const std::string& message, const std::source_location& location);
+
 public:
-	Exception(const std::string& title);
+	/// print the exception to the console.
+	/// @param level Log level of the exception.
+	///
+	void print(LogLevel level = LogLevel::error) const;
+
+	// Inherited form std::exception Get Exception message.
+	/// @return Exception message.
+	///
 	const char* what() const noexcept override;
 
-protected:
-	void _appendMsg(const std::string& msg);
+	/// Get the title of the exception.
+	/// @return Title of the exception.
+	///
+	std::string_view title() const;
+
+	/// Get the message of the exception.
+	/// @return Message of the exception.
+	///
+	std::string_view message() const;
 
-private:
-	std::string _msg;
+	/// Get the source location of the exception.
+	/// @return Source location of the exception.
+	///
+	const std::source_location& location() const;
+
+protected:
+	std::string _title;
+	std::string _message;
+	std::source_location _location;
 };
 
 } // namespace arch

include/exceptions/ConfigException.h

@@ -1,18 +1,21 @@
 #pragma once
 
-#include <exception>
 #include <string>
 
+#include "Exception.h"
+
 namespace arch {
 
-class ConfigException: public std::exception {
+/// Exception thrown when an error occurs during loading of configuration.
+/// @see Exception
+///
+class ConfigException final: public Exception {
 public:
-	explicit ConfigException(const std::string& message = "");
-
-	[[nodiscard]] const char* what() const noexcept override;
-
-private:
-	std::string _message;
+	/// Constructor.
+	/// @param message Message of the exception.
+	/// @param location Source location of the exception.
+	///
+	ConfigException(const std::string& message, const std::source_location& location = std::source_location::current());
 };
 
 } // namespace arch

include/exceptions/GLFWException.h

@@ -4,9 +4,14 @@
 
 namespace arch {
 
-class GLFWException: public Exception {
+/// Exception thrown when an error occurs in GLFW.
+/// @see Exception
+///
+class GLFWException final: public Exception {
 public:
-	GLFWException();
+	/// Constructor.
+	/// @param location Source location of the exception.
+	GLFWException(const std::source_location& location = std::source_location::current());
 };
 
 } // namespace arch

include/exceptions/InitException.h

@@ -1,18 +1,21 @@
 #pragma once
 
-#include <exception>
 #include <string>
 
+#include "Exception.h"
+
 namespace arch {
 
-class InitException: public std::exception {
+/// Exception thrown when an error occurs during initialization.
+/// @see Exception
+///
+class InitException final: public Exception {
 public:
-	explicit InitException(const std::string& message = "");
-
-	[[nodiscard]] const char* what() const noexcept override;
-
-private:
-	std::string _message;
+	/// Constructor.
+	/// @param message Message of the exception.
+	/// @param location Source location of the exception.
+	///
+	InitException(const std::string& message, const std::source_location& location = std::source_location::current());
 };
 
 } // namespace arch

include/net/NetException.h

@@ -4,11 +4,19 @@
 
 namespace arch::net {
 
+/// Exception thrown when an error occurs in networking.
+/// @see Exception
+///
 class NetException: public Exception {
 public:
-	NetException(const std::string& title);
+	/// Constructor.
+	/// @param message Title of the exception.
+	/// @param location Source location of the exception.
+	///
+	NetException(const std::string& message, const std::source_location& location = std::source_location::current());
 };
 
+// Alias for ease of use.
 using Exception = NetException;
 
 } // namespace arch::net

src/Engine.cpp

@@ -16,14 +16,16 @@ Engine::~Engine() {
 }
 
 void Engine::start() {
-	_initialize();
-
 	try {
+		_initialize();
+
 		_mainLoop();
+	} catch (Exception& e) {
+		e.print();
 	} catch (std::exception& e) {
 		Logger::error("Crashed with exception: {}", e.what());
 	} catch (...) {
-		Logger::error("Dupa");
+		Logger::error("Unhandled exception occurred");
 	}
 }
 
@@ -57,8 +59,8 @@ void Engine::_mainLoop() {
 	};
 
 	std::vector<Vertex> vertices{
-		{  float3(0.5f,  0.5f, 0.0f), {}, float2(1.0f, 1.0f) },
-		{  float3(0.5f, -0.5f, 0.0f), {}, float2(1.0f, 0.0f) },
+		{ float3(0.5f,  0.5f, 0.0f), {}, float2(1.0f, 1.0f) },
+		{ float3(0.5f, -0.5f, 0.0f), {}, float2(1.0f, 0.0f) },
 		{ float3(-0.5f, -0.5f, 0.0f), {}, float2(0.0f, 0.0f) },
 		{ float3(-0.5f,	0.5f, 0.0f), {}, float2(0.0f, 1.0f) }
 	};

src/Exception.cpp

@@ -2,16 +2,33 @@
 
 namespace arch {
 
-Exception::Exception(const std::string& title): _msg(title) {
-	_msg.append(": ");
+Exception::Exception(const std::string& title, const std::source_location& location):
+	_title(title),
+	_location(location) {}
+
+Exception::Exception(const std::string& title, const std::string& message, const std::source_location& location):
+	_title(title),
+	_message(message),
+	_location(location) {}
+
+void Exception::print(LogLevel level) const {
+	Logger::log<const std::string&, const std::string&>(level, "[{}]: {}", _title, _message, _location);
 }
 
 const char* Exception::what() const noexcept {
-	return _msg.c_str();
+	return _message.c_str();
+}
+
+std::string_view Exception::title() const {
+	return _title;
+}
+
+std::string_view Exception::message() const {
+	return _message;
 }
 
-void Exception::_appendMsg(const std::string& msg) {
-	_msg.append(msg);
+const std::source_location& Exception::location() const {
+	return _location;
 }
 
 } // namespace arch

src/Logger.cpp

@@ -28,6 +28,7 @@ void Logger::init(LogLevel logLevel, const std::string& name) {
 	{
 		// Add a file sink
 		char logPath[256];
+		// ReSharper disable once CppRedundantCastExpression
 		std::snprintf(logPath, sizeof(logPath), "Logs/%s-%lld.log", name.c_str(), (long long)std::time(nullptr));
 
 		auto sink = std::make_shared<spdlog::sinks::basic_file_sink_mt>(logPath, true);

src/exceptions/ConfigException.cpp

@@ -2,12 +2,7 @@
 
 namespace arch {
 
-ConfigException::ConfigException(const std::string& message) {
-	_message = "Failed load configuration file: " + message;
-}
-
-const char* ConfigException::what() const noexcept {
-	return _message.c_str();
-}
+ConfigException::ConfigException(const std::string& message, const std::source_location& location):
+	Exception("Config", message, location) {}
 
 } // namespace arch

src/exceptions/GLFWException.cpp

@@ -4,13 +4,10 @@
 
 namespace arch {
 
-GLFWException::GLFWException(): Exception("GLFW") {
+GLFWException::GLFWException(const std::source_location& location): Exception("GLFW", location) {
 	const char* description;
 	int code = glfwGetError(&description);
-	_appendMsg("code ");
-	_appendMsg(std::to_string(code));
-	_appendMsg(" description ");
-	_appendMsg(description);
+	_message = "(Code: " + std::to_string(code) + "): " + description;
 }
 
 } // namespace arch

src/exceptions/InitException.cpp

@@ -2,12 +2,7 @@
 
 namespace arch {
 
-InitException::InitException(const std::string& message) {
-	_message = "Failed while initialization: " + message;
-}
-
-const char* InitException::what() const noexcept {
-	return _message.c_str();
-}
+InitException::InitException(const std::string& message, const std::source_location& location):
+	Exception("Init", message, location) {}
 
 } // namespace arch

src/net/NetException.cpp

@@ -2,6 +2,7 @@
 
 namespace arch::net {
 
-NetException::NetException(const std::string& title): Exception("Network submodule error: " + title) {}
+NetException::NetException(const std::string& message, const std::source_location& location):
+	Exception("Network", message, location) {}
 
 } // namespace arch::net