Initial SonarQube improvements

Author: vbaderks

.github/workflows/sonarcloud_analysis.yml

@@ -0,0 +1,43 @@
+# SPDX-FileCopyrightText: © 2025 Team CharLS
+# SPDX-License-Identifier: BSD-3-Clause
+
+name: SonarCloud Analysis
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types: [opened, synchronize, reopened]
+jobs:
+  build:
+    name: Build
+    runs-on: windows-latest
+    env:
+      BUILD_WRAPPER_OUT_DIR: build_wrapper_output_directory # Directory where build-wrapper output will be placed
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+          fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis
+
+      - name: Set up msbuild
+        uses: microsoft/setup-msbuild@v2
+
+      - name: Install sonar-scanner and build-wrapper
+        uses: SonarSource/sonarcloud-github-c-cpp@v3
+
+      - name: Restore NuGet packages
+        working-directory: ${{env.GITHUB_WORKSPACE}}
+        run: nuget restore ${{env.SOLUTION_FILE_PATH}}
+
+      - name: Run build-wrapper
+        run: |
+          build-wrapper-win-x86-64 --out-dir ${{ env.BUILD_WRAPPER_OUT_DIR }} msbuild netpbm-wic-codec.sln /t:netpbm-wic-codec:rebuild /p:Configuration="Release" /p:Platform="x64" /nodeReuse:false
+
+      - name: Run sonar-scanner
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }} # Put the name of your token here
+        run: |
+          sonar-scanner --define sonar.cfamily.build-wrapper-output="${{ env.BUILD_WRAPPER_OUT_DIR }}"

setup/shell-change-notify-custom-action/dll_main.cpp

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: BSD-3-Clause
 
 #include <Windows.h>
-#include <msiquery.h>
+#include <MsiQuery.h>
 #include <ShlObj.h>
 
 unsigned int __stdcall SHChangeNotifyCustomAction(const MSIHANDLE install)

sonar-project.properties

@@ -0,0 +1,15 @@
+# SPDX-FileCopyrightText: © 2025 Team CharLS
+# SPDX-License-Identifier: BSD-3-Clause
+
+sonar.projectKey = team-charls_netpbm-wic-codec
+sonar.organization = team-charls
+
+# This is the name and version displayed in the SonarCloud UI.
+sonar.projectVersion = 1.0
+
+# Define the source code to scan (only scan files that are part of the NetPbm-WIC codec)
+sonar.sources = src/
+sonar.tests = test/
+
+# Encoding of the source code files. Default is the default system encoding, which is not correct.
+sonar.sourceEncoding=UTF-8

src/dll_main.cpp

@@ -167,13 +167,13 @@ void register_property_store()
 // ReSharper disable CppInconsistentNaming
 // ReSharper disable CppParameterNamesMismatch
 
-BOOL __stdcall DllMain(const HMODULE module, const DWORD reason_for_call, void* /*reserved*/) noexcept
+BOOL __stdcall DllMain(const HMODULE dll_module, const DWORD reason_for_call, void* /*reserved*/) noexcept
 {
     switch (reason_for_call)
     {
     case DLL_PROCESS_ATTACH:
         TRACE("netpbm-wic-codec::DllMain DLL_PROCESS_ATTACH \n");
-        VERIFY(DisableThreadLibraryCalls(module));
+        VERIFY(DisableThreadLibraryCalls(dll_module));
         break;
 
     case DLL_THREAD_ATTACH:

src/util.ixx

@@ -17,11 +17,11 @@ namespace {
 
 [[nodiscard]] HMODULE get_current_module() noexcept
 {
-    HMODULE module;
+    HMODULE current_module;
     GetModuleHandleExW(GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS | GET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT,
-                       reinterpret_cast<PCWSTR>(get_current_module), &module);
+                       reinterpret_cast<PCWSTR>(get_current_module), &current_module);
 
-    return module;
+    return current_module;
 }
 
 } // namespace