Introducing ClangFormat tool for code formatting (#379)

* first impl of clang format

* added clang format in CI

* fixe var name

* fixed path

* test non-formatting code

* reverted changes

* fixed include headers sorting

* fixed pipeline

Author: JeanPhilippeKernel

.github/workflows/Engine-CI.yml

@@ -5,10 +5,20 @@ on:
     branches: [ master, develop ]
 
 jobs:
+  clang-format:
+    strategy:
+      matrix:
+        directories: [ZEngine, Tetragrama]
+    uses: ./.github/workflows/job-clangformat.yml
+    with:
+      srcDirectory: ${{ matrix.directories }}
+
   windows:
+    needs: clang-format
     uses: ./.github/workflows/windows-build.yml
 
   macOS:
+    needs: clang-format
     uses: ./.github/workflows/macOS-build.yml
 
   # linux:

.github/workflows/job-clangformat.yml

@@ -0,0 +1,19 @@
+name: ZEngine Code Formatting
+
+on:
+    workflow_call:
+        inputs:
+            srcDirectory:
+                type: string
+
+jobs:
+    format:
+        name: clang-format
+        runs-on: windows-2022
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v4
+
+            - name: Checking formatting
+              run: .\Scripts\ClangFormat.ps1 -SourceDirectory ${{ github.workspace }}/${{ inputs.srcDirectory }} -RunAsCheck 1
+              shell: pwsh

.github/workflows/job-cmakebuild-macOS.yml

@@ -21,7 +21,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: CMake Build
-        run: .\Scripts\BuildEngine.ps1 -Configurations ${{inputs.configuration}}
+        run: .\Scripts\BuildEngine.ps1 -Configurations ${{inputs.configuration}} -RunClangFormat 0
         shell: pwsh
 
       - name: Publish Build Artifacts

.github/workflows/job-cmakebuild-windows.yml

@@ -18,7 +18,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: CMake Build
-        run: .\Scripts\BuildEngine.ps1 -Configurations ${{inputs.configuration}}
+        run: .\Scripts\BuildEngine.ps1 -Configurations ${{inputs.configuration}} -RunClangFormat 0
         shell: pwsh
 
       - name: Publish Build Artifacts

README.md

@@ -1,4 +1,4 @@
-[![ZEngine Windows Build](https://github.com/JeanPhilippeKernel/RendererEngine/actions/workflows/windows-build.yml/badge.svg)](https://github.com/JeanPhilippeKernel/RendererEngine/actions/workflows/windows-build.yml)	[![ZEngine Linux Build](https://github.com/JeanPhilippeKernel/RendererEngine/actions/workflows/linux-build.yml/badge.svg)](https://github.com/JeanPhilippeKernel/RendererEngine/actions/workflows/linux-build.yml) [![ZEngine macOS Build](https://github.com/JeanPhilippeKernel/RendererEngine/actions/workflows/macOS-build.yml/badge.svg)](https://github.com/JeanPhilippeKernel/RendererEngine/actions/workflows/macOS-build.yml) 
+[![Engine Build and Tests](https://github.com/JeanPhilippeKernel/RendererEngine/actions/workflows/Engine-CI.yml/badge.svg)]
 
 [![Discord Server](https://discord.com/api/guilds/1249429728624906405/widget.png?style=banner2)](https://discord.gg/jC3GPVKKsW)
 
@@ -25,6 +25,7 @@ Before building, make sure your setup is correct :
 - Install [Python](https://www.python.org/ftp/python/3.12.4/python-3.12.4-amd64.exe)
 - Install [CMake](https://cmake.org/download/) 3.20 or later.
 - Install [DOTNET SDK 6](https://dotnet.microsoft.com/en-us/download/dotnet/6.0)
+- Install [LLVM](https://github.com/llvm/llvm-project/releases/download/llvmorg-18.1.8/LLVM-18.1.8-win64.exe)
 
 ### Setup macOS machine
 
@@ -53,6 +54,12 @@ Before building, make sure your setup is correct :
 ```
 - Install [DOTNET SDK 6](https://dotnet.microsoft.com/en-us/download/dotnet/6.0)
 
+- Install ClangFormat through Homebrew:
+```bash
+    brew update
+    brew install clang-format@18
+```
+
 ## Building the engine & launcher
 
 1. Start `Powershell Core` and make sure that you can run CMake, You can type `cmake --version` to simply output the current CMake version installed.

Scripts/BuildEngine.ps1

@@ -31,6 +31,12 @@ param (
     [Parameter(HelpMessage = "Whether to run build, default to True")]
     [bool] $RunBuilds = $True,
 
+    [Parameter(HelpMessage = "Whether to run clang format to format the code, default to True")]
+    [bool] $RunClangFormat = $True,
+
+    [Parameter(HelpMessage = "Whether to check code formatting correctness, default to False")]
+    [bool] $VerifyFormatting = $False,
+
     [Parameter(HelpMessage = "Whether to rebuild shader files")]
     [switch] $ForceShaderRebuild,
 
@@ -233,8 +239,28 @@ function Build([string]$configuration, [int]$VsVersion , [bool]$runBuild) {
     }
 }
 
-# Run Shader Compilation
+
 if(-Not $LauncherOnly) {
+
+    # Run Clang format
+    if ($RunClangFormat) {
+        [string]$clangFormatScript = Join-Path $PSScriptRoot -ChildPath "ClangFormat.ps1"
+        [string[]]$srcDirectories = @(
+            (Join-Path $repositoryRootPath -ChildPath "ZEngine"),
+            (Join-Path $repositoryRootPath -ChildPath "Tetragrama")
+        )
+    
+        foreach ($directory in $srcDirectories) {
+            & pwsh -File $clangFormatScript -SourceDirectory $directory -RunAsCheck:$VerifyFormatting
+    
+            if ($LASTEXITCODE -ne 0) {
+                Write-Error "Stopped build process..." -ErrorAction Stop
+            }
+        }
+    }
+
+
+    # Run Shader Compilation
     [bool]$forceRebuild = If ($ForceShaderRebuild) { $True } Else { $False }
     foreach ($config in $Configurations) {
         $shaderCompileScript = Join-Path $PSScriptRoot -ChildPath "ShaderCompile.ps1"

Scripts/ClangFormat.ps1

@@ -0,0 +1,66 @@
+# MIT License
+
+# Copyright (c) 2024 Jean Philippe & Contributors
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+#Requires -PSEdition Core
+
+param (
+    [Parameter(Mandatory, HelpMessage = "The directory that contains source code to format")]
+    [string]$SourceDirectory,
+
+    [Parameter(HelpMessage = "Whether clang-format should only check if the source code is well-formatted")]
+    [bool]$RunAsCheck=$False
+)
+
+$ErrorActionPreference = "Stop"
+
+. (Join-Path $PSScriptRoot Shared.ps1)
+
+$srcFiles = Get-ChildItem -Path $SourceDirectory -Recurse -File | Where-Object { $_.Name -notlike "CMakeLists*" -and $_.Name -notlike "*.json" }
+
+if ($srcFiles.Count -eq 0) {
+    Write-Host "No source files found in the specified directory."
+    return
+}
+
+$srcFiles = $srcFiles | ForEach-Object { $_.FullName }
+
+Write-Host "Running clang-format on $SourceDirectory..."
+
+[string[]] $clangFormatArgument = "-i", "--ferror-limit=0", "-fallback-style=none", "--style=file"
+
+if ($RunAsCheck) {
+    $clangFormatArgument += "--dry-run", "--Werror"
+}
+
+$clangFormatProgram = Find-ClangFormat
+
+$process = Start-Process $clangFormatProgram -ArgumentList "$clangFormatArgument $srcFiles" -NoNewWindow -PassThru
+$handle = $process.Handle
+$process.WaitForExit()
+$exitCode = $process.ExitCode
+
+if ($exitCode -ne 0) {
+    Write-Error "clang-format failed formatting source with exit code '$exitCode'" -ErrorAction Stop
+}
+else {
+    Write-Host "clang-format source formatting succeeded"
+}

Scripts/Shared.ps1

@@ -183,7 +183,36 @@ function Find-GlslangValidator () {
     throw "Failed to find glslangValidator. Tried: " + ($GlslangValidatorCandidates -join ', ')
 }
 
+function Find-ClangFormat () {
+    $repoConfiguration = Get-RepositoryConfiguration
+    $LLVMMinimumVersion = $repoConfiguration.Requirements.LLVM.Version
+    $LLVMMaximumVersion = $repoConfiguration.Requirements.LLVM.MaximumVersion
+
+    $candidates = @(
+        'clang-format'
+        if ($IsMacOS) {
+            $brewPrefixPath = Invoke-Expression -Command "& brew --prefix"
+            Join-Path $brewPrefixPath -ChildPath 'opt/llvm/bin/clang-format'
+        }
+        if ($IsWindows) {
+            Join-Path -Path $env:ProgramFiles -ChildPath 'LLVM\bin\clang-format.exe'
+        }
+    )
 
+    foreach ($candidate in $candidates) {
+        $clangFormatCommand = Get-Command $candidate -ErrorAction SilentlyContinue
+        if ($clangFormatCommand) {
+            if ((& $clangFormatCommand --version | Out-String) -match "clang-format version ([\d\.]*)") {
+                [Version] $clangFormatVersion = $Matches[1]
+                if ((CompareVersion $clangFormatVersion $LLVMMinimumVersion) -and (CompareVersion $LLVMMaximumVersion $clangFormatVersion)) {
+                    return $clangFormatCommand.Source
+                }
+            }
+        }
+    }
+
+    throw "Failed to find clang-format min $LLVMMinimumVersion max $LLVMMaximumVersion. Tried: " + ($candidates -join ', ')
+}
 
 function Setup-ShaderCCompilerTool () {
     $repoConfiguration = Get-RepositoryConfiguration

Tetragrama/src/Components/AboutUIComponent.h

@@ -1,13 +1,16 @@
 #pragma once
 #include <ZEngine/ZEngine.h>
 
-namespace Tetragrama::Components {
-    class AboutUIComponent : public ZEngine::Components::UI::UIComponent {
+namespace Tetragrama::Components
+{
+    class AboutUIComponent : public ZEngine::Components::UI::UIComponent
+    {
     public:
         AboutUIComponent(std::string_view name = "AboutUIComponent", bool visibility = true) : UIComponent(name, visibility, true) {}
         virtual ~AboutUIComponent() = default;
 
-        virtual void Render() override {
+        virtual void Render() override
+        {
             ImGui::ShowAboutWindow(&m_is_open);
         }
 

Tetragrama/src/Components/DemoUIComponent.h

@@ -1,13 +1,16 @@
 #pragma once
 #include <ZEngine/ZEngine.h>
 
-namespace Tetragrama::Components {
-    class DemoUIComponent : public ZEngine::Components::UI::UIComponent {
+namespace Tetragrama::Components
+{
+    class DemoUIComponent : public ZEngine::Components::UI::UIComponent
+    {
     public:
         DemoUIComponent(std::string_view name = "DemoUIComponent", bool visibility = true) : UIComponent(name, visibility, true) {}
         virtual ~DemoUIComponent() = default;
 
-        virtual void Render() override {
+        virtual void Render() override
+        {
             ImGui::ShowDemoWindow(&m_is_open);
         }
 

Tetragrama/src/Components/DockspaceUIComponent.cpp

@@ -1,17 +1,15 @@
 #include <pch.h>
 #include <DockspaceUIComponent.h>
-#include <ZEngine/Logging/LoggerDefinition.h>
+#include <Editor.h>
 #include <Event/EventDispatcher.h>
-#include <imgui/src/imgui_internal.h>
+#include <Helpers/UIDispatcher.h>
+#include <Helpers/WindowsHelper.h>
+#include <Importers/AssimpImporter.h>
 #include <MessageToken.h>
 #include <Messengers/Messenger.h>
-#include <Helpers/WindowsHelper.h>
-#include <Editor.h>
-#include <Helpers/UIDispatcher.h>
-
-
+#include <ZEngine/Logging/LoggerDefinition.h>
 #include <fmt/format.h>
-#include <Importers/AssimpImporter.h>
+#include <imgui/src/imgui_internal.h>
 
 namespace fs = std::filesystem;
 using namespace ZEngine::Components::UI::Event;
@@ -24,7 +22,6 @@ namespace Tetragrama::Components
     std::string DockspaceUIComponent::s_asset_importer_report_msg         = "";
     float       DockspaceUIComponent::s_editor_scene_serializer_progress  = 0.0f;
 
-
     DockspaceUIComponent::DockspaceUIComponent(std::string_view name, bool visibility)
         : UIComponent(name, visibility, false), m_asset_importer(ZEngine::CreateScope<Importers::AssimpImporter>()),
           m_editor_serializer(ZEngine::CreateScope<Serializers::EditorSceneSerializer>())
@@ -68,7 +65,7 @@ namespace Tetragrama::Components
 
 #ifdef _WIN32
         std::replace(scene_fullname.begin(), scene_fullname.end(), '/', '\\'); // Todo : Move this replace into an helper function....
-#endif // _WIN32
+#endif                                                                         // _WIN32
 
         m_editor_serializer->Deserialize(scene_fullname);
     }
@@ -384,7 +381,7 @@ namespace Tetragrama::Components
             ImGui::SameLine();
             if (ImGui::Button("Cancel", ImVec2(120, 0)))
             {
-                m_open_exit = false;
+                m_open_exit        = false;
                 m_pending_shutdown = false;
                 ImGui::CloseCurrentPopup();
             }

Tetragrama/src/Components/DockspaceUIComponent.h

@@ -1,8 +1,8 @@
 #pragma once
-#include <ZEngine/ZEngine.h>
-#include <Message.h>
 #include <Importers/IAssetImporter.h>
+#include <Message.h>
 #include <Serializers/EditorSceneSerializer.h>
+#include <ZEngine/ZEngine.h>
 
 namespace Tetragrama::Components
 {

Tetragrama/src/Components/Events/SceneTextureAvailableEvent.h

@@ -1,23 +1,28 @@
 #pragma once
 #include <ZEngine/ZEngine.h>
 
-namespace Tetragrama::Components::Event {
+namespace Tetragrama::Components::Event
+{
 
-    class SceneTextureAvailableEvent : public ZEngine::Components::UI::Event::UIComponentEvent {
+    class SceneTextureAvailableEvent : public ZEngine::Components::UI::Event::UIComponentEvent
+    {
     public:
         SceneTextureAvailableEvent(uint32_t texture_identifier) : m_texture_identifier(texture_identifier) {}
 
         EVENT_TYPE(SceneTextureAvailable)
 
-        uint32_t GetSceneTexture() const {
+        uint32_t GetSceneTexture() const
+        {
             return m_texture_identifier;
         }
 
-        virtual ZEngine::Event::EventType GetType() const override {
+        virtual ZEngine::Event::EventType GetType() const override
+        {
             return GetStaticType();
         }
 
-        virtual int GetCategory() const override {
+        virtual int GetCategory() const override
+        {
             return GetStaticCategory();
         }
 

Tetragrama/src/Components/Events/SceneViewportFocusedEvent.h

@@ -1,20 +1,24 @@
 #pragma once
 #include <ZEngine/ZEngine.h>
 
-namespace Tetragrama::Components::Event {
+namespace Tetragrama::Components::Event
+{
 
-    class SceneViewportFocusedEvent : public ZEngine::Components::UI::Event::UIComponentEvent {
+    class SceneViewportFocusedEvent : public ZEngine::Components::UI::Event::UIComponentEvent
+    {
     public:
         SceneViewportFocusedEvent()  = default;
         ~SceneViewportFocusedEvent() = default;
 
         EVENT_TYPE(SceneViewportFocused)
 
-        virtual ZEngine::Event::EventType GetType() const override {
+        virtual ZEngine::Event::EventType GetType() const override
+        {
             return GetStaticType();
         }
 
-        virtual int GetCategory() const override {
+        virtual int GetCategory() const override
+        {
             return GetStaticCategory();
         }
     };