Support llvm 22 for clang-format (#485)

MathewBensonCode · web-flow · commit e07ed9533796 · 2026-03-31T12:47:51.000+09:00
- Isolate code that has changed in behaviour since version 20 and use
  clang-format off comments to ignore
  - CoroutineScheduler.h and VulkanDevice.h for
    operator bool()
  - VulkanDevice.cpp for re-aligned declarations
  - RenderPasses.cpp for re-aligned function signature
- update CI workflows for all OSs to use version 22

Co-authored-by: Mathew Benson &lt;mathew@benson.co.ke&gt;
diff --git a/.github/workflows/job-clangformat.yml b/.github/workflows/job-clangformat.yml
@@ -14,6 +14,9 @@ jobs:
             - name: Checkout repository
               uses: actions/checkout@v4
 
+            - name: update llvm to version 22
+              run: choco upgrade llvm
+
             - name: Checking formatting
               run: .\Scripts\ClangFormat.ps1 -SourceDirectory ${{ github.workspace }}/${{ inputs.srcDirectory }} -RunAsCheck 1
               shell: pwsh
diff --git a/.github/workflows/job-cmakebuild-linux.yml b/.github/workflows/job-cmakebuild-linux.yml
@@ -25,16 +25,17 @@ jobs:
     - name: Register the Microsoft repository GPG keys
       run: sudo dpkg -i packages-microsoft-prod.deb
 
-    - name: Install LLVM-20
+    - name: Install LLVM-22
       run: |
           wget https://apt.llvm.org/llvm.sh
           chmod +x llvm.sh
-          sudo ./llvm.sh 20
+          sudo ./llvm.sh 22
 
-    - name: Update the list of packages after we added packages.microsoft.com
+    - name: Update the list of packages
       run: sudo apt-get update
-    - name: Install development library
-      run: sudo apt-get install libasound2-dev libgl1-mesa-dev libpulse-dev libdbus-1-dev libx11-dev libxcursor-dev libxext-dev libxi-dev libxinerama-dev libxrandr-dev libxss-dev libxt-dev libxxf86vm-dev cmake apt-transport-https software-properties-common gcc g++ powershell clang-format-20 libwayland-dev libxkbcommon-dev dotnet-sdk-8.0
+
+    - name: Install Dependencies
+      run: sudo apt-get install libasound2-dev libgl1-mesa-dev libpulse-dev libdbus-1-dev libx11-dev libxcursor-dev libxext-dev libxi-dev libxinerama-dev libxrandr-dev libxss-dev libxt-dev libxxf86vm-dev cmake apt-transport-https software-properties-common gcc g++ powershell clang-format-22 glslang-tools libwayland-dev libxkbcommon-dev
 
     - name: CMake Build
       run: .\Scripts\BuildEngine.ps1 -Configurations ${{inputs.configuration}}
diff --git a/.github/workflows/job-cmakebuild-macOS.yml b/.github/workflows/job-cmakebuild-macOS.yml
@@ -26,6 +26,9 @@ jobs:
       - name: Install NuGet CLI
         run: brew install nuget
 
+      - name: Update LLVM
+        run: brew install llvm
+
       - name: CMake Build
         run: .\Scripts\BuildEngine.ps1 -Configurations ${{inputs.configuration}} -Architecture ${{inputs.architecture}} -RunClangFormat 0
         shell: pwsh
diff --git a/.github/workflows/job-cmakebuild-windows.yml b/.github/workflows/job-cmakebuild-windows.yml
@@ -18,11 +18,14 @@ on:
 jobs:
   cmake-build:
     name: cmake-build-windows-${{ inputs.configuration }}
-    runs-on: windows-2022
+    runs-on: windows-2025
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
 
+      - name: update llvm to version 22
+        run: choco upgrade llvm
+
       - name: CMake Build
         run: .\Scripts\BuildEngine.ps1 -Configurations ${{inputs.configuration}} -RunClangFormat 0
         shell: pwsh
diff --git a/.github/workflows/job-deploy-windows.yml b/.github/workflows/job-deploy-windows.yml
@@ -15,7 +15,7 @@ on:
 jobs:
   deploy:
     name: deploy-windows-x64-${{ inputs.configuration }}
-    runs-on: windows-2022
+    runs-on: windows-2025
     steps:
       - uses: actions/download-artifact@v4
         with:
diff --git a/.github/workflows/job-test-windows.yml b/.github/workflows/job-test-windows.yml
@@ -12,7 +12,7 @@ on:
 jobs:
   test:
     name: test-windows-${{ inputs.configuration }}
-    runs-on: windows-2022
+    runs-on: windows-2025
     steps:
       - name: Download All Artifacts
         uses: actions/download-artifact@v4
diff --git a/Scripts/Shared.ps1 b/Scripts/Shared.ps1
@@ -201,6 +201,8 @@ function Find-ClangFormat () {
         }
         if ($IsLinux) {
             '/usr/bin/clang-format'
+            '/usr/bin/clang-format-22'
+            '/usr/bin/clang-format-21'
             '/usr/bin/clang-format-20'
         }
         'clang-format'
diff --git a/ZEngine/ZEngine/Core/CoroutineScheduler.h b/ZEngine/ZEngine/Core/CoroutineScheduler.h
@@ -14,11 +14,12 @@ namespace ZEngine::Core
 
         ReadyCallback   Ready  = nullptr;
         ExecuteCallback Action = nullptr;
-
+        // clang-format off
         operator bool() noexcept
         {
             return (Ready && Action);
         }
+        // clang-format on
     };
 
     struct CoroutineScheduler
diff --git a/ZEngine/ZEngine/Hardwares/VulkanDevice.cpp b/ZEngine/ZEngine/Hardwares/VulkanDevice.cpp
@@ -633,6 +633,7 @@ namespace ZEngine::Hardwares
         VkSemaphore          semaphores[] = {signal_semaphore->GetHandle()};
         VkCommandBuffer      buffers[]    = {command_buffer->GetHandle()};
         VkSubmitInfo         submit_info  = {
+            // clang-format off
                      .sType                = VK_STRUCTURE_TYPE_SUBMIT_INFO,
                      .pNext                = nullptr,
                      .waitSemaphoreCount   = 0,
@@ -642,6 +643,7 @@ namespace ZEngine::Hardwares
                      .pCommandBuffers      = buffers,
                      .signalSemaphoreCount = 0,
                      .pSignalSemaphores    = 0,
+            //clang-format on
         };
 
         ZENGINE_VALIDATE_ASSERT(vkQueueSubmit(GetQueue(command_buffer->QueueType).Handle, 1, &submit_info, fence->GetHandle()) == VK_SUCCESS, "Failed to submit queue")
@@ -2582,10 +2584,12 @@ namespace ZEngine::Hardwares
         uint32_t                             byte_per_pixel = Specifications::BytePerChannelMap[VALUE_FROM_SPEC_MAP(Specifications::ImageFormat::R8G8B8A8_SRGB)];
 
         Specifications::TextureSpecification spec           = {
+          // clang-format off
                       .Width        = width,
                       .Height       = height,
                       .BytePerPixel = byte_per_pixel,
                       .Format       = Specifications::ImageFormat::R8G8B8A8_SRGB,
+            // clang-format on
         };
 
         auto tex_handle = CreateTexture(spec);
diff --git a/ZEngine/ZEngine/Hardwares/VulkanDevice.h b/ZEngine/ZEngine/Hardwares/VulkanDevice.h
@@ -76,11 +76,12 @@ namespace ZEngine::Hardwares
         BufferType    Type       = BufferType::UNKNOWN;
         VkBuffer      Handle     = VK_NULL_HANDLE;
         VmaAllocation Allocation = nullptr;
-
+        // clang-format off
         operator bool() const
         {
             return (Handle != VK_NULL_HANDLE);
         }
+        // clang-format on
     };
 
     struct BufferImage
@@ -90,11 +91,12 @@ namespace ZEngine::Hardwares
         VkImageView   ViewHandle{VK_NULL_HANDLE};
         VkSampler     Sampler{VK_NULL_HANDLE};
         VmaAllocation Allocation{nullptr};
-
+        // clang-format off
         operator bool() const
         {
             return (Handle != VK_NULL_HANDLE);
         }
+        // clang-format on
     };
 
     struct IGraphicBuffer
diff --git a/ZEngine/ZEngine/Rendering/Renderers/RendererPasses.cpp b/ZEngine/ZEngine/Rendering/Renderers/RendererPasses.cpp
@@ -52,7 +52,7 @@ namespace ZEngine::Rendering::Renderers
                                  .EnablePipelineDepthTest(true)
                                  .UseShader("initial")
                                  .Detach();
-            *output_pass = device->CreateRenderPass(pass_spec);
+            *output_pass   = device->CreateRenderPass(pass_spec);
             (*output_pass)->Bake();
         }
     }
@@ -90,8 +90,9 @@ namespace ZEngine::Rendering::Renderers
 
                                  .UseShader("depth_prepass_scene")
                                  .Detach();
-
+            // clang-format off
             *output_pass = device->CreateRenderPass(pass_spec);
+            // clang-format on
             (*output_pass)->Bake();
         }
 
@@ -166,8 +167,9 @@ namespace ZEngine::Rendering::Renderers
 
                                  .UseShader("skybox")
                                  .Detach();
-
+            // clang-format off
             *output_pass = device->CreateRenderPass(pass_spec);
+            // clang-format on
             (*output_pass)->Bake();
         }
 
@@ -255,7 +257,9 @@ namespace ZEngine::Rendering::Renderers
                                  .EnablePipelineDepthTest(true)
                                  .UseShader("infinite_grid")
                                  .Detach();
+            // clang-format off
             *output_pass = device->CreateRenderPass(pass_spec);
+            // clang-format on
             (*output_pass)->Bake();
         }
 
diff --git a/repoConfiguration.json b/repoConfiguration.json
@@ -24,7 +24,7 @@
         },
         "LLVM": {
             "Version": "20.1.7",
-            "MaximumVersion": "20.2.0"
+            "MaximumVersion": "22.2.0"
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -201,6 +201,8 @@ function Find-ClangFormat () {`
`201`	`201`	`}`
`202`	`202`	`if ($IsLinux) {`
`203`	`203`	`'/usr/bin/clang-format'`
	`204`	`+ '/usr/bin/clang-format-22'`
	`205`	`+ '/usr/bin/clang-format-21'`
`204`	`206`	`'/usr/bin/clang-format-20'`
`205`	`207`	`}`
`206`	`208`	`'clang-format'`
Original file line number	Diff line number	Diff line change
`@@ -14,11 +14,12 @@ namespace ZEngine::Core`
`14`	`14`
`15`	`15`	`ReadyCallback Ready = nullptr;`
`16`	`16`	`ExecuteCallback Action = nullptr;`
`17`		`-`
	`17`	`+ // clang-format off`
`18`	`18`	`operator bool() noexcept`
`19`	`19`	`{`
`20`	`20`	`return (Ready && Action);`
`21`	`21`	`}`
	`22`	`+ // clang-format on`
`22`	`23`	`};`
`23`	`24`
`24`	`25`	`struct CoroutineScheduler`