feat(liblogging): added working build system and other requirments to break out liblogging

src/logging/include/logging.h

@@ -0,0 +1,96 @@
+/* ***********************************************************************
+//
+//   Copyright (C) 2025 -- The 4D-STAR Collaboration
+//   File Author: Emily Boudreaux
+//   Last Modified: April 03, 2025
+//
+//   liblogging is free software; you can use it and/or modify
+//   it under the terms and restrictions the GNU General Library Public
+//   License version 3 (GPLv3) as published by the Free Software Foundation.
+//
+//   liblogging is distributed in the hope that it will be useful,
+//   but WITHOUT ANY WARRANTY; without even the implied warranty of
+//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+//   See the GNU Library General Public License for more details.
+//
+//   You should have received a copy of the GNU Library General Public License
+//   along with this software; if not, write to the Free Software
+//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+//
+// *********************************************************************** */
+//=== Probe.h ===
+#pragma once
+
+#include <string>
+#include <map>
+#include <vector>
+#include <utility>
+
+#include "quill/Logger.h"
+
+/**
+ * @brief The Probe namespace contains utility functions for debugging and logging.
+ */
+namespace fourdst::logging {
+  /**
+   * @brief Class to manage logging operations.
+   */
+  class LogManager {
+  private:
+      /**
+       * @brief Private constructor for singleton pattern.
+       */
+      LogManager();
+
+      /**
+       * @brief Destructor.
+       */
+      ~LogManager();
+
+      // Map to store pointers to quill loggers (raw pointers as quill deals with its own memory managment in a seperated, detatched, thread)
+      std::map<std::string, quill::Logger*> loggerMap;
+
+      // Prevent copying and assignment (Rule of Zero)
+      LogManager(const LogManager&) = delete;
+      LogManager& operator=(const LogManager&) = delete;
+
+  public:
+      /**
+       * @brief Get the singleton instance of LogManager.
+       * @return The singleton instance of LogManager.
+       */
+      static LogManager& getInstance() {
+          static LogManager instance;
+          return instance;
+      }
+
+      /**
+       * @brief Get a logger by name.
+       * @param loggerName The name of the logger.
+       * @return A pointer to the logger.
+       */
+      quill::Logger* getLogger(const std::string& loggerName);
+
+      /**
+       * @brief Get the names of all loggers.
+       * @return A vector of logger names.
+       */
+      std::vector<std::string> getLoggerNames();
+
+      /**
+       * @brief Get all loggers.
+       * @return A vector of pointers to the loggers.
+       */
+      std::vector<quill::Logger*> getLoggers();
+
+      /**
+       * @brief Create a new file logger.
+       * @param filename The name of the log file.
+       * @param loggerName The name of the logger.
+       * @return A pointer to the new logger.
+       */
+      quill::Logger* newFileLogger(const std::string& filename,
+                                  const std::string& loggerName);
+  };
+
+} // namespace Probe

src/logging/lib/logging.cpp

@@ -0,0 +1,98 @@
+/* ***********************************************************************
+//
+//   Copyright (C) 2025 -- The 4D-STAR Collaboration
+//   File Author: Emily Boudreaux
+//   Last Modified: March 18, 2025
+//
+//   liblogging is free software; you can use it and/or modify
+//   it under the terms and restrictions the GNU General Library Public
+//   License version 3 (GPLv3) as published by the Free Software Foundation.
+//
+//   liblogging is distributed in the hope that it will be useful,
+//   but WITHOUT ANY WARRANTY; without even the implied warranty of
+//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+//   See the GNU Library General Public License for more details.
+//
+//   You should have received a copy of the GNU Library General Public License
+//   along with this software; if not, write to the Free Software
+//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+//
+// *********************************************************************** */
+#include "quill/Backend.h"
+#include "quill/Frontend.h"
+#include "quill/Logger.h"
+#include "quill/sinks/ConsoleSink.h"
+#include "quill/sinks/FileSink.h" 
+#include "quill/LogMacros.h"
+
+#include <stdexcept>              
+#include <string>
+#include <iostream>
+#include <chrono>
+#include <cmath>
+#include <vector>
+#include <utility>
+#include <filesystem>
+
+#include "logging.h"
+
+
+namespace fourdst::logging {
+
+LogManager::LogManager() {
+  quill::Backend::start();
+  auto CLILogger = quill::Frontend::create_or_get_logger(
+      "root",
+      quill::Frontend::create_or_get_sink<quill::ConsoleSink>("sink_id_1"));
+
+  newFileLogger("fourdst.log", "log");
+  loggerMap.emplace("stdout", CLILogger);
+}
+
+LogManager::~LogManager() = default;
+
+quill::Logger* LogManager::getLogger(const std::string& loggerName) {
+  auto it = loggerMap.find(loggerName); // Find *once*
+  if (it == loggerMap.end()) {
+    throw std::runtime_error("Cannot find logger " + loggerName);
+  }
+  return it->second; // Return the raw pointer from the shared_ptr
+}
+
+std::vector<std::string> LogManager::getLoggerNames() {
+  std::vector<std::string> loggerNames;
+  loggerNames.reserve(loggerMap.size());
+  for (const auto& pair : loggerMap) { // Use range-based for loop and const auto&
+    loggerNames.push_back(pair.first);
+  }
+  return loggerNames;
+}
+
+std::vector<quill::Logger*> LogManager::getLoggers() {
+  std::vector<quill::Logger*> loggers;
+  loggers.reserve(loggerMap.size());
+  for (const auto& pair : loggerMap) {
+     loggers.push_back(pair.second); // Get the raw pointer
+  }
+  return loggers;
+}
+
+quill::Logger* LogManager::newFileLogger(const std::string& filename,
+                                        const std::string& loggerName) {
+  auto file_sink = quill::Frontend::create_or_get_sink<quill::FileSink>(
+      filename,
+      []() {
+        quill::FileSinkConfig cfg;
+        cfg.set_open_mode('w');
+        return cfg;
+      }(),
+      quill::FileEventNotifier{});
+  // Get the raw pointer.
+  quill::Logger* rawLogger = quill::Frontend::create_or_get_logger(loggerName, std::move(file_sink));
+
+  // Create a shared_ptr from the raw pointer.
+  loggerMap.emplace(loggerName, rawLogger);
+  return rawLogger;
+}
+
+} // namespace Probe

src/logging/meson.build

@@ -0,0 +1,45 @@
+# ***********************************************************************
+#
+#   Copyright (C) 2025 -- The 4D-STAR Collaboration
+#   File Author: Emily Boudreaux
+#   Last Modified: March 19, 2025
+#
+#   liblogging is free software; you can use it and/or modify
+#   it under the terms and restrictions the GNU General Library Public
+#   License version 3 (GPLv3) as published by the Free Software Foundation.
+#
+#   liblogging is distributed in the hope that it will be useful,
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+#   See the GNU Library General Public License for more details.
+#
+#   You should have received a copy of the GNU Library General Public License
+#   along with this software; if not, write to the Free Software
+#   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+#
+# *********************************************************************** #
+logging_sources = files(
+  'lib/logging.cpp',
+)
+
+logging_headers = files(
+  'include/logging.h'
+)
+
+dependencies = [
+    quill_dep,
+]
+
+liblogging = library('logging',
+    logging_sources, 
+    include_directories: include_directories('include'),
+    cpp_args: ['-fvisibility=default'],
+    install : true,
+    dependencies: dependencies
+    )
+
+logging_dep = declare_dependency(
+    include_directories: include_directories('include'),
+    link_with: liblogging,
+    dependencies: dependencies
+)