update dependencies and cleanup

Signed-off-by: Mark Burton <[email protected]>

Author: markfoodyburton

.clang-format

@@ -2,7 +2,7 @@
 Language: Cpp
 BasedOnStyle: Google
 
-ColumnLimit: 79
+ColumnLimit: 120
 UseTab: Never
 IndentWidth: 4
 IndentCaseLabels: false
@@ -17,19 +17,23 @@ AlignConsecutiveMacros: true
 AlignConsecutiveAssignments: false
 
 AllowAllArgumentsOnNextLine: false
-AllowShortFunctionsOnASingleLine: InlineOnly
-AllowShortIfStatementsOnASingleLine: Never
-AllowShortLoopsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: true
+AllowShortIfStatementsOnASingleLine: WithoutElse
+AllowShortLoopsOnASingleLine: true
+AllowShortLambdasOnASingleLine: true
 
-BreakConstructorInitializers: AfterColon
+BreakConstructorInitializers: BeforeComma
 BreakBeforeBinaryOperators: None
 BreakStringLiterals: true
 BreakBeforeBraces: Custom
 BraceWrapping:
   AfterClass: true
+  AfterFunction: true
+# PackConstructorInitializers: Never # When we have clang14
 
 SpaceBeforeCtorInitializerColon: false
 SpacesBeforeTrailingComments: 1
+AlignTrailingComments: true
 
 SortIncludes: false
 SortUsingDeclarations: false

examples/smoke.cc

@@ -48,7 +48,8 @@ SC_MODULE (test) {
     }
 };
 
-int sc_main(int argc, char** argv) {
+int sc_main(int argc, char** argv)
+{
     SCP_INFO() << "Constructing design";
     test test1("test");
     SCP_INFO() << "Starting simulation";

examples/smoke_logger.cc

@@ -16,6 +16,7 @@
 #include <scp/tlm_extensions/initiator_id.h>
 #include <scp/tlm_extensions/path_trace.h>
 #include <scp/logger.h>
+#include <scp/report_cci_setter.h>
 
 #include <systemc>
 #include <tlm>
@@ -48,7 +49,8 @@ SC_MODULE (test3) {
 };
 
 SC_MODULE (test2) {
-    SC_CTOR (test2) : t31("t3_1"), t32("t3_2"), t4("t4") {
+    SC_CTOR (test2) : t31("t3_1"), t32("t3_2"), t4("t4")
+        {
             SCP_INFO(()) << "  T2 Logger()";
             SCP_WARN(()) << "  T2 Logger()";
         }
@@ -58,7 +60,8 @@ SC_MODULE (test2) {
 };
 
 SC_MODULE (test1) {
-    SC_CTOR (test1) : t2("t2") {
+    SC_CTOR (test1) : t2("t2")
+        {
             SCP_WARN((), "My.Name") << " T1 My.Name typed log";
             SCP_INFO(()) << " T1 Logger()";
             SCP_WARN(()) << " T1 Logger()";
@@ -81,7 +84,8 @@ class outside_class
     SCP_LOGGER("out.class", "thing1");
 
 public:
-    outside_class() {
+    outside_class()
+    {
         SCP_INFO(())("constructor");
         SCP_WARN(())("constructor");
     }
@@ -119,8 +123,7 @@ SC_MODULE (test) {
         SCP_INFO() << "Globally cached version empty";
         SCP_INFO(())("FMT String : Locally cached version default");
         SCP_INFO(SCMOD) << "Globally cached version feature using SCMOD macro";
-        SCP_INFO((m_my_logger))
-            << "Locally cached version using (m_my_logger)";
+        SCP_INFO((m_my_logger)) << "Locally cached version using (m_my_logger)";
         SCP_INFO((D)) << "Locally cached version with D";
     }
 
@@ -130,7 +133,8 @@ SC_MODULE (test) {
     SCP_LOGGER((D), "other", "feature.one");
 };
 
-int sc_main(int argc, char** argv) {
+int sc_main(int argc, char** argv)
+{
     cci_utils::consuming_broker broker("global_broker");
     cci_register_broker(broker);
     cci::cci_originator orig("config");
@@ -142,16 +146,15 @@ int sc_main(int argc, char** argv) {
     broker.set_preset_cci_value("test4.log_level", cci::cci_value(4), orig);
     broker.set_preset_cci_value("thing1.log_level", cci::cci_value(5), orig);
 
-    std::string logfile = "/tmp/scp_smoke_report_test." +
-                          std::to_string(getpid());
-    scp::init_logging(
-        scp::LogConfig()
-            .logLevel(scp::log::DEBUG) // set log level to debug
-            .msgTypeFieldWidth(20)
-            .fileInfoFrom(5)
-            .logAsync(false)
-            .printSimTime(false)
-            .logFileName(logfile)); // make the msg type column a bit tighter
+    std::string logfile = "/tmp/scp_smoke_report_test." + std::to_string(getpid());
+    scp::scp_logger_from_cci cci_logger;
+    scp::init_logging(scp::LogConfig()
+                          .logLevel(scp::log::DEBUG) // set log level to debug
+                          .msgTypeFieldWidth(20)
+                          .fileInfoFrom(5)
+                          .logAsync(false)
+                          .printSimTime(false)
+                          .logFileName(logfile)); // make the msg type column a bit tighter
     SCP_INFO() << "Constructing design";
     test toptest("top");
     test1 t1("t1");
@@ -203,8 +206,7 @@ int sc_main(int argc, char** argv) {
 )";
 
     std::ifstream lf(logfile);
-    std::string out((std::istreambuf_iterator<char>(lf)),
-                    std::istreambuf_iterator<char>());
+    std::string out((std::istreambuf_iterator<char>(lf)), std::istreambuf_iterator<char>());
 
     std::cout << "out file\n" << out << "\n";
     std::cout << "expected\n" << expected << "\n";

examples/smoke_report.cc

@@ -47,7 +47,8 @@ SC_MODULE (test3) {
 };
 
 SC_MODULE (test2) {
-    SC_CTOR (test2) : t31("t3_1"), t32("t3_2"), t4("t4") {
+    SC_CTOR (test2) : t31("t3_1"), t32("t3_2"), t4("t4")
+        {
             SCP_INFO(()) << "  T2 Logger()";
             SCP_WARN(()) << "  T2 Logger()";
         }
@@ -57,7 +58,8 @@ SC_MODULE (test2) {
 };
 
 SC_MODULE (test1) {
-    SC_CTOR (test1) : t2("t2") {
+    SC_CTOR (test1) : t2("t2")
+        {
             SCP_WARN((), "My.Name") << " T1 My.Name typed log";
             SCP_INFO(()) << " T1 Logger()";
             SCP_WARN(()) << " T1 Logger()";
@@ -80,7 +82,8 @@ class outside_class
     SCP_LOGGER("out.class", "thing1");
 
 public:
-    outside_class() {
+    outside_class()
+    {
         SCP_INFO(())("constructor");
         SCP_WARN(())("constructor");
     }
@@ -128,7 +131,8 @@ SC_MODULE (test) {
     SCP_LOGGER((D), "other", "feature.one");
 };
 
-int sc_main(int argc, char** argv) {
+int sc_main(int argc, char** argv)
+{
     cci_utils::consuming_broker broker("global_broker");
     cci_register_broker(broker);
     cci::cci_originator orig("config");
@@ -140,8 +144,7 @@ int sc_main(int argc, char** argv) {
     broker.set_preset_cci_value("test4.log_level", cci::cci_value(4), orig);
     broker.set_preset_cci_value("thing1.log_level", cci::cci_value(5), orig);
 
-    std::string logfile = "/tmp/scp_smoke_report_test." +
-                          std::to_string(getpid());
+    std::string logfile = "/tmp/scp_smoke_report_test." + std::to_string(getpid());
     SCP_INFO() << "Constructing design";
     test toptest("top");
     test1 t1("t1");

report/CMakeLists.txt

@@ -8,15 +8,13 @@ set(GITHUB "https://github.com/" CACHE STRING "github base url")
 include(FetchContent)
 include(CTest)
 
-FetchContent_Declare(
-  cpm-cmake
-  GIT_REPOSITORY ${GITHUB}cpm-cmake/CPM.cmake.git
-  GIT_SHALLOW True
-  GIT_TAG v0.31.1
+# download CPM.cmake
+file(
+  DOWNLOAD
+  https://github.com/cpm-cmake/CPM.cmake/releases/download/v0.40.2/CPM.cmake
+  ${CMAKE_CURRENT_BINARY_DIR}/cmake/CPM.cmake
 )
-
-FetchContent_MakeAvailable(cpm-cmake)
-include(${cpm-cmake_SOURCE_DIR}/cmake/CPM.cmake)
+include(${CMAKE_CURRENT_BINARY_DIR}/cmake/CPM.cmake)
 
 cpmaddpackage("${GITHUB}TheLartians/[email protected]")
 
@@ -60,25 +58,25 @@ if(WITH_FMT)
     NAME fmt
     GIT_REPOSITORY ${GITHUB}fmtlib/fmt.git
     GIT_SHALLOW True
-    GIT_TAG 9.1.0
+    GIT_TAG 11.0.2
     OPTIONS FMT_INSTALL "" ON
   )
 endif()
 
 FetchContent_Declare(
   spdlog_git
   GIT_REPOSITORY "https://github.com/gabime/spdlog.git"
-  GIT_TAG "v1.9.2"
+  GIT_TAG "v1.15.0"
   GIT_SHALLOW ON
 )
-FetchContent_Populate(spdlog_git)
+FetchContent_MakeAvailable(spdlog_git)
 FetchContent_GetProperties(
   spdlog_git
   SOURCE_DIR spdlog_git_SRC_DIR
   POPULATED spdlog_git_FOUND
 )
 
-add_library(${PROJECT_NAME} src/report.cpp src/logger.cpp)
+add_library(${PROJECT_NAME} src/sc_report.cpp src/logger.cpp)
 target_include_directories(
   ${PROJECT_NAME} PUBLIC
   $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>
@@ -92,18 +90,17 @@ endif()
 target_include_directories(${PROJECT_NAME} PRIVATE ${spdlog_git_SRC_DIR}/include)
 
 if(TARGET SystemC::cci)
-  target_compile_definitions(${PROJECT_NAME} PRIVATE HAS_CCI)
   target_link_libraries(${PROJECT_NAME} PUBLIC SystemC::cci)
 endif()
 
 target_link_libraries(${PROJECT_NAME} PUBLIC SystemC::systemc)
 set_target_properties(${PROJECT_NAME} PROPERTIES LINKER_LANGUAGE CXX)
 
 # No tests yet. WIP.
-# if(BUILD_TESTING AND ("${PROJECT_NAME}" STREQUAL "${CMAKE_PROJECT_NAME}"))
-# enable_testing()
-# add_subdirectory(tests)
-# endif()
+if(BUILD_TESTING AND ("${PROJECT_NAME}" STREQUAL "${CMAKE_PROJECT_NAME}"))
+enable_testing()
+add_subdirectory(tests)
+endif()
 add_library("scp::report::lib${PROJECT_NAME}" ALIAS ${PROJECT_NAME})
 packageproject(
   NAME "${PROJECT_NAME}"

report/include/scp/helpers.h

@@ -22,7 +22,8 @@
 #include <tlm>
 
 namespace scp {
-static std::string scp_txn_tostring(tlm::tlm_generic_payload& trans) {
+static std::string scp_txn_tostring(tlm::tlm_generic_payload& trans)
+{
     std::stringstream info;
     const char* cmd = "UNKOWN";
     switch (trans.get_command()) {
@@ -42,8 +43,7 @@ static std::string scp_txn_tostring(tlm::tlm_generic_payload& trans) {
     unsigned char* ptr = trans.get_data_ptr();
     info << " data: 0x";
     for (int i = trans.get_data_length(); i; i--) {
-        info << std::setw(2) << std::setfill('0') << std::hex
-             << (unsigned int)(ptr[i - 1]);
+        info << std::setw(2) << std::setfill('0') << std::hex << (unsigned int)(ptr[i - 1]);
     }
     info << " status: " << trans.get_response_string() << " ";
     for (unsigned int i = 0; i < tlm::max_num_extensions(); i++) {

report/include/scp/logger.h

@@ -34,8 +34,7 @@ namespace scp {
  * @param type_field_width the with of the type field in the output
  * @param print_time whether to print the system time stamp
  */
-void init_logging(log level = log::WARNING, unsigned type_field_width = 24,
-                  bool print_time = false);
+void init_logging(log level = log::WARNING, unsigned type_field_width = 24, bool print_time = false);
 /**
  * @fn void init_logging(log=log::WARNING, unsigned=24, bool=false)
  * @brief initializes the SystemC logging system with a particular logging

report/include/scp/report.h

@@ -1,5 +1,32 @@
-/* this is merely a convenience */
+/* this is merely a convenience to maintain the old API's */
 
 #include "scp/sc_report.h"
 #include "scp/helpers.h"
 #include "scp/logger.h"
+
+#ifdef FMT_SHARED
+#ifndef _FMT_CONVENIENCE_DEFINED
+#define _FMT_CONVENIENCE_DEFINED
+#include <fmt/format.h>
+
+/* Convenience for common SystemC useage */
+// Allows Join to be used on vectors etc.
+#include <fmt/ranges.h>
+// cover 'std' types
+#include <fmt/std.h>
+// Make all enum's behave like their underlying types by default
+#include <type_traits>
+template <typename E>
+struct fmt::formatter<E, std::enable_if_t<std::is_enum_v<std::decay_t<E>>, char>> : fmt::formatter<std::string_view> {
+    auto format(E e, format_context& ctx) const { return formatter<std::string_view, char>::format("Test", ctx); }
+};
+#endif // _FMT_CONVENIENCE_DEFINED
+#endif
+
+#ifdef HAS_CCI
+#ifndef _GLOBAL_SCP_LOGGER_FROM_CCI_DEFINED
+#define _GLOBAL_SCP_LOGGER_FROM_CCI_DEFINED
+#include "scp/report_cci_setter.h"
+static scp::scp_logger_from_cci _global_scp_logger_from_cci;
+#endif // _GLOBAL_SCP_LOGGER_FROM_CCI_DEFINED
+#endif