#718: pressio: add no-op for logging macros when pressio-log is disabled

Pressio · Feb 19, 2025 · e670c7b · e670c7b
1 parent 595f02a
commit e670c7b
Show file tree

Hide file tree

Showing 18 changed files with 44 additions and 36 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -29,26 +29,25 @@ endif()
 
 # pull in pressio-log and read macros
 #=====================================================================
-if(PRESSIO_LOG_INCLUDE_DIR)
-  message("${Green}-- Using ${PRESSIO_LOG_INCLUDE_DIR}")
-  include_directories(SYSTEM ${PRESSIO_LOG_INCLUDE_DIR})
-
+if (PRESSIO_ENABLE_LOGGING)
+  if(PRESSIO_LOG_INCLUDE_DIR)
+    message("${Green}-- Using ${PRESSIO_LOG_INCLUDE_DIR}")
+    include_directories(SYSTEM ${PRESSIO_LOG_INCLUDE_DIR})
+  else()
+    include(FetchContent)
+    message("${Green}-- PRESSIO_LOG_INCLUDE_DIR is not defined, so fetching pressio-log...")
+    FetchContent_Declare(
+      pressio-log
+      GIT_REPOSITORY https://github.com/Pressio/pressio-log.git
+      GIT_TAG        main
+      GIT_PROGRESS   TRUE
+      GIT_SHALLOW    TRUE
+    )
+    FetchContent_MakeAvailable(pressio-log)
+    set(PRESSIO_LOG_INCLUDE_DIR ${pressio-log_SOURCE_DIR}/include)
+  endif()
 else()
-
-  include(FetchContent)
-  message("${Green}-- PRESSIO_LOG_INCLUDE_DIR is not defined, so fetching pressio-log...")
-
-  FetchContent_Declare(
-    pressio-log
-    GIT_REPOSITORY https://github.com/Pressio/pressio-log.git
-    GIT_TAG        main
-    GIT_PROGRESS   TRUE
-    GIT_SHALLOW    TRUE
-  )
-
-  FetchContent_MakeAvailable(pressio-log)
-  set(PRESSIO_LOG_INCLUDE_DIR ${pressio-log_SOURCE_DIR}/include)
-
+  message(STATUS "Logging has been disabled (PRESSIO_ENABLE_LOGGING=OFF)")
 endif()
 
 # versioning

diff --git a/include/pressio/ode_advancers.hpp b/include/pressio/ode_advancers.hpp
@@ -52,7 +52,7 @@
 #include "pressio/mpl.hpp"
 #include "pressio/type_traits.hpp"
 
-#include "pressio-log/core.hpp"
+#include "pressio/pressio_macros.hpp"
 
 #include "./ode_concepts.hpp"
 #include "./ode/exceptions.hpp"

diff --git a/include/pressio/ode_concepts.hpp b/include/pressio/ode_concepts.hpp
@@ -53,7 +53,7 @@
 #include "pressio/type_traits.hpp"
 #include "pressio/ops.hpp"
 
-#include "pressio-log/core.hpp"
+#include "pressio/pressio_macros.hpp"
 #include "./ode/ode_strong_types.hpp"
 #include "./ode/ode_enum_and_tags.hpp"
 #include "./ode/ode_stencil_containers.hpp"

diff --git a/include/pressio/ode_steppers_explicit.hpp b/include/pressio/ode_steppers_explicit.hpp
@@ -53,7 +53,7 @@
 #include "pressio/type_traits.hpp"
 #include "pressio/ops.hpp"
 
-#include "pressio-log/core.hpp"
+#include "pressio/pressio_macros.hpp"
 #include "./solvers.hpp"
 #include "./ode_concepts.hpp"
 #include "./ode/exceptions.hpp"

diff --git a/include/pressio/ode_steppers_implicit.hpp b/include/pressio/ode_steppers_implicit.hpp
@@ -53,7 +53,7 @@
 #include "pressio/type_traits.hpp"
 #include "pressio/ops.hpp"
 
-#include "pressio-log/core.hpp"
+#include "pressio/pressio_macros.hpp"
 #include "./solvers.hpp"
 #include "./ode_concepts.hpp"
 #include "./ode/exceptions.hpp"

diff --git a/include/pressio/pressio_macros.hpp b/include/pressio/pressio_macros.hpp
@@ -49,7 +49,16 @@
 #ifndef PRESSIO_MACROS_HPP_
 #define PRESSIO_MACROS_HPP_
 
-#include "pressio-log/core.hpp"
 #include "pressio/ops_macros.hpp"
 
+#if PRESSIO_ENABLE_LOGGING
+    #include "pressio-log/core.hpp"
+#else
+    #define PRESSIOLOG_BASIC(...)   do {} while (0)
+    #define PRESSIOLOG_INFO(...)    do {} while (0)
+    #define PRESSIOLOG_DEBUG(...)   do {} while (0)
+    #define PRESSIOLOG_WARNING(...) do {} while (0)
+    #define PRESSIOLOG_ERROR(...)   do {} while (0)
+#endif
+
 #endif
diff --git a/include/pressio/rom_concepts.hpp b/include/pressio/rom_concepts.hpp
@@ -53,7 +53,7 @@
 #include "pressio/type_traits.hpp"
 #include "pressio/ops.hpp"
 
-#include "pressio-log/core.hpp"
+#include "pressio/pressio_macros.hpp"
 #include "./solvers_linear.hpp"
 #include "./solvers_nonlinear.hpp"
 #include "./ode.hpp"

diff --git a/include/pressio/rom_galerkin_steady.hpp b/include/pressio/rom_galerkin_steady.hpp
@@ -53,7 +53,7 @@
 #include "pressio/type_traits.hpp"
 #include "pressio/ops.hpp"
 
-#include "pressio-log/core.hpp"
+#include "pressio/pressio_macros.hpp"
 #include "./solvers_linear.hpp"
 #include "./solvers_nonlinear.hpp"
 #include "./ode.hpp"

diff --git a/include/pressio/rom_galerkin_unsteady.hpp b/include/pressio/rom_galerkin_unsteady.hpp
@@ -53,7 +53,7 @@
 #include "pressio/type_traits.hpp"
 #include "pressio/ops.hpp"
 
-#include "pressio-log/core.hpp"
+#include "pressio/pressio_macros.hpp"
 #include "./solvers_linear.hpp"
 #include "./solvers_nonlinear.hpp"
 #include "./ode.hpp"

diff --git a/include/pressio/rom_linear.hpp b/include/pressio/rom_linear.hpp
@@ -53,7 +53,7 @@
 #include "pressio/type_traits.hpp"
 #include "pressio/ops.hpp"
 
-#include "pressio-log/core.hpp"
+#include "pressio/pressio_macros.hpp"
 #include "./solvers_linear.hpp"
 #include "./solvers_nonlinear.hpp"
 #include "./ode.hpp"

diff --git a/include/pressio/rom_lspg_steady.hpp b/include/pressio/rom_lspg_steady.hpp
@@ -53,7 +53,7 @@
 #include "pressio/type_traits.hpp"
 #include "pressio/ops.hpp"
 
-#include "pressio-log/core.hpp"
+#include "pressio/pressio_macros.hpp"
 #include "./solvers_linear.hpp"
 #include "./solvers_nonlinear.hpp"
 #include "./ode.hpp"

diff --git a/include/pressio/rom_lspg_unsteady.hpp b/include/pressio/rom_lspg_unsteady.hpp
@@ -53,7 +53,7 @@
 #include "pressio/type_traits.hpp"
 #include "pressio/ops.hpp"
 
-#include "pressio-log/core.hpp"
+#include "pressio/pressio_macros.hpp"
 #include "./solvers_linear.hpp"
 #include "./solvers_nonlinear.hpp"
 #include "./ode.hpp"

diff --git a/include/pressio/rom_subspaces.hpp b/include/pressio/rom_subspaces.hpp
@@ -53,7 +53,7 @@
 #include "pressio/type_traits.hpp"
 #include "pressio/ops.hpp"
 
-#include "pressio-log/core.hpp"
+#include "pressio/pressio_macros.hpp"
 #include "./solvers_linear.hpp"
 #include "./solvers_nonlinear.hpp"
 #include "./ode.hpp"

diff --git a/include/pressio/solvers_linear.hpp b/include/pressio/solvers_linear.hpp
@@ -52,7 +52,7 @@
 #include "pressio/mpl.hpp"
 #include "pressio/type_traits.hpp"
 
-#include "pressio-log/core.hpp"
+#include "pressio/pressio_macros.hpp"
 #include "solvers_linear/solvers_linear_tags.hpp"
 #include "solvers_linear/solvers_linear_solver.hpp"
 

diff --git a/include/pressio/solvers_nonlinear_concepts.hpp b/include/pressio/solvers_nonlinear_concepts.hpp
@@ -52,7 +52,7 @@
 #include "pressio/mpl.hpp"
 #include "pressio/type_traits.hpp"
 
-#include "pressio-log/core.hpp"
+#include "pressio/pressio_macros.hpp"
 
 #ifdef PRESSIO_ENABLE_CXX20
 #include "solvers_nonlinear/solvers_concepts_cxx20.hpp"

diff --git a/include/pressio/solvers_nonlinear_gaussnewton.hpp b/include/pressio/solvers_nonlinear_gaussnewton.hpp
@@ -54,7 +54,7 @@
 #include "pressio/expressions.hpp"
 #include "pressio/ops.hpp"
 
-#include "pressio-log/core.hpp"
+#include "pressio/pressio_macros.hpp"
 #include "./solvers_linear.hpp"
 #include "./solvers_nonlinear/impl/qr.hpp"
 

diff --git a/include/pressio/solvers_nonlinear_levmarq.hpp b/include/pressio/solvers_nonlinear_levmarq.hpp
@@ -54,7 +54,7 @@
 #include "pressio/expressions.hpp"
 #include "pressio/ops.hpp"
 
-#include "pressio-log/core.hpp"
+#include "pressio/pressio_macros.hpp"
 #include "./solvers_linear.hpp"
 
 #include "solvers_nonlinear_concepts.hpp"

diff --git a/include/pressio/solvers_nonlinear_newton.hpp b/include/pressio/solvers_nonlinear_newton.hpp
@@ -54,7 +54,7 @@
 #include "pressio/expressions.hpp"
 #include "pressio/ops.hpp"
 
-#include "pressio-log/core.hpp"
+#include "pressio/pressio_macros.hpp"
 #include "./solvers_linear.hpp"
 
 #include "solvers_nonlinear_concepts.hpp"