Merge pull request #71 from SLM-Audio/syl/logging

Add logging, and document

Author: MeijisIrlnd

include/mostly_harmless/CMakeLists.txt

@@ -26,6 +26,7 @@ set(MOSTLYHARMLESS_HEADERS
         ${CMAKE_CURRENT_SOURCE_DIR}/utils/mostlyharmless_OnScopeExit.h
         ${CMAKE_CURRENT_SOURCE_DIR}/utils/mostlyharmless_Proxy.h
         ${CMAKE_CURRENT_SOURCE_DIR}/utils/mostlyharmless_NoDenormals.h
+        ${CMAKE_CURRENT_SOURCE_DIR}/utils/mostlyharmless_Logging.h
         ${CMAKE_CURRENT_SOURCE_DIR}/data/mostlyharmless_DatabaseState.h
         ${CMAKE_CURRENT_SOURCE_DIR}/data/mostlyharmless_DatabasePropertyWatcher.h
         ${PLATFORM_HEADERS}

include/mostly_harmless/utils/mostlyharmless_Logging.h

@@ -0,0 +1,33 @@
+//
+// Created by sylmo on 05/10/2025.
+//
+
+#ifndef MOSTLYHARMLESS_LOGGING_H
+#define MOSTLYHARMLESS_LOGGING_H
+#include <filesystem>
+namespace mostly_harmless::utils {
+    /***
+     * \brief Helper class for logging to a file.
+     */
+    class Logging final {
+    public:
+        /**
+         * Constructor - if logFile doesn't already exist, creates it. Writes a newline specifying that logging has been started, to distinguish between multiple sessions with this file
+         * @param logFile The destination file for your logging output to be written to
+         */
+        explicit Logging(std::filesystem::path logFile);
+        /**
+         * Destructor - Writes a newline specifying that logging has been ended, to distinguish between multiple sessions with this file.
+         */
+        ~Logging() noexcept;
+
+        /**
+         * Writes some text to your file, followed by a newline.
+         * @param toDump The text to dump to the log file
+         */
+        auto dump(std::string_view toDump) const noexcept -> void;
+    private:
+        std::filesystem::path m_logFile;
+    };
+}
+#endif //MOSTLYHARMLESS_LOGGING_H

source/CMakeLists.txt

@@ -32,6 +32,7 @@ set(MOSTLYHARMLESS_SOURCES
         ${CMAKE_CURRENT_SOURCE_DIR}/utils/mostlyharmless_NoDenormals.cpp
         ${CMAKE_CURRENT_SOURCE_DIR}/utils/mostlyharmless_Hash.cpp
         ${CMAKE_CURRENT_SOURCE_DIR}/utils/mostlyharmless_Macros.cpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/utils/mostlyharmless_Logging.cpp
         ${CMAKE_CURRENT_SOURCE_DIR}/data/mostlyharmless_DatabaseState.cpp
         ${CMAKE_CURRENT_SOURCE_DIR}/data/mostlyharmless_DatabasePropertyWatcher.cpp
         ${PLATFORM_SOURCES}

source/utils/mostlyharmless_Logging.cpp

@@ -0,0 +1,36 @@
+//
+// Created by sylmo on 05/10/2025.
+//
+#include <mostly_harmless/utils/mostlyharmless_Logging.h>
+#include <mostly_harmless/utils/mostlyharmless_OnScopeExit.h>
+
+#include <utility>
+#include <fstream>
+
+namespace mostly_harmless::utils {
+    Logging::Logging(std::filesystem::path logFile) : m_logFile(std::move(logFile)) {
+
+        auto writeMode = std::ios::out;
+        if(std::filesystem::exists(m_logFile)) {
+            writeMode |= std::ios::app;
+        }
+        std::ofstream outputFile{ m_logFile, writeMode };
+        outputFile << "------ START LOG ------ \n";
+        outputFile.flush();
+    }
+
+    Logging::~Logging() noexcept {
+        dump("------ END LOG ------ \n");
+    }
+
+    auto Logging::dump(std::string_view toDump) const noexcept -> void {
+        try {
+            std::ofstream outStream{ m_logFile, std::ios::app | std::ios::out };
+            outStream << toDump << "\n";
+            outStream.flush();
+        } catch (...) {
+        }
+    }
+
+
+} // namespace mostly_harmless::utils