Add clang-format and run it on the code-base

.clang-format

@@ -0,0 +1,9 @@
+---
+BasedOnStyle: LLVM
+Language: Cpp
+IndentWidth: 2
+BreakConstructorInitializersBeforeComma: 'true'
+PointerAlignment: Left
+IncludeBlocks: Preserve
+SortIncludes: false
+ColumnLimit: 120

.github/workflows/ci.yml

@@ -5,7 +5,7 @@ on:
     branches:
       - main
   pull_request:
-  # Also allow running this workflow manually from the Actions tab.
+    types: [synchronize, opened, reopened, ready_for_review, converted_to_draft]
   workflow_dispatch:
   merge_group:
 
@@ -14,6 +14,10 @@ concurrency:
   cancel-in-progress: ${{ github.ref != 'refs/heads/master' }}
 
 jobs:
+  check-labels:
+    uses: lf-lang/lingua-franca/.github/workflows/check-labels.yml@master
+    if:  ${{ github.event_name == 'pull_request' }}
+
   unit-tests-single:
     uses: ./.github/workflows/unit-tests.yml
     with:
@@ -41,31 +45,31 @@ jobs:
     with:
       runtime-ref: ${{ github.ref }}
       compiler-ref: ${{ needs.fetch-lf.outputs.ref }}
-    if: ${{ github.event_name == 'merge_group' || github.ref == 'refs/heads/main' || contains( github.event.pull_request.labels.*.name, 'arduino') }}
+    if: ${{ !github.event.pull_request.draft || contains( github.event.pull_request.labels.*.name, 'arduino') }}
 
   lf-default-zephyr:
     needs: [fetch-lf]
     uses: lf-lang/lingua-franca/.github/workflows/c-zephyr-tests.yml@master
     with:
       runtime-ref: ${{ github.ref }}
       compiler-ref: ${{ needs.fetch-lf.outputs.ref }}
-    if: ${{ github.event_name == 'merge_group' || github.ref == 'refs/heads/main' ||contains( github.event.pull_request.labels.*.name, 'zephyr') }}
+    if: ${{ !github.event.pull_request.draft ||contains( github.event.pull_request.labels.*.name, 'zephyr') }}
 
   lf-default:
     needs: [fetch-lf]
     uses: lf-lang/lingua-franca/.github/workflows/c-tests.yml@master
     with:
       runtime-ref: ${{ github.ref }}
       compiler-ref: ${{ needs.fetch-lf.outputs.ref }}
-      all-platforms: ${{ github.event_name == 'merge_group' || github.ref == 'refs/heads/main' || contains( github.event.pull_request.labels.*.name, 'mac') || contains( github.event.pull_request.labels.*.name, 'windows') }}
+      all-platforms: ${{ !github.event.pull_request.draft || contains( github.event.pull_request.labels.*.name, 'mac') || contains( github.event.pull_request.labels.*.name, 'windows') }}
 
   lf-python:
     needs: [fetch-lf]
     uses: lf-lang/lingua-franca/.github/workflows/py-tests.yml@master
     with:
       reactor-c-ref: ${{ github.ref }}
       compiler-ref: ${{ needs.fetch-lf.outputs.ref }}
-    if: ${{ github.event_name == 'merge_group' || github.ref == 'refs/heads/main' ||contains( github.event.pull_request.labels.*.name, 'python') }}
+    if: ${{ !github.event.pull_request.draft || contains( github.event.pull_request.labels.*.name, 'python') }}
 
   lf-gedf-np:
     needs: [fetch-lf]
@@ -74,7 +78,8 @@ jobs:
       runtime-ref: ${{ github.ref }}
       compiler-ref: ${{ needs.fetch-lf.outputs.ref }}
       scheduler: GEDF_NP
-      all-platforms: ${{ github.event_name == 'merge_group' || github.ref == 'refs/heads/main' || contains( github.event.pull_request.labels.*.name, 'mac') || contains( github.event.pull_request.labels.*.name, 'windows') }}
+      all-platforms: ${{ !github.event.pull_request.draft || contains( github.event.pull_request.labels.*.name, 'mac') || contains( github.event.pull_request.labels.*.name, 'windows') }}
+    if: ${{ !github.event.pull_request.draft || contains( github.event.pull_request.labels.*.name, 'schedulers') }}
 
   lf-adaptive:
     needs: [fetch-lf]
@@ -83,4 +88,5 @@ jobs:
       runtime-ref: ${{ github.ref }}
       compiler-ref: ${{ needs.fetch-lf.outputs.ref }}
       scheduler: ADAPTIVE
-      all-platforms: ${{ github.event_name == 'merge_group' || github.ref == 'refs/heads/main' || contains( github.event.pull_request.labels.*.name, 'mac') || contains( github.event.pull_request.labels.*.name, 'windows') }}
+      all-platforms: ${{ !github.event.pull_request.draft || contains( github.event.pull_request.labels.*.name, 'mac') || contains( github.event.pull_request.labels.*.name, 'windows') }}
+    if: ${{ !github.event.pull_request.draft || contains( github.event.pull_request.labels.*.name, 'schedulers') }}

.github/workflows/clang-format.yml

@@ -0,0 +1,16 @@
+name: clang-format-review
+
+# You can be more specific, but it currently only works on pull requests
+on: [pull_request]
+
+jobs:
+  clang-format:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install clang-tidy
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y clang-tidy
+      - name: Analyze
+        run: make format-check

Makefile

@@ -0,0 +1,9 @@
+# This file lets you format the code-base with a single command.
+FILES := $(shell find . -name '*.c' -o -name '*.h')
+.PHONY: format
+format:
+	clang-format -i -style=file $(FILES)
+
+.PHONY: format-check
+format-check:
+	clang-format --dry-run --Werror -style=file $(FILES)

README.md

@@ -6,6 +6,19 @@
 ## Documentation
 To generate and view documentation, see [docs/README.md](docs/README.md).
 
+## Code-formatting
+We use clang-format to format our codebase. To run the formatter on all source and header files in reactor-c:
+```
+make format
+```
+The CI will do a "dry-run" of the formatter to verify that all files are correctly formatted.
+
+VSCode can be configured to run clang-format on files as they are saved. To achieve this set the following settings:
+- editor.formatOnSave: true
+- C_Cpp.formatting: clang-format
+- C_Cpp.clang_format_style: file
+
+
 ## Testing
 The Github Actions tests for this repo will automatically run all the C Lingua Franca tests with each of the available schedulers. The version of the lingua-franca repo that is used to do this is specified by the lingua-franca-ref.txt file in this directory.