🎉 RFC: Redesign of QDMI

.clang-tidy

@@ -28,7 +28,7 @@ Checks: |
   readability-*,
   -readability-identifier-length,
   -readability-magic-numbers,
-  -readability-function-cognitive-complexity
+  -readability-redundant-member-init
 
 CheckOptions:
   - key: readability-identifier-naming.ClassCase
@@ -51,6 +51,10 @@ CheckOptions:
     value: lower_case
   - key: readability-identifier-naming.MemberCase
     value: lower_case
+  - key: readability-identifier-naming.PrivateMemberSuffix
+    value: _
+  - key: readability-identifier-naming.ProtectedMemberSuffix
+    value: _
   - key: readability-identifier-naming.MemberIgnoredRegexp
     value: ".*QDMI.*"
   - key: readability-identifier-naming.MethodCase
@@ -67,3 +71,5 @@ CheckOptions:
     value: ".*QDMI.*"
   - key: readability-identifier-naming.VariableCase
     value: lower_case
+  - key: readability-identifier-naming.VariableIgnoredRegexp
+    value: ".*QDMI.*"

.github/codecov.yml

@@ -25,8 +25,6 @@ flag_management:
         - "include"
         - "examples/device/src"
         - "examples/driver"
-        - "examples/fomac"
-        - "examples/tool"
 
 parsers:
   gcov:

.github/workflows/ci.yml

@@ -47,12 +47,6 @@ jobs:
       clang-version: 21
       cpp-linter-extra-args: "-std=c++20"
 
-  template:
-    name: 🏗️ Build and Test Templates
-    needs: change-detection
-    if: fromJSON(needs.change-detection.outputs.run-template) && github.event.action != 'closed'
-    uses: ./.github/workflows/reusable-template-ci.yml
-
   docs:
     name: 📝 Build and Deploy Docs
     needs: change-detection
@@ -69,7 +63,6 @@ jobs:
       - change-detection
       - tests
       - linter
-      - template
       - docs
     runs-on: ubuntu-latest
     steps:
@@ -83,9 +76,6 @@ jobs:
             }} ${{
               fromJSON(needs.change-detection.outputs.run-linter)
               && '' || 'linter,'
-            }} ${{
-              fromJSON(needs.change-detection.outputs.run-template)
-              && '' || 'template,'
             }} ${{
              fromJSON(needs.change-detection.outputs.run-docs)
               && '' || 'docs,'

.github/workflows/release-docs.yml

@@ -35,7 +35,7 @@ jobs:
 
       - name: Install and Build 🔧
         run: |
-          cmake -S . -B build -DBUILD_QDMI_DOCS=ON
+          cmake -S . -B build -DQDMI_BUILD_DOCS=ON
           cmake --build build --target qdmi-docs
           mv build/docs/html/ static
 

.github/workflows/reusable-change-detection.yml

@@ -11,9 +11,6 @@ on:
       run-linter:
         description: Whether to run the linter
         value: ${{ jobs.change-detection.outputs.run-linter || false }}
-      run-template:
-        description: Whether to run the template job
-        value: ${{ jobs.change-detection.outputs.run-template || false }}
       run-docs:
         description: Whether to run the documentation job
         value: ${{ jobs.change-detection.outputs.run-docs || false }}
@@ -29,7 +26,6 @@ jobs:
     outputs:
       run-tests: ${{ steps.tests-changes.outputs.run-tests || false }}
       run-linter: ${{ steps.linter-changes.outputs.run-linter || false }}
-      run-template: ${{ steps.template-changes.outputs.run-template || false }}
       run-docs: ${{ steps.docs-changes.outputs.run-docs || false }}
     steps:
       - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
@@ -42,7 +38,6 @@ jobs:
             include/**
             test/**
             examples/**
-            templates/**
             CMakeLists.txt
             cmake/**
             .github/codecov.yml
@@ -63,7 +58,6 @@ jobs:
             include/**
             test/**
             examples/**
-            templates/**
             .clang-tidy
             .github/workflows/ci.yml
       - name: Set a flag for running the linter
@@ -73,24 +67,6 @@ jobs:
         id: linter-changes
         run: >-
           echo "run-linter=true" >> "${GITHUB_OUTPUT}"
-      - name: Get a list of the changed files relevant for the template job
-        if: github.event_name == 'pull_request'
-        id: changed-template-files
-        uses: Ana06/get-changed-files@25f79e676e7ea1868813e21465014798211fad8c # v2.3.0
-        with:
-          filter: |
-            include/**
-            examples/**
-            templates/**
-            .github/workflows/reusable-template-ci.yml
-            .github/workflows/ci.yml
-      - name: Set a flag for running the template job
-        if: >-
-          github.event_name != 'pull_request' ||
-          steps.changed-template-files.outputs.added_modified_renamed != ''
-        id: template-changes
-        run: >-
-          echo "run-template=true" >> "${GITHUB_OUTPUT}"
       - name: Get a list of the changed files relevant for documentation build
         if: github.event_name == 'pull_request'
         id: changed-docs-files
@@ -99,7 +75,6 @@ jobs:
           filter: |
             include/**
             examples/**
-            templates/**
             docs/**
             .github/workflows/reusable-docs.yml
             .github/workflows/ci.yml

.github/workflows/reusable-cpp-ci.yml

@@ -29,7 +29,7 @@ jobs:
     name: 📦 Install
     uses: ./.github/workflows/reusable-cpp-install-tests.yml
     with:
-      cmake-args: "-G Ninja -DBUILD_QDMI_DOCS=OFF"
+      cmake-args: "-G Ninja -DQDMI_BUILD_DOCS=OFF"
 
   coverage:
     name: 📈

.github/workflows/reusable-cpp-install-tests.yml

@@ -58,10 +58,10 @@ jobs:
       # configure CMake for using the installed QDMI
       - name: Configure CMake for use of installed QDMI
         run:
-          cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DUSE_INSTALLED_QDMI=ON -DBUILD_CXX_QDMI_TESTS=ON
+          cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DQDMI_USE_INSTALLED=ON -DBUILD_CXX_QDMI_TESTS=ON
           -DCMAKE_PREFIX_PATH=install-dir ${{ inputs.cmake-args }}
       # build the project
-      - name: Build QDMI examples, templates, and tests with installed QDMI
+      - name: Build QDMI examples and tests with installed QDMI
         run: cmake --build build --config Release
       # run the tests
       - name: Test

.github/workflows/reusable-docs.yml

@@ -19,7 +19,7 @@ jobs:
       - name: Install and Build 🔧
         if: github.event.action != 'closed'
         run: |
-          cmake -S . -B build -DBUILD_QDMI_DOCS=ON
+          cmake -S . -B build -DQDMI_BUILD_DOCS=ON
           cmake --build build --target qdmi-docs
           mv build/docs/html/ static
       - name: Inject version selector

.typos.toml

@@ -1,5 +1,2 @@
 [default.extend-words]
 wille = "wille"
-
-[default.extend-identifiers]
-FoMaC = "FoMaC"