Add static code analysis CI workflows and tools

Author: philippitts

.github/workflows/clang-format.yml

@@ -0,0 +1,18 @@
+name: Clang Format
+
+on: [push, pull_request]
+
+jobs:
+  check-formatting:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Run clang-format
+      uses: DoozyX/clang-format-lint-action@v0.16.2
+      with:
+        source: '.'
+        exclude: './3rdparty ./modules/bglib/include/cmd_def.h ./modules/bglib/src/cmd_def.cpp'
+        extensions: 'h,c,hpp,cpp'
+        clangFormatVersion: 16
+        inplace: False

.github/workflows/cppcheck.yml

@@ -0,0 +1,27 @@
+name: C/C++ Static Code Analysis
+
+on: [push, pull_request]
+
+jobs:
+  cppcheck:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Install CppCheck
+      run: |
+        sudo -H apt-get update -y
+        sudo -H apt-get install cppcheck
+      env:
+        DEBIAN_FRONTEND: noninteractive
+    - name: Run Cppcheck
+      run: cppcheck --std=c++20 --error-exitcode=1 --xml --xml-version=2 --force modules 2>cppcheck_results.xml
+    - name: Generate Report
+      if: ${{ failure() }}
+      run: cppcheck-htmlreport --title=NativeSDK --file=cppcheck_results.xml --report-dir=report
+    - name: Upload Report
+      if: ${{ failure() }}
+      uses: actions/upload-artifact@v1
+      with:
+        name: report
+        path: report

.github/workflows/spellcheck.yml

@@ -0,0 +1,11 @@
+name: 'Check Spelling'
+on:
+  pull_request:
+  push:
+
+jobs:
+  spellcheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: streetsidesoftware/cspell-action@v2

cspell.json

@@ -0,0 +1,39 @@
+{
+    "version": "0.2",
+    "language": "en",
+    // Words to be considered correct that CSpell will not flag.
+    "words": [
+        "gson",
+        "dylib",
+        "bglib",
+        "uart",
+        "hwaddr",
+        "APITYPES",
+        "PACKSTRUCT",
+        "anglion",
+        "lolen",
+        "simblee",
+        "openbci",
+        "simpleble",
+        "rdparty"
+    ],
+    // These words will always be flagged as incorrect.
+    "flagWords": [],
+    "ignorePaths": [
+        ".vscode",
+        ".git",
+        ".github",
+        ".clang-format",
+        ".gitignore",
+        "cspell.json",
+        "build",
+        "compiled",
+        "3rdparty",
+        "cmake/default.cmake",
+        "CMakeLists.txt",
+        "modules/bglib/include/cmd_def.h",
+        "modules/bglib/src/cmd_def.cpp",
+        "modules/bglib/src/stubs.cpp",
+        "modules/bglib/src/uart.cpp"
+    ]
+}

modules/bglib/include/openbci_gui_helpers.h

@@ -1,10 +1,10 @@
 #pragma once
 
 #ifdef _WIN32
-#define SHARED_EXPORT __declspec(dllexport)
+#define SHARED_EXPORT __declspec (dllexport)
 #define CALLING_CONVENTION __cdecl
 #else
-#define SHARED_EXPORT __attribute__((visibility("default")))
+#define SHARED_EXPORT __attribute__ ((visibility ("default")))
 #define CALLING_CONVENTION
 #endif
 

modules/bglib/include/uart.h

@@ -2,7 +2,7 @@
 #define UART_H
 
 void uart_list_devices ();
-int uart_find_serialport (char *name);
+int uart_find_serial_port (char *name);
 int uart_open (char *port);
 void uart_close ();
 int uart_tx (int len, unsigned char *data);

modules/bglib/src/uart.cpp

@@ -92,7 +92,7 @@ void uart_list_devices ()
     return;
 }
 
-int uart_find_serialport (char *name)
+int uart_find_serial_port (char *name)
 {
     BYTE *pbuf = NULL;
     DWORD reqSize = 0;

modules/native-ble/include/openbci_gui_native_helpers.h

@@ -1,7 +1,7 @@
 #pragma once
 
 #ifdef _WIN32
-#define SHARED_EXPORT __declspec(dllexport)
+#define SHARED_EXPORT __declspec (dllexport)
 #define CALLING_CONVENTION __cdecl
 #else
 #define SHARED_EXPORT __attribute__ ((visibility ("default")))