Develop

.bumpversion.cfg

@@ -0,0 +1,30 @@
+[bumpversion]
+current_version = 0.2.0-rc2
+commit = False
+message = Bump version: {current_version} → {new_version}
+tag_message = Release v{new_version}
+tag_name = v{new_version}
+tag = True
+parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)([-](?P<release>(dev|rc))(?P<build>\d+))?
+serialize = 
+	{major}.{minor}.{patch}-{release}{build}
+	{major}.{minor}.{patch}
+
+[bumpversion:part:release]
+first_value = dev
+optional_value = ga
+values = 
+	dev
+	rc
+	ga
+
+[bumpversion:part:build]
+first_value = 0
+
+[bumpversion:file:CMakeLists.txt]
+search = {current_version}
+replace = {new_version}
+parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\.(?P<build>\d+))?
+serialize = 
+	{major}.{minor}.{patch}.{build}
+	{major}.{minor}.{patch}

.clang-format

@@ -0,0 +1,21 @@
+---
+BasedOnStyle: Google
+IndentWidth: 2
+UseTab: Never
+---
+Language: Cpp
+Standard: c++17
+# Standard: Auto
+AlignAfterOpenBracket: false
+AlignEscapedNewlinesLeft: true
+AlwaysBreakAfterDefinitionReturnType: None
+BreakBeforeBraces: Allman
+BreakConstructorInitializersBeforeComma: false
+ColumnLimit: 123
+ConstructorInitializerAllOnOneLineOrOnePerLine: true
+ConstructorInitializerIndentWidth: 0
+IndentCaseLabels: false
+SortIncludes: true
+AlignTrailingComments: false
+
+SpacesInAngles: true

.clang-tidy

@@ -0,0 +1,56 @@
+---
+Checks: "-*,\
+bugprone-*,\
+bugprone-reserved-identifier,\
+-bugprone-exception-escape,\
+-bugprone-unused-return-value,\
+boost-*,\
+-boost-use-ranges,\
+cert-*,\
+-cert-err33-c,\
+-cert-err58-cpp,\
+clang-analyzer-*,\
+-clang-analyzer-unix.BlockInCriticalSection,\
+cppcoreguidelines-*,\
+-cppcoreguidelines-avoid-*,\
+-cppcoreguidelines-init-variables,\
+-cppcoreguidelines-macro-*,\
+-cppcoreguidelines-narrowing-conversions,\
+-cppcoreguidelines-owning-memory,\
+-cppcoreguidelines-prefer-member-initializer,\
+-cppcoreguidelines-pro-bounds-pointer-arithmetic,\
+-cppcoreguidelines-pro-type-reinterpret-cast,\
+hicpp-*,\
+misc-*,\
+-misc-const-correctness,\
+-misc-include-cleaner,\
+-misc-no-recursion,\
+modernize-*,\
+-modernize-macro-to-enum,\
+-modernize-use-designated-initializers,\
+performance-*,\
+-performance-enum-size,\
+portability-*,\
+-portability-avoid-pragma-once,\
+readability-*,\
+readability-identifier-length,\
+readability-identifier-naming,\
+-*magic-numbers,\
+-*avoid-c-arrays,\
+"
+WarningsAsErrors: 'clang-*'
+HeaderFilterRegex: '.*'
+FormatStyle:     file
+User:            clausklein
+# options: hicpp-signed-bitwise.IgnorePositiveIntegerLiterals
+CheckOptions:
+  - { key: readability-identifier-naming.NamespaceCase,         value: lower_case }
+  - { key: readability-identifier-naming.ClassCase,             value: lower_case }
+  - { key: readability-identifier-naming.MethodCase,            value: lower_case }
+  - { key: readability-identifier-naming.MemberCase,            value: lower_case }
+  - { key: readability-identifier-naming.MemberSuffix,          value: _          }
+  - { key: readability-identifier-naming.ConstexprVariableCase, value: UPPER_CASE }
+  - { key: readability-identifier-length.MinimumVariableNameLength,   value: 2 }
+  - { key: readability-identifier-length.MinimumParameterNameLength,  value: 1 }
+  - { key: hicpp-signed-bitwise.IgnorePositiveIntegerLiterals, value: true }
+...

.codespellignore

@@ -0,0 +1,12 @@
+QUE
+UInt
+WRONLY
+WS
+cancelled
+cancelling
+claus
+copyable
+deque
+fo
+pullrequest
+statics

.codespellrc

@@ -0,0 +1,6 @@
+[codespell]
+builtin = clear,rare,en-GB_to_en-US,names,informal,code
+check-hidden =
+skip = ./.git,./.direnv,./build/*,./prefix/*,./coverage/*,./stagedir/*,*.html,*.xsd,*.xsl,*.pdf,*.log,.*.swp,*~,*.bak,./tags
+quiet-level = 2
+ignore-words = .codespellignore

.devcontainer/Dockerfile

@@ -0,0 +1,31 @@
+# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+# We use ubuntu-24.04 (noble)
+FROM mcr.microsoft.com/devcontainers/cpp:1-ubuntu-24.04
+
+USER vscode
+
+# -------------------------------
+# Install latest CMake and Boost
+# -------------------------------
+RUN sudo apt-get update -qq \
+    && sudo apt-get install -y -qq wget gpg software-properties-common \
+    && wget -O - https://apt.kitware.com/keys/kitware-archive-latest.asc \
+        | gpg --dearmor \
+        | sudo tee /usr/share/keyrings/kitware-archive-keyring.gpg >/dev/null \
+    && echo "deb [signed-by=/usr/share/keyrings/kitware-archive-keyring.gpg] https://apt.kitware.com/ubuntu/ noble main" \
+        | sudo tee /etc/apt/sources.list.d/kitware.list >/dev/null \
+    && sudo apt-get update -qq \
+    && sudo apt-get install -y -qq cmake libboost-all-dev python3-pip \
+    && sudo rm -rf /var/lib/apt/lists/*
+
+# -------------------------------
+# Install pre-commit, gcovr, ninja
+# -------------------------------
+RUN pip3 install --no-cache-dir pre-commit gcovr ninja cmake
+
+# -------------------------------
+# Avoid ASAN stalling
+# -------------------------------
+# Reduces mmap randomization slightly so AddressSanitizer works reliably
+RUN sudo sysctl -w vm.mmap_rnd_bits=28

.devcontainer/devcontainer.json

@@ -0,0 +1,15 @@
+{
+  "name": "Beman Project Generic Devcontainer",
+  "build": {
+    "dockerfile": "Dockerfile"
+  },
+  "postCreateCommand": "bash .devcontainer/postcreate.sh",
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "ms-vscode.cpptools",
+        "ms-vscode.cmake-tools"
+      ]
+    }
+  }
+}

.devcontainer/postcreate.sh

@@ -0,0 +1,4 @@
+# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+# Setup pre-commit
+pre-commit
+pre-commit install

.github/workflows/clang.yml

@@ -0,0 +1,48 @@
+name: Clang on Ubuntu
+
+on:
+  push:
+    branches: [ main, develop ]
+  pull_request:
+    branches: [ develop ]
+  workflow_dispatch:
+  schedule:
+    - cron: '30 15 * * 6'
+
+jobs:
+  clang:
+    strategy:
+      fail-fast: false
+      matrix:
+        version: [20, 21]
+
+    runs-on: ubuntu-latest
+
+    container:
+      image: ghcr.io/mattkretz/cplusplus-ci/clang${{ matrix.version }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with: { python-version: "3.13" }
+
+      - name: Install Boost
+        run: apt-get update -qq && apt-get install -y -qq libboost-all-dev
+
+      - name: Setup Cpp
+        uses: aminya/setup-cpp@v1
+        with:
+          # compiler: llvm-${{ matrix.version }}
+          cmake: 4.1.2
+          ninja: 1.13.0
+          gcovr: true
+
+      - name: Run test suite
+        env:
+          CXX: clang++-${{ matrix.version }}
+        run: |
+          export PATH=$HOME/.local/bin:$PATH
+          cmake --workflow --preset llvm-release
+          gcovr
+          # PRESET_NAME=llvm-release make all

.github/workflows/cmake-multi-platform.yml

@@ -0,0 +1,75 @@
+name: CMake on multiple platforms
+
+on:
+  push:
+    branches: [ main, develop ]
+  pull_request:
+    branches: [ develop ]
+  workflow_dispatch:
+  schedule:
+    - cron: '30 15 * * 6'
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        build_type: [debug, release]
+        c_compiler: [gcc, clang, cl]
+        include:
+          # Windows - MSVC
+          - os: windows-latest
+            c_compiler: cl
+            cpp_compiler: cl
+            preset: msvc
+
+          # Ubuntu - GCC
+          - os: ubuntu-latest
+            c_compiler: gcc
+            cpp_compiler: g++
+            preset: gcc
+
+          # Ubuntu - Clang
+          - os: ubuntu-latest
+            c_compiler: clang
+            cpp_compiler: clang++
+            preset: llvm
+
+          # macOS - Clang (default compiler)
+          - os: macos-latest
+            c_compiler: clang
+            cpp_compiler: clang++
+            preset: appleclang
+
+        exclude:
+          - os: windows-latest
+            c_compiler: gcc
+          - os: windows-latest
+            c_compiler: clang
+          - os: ubuntu-latest
+            c_compiler: cl
+          - os: macos-latest
+            c_compiler: gcc
+          - os: macos-latest
+            c_compiler: cl
+
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@v4
+
+      # # see https://github.com/marketplace/actions/enable-developer-command-prompt
+      - uses: ilammy/msvc-dev-cmd@v1
+        if: matrix.os == 'windows-latest'
+        with:
+          vsversion: 2022
+          arch: x64
+
+      - name: Workflow preset ${{ matrix.preset }}-${{ matrix.build_type }}
+        env:
+          CC: ${{ matrix.c_compiler }}
+          CXX: ${{ matrix.cpp_compiler }}
+        run: |
+          cmake --workflow --preset ${{ matrix.preset }}-${{ matrix.build_type }}

.github/workflows/gcc.yml

@@ -0,0 +1,48 @@
+name: GCC on Ubuntu
+
+on:
+  push:
+    branches: [ main, develop ]
+  pull_request:
+    branches: [ develop ]
+  workflow_dispatch:
+  schedule:
+    - cron: '30 15 * * 6'
+
+jobs:
+  gcc:
+    strategy:
+      fail-fast: false
+      matrix:
+        version: [15, 16]
+
+    runs-on: ubuntu-latest
+
+    container:
+      image: ghcr.io/mattkretz/cplusplus-ci/gcc${{ matrix.version }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with: { python-version: "3.13" }
+
+      - name: Install Boost
+        run: apt-get update -qq && apt-get install -y -qq libboost-all-dev
+
+      - name: Setup Cpp
+        uses: aminya/setup-cpp@v1
+        with:
+          # compiler: gnu-${{ matrix.version }}
+          cmake: 4.1.2
+          ninja: 1.13.0
+          gcovr: true
+
+      - name: Run test suite
+        env:
+          CXX: g++-${{ matrix.version }}
+        run: |
+          export PATH=$HOME/.local/bin:$PATH
+          cmake --workflow --preset gcc-release
+          gcovr
+          # PRESET_NAME=gcc-release make all

.github/workflows/pre-commit.yml

@@ -0,0 +1,14 @@
+name: Lint Check (pre-commit)
+
+on:
+  # We have to use pull_request_target here as pull_request does not grant
+  # enough permission for reviewdog
+  pull_request_target:
+  push:
+    branches:
+      - main
+      - develop
+
+jobs:
+  pre-commit:
+    uses: bemanproject/infra-workflows/.github/workflows/reusable-beman-pre-commit.yml@1.1.0

.gitignore

@@ -0,0 +1,7 @@
+*.log
+.*swp
+/CMakeUserPresets.json
+CODEOWNERS
+build/
+coverage/*
+tags

.markdownlint.yaml

@@ -0,0 +1,9 @@
+# MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md033.md
+# Disable inline html linter is needed for <details> <summary>
+MD033: false
+
+# MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md013.md
+# Conforms to .clang-format ColumnLimit
+# Update the comment in .clang-format if we no-longer tie these two column limits.
+MD013:
+  line_length: 119