clang-format 18 (#187)

see: awslabs/aws-c-common#1113

.github/workflows/clang-format.yml

@@ -5,14 +5,12 @@ on: [push]
 jobs:
   clang-format:
 
-    runs-on: ubuntu-20.04 # latest
+    runs-on: ubuntu-24.04 # latest
 
     steps:
     - name: Checkout Sources
-      uses: actions/checkout@v1
+      uses: actions/checkout@v4
 
     - name: clang-format lint
-      uses: DoozyX/clang-format-lint-action@v0.3.1
-      with:
-        # List of extensions to check
-        extensions: c,h
+      run: |
+        ./format-check.py

format-check.py

@@ -0,0 +1,47 @@
+#!/usr/bin/env python3
+import argparse
+import os
+from pathlib import Path
+import re
+from subprocess import list2cmdline, run
+from tempfile import NamedTemporaryFile
+
+CLANG_FORMAT_VERSION = '18.1.6'
+
+INCLUDE_REGEX = re.compile(
+    r'^(include|source|tests|verification)/.*\.(c|h|inl)$')
+EXCLUDE_REGEX = re.compile(r'^$')
+
+arg_parser = argparse.ArgumentParser(description="Check with clang-format")
+arg_parser.add_argument('-i', '--inplace-edit', action='store_true',
+                        help="Edit files inplace")
+args = arg_parser.parse_args()
+
+os.chdir(Path(__file__).parent)
+
+# create file containing list of all files to format
+filepaths_file = NamedTemporaryFile(delete=False)
+for dirpath, dirnames, filenames in os.walk('.'):
+    for filename in filenames:
+        # our regexes expect filepath to use forward slash
+        filepath = Path(dirpath, filename).as_posix()
+        if not INCLUDE_REGEX.match(filepath):
+            continue
+        if EXCLUDE_REGEX.match(filepath):
+            continue
+
+        filepaths_file.write(f"{filepath}\n".encode())
+filepaths_file.close()
+
+# use pipx to run clang-format from PyPI
+# this is a simple way to run the same clang-format version regardless of OS
+cmd = ['pipx', 'run', f'clang-format=={CLANG_FORMAT_VERSION}',
+       f'--files={filepaths_file.name}']
+if args.inplace_edit:
+    cmd += ['-i']
+else:
+    cmd += ['--Werror', '--dry-run']
+
+print(f"{Path.cwd()}$ {list2cmdline(cmd)}")
+if run(cmd).returncode:
+    exit(1)

include/aws/cal/symmetric_cipher.h

@@ -15,25 +15,22 @@ AWS_PUSH_SANE_WARNING_LEVEL
 
 struct aws_symmetric_cipher;
 
-typedef struct aws_symmetric_cipher *(aws_aes_cbc_256_new_fn)(
-    struct aws_allocator *allocator,
-    const struct aws_byte_cursor *key,
-    const struct aws_byte_cursor *iv);
-
-typedef struct aws_symmetric_cipher *(aws_aes_ctr_256_new_fn)(
-    struct aws_allocator *allocator,
-    const struct aws_byte_cursor *key,
-    const struct aws_byte_cursor *iv);
-
-typedef struct aws_symmetric_cipher *(aws_aes_gcm_256_new_fn)(
-    struct aws_allocator *allocator,
-    const struct aws_byte_cursor *key,
-    const struct aws_byte_cursor *iv,
-    const struct aws_byte_cursor *aad,
-    const struct aws_byte_cursor *decryption_tag);
-
-typedef struct aws_symmetric_cipher *(
-    aws_aes_keywrap_256_new_fn)(struct aws_allocator *allocator, const struct aws_byte_cursor *key);
+typedef struct aws_symmetric_cipher *(aws_aes_cbc_256_new_fn)(struct aws_allocator *allocator,
+                                                              const struct aws_byte_cursor *key,
+                                                              const struct aws_byte_cursor *iv);
+
+typedef struct aws_symmetric_cipher *(aws_aes_ctr_256_new_fn)(struct aws_allocator *allocator,
+                                                              const struct aws_byte_cursor *key,
+                                                              const struct aws_byte_cursor *iv);
+
+typedef struct aws_symmetric_cipher *(aws_aes_gcm_256_new_fn)(struct aws_allocator *allocator,
+                                                              const struct aws_byte_cursor *key,
+                                                              const struct aws_byte_cursor *iv,
+                                                              const struct aws_byte_cursor *aad,
+                                                              const struct aws_byte_cursor *decryption_tag);
+
+typedef struct aws_symmetric_cipher *(aws_aes_keywrap_256_new_fn)(struct aws_allocator *allocator,
+                                                                  const struct aws_byte_cursor *key);
 
 enum aws_symmetric_cipher_state {
     AWS_SYMMETRIC_CIPHER_READY,

source/cal.c

@@ -6,7 +6,7 @@
 #include <aws/common/common.h>
 #include <aws/common/error.h>
 
-#define AWS_DEFINE_ERROR_INFO_CAL(CODE, STR) [(CODE)-0x1C00] = AWS_DEFINE_ERROR_INFO(CODE, STR, "aws-c-cal")
+#define AWS_DEFINE_ERROR_INFO_CAL(CODE, STR) [(CODE) - 0x1C00] = AWS_DEFINE_ERROR_INFO(CODE, STR, "aws-c-cal")
 
 static struct aws_error_info s_errors[] = {
     AWS_DEFINE_ERROR_INFO_CAL(AWS_ERROR_CAL_SIGNATURE_VALIDATION_FAILED, "Verify on a cryptographic signature failed."),

source/ecc.c

@@ -62,16 +62,14 @@ int aws_ecc_oid_from_curve_name(enum aws_ecc_curve_name curve_name, struct aws_b
     return AWS_OP_SUCCESS;
 }
 
-typedef struct aws_ecc_key_pair *(aws_ecc_key_pair_new_from_public_key_fn)(
-    struct aws_allocator *allocator,
-    enum aws_ecc_curve_name curve_name,
-    const struct aws_byte_cursor *public_key_x,
-    const struct aws_byte_cursor *public_key_y);
-
-typedef struct aws_ecc_key_pair *(aws_ecc_key_pair_new_from_private_key_fn)(
-    struct aws_allocator *allocator,
-    enum aws_ecc_curve_name curve_name,
-    const struct aws_byte_cursor *priv_key);
+typedef struct aws_ecc_key_pair *(aws_ecc_key_pair_new_from_public_key_fn)(struct aws_allocator *allocator,
+                                                                           enum aws_ecc_curve_name curve_name,
+                                                                           const struct aws_byte_cursor *public_key_x,
+                                                                           const struct aws_byte_cursor *public_key_y);
+
+typedef struct aws_ecc_key_pair *(aws_ecc_key_pair_new_from_private_key_fn)(struct aws_allocator *allocator,
+                                                                            enum aws_ecc_curve_name curve_name,
+                                                                            const struct aws_byte_cursor *priv_key);
 
 #ifndef BYO_CRYPTO
 

source/rsa.c

@@ -8,11 +8,11 @@
 #include <aws/cal/hash.h>
 #include <aws/cal/private/der.h>
 
-typedef struct aws_rsa_key_pair *(
-    aws_rsa_key_pair_new_from_public_pkcs1_fn)(struct aws_allocator *allocator, struct aws_byte_cursor public_key);
+typedef struct aws_rsa_key_pair *(aws_rsa_key_pair_new_from_public_pkcs1_fn)(struct aws_allocator *allocator,
+                                                                             struct aws_byte_cursor public_key);
 
-typedef struct aws_rsa_key_pair *(
-    aws_rsa_key_pair_new_from_private_pkcs1_fn)(struct aws_allocator *allocator, struct aws_byte_cursor private_key);
+typedef struct aws_rsa_key_pair *(aws_rsa_key_pair_new_from_private_pkcs1_fn)(struct aws_allocator *allocator,
+                                                                              struct aws_byte_cursor private_key);
 
 #ifndef BYO_CRYPTO