Add Release build assertions CMake option

The option is off for release builds by default, but enabled for tests.

The intention is to enable this option for "debug" testing, but with
release build.

Author: david-cattermole

lib/CMakeLists.txt

@@ -67,7 +67,8 @@ set(cpp_lib_name "mmsolverlibs_cpp")
 set(rust_lib_name "mmsolverlibs_rust")
 
 include(MMCommonUtils)
-mm_common_set_global_compile_options()
+option(MMSOLVER_BUILD_RELEASE_ASSERTIONS "Enable Assertions to be called in Release mode." OFF)
+mm_common_set_global_compile_options(MMSOLVER_BUILD_RELEASE_ASSERTIONS)
 
 include(MMRustUtils)
 set(rust_linktime_file "NOT-FOUND")

lib/cppbind/mmimage/tests/CMakeLists.txt

@@ -30,7 +30,8 @@ set(test_source_files
 )
 
 include(MMCommonUtils)
-mm_common_set_global_compile_options()
+option(MMSOLVER_BUILD_RELEASE_ASSERTIONS "Enable Assertions to be called in Release mode." ON)
+mm_common_set_global_compile_options(MMSOLVER_BUILD_RELEASE_ASSERTIONS)
 
 # Add test executable using the C++ bindings.
 message(STATUS "target_test_exe_name: ${target_test_exe_name}")

lib/cppbind/mmlens/tests/CMakeLists.txt

@@ -39,7 +39,8 @@ set(test_source_files
 )
 
 include(MMCommonUtils)
-mm_common_set_global_compile_options()
+option(MMSOLVER_BUILD_RELEASE_ASSERTIONS "Enable Assertions to be called in Release mode." ON)
+mm_common_set_global_compile_options(MMSOLVER_BUILD_RELEASE_ASSERTIONS)
 
 # Add test executable using the C++ bindings.
 add_executable(${target_test_exe_name} ${test_source_files})

lib/cppbind/mmscenegraph/tests/CMakeLists.txt

@@ -28,7 +28,8 @@ set(test_source_files
 )
 
 include(MMCommonUtils)
-mm_common_set_global_compile_options()
+option(MMSOLVER_BUILD_RELEASE_ASSERTIONS "Enable Assertions to be called in Release mode." ON)
+mm_common_set_global_compile_options(MMSOLVER_BUILD_RELEASE_ASSERTIONS)
 
 # Add test executable using the C++ bindings.
 add_executable(${target_test_exe_name} ${test_source_files})

scripts/internal/build_mmSolverLibs_linux.bash

@@ -44,6 +44,7 @@ BUILD_DIR_BASE="${PROJECT_ROOT}/../"
 
 # What type of build? "Release" or "Debug"?
 BUILD_TYPE="Release"
+MMSOLVER_BUILD_RELEASE_ASSERTIONS=0
 
 RELEASE_FLAG=""
 BUILD_TYPE_DIR="debug"
@@ -133,6 +134,7 @@ ${CMAKE_EXE} \
     -DCMAKE_MODULE_PATH=${OPENCOLORIO_CMAKE_FIND_MODULES_DIR} \
     -DCMAKE_VERBOSE_MAKEFILE=${MMSOLVER_BUILD_VERBOSE} \
     -DMMSOLVER_VFX_PLATFORM=${VFX_PLATFORM} \
+    -DMMSOLVER_BUILD_RELEASE_ASSERTIONS=${MMSOLVER_BUILD_RELEASE_ASSERTIONS} \
     -DMMSOLVERLIBS_CXXBRIDGE_EXE=${MMSOLVERLIBS_CXXBRIDGE_EXE} \
     -DMMSOLVERLIBS_BUILD_TESTS=${MMSOLVERLIBS_BUILD_TESTS} \
     -DMMSOLVERLIBS_LIB_DIR=${MMSOLVERLIBS_LIB_DIR} \

scripts/internal/build_mmSolverLibs_windows64.bat

@@ -35,6 +35,7 @@ SET BUILD_DIR_BASE=%PROJECT_ROOT%\..
 
 :: What type of build? "Release" or "Debug"?
 SET BUILD_TYPE=Release
+SET MMSOLVER_BUILD_RELEASE_ASSERTIONS=0
 
 SET RELEASE_FLAG=
 SET BUILD_TYPE_DIR=debug
@@ -158,6 +159,7 @@ CHDIR "%BUILD_DIR%"
     -DCMAKE_MODULE_PATH=%OPENCOLORIO_CMAKE_FIND_MODULES_DIR% ^
     -DCMAKE_VERBOSE_MAKEFILE=%MMSOLVER_BUILD_VERBOSE% ^
     -DMMSOLVER_VFX_PLATFORM=%VFX_PLATFORM% ^
+    -DMMSOLVER_BUILD_RELEASE_ASSERTIONS=%MMSOLVER_BUILD_RELEASE_ASSERTIONS% ^
     -DMMSOLVERLIBS_CXXBRIDGE_EXE=%MMSOLVERLIBS_CXXBRIDGE_EXE% ^
     -DMMSOLVERLIBS_BUILD_TESTS=%MMSOLVERLIBS_BUILD_TESTS% ^
     -DMMSOLVERLIBS_LIB_DIR=%MMSOLVERLIBS_LIB_DIR% ^

scripts/internal/build_mmSolver_linux.bash

@@ -59,6 +59,7 @@ BUILD_DIR_BASE="${PROJECT_ROOT}/../"
 
 # What type of build? "Release" or "Debug"?
 BUILD_TYPE=Release
+MMSOLVER_BUILD_RELEASE_ASSERTIONS=0
 
 # Build options, to allow faster compilation times. (not to be used by
 # users wanting to build this project.)
@@ -140,6 +141,7 @@ ${CMAKE_EXE} \
     -DCMAKE_VERBOSE_MAKEFILE=${MMSOLVER_BUILD_VERBOSE} \
     -DOPENGL_INCLUDE_DIR=${OPENGL_INCLUDE_DIR} \
     -DMMSOLVER_VFX_PLATFORM=${VFX_PLATFORM} \
+    -DMMSOLVER_BUILD_RELEASE_ASSERTIONS=${MMSOLVER_BUILD_RELEASE_ASSERTIONS} \
     -DMMSOLVER_BUILD_PLUGIN=${MMSOLVER_BUILD_PLUGIN} \
     -DMMSOLVER_BUILD_TOOLS=${MMSOLVER_BUILD_TOOLS} \
     -DMMSOLVER_BUILD_PYTHON=${MMSOLVER_BUILD_PYTHON} \

scripts/internal/build_mmSolver_windows64.bat

@@ -59,6 +59,7 @@ SET BUILD_PACKAGE=1
 
 :: What type of build? "Release" or "Debug"?
 SET BUILD_TYPE=Release
+SET MMSOLVER_BUILD_RELEASE_ASSERTIONS=0
 
 :: Build options, to allow faster compilation times. (not to be used by
 :: users wanting to build this project.)
@@ -158,6 +159,7 @@ CHDIR "%BUILD_DIR%"
     -DCMAKE_MODULE_PATH=%OPENCOLORIO_CMAKE_FIND_MODULES_DIR% ^
     -DCMAKE_VERBOSE_MAKEFILE=%MMSOLVER_BUILD_VERBOSE% ^
     -DMMSOLVER_VFX_PLATFORM=%VFX_PLATFORM% ^
+    -DMMSOLVER_BUILD_RELEASE_ASSERTIONS=%MMSOLVER_BUILD_RELEASE_ASSERTIONS% ^
     -DMMSOLVER_BUILD_PLUGIN=%MMSOLVER_BUILD_PLUGIN% ^
     -DMMSOLVER_BUILD_TOOLS=%MMSOLVER_BUILD_TOOLS% ^
     -DMMSOLVER_BUILD_PYTHON=%MMSOLVER_BUILD_PYTHON% ^

share/cmake/modules/MMCommonUtils.cmake

@@ -226,10 +226,14 @@ function(mm_common_linux_gcc_set_global_compile_options)
   set(CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} -march=skylake")   # Use AVX2 instructions
 endfunction()
 
-function(mm_common_set_global_compile_options)
+function(mm_common_set_global_compile_options enable_release_mode_assertions)
 
   if(CMAKE_BUILD_TYPE EQUAL "Release")
-    add_compile_definitions(NDEBUG)
+    # If 'NDEBUG' is enabled, it will disable 'assert'ions.
+    # https://en.cppreference.com/w/cpp/error/assert
+    if(NOT enable_release_mode_assertions)
+      add_compile_definitions(NDEBUG)
+    endif ()
   elseif (CMAKE_BUILD_TYPE EQUAL "Debug")
     add_compile_definitions(_DEBUG)
   endif ()

src/CMakeLists.txt

@@ -179,7 +179,8 @@ endif ()
 # plug-in. See 'MMSolverUtils' CMake module for more information.
 include(MMCommonUtils)
 mm_common_set_global_treat_warnings_as_errors()
-mm_common_set_global_compile_options()
+option(MMSOLVER_BUILD_RELEASE_ASSERTIONS "Enable Assertions to be called in Release mode." OFF)
+mm_common_set_global_compile_options(MMSOLVER_BUILD_RELEASE_ASSERTIONS)
 
 # MM Solver standalone libraries.
 find_package(mmsolverlibs_cpp REQUIRED)