first commit

include/sp/misc/Format.h

@@ -0,0 +1,38 @@
+#pragma once
+
+/**
+ * \file Format.h
+ * \brief This file contains the definition of the `Format` function.
+ */
+
+#include <memory>
+#include <stdexcept>
+#include <string>
+
+namespace sp {
+namespace utils {
+
+/**
+ * \brief Formats a string using a format string and variadic arguments.
+ *
+ * This function takes a format string and a variable number of arguments and returns a formatted string.
+ * The format string can contain placeholders that will be replaced by the corresponding arguments.
+ *
+ * \param format The format string.
+ * \param args The variadic arguments to be formatted.
+ * \return The formatted string.
+ * \throws std::runtime_error if an error occurs during formatting.
+ */
+template <typename... Args>
+std::string Format(const std::string& format, Args... args) {
+	int size = snprintf(nullptr, 0, format.c_str(), args...) + 1;  // Extra space for '\0'
+	if (size <= 0) {
+		throw std::runtime_error("Error during formatting.");
+	}
+	std::unique_ptr<char[]> buf(new char[size]);
+	snprintf(buf.get(), static_cast<std::size_t>(size), format.c_str(), args...);
+	return std::string(buf.get(), buf.get() + size - 1);  // We don't want the '\0' inside
+}
+
+}  // namespace utils
+}  // namespace sp

include/sp/misc/Log.h

@@ -0,0 +1,32 @@
+#pragma once
+
+/**
+ * \file Log.h
+ * \brief File defining log functions
+ */
+
+#include <string>
+
+namespace sp {
+namespace utils {
+
+/**
+ * \brief Logs a normal message.
+ * \param msg The message to be logged.
+ */
+void LOG(const std::string& msg);
+
+/**
+ * \brief Logs a normal message in debug mode.
+ * \param msg The message to be logged.
+ */
+void LOGD(const std::string& msg);
+
+/**
+ * \brief Logs an error message.
+ * \param err The error message to be logged.
+ */
+void LOGE(const std::string& err);
+
+}  // namespace utils
+}  // namespace sp

include/sp/misc/Test.h

@@ -0,0 +1,70 @@
+#pragma once
+
+/**
+ * \file Test.h
+ * \brief File containing unit testing utilities
+ */
+
+#include <cstdlib>
+#include <sp/misc/Log.h>
+
+namespace sp {
+namespace test {
+
+/**
+ * \def SP_TEST_SUCCESSFUL
+ * \brief Used in tests to indicate that a test was successful
+ */
+#define SP_TEST_SUCCESSFUL 0
+
+/**
+ * \def SP_TEST_FAILED
+ * \brief Used in tests to indicate that a test failed
+ */
+#define SP_TEST_FAILED 1
+
+#ifndef __FUNCTION_NAME__
+#ifdef _WIN32
+#define __FUNCTION_NAME__ __FUNCTION__
+#else
+#define __FUNCTION_NAME__ __PRETTY_FUNCTION__
+#endif
+#endif
+
+/**
+ * \def blitz_test_assert
+ * \param ... The expression to evaluate
+ * \brief Evaluates the expression and exits the program if not valid.
+ * \note It works like a basic assert() but also in release mode
+ */
+#define sp_test_assert(...)                                                                                                           \
+	if (!static_cast<bool>(__VA_ARGS__)) {                                                                                            \
+		td::test::LogAssert(#__VA_ARGS__, __FILE__, __LINE__, __FUNCTION_NAME__);                                                     \
+		std::exit(SP_TEST_FAILED);                                                                                                    \
+	}
+
+
+/**
+ * \def blitz_debug_assert
+ * \param ... The expression to execute
+ * \brief Assertion without checks in release mode
+ * \note The expression is always executed. However, in release, no checks are made !
+ */
+#ifdef NDEBUG
+#define sp_debug_assert(...) __VA_ARGS__
+#else
+#define sp_debug_assert sp_test_assert
+#endif
+
+
+/**
+ * \brief Prints an error message associated with a failed assertion
+ * \param expression The expression that was tested
+ * \param file The file in which the assertion failed
+ * \param line The line in the file in which the assertion failed
+ * \param function The function in which the assertion failed
+ */
+void LogAssert(const char* expression, const char* file, int line, const char* function);
+
+}  // namespace test
+}  // namespace sp