Merge pull request #272 from diptorupd/tools/clang-format

Tools/clang format

Author: diptorupd

.clang-format

@@ -0,0 +1,25 @@
+BasedOnStyle: LLVM
+IndentWidth: 4
+AccessModifierOffset: -4
+AlignEscapedNewlines: Right
+AllowAllParametersOfDeclarationOnNextLine: false
+BinPackParameters: false
+BreakBeforeBraces: Custom
+BraceWrapping:
+  AfterCaseLabel:  true
+  AfterClass:      true
+  AfterControlStatement: MultiLine
+  AfterEnum:       true
+  AfterFunction:   true
+  AfterNamespace:  true
+  AfterObjCDeclaration: false
+  AfterStruct:     true
+  AfterUnion:      true
+  AfterExternBlock: true
+  BeforeCatch:     false
+  BeforeElse:      true
+  IndentBraces:    false
+  SplitEmptyFunction: true
+  SplitEmptyRecord: true
+  SplitEmptyNamespace: true
+  

.git-blame-ignore-revs

@@ -2,3 +2,6 @@
 
 # Migrate code style to Black
 41ccd65e2e659aa0add0e5ab59f1a46e32cc4c46
+
+# Migrate code style to clang-format
+4b0ecc01669bb2d281ee85b54fb76f8a9b94d63f

.github/workflows/clang-format.yml

@@ -0,0 +1,23 @@
+# This is a workflow to format C/C++ sources with clang-format
+
+name: clang-format Check
+
+# Controls when the action will run. Triggers the workflow on push or pull request
+# events but only for the master branch
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  formatting-check:
+    name: Formatting Check
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Run clang-format style check for C/C++ programs.
+      uses: jidicula/[email protected]
+      with:
+        clang-format-version: '11'
+        check-path: 'dpctl-capi'

CONTRIBUTING.md

@@ -2,6 +2,17 @@
 
 ## Source Code Formatting¶
 
+### C/C++ code style
+
+We use [clang-format](https://clang.llvm.org/docs/ClangFormat.html) code formatter.
+
+Install: `pip install clang`
+
+- Revision: `10.0.1`
+- See the default configuration used by dpCtl in `.clang-format`.
+
+Run before each commit: `clang-format -style=file -i dpctl-capi/include/*.h dpctl-capi/include/Support/*.h dpctl-capi/source/*.cpp dpctl-capi/tests/*.cpp dpctl-capi/helper/include/*.h dpctl-capi/helper/source/*.cpp`
+
 ### Python code style
 
 

dpctl-capi/helper/include/dpctl_dynamic_lib_helper.h

@@ -27,16 +27,16 @@
 
 #if defined(__linux__) || defined(_WIN32) || defined(_WIN64)
 
-    #ifdef __linux__
+#ifdef __linux__
 
-        #include <dlfcn.h>
+#include <dlfcn.h>
 
-    #elif defined(_WIN32) || defined(_WIN64)
+#elif defined(_WIN32) || defined(_WIN64)
 
-        #define NOMINMAX
-        #include <windows.h>
+#define NOMINMAX
+#include <windows.h>
 
-    #endif // __linux__
+#endif // __linux__
 
 #include <cstdint>
 
@@ -46,51 +46,48 @@ namespace dpctl
 class DynamicLibHelper final
 {
 public:
-    DynamicLibHelper()                         = delete;
+    DynamicLibHelper() = delete;
     DynamicLibHelper(const DynamicLibHelper &) = delete;
-    DynamicLibHelper(const char * libName, int flag)
+    DynamicLibHelper(const char *libName, int flag)
     {
 
-    #ifdef __linux__
+#ifdef __linux__
         _handle = dlopen(libName, flag);
-    #elif defined(_WIN32) || defined(_WIN64)
+#elif defined(_WIN32) || defined(_WIN64)
         _handle = LoadLibraryA(libName);
-    #endif
+#endif
     }
 
     ~DynamicLibHelper()
     {
-    #ifdef __linux__
+#ifdef __linux__
         dlclose(_handle);
-    #elif defined(_WIN32) || defined(_WIN64)
+#elif defined(_WIN32) || defined(_WIN64)
         FreeLibrary((HMODULE)_handle);
-    #endif
+#endif
     };
 
-    template <typename T>
-    T getSymbol(const char * symName)
+    template <typename T> T getSymbol(const char *symName)
     {
-    #ifdef __linux__
-        void * sym   = dlsym(_handle, symName);
-        char * error = dlerror();
+#ifdef __linux__
+        void *sym = dlsym(_handle, symName);
+        char *error = dlerror();
 
-        if (NULL != error)
-        {
+        if (NULL != error) {
             return nullptr;
         }
-    #elif defined(_WIN32) || defined(_WIN64)
-        void * sym = (void *)GetProcAddress((HMODULE)_handle, symName);
+#elif defined(_WIN32) || defined(_WIN64)
+        void *sym = (void *)GetProcAddress((HMODULE)_handle, symName);
 
-        if (NULL == sym)
-        {
+        if (NULL == sym) {
             return nullptr;
         }
-    #endif
+#endif
 
         return (T)sym;
     }
 
-    bool opened () const
+    bool opened() const
     {
         if (!_handle)
             return false;
@@ -99,7 +96,7 @@ class DynamicLibHelper final
     }
 
 private:
-    void * _handle = nullptr;
+    void *_handle = nullptr;
 };
 
 } // namespace dpctl

dpctl-capi/helper/source/dpctl_utils_helper.cpp

@@ -24,19 +24,18 @@
 //===----------------------------------------------------------------------===//
 
 #include "dpctl_utils_helper.h"
-#include <string>
 #include <sstream>
+#include <string>
 
 using namespace cl::sycl;
 
 /*!
-* Transforms enum info::device_type to string.
-*/
+ * Transforms enum info::device_type to string.
+ */
 std::string DPCTL_DeviceTypeToStr(info::device_type devTy)
 {
     std::stringstream ss;
-    switch (devTy)
-    {
+    switch (devTy) {
     case info::device_type::cpu:
         ss << "cpu" << '\n';
         break;
@@ -59,22 +58,27 @@ std::string DPCTL_DeviceTypeToStr(info::device_type devTy)
 }
 
 /*!
-* Transforms string to enum info::device_type.
-*/
+ * Transforms string to enum info::device_type.
+ */
 info::device_type DPCTL_StrToDeviceType(std::string devTyStr)
 {
     info::device_type devTy;
     if (devTyStr == "cpu") {
         devTy = info::device_type::cpu;
-    } else if(devTyStr == "gpu") {
+    }
+    else if (devTyStr == "gpu") {
         devTy = info::device_type::gpu;
-    } else if(devTyStr == "accelerator") {
+    }
+    else if (devTyStr == "accelerator") {
         devTy = info::device_type::accelerator;
-    } else if(devTyStr == "custom") {
+    }
+    else if (devTyStr == "custom") {
         devTy = info::device_type::custom;
-    } else if(devTyStr == "host") {
+    }
+    else if (devTyStr == "host") {
         devTy = info::device_type::host;
-    } else {
+    }
+    else {
         // \todo handle the error
         throw std::runtime_error("Unknown device type.");
     }

dpctl-capi/include/Support/CBindingWrapping.h

@@ -32,12 +32,12 @@
 #define DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref)                            \
     __attribute__((unused)) inline ty *unwrap(ref P)                           \
     {                                                                          \
-        return reinterpret_cast<ty*>(P);                                       \
+        return reinterpret_cast<ty *>(P);                                      \
     }                                                                          \
                                                                                \
     __attribute__((unused)) inline ref wrap(const ty *P)                       \
     {                                                                          \
-            return reinterpret_cast<ref>(const_cast<ty*>(P));                  \
+        return reinterpret_cast<ref>(const_cast<ty *>(P));                     \
     }
 
 /*!
@@ -47,10 +47,9 @@
 #define DEFINE_STDCXX_CONVERSION_FUNCTIONS(ty, ref)                            \
     DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref)                                \
                                                                                \
-    template<typename T>                                                       \
-    __attribute__((unused)) inline T *unwrap(ref P)                            \
+    template <typename T> __attribute__((unused)) inline T *unwrap(ref P)      \
     {                                                                          \
-        T *Q = (T*)unwrap(P);                                                  \
+        T *Q = (T *)unwrap(P);                                                 \
         assert(Q && "Invalid cast!");                                          \
         return Q;                                                              \
     }

dpctl-capi/include/Support/DllExport.h

@@ -26,11 +26,11 @@
 #pragma once
 
 #ifdef _WIN32
-#    ifdef DPCTLSyclInterface_EXPORTS
-#        define DPCTL_API __declspec(dllexport)
-#    else
-#        define DPCTL_API __declspec(dllimport)
-#    endif
+#ifdef DPCTLSyclInterface_EXPORTS
+#define DPCTL_API __declspec(dllexport)
 #else
-#    define DPCTL_API
+#define DPCTL_API __declspec(dllimport)
+#endif
+#else
+#define DPCTL_API
 #endif

dpctl-capi/include/Support/ExternC.h

@@ -1,4 +1,4 @@
-//===----------- ExternC.h - Defines a extern C helper macro     -*-C++-*- ===//
+//===----------- ExternC.h - Defines an extern C helper macro    -*-C++-*- ===//
 //
 //                      Data Parallel Control (dpCtl)
 //
@@ -26,8 +26,10 @@
 #pragma once
 
 #ifdef __cplusplus
-#define DPCTL_C_EXTERN_C_BEGIN  extern "C" {
-#define DPCTL_C_EXTERN_C_END    }
+#define DPCTL_C_EXTERN_C_BEGIN                                                 \
+    extern "C"                                                                 \
+    {
+#define DPCTL_C_EXTERN_C_END }
 #else
 #define DPCTL_C_EXTERN_C_BEGIN
 #define DPCTL_C_EXTERN_C_END

dpctl-capi/include/Support/MemOwnershipAttrs.h

@@ -51,9 +51,9 @@
 #endif
 /*!
  * @def __dpctl_take
- * @brief The __dpctl_take attribute indicates that the function "takes" over the
- * ownership of the object and the user must not use the object as an argument
- * to another function.
+ * @brief The __dpctl_take attribute indicates that the function "takes" over
+ * the ownership of the object and the user must not use the object as an
+ * argument to another function.
  *
  * The __dpctl_take attribute mens that the function destroys it before the
  * function returns, and the caller must not use the object again in any other