♻️ Refactor CMake Configuration (#211)

## Description

This PR builds on cda-tum/dd_package#125 as well
as munich-quantum-toolkit/core#246 and refactors the overall
CMake configuration.
The newly enabled compiler warnings showed some alerts, which have
subsequently been fixed.

## Checklist:

<!---
This checklist serves as a reminder of a couple of things that ensure
your pull request will be merged swiftly.
-->

- [x] The pull request only contains commits that are related to it.
- [x] I have added appropriate tests and documentation.
- [x] I have made sure that all CI jobs on GitHub pass.
- [x] The pull request introduces no new warnings and follows the
project's style guidelines.

Author: burgholzer

.github/dependabot.yml

@@ -6,23 +6,20 @@ updates:
       interval: "weekly"
       day: "friday"
       time: "06:00"
-    assignees:
-      - "burgholzer"
+      timezone: "Europe/Vienna"
 
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
       interval: "weekly"
       day: "friday"
       time: "06:00"
-    assignees:
-      - "burgholzer"
+      timezone: "Europe/Vienna"
 
   - package-ecosystem: "pip"
     directory: "/"
     schedule:
       interval: "weekly"
       day: "friday"
       time: "06:00"
-    assignees:
-      - "burgholzer"
+      timezone: "Europe/Vienna"

.github/workflows/ci.yml

@@ -17,6 +17,7 @@ defaults:
 
 env:
   CMAKE_BUILD_PARALLEL_LEVEL: 3
+  CTEST_PARALLEL_LEVEL: 3
   Z3_VERSION: 4.11.2
 
 jobs:
@@ -27,13 +28,9 @@ jobs:
       fail-fast: false
       matrix:
         config:
-          - { os: ubuntu-latest, test-dir: build/test, toolchain: "" }
-          - { os: macos-latest, test-dir: build/test, toolchain: "" }
-          - {
-              os: windows-latest,
-              test-dir: build\test\Release,
-              toolchain: "-T ClangCl",
-            }
+          - { os: ubuntu-latest, toolchain: "" }
+          - { os: macos-latest, toolchain: "" }
+          - { os: windows-latest, toolchain: "-T ClangCl" }
     steps:
       - uses: actions/checkout@v3
         with:
@@ -51,15 +48,13 @@ jobs:
       - name: Build
         run: cmake --build build --config Release
       - name: Test
-        working-directory: ${{ matrix.config.test-dir }}
-        run: ctest -C Release --output-on-failure
+        run: ctest -C Release --output-on-failure --test-dir build --repeat until-pass:3 --timeout 300
       - if: runner.os == 'Linux'
         name: Coverage
         run: |
-          cmake -S . -B buildCov -DCMAKE_BUILD_TYPE=Debug -DBUILD_QMAP_TESTS=ON -DCOVERAGE=ON
+          cmake -S . -B buildCov -DCMAKE_BUILD_TYPE=Debug -DBUILD_QMAP_TESTS=ON -DENABLE_COVERAGE=ON
           cmake --build buildCov --config Debug
-          cd buildCov/test
-          ctest -C Debug --output-on-failure
+          ctest -C Debug --output-on-failure --test-dir buildCov --repeat until-pass:3 --timeout 300
       - if: runner.os == 'Linux'
         name: Upload coverage to Codecov
         uses: codecov/codecov-action@v3.1.1

.github/workflows/codeql-analysis.yml

@@ -2,10 +2,10 @@ name: "CodeQL"
 
 on:
   push:
-    branches: [main]
   pull_request:
   schedule:
     - cron: "15 21 * * 6"
+  workflow_dispatch:
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}

.github/workflows/cpp-linter.yml

@@ -32,8 +32,7 @@ jobs:
           CC=clang-14 CXX=clang++-14 \
           cmake -S . -B build \
           -DBINDINGS=ON \
-          -DBUILD_QMAP_TESTS=ON \
-          -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
+          -DBUILD_QMAP_TESTS=ON
       - name: Run cpp-linter
         id: linter
         env:

.gitmodules

@@ -2,9 +2,7 @@
 	path = extern/qfr
 	url = https://github.com/cda-tum/qfr.git
 	branch = main
-    shallow = true
 [submodule "extern/LogicBlocks"]
 	path = extern/LogicBlocks
 	url = https://github.com/cda-tum/LogicBlocks.git
     branch = main
-    shallow = true

CMakeLists.txt

@@ -1,46 +1,15 @@
-cmake_minimum_required(VERSION 3.19...3.24)
+# set required cmake version
+cmake_minimum_required(VERSION 3.19)
+
+# This avoids googletest complaining that this (IPO) policy is not set
+cmake_policy(SET CMP0069 NEW)
+set(CMAKE_POLICY_DEFAULT_CMP0069 NEW)
 
 project(
   qmap
   LANGUAGES CXX
   DESCRIPTION "MQT QMAP - A library for mapping of quantum circuits to quantum architectures")
 
-# enable organization of targets into folders
-set_property(GLOBAL PROPERTY USE_FOLDERS ON)
-
-# configuration options
-option(DEPLOY "Configure for deployment")
-option(BINDINGS "Configure for building Python bindings")
-option(COVERAGE "Configure for coverage report generation")
-option(GENERATE_POSITION_INDEPENDENT_CODE "Generate position independent code")
-option(BUILD_QMAP_TESTS "Also build tests for QMAP project")
-
-if(DEFINED ENV{DEPLOY})
-  set(DEPLOY
-      $ENV{DEPLOY}
-      CACHE BOOL "Use deployment configuration from environment" FORCE)
-  message(STATUS "Setting deployment configuration to '${DEPLOY}' from environment")
-endif()
-
-# set deployment specific options
-if(DEPLOY)
-  # set the macOS deployment target appropriately
-  set(CMAKE_OSX_DEPLOYMENT_TARGET
-      "10.15"
-      CACHE STRING "" FORCE)
-endif()
-
-# build type settings
-set(DEFAULT_BUILD_TYPE "Release")
-if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
-  message(STATUS "Setting build type to '${DEFAULT_BUILD_TYPE}' as none was specified.")
-  set(CMAKE_BUILD_TYPE
-      "${default_build_type}"
-      CACHE STRING "Choose the type of build." FORCE)
-  set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS "Debug" "Release" "MinSizeRel"
-                                               "RelWithDebInfo")
-endif()
-
 # check whether the submodule ``modulename`` is correctly cloned in the ``/extern`` directory.
 macro(CHECK_SUBMODULE_PRESENT modulename)
   if(NOT EXISTS "${PROJECT_SOURCE_DIR}/extern/${modulename}/CMakeLists.txt")
@@ -65,20 +34,19 @@ if(NOT Z3_FOUND)
   message(WARNING "Did not find Z3. Exact library and other depending target will not be available")
 endif()
 
-set(THREADS_PREFER_PTHREAD_FLAG ON)
-find_package(Threads REQUIRED)
-
 # add main library code
 add_subdirectory(src)
 
 # add test code
+option(BUILD_QMAP_TESTS "Also build tests for QMAP project")
 if(BUILD_QMAP_TESTS)
   enable_testing()
   include(GoogleTest)
   add_subdirectory(test)
 endif()
 
 # add Python binding code
+option(BINDINGS "Configure for building Python bindings")
 if(BINDINGS)
   add_subdirectory(mqt/qmap)
 endif()

extern/LogicBlocks

@@ -48,7 +48,7 @@ class Architecture {
       void set(const KeyType& key, const ValueType& value) {
         props[key] = value;
       }
-      [[nodiscard]] bool available(const KeyType& key) const {
+      [[nodiscard, gnu::pure]] bool available(const KeyType& key) const {
         return props.find(key) != props.end();
       }
       void               clear() { props.clear(); }
@@ -217,8 +217,8 @@ class Architecture {
     loadProperties(propsFilename);
   }
 
-  Architecture(std::uint16_t nQ, const CouplingMap& couplingMap);
-  Architecture(std::uint16_t nQ, const CouplingMap& couplingMap,
+  Architecture(std::uint16_t nQ, const CouplingMap& cm);
+  Architecture(std::uint16_t nQ, const CouplingMap& cm,
                const Properties& props);
 
   [[nodiscard]] std::uint16_t getNqubits() const { return nqubits; }

extern/qfr

@@ -38,8 +38,8 @@ class Mapper {
     qc::Operation* op = nullptr;
 
     Gate(const std::int16_t c, const std::uint16_t t) : control(c), target(t){};
-    Gate(const std::int16_t c, const std::uint16_t t, qc::Operation* op)
-        : control(c), target(t), op(op){};
+    Gate(const std::int16_t c, const std::uint16_t t, qc::Operation* operation)
+        : control(c), target(t), op(operation){};
 
     [[nodiscard]] bool singleQubit() const { return control == -1; }
   };
@@ -128,7 +128,7 @@ class Mapper {
    * @brief Get the index of the next layer after the given index containing a
    * gate acting on more than one qubit
    */
-  virtual std::size_t getNextLayer(std::size_t idx);
+  [[gnu::pure]] virtual std::size_t getNextLayer(std::size_t idx);
 
   /**
    * @brief adding additional qubits to the result circuit if architecture has