Merge branch 'main' into template-deduce-loop

Author: pfultz2

.github/workflows/CI-unixish.yml

@@ -150,6 +150,7 @@ jobs:
       - name: Run CMake install
         run: |
           cmake --build cmake.output --target install
+          # TODO: validate the installed files
 
       - name: Run CMake on ubuntu (no CLI)
         if: matrix.os == 'ubuntu-22.04'

.github/workflows/CI-windows.yml

@@ -51,24 +51,26 @@ jobs:
       - name: Run CMake
         run: |
           rem TODO: enable rules?
-          rem specify Release build so matchcompiler is used
-          cmake -S . -B build -Werror=dev --warn-uninitialized -DCMAKE_BUILD_TYPE=Release -DCMAKE_COMPILE_WARNING_AS_ERROR=On -DBUILD_TESTING=Off -DBUILD_GUI=On -DWITH_QCHART=On -DBUILD_TRIAGE=On -DBUILD_ONLINE_HELP=On -DCMAKE_INSTALL_PREFIX=cppcheck-cmake-install -DCMAKE_COMPILE_WARNING_AS_ERROR=On || exit /b !errorlevel!
+          cmake -S . -B build -Werror=dev --warn-uninitialized -DCMAKE_BUILD_TYPE=Debug -DCMAKE_COMPILE_WARNING_AS_ERROR=On -DBUILD_TESTING=Off -DBUILD_GUI=On -DWITH_QCHART=On -DBUILD_TRIAGE=On -DBUILD_ONLINE_HELP=On -DISABLE_DMAKE=On -DCMAKE_INSTALL_PREFIX=cppcheck-cmake-install -DCMAKE_COMPILE_WARNING_AS_ERROR=On || exit /b !errorlevel!
 
-      - name: Build GUI release
+      - name: Build GUI
         run: |
-          cmake --build build --target cppcheck-gui --config Release || exit /b !errorlevel!
+          cmake --build build --config Debug --target cppcheck-gui || exit /b !errorlevel!
 
+      # TODO: can this be done in CMake?
       - name: Deploy GUI
         run: |
-          windeployqt build\bin\Release || exit /b !errorlevel!
-          del build\bin\Release\cppcheck-gui.ilk || exit /b !errorlevel!
-          del build\bin\Release\cppcheck-gui.pdb || exit /b !errorlevel!
+          windeployqt --no-translations build\bin\Debug || exit /b !errorlevel!
+          del build\bin\Debug\cppcheck-gui.pdb || exit /b !errorlevel!
 
       # TODO: run GUI tests
 
       - name: Run CMake install
         run: |
-          cmake --build build --target install
+          rem TODO: the Qt DLLs are not being installed
+          cmake --build build --config Debug --target install
+          rem TODO: validate the installed files
+          rem TODO: the structure does not match an actual Windows installation
 
   build_cmake_cxxstd:
     strategy:

.github/workflows/selfcheck.yml

@@ -121,8 +121,25 @@ jobs:
 
       - name: Self check (unusedFunction / no test / no gui)
         run: |
-          supprs="--suppress=unusedFunction:lib/errorlogger.h:198 --suppress=unusedFunction:lib/importproject.cpp:1671 --suppress=unusedFunction:lib/importproject.cpp:1695"
-          ./cppcheck -q --template=selfcheck --error-exitcode=1 --library=cppcheck-lib -D__CPPCHECK__ -D__GNUC__ --enable=unusedFunction,information --exception-handling -rp=. --project=cmake.output.notest_nogui/compile_commands.json --suppressions-list=.selfcheck_unused_suppressions --inline-suppr $supprs
+          echo '<?xml version="1.0"?>
+                <suppressions>
+                  <suppress>
+                    <id>unusedFunction</id>
+                    <fileName>lib/errorlogger.h</fileName>
+                    <symbolName>verboseMessage</symbolName>
+                  </suppress>
+                  <suppress>
+                    <id>unusedFunction</id>
+                    <fileName>lib/importproject.cpp</fileName>
+                    <symbolName>selectVsConfigurations</symbolName>
+                  </suppress>
+                  <suppress>
+                    <id>unusedFunction</id>
+                    <fileName>lib/importproject.cpp</fileName>
+                    <symbolName>getVSConfigs</symbolName>
+                  </suppress>
+                </suppressions>' > supprs.xml
+          ./cppcheck -q --template=selfcheck --error-exitcode=1 --library=cppcheck-lib -D__CPPCHECK__ -D__GNUC__ --enable=unusedFunction,information --exception-handling -rp=. --project=cmake.output.notest_nogui/compile_commands.json --suppressions-list=.selfcheck_unused_suppressions --inline-suppr --suppress-xml=supprs.xml
         env:
           DISABLE_VALUEFLOW: 1
           UNUSEDFUNCTION_ONLY: 1

AUTHORS

@@ -133,6 +133,7 @@ Felipe Pena
 Felix Faber
 Felix Geyer
 Felix Passenberg
+Felix Patschkowski
 Felix Wolff
 Florian Mueller
 Florin Iucha

cfg/gtk.cfg

@@ -92,6 +92,7 @@
   <define name="G_LIKELY(expr)" value="(expr)"/>
   <define name="G_UNLIKELY(expr)" value="(expr)"/>
   <define name="G_DEPRECATED" value="__attribute__((__deprecated__))"/>
+  <define name="G_DEPRECATED_FOR(f)" value="__attribute__((__deprecated__(&quot;Use '&quot; #f &quot;' instead&quot;)))"/>
   <define name="G_STMT_START" value="do"/>
   <define name="G_STMT_END" value="while (0)"/>
   <define name="_G_TYPE_CIC(ip, gt, ct)" value="((ct*) ip)"/>
@@ -126,6 +127,7 @@
   <define name="g_try_new(struct_type, n_structs)" value="_G_NEW (struct_type, n_structs, try_malloc)"/>
   <define name="g_try_new0(struct_type, n_structs)" value="_G_NEW (struct_type, n_structs, try_malloc0)"/>
   <define name="g_try_renew(struct_type, mem, n_structs)" value="_G_RENEW (struct_type, mem, n_structs, try_realloc)"/>
+  <define name="G_ENCODE_VERSION(major, minor)" value="((major) &lt;&lt; 16 | (minor) &lt;&lt; 8)"/>
   <define name="GTK_BUTTON(obj)" value="((GtkButton*)(obj))"/>
   <define name="GTK_BOX(obj)" value="((GtkBox*)(obj))"/>
   <define name="GTK_CONTAINER(obj)" value="((GtkContainer*)(obj))"/>

cfg/microsoft_gsl.cfg

@@ -0,0 +1,17 @@
+<?xml version="1.0"?>
+<def>
+  <define name="Expects(x)" value=""/>
+  <define name="Ensures(x)" value=""/>
+  <define name="GSL_SUPPRESS(x)" value=""/>
+  <podtype name="gsl::index" sign="s"/>
+  <podtype name="gsl::byte" sign="u" size="1"/><!-- Deprecated in GSL -->
+  <container id="gslSpan" startPattern="gsl :: span" inherits="stdSpan">
+  </container>
+  <smart-pointer class-name="gsl::owner"/>
+  <smart-pointer class-name="gsl::not_null"/>
+  <smart-pointer class-name="gsl::unique_ptr"><!-- Deprecated in GSL -->
+    <unique/>
+  </smart-pointer>
+  <smart-pointer class-name="gsl::shared_ptr"/><!-- Deprecated in GSL -->
+  <smart-pointer class-name="gsl::strict_not_null"/><!-- non-existing in C++ Core Guidelines -->
+</def>

cli/CMakeLists.txt

@@ -40,27 +40,32 @@ if (BUILD_CLI)
     endif()
 
     install(TARGETS cppcheck
-        RUNTIME DESTINATION ${CMAKE_INSTALL_FULL_BINDIR}
+        RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
         COMPONENT applications)
 
     install(PROGRAMS ${CMAKE_SOURCE_DIR}/htmlreport/cppcheck-htmlreport
-        DESTINATION ${CMAKE_INSTALL_FULL_BINDIR}
+        DESTINATION ${CMAKE_INSTALL_BINDIR}
         COMPONENT applications)
 
+    # TODO: leverage CMAKE_INSTALL_DATAROOTDIR (share)?
+
     install(FILES ${addons_py}
-       DESTINATION ${FILESDIR_DEF}/addons
+       DESTINATION ${FILESDIR_INSTALL}/addons
        COMPONENT headers)
 
     install(FILES ${addons_json}
-       DESTINATION ${FILESDIR_DEF}/addons
+       DESTINATION ${FILESDIR_INSTALL}/addons
        COMPONENT headers)
 
     install(FILES ${cfgs}
-       DESTINATION ${FILESDIR_DEF}/cfg
+       DESTINATION ${FILESDIR_INSTALL}/cfg
        COMPONENT headers)
 
     install(FILES ${platforms}
-       DESTINATION ${FILESDIR_DEF}/platforms
+       DESTINATION ${FILESDIR_INSTALL}/platforms
        COMPONENT headers)
 
+    # TODO: install manpage into CMAKE_INSTALL_MANDIR
+    # TODO: install documentation into CMAKE_INSTALL_DOCDIR?
+
 endif()

cmake/compilerDefinitions.cmake

@@ -20,7 +20,7 @@ endif()
 if ((USE_LIBCXX AND CMAKE_CXX_COMPILER_ID MATCHES "Clang") OR CMAKE_CXX_COMPILER_ID STREQUAL "AppleClang")
     if(CPPCHK_GLIBCXX_DEBUG AND CMAKE_BUILD_TYPE STREQUAL "Debug")
         # TODO: determine proper version for AppleClang - current value is based on the oldest version avaialble in CI
-        if((CMAKE_CXX_COMPILER_ID STREQUALS "Clang" AND CMAKE_CXX_COMPILER_VERSION VERSION_GREATER_EQUAL 18) OR
+        if((CMAKE_CXX_COMPILER_ID STREQUAL "Clang" AND CMAKE_CXX_COMPILER_VERSION VERSION_GREATER_EQUAL 18) OR
            (CMAKE_CXX_COMPILER_ID STREQUAL "AppleClang" AND CMAKE_CXX_COMPILER_VERSION VERSION_GREATER_EQUAL 17))
             add_definitions(-D_LIBCPP_HARDENING_MODE=_LIBCPP_HARDENING_MODE_DEBUG)
         else()

cmake/options.cmake

@@ -134,18 +134,22 @@ set(CMAKE_DISABLE_PRECOMPILE_HEADERS Off CACHE BOOL "Disable precompiled headers
 # see https://gitlab.kitware.com/cmake/cmake/-/issues/21219
 set(CMAKE_PCH_PROLOGUE "")
 
+# TODO: do we need to set these?
 set(CMAKE_INCLUDE_DIRS_CONFIGCMAKE ${CMAKE_INSTALL_PREFIX}/include      CACHE PATH "Output directory for headers")
 set(CMAKE_LIB_DIRS_CONFIGCMAKE     ${CMAKE_INSTALL_PREFIX}/lib          CACHE PATH "Output directory for libraries")
 
+# TODO: do we need to set these?
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/bin)
 set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/lib)
 set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/lib)
 
 string(LENGTH "${FILESDIR}" _filesdir_len)
 # override FILESDIR if it is set or empty
+# needs to be an absolute path in Cppcheck but a relative one for CMake install
 if(FILESDIR OR ${_filesdir_len} EQUAL 0)
-# TODO: verify that it is an absolute path?
+    set(FILESDIR_INSTALL               "${FILESDIR}") # TODO: make relative - leverage CMAKE_INSTALL_DATAROOTDIR?
     set(FILESDIR_DEF                   "${FILESDIR}")
 else()
-    set(FILESDIR_DEF                   ${CMAKE_INSTALL_PREFIX}/share/${PROJECT_NAME} CACHE STRING "Cppcheck files directory")
+    set(FILESDIR_INSTALL               "share/${PROJECT_NAME}")
+    set(FILESDIR_DEF                   "${CMAKE_INSTALL_PREFIX}/${FILESDIR_INSTALL}")
 endif()

cmake/printInfo.cmake

@@ -8,6 +8,7 @@ message(STATUS "Compiler Version =      ${CMAKE_CXX_COMPILER_VERSION}")
 message(STATUS "Build type =            ${CMAKE_BUILD_TYPE}")
 message(STATUS "CMake C++ Standard =    ${CMAKE_CXX_STANDARD}")
 message(STATUS "CMAKE_INSTALL_PREFIX =  ${CMAKE_INSTALL_PREFIX}")
+message(STATUS "CMAKE_INSTALL_BINDIR =  ${CMAKE_INSTALL_BINDIR}")
 message(STATUS "CMAKE_DISABLE_PRECOMPILE_HEADERS = ${CMAKE_DISABLE_PRECOMPILE_HEADERS}")
 message(STATUS "C++ flags (General) =   ${CMAKE_CXX_FLAGS}")
 message(STATUS "C++ flags (Release) =   ${CMAKE_CXX_FLAGS_RELEASE}")
@@ -109,6 +110,7 @@ message(STATUS)
 message(STATUS "USE_LIBCXX =            ${USE_LIBCXX}")
 message(STATUS)
 message(STATUS "FILESDIR =              ${FILESDIR}")
+message(STATUS "FILESDIR_INSTALL =      ${FILESDIR_INSTALL}")
 message(STATUS "FILESDIR_DEF =          ${FILESDIR_DEF}")
 message(STATUS)