Merge branch 'main' of https://github.com/ipc-sim/ipc-toolkit

Author: Huangzizhou

.clang-format

@@ -1,14 +1,43 @@
-# https://clang.llvm.org/docs/ClangFormatStyleOptions.html
+---
+Language: Cpp
 BasedOnStyle: WebKit
-ColumnLimit: 80
-AlignTrailingComments: true
-FixNamespaceComments: true
-ReflowComments: true
-BinPackParameters: false
-AllowAllParametersOfDeclarationOnNextLine: true
 AlignAfterOpenBracket: AlwaysBreak
+AlignTrailingComments:
+  Kind:            Always
+  OverEmptyLines:  0
+BinPackParameters: false
+BreakArrays: false
 BreakBeforeBinaryOperators: NonAssignment
-SortIncludes: false
-CommentPragmas:  '^@.+'
 BreakStringLiterals: false
+ColumnLimit: 80
+CommentPragmas:  '^@.+'
+FixNamespaceComments: true
+# Regroup includes with a priority system
+IncludeBlocks: Regroup
+IncludeCategories:
+  # by default, the main header of a cpp will get priority 0
+  # regex here are sorted by search pattern, not by sort priority
+  - Regex:           "^<ipc\/[^/]*>" # this libraries
+    Priority:        2    # internal library group
+    SortPriority:    2
+    CaseSensitive:   true
+  - Regex:           "^<ipc\/.*\/.*>" # this libraries
+    Priority:        2    # internal library group
+    SortPriority:    3
+    CaseSensitive:   true
+  - Regex:           "^<(.*\\.h[px]*)|(Eigen\/.*)>"
+    Priority:        4    # libraries (because they end in .h)
+    SortPriority:    4
+    CaseSensitive:   false
+  - Regex:           "^<.*"
+    Priority:        5    # system (without .h, because that is captured by the other group)
+    SortPriority:    5
+    CaseSensitive:   false
+  - Regex:           ".*" # catch-all for internal files
+    Priority:        1    # internal file group
+    SortPriority:    1
+    CaseSensitive:   true
 PackConstructorInitializers: CurrentLine
+RemoveEmptyLinesInUnwrappedLines: true
+SortIncludes: CaseInsensitive
+...

.devcontainer/Dockerfile

@@ -0,0 +1,82 @@
+FROM ubuntu:22.04
+
+# Set environment variables
+ENV DEBIAN_FRONTEND=noninteractive
+ENV CCACHE_DIR=/home/devuser/.ccache
+ENV CCACHE_MAXSIZE=1G
+ENV CXX_STANDARD=17
+
+# Update package lists
+RUN apt-get update
+
+# Install essential packages
+RUN apt-get install -y --no-install-recommends \
+    build-essential \
+    git \
+    wget \
+    curl \
+    fish \
+    zsh \
+    ninja-build \
+    ccache \
+    libeigen3-dev \
+    libtbb-dev \
+    libspdlog-dev \
+    python3 \
+    python3-pip \
+    python3-dev \
+    libgmp-dev \
+    libssl-dev \
+    libncurses5-dev \
+    libncursesw5-dev \
+    libxml2-dev \
+    libjsoncpp-dev \
+    libz3-dev \
+    sudo \
+    software-properties-common \
+    lsb-release \
+    gnupg \
+    && rm -rf /var/lib/apt/lists/*
+
+# Create a new user with sudo privileges
+RUN useradd -m devuser \
+    && echo "devuser:password" | chpasswd \
+    && usermod -aG sudo devuser \
+    && echo "devuser ALL=(ALL) NOPASSWD:ALL" >> /etc/sudoers \
+    && mkdir -p $CCACHE_DIR \
+    && chown devuser:devuser $CCACHE_DIR
+
+# Set up Python tools
+RUN pip3 install --upgrade pip setuptools wheel pre-commit
+
+# Add Kitware APT repository for CMake
+RUN wget -qO- https://apt.kitware.com/keys/kitware-archive-latest.asc | \
+    gpg --dearmor -o /usr/share/keyrings/kitware-archive-keyring.gpg
+
+RUN echo "deb [signed-by=/usr/share/keyrings/kitware-archive-keyring.gpg] https://apt.kitware.com/ubuntu/ $(lsb_release -cs) main" | \
+    tee /etc/apt/sources.list.d/kitware.list > /dev/null
+
+# Update package lists and install CMake
+RUN apt-get update
+RUN apt-get install -y cmake
+
+# Verify CMake installation
+RUN cmake --version
+
+# Install LLVM/Clang and Clang-Format version 18
+RUN wget -q https://apt.llvm.org/llvm.sh -O /tmp/llvm.sh
+RUN chmod +x /tmp/llvm.sh
+RUN /tmp/llvm.sh 18 || true
+
+RUN apt-get update && apt-get install -y clang-18 clang-tools-18 clang-format-18
+    
+RUN clang-18 --version
+RUN clang++-18 --version
+RUN clang-format-18 --version
+
+# 12. Set the default user and working directory
+USER devuser
+
+WORKDIR /home/devuser/workspace
+
+CMD ["bash"]

.devcontainer/devcontainer.json

@@ -0,0 +1,59 @@
+{
+    "$schema": "https://raw.githubusercontent.com/devcontainers/spec/main/schemas/devContainer.schema.json",
+    "name": "IPCToolkit C++ Development Container",
+    "build": {
+        "dockerfile": "Dockerfile",
+        "context": ".."
+    },
+    "customizations": {
+        "vscode": {
+            "settings": {
+                "terminal.integrated.shell.linux": "/bin/fish",
+                "C_Cpp.default.configurationProvider": "ms-vscode.cmake-tools",
+                "C_Cpp.default.intelliSenseMode": "gcc-x64",
+                "C_Cpp.default.compilerPath": "/usr/bin/clang++-18",
+                "C_Cpp.clang_format_path": "/usr/bin/clang-format-18",
+                "C_Cpp.clang_format_style": "file",
+                "cmake.configureOnOpen": true,
+                "cmake.buildDirectory": "${workspaceFolder}/build",
+                "python.pythonPath": "/usr/bin/python3",
+                "python.linting.enabled": true,
+                "python.linting.pylintEnabled": true,
+                "python.formatting.provider": "black",
+                "prettier.requireConfig": true
+            },
+            "extensions": [
+                "ms-vscode.cpptools",
+                "ms-vscode.cmake-tools",
+                "xaver.clang-format",
+                "ms-python.python",
+                "ms-azuretools.vscode-docker",
+                "eamodio.gitlens",
+                "esbenp.prettier-vscode",
+                "mhutchie.git-graph",
+                "twxs.cmake",
+                "jeff-hykin.better-cpp-syntax",
+                "vadimcn.vscode-lldb",
+                "cschlosser.doxdocgen",
+                "ms-python.vscode-pylance",
+                "mutantdino.resourcemonitor",
+                "randomfractalsinc.vscode-data-preview",
+                "oderwat.indent-rainbow",
+                "formulahendry.code-runner",
+                "donjayamanne.git-extension-pack"
+            ]
+        }
+    },
+    "postCreateCommand": "pre-commit install",
+    "remoteUser": "devuser",
+    "mounts": [
+        "source=${localWorkspaceFolder}/.ccache,target=/home/devuser/.ccache,type=bind,consistency=cached"
+    ],
+    "forwardPorts": [],
+    "remoteEnv": {
+        "CCACHE_DIR": "/home/devuser/.ccache",
+        "CCACHE_MAXSIZE": "1G"
+    },
+    "workspaceFolder": "/home/devuser/workspace",
+    "workspaceMount": "source=${localWorkspaceFolder},target=/home/devuser/workspace,type=bind,consistency=cached"
+}

.gitattributes

@@ -1,2 +1,3 @@
 # These files should be ignored from GitHub's language statistics.
 python/example.ipynb linguist-vendored
+notebooks/*.ipynb linguist-vendored

.github/pull_request_template.md

@@ -9,6 +9,7 @@ Fixes # (issue)
 Please delete options that are not relevant.
 
 - [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] Enhancement (non-breaking change which improves existing functionality)
 - [ ] New feature (non-breaking change which adds functionality)
 - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
 - [ ] This change requires a documentation update
@@ -21,10 +22,10 @@ Please describe the tests that you ran to verify your changes. Provide instructi
 - [ ] Test B
 
 **Test Configuration**:
-* OS and version:
-* Compile and version:
+* OS and Version:
+* Compiler and Version:
 
-# Checklist:
+# Checklist
 
 - [ ] I have followed the project [style guide](https://ipctk.xyz/style_guide.html)
 - [ ] My code follows the clang-format style guidelines of this project
@@ -34,5 +35,4 @@ Please describe the tests that you ran to verify your changes. Provide instructi
 - [ ] My changes generate no new warnings
 - [ ] I have added tests that prove my fix is effective or that my feature works
 - [ ] New and existing unit tests pass locally with my changes
-- [ ] Any dependent changes have been merged and published in downstream modules
-
+- [ ] Any dependent changes have been merged and published in downstream modules

.github/workflows/clang-format-check.yml

@@ -0,0 +1,33 @@
+name: clang-format Check
+on:
+  push:
+    paths:
+      - '.github/workflows/clang-format-check.yml'
+      - '.clang-format'
+      - 'src/**'
+      - 'tests/src/**'
+      - 'python/src/**'
+  pull_request:
+    paths:
+      - '.github/workflows/clang-format-check.yml'
+      - '.clang-format'
+      - 'src/**'
+      - 'tests/src/**'
+      - 'python/src/**'
+jobs:
+  formatting-check:
+    name: Formatting Check
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        path:
+          - 'src'
+          - 'tests/src'
+          - 'python/src'
+    steps:
+    - uses: actions/checkout@v4
+    - name: clang-format style check
+      uses: jidicula/[email protected]
+      with:
+        clang-format-version: '20'
+        check-path: ${{ matrix.path }}

.github/workflows/continuous.yml

@@ -60,6 +60,10 @@ jobs:
         if: runner.os == 'Windows'
         uses: seanmiddleditch/gha-setup-ninja@master
 
+      - name: Get number of CPU cores
+        uses: SimenB/[email protected]
+        id: cpu-cores
+
       - name: Cache Build
         id: cache-build
         uses: actions/cache@v4
@@ -95,14 +99,16 @@ jobs:
 
       - name: Build (Linux/macOS)
         if: runner.os != 'Windows'
-        run: cd build; make -j2; ccache --show-stats
+        run: |
+          cmake --build build -j ${{ steps.cpu-cores.outputs.count }}
+          ccache --show-stats
 
       - name: Build (Windows)
         if: runner.os == 'Windows'
         shell: cmd
         run: |
           call "C:\Program Files\Microsoft Visual Studio\2022\Enterprise\Common7\Tools\VsDevCmd.bat" -arch=x64
-          cmake --build build -j2 && ccache --show-stats
+          cmake --build build -j ${{ steps.cpu-cores.outputs.count }} && ccache --show-stats
 
       - name: Tests
-        run: cd build; ctest --verbose -j2
+        run: cd build; ctest --verbose -j ${{ steps.cpu-cores.outputs.count }}

.github/workflows/coverage.yml

@@ -1,15 +1,16 @@
 name: Coverage
 
 on:
-  # push:
-  #   branches: [main]
-  # pull_request:
-  #   paths:
-  #     - '.github/workflows/coverage.yml'
-  #     - 'cmake/**'
-  #     - 'src/**'
-  #     - 'tests/**'
-  #     - 'CMakeLists.txt'
+  push:
+    branches: [main]
+  pull_request:
+    paths:
+      - '.github/workflows/coverage.yml'
+      - 'cmake/**'
+      - 'src/**'
+      - 'tests/**'
+      - 'CMakeLists.txt'
+      - 'codecov.yml'
 
 jobs:
   Coverage:
@@ -28,6 +29,10 @@ jobs:
           sudo apt-get install ccache lcov
           echo 'CACHE_PATH=~/.cache/ccache' >> "$GITHUB_ENV"
 
+      - name: Get number of CPU cores
+        uses: SimenB/[email protected]
+        id: cpu-cores
+
       - name: Cache Build
         id: cache-build
         uses: actions/cache@v4
@@ -51,21 +56,23 @@ jobs:
             -DCMAKE_BUILD_TYPE=Release \
 
       - name: Build
-        run: cd build; make -j2; ccache --show-stats
+        run: |
+          cmake --build build -j ${{ steps.cpu-cores.outputs.count }}
+          ccache --show-stats
 
       - name: Run Coverage
         run: |
           cd build
-          ctest --verbose --output-on-failure
-          lcov --directory . --capture --output-file coverage.info
-          lcov --remove coverage.info '/usr/*' "${HOME}"'/.cache/*' '*tests/*' --output-file coverage.info
+          ctest --verbose -j ${{ steps.cpu-cores.outputs.count }}
+          lcov --directory . --capture --output-file coverage.info --ignore-errors inconsistent,format,gcov
+          lcov --remove coverage.info --ignore-errors unused '/usr/*' "$HOME/.cache/*" "*tests/*" --output-file coverage.info
 
       - name: Upload coverage reports to Codecov
-        uses: codecov/codecov-action@v3
-        env:
-          token: ${{ secrets.CODECOV_TOKEN }}
-          files: coverage.info
+        uses: codecov/codecov-action@v3.1.6
+        with:
+          fail_ci_if_error: true
+          files: build/coverage.info
           flags: unittests
           name: ipc-toolkit
-          fail_ci_if_error: true
-          verbose: true
+          token: ${{ secrets.CODECOV_TOKEN }}
+          verbose: true