feat: support the Visual Studio IDE code analysis

Author: aminya

README.md

@@ -35,6 +35,7 @@ project_options(
       ENABLE_CACHE
       ENABLE_CPPCHECK
       ENABLE_CLANG_TIDY
+      ENABLE_VS_ANALYSIS
       # ENABLE_CONAN
       # ENABLE_IPO
       # ENABLE_DOXYGEN
@@ -51,7 +52,6 @@ project_options(
       # ENABLE_USER_LINKER
       # ENABLE_BUILD_WITH_TIME_TRACE
       # ENABLE_UNITY
-      # CONAN_OPTIONS
 )
 ```
 
@@ -156,6 +156,7 @@ It accepts the following named flags:
 - `ENABLE_CACHE`: Enable cache if available
 - `ENABLE_CPPCHECK`: Enable static analysis with Cppcheck
 - `ENABLE_CLANG_TIDY`: Enable static analysis with clang-tidy
+- `ENABLE_VS_ANALYSIS`: Enable Visual Studio IDE code analysis if the generator is Visual Studio.
 - `ENABLE_CONAN`: Use Conan for dependency management
 - `ENABLE_IPO`: Enable Interprocedural Optimization (Link Time Optimization, LTO) in the release build
 - `ENABLE_COVERAGE`: Enable coverage reporting for gcc/clang
@@ -181,6 +182,7 @@ It gets the following named parameters that can have different values in front o
 - `GCC_WARNINGS`: Override the defaults for the GCC warnings
 - `CUDA_WARNINGS`: Override the defaults for the CUDA warnings
 - `CPPCHECK_WARNINGS`: Override the defaults for the options passed to cppcheck
+- `VS_ANALYSIS_RULESET`: Override the defaults for the code analysis rule set in Visual Studio.
 - `CONAN_OPTIONS`: Extra Conan options
 
 ## `run_vcpkg` function

src/DynamicProjectOptions.cmake

@@ -67,6 +67,7 @@ set(options
     "ENABLE_CACHE\;${MAKEFILE_OR_NINJA}\;${MAKEFILE_OR_NINJA}\;Enable ccache on Unix"
     "WARNINGS_AS_ERRORS\;OFF\;ON\;Treat warnings as Errors"
     "ENABLE_CLANG_TIDY\;OFF\;${MAKEFILE_OR_NINJA}\;Enable clang-tidy analysis during compilation"
+    "ENABLE_VS_ANALYSIS\;ON\;ON\;Enable Visual Studio IDE code analysis if the generator is Visual Studio."
     "ENABLE_CONAN\;OFF\;OFF\;Automatically integrate Conan for package management"
     "ENABLE_COVERAGE\;OFF\;OFF\;Analyze and report on coverage"
     "ENABLE_SANITIZER_ADDRESS\;OFF\;${SUPPORTS_ASAN}\;Make memory errors into hard runtime errors (windows/linux/macos)"

src/Index.cmake

@@ -50,6 +50,7 @@ macro(project_options)
       ENABLE_COVERAGE
       ENABLE_CPPCHECK
       ENABLE_CLANG_TIDY
+      ENABLE_VS_ANALYSIS
       ENABLE_INCLUDE_WHAT_YOU_USE
       ENABLE_CACHE
       ENABLE_PCH
@@ -65,7 +66,7 @@ macro(project_options)
       ENABLE_SANITIZER_UNDEFINED_BEHAVIOR
       ENABLE_SANITIZER_THREAD
       ENABLE_SANITIZER_MEMORY)
-  set(oneValueArgs DOXYGEN_THEME)
+  set(oneValueArgs DOXYGEN_THEME VS_ANALYSIS_RULESET)
   set(multiValueArgs
       MSVC_WARNINGS
       CLANG_WARNINGS
@@ -161,6 +162,10 @@ macro(project_options)
     enable_clang_tidy()
   endif()
 
+  if(${ProjectOptions_ENABLE_VS_ANALYSIS})
+    enable_vs_analysis("${ProjectOptions_VS_ANALYSIS_RULESET}")
+  endif()
+
   if(${ProjectOptions_ENABLE_INCLUDE_WHAT_YOU_USE})
     enable_include_what_you_use()
   endif()

src/StaticAnalyzers.cmake

@@ -74,6 +74,34 @@ macro(enable_clang_tidy)
   endif()
 endmacro()
 
+macro(enable_vs_analysis VS_ANALYSIS_RULESET)
+  if("${VS_ANALYSIS_RULESET}" STREQUAL "")
+    # See for other rulesets: C:\Program Files (x86)\Microsoft Visual Studio\20xx\xx\Team Tools\Static Analysis Tools\Rule Sets\
+    set(VS_ANALYSIS_RULESET "AllRules.ruleset")
+  endif()
+  if(NOT
+     "${CMAKE_CXX_CLANG_TIDY}"
+     STREQUAL
+     "")
+    set(_VS_CLANG_TIDY "true")
+  else()
+    set(_VS_CLANG_TIDY "false")
+  endif()
+  if(CMAKE_GENERATOR MATCHES "Visual Studio")
+    get_all_targets(_targets_list)
+    foreach(target IN LISTS ${_targets_list})
+      set_target_properties(
+        ${target}
+        PROPERTIES
+          VS_GLOBAL_EnableMicrosoftCodeAnalysis true
+          VS_GLOBAL_CodeAnalysisRuleSet "${VS_ANALYSIS_RULESET}"
+          VS_GLOBAL_EnableClangTidyCodeAnalysis "${_VS_CLANG_TIDY}"
+          # This is set to false deliberately. The compiler warnings are already given in the CompilerWarnings.cmake file
+          VS_GLOBAL_RunCodeAnalysis false)
+    endforeach()
+  endif()
+endmacro()
+
 macro(enable_include_what_you_use)
   find_program(INCLUDE_WHAT_YOU_USE include-what-you-use)
   if(INCLUDE_WHAT_YOU_USE)