♻️ Modernized the CMake build setup (#898)

* 🔧 Disable system header warnings

* 📝 Add modernization plan

* 🙈 Extend `.gitignore`

* ✏️ Fix typo

* 🔧 Add `pytest-xdist` for parallel Python test execution and `pytest-sugar` for prettified test output

* 🔧 Modernize CMake calls in workflows

* 🔧 Add missing CMake flag

* ♻️ Modernize CLI CMake config

* ♻️ Modernize test CMake config

* ♻️ Modernize include CMake config

* ♻️ Modernize installation CMake config and add dedicated target stripping function

* ♻️ Introduce CMake presets

* ♻️ Moved from git submodules to CMake's `FetchContent`

* ♻️ Moved from git submodules to CMake's `FetchContent`

* 🔧 Allow other CMake projects to find fiction

* 🔧 Bump supported CMake version

* 🔧 Improve clang-tidy integration

* 🐛 Fix subtle bug in `fanout_substitution`

* 🔥 Remove support for CUDA compilers

* 🔧 Further build optimizations through CMake

* 🙈 Update `.gitignore`

* 🔧 Added useful pre-commit checks

* 📝 Update pyfiction docstrings

Signed-off-by: GitHub Actions <actions@github.com>

* 📝 Added CHANGELOG entry

* 💚 Fix CI

* ⬆️ Upgrade Z3 to version 4.15.4

* 💚 Fix CMake config typo

* ✏️ Fix leftover `libs/` after refactoring

* 🔥 Remove redundant CMake config

* ✏️ Fix more leftover `libs/`

* 💚 Don't clone submodules

* 💚 Fix compilation error after pre-commit artifacts

* 🔧 Update `pytest` and related dependencies

* 💚 Replace leftover macOS-13 tag

* 💚 Ignore old paths to not fail CI

* 💚 Replace `libs` with `vendors`

* 💚 Move helpers to anonymous namespaces to fix linker issues

* 💚 Try `ignore` instead of `ignore-tidy`

* 🚨 Fixed clang-tidy warnings

* 🚨 Fixed clang-tidy warnings

* 💚 Fix build error

* 💚 Fix build errors and compiler warnings

* 💚 Fix build errors

* 🚨 Fix `clang-tidy` warnings

* 🚨 Fix `clang-tidy` warnings

* 🚨 Better suppression of compiler warnings from system headers

* ⏪ Revert system-specific optimizations due to test failures

* ⏪ Revert test case binary organization back to multi-binary builds

* 🔧 Upgrade target macOS version for wheels from 11.0 to 13.0

* 🔧 Improve uv build caching by removing unconditional `reinstall-package` and configuring dedicated `cache-keys`

* 🚨 Fix `clang-tidy` warnings

* 🚨 Replace `std::numeric_limits<double>::infinity()` with `std::numeric_limits<double>::max()` due to the compiler flag `-ffinite-math-only`

* 📝 Update pyfiction docstrings

Signed-off-by: GitHub Actions <actions@github.com>

* 🚨 Fix `clang-tidy` warnings

* 🚨 Fix `clang-tidy` warnings

* 🐛 Replace `std::isinf` checks with `WithinAbs` comparisons using `std::numeric_limits<double>::max()`

* ⏪ Revert `std::numeric_limits<double>::max()` back to `std::numeric_limits<double>::infinity()` for semantic reasons and remove the `-ffinite-math-only` compiler optimization

* 📝 Update pyfiction docstrings

Signed-off-by: GitHub Actions <actions@github.com>

* 🚨 Fix `clang-tidy` warnings

* 🚨 Fix `clang-tidy` warnings

* 🏗️ Refactor the ALGLIB downloader for better reliability

* 💚 Fix build errors

* 💚 Enhance ALGLIB fetching process with manual extraction and preparation

* 💚 Significantly simplify the ALGLIB fetching and make it more reliable by hosting our own mirror

* 💚 Remove coverage specification from `noxfile.py`

* 👷 Deactivate PCH and Unity Builds in CI and limit parallelism

* ⬇️ Downgrade Z3 to ensure ABI compatibility

* 💚 Fix `jemalloc` building from source

* 🔥 Remove verbose comments

* 🚨 Fix `clang-tidy` warnings

* 📌 Streamline Z3 versions across all configurations

* 🔥 Remove planning document

* ✏️ Remove remaining mentions of the `libs/` folder

* 📝 Update CHANGELOG

* 🔒 Updated lockfile

* 💚 Reinsert `libs/*` check into the `clang-tidy` CI to prevent deleted files check in this PR

---------

Signed-off-by: GitHub Actions <actions@github.com>
Signed-off-by: Marcel Walter <marcel.walter@tum.de>
Co-authored-by: GitHub Actions <actions@github.com>

Author: marcelwa

.gitattributes

@@ -6,8 +6,8 @@ benchmarks/fontes18/* linguist-vendored
 benchmarks/trindade16/* linguist-vendored
 *.v linguist-detectable=false
 *.fs linguist-detectable=false
-libs/* linguist-detectable=false
-libs/combinations/* linguist-detectable=false
-libs/graph-coloring/* linguist-detectable=false
-libs/mugen/* linguist-detectable=false
-libs/undirected_graph/* linguist-detectable=false
+vendors/* linguist-detectable=false
+vendors/combinations/* linguist-detectable=false
+vendors/graph-coloring/* linguist-detectable=false
+vendors/mugen/* linguist-detectable=false
+vendors/undirected_graph/* linguist-detectable=false

.github/workflows/clang-tidy-review.yml

@@ -19,7 +19,7 @@ permissions:
   pull-requests: write
 
 env:
-  Z3_VERSION: 4.13.0
+  Z3_VERSION: 4.13.4
 
 jobs:
   clangtidy:
@@ -30,7 +30,6 @@ jobs:
       - name: Clone Repository
         uses: actions/checkout@v6
         with:
-          submodules: recursive
           fetch-depth: 0
 
       - name: Install dependencies
@@ -57,6 +56,7 @@ jobs:
           -DFICTION_PROGRESS_BARS=ON
           -DFICTION_Z3=ON
           -DFICTION_ENABLE_MUGEN=ON
+          -DFICTION_PYTHON_BINDINGS=ON
           -DFICTION_ALGLIB=ON
           -DFICTION_ENABLE_MUGEN=ON
           -DMOCKTURTLE_EXAMPLES=OFF
@@ -72,7 +72,7 @@ jobs:
           database: "build"
           step-summary: true
           thread-comments: ${{ ((github.event_name == 'pull_request' && !github.event.pull_request.head.repo.fork) && 'update') || 'false' }}
-          ignore-tidy: "build|libs/*|docs/*|benchmarks/*|bib/*|bindings/mnt/pyfiction/include/pyfiction/pybind11_mkdoc_docstrings.hpp|bindings/mnt/pyfiction/include/pyfiction/documentation.hpp"
+          ignore: "build|libs/*|vendors/*|docs/*|benchmarks/*|bib/*|bindings/mnt/pyfiction/include/pyfiction/pybind11_mkdoc_docstrings.hpp|bindings/mnt/pyfiction/include/pyfiction/documentation.hpp"
           version: "21"
 
       - if: steps.linter.outputs.checks-failed > 0

.github/workflows/codeql-analysis.yml

@@ -9,7 +9,6 @@ on:
       - "**/*.cmake"
       - "**/CMakeLists.txt"
       - "**/*.py"
-      - "libs/**"
       - ".github/workflows/codeql-analysis.yml"
       - "!bindings/mnt/pyfiction/include/pyfiction/pybind11_mkdoc_docstrings.hpp"
   pull_request:
@@ -20,7 +19,6 @@ on:
       - "**/*.cmake"
       - "**/CMakeLists.txt"
       - "**/*.py"
-      - "libs/**"
       - ".github/workflows/codeql-analysis.yml"
       - "!bindings/mnt/pyfiction/include/pyfiction/pybind11_mkdoc_docstrings.hpp"
   merge_group:
@@ -32,7 +30,7 @@ concurrency:
   cancel-in-progress: true
 
 env:
-  Z3_VERSION: 4.13.0
+  Z3_VERSION: 4.13.4
 
 jobs:
   analyze:
@@ -68,7 +66,6 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v6
         with:
-          submodules: recursive
           fetch-depth: 0
 
       - name: Setup ccache
@@ -91,7 +88,7 @@ jobs:
       - name: Install pip packages
         uses: BSFishy/pip-action@v1
         with:
-          requirements: ${{github.workspace}}/libs/mugen/requirements.txt
+          requirements: ${{github.workspace}}/vendors/mugen/requirements.txt
 
       - name: Setup Z3 Solver
         id: z3
@@ -110,19 +107,12 @@ jobs:
           languages: ${{ matrix.language }}
           config-file: .github/codeql-config.yml
 
-      - if: matrix.language == 'cpp'
-        name: Create Build Environment
-        run: cmake -E make_directory ${{github.workspace}}/build
-
       - if: matrix.language == 'cpp'
         name: Configure CMake
-        working-directory: ${{github.workspace}}/build
         run: >
-          cmake ${{github.workspace}}
+          cmake -S ${{github.workspace}} -B ${{github.workspace}}/build
           -DCMAKE_CXX_COMPILER=${{matrix.compiler}}
           -DCMAKE_BUILD_TYPE=${{matrix.build_type}}
-          -DFICTION_ENABLE_UNITY_BUILD=ON
-          -DFICTION_ENABLE_PCH=ON
           -DFICTION_CLI=OFF
           -DFICTION_TEST=ON
           -DFICTION_BENCHMARK=OFF
@@ -136,8 +126,7 @@ jobs:
 
       - if: matrix.language == 'cpp'
         name: Build fiction
-        working-directory: ${{github.workspace}}/build
-        run: cmake --build . --config ${{matrix.build_type}} -j4
+        run: cmake --build ${{github.workspace}}/build --config ${{matrix.build_type}} --parallel 4
 
       - name: Perform CodeQL Analysis
         uses: github/codeql-action/analyze@v4
@@ -149,7 +138,7 @@ jobs:
         uses: advanced-security/filter-sarif@main
         with:
           patterns: |
-            -**/libs/**
+            -**/vendors/**
             -**/docs/**
             -**/experiments/**
           input: sarif-results/${{ matrix.language }}.sarif

.github/workflows/coverage.yml

@@ -8,7 +8,6 @@ on:
       - "**/*.cpp"
       - "**/*.cmake"
       - "**/CMakeLists.txt"
-      - "libs/**"
       - ".github/workflows/coverage.yml"
       - "!bindings/mnt/pyfiction/include/pyfiction/pybind11_mkdoc_docstrings.hpp"
   pull_request:
@@ -18,7 +17,6 @@ on:
       - "**/*.cpp"
       - "**/*.cmake"
       - "**/CMakeLists.txt"
-      - "libs/**"
       - ".github/workflows/coverage.yml"
       - "!bindings/mnt/pyfiction/include/pyfiction/pybind11_mkdoc_docstrings.hpp"
   merge_group:
@@ -33,7 +31,7 @@ defaults:
 
 env:
   BUILD_TYPE: Debug
-  Z3_VERSION: 4.13.0
+  Z3_VERSION: 4.13.4
 
 jobs:
   build_and_test:
@@ -51,8 +49,6 @@ jobs:
 
       - name: Clone Repository
         uses: actions/checkout@v6
-        with:
-          submodules: recursive
 
       - name: Setup ccache
         uses: hendrikmuhs/ccache-action@v1.2
@@ -74,7 +70,7 @@ jobs:
       - name: Install pip packages
         uses: BSFishy/pip-action@v1
         with:
-          requirements: ${{github.workspace}}/libs/mugen/requirements.txt
+          requirements: ${{github.workspace}}/vendors/mugen/requirements.txt
 
       - name: Setup Z3 Solver
         id: z3
@@ -91,11 +87,10 @@ jobs:
           cmake -S ${{github.workspace}} -B ${{github.workspace}}/build -G Ninja
           -DCMAKE_CXX_COMPILER=${{matrix.compiler}}
           -DCMAKE_BUILD_TYPE=$BUILD_TYPE
-          -DFICTION_ENABLE_UNITY_BUILD=ON
-          -DFICTION_ENABLE_PCH=ON
           -DFICTION_CLI=OFF
           -DFICTION_TEST=ON
           -DFICTION_BENCHMARK=OFF
+          -DFICTION_EXPERIMENTS=OFF
           -DFICTION_Z3=ON
           -DFICTION_ALGLIB=ON
           -DFICTION_ENABLE_MUGEN=ON
@@ -105,11 +100,11 @@ jobs:
           -DMOCKTURTLE_EXAMPLES=OFF
 
       - name: Build
-        run: cmake --build ${{github.workspace}}/build --config $BUILD_TYPE --parallel
+        run: cmake --build ${{github.workspace}}/build --config $BUILD_TYPE --parallel 4
 
       - name: Test
         working-directory: ${{github.workspace}}/build
-        run: ctest -C $BUILD_TYPE --output-on-failure --repeat until-pass:3 --parallel
+        run: ctest -C $BUILD_TYPE --output-on-failure --repeat until-pass:3 --parallel 4
 
       - name: Generate Coverage Report
         run: |

.github/workflows/macos.yml

@@ -8,7 +8,6 @@ on:
       - "**/*.cpp"
       - "**/*.cmake"
       - "**/CMakeLists.txt"
-      - "libs/**"
       - ".github/workflows/macos.yml"
       - "!bindings/mnt/pyfiction/include/pyfiction/pybind11_mkdoc_docstrings.hpp"
   pull_request:
@@ -18,7 +17,6 @@ on:
       - "**/*.cpp"
       - "**/*.cmake"
       - "**/CMakeLists.txt"
-      - "libs/**"
       - ".github/workflows/macos.yml"
       - "!bindings/mnt/pyfiction/include/pyfiction/pybind11_mkdoc_docstrings.hpp"
   merge_group:
@@ -32,7 +30,7 @@ defaults:
     shell: bash
 
 env:
-  Z3_VERSION: 4.13.0
+  Z3_VERSION: 4.13.4
 
 jobs:
   build_and_test:
@@ -47,8 +45,6 @@ jobs:
     steps:
       - name: Clone Repository
         uses: actions/checkout@v6
-        with:
-          submodules: recursive
 
       - name: Setup Python
         uses: actions/setup-python@v6
@@ -77,17 +73,12 @@ jobs:
           version: ${{env.Z3_VERSION}}
 
       # Build and test pipeline for Debug mode
-      - name: Create Build Environment (Debug)
-        run: cmake -E make_directory ${{github.workspace}}/build_debug
 
       - name: Configure CMake (Debug)
-        working-directory: ${{github.workspace}}/build_debug
         run: >
-          cmake ${{github.workspace}}
+          cmake -S ${{github.workspace}} -B ${{github.workspace}}/build_debug
           -DCMAKE_CXX_COMPILER=${{matrix.compiler}}
           -DCMAKE_BUILD_TYPE=Debug
-          -DFICTION_ENABLE_UNITY_BUILD=ON
-          -DFICTION_ENABLE_PCH=ON
           -DFICTION_CLI=ON
           -DFICTION_TEST=ON
           -DFICTION_BENCHMARK=OFF
@@ -99,25 +90,18 @@ jobs:
           -DMOCKTURTLE_EXAMPLES=OFF
 
       - name: Build (Debug)
-        working-directory: ${{github.workspace}}/build_debug
-        run: cmake --build . --config Debug -j4 # all macOS runners provide at least 3 cores
+        run: cmake --build ${{github.workspace}}/build_debug --config Debug --parallel 3
 
       - name: Test (Debug)
-        working-directory: ${{github.workspace}}/build_debug
-        run: ctest -C Debug --verbose --output-on-failure --repeat until-pass:3 --parallel 4
+        run: ctest --test-dir ${{github.workspace}}/build_debug -C Debug --verbose --output-on-failure --repeat until-pass:3 --parallel 3
 
       # Build and test pipeline for Release mode
-      - name: Create Build Environment (Release)
-        run: cmake -E make_directory ${{github.workspace}}/build_release
 
       - name: Configure CMake (Release)
-        working-directory: ${{github.workspace}}/build_release
         run: >
-          cmake ${{github.workspace}}
+          cmake -S ${{github.workspace}} -B ${{github.workspace}}/build_release
           -DCMAKE_CXX_COMPILER=${{matrix.compiler}}
           -DCMAKE_BUILD_TYPE=Release
-          -DFICTION_ENABLE_UNITY_BUILD=ON
-          -DFICTION_ENABLE_PCH=ON
           -DFICTION_ENABLE_JEMALLOC=ON
           -DFICTION_CLI=ON
           -DFICTION_TEST=ON
@@ -130,9 +114,7 @@ jobs:
           -DMOCKTURTLE_EXAMPLES=OFF
 
       - name: Build (Release)
-        working-directory: ${{github.workspace}}/build_release
-        run: cmake --build . --config Release -j4 # all macOS runners provide at least 3 cores
+        run: cmake --build ${{github.workspace}}/build_release --config Release --parallel 3
 
       - name: Test (Release)
-        working-directory: ${{github.workspace}}/build_release
-        run: ctest -C Release --verbose --output-on-failure --repeat until-pass:3 --parallel 4
+        run: ctest --test-dir ${{github.workspace}}/build_release -C Release --verbose --output-on-failure --repeat until-pass:3 --parallel 3

.github/workflows/pyfiction-docstring-generator.yml

@@ -15,7 +15,6 @@ jobs:
       - name: Clone Repository
         uses: actions/checkout@v6
         with:
-          submodules: recursive
           fetch-depth: 0 # Fetch all history for all branches and tags
 
       - name: Setup Python

.github/workflows/pyfiction-pypi-deployment.yml

@@ -15,10 +15,9 @@ on:
       - "**/*.cpp"
       - "**/*.cmake"
       - "**/CMakeLists.txt"
-      - "libs/**"
       - "noxfile.py"
       - "pyproject.toml"
-      - ".uv.lock"
+      - "uv.lock"
       - ".github/workflows/pyfiction-pypi-deployment.yml"
   pull_request:
     branches: ["main"]
@@ -29,10 +28,9 @@ on:
       - "**/*.cpp"
       - "**/*.cmake"
       - "**/CMakeLists.txt"
-      - "libs/**"
       - "noxfile.py"
       - "pyproject.toml"
-      - ".uv.lock"
+      - "uv.lock"
       - ".github/workflows/pyfiction-pypi-deployment.yml"
   workflow_dispatch:
   workflow_run:
@@ -50,17 +48,16 @@ concurrency:
   cancel-in-progress: true
 
 env:
-  Z3_VERSION: 4.13.0
+  Z3_VERSION: 4.13.4
 
 jobs:
   build_sdist:
     name: 📦 Build Source Distribution
     runs-on: ubuntu-latest
     steps:
-      - name: Clone respository
+      - name: Clone repository
         uses: actions/checkout@v6
         with:
-          submodules: recursive
           fetch-depth: 0
 
       - name: Install the latest version of uv

.github/workflows/python-bindings.yml

@@ -10,10 +10,9 @@ on:
       - "**/*.cpp"
       - "**/*.cmake"
       - "**/CMakeLists.txt"
-      - "libs/**"
       - "noxfile.py"
       - "pyproject.toml"
-      - ".uv.lock"
+      - "uv.lock"
       - ".github/workflows/python-bindings.yml"
   pull_request:
     branches: ["main"]
@@ -24,10 +23,9 @@ on:
       - "**/*.cpp"
       - "**/*.cmake"
       - "**/CMakeLists.txt"
-      - "libs/**"
       - "noxfile.py"
       - "pyproject.toml"
-      - ".uv.lock"
+      - "uv.lock"
       - ".github/workflows/python-bindings.yml"
   workflow_run:
     workflows: ["pyfiction Docstring Generator"]
@@ -43,7 +41,7 @@ defaults:
     shell: bash
 
 env:
-  Z3_VERSION: 4.13.0
+  Z3_VERSION: 4.13.4
 
 jobs:
   python-tests:
@@ -52,12 +50,11 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        runs-on: [ubuntu-latest, macos-13, macos-15, windows-latest]
+        runs-on: [ubuntu-latest, macos-latest, windows-latest]
     steps:
       - name: Clone Repository
         uses: actions/checkout@v6
         with:
-          submodules: recursive
           fetch-depth: 0
 
       - name: Setup ccache