preparation for clang format (#5422)

* Clang-format excludes

* Add .clang-format

* Don't clang-format in external

* Missing includes and forward declarations

* Replace wonky include-once macro name

* neaten include naming

* Add clang-format to formatting script

* Add xargs and diff to required binaries

* add clang-format to ci formatting check

* Add max version check to formatting script

* temporarily disable checking formatting for cpp files

Author: expipiplus1

.clang-format

@@ -0,0 +1,44 @@
+BasedOnStyle: LLVM
+
+# Whitespace
+MaxEmptyLinesToKeep: 2
+IndentWidth: 4
+ColumnLimit: 100
+
+# Preprocessor
+AlignEscapedNewlines: Left
+IncludeBlocks: Regroup
+
+# Functions
+AllowAllArgumentsOnNextLine: false
+BinPackArguments: false
+BinPackParameters: false
+AllowAllParametersOfDeclarationOnNextLine: false
+PenaltyReturnTypeOnItsOwnLine: 9999999
+PenaltyBreakBeforeFirstCallParameter: 6
+AllowShortFunctionsOnASingleLine: Inline
+
+# Brackets and braces
+AlignAfterOpenBracket: AlwaysBreak
+BreakBeforeBraces: Allman
+
+# Pointers
+PointerAlignment: Left
+
+# Classes
+PackConstructorInitializers: NextLineOnly
+BreakConstructorInitializers: BeforeComma
+AccessModifierOffset: -4
+
+# Switch statements
+IndentCaseBlocks: true
+AllowShortCaseLabelsOnASingleLine: true
+AlignConsecutiveShortCaseStatements:
+  Enabled: true
+
+# Templates
+SpaceAfterTemplateKeyword: false
+AlwaysBreakTemplateDeclarations: true
+
+# Misc
+SortUsingDeclarations: false

.github/actions/format-setup/action.yml

@@ -16,6 +16,6 @@ runs:
         tmpdir=$(mktemp -d)
         curl -L -H "Authorization: token ${{github.token}}" \
           -o "$tmpdir/clang-format" \
-          https://github.com/shader-slang/slang-binaries/raw/4e88845ec51641b4c92e68027e359090bdb219e0/clang-format/x86_64-linux/bin/clang-format
+          https://github.com/shader-slang/slang-binaries/raw/306d22efc0f5f72c7230b0b6b7c99f03c46995bd/clang-format/x86_64-linux/bin/clang-format
         chmod +x "$tmpdir/clang-format"
         echo "$tmpdir" >> $GITHUB_PATH

.github/workflows/check-formatting.yml

@@ -10,7 +10,5 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - name: Setup
-        uses: ./.github/actions/format-setup
+      - uses: ./.github/actions/format-setup
       - run: ./extras/formatting.sh --check-only
-

examples/example-base/test-base.cpp

@@ -1,8 +1,11 @@
 #include "test-base.h"
 
 #ifdef _WIN32
-#include <windows.h>
-#include <shellapi.h>
+// clang-format off
+// include ordering sensitive
+#    include <windows.h>
+#    include <shellapi.h>
+// clang-format on
 #endif
 
 int TestBase::parseOption(int argc, char** argv)

examples/hello-world/vulkan-api.h

@@ -7,6 +7,7 @@
 // the Vulkan API.
 
 // The Vulkan function pointers we will use in this example.
+// clang-format off
 #define VK_API_GLOBAL_PROCS(x) \
     x(vkGetInstanceProcAddr) \
     x(vkCreateInstance) \
@@ -87,6 +88,7 @@
     /* */
 
 #define VK_API_DECLARE_PROC(NAME) PFN_##NAME NAME = nullptr;
+// clang-format on
 
 struct VulkanAPI
 {

external/.clang-format

@@ -0,0 +1 @@
+DisableFormat: true

extras/.clang-format

@@ -40,7 +40,8 @@ cd "$source_dir" || exit 1
 
 require_bin() {
   local name="$1"
-  local required="$2"
+  local min_version="$2"
+  local max_version="${3:-}"
   local version
 
   if ! command -v "$name" &>/dev/null; then
@@ -50,16 +51,29 @@ require_bin() {
   fi
 
   if [ "$no_version_check" -eq 0 ]; then
-    version=$("$name" --version | grep -oP "$name(?:\s+version)?\s+\K\d+\.\d+\.?\d*")
-    if ! printf '%s\n%s\n' "$required" "$version" | sort -V -C; then
-      echo "$name version $version is too old. Version $required or newer is required."
+    version=$("$name" --version | grep -oP "\d+\.\d+\.?\d*" | head -n1)
+
+    if ! printf '%s\n%s\n' "$min_version" "$version" | sort -V -C; then
+      echo "$name version $version is too old. Version $min_version or newer is required."
       missing_bin=1
+      return
+    fi
+
+    if [ -n "$max_version" ]; then
+      if ! printf '%s\n%s\n' "$version" "$max_version" | sort -V -C; then
+        echo "$name version $version is too new. Version less than $max_version is required."
+        missing_bin=1
+        return
+      fi
     fi
   fi
 }
 
 require_bin "git" "1.8"
 require_bin "gersemi" "0.17"
+require_bin "xargs" "3"
+require_bin "diff" "2"
+require_bin "clang-format" "17" "18"
 
 if [ "$missing_bin" ]; then
   exit 1
@@ -84,7 +98,33 @@ cmake_formatting() {
   fi
 }
 
+cpp_formatting() {
+  readarray -t files < <(git ls-files '*.cpp' '*.hpp' '*.c' '*.h')
+
+  if [ "$check_only" -eq 1 ]; then
+    local tmpdir
+    tmpdir=$(mktemp -d)
+    trap 'rm -rf "$tmpdir"' EXIT
+
+    printf '%s\n' "${files[@]}" | xargs -P "$(nproc)" -I{} bash -c "
+      mkdir -p \"\$(dirname \"$tmpdir/{}\")\"
+      diff -u --color=always --label \"{}\" --label \"{}\" \"{}\" <(clang-format \"{}\") > \"$tmpdir/{}\" 
+      :
+    "
+
+    for file in "${files[@]}"; do
+      if [ -s "$tmpdir/$file" ]; then
+        cat "$tmpdir/$file"
+        exit_code=1
+      fi
+    done
+  else
+    printf '%s\n' "${files[@]}" | xargs -n1 -P "$(nproc)" clang-format -i
+  fi
+}
+
 cmake_formatting
+# Disable until we've formatted the code
+# cpp_formatting
 
 exit $exit_code
-

extras/formatting.sh

@@ -0,0 +1,2 @@
+BasedOnStyle: InheritParentConfig
+IndentPPDirectives: BeforeHash

include/.clang-format

@@ -199,6 +199,7 @@ class IShaderProgram: public ISlangUnknown
 // TODO: Confirm with Yong that we really want this naming convention
 // TODO: Rename to what?
 // Dont' change without keeping in sync with Format
+// clang-format off
 #define GFX_FORMAT(x) \
     x( Unknown, 0, 0) \
     \
@@ -304,8 +305,9 @@ class IShaderProgram: public ISlangUnknown
     \
     x(R64_UINT, 8, 1) \
     \
-    x(R64_SINT, 8, 1) \
-    \
+    x(R64_SINT, 8, 1)
+// clang-format on
+
 // TODO: This should be generated from above
 // TODO: enum class should be explicitly uint32_t or whatever's appropriate
 /// Different formats of things like pixels or elements of vertices

include/slang-gfx.h

@@ -154,6 +154,7 @@ bool isDerivedFrom(ENUM_TYPE kind, ENUM_TYPE base) { return g_table##ENUM_TYPE.i
 
 /* !!!!!!!!!!!!!!!!!!!!!!!!!!!!! ArtifactKind !!!!!!!!!!!!!!!!!!!!!!! */
 
+// clang-format off
 #define SLANG_ARTIFACT_KIND(x) \
     x(Invalid, Invalid) \
     x(Base, Invalid) \
@@ -245,6 +246,7 @@ SLANG_HIERARCHICAL_ENUM(ArtifactPayload, SLANG_ARTIFACT_PAYLOAD, SLANG_ARTIFACT_
             x(Kernel, CodeLike) \
             x(Host, CodeLike) \
         x(Obfuscated, Base) 
+// clang-format on
 
 #define SLANG_ARTIFACT_STYLE_ENTRY(TYPE, PARENT) { Index(ArtifactStyle::TYPE), Index(ArtifactStyle::PARENT), #TYPE },
 

source/compiler-core/slang-artifact-desc-util.cpp

@@ -37,26 +37,33 @@
 // generate code on Windows.
 #if SLANG_ENABLE_DXIL_SUPPORT
 
-#   ifdef _WIN32
-#       include <windows.h>
-#       include <unknwn.h>
-#       include "../../external/dxc/dxcapi.h"
-#   else
-#       include "../../external/dxc/dxcapi.h"
-
-#       ifdef __uuidof
-            // DXC's WinAdapter.h defines __uuidof(T) over types, but the existing
-            // usage in this file is over values (both are accepted on MSVC.)
-            // We also need to decay through Slang::ComPtr, hence the helper struct
-            template <typename T>
-            struct StripSlangComPtr { using type = T; };
-            template <typename T>
-            struct StripSlangComPtr<Slang::ComPtr<T>> { using type = T; };
-#           undef __uuidof
-#           define __uuidof(x) __emulated_uuidof<StripSlangComPtr<std::decay_t<decltype(x)>>::type>()
-#       endif
-#   endif
-
+#    ifdef _WIN32
+#        include <unknwn.h>
+#        include <windows.h>
+#    endif
+
+#    include "../../external/dxc/dxcapi.h"
+
+#    ifndef _WIN32
+#        ifdef __uuidof
+// DXC's WinAdapter.h defines __uuidof(T) over types, but the existing
+// usage in this file is over values (both are accepted on MSVC.)
+// We also need to decay through Slang::ComPtr, hence the helper struct
+template<typename T>
+struct StripSlangComPtr
+{
+    using type = T;
+};
+template<typename T>
+struct StripSlangComPtr<Slang::ComPtr<T>>
+{
+    using type = T;
+};
+#            undef __uuidof
+#            define __uuidof(x) \
+                __emulated_uuidof<StripSlangComPtr<std::decay_t<decltype(x)>>::type>()
+#        endif
+#    endif
 #endif
 
 namespace Slang

source/compiler-core/slang-dxc-compiler.cpp

@@ -41,6 +41,7 @@ typedef enum {
 
 typedef struct _nvrtcProgram *nvrtcProgram;
 
+// clang-format off
 #define SLANG_NVRTC_FUNCS(x) \
     x(const char*, nvrtcGetErrorString, (nvrtcResult result)) \
     x(nvrtcResult, nvrtcVersion, (int *major, int *minor)) \
@@ -53,6 +54,7 @@ typedef struct _nvrtcProgram *nvrtcProgram;
     x(nvrtcResult, nvrtcGetProgramLog, (nvrtcProgram prog, char *log))\
     x(nvrtcResult, nvrtcAddNameExpression, (nvrtcProgram prog, const char * const name_expression)) \
     x(nvrtcResult, nvrtcGetLoweredName, (nvrtcProgram prog, const char *const name_expression, const char** lowered_name))
+// clang-format on
 
 } // namespace nvrtc
 

source/compiler-core/slang-nvrtc-compiler.cpp

@@ -1,7 +1,7 @@
 #ifndef SLANG_CORE_BLOB_H
 #define SLANG_CORE_BLOB_H
 
-#include "../../include/slang.h"
+#include "slang.h"
 
 #include "slang-string.h"
 #include "slang-list.h"

source/core/slang-blob.h

@@ -1,7 +1,7 @@
 #ifndef SLANG_CORE_CHUNKED_LIST_H
 #define SLANG_CORE_CHUNKED_LIST_H
 
-#include "../../include/slang.h"
+#include "slang.h"
 
 #include "slang-allocator.h"
 #include "slang-array-view.h"

source/core/slang-chunked-list.h

@@ -1,7 +1,6 @@
-#ifndef SLANG_CORE_COMMON_H
-#define SLANG_CORE_COMMON_H
+#pragma once
 
-#include "../../include/slang.h"
+#include "slang.h"
 
 #include <assert.h>
 
@@ -237,7 +236,6 @@ template<typename T> void slang_use_obj(T&) {}
 
 #define SLANG_UNREFERENCED_PARAMETER(P) slang_use_obj(P)
 #define SLANG_UNREFERENCED_VARIABLE(P) slang_use_obj(P)
-#endif
 
 #if defined(SLANG_RT_DYNAMIC)
 #if defined(_MSC_VER)

source/core/slang-common.h

@@ -1,5 +1,5 @@
 #pragma once
-#include "../../include/slang.h"
+#include "slang.h"
 #include "../core/slang-string.h"
 #include "../core/slang-blob.h"
 #include "../core/slang-list.h"

source/core/slang-crypto.h

@@ -1,7 +1,7 @@
 #ifndef SLANG_FILE_SYSTEM_H_INCLUDED
 #define SLANG_FILE_SYSTEM_H_INCLUDED
 
-#include "../../include/slang.h"
+#include "slang.h"
 #include "slang-com-helper.h"
 #include "slang-com-ptr.h"
 

source/core/slang-file-system.h

@@ -1,7 +1,7 @@
 #ifndef SLANG_CORE_FREE_LIST_H
 #define SLANG_CORE_FREE_LIST_H
 
-#include "../../include/slang.h"
+#include "slang.h"
 
 #include "slang-common.h"