Add external logger to the project

.github/workflows/cmake_install_macos.yml

@@ -27,5 +27,5 @@ jobs:
         touch test.cpp
         echo "#include <dsm/dsm.hpp>" >> test.cpp
         echo "int main() {}" >> test.cpp
-        g++ test.cpp -std=c++20 && echo "Compiled successfully" \
+        g++ test.cpp -std=c++20 -lspdlog && echo "Compiled successfully" \
                                 || (echo "Cannot include dsm" ; exit 1)

.github/workflows/cmake_test_macos.yml

@@ -12,7 +12,6 @@ env:
 jobs:
   build:
     runs-on: macos-latest
-
     steps:
     - uses: actions/checkout@v4
 

CMakeLists.txt

@@ -2,28 +2,35 @@ cmake_minimum_required(VERSION 3.16.0)
 
 project(dms VERSION 2.0.0 LANGUAGES CXX)
 
-# set the C++ standard
+# Set the C++ standard
 set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_CXX_EXTENSIONS OFF)
 
+include(FetchContent)
+# Get spdlog
+FetchContent_Declare(
+    spdlog
+    GIT_REPOSITORY https://github.com/gabime/spdlog.git
+    GIT_TAG v1.15.0
+)
+FetchContent_MakeAvailable(spdlog)
+
 file(GLOB SOURCES "src/dsm/headers/*.cpp")
 
 add_library(dsm STATIC ${SOURCES})
+
+target_link_libraries(dsm PUBLIC spdlog::spdlog)
+
 target_include_directories(dsm PUBLIC 
     $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/src/headers>
     $<INSTALL_INTERFACE:include>
 )
 
 install(TARGETS dsm
-		EXPORT dsmConfig
-		ARCHIVE DESTINATION lib
-		LIBRARY DESTINATION lib
-		RUNTIME DESTINATION bin)
-
-install(DIRECTORY ${PROJECT_SOURCE_DIR}/src/ DESTINATION ${CMAKE_INSTALL_PREFIX}/include)
+    EXPORT dsmConfig
+    ARCHIVE DESTINATION lib
+    LIBRARY DESTINATION lib
+    RUNTIME DESTINATION bin)
 
-install(EXPORT dsmConfig
-		FILE dsmConfig.cmake
-		NAMESPACE dsm::
-		DESTINATION lib/cmake/dsm)
+install(DIRECTORY ${PROJECT_SOURCE_DIR}/src/ DESTINATION ${CMAKE_INSTALL_PREFIX}/include)

README.md

@@ -7,28 +7,21 @@ This rework consists of a full code rewriting, in order to implement more featur
 
 ## Requirements
 
-The project only requires `C++20` or greater and `cmake`.
+This project requieres a compiler whith full support for `C++20` or greater and `cmake`.
+It also depends on [spdlog](https://github.com/gabime/spdlog).
 
 Utilities are written in python. To install their dependencies:
 ```shell
 pip install -r ./requirements.txt
 ```
 
 ## Installation
-The library can be installed using CMake. To build and install the project in the default folder run:
+The library can be installed using CMake.
+To build and install the project in the default folder run:
 ```shell
-cmake -B build && cmake --build build
+cmake -B build && make -C build
 sudo cmake --install build
 ```
-Otherwise, it is possible to customize the installation path:
-```shell
-cmake -B build -DCMAKE_INSTALL_PREFIX=/path/to/install
-```
-then building and installing it (eventually in sudo mode) with:
-```shell
-cmake --build build
-cmake --install build
-```
 
 ## Testing
 This project uses [Doctest](https://github.com/doctest/doctest) for testing.

benchmark/CMakeLists.txt

@@ -9,6 +9,15 @@ set(CMAKE_CXX_EXTENSIONS OFF)
 
 include_directories(../extern/benchmark/)
 
+include(FetchContent)
+# Get spdlog
+FetchContent_Declare(
+    spdlog
+    GIT_REPOSITORY https://github.com/gabime/spdlog.git
+    GIT_TAG v1.15.0
+)
+FetchContent_MakeAvailable(spdlog)
+
 # add subdirectories
 add_subdirectory(Graph)
 add_subdirectory(Street)

benchmark/Dynamics/CMakeLists.txt

@@ -13,6 +13,7 @@ set(EXECUTABLE_OUTPUT_PATH ../../)
 
 include_directories(../../src/dsm/headers)
 include_directories(../../src/dsm/utility/)
+include_directories(${spdlog_SOURCE_DIR}/include)
 
 file(GLOB SOURCES "../../src/dsm/headers/*.cpp")
 

benchmark/Graph/CMakeLists.txt

@@ -13,6 +13,7 @@ set(EXECUTABLE_OUTPUT_PATH ../../)
 
 include_directories(../../src/dsm/headers/)
 include_directories(../../src/dsm/utility/)
+include_directories(${spdlog_SOURCE_DIR}/include)
 
 file(GLOB SOURCES "../../src/dsm/headers/*.cpp")
 

benchmark/Street/CMakeLists.txt

@@ -13,6 +13,7 @@ set(EXECUTABLE_OUTPUT_PATH ../../)
 
 include_directories(../../src/dsm/headers)
 include_directories(../../src/dsm/utility/)
+include_directories(${spdlog_SOURCE_DIR}/include)
 
 file(GLOB SOURCES "../../src/dsm/headers/*.cpp")
 

examples/CMakeLists.txt

@@ -17,6 +17,15 @@ endif()
 # Set the folder for the executable
 set(EXECUTABLE_OUTPUT_PATH ../)
 
+include(FetchContent)
+# Get spdlog
+FetchContent_Declare(
+    spdlog
+    GIT_REPOSITORY https://github.com/gabime/spdlog.git
+    GIT_TAG v1.15.0
+)
+FetchContent_MakeAvailable(spdlog)
+
 # add as executable all cpp files into '.' folder
 file(GLOB SOURCES "*.cpp")
 file(GLOB SRC_SOURCES "../src/dsm/headers/*.cpp")
@@ -25,5 +34,5 @@ file(GLOB SRC_SOURCES "../src/dsm/headers/*.cpp")
 foreach(SOURCE ${SOURCES})
     get_filename_component(EXE_NAME ${SOURCE} NAME_WE)
 	add_executable(${EXE_NAME}.out ${SOURCE} ${SRC_SOURCES})
-    target_include_directories(${EXE_NAME}.out PRIVATE ../src/dsm/headers/ ../src/dsm/utility/TypeTraits/)
+    target_include_directories(${EXE_NAME}.out PRIVATE ../src/dsm/headers/ ../src/dsm/utility/TypeTraits/ ${spdlog_SOURCE_DIR}/include)
 endforeach()

profiling/CMakeLists.txt

@@ -13,13 +13,22 @@ string(APPEND CMAKE_CXX_FLAGS "-Wall -Wextra -Os")
 # Set the folder for the executable
 set(EXECUTABLE_OUTPUT_PATH ../)
 
+include(FetchContent)
+# Get spdlog
+FetchContent_Declare(
+    spdlog
+    GIT_REPOSITORY https://github.com/gabime/spdlog.git
+    GIT_TAG v1.15.0
+)
+FetchContent_MakeAvailable(spdlog)
+
 file(GLOB SOURCES "../src/dsm/headers/*.cpp")
 
 # Define the executable
 add_executable(prof.out main.cpp ${SOURCES})
-target_include_directories(prof.out PRIVATE ../src/)
+target_include_directories(prof.out PRIVATE ../src/ ${spdlog_SOURCE_DIR}/include)
 target_compile_options(prof.out PRIVATE -pg)
 target_link_options(prof.out PRIVATE -pg)
 add_executable(mem.out main.cpp ${SOURCES})
-target_include_directories(mem.out PRIVATE ../src/)
+target_include_directories(mem.out PRIVATE ../src/ ${spdlog_SOURCE_DIR}/include)
 add_executable(parse_massif.out parse_massif.cpp)

src/dsm/dsm.hpp

@@ -1,5 +1,4 @@
-#ifndef dsm_hpp
-#define dsm_hpp
+#pragma once
 
 #include <cstdint>
 #include <format>
@@ -27,5 +26,3 @@ namespace dsm {
 #include "utility/TypeTraits/is_node.hpp"
 #include "utility/TypeTraits/is_street.hpp"
 #include "utility/TypeTraits/is_numeric.hpp"
-
-#endif

src/dsm/headers/Agent.hpp

@@ -21,15 +21,18 @@
 #include <limits>
 #include <optional>
 
+#include <spdlog/spdlog.h>
+#include <spdlog/sinks/stdout_color_sinks.h>
+#include <spdlog/sinks/basic_file_sink.h>
+
 namespace dsm {
   /// @brief The Agent class represents an agent in the network.
-  /// @tparam Id, The type of the agent's id. It must be an unsigned integral type.
-  /// @tparam Size, The type of the size of a street. It must be an unsigned integral type.
   /// @tparam Delay, The type of the agent's delay. It must be a numeric type (see utility/TypeTraits/is_numeric.hpp).
   template <typename Delay>
     requires(is_numeric_v<Delay>)
   class Agent {
   private:
+    inline static auto const pConsoleLogger{spdlog::stdout_color_mt("DSM_AGENT_CONSOLE")};
     Id m_id;
     Id m_itineraryId;
     std::optional<Id> m_streetId;
@@ -63,11 +66,9 @@ namespace dsm {
     /// @throw std::invalid_argument, if speed is negative
     void setSpeed(double speed);
     /// @brief Increment the agent's delay by 1
-    /// @throw std::overflow_error, if delay has reached its maximum value
     void incrementDelay();
     /// @brief Increment the agent's delay by a given value
     /// @param delay The agent's delay
-    /// @throw std::overflow_error, if delay has reached its maximum value
     void incrementDelay(Delay const delay);
     /// @brief Decrement the agent's delay by 1
     /// @throw std::underflow_error, if delay has reached its minimum value
@@ -78,12 +79,10 @@ namespace dsm {
     /// @param distance The value to increment the agent's distance byù
     /// @throw std::invalid_argument, if distance is negative
     void incrementDistance(double distance);
-    /// @brief Increment the agent's time by 1
-    /// @throw std::overflow_error, if time has reached its maximum value
+    /// @brief Increment the agent's time by 1.
     void incrementTime();
-    /// @brief Increment the agent's time by a given value
+    /// @brief Increment the agent's time by a given value.
     /// @param time The value to increment the agent's time by
-    /// @throw std::overflow_error, if time has reached its maximum value
     void incrementTime(unsigned int const time);
     /// @brief Reset the agent's time to 0
     void resetTime() { m_time = 0; }
@@ -147,15 +146,19 @@ namespace dsm {
     requires(is_numeric_v<Delay>)
   void Agent<Delay>::incrementDelay() {
     if (m_delay == std::numeric_limits<Delay>::max()) {
-      throw std::overflow_error(buildLog("Delay has reached its maximum value"));
+      pConsoleLogger->critical(
+          "Agent {} delay has reached its maximum value ({}).", m_id, m_delay);
+      std::abort();
     }
     ++m_delay;
   }
   template <typename Delay>
     requires(is_numeric_v<Delay>)
   void Agent<Delay>::incrementDelay(Delay const delay) {
     if (m_delay + delay < m_delay) {
-      throw std::overflow_error(buildLog("Delay has reached its maximum value"));
+      pConsoleLogger->critical(
+          "Agent {} delay has reached its maximum value ({}).", m_id, m_delay);
+      std::abort();
     }
     m_delay += delay;
   }
@@ -181,15 +184,19 @@ namespace dsm {
     requires(is_numeric_v<Delay>)
   void Agent<Delay>::incrementTime() {
     if (m_time == std::numeric_limits<unsigned int>::max()) {
-      throw std::overflow_error(buildLog("Time has reached its maximum value"));
+      pConsoleLogger->critical(
+          "Agent {} time has reached its maximum value ({}).", m_id, m_time);
+      std::abort();
     }
     ++m_time;
   }
   template <typename Delay>
     requires(is_numeric_v<Delay>)
   void Agent<Delay>::incrementTime(unsigned int const time) {
     if (m_time + time < m_time) {
-      throw std::overflow_error(buildLog("Time has reached its maximum value"));
+      pConsoleLogger->critical(
+          "Agent {} time has reached its maximum value ({}).", m_id, m_time);
+      std::abort();
     }
     m_time += time;
   }