diff --git a/.clang-tidy b/.clang-tidy index 1f592f8f..db4d3ea5 100644 --- a/.clang-tidy +++ b/.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.*" diff --git a/.github/codecov.yml b/.github/codecov.yml index d11a87df..a276118d 100644 --- a/.github/codecov.yml +++ b/.github/codecov.yml @@ -25,8 +25,6 @@ flag_management: - "include" - "examples/device/src" - "examples/driver" - - "examples/fomac" - - "examples/tool" parsers: gcov: diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 27ea6c9b..6539ee80 100644 --- a/.github/workflows/ci.yml +++ b/.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,' diff --git a/.github/workflows/release-docs.yml b/.github/workflows/release-docs.yml index 08da816f..1987fffe 100644 --- a/.github/workflows/release-docs.yml +++ b/.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 diff --git a/.github/workflows/reusable-change-detection.yml b/.github/workflows/reusable-change-detection.yml index c2bfa82b..215c10ac 100644 --- a/.github/workflows/reusable-change-detection.yml +++ b/.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 diff --git a/.github/workflows/reusable-cpp-ci.yml b/.github/workflows/reusable-cpp-ci.yml index bbf2e967..2ed75e53 100644 --- a/.github/workflows/reusable-cpp-ci.yml +++ b/.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: πŸ“ˆ diff --git a/.github/workflows/reusable-cpp-install-tests.yml b/.github/workflows/reusable-cpp-install-tests.yml index 0bfeed5e..9397e286 100644 --- a/.github/workflows/reusable-cpp-install-tests.yml +++ b/.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 diff --git a/.github/workflows/reusable-docs.yml b/.github/workflows/reusable-docs.yml index 5b9ca032..329fb698 100644 --- a/.github/workflows/reusable-docs.yml +++ b/.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 diff --git a/.github/workflows/reusable-template-ci.yml b/.github/workflows/reusable-template-ci.yml deleted file mode 100644 index 2a7a7712..00000000 --- a/.github/workflows/reusable-template-ci.yml +++ /dev/null @@ -1,76 +0,0 @@ -name: πŸ—οΈ Build and Test Templates -on: - workflow_call: - -permissions: - contents: read - -jobs: - device-template: - name: Build Device Template - runs-on: ubuntu-24.04 - env: - CMAKE_BUILD_PARALLEL_LEVEL: 4 - CTEST_PARALLEL_LEVEL: 4 - FORCE_COLOR: 3 - steps: - - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 - with: - path: qdmi - - name: Configure template - working-directory: qdmi - run: > - cmake -DQDMI_GENERATE_TEMPLATE=ON \ - -DTEMPLATE_PREFIX="MQSS" \ - -DTEMPLATE_PATH="$GITHUB_WORKSPACE" \ - -S . -B build - - name: Generate template - working-directory: qdmi - run: cmake --build build --target qdmi-template - - name: Delete source repository and build directory - run: | - rm -rf qdmi build - - name: Initialize as git repository (with main as branch name) and commit - run: | - git config --global init.defaultBranch main - git config --global user.name "GitHub Actions" - git config --global user.email "actions@github.com" - git init - git add . - git commit -m "πŸŽ‰ Initial commit" - - name: Build template - run: | - cmake -G Ninja -S . -B build -DCMAKE_BUILD_TYPE=Release -DBUILD_MQSS_QDMI_TESTS=ON - cmake --build build --config Release - - name: Install Doxygen - uses: ssciwr/doxygen-install@329d88f5a303066a5bd006db7516b1925b86350e # v2.0.1 - with: - version: "1.15.0" - - name: Build docs - run: | - cmake -G Ninja -S . -B build_docs -DCMAKE_BUILD_TYPE=Release -DBUILD_MQSS_QDMI_DOCS=ON -DBUILD_MQSS_QDMI_TESTS=OFF - cmake --build build_docs --config Release --target mqss_qdmi_device_docs - rm -rf build_docs - - uses: pypa/cibuildwheel@294735312765b09d24a2fbec22660ce817587d55 # v4.1.0 - - name: Verify clean directory - run: git diff --exit-code - - name: Upload wheels - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 - with: - name: ${{ github.event_name == 'pull_request' && 'dev-' || '' }}cibw-wheels-${{ runner.runs-on }} - path: wheelhouse/*.whl - - name: Install the latest version of uv - uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0 - with: - enable-cache: true - save-cache: ${{ github.ref == 'refs/heads/main' }} - - name: Build SDist - run: uv build --sdist - - name: Check metadata - run: uvx twine check dist/* - - name: Run check-sdist - run: uvx check-sdist --inject-junk - - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 - with: - name: ${{ github.event_name == 'pull_request' && 'dev-' || '' }}cibw-sdist - path: dist/*.tar.gz diff --git a/.typos.toml b/.typos.toml index 74f08567..3f4dce4b 100644 --- a/.typos.toml +++ b/.typos.toml @@ -1,5 +1,2 @@ [default.extend-words] wille = "wille" - -[default.extend-identifiers] -FoMaC = "FoMaC" diff --git a/CMakeLists.txt b/CMakeLists.txt index 9f25ed17..d8a0ebab 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -19,8 +19,8 @@ cmake_minimum_required(VERSION 3.24...4.2) project( qdmi - LANGUAGES C CXX - VERSION 1.3.2 + LANGUAGES C + VERSION 2.0.0 DESCRIPTION "QDMI –– Quantum Device Management Interface") set(PROJECT_VERSION_PRERELEASE "-dev") @@ -47,22 +47,18 @@ else() set(QDMI_MASTER_PROJECT OFF) endif() -option( - USE_INSTALLED_QDMI - "Use an installed version of QDMI to build examples, templates, and tests" - OFF) - +option(QDMI_USE_INSTALLED + "Use an installed version of QDMI to build examples and tests" OFF) +option(QDMI_BUILD_DOCS "Build documentation for the QDMI project" OFF) include(CMakeDependentOption) cmake_dependent_option( - INSTALL_QDMI "Generate installation instructions for QDMI" - ${QDMI_MASTER_PROJECT} "NOT USE_INSTALLED_QDMI" OFF) -option(BUILD_QDMI_TESTS "Also build tests for the QDMI project" - ${QDMI_MASTER_PROJECT}) -option(BUILD_QDMI_EXAMPLES "Also build examples for the QDMI project" - ${QDMI_MASTER_PROJECT}) -option(BUILD_QDMI_DOCS "Also build documentation for the QDMI project" OFF) -option(BUILD_QDMI_TEMPLATES "Also build templates for the QDMI project" + QDMI_INSTALL "Generate installation instructions for QDMI" + ${QDMI_MASTER_PROJECT} "NOT QDMI_USE_INSTALLED" OFF) +option(QDMI_BUILD_EXAMPLES "Also build examples for the QDMI project" ${QDMI_MASTER_PROJECT}) +cmake_dependent_option( + QDMI_BUILD_TESTS "Also build tests for the QDMI examples" + ${QDMI_BUILD_EXAMPLES} "QDMI_BUILD_EXAMPLES" OFF) # Generate compile_commands.json to make it easier to work with clang-based # tools @@ -77,7 +73,7 @@ set(CMAKE_C_EXTENSIONS False) include(cmake/ExternalDependencies.cmake) -if(NOT USE_INSTALLED_QDMI) +if(NOT QDMI_USE_INSTALLED) # set some important directories set(QDMI_INCLUDE_BUILD_DIR "${CMAKE_CURRENT_SOURCE_DIR}/include" @@ -91,6 +87,11 @@ if(NOT USE_INSTALLED_QDMI) include(cmake/Cache.cmake) + # enable C++ only when building examples (C++ implementations, tests, spdlog) + if(QDMI_BUILD_EXAMPLES) + enable_language(CXX) + endif() + include(cmake/PrefixHandling.cmake) include(GNUInstallDirs) @@ -128,13 +129,13 @@ if(NOT USE_INSTALLED_QDMI) endif() # enable coverage collection options - option(ENABLE_COVERAGE "Enable coverage reporting" FALSE) - if(ENABLE_COVERAGE) + option(QDMI_ENABLE_COVERAGE "Enable coverage reporting for gcc/clang" FALSE) + if(QDMI_ENABLE_COVERAGE) add_library(qdmi_coverage_flags INTERFACE) target_compile_options( qdmi_coverage_flags INTERFACE --coverage -fprofile-arcs -ftest-coverage -O0) - target_link_libraries(qdmi_coverage_flags INTERFACE gcov --coverage) + target_link_libraries(qdmi_coverage_flags INTERFACE --coverage) add_library(qdmi::qdmi_coverage_flags ALIAS qdmi_coverage_flags) target_link_libraries(qdmi INTERFACE qdmi::qdmi_coverage_flags) endif() @@ -143,7 +144,8 @@ if(NOT USE_INSTALLED_QDMI) set_target_properties( qdmi PROPERTIES VERSION ${PROJECT_VERSION} - SOVERSION ${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}) + SOVERSION ${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR} + FOLDER "qdmi") # add alias add_library(qdmi::qdmi ALIAS qdmi) @@ -151,34 +153,20 @@ if(NOT USE_INSTALLED_QDMI) endif() # add documentation -if(BUILD_QDMI_DOCS) +if(QDMI_BUILD_DOCS) add_subdirectory(docs) endif() -# add examples (used by tests) -if(BUILD_QDMI_EXAMPLES OR BUILD_QDMI_TESTS) +# add examples (incl. opt. tests) +if(QDMI_BUILD_EXAMPLES) + if(QDMI_BUILD_TESTS) + enable_testing() + endif() add_subdirectory(examples) endif() -# add templates -if(BUILD_QDMI_TEMPLATES OR BUILD_QDMI_TESTS) - # if testing is enabled, also enable building the tests in the templates - set(BUILD_MY_QDMI_TESTS - ${BUILD_QDMI_TESTS} - CACHE BOOL "Build tests for my-qdmi-device" FORCE) - add_subdirectory(templates) -endif() - -# add test code -if(BUILD_QDMI_TESTS) - enable_testing() - include(GoogleTest) - # include the tests itself - add_subdirectory(test) -endif() - # Installation instructions for the main library -if(INSTALL_QDMI) +if(QDMI_INSTALL) set(QDMI_CONFIG_INSTALL_DIR "${CMAKE_INSTALL_DATADIR}/cmake/${PROJECT_NAME}" CACHE INTERNAL "Config install directory") @@ -201,7 +189,7 @@ if(INSTALL_QDMI) COMPONENT ${PROJECT_NAME}_Development) set(QDMI_INSTALL_TARGETS ${QDMI_INSTALL_TARGETS} qdmi qdmi_project_warnings) - if(ENABLE_COVERAGE) + if(QDMI_ENABLE_COVERAGE) list(APPEND QDMI_INSTALL_TARGETS qdmi_coverage_flags) endif() @@ -232,7 +220,7 @@ if(INSTALL_QDMI) FILES ${PROJECT_SOURCE_DIR}/cmake/Cache.cmake ${PROJECT_SOURCE_DIR}/cmake/prefix_defs.txt ${PROJECT_SOURCE_DIR}/cmake/PrefixHandling.cmake - ${PROJECT_SOURCE_DIR}/cmake/test_defs.cpp.in + ${PROJECT_SOURCE_DIR}/cmake/test_defs.c.in DESTINATION ${QDMI_CONFIG_INSTALL_DIR} COMPONENT ${PROJECT_NAME}_Development) endif() diff --git a/CMakePresets.json b/CMakePresets.json index c80c0e74..f4731051 100644 --- a/CMakePresets.json +++ b/CMakePresets.json @@ -35,7 +35,7 @@ "displayName": "Coverage config", "cacheVariables": { "CMAKE_BUILD_TYPE": "Debug", - "ENABLE_COVERAGE": "ON" + "QDMI_ENABLE_COVERAGE": "ON" } }, { diff --git a/cmake/ExternalDependencies.cmake b/cmake/ExternalDependencies.cmake index a46a8224..cea45ecf 100644 --- a/cmake/ExternalDependencies.cmake +++ b/cmake/ExternalDependencies.cmake @@ -16,10 +16,9 @@ # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception include(FetchContent) -include(CMakeDependentOption) set(FETCH_PACKAGES "") -if(BUILD_QDMI_DOCS) +if(QDMI_BUILD_DOCS) set(CMAKE_POLICY_DEFAULT_CMP0116 NEW CACHE STRING @@ -51,7 +50,22 @@ if(BUILD_QDMI_DOCS) list(APPEND FETCH_PACKAGES doxygen-awesome-css) endif() -if(BUILD_QDMI_TESTS) +if(QDMI_BUILD_EXAMPLES) + set(SPDLOG_VERSION + 1.17.0 + CACHE STRING "spdlog version") + set(SPDLOG_URL + https://github.com/gabime/spdlog/archive/refs/tags/v${SPDLOG_VERSION}.tar.gz + ) + set(SPDLOG_SYSTEM_INCLUDES + ON + CACHE INTERNAL "Treat the library headers like system headers") + FetchContent_Declare(spdlog URL ${SPDLOG_URL} FIND_PACKAGE_ARGS + ${SPDLOG_VERSION}) + list(APPEND FETCH_PACKAGES spdlog) +endif() + +if(QDMI_BUILD_TESTS) set(gtest_force_shared_crt ON CACHE BOOL "" FORCE) @@ -72,6 +86,15 @@ endif() # Make all declared dependencies available. FetchContent_MakeAvailable(${FETCH_PACKAGES}) -if(USE_INSTALLED_QDMI) +# Group fetched targets into IDE folders (must be after MakeAvailable) +if(QDMI_BUILD_EXAMPLES AND TARGET spdlog) + set_target_properties(spdlog PROPERTIES FOLDER "external/spdlog") +endif() +if(QDMI_BUILD_TESTS AND TARGET gtest) + set_target_properties(gtest gtest_main gmock gmock_main + PROPERTIES FOLDER "external/googletest") +endif() + +if(QDMI_USE_INSTALLED) find_package(QDMI ${PROJECT_VERSION} REQUIRED) endif() diff --git a/cmake/GenerateTemplate.cmake b/cmake/GenerateTemplate.cmake deleted file mode 100644 index a60216af..00000000 --- a/cmake/GenerateTemplate.cmake +++ /dev/null @@ -1,211 +0,0 @@ -# Copyright (c) 2024 - 2026 QDMI Maintainers -# All rights reserved. -# -# Licensed under the Apache License v2.0 with LLVM Exceptions (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://llvm.org/LICENSE.txt -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -# License for the specific language governing permissions and limitations under -# the License. -# -# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception - -# Script-mode generator for the QDMI device template. -# -# Expected variables (passed via -D...): - QDMI_TEMPLATE_SOURCE_DIR: path to -# templates/device - QDMI_TEMPLATE_OUTPUT_DIR: output directory to -# create/populate - QDMI_TEMPLATE_PREFIX: uppercase prefix, e.g. "ABC" - -# QDMI_TEMPLATE_FORCE: ON/OFF, allow overwriting conflicting files - -# QDMI_TEMPLATE_CLEAN: ON/OFF, remove the entire output dir before generating - -cmake_minimum_required(VERSION 3.24) - -foreach(var IN ITEMS QDMI_TEMPLATE_SOURCE_DIR QDMI_TEMPLATE_OUTPUT_DIR - QDMI_TEMPLATE_PREFIX) - if(NOT DEFINED ${var} OR "${${var}}" STREQUAL "") - message(FATAL_ERROR "[qdmi-template] Missing required -D${var}=...") - endif() -endforeach() - -set(QDMI_TEMPLATE_FORCE "${QDMI_TEMPLATE_FORCE}") -if("${QDMI_TEMPLATE_FORCE}" STREQUAL "") - set(QDMI_TEMPLATE_FORCE OFF) -endif() - -set(QDMI_TEMPLATE_CLEAN "${QDMI_TEMPLATE_CLEAN}") -if("${QDMI_TEMPLATE_CLEAN}" STREQUAL "") - set(QDMI_TEMPLATE_CLEAN OFF) -endif() - -set(QDMI_TEMPLATE_TEST_SUITE "${QDMI_TEMPLATE_TEST_SUITE}") -if("${QDMI_TEMPLATE_TEST_SUITE}" STREQUAL "") - set(QDMI_TEMPLATE_TEST_SUITE OFF) -endif() - -# file(REAL_PATH ...) fails if the path doesn't (yet) exist on some -# platforms/CMakes. Use REAL_PATH only when the path exists; otherwise compute -# an absolute path which does not require the target to exist. -if(EXISTS "${QDMI_TEMPLATE_SOURCE_DIR}") - file(REAL_PATH "${QDMI_TEMPLATE_SOURCE_DIR}" QDMI_TEMPLATE_SOURCE_DIR) -else() - get_filename_component(QDMI_TEMPLATE_SOURCE_DIR "${QDMI_TEMPLATE_SOURCE_DIR}" - ABSOLUTE) -endif() - -if(EXISTS "${QDMI_TEMPLATE_OUTPUT_DIR}") - file(REAL_PATH "${QDMI_TEMPLATE_OUTPUT_DIR}" QDMI_TEMPLATE_OUTPUT_DIR) -else() - get_filename_component(QDMI_TEMPLATE_OUTPUT_DIR "${QDMI_TEMPLATE_OUTPUT_DIR}" - ABSOLUTE) -endif() - -string(TOLOWER "${QDMI_TEMPLATE_PREFIX}" QDMI_TEMPLATE_prefix) - -if(NOT EXISTS "${QDMI_TEMPLATE_SOURCE_DIR}") - message( - FATAL_ERROR - "[qdmi-template] Source directory does not exist: ${QDMI_TEMPLATE_SOURCE_DIR}" - ) -endif() - -# Destination handling By default, we allow generating into an existing -# directory (even if non-empty) and simply overwrite files that belong to the -# template. This avoids surprising configure-time side effects while keeping the -# generation convenient. -if(EXISTS "${QDMI_TEMPLATE_OUTPUT_DIR}") - if(QDMI_TEMPLATE_CLEAN) - message( - STATUS "[qdmi-template] Cleaning output dir: ${QDMI_TEMPLATE_OUTPUT_DIR}") - file(REMOVE_RECURSE "${QDMI_TEMPLATE_OUTPUT_DIR}") - file(MAKE_DIRECTORY "${QDMI_TEMPLATE_OUTPUT_DIR}") - else() - # Keep the directory and just overwrite files as needed. - message( - STATUS - "[qdmi-template] Output directory exists; updating in-place: ${QDMI_TEMPLATE_OUTPUT_DIR}" - ) - endif() -else() - file(MAKE_DIRECTORY "${QDMI_TEMPLATE_OUTPUT_DIR}") -endif() - -message( - STATUS - "[qdmi-template] Generating device template for prefix '${QDMI_TEMPLATE_PREFIX}' in '${QDMI_TEMPLATE_OUTPUT_DIR}'" -) - -# Collect all files under the template source dir, but only regular files. -file( - GLOB_RECURSE _files - LIST_DIRECTORIES false - "${QDMI_TEMPLATE_SOURCE_DIR}/*") - -# Apply substitutions file-by-file. -foreach(_src IN LISTS _files) - file(RELATIVE_PATH _rel "${QDMI_TEMPLATE_SOURCE_DIR}" "${_src}") - get_filename_component(_rel_dir "${_rel}" DIRECTORY) - get_filename_component(_name "${_rel}" NAME) - - # Rename path segments / filenames similar to the previous configure-time - # logic. - set(_dest_rel_dir "${_rel_dir}") - set(_dest_name "${_name}") - - # Directory-level rename: python/my -> python/ - string(REPLACE "python/my" "python/${QDMI_TEMPLATE_prefix}" _dest_rel_dir - "${_dest_rel_dir}") - - # Filename renames that include the placeholder - string(REPLACE "my_" "${QDMI_TEMPLATE_prefix}_" _dest_name "${_dest_name}") - string(REPLACE "my-" "${QDMI_TEMPLATE_prefix}-" _dest_name "${_dest_name}") - string(REPLACE "my.qdmi" "${QDMI_TEMPLATE_prefix}.qdmi" _dest_name - "${_dest_name}") - - set(_dest "${QDMI_TEMPLATE_OUTPUT_DIR}/${_dest_rel_dir}/${_dest_name}") - get_filename_component(_dest_dir "${_dest}" DIRECTORY) - file(MAKE_DIRECTORY "${_dest_dir}") - - # Read content and replace placeholders. - file(READ "${_src}" _content) - - # ---- Tutorial test-suite switching ---------------------------------------- - # test_my_device_tutorial.cpp: only written when QDMI_TEMPLATE_TEST_SUITE=ON, - # and it is written to the same destination as the normal test file would be. - # test_my_device.cpp: only written when QDMI_TEMPLATE_TEST_SUITE=OFF. - if("${_name}" STREQUAL "test_my_device_tutorial.cpp") - if(NOT QDMI_TEMPLATE_TEST_SUITE) - continue() # skip tutorial suite when flag is OFF - endif() - # Override destination name before the normal my_β†’prefix renaming runs, so - # the file lands as test__device.cpp (not _tutorial.cpp). - set(_dest_name "test_${QDMI_TEMPLATE_prefix}_device.cpp") - # Recompute the full destination path with the new name. - set(_dest "${QDMI_TEMPLATE_OUTPUT_DIR}/${_dest_rel_dir}/${_dest_name}") - get_filename_component(_dest_dir "${_dest}" DIRECTORY) - file(MAKE_DIRECTORY "${_dest_dir}") - elseif("${_name}" STREQUAL "test_my_device.cpp") - if(QDMI_TEMPLATE_TEST_SUITE) - continue() # skip default suite when tutorial suite is selected - endif() - endif() - # -------------------------------------------------------------------------- - - # Be conservative: these are all specific placeholders used by the shipped - # template. - string( - REGEX - REPLACE "set\\(QDMI_PREFIX \"MY\"\\)" - "set(QDMI_PREFIX \"${QDMI_TEMPLATE_PREFIX}\")" _content - "${_content}") - string(REPLACE "MY_" "${QDMI_TEMPLATE_PREFIX}_" _content "${_content}") - string(REPLACE "MY QDMI" "${QDMI_TEMPLATE_PREFIX} QDMI" _content - "${_content}") - string(REPLACE "my_" "${QDMI_TEMPLATE_prefix}_" _content "${_content}") - string(REPLACE "my-" "${QDMI_TEMPLATE_prefix}-" _content "${_content}") - string(REPLACE "python/my" "python/${QDMI_TEMPLATE_prefix}" _content - "${_content}") - string(REPLACE "my/qdmi" "${QDMI_TEMPLATE_prefix}/qdmi" _content - "${_content}") - string(REPLACE "my-qdmi" "${QDMI_TEMPLATE_prefix}-qdmi" _content - "${_content}") - string(REPLACE "my.qdmi" "${QDMI_TEMPLATE_prefix}.qdmi" _content - "${_content}") - string(REPLACE "\"my\"" "\"${QDMI_TEMPLATE_PREFIX}\"" _content "${_content}") - string(REPLACE "--namespace-pkg my" "--namespace-pkg ${QDMI_TEMPLATE_prefix}" - _content "${_content}") - - file(WRITE "${_dest}" "${_content}") -endforeach() - -# Explicit folder/file renames that can't be expressed purely via filename -# mapping above. (These are safe no-ops if the file doesn't exist in future -# template revisions.) -if(EXISTS "${QDMI_TEMPLATE_OUTPUT_DIR}/python/my") - file(RENAME "${QDMI_TEMPLATE_OUTPUT_DIR}/python/my" - "${QDMI_TEMPLATE_OUTPUT_DIR}/python/${QDMI_TEMPLATE_prefix}") -endif() - -foreach( - _p IN - ITEMS - "src/my_device.cpp;src/${QDMI_TEMPLATE_prefix}_device.cpp" - "test/test_my_device.cpp;test/test_${QDMI_TEMPLATE_prefix}_device.cpp" - "cmake/my-qdmi-device-config.cmake.in;cmake/${QDMI_TEMPLATE_prefix}-qdmi-device-config.cmake.in" - "docs/_static/my_logo.svg;docs/_static/${QDMI_TEMPLATE_prefix}_logo.svg" - "docs/_static/my_logo_dark.svg;docs/_static/${QDMI_TEMPLATE_prefix}_logo_dark.svg" -) - string(REPLACE ";" ";" _p "${_p}") - list(GET _p 0 _from) - list(GET _p 1 _to) - if(EXISTS "${QDMI_TEMPLATE_OUTPUT_DIR}/${_from}") - file(RENAME "${QDMI_TEMPLATE_OUTPUT_DIR}/${_from}" - "${QDMI_TEMPLATE_OUTPUT_DIR}/${_to}") - endif() -endforeach() - -message(STATUS "[qdmi-template] Generation done") diff --git a/cmake/MakeVersion.cmake b/cmake/MakeVersion.cmake new file mode 100644 index 00000000..af78f27a --- /dev/null +++ b/cmake/MakeVersion.cmake @@ -0,0 +1,36 @@ +# Copyright (c) 2024 - 2026 QDMI Maintainers +# All rights reserved. +# +# Licensed under the Apache License v2.0 with LLVM Exceptions (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://llvm.org/LICENSE.txt +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations under +# the License. +# +# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception + +# function to pack version strings into one integer according to QDMI's +# specification +function(qdmi_make_version output input) + set(result 0) + # Split the version string into major, minor, and patch components + string(REGEX MATCHALL "[0-9]+" qdmi_version_components "${input}") + list(GET qdmi_version_components 0 qdmi_version_major) + list(GET qdmi_version_components 1 qdmi_version_minor) + list(GET qdmi_version_components 2 qdmi_version_patch) + # Calculate the packed integer version + math( + EXPR + result + "(${qdmi_version_major} << 22) | (${qdmi_version_minor} << 12) | ${qdmi_version_patch}" + ) + set(${output} + ${result} + PARENT_SCOPE) +endfunction() diff --git a/cmake/PrefixHandling.cmake b/cmake/PrefixHandling.cmake index 2b1f9239..3619d92e 100644 --- a/cmake/PrefixHandling.cmake +++ b/cmake/PrefixHandling.cmake @@ -30,10 +30,8 @@ function(generate_prefixed_qdmi_headers prefix) set(QDMI_INCLUDE_DIR "${qdmi_INCLUDE_DIR}") endif() - # Get the list of all QDMI device headers. - file(GLOB_RECURSE QDMI_DEVICE_HEADERS ${QDMI_INCLUDE_DIR}/qdmi/constants.h - ${QDMI_INCLUDE_DIR}/qdmi/device.h ${QDMI_INCLUDE_DIR}/qdmi/export.h - ${QDMI_INCLUDE_DIR}/qdmi/types.h) + # Get the list of all QDMI headers. + file(GLOB_RECURSE QDMI_HEADERS ${QDMI_INCLUDE_DIR}/qdmi/**.h) # Determine the correct CMake directory for prefix_defs.txt set(QDMI_PREFIX_DIR "${QDMI_CMAKE_DIR}") @@ -44,7 +42,7 @@ function(generate_prefixed_qdmi_headers prefix) # Read the prefix definitions. file(READ ${QDMI_PREFIX_DIR}/prefix_defs.txt replacements) string(REPLACE "\n" ";" replacements "${replacements}") - foreach(header ${QDMI_DEVICE_HEADERS}) + foreach(header ${QDMI_HEADERS}) # Get the relative path of the header. file(RELATIVE_PATH rel_header ${QDMI_INCLUDE_DIR}/qdmi ${header}) get_filename_component(rel_dir ${rel_header} DIRECTORY) @@ -56,9 +54,11 @@ function(generate_prefixed_qdmi_headers prefix) # Replace the include for the device header with the prefixed version. string( REGEX - REPLACE "#include (\"|<)qdmi/(constants|device|export|types).h(\"|>)" - "#include \\1${QDMI_prefix}_qdmi/\\2.h\\3" header_content - "${header_content}") + REPLACE + "#include (\"|<)qdmi/(core|export|job|orchestration_layer|provider|qpu|superconducting)(/[A-Za-z_]+)?\.h(\"|>)" + "#include \\1${QDMI_prefix}_qdmi/\\2\\3.h\\4" + header_content + "${header_content}") # Replace the prefix definitions. foreach(replacement ${replacements}) string( @@ -67,6 +67,29 @@ function(generate_prefixed_qdmi_headers prefix) "\\1${prefix}_${replacement}\\2" header_content "${header_content}") endforeach() + # revert changes in lines preceded by a // NONAMESHIFTNEXTLINE comment + string(REGEX + REPLACE "(// NONAMESHIFTNEXTLINE\n[^\n]*)(${prefix}|${QDMI_prefix})_" + "\\1" header_content "${header_content}") + if(ARGN) # ARGN holds args after the declared params + list(GET ARGN 0 subprefix) # take first extra arg if provided + # make changes in lines preceded by a // EXTRANAMESHIFTNEXTLINE comment + string(REGEX + REPLACE "(// EXTRANAMESHIFTNEXTLINE\n[^\n]*)(${prefix})_" + "\\1${subprefix}_" header_content "${header_content}") + # Get the lowercase version of the prefix. + string(TOLOWER ${subprefix} QDMI_subprefix) + string(REGEX + REPLACE "(// EXTRANAMESHIFTNEXTLINE\n[^\n]*)(${QDMI_prefix})_" + "\\1${QDMI_subprefix}_" header_content "${header_content}") + else() + # treat lines preceded by a // EXTRANAMESHIFTNEXTLINE comment the same as + # // NONAMESHIFTNEXTLINE if no subprefix is provided + string( + REGEX + REPLACE "(// EXTRANAMESHIFTNEXTLINE\n[^\n]*)(${prefix}|${QDMI_prefix})_" + "\\1" header_content "${header_content}") + endif() # Write the prefixed header. file(WRITE ${CMAKE_CURRENT_BINARY_DIR}/include/${QDMI_prefix}_qdmi/${rel_header} @@ -108,13 +131,12 @@ function(generate_device_defs_executable prefix) endif() # Create the test definitions file. - configure_file(${QDMI_PREFIX_DIR}/test_defs.cpp.in - ${CMAKE_CURRENT_BINARY_DIR}/${QDMI_prefix}_test_defs.cpp @ONLY) + configure_file(${QDMI_PREFIX_DIR}/test_defs.c.in + ${CMAKE_CURRENT_BINARY_DIR}/${QDMI_prefix}_test_defs.c @ONLY) # Create the test executable. add_executable(qdmi_test_${QDMI_prefix}_device_defs - ${CMAKE_CURRENT_BINARY_DIR}/${QDMI_prefix}_test_defs.cpp) + ${CMAKE_CURRENT_BINARY_DIR}/${QDMI_prefix}_test_defs.c) target_link_libraries(qdmi_test_${QDMI_prefix}_device_defs PRIVATE ${DEVICE_TARGET} qdmi::qdmi_project_warnings) - target_compile_features(qdmi_test_${QDMI_prefix}_device_defs - PRIVATE cxx_std_20) + target_compile_features(qdmi_test_${QDMI_prefix}_device_defs PRIVATE c_std_11) endfunction() diff --git a/cmake/prefix_defs.txt b/cmake/prefix_defs.txt index cc169eb8..731178d9 100644 --- a/cmake/prefix_defs.txt +++ b/cmake/prefix_defs.txt @@ -1,29 +1,106 @@ -QDMI_device_initialize -QDMI_device_finalize -QDMI_device_session_alloc -QDMI_device_session_init -QDMI_device_session_free -QDMI_device_session_set_parameter -QDMI_device_session_create_device_job -QDMI_device_job_free -QDMI_device_job_set_parameter -QDMI_device_job_query_property -QDMI_device_job_submit -QDMI_device_job_cancel -QDMI_device_job_check -QDMI_device_job_wait -QDMI_device_job_get_results -QDMI_device_session_query_device_property -QDMI_device_session_query_site_property -QDMI_device_session_query_operation_property -QDMI_Device_Session -QDMI_Device_Session_impl_d -QDMI_Device_Job -QDMI_Device_Job_impl_d -QDMI_Site -QDMI_Site_impl_d -QDMI_Operation -QDMI_Operation_impl_d +QDMI_initialize +QDMI_initialize_t +QDMI_Core_Interface +QDMI_Core_Interface_impl_d +QDMI_Library +QDMI_Library_impl_d +QDMI_Context +QDMI_Context_impl_d +QDMI_Module +QDMI_Module_impl_d +QDMI_Session +QDMI_Session_impl_d +QDMI_get_interface +QDMI_context_set_log_callback +QDMI_context_finalize +QDMI_context_query_id +QDMI_context_query_name +QDMI_context_query_version +QDMI_context_query_authentication_options +QDMI_context_query_modules +QDMI_context_query_module_by_id +QDMI_context_query_module_id +QDMI_context_get_module_interface +QDMI_context_allocate_session +QDMI_session_set_token +QDMI_session_set_authentication_file +QDMI_session_set_authentication_url +QDMI_session_set_username +QDMI_session_set_password +QDMI_session_set_log_callback +QDMI_session_initialize +QDMI_session_free +QDMI_Program_Format +QDMI_Program_Format_impl_d +QDMI_Job +QDMI_Job_impl_d +QDMI_QPU_Interface +QDMI_QPU_Interface_impl_d +QDMI_session_query_qpu_status +QDMI_session_query_qubit_count +QDMI_session_query_program_formats +QDMI_session_query_program_format_by_id_and_version +QDMI_session_query_program_format_id +QDMI_session_query_program_format_string_support +QDMI_session_query_program_format_binary_support +QDMI_session_query_program_format_version +QDMI_session_create_job +QDMI_session_retrieve_job_by_id +QDMI_job_set_payload_string +QDMI_job_set_payload_binary +QDMI_job_set_shot_count +QDMI_job_set_log_callback +QDMI_job_query_id +QDMI_job_query_payload_program_format +QDMI_job_query_payload_string +QDMI_job_query_payload_binary +QDMI_job_query_shot_count +QDMI_job_submit +QDMI_job_cancel +QDMI_job_check +QDMI_job_wait +QDMI_job_get_shots +QDMI_job_get_histogram +QDMI_job_get_state_vector_dense +QDMI_job_get_probabilities_dense +QDMI_job_get_state_vector_sparse +QDMI_job_get_probabilities_sparse +QDMI_job_free +QDMI_Provider_Interface +QDMI_Provider_Interface_impl_d +QDMI_Device +QDMI_Device_impl_d +QDMI_session_query_devices +QDMI_session_query_device_by_id +QDMI_session_get_device_interface +QDMI_session_query_device_context +QDMI_OrchestrationLayer_Interface +QDMI_OrchestrationLayer_Interface_impl_d +QDMI_job_set_device +QDMI_SC_Interface +QDMI_SC_Interface_impl_d +QDMI_SCQubit +QDMI_SCQubit_impl_d +QDMI_SCOperation +QDMI_SCOperation_impl_d +QDMI_session_query_sc_duration_scale_factor +QDMI_session_query_sc_qubits +QDMI_session_query_sc_qubit_by_index +QDMI_session_query_sc_qubit_by_name +QDMI_session_query_sc_qubit_index +QDMI_session_query_sc_qubit_name +QDMI_session_query_sc_qubit_coherence_t1 +QDMI_session_query_sc_qubit_coherence_t2 +QDMI_session_query_coupling_map +QDMI_session_query_sc_operations +QDMI_session_query_sc_operation_by_id +QDMI_session_query_sc_operation_id +QDMI_session_query_sc_operation_name +QDMI_session_query_sc_operation_parameter_count +QDMI_session_query_sc_operation_qubit_count +QDMI_session_query_sc_operation_qubits +QDMI_session_query_sc_operation_duration +QDMI_session_query_sc_operation_fidelity QDMI_STATIC_DEFINE QDMI_EXPORT QDMI_NO_EXPORT diff --git a/examples/tool/CMakeLists.txt b/cmake/test_defs.c.in similarity index 59% rename from examples/tool/CMakeLists.txt rename to cmake/test_defs.c.in index 46eca029..713354d5 100644 --- a/examples/tool/CMakeLists.txt +++ b/cmake/test_defs.c.in @@ -15,11 +15,17 @@ # # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception -# add C++ language support -enable_language(CXX) +/// @file +/// This file is for testing whether a device implements all the required functions. +/// +/// It calls all the functions in the device interface to ensure that +/// they are implemented. During linking, when a function is not implemented this +/// will raise an error. +/// +/// @note This file is not meant to be ever executed, only linked. -add_library(qdmi_example_tool example_tool.cpp example_tool.hpp) -target_link_libraries(qdmi_example_tool PRIVATE qdmi::qdmi qdmi::example_fomac) -target_include_directories(qdmi_example_tool PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}) -target_compile_features(qdmi_example_tool PRIVATE cxx_std_20) -add_library(qdmi::example_tool ALIAS qdmi_example_tool) +#include "@QDMI_prefix@_qdmi/core.h" + +int main(void) { + @QDMI_PREFIX@_QDMI_initialize(0, NULL, NULL, NULL, NULL); +} diff --git a/cmake/test_defs.cpp.in b/cmake/test_defs.cpp.in deleted file mode 100644 index 3b6bee3c..00000000 --- a/cmake/test_defs.cpp.in +++ /dev/null @@ -1,35 +0,0 @@ -/** @file - * @brief This file is for testing whether a device implements all the required - * functions. - * @details It calls all the functions in the device interface to ensure that - * they are implemented. During linking, when a function is not implemented this - * will raise an error. - * @note This file is not meant to be ever executed, only linked. - */ - -#include "@QDMI_prefix@_qdmi/device.h" - -int main() { - @QDMI_PREFIX@_QDMI_Device_Session session = nullptr; - @QDMI_PREFIX@_QDMI_Device_Job job = nullptr; - @QDMI_PREFIX@_QDMI_Site site = nullptr; - @QDMI_PREFIX@_QDMI_Operation operation = nullptr; - @QDMI_PREFIX@_QDMI_device_initialize(); - @QDMI_PREFIX@_QDMI_device_finalize(); - @QDMI_PREFIX@_QDMI_device_session_alloc(&session); - @QDMI_PREFIX@_QDMI_device_session_init(session); - @QDMI_PREFIX@_QDMI_device_session_free(session); - @QDMI_PREFIX@_QDMI_device_session_set_parameter(session, QDMI_DEVICE_SESSION_PARAMETER_MAX, 0, nullptr); - @QDMI_PREFIX@_QDMI_device_session_create_device_job(session, &job); - @QDMI_PREFIX@_QDMI_device_job_free(job); - @QDMI_PREFIX@_QDMI_device_job_set_parameter(job, QDMI_DEVICE_JOB_PARAMETER_MAX, 0, nullptr); - @QDMI_PREFIX@_QDMI_device_job_query_property(job, QDMI_DEVICE_JOB_PROPERTY_MAX, 0, nullptr, nullptr); - @QDMI_PREFIX@_QDMI_device_job_submit(job); - @QDMI_PREFIX@_QDMI_device_job_cancel(job); - @QDMI_PREFIX@_QDMI_device_job_check(job, nullptr); - @QDMI_PREFIX@_QDMI_device_job_wait(job, 0); - @QDMI_PREFIX@_QDMI_device_job_get_results(job, QDMI_JOB_RESULT_MAX, 0, nullptr, nullptr); - @QDMI_PREFIX@_QDMI_device_session_query_device_property(session, QDMI_DEVICE_PROPERTY_MAX, 0, nullptr, nullptr); - @QDMI_PREFIX@_QDMI_device_session_query_site_property(session, site, QDMI_SITE_PROPERTY_MAX, 0, nullptr, nullptr); - @QDMI_PREFIX@_QDMI_device_session_query_operation_property(session, operation, 0, nullptr, 0, nullptr, QDMI_OPERATION_PROPERTY_MAX, 0, nullptr, nullptr); -} diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt index c3a0ef93..b26da954 100644 --- a/docs/CMakeLists.txt +++ b/docs/CMakeLists.txt @@ -41,12 +41,8 @@ file( # order in the generated documentation. set(DOXYGEN_INPUT_DIRS ${DOXYGEN_INPUT_DIRS} - ${CMAKE_CURRENT_SOURCE_DIR}/index.md ${CMAKE_CURRENT_SOURCE_DIR}/faq.md ${CMAKE_CURRENT_SOURCE_DIR}/support.md - ${CMAKE_CURRENT_SOURCE_DIR}/rationale.md - ${CMAKE_CURRENT_SOURCE_DIR}/examples.md - ${CMAKE_CURRENT_SOURCE_DIR}/templates.md ${PROJECT_SOURCE_DIR}/CHANGELOG.md ${PROJECT_SOURCE_DIR}/UPGRADING.md ${CMAKE_CURRENT_SOURCE_DIR}/contributing.md @@ -59,14 +55,8 @@ string(REPLACE ";" " " DOXYGEN_INPUT_DIRS "${DOXYGEN_INPUT_DIRS}") # can be included with the `\include`or `\snippet` command, we need to add the # directories where these files are located. set(DOXYGEN_EXAMPLE_DIRS - ${PROJECT_SOURCE_DIR}/examples/device/src - ${PROJECT_SOURCE_DIR}/examples/driver - ${PROJECT_SOURCE_DIR}/examples/fomac - ${PROJECT_SOURCE_DIR}/examples/tool - ${PROJECT_SOURCE_DIR}/.github - ${PROJECT_SOURCE_DIR}/CHANGELOG.md - ${PROJECT_SOURCE_DIR}/UPGRADING.md - ${PROJECT_SOURCE_DIR}/README.md) + ${PROJECT_SOURCE_DIR}/.github ${PROJECT_SOURCE_DIR}/CHANGELOG.md + ${PROJECT_SOURCE_DIR}/UPGRADING.md ${PROJECT_SOURCE_DIR}/README.md) # Again, replace the semicolon with a space such that Doxygen can handle it. string(REPLACE ";" " " DOXYGEN_EXAMPLE_DIRS "${DOXYGEN_EXAMPLE_DIRS}") diff --git a/docs/index.md b/docs/index.md index 5d6e6487..48405165 100644 --- a/docs/index.md +++ b/docs/index.md @@ -25,7 +25,7 @@ design and implementation can be found in the [Rationale](rationale.md) page. #### Hands-On The [Examples](examples.md) page provides a collection of examples to see QDMI in action. When you -want to start your own implementation of QDMI, the [Templates](templates.md) page is a good starting +want to start your own implementation of QDMI, the [Tutorial](tutorial.md) page is a good starting point. #### Nitty-Gritty Details diff --git a/docs/layout.xml b/docs/layout.xml index 08d43c50..9386f0b9 100644 --- a/docs/layout.xml +++ b/docs/layout.xml @@ -24,6 +24,7 @@ + diff --git a/docs/templates.md b/docs/templates.md deleted file mode 100644 index 75704775..00000000 --- a/docs/templates.md +++ /dev/null @@ -1,119 +0,0 @@ -# Template - - - - - -Together with QDMI, we provide a template meant to kick-start the implementation of a new device. -The following sections describe how to set up and use the template. - -\tableofcontents - -## Creating a new Project {#template-create} - -The code for the template is contained in the `template/` directory of the QDMI repository. To start -a new project based on the template, configure QDMI once to define the prefix and output path, then -explicitly build the `qdmi-template` target that writes the files. - -\note An internet connection is needed for this step as the QDMI repository will be fetched from -GitHub. - -```sh -cmake -DQDMI_GENERATE_TEMPLATE=ON \ - -DTEMPLATE_PREFIX="PREFIX" \ - -DTEMPLATE_PATH="path/to/dir" \ - -S . -B build - -# actually write the template files -cmake --build build --target qdmi-template -``` - -If the option `TEMPLATE_PATH` is not given it will be placed in `PREFIX-qdmi-device` relative to the -parent directory where QDMI was cloned in. - -If you want to regenerate into an existing directory, use: - -```sh -cmake --build build --target qdmi-template-force -``` - -After this step you can directly start implementing your device in C++. -Example implementations are provided in the `examples/` directory. See -[Examples](examples.md) for more information. - -## Configuring the Template {#template-configure} - -For stability, we recommend pinning the version of QDMI that you are using for your implementation. -You can use any valid git tag, branch, or commit hash for that. To this end, adjust the `QDMI_REV` -variable in `cmake/ExternalDependecies.cmake` as follows: - -```diff -- set(QDMI_REV "develop" -+ set(QDMI_REV "v1.2.0" -``` - -When you want to change the prefix after the creation of the template, you need to change the prefix -in a couple of places. We want to give you some hints where you have to change it, but depending on -your personal project setup, they might be different or there might be more than the ones listed. -All paths are given relative to the root of the template project directory. - -- `CMakeLists.txt`, -- `src/CMakeLists.txt`: the target `prefix_qdmi` and `prefix_qdmi.cpp` -- Rename `src/prefix_qdmi.cpp` accordingly -- `src/prefix_qdmi.cpp`: adapt the includes and the prefix of each function -- Rename `test/test_prefix_qdmi.cpp` accordingly -- `test/test_prefix_qdmi.cpp`: adapt the includes and the prefix of each function -- `pyproject.toml`: adapt the package name and several paths -- `python/prefix`: adapt the package namespace in the directory structure -- `python/prefix/qdmi/*`: adapt the prefix throughout the package -- `test/python/*`: adapt the prefix throughout the tests -- `docs/*`: the package name and several paths - -## Working with the Template {#template-working} - -The template is structured into five directories. The top-level -`CMakeLists.txt` contains settings for the entire project. Some additional CMake code that imports -required dependencies is outsourced into `cmake/`. - -The most important directory for your implementation is `src/` and the `.cpp` file located in that -directory. Here you find stubs for all functions that have to be implemented by a device. For every -function the `return QDMI_ERROR_NOTIMPLEMENTED;` should be replaced by a proper implementation of -the function. In particular, there should not be any computation path at the end that returns \ref -QDMI_ERROR_NOTIMPLEMENTED. Instead, some other error code from \ref QDMI_STATUS should be returned -in case of an erroneous state. - -The implementation in the `src/` directory is complemented with a testing framework in `test/`. The -`.cpp` source file already contains some examples for tests. They are meant to serve as an -inspiration, and more tests should be implemented to cover everything in your device implementation. - -The `python` directory in combination with the `pyproject.toml` file contains some basic packaging setup -for distributing the device implementation as a Python package. - -The `docs/` directory contains the documentation for the template. This is intended to be used as a -starting point for your own documentation. - -Some more files are present in the root directory of the template, such as `LICENSE`, `README.md`, and -`.gitignore`. - -## Building the Template and Running the Tests {#template-building} - -All following commands are meant to be executed from the root directory of the template. After -configuring your project (see [Configuring the Template](#template-configure)), you can build your -project with the following command: - -```sh -cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -cmake --build build --config Release -``` - -If you only want to build a specific target, you can append, for example, -`--target prefix_device_test` to the command above, which will build the tests. If you only want to -build the device implementation, you can use `--target prefix_qdmi`. - -To run the tests, perform the following command: - -```sh -ctest --test-dir build -``` - -For more details on the development process, also check out the [Contributing Guide](contributing.md). diff --git a/docs/tutorial.md b/docs/tutorial.md index 25b9fa3c..3906964f 100644 --- a/docs/tutorial.md +++ b/docs/tutorial.md @@ -35,6 +35,11 @@ CMake handles fetching all other dependencies, such as the QDMI core interface a ## Phase 1 β€” Project Setup {#tutorial-create} +> [!WARNING] +> +> The template does not exist anymore and, hence, this section is outdated. +> It mus be updated to reflect the current state. + First, we'll generate the project workspace using the QDMI template. This requires setting a prefix that is used within the template. For this guide, we'll use `tutorial` as our project prefix. ```sh diff --git a/examples/CMakeLists.txt b/examples/CMakeLists.txt index f7bbe91f..1cf964ca 100644 --- a/examples/CMakeLists.txt +++ b/examples/CMakeLists.txt @@ -15,7 +15,14 @@ # # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception -add_subdirectory(device) -add_subdirectory(fomac) -add_subdirectory(tool) -add_subdirectory(driver) +set(QDMI_EXAMPLES_INCLUDE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/include") + +add_subdirectory(src) +add_subdirectory(apps) + +# add test code +if(QDMI_BUILD_TESTS) + include(GoogleTest) + # include the tests itself + add_subdirectory(test) +endif() diff --git a/examples/apps/1_bootstrapping/CMakeLists.txt b/examples/apps/1_bootstrapping/CMakeLists.txt new file mode 100644 index 00000000..1b630278 --- /dev/null +++ b/examples/apps/1_bootstrapping/CMakeLists.txt @@ -0,0 +1,48 @@ +# Copyright (c) 2024 - 2026 QDMI Maintainers +# All rights reserved. +# +# Licensed under the Apache License v2.0 with LLVM Exceptions (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://llvm.org/LICENSE.txt +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations under +# the License. +# +# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception + +include(MakeVersion) + +set(TARGET_NAME 1_bootstrapping) + +# create executable target +add_executable(${TARGET_NAME}) + +# link to qdmi core library +target_link_libraries(${TARGET_NAME} PRIVATE qdmi::qdmi + qdmi::qdmi_project_warnings) + +# set C standard to C11 +target_compile_features(${TARGET_NAME} PRIVATE c_std_11) + +# define version macros +get_target_property(qdmi_library_VERSION qdmi::qdmi VERSION) +qdmi_make_version(qdmi_packed_version ${qdmi_library_VERSION}) +target_compile_definitions( + ${TARGET_NAME} PRIVATE QDMI_VERSION=${qdmi_packed_version} + QDMI_DYLIB="$") + +# add sources to target +target_sources(${TARGET_NAME} PRIVATE bootstrapping.c) + +# set the folder of the target for IDEs and output directory +set_target_properties( + ${TARGET_NAME} PROPERTIES FOLDER "examples/apps" RUNTIME_OUTPUT_DIRECTORY + "${CMAKE_BINARY_DIR}/bin") + +# add qdmi::qpu_q1 as a dependency to ensure it is built before the executable +add_dependencies(${TARGET_NAME} qdmi::qpu_q1) diff --git a/examples/apps/1_bootstrapping/bootstrapping.c b/examples/apps/1_bootstrapping/bootstrapping.c new file mode 100644 index 00000000..9115064c --- /dev/null +++ b/examples/apps/1_bootstrapping/bootstrapping.c @@ -0,0 +1,96 @@ +/* + * Copyright (c) 2024 - 2026 QDMI Maintainers + * All rights reserved. + * + * Licensed under the Apache License v2.0 with LLVM Exceptions (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://llvm.org/LICENSE.txt + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations under + * the License. + * + * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception + */ + +#include "qdmi/core.h" + +#include + +#ifdef _WIN32 +#include +#else +#include +#endif // _WIN32 + +#ifdef _WIN32 +#define DL_OPEN(lib) LoadLibraryA((lib)) +#define DL_SYM(lib, sym) \ + reinterpret_cast(GetProcAddress(static_cast((lib)), (sym))) +#define DL_CLOSE(lib) FreeLibrary(static_cast((lib))) +#else +#define DL_OPEN(lib, flags) dlopen((lib), (flags)) +#define DL_SYM(lib, sym) dlsym((lib), (sym)) +#define DL_CLOSE(lib) dlclose((lib)) +#endif + +#define ANSI_RED "\x1b[0;31m" +#define ANSI_GREEN "\x1b[0;32m" +#define ANSI_RESET "\x1b[0m" + +// use `static` to enforce internal linkage +static void Log_callback(const QDMI_Log_Level level, const char *message, + void *user_data) { + printf("[%s] ", (char *)user_data); + switch (level) { + case QDMI_LOG_LEVEL_ERROR: + printf("[" ANSI_RED "error" ANSI_RESET "]"); + break; + case QDMI_LOG_LEVEL_INFO: + printf("[" ANSI_GREEN "info" ANSI_RESET "]"); + break; + default: + break; + } + printf(" %s\n", message); +} + +int main(void) { + //===--------------------------------------------------------------------===// + // Listing 1 + //===--------------------------------------------------------------------===// + // dynamically load the shared library + void *dylib = DL_OPEN(QDMI_DYLIB, RTLD_NOW | RTLD_LOCAL); + QDMI_initialize_t *init_fn = + (QDMI_initialize_t *)dlsym(dylib, "Q_QDMI_initialize"); + + // initialize the library + QDMI_Context ctx = NULL; + const QDMI_Library *lib = NULL; + init_fn(QDMI_VERSION, &Log_callback, "qdmi ", &ctx, &lib); + + // get the core interface function table + const QDMI_Core_Interface *core = NULL; + lib->get_interface(&core); + + // open and authenticate a session + QDMI_Session session = NULL; + core->context_allocate_session(ctx, &Log_callback, "session", &session); + core->session_set_token(session, "abc..."); + core->session_initialize(session); + //===--------------------------------------------------------------------===// + // free resources + core->session_free(session); + lib->context_finalize(ctx); + DL_CLOSE(dylib); + + return 0; +} + +#undef DL_CLOSE +#undef DL_SYM +#undef DL_OPEN diff --git a/examples/apps/2_job_lifecycle/CMakeLists.txt b/examples/apps/2_job_lifecycle/CMakeLists.txt new file mode 100644 index 00000000..cc5e4d79 --- /dev/null +++ b/examples/apps/2_job_lifecycle/CMakeLists.txt @@ -0,0 +1,48 @@ +# Copyright (c) 2024 - 2026 QDMI Maintainers +# All rights reserved. +# +# Licensed under the Apache License v2.0 with LLVM Exceptions (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://llvm.org/LICENSE.txt +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations under +# the License. +# +# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception + +include(MakeVersion) + +set(TARGET_NAME 2_job_lifecycle) + +# create executable target +add_executable(${TARGET_NAME}) + +# link to qdmi core library +target_link_libraries(${TARGET_NAME} PRIVATE qdmi::qdmi + qdmi::qdmi_project_warnings) + +# set C standard to C11 +target_compile_features(${TARGET_NAME} PRIVATE c_std_11) + +# define version macros +get_target_property(qdmi_library_VERSION qdmi::qdmi VERSION) +qdmi_make_version(qdmi_packed_version ${qdmi_library_VERSION}) +target_compile_definitions( + ${TARGET_NAME} PRIVATE QDMI_VERSION=${qdmi_packed_version} + QDMI_DYLIB="$") + +# add sources to target +target_sources(${TARGET_NAME} PRIVATE job_lifecycle.c) + +# set the folder of the target for IDEs +set_target_properties( + ${TARGET_NAME} PROPERTIES FOLDER "examples/apps" RUNTIME_OUTPUT_DIRECTORY + "${CMAKE_BINARY_DIR}/bin") + +# add qdmi::qpu_q1 as a dependency to ensure it is built before the executable +add_dependencies(${TARGET_NAME} qdmi::qpu_q1) diff --git a/examples/apps/2_job_lifecycle/job_lifecycle.c b/examples/apps/2_job_lifecycle/job_lifecycle.c new file mode 100644 index 00000000..c2bc4d11 --- /dev/null +++ b/examples/apps/2_job_lifecycle/job_lifecycle.c @@ -0,0 +1,136 @@ +/* + * Copyright (c) 2024 - 2026 QDMI Maintainers + * All rights reserved. + * + * Licensed under the Apache License v2.0 with LLVM Exceptions (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://llvm.org/LICENSE.txt + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations under + * the License. + * + * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception + */ + +#include "qdmi/core.h" +#include "qdmi/qpu.h" + +#include +#include + +#ifdef _WIN32 +#include +#else +#include +#endif // _WIN32 + +#ifdef _WIN32 +#define DL_OPEN(lib) LoadLibraryA((lib)) +#define DL_SYM(lib, sym) \ + reinterpret_cast(GetProcAddress(static_cast((lib)), (sym))) +#define DL_CLOSE(lib) FreeLibrary(static_cast((lib))) +#else +#define DL_OPEN(lib, flags) dlopen((lib), (flags)) +#define DL_SYM(lib, sym) dlsym((lib), (sym)) +#define DL_CLOSE(lib) dlclose((lib)) +#endif + +#define VERSION QDMI_MAKE_VERSION + +#define ANSI_RED "\x1b[0;31m" +#define ANSI_GREEN "\x1b[0;32m" +#define ANSI_RESET "\x1b[0m" + +// use `static` to enforce internal linkage +static void Log_callback(const QDMI_Log_Level level, const char *message, + void *user_data) { + printf("[%s] ", (char *)user_data); + switch (level) { + case QDMI_LOG_LEVEL_ERROR: + printf("[" ANSI_RED "error" ANSI_RESET "]"); + break; + case QDMI_LOG_LEVEL_INFO: + printf("[" ANSI_GREEN "info" ANSI_RESET "]"); + break; + default: + break; + } + printf(" %s\n", message); +} + +int main(void) { + //===--------------------------------------------------------------------===// + // Listing 1 (identical to bootstrapping.cpp) + //===--------------------------------------------------------------------===// + // dynamically load the shared library + void *dylib = DL_OPEN(QDMI_DYLIB, RTLD_NOW | RTLD_LOCAL); + QDMI_initialize_t *init_fn = + (QDMI_initialize_t *)dlsym(dylib, "Q_QDMI_initialize"); + + // initialize the library + QDMI_Context ctx = NULL; + const QDMI_Library *lib = NULL; + init_fn(QDMI_VERSION, Log_callback, "qdmi ", &ctx, &lib); + + // get the core interface function table + const QDMI_Core_Interface *core = NULL; + lib->get_interface(&core); + + // open and authenticate a session + QDMI_Session session = NULL; + core->context_allocate_session(ctx, Log_callback, "session", &session); + core->session_set_token(session, "abc..."); + core->session_initialize(session); + //===--------------------------------------------------------------------===// + //===--------------------------------------------------------------------===// + // Listing 2 + //===--------------------------------------------------------------------===// + // query 'qpu' module and get its function table + QDMI_Module m = NULL; + core->context_query_module_by_id(ctx, "qpu", &m); + const QDMI_QPU_Interface *qpu = NULL; + core->context_get_module_interface(ctx, m, (const void **)&qpu); + + // negotiate program format + QDMI_Program_Format fmt = NULL; + if (qpu->session_query_program_format_by_id_and_version( + session, "qasm", VERSION(3, 0, 0), &fmt) != QDMI_SUCCESS) { + return -1; // abort with error + } + + // create, configure, and submit a job + QDMI_Job job = NULL; + qpu->session_create_job(session, Log_callback, "job ", &job); + const char *ps[] = { + "include \"stdgates.inc\";\nqubit[2] q;\nh q[0];\ncx q[0],q[1];"}; + qpu->job_set_payload_string(job, fmt, 1, ps); + qpu->job_set_shot_count(job, 100); + qpu->job_submit(job); + + // wait and retrieve results + qpu->job_wait(job, /*timeout_s=*/10); + size_t nq = 0; // num. qubits + qpu->session_query_qubit_count(session, &nq); + char *result = malloc((nq + 1) * /*n_shots=*/100); + qpu->job_get_shots(job, /*prog_idx=*/0, (nq + 1) * 100, result, NULL); + printf("%s\n", result); // '11000,00000,11000,...' + //===--------------------------------------------------------------------===// + // free resources + free(result); + qpu->job_free(job); + core->session_free(session); + lib->context_finalize(ctx); + DL_CLOSE(dylib); + + return 0; +} + +#undef VERSION +#undef DL_CLOSE +#undef DL_SYM +#undef DL_OPEN diff --git a/examples/apps/3_stack-as-a-device/CMakeLists.txt b/examples/apps/3_stack-as-a-device/CMakeLists.txt new file mode 100644 index 00000000..1abb8ba2 --- /dev/null +++ b/examples/apps/3_stack-as-a-device/CMakeLists.txt @@ -0,0 +1,49 @@ +# Copyright (c) 2024 - 2026 QDMI Maintainers +# All rights reserved. +# +# Licensed under the Apache License v2.0 with LLVM Exceptions (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://llvm.org/LICENSE.txt +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations under +# the License. +# +# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception + +include(MakeVersion) + +set(TARGET_NAME 3_stack-as-a-device) + +# create executable target +add_executable(${TARGET_NAME}) + +# link to qdmi core library +target_link_libraries(${TARGET_NAME} PRIVATE qdmi::qdmi + qdmi::qdmi_project_warnings) + +# set C standard to C11 +target_compile_features(${TARGET_NAME} PRIVATE c_std_11) + +# define version macros +get_target_property(qdmi_library_VERSION qdmi::qdmi VERSION) +qdmi_make_version(qdmi_packed_version ${qdmi_library_VERSION}) +target_compile_definitions( + ${TARGET_NAME} PRIVATE QDMI_VERSION=${qdmi_packed_version} + QDMI_DYLIB="$") + +# add sources to target +target_sources(${TARGET_NAME} PRIVATE stack-as-a-device.c) + +# set the folder of the target for IDEs +set_target_properties( + ${TARGET_NAME} PROPERTIES FOLDER "examples/apps" RUNTIME_OUTPUT_DIRECTORY + "${CMAKE_BINARY_DIR}/bin") + +# add qdmi::orchestration_layer_o1 as a dependency to ensure it is built before +# the executable +add_dependencies(${TARGET_NAME} qdmi::orchestration_layer_o1) diff --git a/examples/apps/3_stack-as-a-device/stack-as-a-device.c b/examples/apps/3_stack-as-a-device/stack-as-a-device.c new file mode 100644 index 00000000..fd62c679 --- /dev/null +++ b/examples/apps/3_stack-as-a-device/stack-as-a-device.c @@ -0,0 +1,128 @@ +/* + * Copyright (c) 2024 - 2026 QDMI Maintainers + * All rights reserved. + * + * Licensed under the Apache License v2.0 with LLVM Exceptions (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://llvm.org/LICENSE.txt + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations under + * the License. + * + * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception + */ + +#include "qdmi/core.h" +#include "qdmi/orchestration_layer.h" + +#include +#include + +#ifdef _WIN32 +#include +#else +#include +#endif // _WIN32 + +#ifdef _WIN32 +#define DL_OPEN(lib) LoadLibraryA((lib)) +#define DL_SYM(lib, sym) \ + reinterpret_cast(GetProcAddress(static_cast((lib)), (sym))) +#define DL_CLOSE(lib) FreeLibrary(static_cast((lib))) +#else +#define DL_OPEN(lib, flags) dlopen((lib), (flags)) +#define DL_SYM(lib, sym) dlsym((lib), (sym)) +#define DL_CLOSE(lib) dlclose((lib)) +#endif + +#define VERSION QDMI_MAKE_VERSION + +#define ANSI_RED "\x1b[0;31m" +#define ANSI_GREEN "\x1b[0;32m" +#define ANSI_RESET "\x1b[0m" + +// use `static` to enforce internal linkage +static void Log_callback(const QDMI_Log_Level level, const char *message, + void *user_data) { + printf("[%s] ", (char *)user_data); + switch (level) { + case QDMI_LOG_LEVEL_ERROR: + printf("[" ANSI_RED "error" ANSI_RESET "]"); + break; + case QDMI_LOG_LEVEL_INFO: + printf("[" ANSI_GREEN "info" ANSI_RESET "]"); + break; + default: + break; + } + printf(" %s\n", message); +} + +int main(void) { + //===--------------------------------------------------------------------===// + // Listing 1 (identical to bootstrapping.cpp) + //===--------------------------------------------------------------------===// + // dynamically load the shared library + void *dylib = DL_OPEN(QDMI_DYLIB, RTLD_NOW | RTLD_LOCAL); + QDMI_initialize_t *init_fn = + (QDMI_initialize_t *)dlsym(dylib, "O_QDMI_initialize"); + + // initialize the library + QDMI_Context ctx = NULL; + const QDMI_Library *lib = NULL; + init_fn(QDMI_VERSION, Log_callback, "qdmi ", &ctx, &lib); + + // get the core interface function table + const QDMI_Core_Interface *core = NULL; + lib->get_interface(&core); + + // open and authenticate a session + QDMI_Session session = NULL; + core->context_allocate_session(ctx, Log_callback, "session", &session); + core->session_set_token(session, "abc..."); + core->session_initialize(session); + //===--------------------------------------------------------------------===// + // NOLINTEND(misc-include-cleaner,cppcoreguidelines-pro-type-reinterpret-cast) + // NOLINTBEGIN(cppcoreguidelines-pro-type-reinterpret-cast,cppcoreguidelines-avoid-c-arrays,cppcoreguidelines-no-malloc) + //===--------------------------------------------------------------------===// + // Listing 3 + //===--------------------------------------------------------------------===// + // query orchestration layer module 'ol' + // and get its function table + QDMI_Module m = NULL; + core->context_query_module_by_id(ctx, "ol", &m); + const QDMI_OrchestrationLayer_Interface *ol = NULL; + core->context_get_module_interface(ctx, m, (const void **)&ol); + + // query QPU 'q', get its context and function table + QDMI_Device q = NULL; + QDMI_Context q_ctx = NULL; + const QDMI_Core_Interface *q_core = NULL; + ol->session_query_device_by_id(session, "q1", &q); + ol->session_query_device_context(session, q, &q_ctx); + ol->session_get_device_interface(session, q, &q_core); + + // open and authenticate a session + QDMI_Session q_session = NULL; + q_core->context_allocate_session(q_ctx, Log_callback, "qpu ", &q_session); + // q_core->session_set_token(q_session, "abc..."); // not required here + q_core->session_initialize(q_session); + //===--------------------------------------------------------------------===// + // free resources + q_core->session_free(q_session); + core->session_free(session); + lib->context_finalize(ctx); + DL_CLOSE(dylib); + + return 0; +} + +#undef VERSION +#undef DL_CLOSE +#undef DL_SYM +#undef DL_OPEN diff --git a/examples/apps/BONUS_end-to-end/CMakeLists.txt b/examples/apps/BONUS_end-to-end/CMakeLists.txt new file mode 100644 index 00000000..c1db6f25 --- /dev/null +++ b/examples/apps/BONUS_end-to-end/CMakeLists.txt @@ -0,0 +1,49 @@ +# Copyright (c) 2024 - 2026 QDMI Maintainers +# All rights reserved. +# +# Licensed under the Apache License v2.0 with LLVM Exceptions (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://llvm.org/LICENSE.txt +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations under +# the License. +# +# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception + +include(MakeVersion) + +set(TARGET_NAME BONUS_end-to-end) + +# create executable target +add_executable(${TARGET_NAME}) + +# link to qdmi core library +target_link_libraries(${TARGET_NAME} PRIVATE qdmi::qdmi + qdmi::qdmi_project_warnings) + +# set C standard to C11 +target_compile_features(${TARGET_NAME} PRIVATE c_std_11) + +# define version macros +get_target_property(qdmi_library_VERSION qdmi::qdmi VERSION) +qdmi_make_version(qdmi_packed_version ${qdmi_library_VERSION}) +target_compile_definitions( + ${TARGET_NAME} PRIVATE QDMI_VERSION=${qdmi_packed_version} + QDMI_DYLIB="$") + +# add sources to target +target_sources(${TARGET_NAME} PRIVATE end-to-end.c) + +# set the folder of the target for IDEs +set_target_properties( + ${TARGET_NAME} PROPERTIES FOLDER "examples/apps" RUNTIME_OUTPUT_DIRECTORY + "${CMAKE_BINARY_DIR}/bin") + +# add qdmi::orchestration_layer_o1 as a dependency to ensure it is built before +# the executable +add_dependencies(${TARGET_NAME} qdmi::orchestration_layer_o1) diff --git a/examples/apps/BONUS_end-to-end/end-to-end.c b/examples/apps/BONUS_end-to-end/end-to-end.c new file mode 100644 index 00000000..9d4c4f97 --- /dev/null +++ b/examples/apps/BONUS_end-to-end/end-to-end.c @@ -0,0 +1,212 @@ +/* + * Copyright (c) 2024 - 2026 QDMI Maintainers + * All rights reserved. + * + * Licensed under the Apache License v2.0 with LLVM Exceptions (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://llvm.org/LICENSE.txt + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations under + * the License. + * + * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception + */ + +#include "qdmi/core.h" +#include "qdmi/orchestration_layer.h" + +#include +#include + +#ifdef _WIN32 +#include +#else +#include +#endif // _WIN32 + +#ifdef _WIN32 +#define DL_OPEN(lib) LoadLibraryA((lib)) +#define DL_SYM(lib, sym) \ + reinterpret_cast(GetProcAddress(static_cast((lib)), (sym))) +#define DL_CLOSE(lib) FreeLibrary(static_cast((lib))) +#else +#define DL_OPEN(lib, flags) dlopen((lib), (flags)) +#define DL_SYM(lib, sym) dlsym((lib), (sym)) +#define DL_CLOSE(lib) dlclose((lib)) +#endif + +#define VERSION QDMI_MAKE_VERSION + +#define ANSI_RED "\x1b[0;31m" +#define ANSI_GREEN "\x1b[0;32m" +#define ANSI_RESET "\x1b[0m" + +// use `static` to enforce internal linkage +static void Log_callback(const QDMI_Log_Level level, const char *message, + void *user_data) { + printf("[%s] ", (char *)user_data); + switch (level) { + case QDMI_LOG_LEVEL_ERROR: + printf("[" ANSI_RED "error" ANSI_RESET "]"); + break; + case QDMI_LOG_LEVEL_INFO: + printf("[" ANSI_GREEN "info" ANSI_RESET "]"); + break; + default: + break; + } + printf(" %s\n", message); +} + +int main(void) { + //===--------------------------------------------------------------------===// + // Listing 1 (identical to bootstrapping.cpp) + //===--------------------------------------------------------------------===// + // dynamically load the shared library + void *dylib = DL_OPEN(QDMI_DYLIB, RTLD_NOW | RTLD_LOCAL); + QDMI_initialize_t *init_fn = + (QDMI_initialize_t *)dlsym(dylib, "O_QDMI_initialize"); + + // initialize the library + QDMI_Context ctx = NULL; + const QDMI_Library *lib = NULL; + init_fn(QDMI_VERSION, Log_callback, "qdmi ", &ctx, &lib); + + // get the core interface function table + const QDMI_Core_Interface *core = NULL; + lib->get_interface(&core); + + // open and authenticate a session + QDMI_Session session = NULL; + core->context_allocate_session(ctx, Log_callback, "session", &session); + core->session_set_token(session, "abc..."); + core->session_initialize(session); + //===--------------------------------------------------------------------===// + int command = 0; + while (printf("Which QPU should the job run on [?,1,2,3,4,q]? ") && + ((command = getchar()) != EOF)) { + // discard the rest of the line (including the '\n' from pressing Enter) + int ch = 0; + while ((ch = getchar()) != '\n' && ch != EOF) { + } + const char *id = NULL; + if (command == '1') { + id = "q1"; + } else if (command == '2') { + id = "q2"; + } else if (command == '3') { + id = "q3"; + } else if (command == '4') { + id = "V1"; + } else if (command == 'q') { + break; + } else if (command == '?') { + printf("You have an active session with an orchestration layer that has\n" + "access to three QPUs:\n" + "1 - a QPU (ID: \"q1\") that is directly connected to the\n" + " orchestration layer loaded via `dlopen` by the\n" + " orchestration itself. This QPU corresponds to the CMake\n" + " target `qpu_q1`.\n" + "2 - a QPU (ID: \"q2\") that is connected to the orchestration\n" + " layer via a provider. The QPU with CMake target `qpu_q2` is\n" + " loaded via `dlopen` by the provider. The provider\n" + " corresponding to CMake target `provider_p1`, in turn, is\n" + " loaded by the orchestration layer via `dlopen`.\n" + "3 - a QPU (ID: \"q3\") that is part of another orchestration\n" + " layer corresponding to CMake target\n" + " `orchestration_layer_o2`. This separate orchestration layer\n" + " loads the QPU corresponding to CMake target `qpu_q3` and\n" + " exposes it to this orchestration layer.\n" + "4 - a QPU (ID: \"V1\") that is to the orchestration layer\n" + " through two nested providers. The directly connected\n" + " provider is the same as for '2'. The second provider is an" + " adapter that corresponds to the CMake target `adapter`. It\n" + " loads a QDMIv1 device and exposes it as a QDMIv2 device.\n" + "After selecting the QPU, the same job is created with the\n" + "target device set accordingly. The job is submitted and\n" + "(random) results are retrieved and printed to the console.\n"); + continue; + } else { + printf("Invalid command. Type '?' for help, '1', '2', '3', or '4' to " + "select the a QPU, or 'q' to quit.\n"); + continue; + } + char qpu_prefix[8]; + snprintf(qpu_prefix, sizeof(qpu_prefix), "qpu%c ", command); + char job_prefix[8]; + snprintf(job_prefix, sizeof(job_prefix), "job%c ", command); + //===------------------------------------------------------------------===// + // Listing 3 + //===------------------------------------------------------------------===// + // query orchestration layer module 'ol' + // and get its function table + QDMI_Module m = NULL; + core->context_query_module_by_id(ctx, "ol", &m); + const QDMI_OrchestrationLayer_Interface *ol = NULL; + core->context_get_module_interface(ctx, m, (const void **)&ol); + + // query QPU, get its context and function table + QDMI_Device q = NULL; + QDMI_Context q_ctx = NULL; + const QDMI_Core_Interface *q_core = NULL; + ol->session_query_device_by_id(session, id, &q); + ol->session_query_device_context(session, q, &q_ctx); + ol->session_get_device_interface(session, q, &q_core); + + // open and authenticate a session + QDMI_Session q_session = NULL; + q_core->context_allocate_session(q_ctx, Log_callback, qpu_prefix, + &q_session); + // q_core->session_set_token(q_session, "abc..."); // not required here + q_core->session_initialize(q_session); + //===----------------------------------------------------------------===// + //===------------------------------------------------------------------===// + // Listing 2 (adapted for the orchestration layer) + //===------------------------------------------------------------------===// + // negotiate program format + QDMI_Program_Format fmt = NULL; + if (ol->session_query_program_format_by_id_and_version( + session, "qasm", VERSION(3, 0, 0), &fmt) != QDMI_SUCCESS) { + return -1; // abort with error + } + + // create, configure, and submit a job + QDMI_Job job = NULL; + ol->session_create_job(session, Log_callback, job_prefix, &job); + const char *ps[] = { + "include \"stdgates.inc\";\nqubit[2] q;\nh q[0];\ncx q[0],q[1];"}; + ol->job_set_payload_string(job, fmt, 1, ps); + ol->job_set_shot_count(job, 100); + ol->job_set_device(job, q); + ol->job_submit(job); + + // wait and retrieve results + ol->job_wait(job, /*timeout_s=*/10); + size_t result_size = 0; + ol->job_get_shots(job, /*prog_idx=*/0, 0, NULL, &result_size); + char *result = malloc(result_size); + ol->job_get_shots(job, /*prog_idx=*/0, result_size, result, NULL); + printf("%s\n", result); // '11000,00000,11000,...' + //===------------------------------------------------------------------===// + // free resources + free(result); + ol->job_free(job); + q_core->session_free(q_session); + } + // free resources + core->session_free(session); + lib->context_finalize(ctx); + DL_CLOSE(dylib); + + return 0; +} + +#undef VERSION +#undef DL_CLOSE +#undef DL_SYM +#undef DL_OPEN diff --git a/examples/device/python/cxx/qdmi/_version.pyi b/examples/apps/CMakeLists.txt similarity index 82% rename from examples/device/python/cxx/qdmi/_version.pyi rename to examples/apps/CMakeLists.txt index 82bb9e25..d721e201 100644 --- a/examples/device/python/cxx/qdmi/_version.pyi +++ b/examples/apps/CMakeLists.txt @@ -15,4 +15,7 @@ # # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception -version: str +add_subdirectory(1_bootstrapping) +add_subdirectory(2_job_lifecycle) +add_subdirectory(3_stack-as-a-device) +add_subdirectory(BONUS_end-to-end) diff --git a/examples/device/.clang-format b/examples/device/.clang-format deleted file mode 100644 index 872f8d52..00000000 --- a/examples/device/.clang-format +++ /dev/null @@ -1,3 +0,0 @@ -BasedOnStyle: LLVM -IncludeBlocks: Regroup -Standard: c++20 diff --git a/examples/device/.clang-tidy b/examples/device/.clang-tidy deleted file mode 100644 index 1f592f8f..00000000 --- a/examples/device/.clang-tidy +++ /dev/null @@ -1,69 +0,0 @@ -FormatStyle: file - -Checks: | - bugprone-*, - -bugprone-easily-swappable-parameters, - clang-analyzer-*, - -clang-analyzer-security.insecureAPI.*, - clang-diagnostic-*, - cppcoreguidelines-*, - -cppcoreguidelines-non-private-member-variables-in-classes, - -cppcoreguidelines-avoid-magic-numbers, - -cppcoreguidelines-macro-usage, - -cppcoreguidelines-pro-bounds-constant-array-index, - -cppcoreguidelines-pro-bounds-array-to-pointer-decay, - -cppcoreguidelines-pro-bounds-pointer-arithmetic, - -cppcoreguidelines-owning-memory, - google-*, - -google-readability-todo, - -google-build-using-namespace, - misc-*, - -misc-no-recursion, - -misc-non-private-member-variables-in-classes, - modernize-*, - -modernize-use-trailing-return-type, - performance-*, - portability-*, - -portability-avoid-pragma-once - readability-*, - -readability-identifier-length, - -readability-magic-numbers, - -readability-function-cognitive-complexity - -CheckOptions: - - key: readability-identifier-naming.ClassCase - value: CamelCase - - key: readability-identifier-naming.ConstantParameterCase - value: lower_case - - key: readability-identifier-naming.EnumCase - value: UPPER_CASE - - key: readability-identifier-naming.EnumConstantCase - value: UPPER_CASE - - key: readability-identifier-naming.FunctionCase - value: Leading_upper_snake_case - - key: readability-identifier-naming.FunctionIgnoredRegexp - value: ".*QDMI.*" - - key: readability-identifier-naming.GlobalConstantCase - value: UPPER_CASE - - key: readability-identifier-naming.IgnoreMainLikeFunctions - value: "true" - - key: readability-identifier-naming.LocalConstantCase - value: lower_case - - key: readability-identifier-naming.MemberCase - value: lower_case - - key: readability-identifier-naming.MemberIgnoredRegexp - value: ".*QDMI.*" - - key: readability-identifier-naming.MethodCase - value: lower_case - - key: readability-identifier-naming.ParameterCase - value: lower_case - - key: readability-identifier-naming.NamespaceCase - value: lower_case - - key: readability-identifier-naming.StaticConstantCase - value: UPPER_CASE - - key: readability-identifier-naming.StructCase - value: Leading_upper_snake_case - - key: readability-identifier-naming.StructIgnoredRegexp - value: ".*QDMI.*" - - key: readability-identifier-naming.VariableCase - value: lower_case diff --git a/examples/device/.cmake-format.yaml b/examples/device/.cmake-format.yaml deleted file mode 100644 index 99cc9dfc..00000000 --- a/examples/device/.cmake-format.yaml +++ /dev/null @@ -1,6 +0,0 @@ -format: - line_width: 80 - keyword_case: "upper" - autosort: true -markup: - first_comment_is_literal: true diff --git a/examples/device/.gitignore b/examples/device/.gitignore deleted file mode 100644 index 31ec068b..00000000 --- a/examples/device/.gitignore +++ /dev/null @@ -1,176 +0,0 @@ -# Byte-compiled / optimized / DLL files -__pycache__/ -*.py[cod] -*$py.class - -# C extensions -*.so -.ccache/ -cmake-build-*/ -*install-dir/ - -# Distribution / packaging -.Python -/build/ -/test/*/build -develop-eggs/ -dist/ -downloads/ -eggs/ -.eggs/ -lib/ -lib64/ -parts/ -sdist/ -var/ -wheels/ -share/python-wheels/ -*.egg-info/ -.installed.cfg -*.egg -MANIFEST - -# PyInstaller -# Usually these files are written by a python script from a template -# before PyInstaller builds the exe, so as to inject date/other infos into it. -*.manifest -*.spec - -# Installer logs -pip-log.txt -pip-delete-this-directory.txt - -# Unit test / coverage reports -htmlcov/ -.tox/ -.nox/ -.coverage -.coverage.* -.cache -nosetests.xml -coverage.xml -*.cover -*.py,cover -.hypothesis/ -.pytest_cache/ -cover/ -*.profraw - -# Translations -*.mo -*.pot - -# Django stuff: -*.log -local_settings.py -db.sqlite3 -db.sqlite3-journal - -# Flask stuff: -instance/ -.webassets-cache - -# Scrapy stuff: -.scrapy - -# Sphinx documentation -docs/_build/ -docs/api/ - -# PyBuilder -.pybuilder/ -target/ - -# Jupyter Notebook -.ipynb_checkpoints - -# IPython -profile_default/ -ipython_config.py - -# PEP 582; used by e.g. github.com/David-OConnor/pyflow -__pypackages__/ - -# Celery stuff -celerybeat-schedule -celerybeat.pid - -# SageMath parsed files -*.sage.py - -# Environments -.env* -.venv* -env*/ -venv*/ -ENV/ -env.bak/ -venv.bak/ - -# Spyder project settings -.spyderproject -.spyproject - -# Rope project settings -.ropeproject - -# mkdocs documentation -/site - -# mypy -.mypy_cache/ -.dmypy.json -dmypy.json - -# Pyre type checker -.pyre/ - -# pytype static type analyzer -.pytype/ - -# Cython debug symbols -cython_debug/ - -# setuptools_scm -src/*/_version.py - -# SKBuild cache dir -_skbuild/ - -# Any build dirs in the tests -test/**/build/ - -# Common editor files -*~ -*.swp - -# RPM spec file -!/distro/*.spec -/distro/*.tar.gz -*.rpm - -# ruff -.ruff_cache/ - -# OS specific stuff -.DS_Store -.DS_Store? -._* -.Spotlight-V100 -.Trashes -ehthumbs.db -Thumbs.db - -.idea/ -.vscode/ -# tmt setup -/distro/main.fmf -/distro/plans/main.fmf -/distro/tests/main.fmf - -/docs/**/build -.vs -out/build - -node_modules/ -wheelhouse/ diff --git a/examples/device/.license-tools-config.json b/examples/device/.license-tools-config.json deleted file mode 100644 index 78502bd8..00000000 --- a/examples/device/.license-tools-config.json +++ /dev/null @@ -1,41 +0,0 @@ -{ - "author": { - "name": "QDMI Maintainers", - "years": [2024, 2026] - }, - "force_author": true, - "custom_license": "Licensed under the Apache License v2.0 with LLVM Exceptions (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\nhttps://llvm.org/LICENSE.txt\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the\nLicense for the specific language governing permissions and limitations under the License.\n\nSPDX-License-Identifier: Apache-2.0 WITH LLVM-exception", - "force_license": true, - "title": false, - "include": ["**/*"], - "style_override_for_suffix": { - ".pyi": "DOCSTRING_STYLE", - ".in": "POUND_STYLE", - ".mlir": "SLASH_STYLE", - ".td": "SLASH_STYLE", - ".yaml": "POUND_STYLE", - ".toml": "POUND_STYLE", - ".proto": "SLASH_STYLE", - ".ts": "C_STYLE", - ".css": "C_STYLE", - ".ps1": "POUND_STYLE" - }, - "exclude": [ - "^\\.[^/]+", - "/\\.[^/]+", - ".*\\.qasm", - ".*\\.ll", - ".*\\.md", - ".*\\.bib", - ".*\\.cff", - ".*\\.json", - ".*\\.html", - ".*\\.tfc", - ".*\\.qc", - ".*\\.real", - ".*\\.tex", - "uv\\.lock", - "py\\.typed", - "LICENSE" - ] -} diff --git a/examples/device/.pre-commit-config.yaml b/examples/device/.pre-commit-config.yaml deleted file mode 100644 index 81b11dda..00000000 --- a/examples/device/.pre-commit-config.yaml +++ /dev/null @@ -1,112 +0,0 @@ -# To run all pre-commit checks, use: -# -# pre-commit run -a -# -# To install pre-commit hooks that run every time you commit: -# -# pre-commit install -# - -ci: - autoupdate_commit_msg: "⬆️πŸͺ update pre-commit hooks" - autoupdate_schedule: quarterly - autofix_commit_msg: "🎨 pre-commit fixes" - -repos: - # Standard hooks - - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v6.0.0 - hooks: - - id: check-added-large-files - - id: check-case-conflict - - id: check-docstring-first - - id: check-merge-conflict - - id: check-symlinks - - id: check-toml - - id: check-yaml - - id: debug-statements - - id: end-of-file-fixer - - id: mixed-line-ending - - id: requirements-txt-fixer - - id: trailing-whitespace - - # Handling unwanted unicode characters - - repo: https://github.com/sirosen/texthooks - rev: 0.7.1 - hooks: - - id: fix-ligatures - - id: fix-smartquotes - - # Check for common mistakes - - repo: https://github.com/pre-commit/pygrep-hooks - rev: v1.10.0 - hooks: - - id: rst-backticks - - id: rst-directive-colons - - id: rst-inline-touching-normal - - # Ensure uv lock file is up-to-date - - repo: https://github.com/astral-sh/uv-pre-commit - rev: 0.11.7 - hooks: - - id: uv-lock - - # Python linting using ruff - - repo: https://github.com/astral-sh/ruff-pre-commit - rev: v0.15.11 - hooks: - - id: ruff-check - - id: ruff-format - - # Check for license headers - - repo: https://github.com/emzeat/mz-lictools - rev: v2.9.0 - hooks: - - id: license-tools - - # Check for spelling - - repo: https://github.com/crate-ci/typos - rev: v1.45.1 - hooks: - - id: typos - - # Clang-format the C++ part of the code base automatically - - repo: https://github.com/pre-commit/mirrors-clang-format - rev: v22.1.3 - hooks: - - id: clang-format - types_or: [c++, c, cuda] - - # CMake format the CMakeLists.txt files - - repo: https://github.com/cheshirekow/cmake-format-precommit - rev: v0.6.13 - hooks: - - id: cmake-format - additional_dependencies: [pyyaml] - types: [file] - files: (\.cmake|CMakeLists.txt)(.in)?$ - - # Format configuration files with prettier - - repo: https://github.com/rbubley/mirrors-prettier - rev: v3.8.3 - hooks: - - id: prettier - types_or: [yaml, markdown, html, css, scss, javascript, json] - exclude: ^docs/header\.html$ - - # Catch common capitalization mistakes - - repo: local - hooks: - - id: disallow-caps - name: Disallow improper capitalization - language: pygrep - entry: PyBind|Numpy|Cmake|CCache|Github|PyTest|Mqt|Tum - exclude: .pre-commit-config.yaml - - # Check JSON schemata - - repo: https://github.com/python-jsonschema/check-jsonschema - rev: 0.37.1 - hooks: - - id: check-dependabot - - id: check-github-workflows - - id: check-readthedocs diff --git a/examples/device/CMakeLists.txt b/examples/device/CMakeLists.txt deleted file mode 100644 index ccb022cd..00000000 --- a/examples/device/CMakeLists.txt +++ /dev/null @@ -1,84 +0,0 @@ -# Copyright (c) 2024 - 2026 QDMI Maintainers -# All rights reserved. -# -# Licensed under the Apache License v2.0 with LLVM Exceptions (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://llvm.org/LICENSE.txt -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -# License for the specific language governing permissions and limitations under -# the License. -# -# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception - -cmake_minimum_required(VERSION 3.24...4.2) - -project( - cxx-qdmi-device - LANGUAGES C CXX - VERSION 0.1.0 - DESCRIPTION "CXX QDMI Device Implementation") - -if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES) - set(CMAKE_BUILD_TYPE - Release - CACHE STRING "Choose the type of build." FORCE) - set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS "Debug" "Release" - "MinSizeRel" "RelWithDebInfo") -endif() - -include(CMakeDependentOption) - -option(USE_INSTALLED_CXX_QDMI_DEVICE - "Use an installed version of the CXX QDMI Device to build tests" OFF) - -if(USE_INSTALLED_CXX_QDMI_DEVICE) - find_package(cxx-qdmi-device REQUIRED ${PROJECT_VERSION}) -endif() - -# Generate compile_commands.json to make it easier to work with clang based -# tools -set(CMAKE_EXPORT_COMPILE_COMMANDS - ON - CACHE BOOL "Export compile commands" FORCE) - -set(CMAKE_VERIFY_INTERFACE_HEADER_SETS - ON - CACHE BOOL "Verify interface header sets" FORCE) - -set(QDMI_PREFIX "CXX") - -cmake_dependent_option( - INSTALL_CXX_QDMI_DEVICE - "Generate installation instructions for the CXX QDMI Device" - ${PROJECT_IS_TOP_LEVEL} "NOT USE_INSTALLED_CXX_QDMI_DEVICE" OFF) -option(BUILD_CXX_QDMI_TESTS "Build tests for the CXX QDMI device" - ${PROJECT_IS_TOP_LEVEL}) -option(BUILD_CXX_QDMI_DOCS "Build documentation for the CXX QDMI device" OFF) - -# Manage external dependencies -include(cmake/ExternalDependencies.cmake) - -# Set target name -set(QDMI_TARGET_NAME "cxx-qdmi-device") - -# Add the main library code -if(NOT USE_INSTALLED_CXX_QDMI_DEVICE) - add_subdirectory(src) -endif() - -# Add the documentation -if(BUILD_CXX_QDMI_DOCS) - add_subdirectory(docs) -endif() - -# Add the tests -if(BUILD_CXX_QDMI_TESTS) - enable_testing() - include(GoogleTest) - add_subdirectory(test) -endif() diff --git a/examples/device/LICENSE b/examples/device/LICENSE deleted file mode 100644 index 0a911a4c..00000000 --- a/examples/device/LICENSE +++ /dev/null @@ -1,217 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - ----- LLVM Exceptions to the Apache 2.0 License ---- - -As an exception, if, as a result of your compiling your source code, portions -of this Software are embedded into an Object form of such source code, you -may redistribute such embedded portions in such Object form without complying -with the conditions of Sections 4(a), 4(b) and 4(d) of the License. - -In addition, if you combine or link compiled forms of this Software with -software that is licensed under the GPLv2 ("Combined Software") and if a -court of competent jurisdiction determines that the patent provision (Section -3), the indemnity provision (Section 9) or other Section of the License -conflicts with the conditions of the GPLv2, you may retroactively and -prospectively choose to deem waived or otherwise exclude such Section(s) of -the License, but only in their entirety and only with respect to the Combined -Software. diff --git a/examples/device/README.md b/examples/device/README.md deleted file mode 100644 index a56bd5d9..00000000 --- a/examples/device/README.md +++ /dev/null @@ -1,25 +0,0 @@ -

- - - - Logo - - -

- -# CXX QDMI Device - -A C++20 library that implements the QDMI Device interface. - -## Documentation - -The full documentation, including a user guide, development guide, and the C++ API reference, is available in the `docs/` directory and can be built using [Doxygen](https://doxygen.nl/). - -You can build the documentation by running: - -```console -$ cmake -S . -B build -DBUILD_CXX_QDMI_DOCS=ON -$ cmake --build build --target cxx_qdmi_device_docs -``` - -The documentation will be generated in the `build/docs/` directory. You can view the HTML documentation by opening the `index.html` file in a web browser. diff --git a/examples/device/cmake/ExternalDependencies.cmake b/examples/device/cmake/ExternalDependencies.cmake deleted file mode 100644 index 0ce08eaf..00000000 --- a/examples/device/cmake/ExternalDependencies.cmake +++ /dev/null @@ -1,95 +0,0 @@ -# Copyright (c) 2024 - 2026 QDMI Maintainers -# All rights reserved. -# -# Licensed under the Apache License v2.0 with LLVM Exceptions (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://llvm.org/LICENSE.txt -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -# License for the specific language governing permissions and limitations under -# the License. -# -# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception - -include(FetchContent) -include(CMakeDependentOption) -set(FETCH_PACKAGES "") - -if(TARGET qdmi::qdmi) - message(STATUS "[qdmi][template] QDMI is already available.") -else() - message(STATUS "[qdmi][template] QDMI will be included via FetchContent") - # cmake-format: off - set(QDMI_VERSION 1.3.2 - CACHE STRING "QDMI version") - set(QDMI_REV "develop" - CACHE STRING "QDMI identifier (tag, branch or commit hash)") - set(QDMI_REPO_OWNER "Munich-Quantum-Software-Stack" - CACHE STRING "QDMI repository owner (change when using a fork)") - set(QDMI_INSTALL - OFF - CACHE BOOL "Generate installation instructions for QDMI") - # cmake-format: on - FetchContent_Declare( - qdmi - GIT_REPOSITORY https://github.com/${QDMI_REPO_OWNER}/qdmi.git - GIT_TAG ${QDMI_REV} - FIND_PACKAGE_ARGS ${QDMI_VERSION}) - list(APPEND FETCH_PACKAGES qdmi) - message( - STATUS "[qdmi][template] QDMI will be included via FetchContent - done") -endif() - -if(BUILD_CXX_QDMI_TESTS) - set(gtest_force_shared_crt - ON - CACHE BOOL "" FORCE) - set(GTEST_VERSION - 1.17.0 - CACHE STRING "Google Test version") - set(GTEST_URL - https://github.com/google/googletest/archive/refs/tags/v${GTEST_VERSION}.tar.gz - ) - FetchContent_Declare(googletest URL ${GTEST_URL} FIND_PACKAGE_ARGS - ${GTEST_VERSION} NAMES GTest) - list(APPEND FETCH_PACKAGES googletest) -endif() - -if(BUILD_CXX_QDMI_DOCS) - set(CMAKE_POLICY_DEFAULT_CMP0116 - NEW - CACHE STRING - "Set the default CMP0116 policy to NEW for documentation builds") - set(MIN_DOXYGEN_VERSION - 1.15.0 - CACHE STRING "Minimum required Doxygen version") - set(DOXYGEN_REV - "669aeeefca743c148e2d935b3d3c69535c7491e6" # v1.16.1 - CACHE STRING "Doxygen identifier (tag, branch or commit hash)") - FetchContent_Declare( - Doxygen - GIT_REPOSITORY https://github.com/doxygen/doxygen.git - GIT_TAG ${DOXYGEN_REV} - FIND_PACKAGE_ARGS ${MIN_DOXYGEN_VERSION}) - list(APPEND FETCH_PACKAGES Doxygen) - - set(DOXYGEN_AWESOME_VERSION - 2.4.1 - CACHE STRING "Doxygen Awesome version") - set(DOXYGEN_AWESOME_REV - "1f3620084ff75734ed192101acf40e9dff01d848" - CACHE STRING "Doxygen Awesome identifier (tag, branch or commit hash)") - FetchContent_Declare( - doxygen-awesome-css - GIT_REPOSITORY https://github.com/jothepro/doxygen-awesome-css.git - GIT_TAG ${DOXYGEN_AWESOME_REV} - FIND_PACKAGE_ARGS ${DOXYGEN_AWESOME_VERSION}) - list(APPEND FETCH_PACKAGES doxygen-awesome-css) -endif() - -# Make all declared dependencies available. -FetchContent_MakeAvailable(${FETCH_PACKAGES}) diff --git a/examples/device/docs/CMakeLists.txt b/examples/device/docs/CMakeLists.txt deleted file mode 100644 index 8bfb6134..00000000 --- a/examples/device/docs/CMakeLists.txt +++ /dev/null @@ -1,98 +0,0 @@ -# Copyright (c) 2024 - 2026 QDMI Maintainers -# All rights reserved. -# -# Licensed under the Apache License v2.0 with LLVM Exceptions (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://llvm.org/LICENSE.txt -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -# License for the specific language governing permissions and limitations under -# the License. -# -# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception - -# Set the Doxygen configuration file. In the Doxyfile.in file, there are some -# placeholders that are replaced by CMake. That is also the reason for the -# extension `.in`. For details see below for the command `configure_file`. -set(DOXYGEN_CONFIG_FILE_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in) - -# Set the input directories for doxygen, i.e., all files that contain source -# code with documentation. -set(DOXYGEN_INPUT_DIRS ${PROJECT_SOURCE_DIR}/include - ${PROJECT_BINARY_DIR}/src/include/cxx_qdmi) - -# This variable is only needed to setup the dependency tracking of CMake -# correctly and is not passed to Doxygen. Whenever such a file is modified, -# CMake detects that change and will rerun the Doxygen command instead of using -# the cached result when the target `docs` is built. - -file(GLOB_RECURSE DOXYGEN_INPUT_FILES ${PROJECT_SOURCE_DIR}/include/*.hpp - ${PROJECT_BINARY_DIR}/src/include/cxx_qdmi/*.h - ${CMAKE_CURRENT_SOURCE_DIR}/*.md) -# After the variable above is correctly initialized, we can add the additional -# files that are not source code but still part of the documentation. IMPORTANT: -# The order the files with the static content are added here influences their -# order in the generated documentation. -set(DOXYGEN_INPUT_DIRS - ${DOXYGEN_INPUT_DIRS} ${CMAKE_CURRENT_SOURCE_DIR}/index.md - ${CMAKE_CURRENT_SOURCE_DIR}/development_guide.md - ${CMAKE_CURRENT_SOURCE_DIR}/dependencies.md) -# By default the files are separated by a semicolon. This is not what Doxygen -# wants, so we replace it with a space. -string(REPLACE ";" " " DOXYGEN_INPUT_DIRS "${DOXYGEN_INPUT_DIRS}") - -# Set the output directory for the generated documentation: Place it in the -# CMake build directory. -set(DOXYGEN_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR}) - -# Set the Doxygen configured configuration file. This will point to the Doxyfile -# that is written out by CMake with all placeholders substituted. -set(DOXYGEN_CONFIG_FILE_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile) - -# Save the location the files of the project doxygen-awesome-css were cloned -# into. This allows us to get the path to doxygen-awesome.css. For its usage -# also see the occurrences of @AWESOME_CSS_DIR@ in the Doxyfile.in. -FetchContent_GetProperties(doxygen-awesome-css SOURCE_DIR AWESOME_CSS_DIR) - -# Ensure the output directory exists -file(MAKE_DIRECTORY ${DOXYGEN_OUTPUT_DIR}/html) - -# Copy over the dark mode logos as they are not automatically copied by Doxygen. -# `configure_file` is used here because `file(COPY ...)` does not detect changes -# and copies the files again after they have changed. -configure_file(_static/cxx_logo_dark.svg ${DOXYGEN_OUTPUT_DIR}/html COPYONLY) -# Set the logo for the project. -set(PROJECT_LOGO "cxx_logo.svg") - -# Replace variables inside @@ with the current values, e.g., the placeholder -# @DOXYGEN_INPUT_DIRS@ is replaced by the content of the variable -# DOXYGEN_INPUT_DIRS. -configure_file(${DOXYGEN_CONFIG_FILE_IN} ${DOXYGEN_CONFIG_FILE_OUT} @ONLY) - -if(${DOXYGEN_EXECUTABLE} STREQUAL "DOXYGEN_EXECUTABLE-NOTFOUND") - set(DOXYGEN_EXECUTABLE ${doxygen_BINARY_DIR}/bin/doxygen) - message(STATUS "Setting doxygen binary manually to ${DOXYGEN_EXECUTABLE}") -endif() - -# Create a custom command to run Doxygen -add_custom_command( - OUTPUT ${DOXYGEN_OUTPUT_DIR}/html/index.html - DEPENDS ${DOXYGEN_INPUT_FILES} - ${DOXYGEN_CONFIG_FILE_IN} - ${CMAKE_CURRENT_SOURCE_DIR}/header.html - ${CMAKE_CURRENT_SOURCE_DIR}/layout.xml - ${CMAKE_CURRENT_SOURCE_DIR}/style.css - ${CMAKE_SOURCE_DIR}/README.md - $,doxygen,> - COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_CONFIG_FILE_OUT} - WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} - COMMENT "Generating API documentation with Doxygen" - VERBATIM) - -# Create a custom target -add_custom_target(cxx_qdmi_device_docs ALL - DEPENDS ${DOXYGEN_OUTPUT_DIR}/html/index.html) diff --git a/examples/device/docs/Doxyfile.in b/examples/device/docs/Doxyfile.in deleted file mode 100644 index 381ff95e..00000000 --- a/examples/device/docs/Doxyfile.in +++ /dev/null @@ -1,2912 +0,0 @@ -# Copyright (c) 2024 - 2026 QDMI Maintainers -# All rights reserved. -# -# Licensed under the Apache License v2.0 with LLVM Exceptions (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://llvm.org/LICENSE.txt -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -# License for the specific language governing permissions and limitations under -# the License. -# -# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception - -# Doxyfile 1.12.0 - -# This file describes the settings to be used by the documentation system -# Doxygen (www.doxygen.org) for a project. -# -# All text after a double hash (##) is considered a comment and is placed in -# front of the TAG it is preceding. -# -# All text after a single hash (#) is considered a comment and will be ignored. -# The format is: -# TAG = value [value, ...] -# For lists, items can also be appended using: -# TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (\" \"). -# -# Note: -# -# Use Doxygen to compare the used configuration file with the template -# configuration file: -# doxygen -x [configFile] -# Use Doxygen to compare the used configuration file with the template -# configuration file without replacing the environment variables or CMake type -# replacement variables: -# doxygen -x_noenv [configFile] - -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- - -# This tag specifies the encoding used for all characters in the configuration -# file that follow. The default is UTF-8 which is also the encoding used for all -# text before the first occurrence of this tag. Doxygen uses libiconv (or the -# iconv built into libc) for the transcoding. See -# https://www.gnu.org/software/libiconv/ for the list of possible encodings. -# The default value is: UTF-8. - -DOXYFILE_ENCODING = UTF-8 - -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by -# double-quotes, unless you are using Doxywizard) that should identify the -# project for which the documentation is generated. This name is used in the -# title of most generated pages and in a few other places. -# The default value is: My Project. - -PROJECT_NAME = "CXX QDMI" - -# The PROJECT_NUMBER tag can be used to enter a project or revision number. This -# could be handy for archiving the generated documentation or if some version -# control system is used. - -PROJECT_NUMBER = v@CMAKE_PROJECT_VERSION@ - -# Using the PROJECT_BRIEF tag one can provide an optional one line description -# for a project that appears at the top of each page and should give viewer a -# quick idea about the purpose of the project. Keep the description short. - -PROJECT_BRIEF = @CMAKE_PROJECT_DESCRIPTION@ - -# With the PROJECT_LOGO tag one can specify a logo or an icon that is included -# in the documentation. The maximum height of the logo should not exceed 55 -# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy -# the logo to the output directory. - -PROJECT_LOGO = _static/@PROJECT_LOGO@ - -# With the PROJECT_ICON tag one can specify an icon that is included in the tabs -# when the HTML document is shown. Doxygen will copy the logo to the output -# directory. - -PROJECT_ICON = - -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path -# into which the generated documentation will be written. If a relative path is -# entered, it will be relative to the location where Doxygen was started. If -# left blank the current directory will be used. - -OUTPUT_DIRECTORY = @DOXYGEN_OUTPUT_DIR@ - -# If the CREATE_SUBDIRS tag is set to YES then Doxygen will create up to 4096 -# sub-directories (in 2 levels) under the output directory of each output format -# and will distribute the generated files over these directories. Enabling this -# option can be useful when feeding Doxygen a huge amount of source files, where -# putting all generated files in the same directory would otherwise causes -# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to -# control the number of sub-directories. -# The default value is: NO. - -CREATE_SUBDIRS = NO - -# Controls the number of sub-directories that will be created when -# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every -# level increment doubles the number of directories, resulting in 4096 -# directories at level 8 which is the default and also the maximum value. The -# sub-directories are organized in 2 levels, the first level always has a fixed -# number of 16 directories. -# Minimum value: 0, maximum value: 8, default value: 8. -# This tag requires that the tag CREATE_SUBDIRS is set to YES. - -CREATE_SUBDIRS_LEVEL = 8 - -# If the ALLOW_UNICODE_NAMES tag is set to YES, Doxygen will allow non-ASCII -# characters to appear in the names of generated files. If set to NO, non-ASCII -# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode -# U+3044. -# The default value is: NO. - -ALLOW_UNICODE_NAMES = NO - -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by Doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian, -# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English -# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, -# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with -# English messages), Korean, Korean-en (Korean with English messages), Latvian, -# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, -# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, -# Swedish, Turkish, Ukrainian and Vietnamese. -# The default value is: English. - -OUTPUT_LANGUAGE = English - -# If the BRIEF_MEMBER_DESC tag is set to YES, Doxygen will include brief member -# descriptions after the members that are listed in the file and class -# documentation (similar to Javadoc). Set to NO to disable this. -# The default value is: YES. - -BRIEF_MEMBER_DESC = YES - -# If the REPEAT_BRIEF tag is set to YES, Doxygen will prepend the brief -# description of a member or function before the detailed description -# -# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the -# brief descriptions will be completely suppressed. -# The default value is: YES. - -REPEAT_BRIEF = YES - -# This tag implements a quasi-intelligent brief description abbreviator that is -# used to form the text in various listings. Each string in this list, if found -# as the leading text of the brief description, will be stripped from the text -# and the result, after processing the whole list, is used as the annotated -# text. Otherwise, the brief description is used as-is. If left blank, the -# following values are used ($name is automatically replaced with the name of -# the entity):The $name class, The $name widget, The $name file, is, provides, -# specifies, contains, represents, a, an and the. - -ABBREVIATE_BRIEF = "The $name class" \ - "The $name widget" \ - "The $name file" \ - is \ - provides \ - specifies \ - contains \ - represents \ - a \ - an \ - the - -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# Doxygen will generate a detailed section even if there is only a brief -# description. -# The default value is: NO. - -ALWAYS_DETAILED_SEC = NO - -# If the INLINE_INHERITED_MEMB tag is set to YES, Doxygen will show all -# inherited members of a class in the documentation of that class as if those -# members were ordinary class members. Constructors, destructors and assignment -# operators of the base classes will not be shown. -# The default value is: NO. - -INLINE_INHERITED_MEMB = NO - -# If the FULL_PATH_NAMES tag is set to YES, Doxygen will prepend the full path -# before files name in the file list and in the header files. If set to NO the -# shortest path that makes the file name unique will be used -# The default value is: YES. - -FULL_PATH_NAMES = YES - -# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. -# Stripping is only done if one of the specified strings matches the left-hand -# part of the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which Doxygen is run is used as the path to -# strip. -# -# Note that you can specify absolute paths here, but also relative paths, which -# will be relative from the directory where Doxygen is started. -# This tag requires that the tag FULL_PATH_NAMES is set to YES. - -STRIP_FROM_PATH = @PROJECT_SOURCE_DIR@/include @PROJECT_SOURCE_DIR@/src @PROJECT_SOURCE_DIR@ @PROJECT_BINARY_DIR@/src/include/cxx_qdmi - -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the -# path mentioned in the documentation of a class, which tells the reader which -# header file to include in order to use a class. If left blank only the name of -# the header file containing the class definition is used. Otherwise one should -# specify the list of include paths that are normally passed to the compiler -# using the -I flag. - -STRIP_FROM_INC_PATH = - -# If the SHORT_NAMES tag is set to YES, Doxygen will generate much shorter (but -# less readable) file names. This can be useful is your file systems doesn't -# support long names like on DOS, Mac, or CD-ROM. -# The default value is: NO. - -SHORT_NAMES = NO - -# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen will interpret the -# first line (until the first dot) of a Javadoc-style comment as the brief -# description. If set to NO, the Javadoc-style will behave just like regular Qt- -# style comments (thus requiring an explicit @brief command for a brief -# description.) -# The default value is: NO. - -JAVADOC_AUTOBRIEF = NO - -# If the JAVADOC_BANNER tag is set to YES then Doxygen will interpret a line -# such as -# /*************** -# as being the beginning of a Javadoc-style comment "banner". If set to NO, the -# Javadoc-style will behave just like regular comments and it will not be -# interpreted by Doxygen. -# The default value is: NO. - -JAVADOC_BANNER = NO - -# If the QT_AUTOBRIEF tag is set to YES then Doxygen will interpret the first -# line (until the first dot) of a Qt-style comment as the brief description. If -# set to NO, the Qt-style will behave just like regular Qt-style comments (thus -# requiring an explicit \brief command for a brief description.) -# The default value is: NO. - -QT_AUTOBRIEF = NO - -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen treat a -# multi-line C++ special comment block (i.e. a block of //! or /// comments) as -# a brief description. This used to be the default behavior. The new default is -# to treat a multi-line C++ comment block as a detailed description. Set this -# tag to YES if you prefer the old behavior instead. -# -# Note that setting this tag to YES also means that rational rose comments are -# not recognized any more. -# The default value is: NO. - -MULTILINE_CPP_IS_BRIEF = NO - -# By default Python docstrings are displayed as preformatted text and Doxygen's -# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the -# Doxygen's special commands can be used and the contents of the docstring -# documentation blocks is shown as Doxygen documentation. -# The default value is: YES. - -PYTHON_DOCSTRING = YES - -# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the -# documentation from any documented member that it re-implements. -# The default value is: YES. - -INHERIT_DOCS = YES - -# If the SEPARATE_MEMBER_PAGES tag is set to YES then Doxygen will produce a new -# page for each member. If set to NO, the documentation of a member will be part -# of the file/class/namespace that contains it. -# The default value is: NO. - -SEPARATE_MEMBER_PAGES = NO - -# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen -# uses this value to replace tabs by spaces in code fragments. -# Minimum value: 1, maximum value: 16, default value: 4. - -TAB_SIZE = 4 - -# This tag can be used to specify a number of aliases that act as commands in -# the documentation. An alias has the form: -# name=value -# For example adding -# "sideeffect=@par Side Effects:^^" -# will allow you to put the command \sideeffect (or @sideeffect) in the -# documentation, which will result in a user-defined paragraph with heading -# "Side Effects:". Note that you cannot put \n's in the value part of an alias -# to insert newlines (in the resulting output). You can put ^^ in the value part -# of an alias to insert a newline as if a physical newline was in the original -# file. When you need a literal { or } or , in the value part of an alias you -# have to escape them by means of a backslash (\), this can lead to conflicts -# with the commands \{ and \} for these it is advised to use the version @{ and -# @} or use a double escape (\\{ and \\}) - -ALIASES = - -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources -# only. Doxygen will then generate output that is more tailored for C. For -# instance, some of the names that are used will be different. The list of all -# members will be omitted, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_FOR_C = YES - -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or -# Python sources only. Doxygen will then generate output that is more tailored -# for that language. For instance, namespaces will be presented as packages, -# qualified scopes will look different, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_JAVA = NO - -# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran -# sources. Doxygen will then generate output that is tailored for Fortran. -# The default value is: NO. - -OPTIMIZE_FOR_FORTRAN = NO - -# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL -# sources. Doxygen will then generate output that is tailored for VHDL. -# The default value is: NO. - -OPTIMIZE_OUTPUT_VHDL = NO - -# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice -# sources only. Doxygen will then generate output that is more tailored for that -# language. For instance, namespaces will be presented as modules, types will be -# separated into more groups, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_SLICE = NO - -# Doxygen selects the parser to use depending on the extension of the files it -# parses. With this tag you can assign which parser to use for a given -# extension. Doxygen has a built-in mapping, but you can override or extend it -# using this tag. The format is ext=language, where ext is a file extension, and -# language is one of the parsers supported by Doxygen: IDL, Java, JavaScript, -# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, -# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: -# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser -# tries to guess whether the code is fixed or free formatted code, this is the -# default for Fortran type files). For instance to make Doxygen treat .inc files -# as Fortran files (default is PHP), and .f files as C (default is Fortran), -# use: inc=Fortran f=C. -# -# Note: For files without extension you can use no_extension as a placeholder. -# -# Note that for custom extensions you also need to set FILE_PATTERNS otherwise -# the files are not read by Doxygen. When specifying no_extension you should add -# * to the FILE_PATTERNS. -# -# Note see also the list of default file extension mappings. - -EXTENSION_MAPPING = - -# If the MARKDOWN_SUPPORT tag is enabled then Doxygen pre-processes all comments -# according to the Markdown format, which allows for more readable -# documentation. See https://daringfireball.net/projects/markdown/ for details. -# The output of markdown processing is further processed by Doxygen, so you can -# mix Doxygen, HTML, and XML commands with Markdown formatting. Disable only in -# case of backward compatibilities issues. -# The default value is: YES. - -MARKDOWN_SUPPORT = YES - -# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up -# to that level are automatically included in the table of contents, even if -# they do not have an id attribute. -# Note: This feature currently applies only to Markdown headings. -# Minimum value: 0, maximum value: 99, default value: 6. -# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. - -TOC_INCLUDE_HEADINGS = 0 - -# The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to -# generate identifiers for the Markdown headings. Note: Every identifier is -# unique. -# Possible values are: DOXYGEN use a fixed 'autotoc_md' string followed by a -# sequence number starting at 0 and GITHUB use the lower case version of title -# with any whitespace replaced by '-' and punctuation characters removed. -# The default value is: DOXYGEN. -# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. - -MARKDOWN_ID_STYLE = DOXYGEN - -# When enabled Doxygen tries to link words that correspond to documented -# classes, or namespaces to their corresponding documentation. Such a link can -# be prevented in individual cases by putting a % sign in front of the word or -# globally by setting AUTOLINK_SUPPORT to NO. -# The default value is: YES. - -AUTOLINK_SUPPORT = YES - -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want -# to include (a tag file for) the STL sources as input, then you should set this -# tag to YES in order to let Doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); -# versus func(std::string) {}). This also makes the inheritance and -# collaboration diagrams that involve STL classes more complete and accurate. -# The default value is: NO. - -BUILTIN_STL_SUPPORT = NO - -# If you use Microsoft's C++/CLI language, you should set this option to YES to -# enable parsing support. -# The default value is: NO. - -CPP_CLI_SUPPORT = NO - -# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: -# https://www.riverbankcomputing.com/software) sources only. Doxygen will parse -# them like normal C++ but will assume all classes use public instead of private -# inheritance when no explicit protection keyword is present. -# The default value is: NO. - -SIP_SUPPORT = NO - -# For Microsoft's IDL there are propget and propput attributes to indicate -# getter and setter methods for a property. Setting this option to YES will make -# Doxygen to replace the get and set methods by a property in the documentation. -# This will only work if the methods are indeed getting or setting a simple -# type. If this is not the case, or you want to show the methods anyway, you -# should set this option to NO. -# The default value is: YES. - -IDL_PROPERTY_SUPPORT = YES - -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES then Doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default -# all members of a group must be documented explicitly. -# The default value is: NO. - -DISTRIBUTE_GROUP_DOC = NO - -# If one adds a struct or class to a group and this option is enabled, then also -# any nested class or struct is added to the same group. By default this option -# is disabled and one has to add nested compounds explicitly via \ingroup. -# The default value is: NO. - -GROUP_NESTED_COMPOUNDS = NO - -# Set the SUBGROUPING tag to YES to allow class member groups of the same type -# (for instance a group of public functions) to be put as a subgroup of that -# type (e.g. under the Public Functions section). Set it to NO to prevent -# subgrouping. Alternatively, this can be done per class using the -# \nosubgrouping command. -# The default value is: YES. - -SUBGROUPING = YES - -# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions -# are shown inside the group in which they are included (e.g. using \ingroup) -# instead of on a separate page (for HTML and Man pages) or section (for LaTeX -# and RTF). -# -# Note that this feature does not work in combination with -# SEPARATE_MEMBER_PAGES. -# The default value is: NO. - -INLINE_GROUPED_CLASSES = NO - -# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions -# with only public data fields or simple typedef fields will be shown inline in -# the documentation of the scope in which they are defined (i.e. file, -# namespace, or group documentation), provided this scope is documented. If set -# to NO, structs, classes, and unions are shown on a separate page (for HTML and -# Man pages) or section (for LaTeX and RTF). -# The default value is: NO. - -INLINE_SIMPLE_STRUCTS = NO - -# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or -# enum is documented as struct, union, or enum with the name of the typedef. So -# typedef struct TypeS {} TypeT, will appear in the documentation as a struct -# with name TypeT. When disabled the typedef will appear as a member of a file, -# namespace, or class. And the struct will be named TypeS. This can typically be -# useful for C code in case the coding convention dictates that all compound -# types are typedef'ed and only the typedef is referenced, never the tag name. -# The default value is: NO. - -TYPEDEF_HIDES_STRUCT = YES - -# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This -# cache is used to resolve symbols given their name and scope. Since this can be -# an expensive process and often the same symbol appears multiple times in the -# code, Doxygen keeps a cache of pre-resolved symbols. If the cache is too small -# Doxygen will become slower. If the cache is too large, memory is wasted. The -# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range -# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 -# symbols. At the end of a run Doxygen will report the cache usage and suggest -# the optimal cache size from a speed point of view. -# Minimum value: 0, maximum value: 9, default value: 0. - -LOOKUP_CACHE_SIZE = 0 - -# The NUM_PROC_THREADS specifies the number of threads Doxygen is allowed to use -# during processing. When set to 0 Doxygen will based this on the number of -# cores available in the system. You can set it explicitly to a value larger -# than 0 to get more control over the balance between CPU load and processing -# speed. At this moment only the input processing can be done using multiple -# threads. Since this is still an experimental feature the default is set to 1, -# which effectively disables parallel processing. Please report any issues you -# encounter. Generating dot graphs in parallel is controlled by the -# DOT_NUM_THREADS setting. -# Minimum value: 0, maximum value: 32, default value: 1. - -NUM_PROC_THREADS = 1 - -# If the TIMESTAMP tag is set different from NO then each generated page will -# contain the date or date and time when the page was generated. Setting this to -# NO can help when comparing the output of multiple runs. -# Possible values are: YES, NO, DATETIME and DATE. -# The default value is: NO. - -TIMESTAMP = NO - -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- - -# If the EXTRACT_ALL tag is set to YES, Doxygen will assume all entities in -# documentation are documented, even if no documentation was available. Private -# class members and static file members will be hidden unless the -# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. -# Note: This will also disable the warnings about undocumented members that are -# normally produced when WARNINGS is set to YES. -# The default value is: NO. - -EXTRACT_ALL = NO - -# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will -# be included in the documentation. -# The default value is: NO. - -EXTRACT_PRIVATE = NO - -# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual -# methods of a class will be included in the documentation. -# The default value is: NO. - -EXTRACT_PRIV_VIRTUAL = NO - -# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal -# scope will be included in the documentation. -# The default value is: NO. - -EXTRACT_PACKAGE = NO - -# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be -# included in the documentation. -# The default value is: NO. - -EXTRACT_STATIC = NO - -# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined -# locally in source files will be included in the documentation. If set to NO, -# only classes defined in header files are included. Does not have any effect -# for Java sources. -# The default value is: YES. - -EXTRACT_LOCAL_CLASSES = YES - -# This flag is only useful for Objective-C code. If set to YES, local methods, -# which are defined in the implementation section but not in the interface are -# included in the documentation. If set to NO, only methods in the interface are -# included. -# The default value is: NO. - -EXTRACT_LOCAL_METHODS = NO - -# If this flag is set to YES, the members of anonymous namespaces will be -# extracted and appear in the documentation as a namespace called -# 'anonymous_namespace{file}', where file will be replaced with the base name of -# the file that contains the anonymous namespace. By default anonymous namespace -# are hidden. -# The default value is: NO. - -EXTRACT_ANON_NSPACES = NO - -# If this flag is set to YES, the name of an unnamed parameter in a declaration -# will be determined by the corresponding definition. By default unnamed -# parameters remain unnamed in the output. -# The default value is: YES. - -RESOLVE_UNNAMED_PARAMS = YES - -# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all -# undocumented members inside documented classes or files. If set to NO these -# members will be included in the various overviews, but no documentation -# section is generated. This option has no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - -HIDE_UNDOC_MEMBERS = NO - -# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. If set -# to NO, these classes will be included in the various overviews. This option -# will also hide undocumented C++ concepts if enabled. This option has no effect -# if EXTRACT_ALL is enabled. -# The default value is: NO. - -HIDE_UNDOC_CLASSES = NO - -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all friend -# declarations. If set to NO, these declarations will be included in the -# documentation. -# The default value is: NO. - -HIDE_FRIEND_COMPOUNDS = NO - -# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any -# documentation blocks found inside the body of a function. If set to NO, these -# blocks will be appended to the function's detailed documentation block. -# The default value is: NO. - -HIDE_IN_BODY_DOCS = NO - -# The INTERNAL_DOCS tag determines if documentation that is typed after a -# \internal command is included. If the tag is set to NO then the documentation -# will be excluded. Set it to YES to include the internal documentation. -# The default value is: NO. - -INTERNAL_DOCS = NO - -# With the correct setting of option CASE_SENSE_NAMES Doxygen will better be -# able to match the capabilities of the underlying filesystem. In case the -# filesystem is case sensitive (i.e. it supports files in the same directory -# whose names only differ in casing), the option must be set to YES to properly -# deal with such files in case they appear in the input. For filesystems that -# are not case sensitive the option should be set to NO to properly deal with -# output files written for symbols that only differ in casing, such as for two -# classes, one named CLASS and the other named Class, and to also support -# references to files without having to specify the exact matching casing. On -# Windows (including Cygwin) and macOS, users should typically set this option -# to NO, whereas on Linux or other Unix flavors it should typically be set to -# YES. -# Possible values are: SYSTEM, NO and YES. -# The default value is: SYSTEM. - -CASE_SENSE_NAMES = SYSTEM - -# If the HIDE_SCOPE_NAMES tag is set to NO then Doxygen will show members with -# their full class and namespace scopes in the documentation. If set to YES, the -# scope will be hidden. -# The default value is: NO. - -HIDE_SCOPE_NAMES = NO - -# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then Doxygen will -# append additional text to a page's title, such as Class Reference. If set to -# YES the compound reference will be hidden. -# The default value is: NO. - -HIDE_COMPOUND_REFERENCE= NO - -# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class -# will show which file needs to be included to use the class. -# The default value is: YES. - -SHOW_HEADERFILE = YES - -# If the SHOW_INCLUDE_FILES tag is set to YES then Doxygen will put a list of -# the files that are included by a file in the documentation of that file. -# The default value is: YES. - -SHOW_INCLUDE_FILES = NO - -# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each -# grouped member an include statement to the documentation, telling the reader -# which file to include in order to use the member. -# The default value is: NO. - -SHOW_GROUPED_MEMB_INC = NO - -# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen will list include -# files with double quotes in the documentation rather than with sharp brackets. -# The default value is: NO. - -FORCE_LOCAL_INCLUDES = NO - -# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the -# documentation for inline members. -# The default value is: YES. - -INLINE_INFO = YES - -# If the SORT_MEMBER_DOCS tag is set to YES then Doxygen will sort the -# (detailed) documentation of file and class members alphabetically by member -# name. If set to NO, the members will appear in declaration order. -# The default value is: YES. - -SORT_MEMBER_DOCS = NO - -# If the SORT_BRIEF_DOCS tag is set to YES then Doxygen will sort the brief -# descriptions of file, namespace and class members alphabetically by member -# name. If set to NO, the members will appear in declaration order. Note that -# this will also influence the order of the classes in the class list. -# The default value is: NO. - -SORT_BRIEF_DOCS = NO - -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then Doxygen will sort the -# (brief and detailed) documentation of class members so that constructors and -# destructors are listed first. If set to NO the constructors will appear in the -# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. -# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief -# member documentation. -# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting -# detailed member documentation. -# The default value is: NO. - -SORT_MEMBERS_CTORS_1ST = NO - -# If the SORT_GROUP_NAMES tag is set to YES then Doxygen will sort the hierarchy -# of group names into alphabetical order. If set to NO the group names will -# appear in their defined order. -# The default value is: NO. - -SORT_GROUP_NAMES = NO - -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by -# fully-qualified names, including namespaces. If set to NO, the class list will -# be sorted only by class name, not including the namespace part. -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the alphabetical -# list. -# The default value is: NO. - -SORT_BY_SCOPE_NAME = NO - -# If the STRICT_PROTO_MATCHING option is enabled and Doxygen fails to do proper -# type resolution of all parameters of a function it will reject a match between -# the prototype and the implementation of a member function even if there is -# only one candidate or it is obvious which candidate to choose by doing a -# simple string match. By disabling STRICT_PROTO_MATCHING Doxygen will still -# accept a match between prototype and implementation in such cases. -# The default value is: NO. - -STRICT_PROTO_MATCHING = NO - -# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo -# list. This list is created by putting \todo commands in the documentation. -# The default value is: YES. - -GENERATE_TODOLIST = YES - -# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test -# list. This list is created by putting \test commands in the documentation. -# The default value is: YES. - -GENERATE_TESTLIST = YES - -# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug -# list. This list is created by putting \bug commands in the documentation. -# The default value is: YES. - -GENERATE_BUGLIST = YES - -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) -# the deprecated list. This list is created by putting \deprecated commands in -# the documentation. -# The default value is: YES. - -GENERATE_DEPRECATEDLIST= YES - -# The ENABLED_SECTIONS tag can be used to enable conditional documentation -# sections, marked by \if ... \endif and \cond -# ... \endcond blocks. - -ENABLED_SECTIONS = - -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the -# initial value of a variable or macro / define can have for it to appear in the -# documentation. If the initializer consists of more lines than specified here -# it will be hidden. Use a value of 0 to hide initializers completely. The -# appearance of the value of individual variables and macros / defines can be -# controlled using \showinitializer or \hideinitializer command in the -# documentation regardless of this setting. -# Minimum value: 0, maximum value: 10000, default value: 30. - -MAX_INITIALIZER_LINES = 30 - -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at -# the bottom of the documentation of classes and structs. If set to YES, the -# list will mention the files that were used to generate the documentation. -# The default value is: YES. - -SHOW_USED_FILES = YES - -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This -# will remove the Files entry from the Quick Index and from the Folder Tree View -# (if specified). -# The default value is: YES. - -SHOW_FILES = YES - -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces -# page. This will remove the Namespaces entry from the Quick Index and from the -# Folder Tree View (if specified). -# The default value is: YES. - -SHOW_NAMESPACES = YES - -# The FILE_VERSION_FILTER tag can be used to specify a program or script that -# Doxygen should invoke to get the current version for each file (typically from -# the version control system). Doxygen will invoke the program by executing (via -# popen()) the command command input-file, where command is the value of the -# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided -# by Doxygen. Whatever the program writes to standard output is used as the file -# version. For an example see the documentation. - -FILE_VERSION_FILTER = - -# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed -# by Doxygen. The layout file controls the global structure of the generated -# output files in an output format independent way. To create the layout file -# that represents Doxygen's defaults, run Doxygen with the -l option. You can -# optionally specify a file name after the option, if omitted DoxygenLayout.xml -# will be used as the name of the layout file. See also section "Changing the -# layout of pages" for information. -# -# Note that if you run Doxygen from a directory containing a file called -# DoxygenLayout.xml, Doxygen will parse it automatically even if the LAYOUT_FILE -# tag is left empty. - -LAYOUT_FILE = layout.xml - -# The CITE_BIB_FILES tag can be used to specify one or more bib files containing -# the reference definitions. This must be a list of .bib files. The .bib -# extension is automatically appended if omitted. This requires the bibtex tool -# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. -# For LaTeX the style of the bibliography can be controlled using -# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the -# search path. See also \cite for info how to create references. - -CITE_BIB_FILES = - -# The EXTERNAL_TOOL_PATH tag can be used to extend the search path (PATH -# environment variable) so that external tools such as latex and gs can be -# found. -# Note: Directories specified with EXTERNAL_TOOL_PATH are added in front of the -# path already specified by the PATH variable, and are added in the order -# specified. -# Note: This option is particularly useful for macOS version 14 (Sonoma) and -# higher, when running Doxygen from Doxywizard, because in this case any user- -# defined changes to the PATH are ignored. A typical example on macOS is to set -# EXTERNAL_TOOL_PATH = /Library/TeX/texbin /usr/local/bin -# together with the standard path, the full search path used by doxygen when -# launching external tools will then become -# PATH=/Library/TeX/texbin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin - -EXTERNAL_TOOL_PATH = - -#--------------------------------------------------------------------------- -# Configuration options related to warning and progress messages -#--------------------------------------------------------------------------- - -# The QUIET tag can be used to turn on/off the messages that are generated to -# standard output by Doxygen. If QUIET is set to YES this implies that the -# messages are off. -# The default value is: NO. - -QUIET = NO - -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated to standard error (stderr) by Doxygen. If WARNINGS is set to YES -# this implies that the warnings are on. -# -# Tip: Turn warnings on while writing the documentation. -# The default value is: YES. - -WARNINGS = YES - -# If the WARN_IF_UNDOCUMENTED tag is set to YES then Doxygen will generate -# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag -# will automatically be disabled. -# The default value is: YES. - -WARN_IF_UNDOCUMENTED = YES - -# If the WARN_IF_DOC_ERROR tag is set to YES, Doxygen will generate warnings for -# potential errors in the documentation, such as documenting some parameters in -# a documented function twice, or documenting parameters that don't exist or -# using markup commands wrongly. -# The default value is: YES. - -WARN_IF_DOC_ERROR = YES - -# If WARN_IF_INCOMPLETE_DOC is set to YES, Doxygen will warn about incomplete -# function parameter documentation. If set to NO, Doxygen will accept that some -# parameters have no documentation without warning. -# The default value is: YES. - -WARN_IF_INCOMPLETE_DOC = YES - -# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that -# are documented, but have no documentation for their parameters or return -# value. If set to NO, Doxygen will only warn about wrong parameter -# documentation, but not about the absence of documentation. If EXTRACT_ALL is -# set to YES then this flag will automatically be disabled. See also -# WARN_IF_INCOMPLETE_DOC -# The default value is: NO. - -WARN_NO_PARAMDOC = YES - -# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, Doxygen will warn about -# undocumented enumeration values. If set to NO, Doxygen will accept -# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag -# will automatically be disabled. -# The default value is: NO. - -WARN_IF_UNDOC_ENUM_VAL = YES - -# If the WARN_AS_ERROR tag is set to YES then Doxygen will immediately stop when -# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS -# then Doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but -# at the end of the Doxygen process Doxygen will return with a non-zero status. -# If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then Doxygen behaves -# like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined Doxygen will not -# write the warning messages in between other messages but write them at the end -# of a run, in case a WARN_LOGFILE is defined the warning messages will be -# besides being in the defined file also be shown at the end of a run, unless -# the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case -# the behavior will remain as with the setting FAIL_ON_WARNINGS. -# Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT. -# The default value is: NO. - -WARN_AS_ERROR = NO - -# The WARN_FORMAT tag determines the format of the warning messages that Doxygen -# can produce. The string should contain the $file, $line, and $text tags, which -# will be replaced by the file and line number from which the warning originated -# and the warning text. Optionally the format may contain $version, which will -# be replaced by the version of the file (if it could be obtained via -# FILE_VERSION_FILTER) -# See also: WARN_LINE_FORMAT -# The default value is: $file:$line: $text. - -WARN_FORMAT = "$file:$line: $text" - -# In the $text part of the WARN_FORMAT command it is possible that a reference -# to a more specific place is given. To make it easier to jump to this place -# (outside of Doxygen) the user can define a custom "cut" / "paste" string. -# Example: -# WARN_LINE_FORMAT = "'vi $file +$line'" -# See also: WARN_FORMAT -# The default value is: at line $line of file $file. - -WARN_LINE_FORMAT = "at line $line of file $file" - -# The WARN_LOGFILE tag can be used to specify a file to which warning and error -# messages should be written. If left blank the output is written to standard -# error (stderr). In case the file specified cannot be opened for writing the -# warning and error messages are written to standard error. When as file - is -# specified the warning and error messages are written to standard output -# (stdout). - -WARN_LOGFILE = - -#--------------------------------------------------------------------------- -# Configuration options related to the input files -#--------------------------------------------------------------------------- - -# The INPUT tag is used to specify the files and/or directories that contain -# documented source files. You may enter file names like myfile.cpp or -# directories like /usr/src/myproject. Separate the files or directories with -# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING -# Note: If this tag is empty the current directory is searched. - -INPUT = @DOXYGEN_INPUT_DIRS@ - -# This tag can be used to specify the character encoding of the source files -# that Doxygen parses. Internally Doxygen uses the UTF-8 encoding. Doxygen uses -# libiconv (or the iconv built into libc) for the transcoding. See the libiconv -# documentation (see: -# https://www.gnu.org/software/libiconv/) for the list of possible encodings. -# See also: INPUT_FILE_ENCODING -# The default value is: UTF-8. - -INPUT_ENCODING = UTF-8 - -# This tag can be used to specify the character encoding of the source files -# that Doxygen parses The INPUT_FILE_ENCODING tag can be used to specify -# character encoding on a per file pattern basis. Doxygen will compare the file -# name with each pattern and apply the encoding instead of the default -# INPUT_ENCODING) if there is a match. The character encodings are a list of the -# form: pattern=encoding (like *.php=ISO-8859-1). -# See also: INPUT_ENCODING for further information on supported encodings. - -INPUT_FILE_ENCODING = - -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and -# *.h) to filter out the source-files in the directories. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# read by Doxygen. -# -# Note the list of default checked file patterns might differ from the list of -# default file extension mappings. -# -# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm, -# *.cpp, *.cppm, *.ccm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, -# *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.ixx, *.l, *.cs, *.d, -# *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to -# be provided as Doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, -# *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. - -FILE_PATTERNS = *.c \ - *.cc \ - *.cxx \ - *.cxxm \ - *.cpp \ - *.cppm \ - *.ccm \ - *.c++ \ - *.c++m \ - *.java \ - *.ii \ - *.ixx \ - *.ipp \ - *.i++ \ - *.inl \ - *.idl \ - *.ddl \ - *.odl \ - *.h \ - *.hh \ - *.hxx \ - *.hpp \ - *.h++ \ - *.ixx \ - *.l \ - *.cs \ - *.d \ - *.php \ - *.php4 \ - *.php5 \ - *.phtml \ - *.inc \ - *.m \ - *.markdown \ - *.md \ - *.mm \ - *.dox \ - *.py \ - *.pyw \ - *.f90 \ - *.f95 \ - *.f03 \ - *.f08 \ - *.f18 \ - *.f \ - *.for \ - *.vhd \ - *.vhdl \ - *.ucf \ - *.qsf \ - *.ice - -# The RECURSIVE tag can be used to specify whether or not subdirectories should -# be searched for input files as well. -# The default value is: NO. - -RECURSIVE = YES - -# The EXCLUDE tag can be used to specify files and/or directories that should be -# excluded from the INPUT source files. This way you can easily exclude a -# subdirectory from a directory tree whose root is specified with the INPUT tag. -# -# Note that relative paths are relative to the directory from which Doxygen is -# run. - -EXCLUDE = ../src/private - -# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or -# directories that are symbolic links (a Unix file system feature) are excluded -# from the input. -# The default value is: NO. - -EXCLUDE_SYMLINKS = NO - -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories for example use the pattern */test/* - -EXCLUDE_PATTERNS = - -# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the -# output. The symbol name can be a fully qualified name, a word, or if the -# wildcard * is used, a substring. Examples: ANamespace, AClass, -# ANamespace::AClass, ANamespace::*Test - -EXCLUDE_SYMBOLS = - -# The EXAMPLE_PATH tag can be used to specify one or more files or directories -# that contain example code fragments that are included (see the \include -# command). - -EXAMPLE_PATH = @DOXYGEN_EXAMPLE_DIRS@ - -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and -# *.h) to filter out the source-files in the directories. If left blank all -# files are included. - -EXAMPLE_PATTERNS = * - -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude commands -# irrespective of the value of the RECURSIVE tag. -# The default value is: NO. - -EXAMPLE_RECURSIVE = NO - -# The IMAGE_PATH tag can be used to specify one or more files or directories -# that contain images that are to be included in the documentation (see the -# \image command). - -IMAGE_PATH = _static - -# The INPUT_FILTER tag can be used to specify a program that Doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command: -# -# -# -# where is the value of the INPUT_FILTER tag, and is the -# name of an input file. Doxygen will then use the output that the filter -# program writes to standard output. If FILTER_PATTERNS is specified, this tag -# will be ignored. -# -# Note that the filter must not add or remove lines; it is applied before the -# code is scanned, but not when the output code is generated. If lines are added -# or removed, the anchors will not be placed correctly. -# -# Note that Doxygen will use the data processed and written to standard output -# for further processing, therefore nothing else, like debug statements or used -# commands (so in case of a Windows batch file always use @echo OFF), should be -# written to standard output. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# properly processed by Doxygen. - -INPUT_FILTER = - -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: pattern=filter -# (like *.cpp=cxx_cpp_filter). See INPUT_FILTER for further information on how -# filters are used. If the FILTER_PATTERNS tag is empty or if none of the -# patterns match the file name, INPUT_FILTER is applied. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# properly processed by Doxygen. - -FILTER_PATTERNS = - -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will also be used to filter the input files that are used for -# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). -# The default value is: NO. - -FILTER_SOURCE_FILES = NO - -# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file -# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and -# it is also possible to disable source filtering for a specific pattern using -# *.ext= (so without naming a filter). -# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. - -FILTER_SOURCE_PATTERNS = - -# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that -# is part of the input, its contents will be placed on the main page -# (index.html). This can be useful if you have a project on for instance GitHub -# and want to reuse the introduction page also for the Doxygen output. - -USE_MDFILE_AS_MAINPAGE = - -# The Fortran standard specifies that for fixed formatted Fortran code all -# characters from position 72 are to be considered as comment. A common -# extension is to allow longer lines before the automatic comment starts. The -# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can -# be processed before the automatic comment starts. -# Minimum value: 7, maximum value: 10000, default value: 72. - -FORTRAN_COMMENT_AFTER = 72 - -#--------------------------------------------------------------------------- -# Configuration options related to source browsing -#--------------------------------------------------------------------------- - -# If the SOURCE_BROWSER tag is set to YES then a list of source files will be -# generated. Documented entities will be cross-referenced with these sources. -# -# Note: To get rid of all source code in the generated output, make sure that -# also VERBATIM_HEADERS is set to NO. -# The default value is: NO. - -SOURCE_BROWSER = NO - -# Setting the INLINE_SOURCES tag to YES will include the body of functions, -# multi-line macros, enums or list initialized variables directly into the -# documentation. -# The default value is: NO. - -INLINE_SOURCES = NO - -# Setting the STRIP_CODE_COMMENTS tag to YES will instruct Doxygen to hide any -# special comment blocks from generated source code fragments. Normal C, C++ and -# Fortran comments will always remain visible. -# The default value is: YES. - -STRIP_CODE_COMMENTS = YES - -# If the REFERENCED_BY_RELATION tag is set to YES then for each documented -# entity all documented functions referencing it will be listed. -# The default value is: NO. - -REFERENCED_BY_RELATION = NO - -# If the REFERENCES_RELATION tag is set to YES then for each documented function -# all documented entities called/used by that function will be listed. -# The default value is: NO. - -REFERENCES_RELATION = NO - -# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set -# to YES then the hyperlinks from functions in REFERENCES_RELATION and -# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will -# link to the documentation. -# The default value is: YES. - -REFERENCES_LINK_SOURCE = YES - -# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the -# source code will show a tooltip with additional information such as prototype, -# brief description and links to the definition and documentation. Since this -# will make the HTML file larger and loading of large files a bit slower, you -# can opt to disable this feature. -# The default value is: YES. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -SOURCE_TOOLTIPS = YES - -# If the USE_HTAGS tag is set to YES then the references to source code will -# point to the HTML generated by the htags(1) tool instead of Doxygen built-in -# source browser. The htags tool is part of GNU's global source tagging system -# (see https://www.gnu.org/software/global/global.html). You will need version -# 4.8.6 or higher. -# -# To use it do the following: -# - Install the latest version of global -# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file -# - Make sure the INPUT points to the root of the source tree -# - Run doxygen as normal -# -# Doxygen will invoke htags (and that will in turn invoke gtags), so these -# tools must be available from the command line (i.e. in the search path). -# -# The result: instead of the source browser generated by Doxygen, the links to -# source code will now point to the output of htags. -# The default value is: NO. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -USE_HTAGS = NO - -# If the VERBATIM_HEADERS tag is set the YES then Doxygen will generate a -# verbatim copy of the header file for each class for which an include is -# specified. Set to NO to disable this. -# See also: Section \class. -# The default value is: YES. - -VERBATIM_HEADERS = YES - -#--------------------------------------------------------------------------- -# Configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- - -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all -# compounds will be generated. Enable this if the project contains a lot of -# classes, structs, unions or interfaces. -# The default value is: YES. - -ALPHABETICAL_INDEX = YES - -# The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes) -# that should be ignored while generating the index headers. The IGNORE_PREFIX -# tag works for classes, function and member names. The entity will be placed in -# the alphabetical list under the first letter of the entity name that remains -# after removing the prefix. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -IGNORE_PREFIX = QDMI_ - -#--------------------------------------------------------------------------- -# Configuration options related to the HTML output -#--------------------------------------------------------------------------- - -# If the GENERATE_HTML tag is set to YES, Doxygen will generate HTML output -# The default value is: YES. - -GENERATE_HTML = YES - -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of -# it. -# The default directory is: html. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_OUTPUT = html - -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each -# generated HTML page (for example: .htm, .php, .asp). -# The default value is: .html. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FILE_EXTENSION = .html - -# The HTML_HEADER tag can be used to specify a user-defined HTML header file for -# each generated HTML page. If the tag is left blank Doxygen will generate a -# standard header. -# -# To get valid HTML the header file that includes any scripts and style sheets -# that Doxygen needs, which is dependent on the configuration options used (e.g. -# the setting GENERATE_TREEVIEW). It is highly recommended to start with a -# default header using -# doxygen -w html new_header.html new_footer.html new_stylesheet.css -# YourConfigFile -# and then modify the file new_header.html. See also section "Doxygen usage" -# for information on how to generate the default header that Doxygen normally -# uses. -# Note: The header is subject to change so you typically have to regenerate the -# default header when upgrading to a newer version of Doxygen. For a description -# of the possible markers and block names see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_HEADER = header.html - -# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each -# generated HTML page. If the tag is left blank Doxygen will generate a standard -# footer. See HTML_HEADER for more information on how to generate a default -# footer and what special commands can be used inside the footer. See also -# section "Doxygen usage" for information on how to generate the default footer -# that Doxygen normally uses. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FOOTER = - -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style -# sheet that is used by each HTML page. It can be used to fine-tune the look of -# the HTML output. If left blank Doxygen will generate a default style sheet. -# See also section "Doxygen usage" for information on how to generate the style -# sheet that Doxygen normally uses. -# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as -# it is more robust and this tag (HTML_STYLESHEET) will in the future become -# obsolete. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_STYLESHEET = - -# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined -# cascading style sheets that are included after the standard style sheets -# created by Doxygen. Using this option one can overrule certain style aspects. -# This is preferred over using HTML_STYLESHEET since it does not replace the -# standard style sheet and is therefore more robust against future updates. -# Doxygen will copy the style sheet files to the output directory. -# Note: The order of the extra style sheet files is of importance (e.g. the last -# style sheet in the list overrules the setting of the previous ones in the -# list). -# Note: Since the styling of scrollbars can currently not be overruled in -# Webkit/Chromium, the styling will be left out of the default doxygen.css if -# one or more extra stylesheets have been specified. So if scrollbar -# customization is desired it has to be added explicitly. For an example see the -# documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_EXTRA_STYLESHEET = @AWESOME_CSS_DIR@/doxygen-awesome.css \ - @AWESOME_CSS_DIR@/doxygen-awesome-sidebar-only.css \ - @AWESOME_CSS_DIR@/doxygen-awesome-sidebar-only-darkmode-toggle.css \ - style.css - -# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or -# other source files which should be copied to the HTML output directory. Note -# that these files will be copied to the base HTML output directory. Use the -# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these -# files. In the HTML_STYLESHEET file, use the file name only. Also note that the -# files will be copied as-is; there are no commands or markers available. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_EXTRA_FILES = @AWESOME_CSS_DIR@/doxygen-awesome-darkmode-toggle.js \ - @AWESOME_CSS_DIR@/doxygen-awesome-fragment-copy-button.js \ - @AWESOME_CSS_DIR@/doxygen-awesome-paragraph-link.js \ - @AWESOME_CSS_DIR@/doxygen-awesome-interactive-toc.js \ - @AWESOME_CSS_DIR@/doxygen-awesome-tabs.js - -# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output -# should be rendered with a dark or light theme. -# Possible values are: LIGHT always generates light mode output, DARK always -# generates dark mode output, AUTO_LIGHT automatically sets the mode according -# to the user preference, uses light mode if no preference is set (the default), -# AUTO_DARK automatically sets the mode according to the user preference, uses -# dark mode if no preference is set and TOGGLE allows a user to switch between -# light and dark mode via a button. -# The default value is: AUTO_LIGHT. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE = LIGHT - -# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen -# will adjust the colors in the style sheet and background images according to -# this color. Hue is specified as an angle on a color-wheel, see -# https://en.wikipedia.org/wiki/Hue for more information. For instance the value -# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 -# purple, and 360 is red again. -# Minimum value: 0, maximum value: 359, default value: 220. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_HUE = 220 - -# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors -# in the HTML output. For a value of 0 the output will use gray-scales only. A -# value of 255 will produce the most vivid colors. -# Minimum value: 0, maximum value: 255, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_SAT = 100 - -# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the -# luminance component of the colors in the HTML output. Values below 100 -# gradually make the output lighter, whereas values above 100 make the output -# darker. The value divided by 100 is the actual gamma applied, so 80 represents -# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not -# change the gamma. -# Minimum value: 40, maximum value: 240, default value: 80. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_GAMMA = 80 - -# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML -# documentation will contain a main index with vertical navigation menus that -# are dynamically created via JavaScript. If disabled, the navigation index will -# consists of multiple levels of tabs that are statically embedded in every HTML -# page. Disable this option to support browsers that do not have JavaScript, -# like the Qt help browser. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_DYNAMIC_MENUS = YES - -# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML -# documentation will contain sections that can be hidden and shown after the -# page has loaded. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_DYNAMIC_SECTIONS = NO - -# If the HTML_CODE_FOLDING tag is set to YES then classes and functions can be -# dynamically folded and expanded in the generated HTML source code. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_CODE_FOLDING = YES - -# If the HTML_COPY_CLIPBOARD tag is set to YES then Doxygen will show an icon in -# the top right corner of code and text fragments that allows the user to copy -# its content to the clipboard. Note this only works if supported by the browser -# and the web page is served via a secure context (see: -# https://www.w3.org/TR/secure-contexts/), i.e. using the https: or file: -# protocol. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COPY_CLIPBOARD = NO - -# Doxygen stores a couple of settings persistently in the browser (via e.g. -# cookies). By default these settings apply to all HTML pages generated by -# Doxygen across all projects. The HTML_PROJECT_COOKIE tag can be used to store -# the settings under a project specific key, such that the user preferences will -# be stored separately. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_PROJECT_COOKIE = - -# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries -# shown in the various tree structured indices initially; the user can expand -# and collapse entries dynamically later on. Doxygen will expand the tree to -# such a level that at most the specified number of entries are visible (unless -# a fully collapsed tree already exceeds this amount). So setting the number of -# entries 1 will produce a full collapsed tree by default. 0 is a special value -# representing an infinite number of entries and will result in a full expanded -# tree by default. -# Minimum value: 0, maximum value: 9999, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_INDEX_NUM_ENTRIES = 100 - -# If the GENERATE_DOCSET tag is set to YES, additional index files will be -# generated that can be used as input for Apple's Xcode 3 integrated development -# environment (see: -# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To -# create a documentation set, Doxygen will generate a Makefile in the HTML -# output directory. Running make will produce the docset in that directory and -# running make install will install the docset in -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at -# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy -# genXcode/_index.html for more information. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_DOCSET = NO - -# This tag determines the name of the docset feed. A documentation feed provides -# an umbrella under which multiple documentation sets from a single provider -# (such as a company or product suite) can be grouped. -# The default value is: Doxygen generated docs. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_FEEDNAME = "Doxygen generated docs" - -# This tag determines the URL of the docset feed. A documentation feed provides -# an umbrella under which multiple documentation sets from a single provider -# (such as a company or product suite) can be grouped. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_FEEDURL = - -# This tag specifies a string that should uniquely identify the documentation -# set bundle. This should be a reverse domain-name style string, e.g. -# com.mycompany.MyDocSet. Doxygen will append .docset to the name. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_BUNDLE_ID = org.doxygen.Project - -# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify -# the documentation publisher. This should be a reverse domain-name style -# string, e.g. com.mycompany.MyDocSet.documentation. -# The default value is: org.doxygen.Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_PUBLISHER_ID = org.doxygen.Publisher - -# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. -# The default value is: Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_PUBLISHER_NAME = Publisher - -# If the GENERATE_HTMLHELP tag is set to YES then Doxygen generates three -# additional HTML index files: index.hhp, index.hhc, and index.hhk. The -# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop -# on Windows. In the beginning of 2021 Microsoft took the original page, with -# a.o. the download links, offline the HTML help workshop was already many years -# in maintenance mode). You can download the HTML help workshop from the web -# archives at Installation executable (see: -# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo -# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). -# -# The HTML Help Workshop contains a compiler that can convert all HTML output -# generated by Doxygen into a single compiled HTML file (.chm). Compiled HTML -# files are now used as the Windows 98 help format, and will replace the old -# Windows help format (.hlp) on all Windows platforms in the future. Compressed -# HTML files also contain an index, a table of contents, and you can search for -# words in the documentation. The HTML workshop also contains a viewer for -# compressed HTML files. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_HTMLHELP = NO - -# The CHM_FILE tag can be used to specify the file name of the resulting .chm -# file. You can add a path in front of the file if the result should not be -# written to the html output directory. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_FILE = - -# The HHC_LOCATION tag can be used to specify the location (absolute path -# including file name) of the HTML help compiler (hhc.exe). If non-empty, -# Doxygen will try to run the HTML help compiler on the generated index.hhp. -# The file has to be specified with full path. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -HHC_LOCATION = - -# The GENERATE_CHI flag controls if a separate .chi index file is generated -# (YES) or that it should be included in the main .chm file (NO). -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -GENERATE_CHI = NO - -# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) -# and project file content. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_INDEX_ENCODING = - -# The BINARY_TOC flag controls whether a binary table of contents is generated -# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it -# enables the Previous and Next buttons. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -BINARY_TOC = NO - -# The TOC_EXPAND flag can be set to YES to add extra items for group members to -# the table of contents of the HTML help documentation and to the tree view. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -TOC_EXPAND = NO - -# The SITEMAP_URL tag is used to specify the full URL of the place where the -# generated documentation will be placed on the server by the user during the -# deployment of the documentation. The generated sitemap is called sitemap.xml -# and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL -# is specified no sitemap is generated. For information about the sitemap -# protocol see https://www.sitemaps.org -# This tag requires that the tag GENERATE_HTML is set to YES. - -SITEMAP_URL = - -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and -# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that -# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help -# (.qch) of the generated HTML documentation. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_QHP = NO - -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify -# the file name of the resulting .qch file. The path specified is relative to -# the HTML output folder. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QCH_FILE = - -# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help -# Project output. For more information please see Qt Help Project / Namespace -# (see: -# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_NAMESPACE = org.doxygen.Project - -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt -# Help Project output. For more information please see Qt Help Project / Virtual -# Folders (see: -# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). -# The default value is: doc. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_VIRTUAL_FOLDER = doc - -# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom -# filter to add. For more information please see Qt Help Project / Custom -# Filters (see: -# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_NAME = - -# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the -# custom filter to add. For more information please see Qt Help Project / Custom -# Filters (see: -# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_ATTRS = - -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this -# project's filter section matches. Qt Help Project / Filter Attributes (see: -# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_SECT_FILTER_ATTRS = - -# The QHG_LOCATION tag can be used to specify the location (absolute path -# including file name) of Qt's qhelpgenerator. If non-empty Doxygen will try to -# run qhelpgenerator on the generated .qhp file. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHG_LOCATION = - -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be -# generated, together with the HTML files, they form an Eclipse help plugin. To -# install this plugin and make it available under the help contents menu in -# Eclipse, the contents of the directory containing the HTML and XML files needs -# to be copied into the plugins directory of eclipse. The name of the directory -# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. -# After copying Eclipse needs to be restarted before the help appears. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_ECLIPSEHELP = NO - -# A unique identifier for the Eclipse help plugin. When installing the plugin -# the directory name containing the HTML and XML files should also have this -# name. Each documentation set should have its own identifier. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. - -ECLIPSE_DOC_ID = org.doxygen.Project - -# If you want full control over the layout of the generated HTML pages it might -# be necessary to disable the index and replace it with your own. The -# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top -# of each HTML page. A value of NO enables the index and the value YES disables -# it. Since the tabs in the index contain the same information as the navigation -# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -DISABLE_INDEX = NO - -# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index -# structure should be generated to display hierarchical information. If the tag -# value is set to YES, a side panel will be generated containing a tree-like -# index structure (just like the one that is generated for HTML Help). For this -# to work a browser that supports JavaScript, DHTML, CSS and frames is required -# (i.e. any modern browser). Windows users are probably better off using the -# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can -# further fine tune the look of the index (see "Fine-tuning the output"). As an -# example, the default style sheet generated by Doxygen has an example that -# shows how to put an image at the root of the tree instead of the PROJECT_NAME. -# Since the tree basically has the same information as the tab index, you could -# consider setting DISABLE_INDEX to YES when enabling this option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_TREEVIEW = YES - -# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the -# FULL_SIDEBAR option determines if the side bar is limited to only the treeview -# area (value NO) or if it should extend to the full height of the window (value -# YES). Setting this to YES gives a layout similar to -# https://docs.readthedocs.io with more room for contents, but less room for the -# project logo, title, and description. If either GENERATE_TREEVIEW or -# DISABLE_INDEX is set to NO, this option has no effect. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FULL_SIDEBAR = NO - -# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that -# Doxygen will group on one line in the generated HTML documentation. -# -# Note that a value of 0 will completely suppress the enum values from appearing -# in the overview section. -# Minimum value: 0, maximum value: 20, default value: 4. -# This tag requires that the tag GENERATE_HTML is set to YES. - -ENUM_VALUES_PER_LINE = 4 - -# When the SHOW_ENUM_VALUES tag is set doxygen will show the specified -# enumeration values besides the enumeration mnemonics. -# The default value is: NO. - -SHOW_ENUM_VALUES = YES - -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used -# to set the initial width (in pixels) of the frame in which the tree is shown. -# Minimum value: 0, maximum value: 1500, default value: 250. -# This tag requires that the tag GENERATE_HTML is set to YES. - -TREEVIEW_WIDTH = 250 - -# If the EXT_LINKS_IN_WINDOW option is set to YES, Doxygen will open links to -# external symbols imported via tag files in a separate window. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -EXT_LINKS_IN_WINDOW = NO - -# If the OBFUSCATE_EMAILS tag is set to YES, Doxygen will obfuscate email -# addresses. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -OBFUSCATE_EMAILS = YES - -# If the HTML_FORMULA_FORMAT option is set to svg, Doxygen will use the pdf2svg -# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see -# https://inkscape.org) to generate formulas as SVG images instead of ONGs for -# the HTML output. These images will generally look nicer at scaled resolutions. -# Possible values are: png (the default) and svg (looks nicer but requires the -# pdf2svg or inkscape tool). -# The default value is: png. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FORMULA_FORMAT = png - -# Use this tag to change the font size of LaTeX formulas included as images in -# the HTML documentation. When you change the font size after a successful -# Doxygen run you need to manually remove any form_*.png images from the HTML -# output directory to force them to be regenerated. -# Minimum value: 8, maximum value: 50, default value: 10. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_FONTSIZE = 10 - -# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands -# to create new LaTeX commands to be used in formulas as building blocks. See -# the section "Including formulas" for details. - -FORMULA_MACROFILE = - -# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see -# https://www.mathjax.org) which uses client side JavaScript for the rendering -# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX -# installed or if you want to formulas look prettier in the HTML output. When -# enabled you may also need to install MathJax separately and configure the path -# to it using the MATHJAX_RELPATH option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -USE_MATHJAX = NO - -# With MATHJAX_VERSION it is possible to specify the MathJax version to be used. -# Note that the different versions of MathJax have different requirements with -# regards to the different settings, so it is possible that also other MathJax -# settings have to be changed when switching between the different MathJax -# versions. -# Possible values are: MathJax_2 and MathJax_3. -# The default value is: MathJax_2. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_VERSION = MathJax_2 - -# When MathJax is enabled you can set the default output format to be used for -# the MathJax output. For more details about the output format see MathJax -# version 2 (see: -# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 -# (see: -# http://docs.mathjax.org/en/latest/web/components/output.html). -# Possible values are: HTML-CSS (which is slower, but has the best -# compatibility. This is the name for Mathjax version 2, for MathJax version 3 -# this will be translated into chtml), NativeMML (i.e. MathML. Only supported -# for MathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This -# is the name for Mathjax version 3, for MathJax version 2 this will be -# translated into HTML-CSS) and SVG. -# The default value is: HTML-CSS. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_FORMAT = HTML-CSS - -# When MathJax is enabled you need to specify the location relative to the HTML -# output directory using the MATHJAX_RELPATH option. The destination directory -# should contain the MathJax.js script. For instance, if the mathjax directory -# is located at the same level as the HTML output directory, then -# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax -# Content Delivery Network so you can quickly see the result without installing -# MathJax. However, it is strongly recommended to install a local copy of -# MathJax from https://www.mathjax.org before deployment. The default value is: -# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 -# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_RELPATH = - -# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax -# extension names that should be enabled during MathJax rendering. For example -# for MathJax version 2 (see -# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions): -# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols -# For example for MathJax version 3 (see -# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): -# MATHJAX_EXTENSIONS = ams -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_EXTENSIONS = - -# The MATHJAX_CODEFILE tag can be used to specify a file with JavaScript pieces -# of code that will be used on startup of the MathJax code. See the MathJax site -# (see: -# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an -# example see the documentation. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_CODEFILE = - -# When the SEARCHENGINE tag is enabled Doxygen will generate a search box for -# the HTML output. The underlying search engine uses JavaScript and DHTML and -# should work on any modern browser. Note that when using HTML help -# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) -# there is already a search function so this one should typically be disabled. -# For large projects the JavaScript based search engine can be slow, then -# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to -# search using the keyboard; to jump to the search box use + S -# (what the is depends on the OS and browser, but it is typically -# , /