Enable default warning levels in cmake build (lballabio#1611)

Author: lballabio

.github/workflows/cmake.yml

@@ -21,8 +21,8 @@ jobs:
       run: |
         mkdir build
         cd build
-        cmake .. -GNinja -DBOOST_ROOT=/usr -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_COMPILER_LAUNCHER=ccache
-        cmake --build .
+        cmake .. -GNinja -DBOOST_ROOT=/usr -DCMAKE_BUILD_TYPE=Release -DQL_COMPILE_WARNING_AS_ERROR=ON -DCMAKE_CXX_COMPILER_LAUNCHER=ccache -L
+        cmake --build . --verbose
     - name: Test
       run: |
         cd build
@@ -45,8 +45,8 @@ jobs:
           cmake-linux-ci-opts-
     - name: Compile
       run: |
-        cmake --preset linux-ci-build-with-nonstandard-options
-        cmake --build --preset linux-ci-build-with-nonstandard-options 
+        cmake --preset linux-ci-build-with-nonstandard-options -L
+        cmake --build --preset linux-ci-build-with-nonstandard-options --verbose
     - name: Test
       run: |
         cd build
@@ -78,7 +78,7 @@ jobs:
         mkdir build
         cd build
         call "C:\Program Files\Microsoft Visual Studio\2022\Enterprise\Vc\Auxiliary\Build\vcvarsall.bat" amd64 -vcvars_ver=14.3 || exit 1
-        cmake .. -GNinja -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_COMPILER_LAUNCHER=sccache
+        cmake .. -GNinja -DCMAKE_BUILD_TYPE=Release -DQL_COMPILE_WARNING_AS_ERROR=ON -DCMAKE_CXX_COMPILER_LAUNCHER=sccache -L
         cmake --build . --verbose
         dir ql\*.lib
     - name: Test
@@ -112,7 +112,7 @@ jobs:
         mkdir build
         cd build
         call "C:\Program Files\Microsoft Visual Studio\2022\Enterprise\Vc\Auxiliary\Build\vcvarsall.bat" amd64 -vcvars_ver=14.3 || exit 1
-        cmake .. -GNinja -DCMAKE_MSVC_RUNTIME_LIBRARY=MultiThreadedDLL -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_COMPILER_LAUNCHER=sccache
+        cmake .. -GNinja -DCMAKE_MSVC_RUNTIME_LIBRARY=MultiThreadedDLL -DCMAKE_BUILD_TYPE=Release -DQL_COMPILE_WARNING_AS_ERROR=ON -DCMAKE_CXX_COMPILER_LAUNCHER=sccache -L
         cmake --build . --verbose
         dir ql\*.lib
     - name: Test
@@ -144,8 +144,8 @@ jobs:
       shell: cmd
       run: |
         call "C:\Program Files\Microsoft Visual Studio\2022\Enterprise\Vc\Auxiliary\Build\vcvarsall.bat" amd64 -vcvars_ver=14.3 || exit 1
-        cmake --preset windows-ci-build-with-nonstandard-options
-        cmake --build --preset windows-ci-build-with-nonstandard-options
+        cmake --preset windows-ci-build-with-nonstandard-options -L
+        cmake --build --preset windows-ci-build-with-nonstandard-options --verbose
     - name: Test
       run: |
         cd build
@@ -171,8 +171,8 @@ jobs:
       run: |
         mkdir build
         cd build
-        cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_COMPILER_LAUNCHER=ccache -GNinja
-        cmake --build .
+        cmake .. -DCMAKE_BUILD_TYPE=Release -DQL_COMPILE_WARNING_AS_ERROR=ON -DCMAKE_CXX_COMPILER_LAUNCHER=ccache -GNinja -L
+        cmake --build . --verbose
     - name: Test
       run: |
         cd build

CMakeLists.txt

@@ -47,6 +47,8 @@ option(QL_ENABLE_PARALLEL_UNIT_TEST_RUNNER "Enable the parallel unit test runner
 option(QL_ENABLE_SESSIONS "Singletons return different instances for different sessions" OFF)
 option(QL_ENABLE_THREAD_SAFE_OBSERVER_PATTERN "Enable the thread-safe observer pattern" OFF)
 option(QL_ENABLE_TRACING "Tracing messages should be allowed" OFF)
+option(QL_ENABLE_DEFAULT_WARNING_LEVEL "Enable the default warning level to pass the ci pipeline" ON)
+option(QL_COMPILE_WARNING_AS_ERROR "Specify whether to treat warnings on compile as errors." OFF)
 option(QL_ERROR_FUNCTIONS "Error messages should include current function information" OFF)
 option(QL_ERROR_LINES "Error messages should include file and line information" OFF)
 option(QL_EXTRA_SAFETY_CHECKS "Extra safety checks should be performed" OFF)
@@ -101,6 +103,34 @@ if (CMAKE_CXX_STANDARD LESS 17)
     endif()
 endif ()
 
+# Set the default warning level we use to pass the GitHub workflows
+if (QL_ENABLE_DEFAULT_WARNING_LEVEL)
+    if (MSVC)
+        # warning level 3
+        # There are also specific warnings disabled for MSCV in cmake/Platform.cmake.
+        add_compile_options(-W3)
+    else()
+        # lots of warnings
+        add_compile_options(-Wall -Wno-unknown-pragmas)
+    endif()
+endif()
+
+# Treat warnings on compile as errors
+if (QL_COMPILE_WARNING_AS_ERROR)
+    # all compiler warnings as errors
+    if (CMAKE_VERSION VERSION_GREATER_EQUAL "3.24.0")
+        # since v3.24 cmake can set all compiler warnings as errors itself
+        set(CMAKE_COMPILE_WARNING_AS_ERROR ON)
+    else()
+        # or set them manually
+        if (MSVC)
+            add_compile_options(-WX)
+        else()
+            add_compile_options(-Werror)
+        endif()
+    endif()
+endif()
+
 if (QL_USE_CLANG_TIDY)
     if (NOT DEFINED QL_CLANG_TIDY)
         set(QL_CLANG_TIDY clang-tidy)

CMakePresets.json

@@ -116,7 +116,8 @@
         "QL_HIGH_RESOLUTION_DATE": "ON",
         "QL_NULL_AS_FUNCTIONS": "ON",
         "QL_USE_INDEXED_COUPON": "ON",
-        "QL_USE_STD_CLASSES": "ON"
+        "QL_USE_STD_CLASSES": "ON",
+        "QL_COMPILE_WARNING_AS_ERROR": "ON"
       }
     },
     {
@@ -137,6 +138,7 @@
         "QL_NULL_AS_FUNCTIONS": "ON",
         "QL_USE_INDEXED_COUPON": "ON",
         "QL_USE_STD_CLASSES": "ON",
+        "QL_COMPILE_WARNING_AS_ERROR": "ON",
         "CMAKE_CXX_COMPILER_LAUNCHER": "sccache"
       },
       "vendor": {

cmake/Platform.cmake

@@ -17,6 +17,9 @@ if (MSVC)
 
     add_compile_definitions(NOMINMAX)
 
+    # caused by ql\time\date.cpp: warning C4996: 'localtime': This function or variable may be unsafe. Consider using localtime_s instead.
+    add_compile_definitions(_CRT_SECURE_NO_WARNINGS)
+
     # /wd4267
     # Suppress warnings: assignment of 64-bit value to 32-bit QuantLib::Integer (x64)
 
@@ -27,4 +30,11 @@ if (MSVC)
     # Suppress warnings: "Prefer enum class over enum" (Enum.3)
 
     add_compile_options(/wd4267 /wd4819 /wd26812)
+
+    # prevent warnings when using /std:c++17 and above
+    if(CMAKE_CXX_STANDARD GREATER_EQUAL 17)
+        # E.g. caused by #include <boost/numeric/ublas/matrix.hpp>
+        # In c++17 std::iterator is deprecated. As of boost 1.81 boost::ublas has not provided a fix for this.
+        add_compile_definitions(_SILENCE_CXX17_ITERATOR_BASE_CLASS_DEPRECATION_WARNING)
+    endif()
 endif()