CAP: added logging

Author: 9and3

.gitmodules

@@ -11,3 +11,6 @@
 [submodule "deps/boost"]
 	path = deps/boost
 	url = https://github.com/diffCheckOrg/submodule-boost.git
+[submodule "deps/loguru"]
+	path = deps/loguru
+	url = https://github.com/emilk/loguru.git

.vscode/settings.json

@@ -96,6 +96,7 @@
         "valarray": "cpp",
         "*.inc": "cpp",
         "coroutine": "cpp",
-        "resumable": "cpp"
+        "resumable": "cpp",
+        "*.ipp": "cpp"
     }
 }

CMakeLists.txt

@@ -4,8 +4,8 @@ set(CMAKE_CXX_STANDARD 17)
 
 list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)
 
-# import the custom cmake utilities funcs
 include(external_tools)
+include(options)
 
 # do a submodule init if not done already
 execute_process(COMMAND git submodule update --init --recursive
@@ -17,6 +17,13 @@ if(NOT GIT_SUBMOD_RESULT EQUAL "0")
 endif()
 
 
+#--------------------------------------------------------------------------
+# pre-compiled definitions
+#--------------------------------------------------------------------------
+if(SILENT_LOGGING)
+    target_compile_definitions(${PROJECT_NAME} PRIVATE SILENT_LOGGING=true)
+endif()
+
 #--------------------------------------------------------------------------
 # diffCheck dynamic lib
 #--------------------------------------------------------------------------
@@ -42,6 +49,9 @@ target_include_directories(${SHARED_LIB_NAME}
     PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/src
     )
 
+    #set the MD_DynamicRelease flag for MSVC since we are compiling with /MD for py wrap
+set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>DLL")
+
 
 #--------------------------------------------------------------------------
 # 3rd party
@@ -52,17 +62,7 @@ download_submodule_project(eigen)
 add_subdirectory(deps/eigen)
 target_link_libraries(${SHARED_LIB_NAME} PUBLIC Eigen3::Eigen)
 
-# Open3D (pre-built binaries) -----------------------------------------------------    
-# The options need to be the same as Open3D's default
-# If Open3D is configured and built with custom options, you'll also need to
-# specify the same custom options.
-option(STATIC_WINDOWS_RUNTIME "Use static (MT/MTd) Windows runtime" ON)
-if(STATIC_WINDOWS_RUNTIME)
-    set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>")
-else()
-    set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>DLL")
-endif()
-
+# Open3D (pre-built binaries) ---------------------------------------------
 download_submodule_project(open3d)
 set(Open3D_DIR ${CMAKE_CURRENT_SOURCE_DIR}/deps/open3d/win/0_18/CMake)
 find_package(Open3D 0.18.0 REQUIRED)
@@ -91,14 +91,14 @@ endif()
 download_submodule_project(boost)
 target_link_directories(${SHARED_LIB_NAME} PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/deps/boost/win/1_89/include/boost-1_85)
 
-# print boost include dir
-message(STATUS "Boost include dir: ${Boost_INCLUDE_DIRS}")
-
-target_include_directories(${SHARED_LIB_NAME} PUBLIC ${Boost_INCLUDE_DIRS})
-
 # CGAL (header-only) ------------------------------------------------------
 target_include_directories(${SHARED_LIB_NAME} PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/deps/cgal/include)
 
+# loguru (header-only) ----------------------------------------------------
+download_submodule_project(loguru)
+add_subdirectory(deps/loguru)
+target_link_libraries(${SHARED_LIB_NAME} PUBLIC loguru::loguru)
+
 #--------------------------------------------------------------------------
 # executable for prototyping
 #--------------------------------------------------------------------------

CONTRIBUTING.md

@@ -157,23 +157,25 @@ Follow [this guide for documenting the code](https://developer.lsst.io/cpp/api-d
  */
 ``` -->
 
-<!-- ### Logging (TO BE UPDATED)
-To log use the following MACROS. All the code is contained in `Log.hpp` and `Log.cpp`. 
+### Logging
+To log use the following MACROS. All the code is contained in `log.hh` and `log.cc`.
 ```c++
-AIAC_INFO("test_core_info");
-AIAC_WARN("test_core_warn");
-AIAC_CRITICAL("test_core_critical");
-AIAC_DEBUG("test_core_debug");
-AIAC_ERROR("test_core_error");
+DIFFCHECK_INFO("test_core_info");
+DIFFCHECK_WARN("test_core_warn");
+DIFFCHECK_ERROR("test_core_error");
+DIFFCHECK_FATAL("test_core_critical");
 ```
 The output is like so:
 ```bash
-[source main.cpp] [function main] [line 32] [16:30:05] APP: test
+2024-03-30 12:53:29.971 (   0.000s) [        ADF6D348]        diffCheckApp.cc:24    INFO| test_core_info
+2024-03-30 12:53:29.972 (   0.000s) [        ADF6D348]        diffCheckApp.cc:25    WARN| test_core_warn
+2024-03-30 12:53:29.972 (   0.000s) [        ADF6D348]        diffCheckApp.cc:26     ERR| test_core_error
+2024-03-30 12:53:29.972 (   0.000s) [        ADF6D348]        diffCheckApp.cc:27    FATL| test_core_critical
 ```
-The logging can be silenced by setting OFF the option in the main `CMakeLists.txt` and do clean reconfiguration.
+The logging can be silenced by setting ON the option in the main `CMakeLists.txt`.
 ```cmake
 option(SILENT_LOGGING "Do not log messages in the terminal of on." ON)
-``` -->
+```
 
 ### I/O and basic datatypes
 Here's how you can import point cloud from file:

cmake/options.cmake

@@ -0,0 +1,6 @@
+# The options need to be the same as Open3D's default
+# If Open3D is configured and built with custom options, you'll also need to
+# specify the same custom options.
+option(STATIC_WINDOWS_RUNTIME "Use static (MT/MTd) Windows runtime" ON)
+
+option(SILENT_LOGGING "Do not log messages in the terminal if on." OFF)

deps/boost

@@ -0,0 +1,4 @@
+arguments: loguru
+Current dir: F:\diffCheck
+File verbosity level: -2
+date       time         ( uptime  ) [ thread name/id ]                   file:line     v|