[ { "path": ".backportrc.json", "content": "// Documentation at\n// https://github.com/sorenlouv/backport/blob/main/docs/config-file-options.md\n// Comments are allowed, trailing commas are not.\n{\n \"repoOwner\": \"cocotb\",\n \"repoName\": \"cocotb\",\n\n // Branches to backport to.\n \"targetBranchChoices\": [\n \"stable/1.9\"\n ],\n\n // Use `backport-to:VERSION` as indication of the target branch.\n // Also update .github/workflows/backport.yml when changing the label here.\n \"branchLabelMapping\": {\n \"^backport-to:(\\\\d+\\\\.\\\\d+)$\": \"stable/$1\"\n },\n\n // Labels assigned to the source PR after opening the backport PR(s).\n \"sourcePRLabels\": [\"status:backport-created\"],\n\n // In GitHub PR comments made by the bot suggest that users run\n // \"npx backport\", which automatically installs backport if necessary.\n \"backportBinary\": \"npx backport\",\n\n // Leave a note in the source PR if a backport failed.\n \"publishStatusCommentOnFailure\": true,\n\n // Title of the backport PR(s).\n \"prTitle\": \"[{{targetBranch}}] Backport PR #{{sourcePullRequest.number}}: {{sourcePullRequest.title}}\",\n\n // Labels added to the newly created backport PR(s).\n \"targetPRLabels\": [\"type:backport\"],\n\n // Default reviewers.\n \"reviewers\": [\"cocotb/maintainers\"]\n}\n" }, { "path": ".clang-format", "content": "# Copyright cocotb contributors\n# Licensed under the Revised BSD License, see LICENSE for details.\n# SPDX-License-Identifier: BSD-3-Clause\nBasedOnStyle: Google\nIndentWidth: 4\nAccessModifierOffset: -2\nPointerAlignment: Right\n" }, { "path": ".codecov.yml", "content": "# Copyright cocotb contributors\n# Licensed under the Revised BSD License, see LICENSE for details.\n# SPDX-License-Identifier: BSD-3-Clause\n\n# Codecov configuration\ncodecov:\n notify:\n # Codecov claims [1] to wait until all CI runs have completed, but that\n # doesn't work for our CI setup, causing early reports to come in which\n # indicate a drop in coverage. These reports are later updated as more\n # reports come in. But by that time the first issue comment has already\n # been made and an email has been sent. Prevent that by explicitly\n # specifying the number of builds that need to be uploaded to codecov\n # [2].\n #\n # Keep this number in sync with the CI configuration!\n #\n # The number should be the same as the total number of tests belonging\n # to \"ci-free\" and \"ci-licensed\".\n #\n # [1] https://docs.codecov.io/docs/merging-reports#how-does-codecov-know-when-to-send-notifications\n # [2] https://docs.codecov.io/docs/notifications#preventing-notifications-until-after-n-builds\n after_n_builds: 24\n\ncoverage:\n status:\n project:\n default:\n # Report a CI failure if coverage drops by more than 1 percent.\n threshold: 1%\n" }, { "path": ".devcontainer/Dockerfile", "content": "ARG VERILATOR_VERSION=5.044\nARG UV_VERSION=0.10.2\n\n# Container images used only to copy binaries out of it (see below).\nFROM verilator/verilator:v${VERILATOR_VERSION} AS verilator\nFROM ghcr.io/astral-sh/uv:${UV_VERSION} AS uv\n\n# See https://github.com/devcontainers/images/tree/main/src/base-ubuntu/history\n# for a description of what's in this base image.\nFROM mcr.microsoft.com/devcontainers/base:2-ubuntu-24.04\n\nRUN apt-get update && export DEBIAN_FRONTEND=noninteractive \\\n && apt-get -y install --no-install-recommends \\\n bear \\\n bison \\\n build-essential \\\n ccache \\\n clang \\\n clangd \\\n colordiff \\\n doxygen \\\n flex \\\n gdb \\\n gdb \\\n gh \\\n ghdl \\\n git \\\n git-absorb \\\n gperf \\\n graphviz \\\n iverilog \\\n libenchant-2-dev \\\n lldb \\\n pre-commit \\\n python3-dev \\\n python3-pip \\\n python3-venv \\\n valgrind \\\n && apt-get clean && rm -rf /var/lib/apt/lists/*\n\n# Install UV from the official uv container image.\nCOPY --from=uv /uv /uvx /usr/local/bin/\n\n# Install Verilator from official Verilator container image.\nCOPY --from=verilator /usr/local/share/verilator /usr/local/share/verilator\nCOPY --from=verilator /usr/local/bin/verilator* /usr/local/bin/\nCOPY --from=verilator /usr/local/share/man /usr/local/share/man\nCOPY --from=verilator /usr/local/share/pkgconfig/verilator.pc /usr/local/share/pkgconfig\n\n# Install NVC from an upstream Debian package.\n# (Use apt instead of dpkg to resolve dependencies automatically.)\nARG NVC_VERSION=1.18.2\nARG NVC_SHA256=bb6f19a84a398e13c56649996262db63ed9787e19dd0ad894774e132e170b785\nRUN mkdir -p /tmp/nvc-install \\\n && curl -SLo /tmp/nvc-install/nvc.deb \"https://github.com/nickg/nvc/releases/download/r${NVC_VERSION}/nvc_${NVC_VERSION}-1_amd64_ubuntu-24.04.deb\" \\\n && echo \"${NVC_SHA256} /tmp/nvc-install/nvc.deb\" | sha256sum --check \\\n && apt-get update && export DEBIAN_FRONTEND=noninteractive \\\n && apt -y install --no-install-recommends /tmp/nvc-install/nvc.deb \\\n && apt-get clean && rm -rf /var/lib/apt/lists/* \\\n && rm -rf /tmp/nvc-install\n" }, { "path": ".devcontainer/README.md", "content": "# Cocotb Development Environment in a Dev Container\n\nThe Dev Container provides a ready-to-code development environment for cocotb on Windows, Mac, or Linux.\nDev Containers combine VS Code with (Docker) containers and configuration within the cocotb repository.\n\nBy default, Dev Containers cannot access files on your local machine;\nif you want to use proprietary simulators installed on your machine, you might be better off with a development environment on your machine itself.\n\n## What's included in the Dev Container?\n\n* Ubuntu 24.04\n* Compilers: GCC and clang\n* Open-source simulators: GHDL, Icarus Verilog, Verilator, NVC\n* Productivity tools: GDB, LLDB, Valgrind, [Bear](https://github.com/rizsotto/Bear)\n\n## Getting started\n\nYou need VS Code and the Dev Containers extension to run the Dev Container on your local machine.\nFollow the [Dev Containers Getting Started documentation](https://code.visualstudio.com/docs/devcontainers/containers#_getting-started) documentation to install all required tools.\n\nThen start the Dev Container:\n* Open VS Code\n* Open the command palette (F1)\n* Type `Dev Containers: Clone Repository in Container Volume...` and press ENTER.\n* Enter the repository URL `https://github.com/cocotb/cocotb` and press ENTER again.\n* Wait for a short moment until the Dev Container is ready to be used.\n\nNote: On Linux you can alternatively clone the Git repository on your local machine and open the folder in a container.\nWe don't recommend that on Windows or Mac to get good filesystem performance ([learn more](https://code.visualstudio.com/remote/advancedcontainers/improve-performance)).\n\nAfter the Dev Container startup completed **open a new terminal** to run a first cocotb test.\nNote: *Do not* reuse the `Welcome to Codespaces` terminal you might see -- it does not have an active Python venv and commands will fail.\n\n```\ncd examples/simple_dff\nmake WAVES=1 SIM=iverlog\ncode sim_build/dff.fst\n```\n" }, { "path": ".devcontainer/devcontainer.json", "content": "// VS Code Dev Container configuration file for a cocotb development environment.\n{\n\t\"name\": \"cocotb development\",\n\t\"build\": {\n\t\t\"context\": \"..\",\n\t\t\"dockerfile\": \"Dockerfile\"\n\t},\n\t\"postCreateCommand\": \".devcontainer/post-create.sh\",\n\t\"postAttachCommand\": \"less .devcontainer/README.md\",\n\t\"customizations\": {\n\t\t\"vscode\": {\n\t\t\t\"extensions\": [\n\t\t\t\t\"llvm-vs-code-extensions.vscode-clangd\",\n\t\t\t\t\"ms-python.python\",\n\t\t\t\t\"ms-python.vscode-pylance\",\n\t\t\t\t\"lramseyer.vaporview\"\n\t\t\t],\n\t\t\t\"settings\": {\n\t\t\t\t\"tasks\": {\n\t\t\t\t\t// See https://go.microsoft.com/fwlink/?LinkId=733558\n\t\t\t\t\t// for the documentation about the tasks.json format\n\t\t\t\t\t\"version\": \"2.0.0\",\n\t\t\t\t\t\"tasks\": [\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"label\": \"Preview documentation\",\n\t\t\t\t\t\t\t\"type\": \"shell\",\n\t\t\t\t\t\t\t// Run the docs_preview nox session with the virtual environment's Python\n\t\t\t\t\t\t\t// (if it exists).\n\t\t\t\t\t\t\t\"command\": \"PATH=.venv/bin:$PATH nox -s docs_preview\",\n\t\t\t\t\t\t\t\"isBackground\": true\n\t\t\t\t\t\t}\n\t\t\t\t\t]\n\t\t\t\t},\n\t\t\t\t\"files.exclude\": {\n\t\t\t\t\t\"**/.venv\": true\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}\n" }, { "path": ".devcontainer/post-create.sh", "content": "#!/bin/bash\nset -eo pipefail\n\n# Create and activate a virtual environment.\npython3 -m venv --prompt cocotb-devenv .venv\n. .venv/bin/activate\n\n# Install prerequisites and development tools.\npre-commit install\npip3 install nox pytest\n\n# Install cocotb in editable mode.\nbear -- pip3 install -e .\n" }, { "path": ".git-blame-ignore-revs", "content": "# Copyright cocotb contributors\n# Licensed under the Revised BSD License, see LICENSE for details.\n# SPDX-License-Identifier: BSD-3-Clause\n\n# The following command will configure your local git repo to ignore these commits\n# when doing git-blame.\n# git config blame.ignoreRevsFile .git-blame-ignore-revs\n\n# clang-format\n78e69fa428477b73808d08aec0e6702a924497f8\n# black and isort\n720b0e1071d0c720e61fa50fcb1813fd99198f20\n# ruff\neb254d7581b64e5384ee87f49d4363d72be6e20a\n785e0896930039023db3c2e2be47bed5375326c5\n0f943a324a997bb31dcd55831b51b393d5435965\n" }, { "path": ".github/PULL_REQUEST_TEMPLATE.md", "content": "\n" }, { "path": ".github/dependabot.yml", "content": "# Copyright cocotb contributors\n# Licensed under the Revised BSD License, see LICENSE for details.\n# SPDX-License-Identifier: BSD-3-Clause\n\nversion: 2\nupdates:\n - package-ecosystem: \"github-actions\"\n directory: \"/\"\n schedule:\n interval: \"weekly\"\n cooldown:\n default-days: 7\n - package-ecosystem: \"uv\"\n directory: \"/\"\n schedule:\n interval: \"weekly\"\n cooldown:\n default-days: 7\n versioning-strategy: lockfile-only\n groups:\n updates:\n applies-to: version-updates\n patterns:\n - \"*\"\n update-types:\n - \"minor\"\n - \"patch\"\n" }, { "path": ".github/generate-envs.py", "content": "#!/usr/bin/env python3\n# Copyright cocotb contributors\n# Licensed under the Revised BSD License, see LICENSE for details.\n# SPDX-License-Identifier: BSD-3-Clause\n\n\"\"\"Generate a list of test environments.\n\nEach environment must contain the following fields:\n- lang: The TOPLEVEL_LANG of the test. Must be one of \"verilog\" or \"vhdl\".\n- sim: The SIM of the test. Must be one of \"icarus\", \"ghdl\", \"nvc\", \"verilator\", \"riviera\", \"questa\", \"xcelium\", or \"vcs\".\n- sim-version: The version of the simulator to use. Valid values depend upon the simulator and build recipe.\n- os: The OS to operate on. Must be a valid value for the \"jobs..runs-on\" field for Github Actions.\n- python-version: The Python version to test with. Must be a valid value for the \"python-version\" field of the \"actions/setup-python\" Github Action.\n- group: The group to run the test in. One of \"ci-free\", \"ci-licensed\", \"experimental\", or \"extended\". See below note.\n\nOptional fields:\n- self-hosted: True if test needs to be run on a self-hosted Github Action runner. Default: False.\n- cc: C compiler and linker to use. Default: gcc.\n- cxx: C++ compiler and linker to use. Default: g++.\n- extra_name: Additional tag prepended to computed name for test. Default: .\n\nWhat tests belong in what groups:\n- ci-free: The most recent stable release of a given free simulator, all supported versions of Python, and all supported operating systems. Run on all PRs and master pushes.\n- ci-licensed: The most recent stable release of a given licensed simulator. Run on all PRs and master pushes in the cocotb repo, but are skipped in forks.\n- experimental: Development HEAD for each simulator, any under-development version of Python, and under-development simulator. Run weekly.\n- extended: The minimum supoprted version of a simulator, and a smattering of released simulator versions between the minimum and most recent. Run weekly.\n\nIdeally, whenever a new version of a simulator is released, a new test should be added for that simulator.\nThe current test in the \"ci-free\"/\"ci-licensed\" group should be moved to \"extended\",\nand the new version should be added to \"ci-free\"/\"ci-licensed\" and any changes in behavior recorded with expectations to make CI pass.\n\"\"\"\n\nfrom __future__ import annotations\n\nimport argparse\nimport json\nimport sys\n\nENVS = [\n # Test different Python versions with package managed Icarus on Ubuntu\n {\n \"lang\": \"vhdl\",\n \"sim\": \"nvc\",\n \"sim-version\": \"r1.19.2\",\n \"os\": \"ubuntu-22.04\",\n \"python-version\": \"3.9\",\n \"group\": \"ci-free\",\n },\n {\n \"lang\": \"vhdl\",\n \"sim\": \"nvc\",\n \"sim-version\": \"r1.19.2\",\n \"os\": \"ubuntu-22.04\",\n \"python-version\": \"3.10\",\n \"group\": \"ci-free\",\n },\n {\n \"lang\": \"vhdl\",\n \"sim\": \"nvc\",\n \"sim-version\": \"r1.19.2\",\n \"os\": \"ubuntu-22.04\",\n \"python-version\": \"3.11\",\n \"group\": \"ci-free\",\n },\n {\n \"lang\": \"vhdl\",\n \"sim\": \"nvc\",\n \"sim-version\": \"r1.19.2\",\n \"os\": \"ubuntu-22.04\",\n \"python-version\": \"3.12\",\n \"group\": \"ci-free\",\n },\n {\n \"lang\": \"vhdl\",\n \"sim\": \"nvc\",\n \"sim-version\": \"r1.19.2\",\n \"os\": \"ubuntu-22.04\",\n \"python-version\": \"3.13\",\n \"group\": \"ci-free\",\n },\n {\n \"lang\": \"vhdl\",\n \"sim\": \"nvc\",\n \"sim-version\": \"r1.19.2\",\n \"os\": \"ubuntu-22.04\",\n \"python-version\": \"3.14\",\n \"group\": \"ci-free\",\n },\n # {\n # \"lang\": \"vhdl\",\n # \"sim\": \"nvc\",\n # \"sim-version\": \"r1.17.1\",\n # \"os\": \"ubuntu-22.04\",\n # \"python-version\": \"3.15\",\n # \"group\": \"experimental\",\n # },\n # Test Icarus on Ubuntu\n {\n \"lang\": \"verilog\",\n \"sim\": \"icarus\",\n \"sim-version\": \"v11_0\", # Minimum supported version\n \"os\": \"ubuntu-22.04\",\n \"python-version\": \"3.9\",\n \"group\": \"extended\",\n },\n {\n \"lang\": \"verilog\",\n \"sim\": \"icarus\",\n \"sim-version\": \"v13_0\", # The latest release version.\n \"os\": \"ubuntu-22.04\",\n \"python-version\": \"3.9\",\n \"group\": \"ci-free\",\n },\n {\n \"lang\": \"verilog\",\n \"sim\": \"icarus\",\n \"sim-version\": \"master\",\n \"os\": \"ubuntu-22.04\",\n \"python-version\": \"3.9\",\n \"group\": \"experimental\",\n },\n # Test GHDL on Ubuntu\n {\n \"lang\": \"vhdl\",\n \"sim\": \"ghdl\",\n \"sim-version\": \"v2.0.0\", # GHDL 2.0 is the minimum supported version.\n \"os\": \"ubuntu-22.04\",\n \"python-version\": \"3.9\",\n \"group\": \"extended\",\n },\n {\n \"lang\": \"vhdl\",\n \"sim\": \"ghdl\",\n \"sim-version\": \"v5.1.1\", # The latest release version.\n \"os\": \"ubuntu-22.04\",\n \"python-version\": \"3.9\",\n \"group\": \"ci-free\",\n },\n {\n \"lang\": \"vhdl\",\n \"sim\": \"ghdl\",\n \"sim-version\": \"master\",\n \"os\": \"ubuntu-22.04\",\n \"python-version\": \"3.9\",\n \"group\": \"experimental\",\n },\n # Testing latest release is covered by the Python version tests\n {\n \"lang\": \"vhdl\",\n \"sim\": \"nvc\",\n \"sim-version\": \"master\",\n \"os\": \"ubuntu-22.04\",\n \"python-version\": \"3.9\",\n \"group\": \"experimental\",\n },\n # Test Verilator on Ubuntu\n {\n \"lang\": \"verilog\",\n \"sim\": \"verilator\",\n \"sim-version\": \"v5.046\", # Latest release version.\n \"os\": \"ubuntu-22.04\",\n \"python-version\": \"3.10\",\n \"group\": \"ci-free\",\n },\n {\n \"lang\": \"verilog\",\n \"sim\": \"verilator\",\n \"sim-version\": \"master\",\n \"os\": \"ubuntu-22.04\",\n \"python-version\": \"3.10\",\n \"group\": \"experimental\",\n },\n # Test other OSes\n # Icarus homebrew (ARM64)\n {\n \"lang\": \"verilog\",\n \"sim\": \"icarus\",\n \"sim-version\": \"homebrew-stable\",\n \"os\": \"macos-14\",\n \"python-version\": \"3.9\",\n \"group\": \"ci-free\",\n },\n # Icarus homebrew (ARM64) (HEAD/master)\n {\n \"lang\": \"verilog\",\n \"sim\": \"icarus\",\n \"sim-version\": \"homebrew-HEAD\",\n \"os\": \"macos-14\",\n \"python-version\": \"3.9\",\n \"group\": \"experimental\",\n },\n # Verilator macOS (ARM64) HEAD\n {\n \"lang\": \"verilog\",\n \"sim\": \"verilator\",\n \"sim-version\": \"master\",\n \"os\": \"macos-14\",\n \"python-version\": \"3.9\",\n \"group\": \"experimental\",\n },\n # Verilator macOS (ARM64) latest release\n {\n \"lang\": \"verilog\",\n \"sim\": \"verilator\",\n \"sim-version\": \"v5.046\",\n \"os\": \"macos-14\",\n \"python-version\": \"3.9\",\n \"group\": \"ci-free\",\n },\n # Icarus homebrew (x86)\n {\n \"lang\": \"verilog\",\n \"sim\": \"icarus\",\n \"sim-version\": \"homebrew-stable\",\n \"os\": \"macos-15-intel\",\n \"python-version\": \"3.9\",\n \"group\": \"ci-free\",\n },\n # Icarus windows from source\n {\n \"lang\": \"verilog\",\n \"sim\": \"icarus\",\n \"sim-version\": \"v13_0\",\n \"os\": \"windows-latest\",\n \"python-version\": \"3.11\",\n \"toolchain\": \"mingw\",\n \"extra-name\": \"mingw\",\n \"group\": \"ci-free\",\n },\n # use msvc instead of mingw\n {\n \"lang\": \"verilog\",\n \"sim\": \"icarus\",\n \"sim-version\": \"v13_0\",\n \"os\": \"windows-latest\",\n \"python-version\": \"3.11\",\n \"toolchain\": \"msvc\",\n \"extra-name\": \"msvc\",\n \"group\": \"ci-free\",\n },\n # NVC on windows\n {\n \"lang\": \"vhdl\",\n \"sim\": \"nvc\",\n \"sim-version\": \"r1.19.2\",\n \"os\": \"windows-latest\",\n \"python-version\": \"3.11\",\n \"group\": \"ci-free\",\n },\n # Other\n # use clang instead of gcc\n {\n \"lang\": \"vhdl\",\n \"sim\": \"nvc\",\n \"sim-version\": \"r1.19.2\",\n \"os\": \"ubuntu-22.04\",\n \"python-version\": \"3.9\",\n \"cxx\": \"clang++\",\n \"cc\": \"clang\",\n \"extra-name\": \"clang\",\n \"group\": \"ci-free\",\n },\n # Test Siemens Questa on Ubuntu\n {\n \"lang\": \"verilog\",\n \"sim\": \"questa\",\n \"sim-version\": \"siemens/questa/2025.2\",\n \"os\": \"ubuntu-22.04\",\n \"self-hosted\": True,\n \"python-version\": \"3.9\",\n \"group\": \"ci-licensed\",\n },\n {\n \"lang\": \"vhdl and fli\",\n \"sim\": \"questa\",\n \"sim-version\": \"siemens/questa/2025.2\",\n \"os\": \"ubuntu-22.04\",\n \"self-hosted\": True,\n \"python-version\": \"3.9\",\n \"group\": \"ci-licensed\",\n },\n {\n \"lang\": \"vhdl and vhpi\",\n \"sim\": \"questa\",\n \"sim-version\": \"siemens/questa/2025.2\",\n \"os\": \"ubuntu-22.04\",\n \"self-hosted\": True,\n \"python-version\": \"3.9\",\n \"group\": \"ci-licensed\",\n },\n # Test Aldec Riviera-PRO on Ubuntu\n {\n \"lang\": \"verilog\",\n \"sim\": \"riviera\",\n \"sim-version\": \"aldec/rivierapro/2025.10\",\n \"os\": \"ubuntu-22.04\",\n \"self-hosted\": True,\n \"python-version\": \"3.9\",\n \"group\": \"ci-licensed\",\n },\n {\n \"lang\": \"vhdl\",\n \"sim\": \"riviera\",\n \"sim-version\": \"aldec/rivierapro/2025.10\",\n \"os\": \"ubuntu-22.04\",\n \"self-hosted\": True,\n \"python-version\": \"3.9\",\n \"group\": \"ci-licensed\",\n },\n # Test Cadence Xcelium on Ubuntu\n {\n \"lang\": \"verilog\",\n \"sim\": \"xcelium\",\n \"sim-version\": \"cadence/xcelium/2509\",\n \"os\": \"ubuntu-22.04\",\n \"self-hosted\": True,\n \"python-version\": \"3.9\",\n \"group\": \"ci-licensed\",\n },\n {\n \"lang\": \"vhdl\",\n \"sim\": \"xcelium\",\n \"sim-version\": \"cadence/xcelium/2509\",\n \"os\": \"ubuntu-22.04\",\n \"self-hosted\": True,\n \"python-version\": \"3.9\",\n \"group\": \"ci-licensed\",\n },\n # Test Synopsys VCS on Ubuntu\n {\n \"lang\": \"verilog\",\n \"sim\": \"vcs\",\n \"sim-version\": \"synopsys/vcs/X-2025.06\",\n \"os\": \"ubuntu-22.04\",\n \"self-hosted\": True,\n \"python-version\": \"3.9\",\n \"group\": \"ci-licensed\",\n },\n {\n \"lang\": \"vhdl\",\n \"sim\": \"vcs\",\n \"sim-version\": \"synopsys/vcs/X-2025.06\",\n \"os\": \"ubuntu-22.04\",\n \"self-hosted\": True,\n \"python-version\": \"3.9\",\n \"group\": \"experimental\",\n },\n]\n\nghdl_versions = (\"v3.0.0\", \"v4.1.0\")\nfor version in ghdl_versions:\n ENVS += [\n {\n \"lang\": \"vhdl\",\n \"sim\": \"ghdl\",\n \"sim-version\": version,\n \"os\": \"ubuntu-22.04\",\n \"python-version\": \"3.9\",\n \"group\": \"extended\",\n },\n ]\n\nicarus_versions = (\"v12_0\",)\nfor version in icarus_versions:\n ENVS += [\n {\n \"lang\": \"verilog\",\n \"sim\": \"icarus\",\n \"sim-version\": version,\n \"os\": \"ubuntu-22.04\",\n \"python-version\": \"3.9\",\n \"group\": \"extended\",\n },\n ]\n\nverilator_versions = (\"v5.036\", \"v5.038\", \"v5.040\", \"v5.042\", \"v5.044\")\nfor version in verilator_versions:\n ENVS += [\n {\n \"lang\": \"verilog\",\n \"sim\": \"verilator\",\n \"sim-version\": version,\n \"os\": \"ubuntu-22.04\",\n \"python-version\": \"3.9\",\n \"group\": \"extended\",\n },\n ]\n\nnvc_versions = (\n \"r1.11.0\",\n \"r1.12.2\",\n \"r1.13.3\",\n \"r1.14.2\",\n \"r1.15.2\",\n \"r1.16.0\", # First version with --preserve-case\n \"r1.17.1\",\n \"r1.18.2\",\n)\nfor version in nvc_versions:\n ENVS += [\n {\n \"lang\": \"vhdl\",\n \"sim\": \"nvc\",\n \"sim-version\": version,\n \"os\": \"ubuntu-22.04\",\n \"python-version\": \"3.9\",\n \"group\": \"extended\",\n },\n ]\n\n# Questa: test more versions as part of the extended tests.\nquesta_versions_novhpi = (\"2021.2\", \"2021.3\", \"2021.4\", \"2022.1\", \"2022.2\")\nquesta_versions_vhpi = (\n \"2022.3\",\n \"2022.4\",\n \"2023.1\",\n \"2023.2\",\n \"2023.4\",\n \"2024.1\",\n \"2024.2\",\n)\n\nfor version in questa_versions_novhpi + questa_versions_vhpi:\n ENVS += [\n {\n \"lang\": \"verilog\",\n \"sim\": \"questa\",\n \"sim-version\": f\"siemens/questa/{version}\",\n \"os\": \"ubuntu-22.04\",\n \"self-hosted\": True,\n \"python-version\": \"3.9\",\n \"group\": \"extended\",\n },\n {\n \"lang\": \"vhdl and fli\",\n \"sim\": \"questa\",\n \"sim-version\": f\"siemens/questa/{version}\",\n \"os\": \"ubuntu-22.04\",\n \"self-hosted\": True,\n \"python-version\": \"3.9\",\n \"group\": \"extended\",\n },\n ]\nfor version in questa_versions_vhpi:\n ENVS += [\n {\n \"lang\": \"vhdl and vhpi\",\n \"sim\": \"questa\",\n \"sim-version\": f\"siemens/questa/{version}\",\n \"os\": \"ubuntu-22.04\",\n \"self-hosted\": True,\n \"python-version\": \"3.9\",\n \"group\": \"extended\",\n },\n ]\n\n# Riviera-PRO: test more versions as part of the extended tests.\nriviera_versions = (\n \"2019.10\",\n \"2020.04\",\n \"2020.10\",\n \"2021.04\",\n \"2021.10\",\n \"2022.04\",\n \"2023.10\",\n \"2024.04\",\n \"2024.10\",\n \"2025.04\",\n)\nfor version in riviera_versions:\n ENVS += [\n {\n \"lang\": \"verilog\",\n \"sim\": \"riviera\",\n \"sim-version\": f\"aldec/rivierapro/{version}\",\n \"os\": \"ubuntu-22.04\",\n \"self-hosted\": True,\n \"python-version\": \"3.9\",\n \"group\": \"extended\",\n },\n {\n \"lang\": \"vhdl\",\n \"sim\": \"riviera\",\n \"sim-version\": f\"aldec/rivierapro/{version}\",\n \"os\": \"ubuntu-22.04\",\n \"self-hosted\": True,\n \"python-version\": \"3.9\",\n \"group\": \"extended\",\n },\n ]\n\n# Xcelium: test more versions as part of the extended tests.\nxcelium_versions = (\"2309\", \"2403\", \"2503\")\nfor version in xcelium_versions:\n ENVS += [\n {\n \"lang\": \"verilog\",\n \"sim\": \"xcelium\",\n \"sim-version\": f\"cadence/xcelium/{version}\",\n \"os\": \"ubuntu-22.04\",\n \"self-hosted\": True,\n \"python-version\": \"3.9\",\n \"group\": \"extended\",\n },\n {\n \"lang\": \"vhdl\",\n \"sim\": \"xcelium\",\n \"sim-version\": f\"cadence/xcelium/{version}\",\n \"os\": \"ubuntu-22.04\",\n \"self-hosted\": True,\n \"python-version\": \"3.9\",\n \"group\": \"extended\",\n },\n ]\n\n# VCS: test more versions as part of the extended tests.\nvcs_versions = (\"W-2024.09\",)\nfor version in vcs_versions:\n ENVS += [\n {\n \"lang\": \"verilog\",\n \"sim\": \"vcs\",\n \"sim-version\": f\"synopsys/vcs/{version}\",\n \"os\": \"ubuntu-22.04\",\n \"self-hosted\": True,\n \"python-version\": \"3.9\",\n \"group\": \"extended\",\n },\n # Don't run extended tests for VCS/VHDL yet until we have a version that\n # works.\n ]\n\n\ndef append_str_val(listref, my_list, key) -> None:\n if key not in my_list:\n return\n listref.append(str(my_list[key]))\n\n\ndef main() -> int:\n parser = argparse.ArgumentParser(description=__doc__)\n parser.add_argument(\"--group\")\n parser.add_argument(\"--output-format\", choices=(\"gha\", \"json\"), default=\"json\")\n parser.add_argument(\n \"--gha-output-file\",\n type=argparse.FileType(\"a\", encoding=\"utf-8\"),\n help=\"The $GITHUB_OUTPUT file.\",\n )\n\n args = parser.parse_args()\n\n if args.group is not None and args.group != \"\":\n selected_envs = [t for t in ENVS if \"group\" in t and t[\"group\"] == args.group]\n else:\n # Return all tasks if no group is selected.\n selected_envs = ENVS\n\n for env in selected_envs:\n # The \"runs-on\" job attribute is a string if we're using the GitHub-\n # provided hosted runners, or an array with special keys if we're\n # using self-hosted runners.\n if \"self-hosted\" in env and env[\"self-hosted\"] and \"runs-on\" not in env:\n env[\"runs-on\"] = [\"self-hosted\", f\"cocotb-private-{env['os']}\"]\n else:\n env[\"runs-on\"] = env[\"os\"]\n\n # Assemble the human-readable name of the job.\n name_parts = []\n append_str_val(name_parts, env, \"extra-name\")\n append_str_val(name_parts, env, \"sim\")\n if \"/\" in env[\"sim-version\"]:\n # Shorten versions like 'siemens/questa/2023.2' to '2023.2'.\n name_parts.append(env[\"sim-version\"].split(\"/\")[-1])\n else:\n name_parts.append(env[\"sim-version\"])\n append_str_val(name_parts, env, \"lang\")\n append_str_val(name_parts, env, \"os\")\n append_str_val(name_parts, env, \"python-version\")\n if env.get(\"may-fail\") is not None:\n name_parts.append(\"May fail\")\n\n env[\"name\"] = \"|\".join(name_parts)\n\n if args.output_format == \"gha\":\n # Output for GitHub Actions (GHA). Appends the configuration to\n # the file named in the \"--gha-output-file\" argument.\n\n assert args.gha_output_file is not None\n\n # The generated JSON output may not contain newlines to be parsed by GHA\n print(f\"envs={json.dumps(selected_envs)}\", file=args.gha_output_file)\n\n # Print the the selected environments for easier debugging.\n print(\"Generated the following test configurations:\")\n print(json.dumps(selected_envs, indent=2))\n elif args.output_format == \"json\":\n print(json.dumps(selected_envs, indent=2))\n else:\n assert False\n\n return 0\n\n\nif __name__ == \"__main__\":\n sys.exit(main())\n" }, { "path": ".github/issue_template.md", "content": "\n" }, { "path": ".github/workflows/backport.yml", "content": "# Copyright cocotb contributors\n# Licensed under the Revised BSD License, see LICENSE for details.\n# SPDX-License-Identifier: BSD-3-Clause\n\n# A workflow to automatically backport pull requests to a stable branch.\n#\n# This workflow uses the Backport CLI (https://github.com/sorenlouv/backport)\n# under the hood, which is configured in `.backportrc.json` in the repository\n# root.\n#\n# See https://github.com/sorenlouv/backport-github-action for documentation\n# on the used action.\n\nname: Backport PRs to stable branches\n\non:\n pull_request_target:\n # Run this workflow when a label on a PR is added, or if it's closed.\n types: [\"labeled\", \"closed\"]\n\njobs:\n backport:\n name: Backport PR\n if: github.event.pull_request.merged == true\n runs-on: ubuntu-latest\n steps:\n # Run the backport action only on PRs with one of the `backport-to:`\n # labels applied.\n #\n # Also update `branchLabelMapping` in `.backportrc.json` when changing the\n # label here.\n #\n # Implementation note: GitHub's contains() is matching the full string\n # when operating on an array (and startsWith() does not operate on arrays\n # at all). Do the label matching with jq instead.\n - name: Check for backport labels\n id: check_labels\n run: |-\n labels='${{ toJSON(github.event.pull_request.labels.*.name) }}'\n matched=$(echo $labels | jq '.|map(select(startswith(\"backport-to:\"))) | length')\n echo \"matched=$matched\"\n echo \"matched=$matched\" >> $GITHUB_OUTPUT\n\n - name: Backport Action\n if: fromJSON(steps.check_labels.outputs.matched) > 0\n uses: sorenlouv/backport-github-action@9460b7102fea25466026ce806c9ebf873ac48721 # v11.0.0\n with:\n # GITHUB_TOKEN is available by default, but the powers it has are\n # configurable. Follow the GitHub documentation at\n # https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository\n # to \"Allow GitHub Actions to create and approve pull requests\".\n github_token: ${{ secrets.GITHUB_TOKEN }}\n\n - name: Info log\n if: ${{ fromJSON(steps.check_labels.outputs.matched) > 0 && success() }}\n run: cat ~/.backport/backport.info.log\n\n - name: Debug log\n if: ${{ fromJSON(steps.check_labels.outputs.matched) > 0 && failure() }}\n run: cat ~/.backport/backport.debug.log\n" }, { "path": ".github/workflows/benchmark.yml", "content": "name: Performance Benchmark\n# adapted from https://github.com/benchmark-action/github-action-benchmark#charts-on-github-pages-1\n\nconcurrency:\n group: ${{ github.workflow }}-${{ github.event.number }}-${{ github.event.ref }}\n cancel-in-progress: ${{ !(contains(github.ref, 'release/') || contains(github.ref, 'master')) }}\n\non:\n push:\n branches:\n - master\n pull_request:\n branches:\n - master\n\njobs:\n\n tests:\n if: github.repository == 'cocotb/cocotb'\n name: Python ${{matrix.python-version}}\n runs-on: ubuntu-22.04\n\n strategy:\n fail-fast: false\n matrix:\n include:\n - python-version: 3.9\n\n steps:\n - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n - name: Set up Python ${{matrix.python-version}}\n uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0\n with:\n python-version: ${{matrix.python-version}}\n\n - name: Install Icarus Verilog\n run: |\n sudo apt-get install -y --no-install-recommends iverilog\n\n - name: Set up NVC (Ubuntu)\n run: |\n sudo apt-get install -y --no-install-recommends llvm-dev libdw-dev flex libzstd-dev pkg-config\n git clone https://github.com/nickg/nvc.git\n cd nvc\n git reset --hard r1.16.0\n ./autogen.sh\n mkdir build\n cd build\n ../configure\n make -j $(nproc)\n sudo make install\n\n - name: Run benchmark\n run: |\n pip install pytest pytest-benchmark\n pip install .\n pytest -c /dev/null tests/benchmarks --benchmark-json output.json\n\n # Pushing the benchmark requires elevated permissions to the\n # cocotb/cocotb-benchmark-results repository, which we only grant for\n # master builds, not for PR builds.\n - name: Generate a token to access cocotb/cocotb-benchmark-results\n if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}\n id: generate_token\n uses: actions/create-github-app-token@f8d387b68d61c58ab83c6c016672934102569859 # v3.0.0\n with:\n app-id: ${{ secrets.COCOTB_CI_REPOACCESS_APP_ID }}\n private-key: ${{ secrets.COCOTB_CI_REPOACCESS_APP_PRIVATE_KEY }}\n owner: ${{ github.repository_owner }}\n repositories: cocotb-benchmark-results\n\n - name: Store benchmark result\n if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}\n uses: benchmark-action/github-action-benchmark@a60cea5bc7b49e15c1f58f411161f99e0df48372 # v1.22.0\n continue-on-error: true\n with:\n tool: 'pytest'\n output-file-path: output.json\n alert-threshold: '120%'\n fail-on-alert: true\n github-token: ${{ steps.generate_token.outputs.token }}\n auto-push: true\n gh-repository: 'github.com/cocotb/cocotb-benchmark-results'\n" }, { "path": ".github/workflows/build-test-dev.yml", "content": "# Copyright cocotb contributors\n# Licensed under the Revised BSD License, see LICENSE for details.\n# SPDX-License-Identifier: BSD-3-Clause\n\nname: CI\n\nconcurrency:\n group: ${{ github.workflow }}-${{ github.event.number }}-${{ github.event.ref }}\n cancel-in-progress: ${{ !(contains(github.ref, 'release/') || contains(github.ref, 'master')) }}\n\non:\n # Run this workflow on every push to the master branch, or a stable branch.\n push:\n branches:\n - master\n - \"stable/**\"\n pull_request:\n branches:\n - master\n - 'stable/**'\n paths-ignore:\n # Skip running tests for changes only in:\n # Documentation\n - 'docs/**'\n # Dot-files not related to running tests\n - '.devcontainer/**'\n - '.backportrc.json'\n - '.clang-format'\n - '.git-blame-ignore-revs'\n - '.gitignore'\n - '.pre-commit-config.yaml'\n - '.readthedocs.yml'\n # Information files\n - 'LICENSE'\n - 'README.md'\n - 'CONTRIBUTING.md'\n - 'MANIFEST.in'\n # Github files that aren't related to testing\n - '.github/issue_template.md'\n - '.github/PULL_REQUEST_TEMPLATE.md'\n - '.github/workflows/backport.yml'\n - '.github/workflows/benchmark.yml'\n - '.github/workflows/ecosystem-compat.yml'\n - '.github/workflows/experimental.yml'\n - '.github/workflows/extended.yml'\n - '.github/workflows/stale.yml'\n\njobs:\n test_dev:\n name: Regression Tests\n uses: ./.github/workflows/regression-tests.yml\n with:\n test_task: dev_test\n collect_coverage: true\n group: ci-free\n\n test_dev_licensed:\n if: github.repository == 'cocotb/cocotb'\n name: Regression Tests\n uses: ./.github/workflows/regression-tests.yml\n with:\n test_task: dev_test\n collect_coverage: true\n group: ci-licensed\n" }, { "path": ".github/workflows/build-test-release.yml", "content": "# Copyright cocotb contributors\n# Licensed under the Revised BSD License, see LICENSE for details.\n# SPDX-License-Identifier: BSD-3-Clause\n\n#\n# DO NOT RENAME THIS FILE!\n# PyPi uploads use OIDC, aka Trusted Publishing, to avoid the need for API keys.\n# https://pypi.org/manage/project/cocotb/settings/publishing/ is configured to\n# allow uploads from the cocotb GitHub project and this exact file name.\n#\n\nname: Release\n\nconcurrency:\n group: ${{ github.workflow }}-${{ github.event.number }}-${{ github.event.ref }}\n cancel-in-progress: ${{ !(contains(github.ref, 'release/') || contains(github.ref, 'master')) }}\n\non:\n # Run this workflow on every push to master or to a stable branch.\n push:\n branches:\n - master\n - \"stable/**\"\n tags:\n - 'v*'\n\njobs:\n build_release:\n name: Build distribution on ${{ matrix.os }}\n runs-on: ${{ matrix.os }}\n strategy:\n fail-fast: false # Keep going even if one matrix build fails.\n matrix:\n os:\n - ubuntu-22.04\n - windows-2022\n - macos-15-intel # x86_64\n - macos-14 # ARM64\n steps:\n - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n - uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0\n with:\n python-version: \"3.12\"\n - name: Install uv\n uses: astral-sh/setup-uv@v7\n - name: Install nox\n run: python3 -m pip install nox nox-uv\n\n # Use the cibuildwheel configuration inside nox, instead of the\n # cibuildwheel GitHub Action, to make the process easy to reproduce\n # locally.\n - name: Build cocotb release\n run: |\n nox -s release_clean\n nox -s release_build\n\n - uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0\n with:\n name: cocotb-dist-${{ matrix.os }}\n path: |\n dist/*.whl\n dist/*.tar.gz\n\n # This tests both the sdist and wheel builds in separate venvs back to back with just the pytest tests.\n test_release:\n name: Regression Tests\n needs: build_release\n uses: ./.github/workflows/regression-tests.yml\n with:\n test_task: release_test\n download_artifacts: true\n group: ci-free\n\n test_release_licensed:\n name: Regression Tests\n needs: build_release\n uses: ./.github/workflows/regression-tests.yml\n with:\n test_task: release_test\n download_artifacts: true\n group: ci-licensed\n\n deploy_pypi:\n name: Deploy to pypi.org\n needs:\n - test_release\n - test_release_licensed\n permissions:\n id-token: write\n runs-on: ubuntu-22.04\n # Only upload tagged releases.\n if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')\n steps:\n - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n - uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0\n with:\n python-version: \"3.12\"\n - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n with:\n path: dist\n pattern: cocotb-dist-*\n merge-multiple: true\n - name: Publish distribution to PyPI\n uses: pypa/gh-action-pypi-publish@ed0c53931b1dc9bd32cbe73a98c7f6766f8a527e # v1.13.0\n # Authentication to PyPi is done through OIDC (\"Trusted Publishing\").\n" }, { "path": ".github/workflows/ecosystem-compat.yml", "content": "# Copyright cocotb contributors\n# Licensed under the Revised BSD License, see LICENSE for details.\n# SPDX-License-Identifier: BSD-3-Clause\n\n# Tests to ensure that projects depending on cocotb continue to work with the\n# latest development version of cocotb.\n#\n# Generally, we test the development version of cocotb against supported,\n# released versions of the other projects. (It is expected that the projects\n# themselves test their in-development code against the released version of\n# cocotb.)\n\nname: Ecosystem compatibility tests\n\non:\n # Run daily at midnight (UTC).\n schedule:\n - cron: '0 0 * * *'\n # Allow triggering a CI run from the web UI.\n workflow_dispatch:\n\njobs:\n cocotb-coverage:\n if: github.repository == 'cocotb/cocotb'\n name: Test cocotb-coverage\n runs-on: ubuntu-24.04\n strategy:\n matrix:\n cocotb-coverage-version: [ \"2.0\" ]\n\n steps:\n - name: Set up Python\n uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0\n with:\n python-version: \"3.11\"\n\n - name: Install Icarus Verilog\n run: sudo apt-get install -y --no-install-recommends iverilog\n\n - name: Checkout cocotb-coverage repository\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n with:\n repository: mciepluc/cocotb-coverage\n path: cocotb-coverage\n ref: v${{ matrix.cocotb-coverage-version }}\n\n - name: Install the release version of cocotb-coverage\n run: pip install ./cocotb-coverage\n\n - name: Install the development version of cocotb\n run: pip install git+https://github.com/cocotb/cocotb.git\n\n - name: Run tests\n if: ${{ matrix.cocotb-coverage-version }} == '2.0'\n env:\n SIM: icarus\n TOPLEVEL_LANG: verilog\n run: |\n pip install pytest cocotb-bus numpy\n cd cocotb-coverage\n make -k -C tests\n make -C examples/fifo/tests\n make -C examples/pkt_switch/tests\n\n pyuvm:\n if: github.repository == 'cocotb/cocotb'\n name: Test pyuvm\n runs-on: ubuntu-24.04\n strategy:\n matrix:\n pyuvm-version: [ \"4.0.1\" ]\n\n steps:\n - name: Set up Python\n uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0\n with:\n python-version: \"3.11\"\n\n - name: Install Icarus Verilog\n run: sudo apt-get install -y --no-install-recommends iverilog\n\n - name: Install NVC\n uses: nickg/setup-nvc@v1\n with:\n version: r1.19.3\n\n - name: Checkout pyuvm repository\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n with:\n repository: pyuvm/pyuvm\n path: pyuvm\n ref: ${{ matrix.pyuvm-version }}\n\n - name: Install pyuvm\n run: pip install ./pyuvm\n\n - name: Install the development version of cocotb\n run: pip install git+https://github.com/cocotb/cocotb.git\n\n - name: Run tests\n if: ${{ matrix.pyuvm-version }} == '4.0.1'\n working-directory: pyuvm\n env:\n VERILOG_SIM: icarus\n VHDL_SIM: nvc\n run: |\n pip install pytest\n pytest\n make cocotb_tests\n\n forastero:\n if: github.repository == 'cocotb/cocotb'\n name: Test Forastero\n runs-on: ubuntu-24.04\n strategy:\n matrix:\n forastero-version: [ \"1.2.1\" ]\n\n steps:\n - name: Set up Python\n uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0\n with:\n python-version: \"3.13\"\n\n - name: Install Icarus Verilog\n run: sudo apt-get install -y --no-install-recommends iverilog\n\n - name: Checkout Forastero repository\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n with:\n repository: intuity/forastero\n path: forastero\n ref: ${{ matrix.forastero-version }}\n\n - name: Install the release version of Forastero\n run: pip install ./forastero\n\n - name: Install the development version of cocotb\n run: pip install git+https://github.com/cocotb/cocotb.git\n\n - name: Run tests\n working-directory: forastero\n env:\n SIM: icarus\n TOPLEVEL_LANG: verilog\n run: |\n make -C examples/arbiter_strict\n make -C examples/arbiter_window\n" }, { "path": ".github/workflows/experimental.yml", "content": "# Copyright cocotb contributors\n# Licensed under the Revised BSD License, see LICENSE for details.\n# SPDX-License-Identifier: BSD-3-Clause\n\n# A workflow where the tool is the moving target, or the tool is known to be\n# not fully supported by cocotb, but we still want to see how its support\n# evolves over time.\n\nname: Test experimental tool versions\n\non:\n # Run every Monday at 2am (UTC).\n schedule:\n - cron: '0 2 * * 1'\n # Allow triggering a CI run from the web UI.\n workflow_dispatch:\n\njobs:\n test_dev:\n if: github.repository == 'cocotb/cocotb'\n name: Regression Tests\n uses: ./.github/workflows/regression-tests.yml\n with:\n test_task: dev_test\n group: experimental\n" }, { "path": ".github/workflows/extended.yml", "content": "# Copyright cocotb contributors\n# Licensed under the Revised BSD License, see LICENSE for details.\n# SPDX-License-Identifier: BSD-3-Clause\n\n# Run tests against an extended set of simulator (versions).\n\nname: Test extended tool versions\n\non:\n # Run every Sunday at 2am (UTC).\n schedule:\n - cron: '0 2 * * 0'\n # Allow triggering a CI run from the web UI.\n workflow_dispatch:\n\njobs:\n test_dev:\n if: github.repository == 'cocotb/cocotb'\n name: Regression Tests\n uses: ./.github/workflows/regression-tests.yml\n with:\n test_task: dev_test\n group: extended\n max_parallel: 5\n" }, { "path": ".github/workflows/regression-tests.yml", "content": "# Copyright cocotb contributors\n# Licensed under the Revised BSD License, see LICENSE for details.\n# SPDX-License-Identifier: BSD-3-Clause\nname: Regression Tests\n\non:\n workflow_call:\n inputs:\n test_task:\n required: true\n type: string\n default: dev_test\n collect_coverage:\n required: false\n type: boolean\n default: false\n download_artifacts:\n required: false\n type: boolean\n default: false\n group:\n required: false\n type: string\n default: \"ci-free\"\n description: Group of environments to run the tests against. Leave empty to run them all.\n max_parallel:\n required: false\n type: number\n default: 0\n description: Maximum number of parallel matrix jobs\n setup_python:\n required: false\n type: string\n description: Which Github Action to setup Python\n\njobs:\n\n generate_envs:\n runs-on: ubuntu-latest\n name: Generate a list of environments to run tests against\n steps:\n - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n - run: ./.github/generate-envs.py --output-format=gha --gha-output-file=\"$GITHUB_OUTPUT\" --group=\"${{inputs.group}}\"\n id: run_generate_script\n outputs:\n envs: ${{ steps.run_generate_script.outputs.envs }}\n\n tests:\n\n needs: generate_envs\n\n name: ${{matrix.name}}\n runs-on: ${{matrix.runs-on}}\n timeout-minutes: 60\n\n env:\n SIM: ${{matrix.sim}}\n TOPLEVEL_LANG: ${{matrix.lang}}\n CXX: ${{matrix.cxx || 'g++'}}\n CC: ${{matrix.cc || 'gcc'}}\n OS: ${{matrix.os}}\n PYTHON_VERSION: ${{matrix.python-version}}\n\n strategy:\n fail-fast: false\n matrix:\n include: ${{ fromJson(needs.generate_envs.outputs.envs) }}\n max-parallel: ${{ inputs.max_parallel }}\n\n steps:\n - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n with:\n # GitHub PR's create a merge commit, and Actions are run on that commit.\n # Codecov's uploader needs the previous commit (tip of PR branch) to associate coverage correctly.\n # A fetch depth of 2 provides enough information without fetching the entire history.\n fetch-depth: 2\n\n - name: setup ccache\n uses: hendrikmuhs/ccache-action@33522472633dbd32578e909b315f5ee43ba878ce # v1.2.22\n if: ${{ startsWith(matrix.os, 'ubuntu') }}\n with:\n key: ${{ matrix.os }}-${{matrix.cc || 'gcc'}}\n - name: setup ccache path\n if: ${{ startsWith(matrix.os, 'ubuntu') }}\n run: |\n echo \"/usr/lib/ccache:/usr/local/opt/ccache/libexec\" >> $GITHUB_PATH\n\n # Use the ccache cache for all compilers.\n\n - name: Update package index (ubuntu)\n if: startsWith(matrix.os, 'ubuntu')\n run: sudo apt-get update\n\n # Download distribution artifacts (if any).\n - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n if: ${{ inputs.download_artifacts }}\n with:\n path: dist\n pattern: cocotb-dist-*\n merge-multiple: true\n\n # Install Python\n - name: Set up Python ${{matrix.python-version}} (setup-python)\n if: matrix.setup_python == ''\n uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0\n with:\n python-version: ${{matrix.python-version}}\n allow-prereleases: true\n\n - name: Install msys2 (Windows)\n if: startsWith(matrix.os, 'windows') && matrix.sim == 'icarus'\n uses: msys2/setup-msys2@v2\n with:\n msystem: MINGW64\n update: true\n install: >\n base-devel\n gperf\n mingw-w64-x86_64-toolchain\n\n # Install\n - name: Install XML-dependencies for Python 3.14\n if: startsWith(matrix.python-version, '3.14') && startsWith(matrix.os, 'ubuntu')\n run: sudo apt-get install -y --no-install-recommends libxml2-dev libxslt-dev\n # Run tests that don't need a simulator.\n - name: Install uv\n uses: astral-sh/setup-uv@v7\n - name: Install Python testing dependencies\n run: |\n pip install nox nox-uv\n\n # Install Icarus\n - name: Set up Icarus (Ubuntu - apt)\n if: startsWith(matrix.os, 'ubuntu') && matrix.sim == 'icarus' && matrix.sim-version == 'apt'\n run: |\n sudo apt-get install -y --no-install-recommends iverilog\n - name: Set up Icarus (Ubuntu - source)\n if: startsWith(matrix.os, 'ubuntu') && matrix.sim == 'icarus' && matrix.sim-version != 'apt'\n run: |\n sudo apt-get install -y --no-install-recommends g++ gperf flex bison make autoconf\n git clone https://github.com/steveicarus/iverilog.git\n cd iverilog\n git reset --hard ${{matrix.sim-version}}\n bash ./autoconf.sh\n # Icarus 11.0 fails to configure under Ubuntu 22.04 without explicitly\n # telling it where to find the preprocessor.\n CXXCPP=/usr/bin/cpp bash ./configure\n make -j $(nproc)\n sudo make install\n - name: Set up Icarus (Windows - source - pt. 1)\n if: startsWith(matrix.os, 'windows') && matrix.sim == 'icarus'\n run: |\n git config --global core.autocrlf input\n git clone https://github.com/steveicarus/iverilog.git\n cd iverilog\n git reset --hard ${{matrix.sim-version}}\n - name: Set up Icarus (Windows - source - pt. 2)\n if: startsWith(matrix.os, 'windows') && matrix.sim == 'icarus'\n timeout-minutes: 10\n shell: msys2 {0}\n env:\n MINGW_ARCH: MINGW64\n run: |\n cd iverilog\n cd msys2\n makepkg-mingw --noconfirm --noprogressbar -sCLf\n - name: Set up Icarus (Windows - source - pt. 3)\n if: startsWith(matrix.os, 'windows') && matrix.sim == 'icarus'\n timeout-minutes: 10\n shell: msys2 {0}\n env:\n MINGW_ARCH: MINGW64\n run: |\n pacman -U --noconfirm iverilog/msys2/*.zst\n echo \"$(dirname $(cygpath -m $(which iverilog)))\" >> $GITHUB_PATH\n - name: Set up Icarus (MacOS - homebrew --HEAD)\n if: startsWith(matrix.os, 'macos') && matrix.sim == 'icarus' && matrix.sim-version == 'homebrew-HEAD'\n run: |\n brew install icarus-verilog --HEAD\n - name: Set up Icarus (MacOS - homebrew)\n if: startsWith(matrix.os, 'macos') && matrix.sim == 'icarus' && matrix.sim-version == 'homebrew-stable'\n run: |\n brew install icarus-verilog\n\n # Install GHDL\n - name: Set up GHDL (Ubuntu)\n if: startsWith(matrix.os, 'ubuntu') && matrix.sim == 'ghdl'\n run: |\n sudo apt-get install -y --no-install-recommends gnat\n git clone https://github.com/ghdl/ghdl.git\n cd ghdl\n git reset --hard ${{matrix.sim-version}}\n mkdir build\n cd build\n ../configure\n make -j $(nproc)\n sudo make install\n\n # Install NVC\n - name: Set up NVC (Ubuntu, release)\n if: startsWith(matrix.os, 'ubuntu') && matrix.sim == 'nvc' && startsWith(matrix.sim-version, 'r') && matrix.cc != 'clang'\n uses: nickg/setup-nvc@v1\n with:\n version: ${{matrix.sim-version}}\n - name: Set up NVC (Windows, release)\n if: startsWith(matrix.os, 'windows') && matrix.sim == 'nvc'\n uses: nickg/setup-nvc@v1\n with:\n version: ${{matrix.sim-version}}\n - name: Set up NVC (Ubuntu, source)\n if: startsWith(matrix.os, 'ubuntu') && matrix.sim == 'nvc' && (!startsWith(matrix.sim-version, 'r') || matrix.cc == 'clang')\n run: |\n sudo apt-get install -y --no-install-recommends llvm-dev libdw-dev flex\n git clone --depth=1 --no-single-branch https://github.com/nickg/nvc.git\n cd nvc\n git reset --hard ${{matrix.sim-version}}\n ./autogen.sh\n mkdir build\n cd build\n ../configure\n make -j $(nproc)\n sudo make install\n\n # Install Verilator (Linux)\n - name: Set up Verilator (Ubuntu - source)\n if: startsWith(matrix.os, 'ubuntu') && matrix.sim == 'verilator'\n run: |\n sudo apt-get install -y --no-install-recommends help2man make g++ perl python3 autoconf flex bison libfl2 libfl-dev zlib1g zlib1g-dev\n git clone https://github.com/verilator/verilator.git\n cd verilator\n git reset --hard ${{matrix.sim-version}}\n autoconf\n ./configure\n make -j $(nproc)\n sudo make install\n\n # Install Verilator (MacOS)\n - name: Set up Verilator (MacOS - source)\n if: startsWith(matrix.os, 'macos') && matrix.sim == 'verilator'\n run: |\n brew install autoconf help2man\n git clone https://github.com/verilator/verilator.git\n cd verilator\n git reset --hard ${{matrix.sim-version}}\n autoconf\n ./configure\n make -j $(sysctl -n hw.logicalcpu)\n sudo make install\n\n # Windows Testing\n - name: Test (Windows)\n if: startsWith(matrix.os, 'windows')\n id: windowstesting\n continue-on-error: ${{matrix.may-fail || false}}\n run: |\n nox -k \"${{ inputs.test_task }} and ${{ matrix.sim }} and ${{ matrix.lang }}\"\n env:\n COCOTB_ANSI_OUTPUT: 1\n COCOTB_CI_SKIP_MAKE: 1\n\n # Ubuntu / MacOS Testing\n - name: Install cocotb build dependencies (Ubuntu - g++)\n if: startsWith(matrix.os, 'ubuntu') && (!matrix.cxx || matrix.cxx == 'g++')\n run: |\n sudo apt-get install g++\n - name: Install cocotb build dependencies (Ubuntu - clang++)\n if: startsWith(matrix.os, 'ubuntu') && matrix.cxx == 'clang++'\n run: |\n sudo apt-get install clang llvm\n - name: Install cocotb build dependencies (MacOS)\n if: startsWith(matrix.os, 'macos')\n run: |\n g++ --version\n - name: Test (Ubuntu, MacOS)\n id: unixtesting\n if: startsWith(matrix.os, 'ubuntu') || startsWith(matrix.os, 'macos')\n continue-on-error: ${{matrix.may-fail || false}}\n timeout-minutes: 40\n run: |\n if [ \"${{matrix.self-hosted}}\" == \"true\" ]; then\n module load \"${{ matrix.sim-version }}\"\n fi\n nox -k \"${{ inputs.test_task }} and ${{ matrix.sim }} and ${{ matrix.lang }}\"\n env:\n COCOTB_ANSI_OUTPUT: 1\n\n # codecov\n - name: Combine and report coverage\n if: inputs.collect_coverage && matrix.cxx != 'clang++'\n run: nox -s dev_coverage_report\n - name: Combine and report coverage (clang)\n if: inputs.collect_coverage && matrix.cxx == 'clang++'\n run: nox -s dev_coverage_report -- 'llvm-cov gcov'\n\n - name: Upload to codecov\n if: inputs.collect_coverage\n uses: codecov/codecov-action@57e3a136b779b570ffcdbf80b3bdc90e7fab3de2 # v6.0.0\n env:\n # https://community.codecov.com/t/upload-issues-unable-to-locate-build-via-github-actions-api/3954\n CODECOV_TOKEN: 669f2048-851e-479e-a618-8fa64f3736cc\n with:\n files: .python_coverage.xml,.cpp_coverage.xml\n name: ${{ matrix.name }}\n env_vars: SIM,TOPLEVEL_LANG,CXX,OS,PYTHON_VERSION\n verbose: true\n" }, { "path": ".github/workflows/stale.yml", "content": "# Copyright cocotb contributors\n# Licensed under the Revised BSD License, see LICENSE for details.\n# SPDX-License-Identifier: BSD-3-Clause\n\nname: \"Stale Questions\"\non:\n schedule:\n - cron: \"00 02 * * *\"\n\njobs:\n stale:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/stale@b5d41d4e1d5dceea10e7104786b73624c18a190f # v10.2.0\n with:\n repo-token: ${{secrets.GITHUB_TOKEN}}\n days-before-stale: 30\n days-before-close: 7\n stale-issue-message: >\n Has your question been resolved? If so please close this issue.\n If it has not been resolved, you may need to provide more information.\n If no more activity on this issue occurs in 7 days, it will be closed.\n stale-issue-label: \"status:stale\"\n stale-pr-message: >\n Are you still actively working on this pull request?\n You may have requested changes that need to be addressed.\n If the maintainers aren't being timely with a review, we apologize.\n Please bump this pull request to keep it alive.\n If no more activity on this pull request occurs in 7 days, it will be closed.\n stale-pr-label: \"status:stale\"\n any-of-labels: \"type:question,status:close?,status:needs-info\"\n operations-per-run: 30\n" }, { "path": ".gitignore", "content": "*.py[cod]\n\n# C extensions\n*.so\n*.dll\n\n# C objects\n*.o\n\n# Python and C++ code coverage\n.coverage\n.coverage.cocotb\n*.gcno\n*.gcda\n*.gcov\n*.xml\n\n# Packaging\n*.egg\n*.egg-info\ndist\nbuild\neggs\nparts\nsdist\nobj\ndevelop-eggs\n.installed.cfg\n__pycache__\n.tox\n.nox\n.eggs\n\n# Vim tmp files\n*.swp\n*~\n\n# VSCode project files\n.vscode/\n*.code-workspace\n\n# Emacs tmp files\n\\#*\\#\n\\.\\#*\n\n# Mergetool tmp files\n*.orig\n*.bak\n\n# Waveforms\n*.vcd\n*.fst\n*.fst.hier\n\n# Results\nresults.xml\ncombined_results.xml\n\n# Debuggers\n.gdb_history\n\n# VCS files\n*.tab\nsim_build\nucli.key\n\n# Pytest\n.pytest_cache\n\n# Cadence Incisive/Xcelium\n*.elog\nirun.log\nxrun.log\nirun.key\nxrun.key\nirun.history\nxrun.history\nINCA_libs\nxcelium.d\nncelab_*.err\nxmelab_*.err\nncsim_*.err\nxmsim_*.err\nbpad_*.err\n.bpad/\n.simvision/\nwaves.shm/\n\n# Interface libraries built on setup\nsrc/cocotb/libs\npip-wheel-metadata/\n\n# Mentor Modelsim/Questa\ntests/test_cases/*/modelsim.ini\ntests/test_cases/*/transcript\ntests/test_cases/*/qwave.db\ntests/test_cases/*/design.bin\nexamples/*/tests/modelsim.ini\nexamples/*/tests/transcript\nexamples/*/tests/qwave.db\nexamples/*/tests/design.bin\n*.wlf\nqrun.log\nvisualizer.log\n\n# Riviera\ntests/test_cases/*/library.cfg\ntests/test_cases/*/dataset.asdb\ntests/test_cases/*/compile\nexamples/*/tests/library.cfg\nexamples/*/tests/dataset.asdb\nexamples/*/tests/compile\n\n# Tachyon DA CVC\ntests/test_cases/*/verilog.log\nexamples/*/tests/verilog.log\n\n# DSim\ndsim*\nmetrics.db\n\n# Build artifacts\n/dist/\n\n# clangd\ncompile_commands.json\ncompile_commands.*.json\n.cache/\n" }, { "path": ".pre-commit-config.yaml", "content": "# Copyright cocotb contributors\n# Licensed under the Revised BSD License, see LICENSE for details.\n# SPDX-License-Identifier: BSD-3-Clause\n\nexclude: \"^.*/_vendor/\"\nrepos:\n# ruff with --fix should run before other formatting tools\n- repo: https://github.com/astral-sh/ruff-pre-commit\n rev: \"v0.15.10\"\n hooks:\n # Run the linter.\n - id: \"ruff\"\n args:\n - \"--fix\"\n - \"--exit-non-zero-on-fix\"\n # Run the formatter.\n - id: ruff-format\n\n- repo: \"https://github.com/pre-commit/mirrors-clang-format\"\n rev: \"v22.1.3\"\n hooks:\n - id: \"clang-format\"\n exclude: \"^src/cocotb/share/include/(sv_vpi|vhpi|vpi)_user(_ext)?.h\"\n types_or: [c, c++]\n\n- repo: \"https://github.com/pre-commit/pre-commit-hooks\"\n rev: \"v6.0.0\"\n hooks:\n - id: \"trailing-whitespace\"\n - id: \"mixed-line-ending\"\n args:\n - \"--fix=lf\"\n - id: \"end-of-file-fixer\"\n exclude: \"^docs/source/diagrams/(svg|xml)/\"\n\n- repo: https://github.com/henryiii/validate-pyproject-schema-store\n rev: \"2026.04.11\"\n hooks:\n - id: validate-pyproject\n files: pyproject.toml\n\n- repo: local\n hooks:\n - id: \"git-diff\"\n name: git diff\n entry: git diff --exit-code\n language: system\n pass_filenames: false\n always_run: true\n\n- repo: https://github.com/codespell-project/codespell\n rev: v2.4.2\n hooks:\n - id: codespell\n additional_dependencies:\n - tomli\n\n- repo: https://github.com/pre-commit/mirrors-mypy\n rev: v1.19.1\n hooks:\n - id: mypy\n args: [--follow-imports=silent]\n additional_dependencies:\n - pytest\n - pluggy\n - coverage\n - nox\n - nox-uv\n files: ^(src/cocotb/|src/pygpi/|noxfile\\.py|src/cocotb_tools/pytest/)\n\n- repo: https://github.com/astral-sh/uv-pre-commit\n rev: 0.11.6\n hooks:\n - id: uv-lock\n\nci:\n autofix_prs: false\n" }, { "path": ".readthedocs.yml", "content": "# .readthedocs.yml\n# Read the Docs configuration file\n# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details\n\nversion: 2\n\nbuild:\n os: ubuntu-22.04\n tools:\n python: \"3.12\"\n apt_packages:\n - graphviz\n jobs:\n create_environment:\n - asdf plugin add uv\n - asdf install uv latest\n - asdf global uv latest\n - UV_PROJECT_ENVIRONMENT=$READTHEDOCS_VIRTUALENV_PATH uv sync --all-extras --group docs\n install:\n - \"true\"\n\nsphinx:\n configuration: docs/source/conf.py\n" }, { "path": "CONTRIBUTING.md", "content": "# cocotb Contribution Guidelines\n\ncocotb welcomes contributions from anyone!\nPlease have a look at the [Development & Community](https://docs.cocotb.org/en/development/contributing.html) section of the cocotb documentation for an in-depth contribution guide.\n" }, { "path": "LICENSE", "content": "Copyright cocotb contributors\nCopyright (c) 2013 Potential Ventures Ltd\nCopyright (c) 2013 SolarFlare Communications Inc\nAll rights reserved.\n\nRedistribution and use in source and binary forms, with or without\nmodification, are permitted provided that the following conditions are met:\n\n1. Redistributions of source code must retain the above copyright notice, this\n list of conditions and the following disclaimer.\n\n2. Redistributions in binary form must reproduce the above copyright notice,\n this list of conditions and the following disclaimer in the documentation\n and/or other materials provided with the distribution.\n\n3. Neither the name of the copyright holder nor the names of its\n contributors may be used to endorse or promote products derived from\n this software without specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND\nANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\nWARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\nDISCLAIMED. IN NO EVENT SHALL POTENTIAL VENTURES LTD BE LIABLE FOR ANY\nDIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES\n(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\nLOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND\nON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n" }, { "path": "MANIFEST.in", "content": "recursive-include src/cocotb/share *\nrecursive-include src/cocotb/_vendor *\ninclude README.md\ninclude LICENSE\ninclude cocotb_build_libs.py\n" }, { "path": "Makefile", "content": "# Copyright cocotb contributors\n# Copyright (c) 2013 Potential Ventures Ltd\n# Copyright (c) 2013 SolarFlare Communications Inc\n# Licensed under the Revised BSD License, see LICENSE for details.\n# SPDX-License-Identifier: BSD-3-Clause\n\nREPO_ROOT := $(shell dirname $(realpath $(firstword $(MAKEFILE_LIST))))\n\n.PHONY: all\nall: test\n\n.PHONY: clean\nclean:\n\t-@find . -name \"obj\" -exec rm -rf {} +\n\t-@find . -name \"*.pyc\" -delete\n\t-@find . -name \"*results.xml\" -delete\n\t$(MAKE) -C examples clean\n\t$(MAKE) -C tests clean\n\n.PHONY: do_tests\ndo_tests::\n\t$(MAKE) -C tests\ndo_tests::\n\t$(MAKE) -C examples\n\n# For Jenkins we use the exit code to detect compile errors or catastrophic\n# failures and the XML to track test results\n.PHONY: jenkins\njenkins: do_tests\n\tpython -m cocotb_tools.combine_results --repo-root $(REPO_ROOT) --suppress_rc --testsuites_name=cocotb_regression\n\n# By default want the exit code to indicate the test results\n.PHONY: test\ntest:\n\t$(MAKE) do_tests; ret=$$?; python -m cocotb_tools.combine_results --repo-root $(REPO_ROOT) && exit $$ret\n\nCOCOTB_MAKEFILES_DIR = $(realpath $(shell cocotb-config --makefiles))\nAVAILABLE_SIMULATORS = $(patsubst .%,%,$(suffix $(wildcard $(COCOTB_MAKEFILES_DIR)/simulators/Makefile.*)))\n\n.PHONY: help\nhelp:\n\t@echo \"\"\n\t@echo \"This cocotb makefile has the following targets\"\n\t@echo \"\"\n\t@echo \"all, test - run regression producing combined_results.xml\"\n\t@echo \" (return error code produced by sub-makes)\"\n\t@echo \"jenkins - run regression producing combined_results.xml\"\n\t@echo \" (return error code 1 if any failure was found)\"\n\t@echo \"clean - remove build directory and all simulation artefacts\"\n\t@echo \"\"\n\t@echo \"The default simulator is Icarus Verilog.\"\n\t@echo \"To use another, set the environment variable SIM as below.\"\n\t@echo \"Available simulators:\"\n\t@for X in $(sort $(AVAILABLE_SIMULATORS)); do \\\n\t\techo export SIM=$$X; \\\n\tdone\n\t@echo \"\"\n" }, { "path": "README.md", "content": "**cocotb** is a framework empowering users to write VHDL and Verilog testbenches in Python.\n\n[![Documentation Status](https://readthedocs.org/projects/cocotb/badge/?version=development)](https://docs.cocotb.org/en/stable/)\n[![CI](https://github.com/cocotb/cocotb/actions/workflows/build-test-dev.yml/badge.svg?branch=master)](https://github.com/cocotb/cocotb/actions/workflows/build-test-dev.yml)\n[![PyPI](https://img.shields.io/pypi/dm/cocotb.svg?label=PyPI%20downloads)](https://pypi.org/project/cocotb/)\n[![codecov](https://codecov.io/gh/cocotb/cocotb/branch/master/graph/badge.svg)](https://codecov.io/gh/cocotb/cocotb)\n\n* Check out the [tutorial](https://docs.cocotb.org/en/stable/quickstart.html)\n* Read the [docs](https://docs.cocotb.org/en/stable/)\n* Find more info in the [wiki](https://github.com/cocotb/cocotb/wiki)\n* Discover [useful extensions](https://github.com/cocotb/cocotb/wiki/Further-Resources#utility-libraries-and-frameworks)\n* Join the discussion in the [Gitter chat room](https://gitter.im/cocotb/Lobby)\n* [Ask a question](https://github.com/cocotb/cocotb/discussions)\n* [Raise a bug / request an enhancement](https://github.com/cocotb/cocotb/issues/new)\n" }, { "path": "cocotb_build_libs.py", "content": "# Copyright cocotb contributors\n# Licensed under the Revised BSD License, see LICENSE for details.\n# SPDX-License-Identifier: BSD-3-Clause\nfrom __future__ import annotations\n\nimport distutils\nimport logging\nimport os\nimport subprocess\nimport sys\nimport sysconfig\nimport textwrap\nfrom distutils.ccompiler import get_default_compiler\nfrom distutils.file_util import copy_file\n\nfrom setuptools import Extension\nfrom setuptools.command.build_ext import build_ext as _build_ext\n\nlogger = logging.getLogger(__name__)\ncocotb_share_dir = os.path.abspath(\n os.path.join(os.path.dirname(__file__), \"src\", \"cocotb\", \"share\")\n)\n_base_warns = [\n \"-Wall\",\n \"-Wextra\",\n \"-Wcast-qual\",\n \"-Wwrite-strings\",\n \"-Wconversion\",\n # -Wno-missing-field-initializers is required on GCC 4.x to prevent a\n # spurious warning `error: missing initializer for member ...` when\n # compiling `PyTypeObject type = {};` in `simulatormodule.cpp`.\n # (See https://gcc.gnu.org/bugzilla/show_bug.cgi?id=36750.) This flag can be\n # removed once we require later GCC versions.\n \"-Wno-missing-field-initializers\",\n \"-Werror=shadow\",\n]\n_ccx_warns = [*_base_warns, \"-Wnon-virtual-dtor\", \"-Woverloaded-virtual\"]\n_extra_cxx_compile_args = [\n \"-std=c++11\",\n \"-fvisibility=hidden\",\n \"-fvisibility-inlines-hidden\",\n *_ccx_warns,\n]\nif os.name != \"nt\":\n _extra_cxx_compile_args += [\"-flto\"]\n\n_extra_cxx_compile_args_msvc = [\"/permissive-\"]\n\n# Make PRI* format macros available with C++11 compiler but older libc, e.g. on RHEL6.\n_extra_defines = [(\"__STDC_FORMAT_MACROS\", \"\")]\n\n\ndef create_sxs_assembly_manifest(\n name: str, filename: str, libraries: list[str], dependency_only=False\n) -> str:\n \"\"\"\n Create side-by-side (sxs) assembly manifest\n\n It contains dependencies to other assemblies (in our case the assemblies are equal to the other libraries).\n For more details see:\n - https://docs.microsoft.com/en-us/windows/win32/sbscs/assembly-manifests\n - https://docs.microsoft.com/en-us/windows/win32/sbscs/using-side-by-side-assemblies\n\n Args:\n name: The name of the assembly for which the manifest is generated, e.g. ``libgpi``.\n filename: The filename of the library, e.g. ``libgpi.dll``.\n libraries: A list of names of dependent manifests, e.g. ``[\"libgpi\"]``.\n \"\"\"\n\n architecture = \"amd64\" if sys.maxsize > 2**32 else \"x86\"\n dependencies = []\n\n for lib in libraries:\n dependencies.append(\n textwrap.dedent(\n \"\"\"\\\n \n \n \n \n \n \"\"\"\n )\n % (lib, architecture)\n )\n\n if not dependency_only:\n manifest_body = textwrap.dedent(\n \"\"\"\\\n \n \n \n \n %s\n \n \"\"\"\n ) % (\n name,\n architecture,\n filename,\n textwrap.indent(\"\".join(dependencies), \" \").strip(),\n )\n else:\n manifest_body = textwrap.dedent(\n \"\"\"\\\n \n \n %s\n \n \"\"\"\n ) % (textwrap.indent(\"\".join(dependencies), \" \").strip())\n\n return manifest_body\n\n\ndef create_sxs_appconfig(filename):\n \"\"\"\n Create side-by-side (sxs) application configuration file.\n\n The application configuration specifies additional search paths for manifests.\n For more details see: https://docs.microsoft.com/en-us/windows/win32/sbscs/application-configuration-files\n \"\"\"\n\n config_body = textwrap.dedent(\n \"\"\"\\\n \n \n \n \n \n \n \n \n \"\"\"\n )\n\n dirpath = os.path.dirname(filename)\n os.makedirs(dirpath, exist_ok=True)\n\n with open(filename + \".2.config\", \"w\", encoding=\"utf-8\") as f:\n f.write(config_body)\n\n\ndef create_rc_file(rc_filename, name, filename, libraries, runtime_libraries):\n \"\"\"\n Creates windows resource definition script to embed the side-by-side assembly manifest into the libraries.\n\n For more details see: https://docs.microsoft.com/en-us/windows/win32/menurc/about-resource-files\n \"\"\"\n\n manifest = create_sxs_assembly_manifest(name, filename, libraries)\n\n # Escape double quotes and put every line between double quotes for embedding into rc file\n manifest = manifest.replace('\"', '\"\"')\n manifest = \"\\n\".join([f'\"{x}\\\\r\\\\n\"' for x in manifest.splitlines()])\n\n rc_body = (\n textwrap.dedent(\n \"\"\"\\\n #pragma code_page(65001) // UTF-8\n #include \n\n LANGUAGE 0x00, 0x00\n\n ISOLATIONAWARE_MANIFEST_RESOURCE_ID RT_MANIFEST\n BEGIN\n %s\n END\n \"\"\"\n )\n % manifest\n )\n\n if runtime_libraries is not None:\n manifest = create_sxs_assembly_manifest(\n name, filename, runtime_libraries, dependency_only=True\n )\n\n # Escape double quotes and put every line between double quotes for embedding into rc file\n manifest = manifest.replace('\"', '\"\"')\n manifest = \"\\n\".join([f'\"{x}\\\\r\\\\n\"' for x in manifest.splitlines()])\n\n rc_body += (\n textwrap.dedent(\n \"\"\"\\\n 1000 RT_MANIFEST\n BEGIN\n %s\n END\n \"\"\"\n )\n % manifest\n )\n\n with open(rc_filename, \"w\", encoding=\"utf-8\") as f:\n f.write(rc_body)\n\n\ndef _get_lib_ext_name():\n \"\"\"Get name of default library file extension on given OS.\"\"\"\n\n if os.name == \"nt\":\n ext_name = \"dll\"\n else:\n ext_name = \"so\"\n\n return ext_name\n\n\nclass build_ext(_build_ext):\n def _uses_msvc(self):\n if self.compiler == \"msvc\":\n return True\n if self.compiler is None:\n return get_default_compiler() == \"msvc\"\n else:\n return getattr(self.compiler, \"compiler_type\", None) == \"msvc\"\n\n def run(self):\n if os.name == \"nt\":\n create_sxs_appconfig(\n self.get_ext_fullpath(os.path.join(\"cocotb\", \"simulator\"))\n )\n\n super().run()\n\n def build_extensions(self):\n if os.name == \"nt\":\n if self._uses_msvc():\n # Initialize the compiler now so that compiler/linker flags are populated\n if not self.compiler.initialized:\n self.compiler.initialize()\n\n # Setuptools defaults to activate automatic manifest generation for msvc,\n # disable it here as we manually generate it to also support mingw on windows\n for k, ldflags in self.compiler._ldflags.items():\n self.compiler._ldflags[k] = [\n x for x in ldflags if not x.startswith(\"/MANIFEST\")\n ] + [\"/MANIFEST:NO\"]\n\n self.compiler.compile_options = [\n x for x in self.compiler.compile_options if not x.startswith(\"/W\")\n ] + [\"/W4\"]\n\n ext_names = {os.path.split(ext.name)[-1] for ext in self.extensions}\n for ext in self.extensions:\n fullname = self.get_ext_fullname(ext.name)\n filename = self.get_ext_filename(fullname)\n name = os.path.split(fullname)[-1]\n filename = os.path.split(filename)[-1]\n libraries = {\"lib\" + lib for lib in ext.libraries}.intersection(\n ext_names\n )\n rc_filename = name + \".rc\"\n runtime_libraries = None\n\n # Strip lib prefix for msvc\n if self._uses_msvc():\n name = name[3:] if name.startswith(\"lib\") else name\n libraries = {\n (lib[3:] if lib.startswith(\"lib\") else lib) for lib in libraries\n }\n if runtime_libraries is not None:\n runtime_libraries = {\n (lib[3:] if lib.startswith(\"lib\") else lib)\n for lib in runtime_libraries\n }\n create_rc_file(\n rc_filename, name, filename, libraries, runtime_libraries\n )\n\n def_dir = os.path.join(cocotb_share_dir, \"def\")\n self._gen_import_libs(def_dir)\n\n for e in self.extensions:\n e.library_dirs += [def_dir]\n\n super().build_extensions()\n\n def build_extension(self, ext):\n \"\"\"Build each extension in its own temp directory to make gcov happy.\n\n A normal PEP 517 install still works as the temp directories are discarded anyway.\n \"\"\"\n lib_name = os.path.split(ext.name)[-1]\n\n if self._uses_msvc():\n ext.extra_compile_args += _extra_cxx_compile_args_msvc\n else:\n ext.extra_compile_args += _extra_cxx_compile_args\n\n if os.name == \"nt\":\n # Align behavior of gcc with msvc and export only symbols marked with __declspec(dllexport)\n ext.extra_link_args += [\"-Wl,--exclude-all-symbols\"]\n else:\n ext.extra_link_args += [\"-flto\"]\n\n rpaths = []\n if lib_name == \"simulator\":\n rpaths += [\"$ORIGIN/libs\"]\n install_name = None\n else:\n rpaths += [\"$ORIGIN\"]\n install_name = lib_name\n\n if sys.platform == \"darwin\":\n rpaths = [\n rpath.replace(\"$ORIGIN\", \"@loader_path\") for rpath in rpaths\n ]\n if install_name is not None:\n ext.extra_link_args += [\n f\"-Wl,-install_name,@rpath/{install_name}.so\"\n ]\n\n if sys.platform == \"linux\":\n # Avoid a runtime dependency on libstdc++. Some simulators\n # ship a version of libstdc++6.so which is older than the\n # one cocotb has been compiled with, which will then lead to\n # load-time errors like \"libstdc++.so.6: version\n # `GLIBCXX_3.4.29' not found (required by\n # /path/to/libcocotbvhpi_modelsim.so).\"\n ext.extra_link_args += [\"-static-libstdc++\"]\n\n ext.extra_link_args += [f\"-Wl,-rpath,{rpath}\" for rpath in rpaths]\n\n # vpi_user.h and vhpi_user.h require that WIN32 is defined\n if os.name == \"nt\":\n ext.define_macros += [(\"WIN32\", \"\")]\n\n old_build_temp = self.build_temp\n self.build_temp = os.path.join(self.build_temp, ext.name)\n super().build_extension(ext)\n self.build_temp = old_build_temp\n\n # Needed for Windows to not assume python module (generate interface in def file)\n def get_export_symbols(self, ext):\n return None\n\n # For proper cocotb library naming, based on https://github.com/cython/cython/issues/1740\n def get_ext_filename(self, ext_name):\n \"\"\"\n Like the base class method, but for libraries that are not python extension:\n - removes the ``.cpython-36m-x86_64-linux-gnu.`` or ``-cpython-36m.`` part before the extension\n - replaces ``.pyd`` with ``.dll`` on windows.\n \"\"\"\n\n filename = _build_ext.get_ext_filename(self, ext_name)\n\n # for the simulator python extension library, leaving suffix in place\n if os.path.split(ext_name)[-1] == \"simulator\":\n return filename\n\n head, tail = os.path.split(filename)\n tail_split = tail.split(\".\")\n\n # mingw on msys2 uses `-` as separator\n tail_split = tail_split[0].split(\"-\")\n\n # strip lib prefix if msvc is used\n if self._uses_msvc() and tail_split[0].startswith(\"lib\"):\n tail_split[0] = tail_split[0][3:]\n\n filename_short = os.path.join(head, tail_split[0] + \".\" + _get_lib_ext_name())\n\n return filename_short\n\n def finalize_options(self):\n \"\"\"Like the base class method,but add extra library_dirs path.\"\"\"\n\n super().finalize_options()\n\n for ext in self.extensions:\n ext.library_dirs.append(os.path.join(self.build_lib, \"cocotb\", \"libs\"))\n\n def copy_extensions_to_source(self):\n \"\"\"Like the base class method, but copy libs into proper directory in develop.\"\"\"\n\n build_py = self.get_finalized_command(\"build_py\")\n for ext in self.extensions:\n fullname = self.get_ext_fullname(ext.name)\n filename = self.get_ext_filename(fullname)\n modpath = fullname.split(\".\")\n package = \".\".join(modpath[:-1])\n package_dir = build_py.get_package_dir(package)\n # unlike the method from `setuptools`, we do not call `os.path.basename` here\n dest_filename = os.path.join(package_dir, filename)\n src_filename = os.path.join(self.build_lib, filename)\n\n os.makedirs(os.path.dirname(dest_filename), exist_ok=True)\n\n copy_file(src_filename, dest_filename, verbose=self.verbose)\n if ext._needs_stub:\n self.write_stub(package_dir or os.curdir, ext, True)\n\n def _gen_import_libs(self, def_dir):\n \"\"\"\n On Windows generate import libraries that contains the code required to\n load the DLL (.a) based on module definition files (.def)\n \"\"\"\n\n for sim in [\"icarus\", \"modelsim\", \"aldec\", \"ghdl\", \"nvcvhpi\"]:\n if self._uses_msvc():\n subprocess.run(\n [\n self.compiler.lib,\n \"/def:\" + os.path.join(def_dir, sim + \".def\"),\n \"/out:\" + os.path.join(def_dir, sim + \".lib\"),\n \"/machine:\" + (\"X64\" if sys.maxsize > 2**32 else \"X86\"),\n ],\n check=True,\n )\n else:\n subprocess.run(\n [\n \"dlltool\",\n \"-d\",\n os.path.join(def_dir, sim + \".def\"),\n \"-l\",\n os.path.join(def_dir, \"lib\" + sim + \".a\"),\n ],\n check=True,\n )\n\n\ndef _get_python_lib_link():\n \"\"\"Get name of python library used for linking\"\"\"\n\n if sys.platform == \"darwin\":\n ld_library = sysconfig.get_config_var(\"LIBRARY\")\n else:\n ld_library = sysconfig.get_config_var(\"LDLIBRARY\")\n\n if ld_library is not None:\n python_lib_link = os.path.splitext(ld_library)[0][3:]\n else:\n python_version = sysconfig.get_python_version().replace(\".\", \"\")\n python_lib_link = \"python\" + python_version\n\n return python_lib_link\n\n\ndef _get_python_lib():\n \"\"\"Get the library for embedded the python interpreter\"\"\"\n\n if os.name == \"nt\":\n python_lib = _get_python_lib_link() + \".\" + _get_lib_ext_name()\n elif sys.platform == \"darwin\":\n python_lib = os.path.join(\n sysconfig.get_config_var(\"LIBDIR\"), \"lib\" + _get_python_lib_link() + \".\"\n )\n if os.path.exists(python_lib + \"dylib\"):\n python_lib += \"dylib\"\n else:\n python_lib += \"so\"\n else:\n python_lib = \"lib\" + _get_python_lib_link() + \".\" + _get_lib_ext_name()\n\n return python_lib\n\n\ndef _get_common_lib_ext(include_dirs, share_lib_dir):\n \"\"\"\n Defines common libraries.\n\n All libraries go into the same directory to enable loading without modifying the library path (e.g. LD_LIBRARY_PATH).\n \"\"\"\n\n #\n # libgpi\n #\n libgpi_sources = [\n os.path.join(share_lib_dir, \"gpi\", \"GpiCbHdl.cpp\"),\n os.path.join(share_lib_dir, \"gpi\", \"GpiCommon.cpp\"),\n os.path.join(share_lib_dir, \"gpi\", \"dynload.cpp\"),\n os.path.join(share_lib_dir, \"gpi\", \"logging.cpp\"),\n ]\n libgpi_libraries = []\n if sys.platform.startswith((\"linux\", \"darwin\", \"cygwin\", \"msys\")):\n libgpi_libraries.append(\"dl\") # dlopen, dlerror, dlsym\n if os.name == \"nt\":\n libgpi_sources += [\"libgpi.rc\"]\n libgpi = Extension(\n os.path.join(\"cocotb\", \"libs\", \"libgpi\"),\n define_macros=[\n (\"GPI_EXPORTS\", \"\"),\n *_extra_defines,\n ],\n include_dirs=include_dirs,\n libraries=libgpi_libraries,\n sources=libgpi_sources,\n )\n\n #\n # PyGPI\n #\n pygpi_sources = [\n os.path.join(share_lib_dir, \"pygpi\", \"bind.cpp\"),\n os.path.join(share_lib_dir, \"pygpi\", \"embed.cpp\"),\n os.path.join(share_lib_dir, \"pygpi\", \"logging.cpp\"),\n ]\n if os.name == \"nt\":\n pygpi_sources += [\"simulator.rc\"]\n python_lib_dirs = []\n if sys.platform == \"darwin\":\n python_lib_dirs = [sysconfig.get_config_var(\"LIBDIR\")]\n libpygpi = Extension(\n os.path.join(\"cocotb\", \"simulator\"),\n define_macros=[\n (\"PYGPI_EXPORTS\", \"\"),\n *_extra_defines,\n ],\n include_dirs=include_dirs,\n libraries=[\"gpi\"],\n library_dirs=python_lib_dirs,\n sources=pygpi_sources,\n )\n\n # The libraries in this list are compiled in order of their appearance.\n # If there is a linking dependency on one library to another,\n # the linked library must be built first.\n return [libgpi, libpygpi]\n\n\ndef _get_vpi_lib_ext(\n include_dirs, share_lib_dir, sim_define, extra_lib=[], extra_lib_dir=[]\n):\n lib_name = \"libcocotbvpi_\" + sim_define.lower()\n libcocotbvpi_sources = [\n os.path.join(share_lib_dir, \"gpi\", \"vpi\", \"VpiImpl.cpp\"),\n os.path.join(share_lib_dir, \"gpi\", \"vpi\", \"VpiCbHdl.cpp\"),\n os.path.join(share_lib_dir, \"gpi\", \"vpi\", \"VpiObj.cpp\"),\n os.path.join(share_lib_dir, \"gpi\", \"vpi\", \"VpiIterator.cpp\"),\n os.path.join(share_lib_dir, \"gpi\", \"vpi\", \"VpiSignal.cpp\"),\n ]\n if os.name == \"nt\":\n libcocotbvpi_sources += [lib_name + \".rc\"]\n libcocotbvpi = Extension(\n os.path.join(\"cocotb\", \"libs\", lib_name),\n define_macros=[(\"COCOTBVPI_EXPORTS\", \"\"), (sim_define, \"\"), *_extra_defines],\n include_dirs=include_dirs,\n libraries=[\"gpi\", *extra_lib],\n library_dirs=extra_lib_dir,\n sources=libcocotbvpi_sources,\n )\n\n return libcocotbvpi\n\n\ndef _get_vhpi_lib_ext(\n include_dirs, share_lib_dir, sim_define, extra_lib=[], extra_lib_dir=[]\n):\n lib_name = \"libcocotbvhpi_\" + sim_define.lower()\n libcocotbvhpi_sources = [\n os.path.join(share_lib_dir, \"gpi\", \"vhpi\", \"VhpiImpl.cpp\"),\n os.path.join(share_lib_dir, \"gpi\", \"vhpi\", \"VhpiCbHdl.cpp\"),\n os.path.join(share_lib_dir, \"gpi\", \"vhpi\", \"VhpiObj.cpp\"),\n os.path.join(share_lib_dir, \"gpi\", \"vhpi\", \"VhpiIterator.cpp\"),\n os.path.join(share_lib_dir, \"gpi\", \"vhpi\", \"VhpiSignal.cpp\"),\n ]\n if os.name == \"nt\":\n libcocotbvhpi_sources += [lib_name + \".rc\"]\n libcocotbvhpi = Extension(\n os.path.join(\"cocotb\", \"libs\", lib_name),\n include_dirs=include_dirs,\n define_macros=[(\"COCOTBVHPI_EXPORTS\", \"\"), (sim_define, \"\"), *_extra_defines],\n libraries=[\"gpi\", *extra_lib],\n library_dirs=extra_lib_dir,\n sources=libcocotbvhpi_sources,\n )\n\n return libcocotbvhpi\n\n\ndef get_ext():\n cfg_vars = distutils.sysconfig.get_config_vars()\n\n if sys.platform == \"darwin\":\n cfg_vars[\"LDSHARED\"] = cfg_vars[\"LDSHARED\"].replace(\"-bundle\", \"-dynamiclib\")\n cfg_vars[\"LDCXXSHARED\"] = cfg_vars[\"LDSHARED\"].replace(\"-bundle\", \"-dynamiclib\")\n\n share_lib_dir = os.path.relpath(os.path.join(cocotb_share_dir, \"lib\"))\n include_dirs = [\n os.path.relpath(os.path.join(cocotb_share_dir, \"include\")),\n os.path.relpath(os.path.join(os.path.dirname(__file__), \"src\", \"cocotb\")),\n ]\n\n ext = []\n\n logger.info(\"Compiling interface libraries for cocotb ...\")\n\n ext += _get_common_lib_ext(include_dirs, share_lib_dir)\n\n #\n # Icarus Verilog\n #\n icarus_extra_lib = []\n logger.info(\"Compiling libraries for Icarus Verilog\")\n if os.name == \"nt\":\n icarus_extra_lib = [\"icarus\"]\n\n icarus_vpi_ext = _get_vpi_lib_ext(\n include_dirs=include_dirs,\n share_lib_dir=share_lib_dir,\n sim_define=\"ICARUS\",\n extra_lib=icarus_extra_lib,\n )\n ext.append(icarus_vpi_ext)\n\n #\n # Modelsim/Questa\n #\n modelsim_extra_lib = []\n logger.info(\"Compiling libraries for Modelsim/Questa\")\n if os.name == \"nt\":\n modelsim_extra_lib = [\"modelsim\"]\n\n modelsim_vpi_ext = _get_vpi_lib_ext(\n include_dirs=include_dirs,\n share_lib_dir=share_lib_dir,\n sim_define=\"MODELSIM\",\n extra_lib=modelsim_extra_lib,\n )\n ext.append(modelsim_vpi_ext)\n\n modelsim_vhpi_ext = _get_vhpi_lib_ext(\n include_dirs=include_dirs,\n share_lib_dir=share_lib_dir,\n sim_define=\"MODELSIM\",\n extra_lib=modelsim_extra_lib,\n )\n ext.append(modelsim_vhpi_ext)\n\n lib_name = \"libcocotbfli_modelsim\"\n fli_sources = [\n os.path.join(share_lib_dir, \"gpi\", \"fli\", \"FliImpl.cpp\"),\n os.path.join(share_lib_dir, \"gpi\", \"fli\", \"FliCbHdl.cpp\"),\n os.path.join(share_lib_dir, \"gpi\", \"fli\", \"FliObjHdl.cpp\"),\n ]\n if os.name == \"nt\":\n fli_sources += [lib_name + \".rc\"]\n fli_ext = Extension(\n os.path.join(\"cocotb\", \"libs\", lib_name),\n define_macros=[(\"COCOTBFLI_EXPORTS\", \"\"), *_extra_defines],\n include_dirs=include_dirs,\n libraries=[\"gpi\", *modelsim_extra_lib],\n sources=fli_sources,\n )\n\n ext.append(fli_ext)\n\n #\n # GHDL\n #\n ghdl_extra_lib = []\n logger.info(\"Compiling libraries for GHDL\")\n if os.name == \"nt\":\n ghdl_extra_lib = [\"ghdl\"]\n\n ghdl_vpi_ext = _get_vpi_lib_ext(\n include_dirs=include_dirs,\n share_lib_dir=share_lib_dir,\n sim_define=\"GHDL\",\n extra_lib=ghdl_extra_lib,\n )\n ext.append(ghdl_vpi_ext)\n\n #\n # IUS\n #\n if os.name == \"posix\":\n logger.info(\"Compiling libraries for Incisive/Xcelium\")\n ius_vpi_ext = _get_vpi_lib_ext(\n include_dirs=include_dirs, share_lib_dir=share_lib_dir, sim_define=\"IUS\"\n )\n ext.append(ius_vpi_ext)\n\n ius_vhpi_ext = _get_vhpi_lib_ext(\n include_dirs=include_dirs, share_lib_dir=share_lib_dir, sim_define=\"IUS\"\n )\n ext.append(ius_vhpi_ext)\n\n #\n # VCS\n #\n if os.name == \"posix\":\n logger.info(\"Compiling libraries for VCS\")\n vcs_vpi_ext = _get_vpi_lib_ext(\n include_dirs=include_dirs, share_lib_dir=share_lib_dir, sim_define=\"VCS\"\n )\n ext.append(vcs_vpi_ext)\n\n #\n # Aldec Riviera Pro\n #\n aldec_extra_lib = []\n logger.info(\"Compiling libraries for Riviera\")\n if os.name == \"nt\":\n aldec_extra_lib = [\"aldec\"]\n\n aldec_vpi_ext = _get_vpi_lib_ext(\n include_dirs=include_dirs,\n share_lib_dir=share_lib_dir,\n sim_define=\"ALDEC\",\n extra_lib=aldec_extra_lib,\n )\n ext.append(aldec_vpi_ext)\n\n aldec_vhpi_ext = _get_vhpi_lib_ext(\n include_dirs=include_dirs,\n share_lib_dir=share_lib_dir,\n sim_define=\"ALDEC\",\n extra_lib=aldec_extra_lib,\n )\n ext.append(aldec_vhpi_ext)\n\n #\n # Verilator\n #\n if os.name == \"posix\":\n logger.info(\"Compiling libraries for Verilator\")\n verilator_vpi_ext = _get_vpi_lib_ext(\n include_dirs=include_dirs,\n share_lib_dir=share_lib_dir,\n sim_define=\"VERILATOR\",\n )\n ext.append(verilator_vpi_ext)\n\n #\n # NVC\n #\n nvc_extra_lib = []\n if os.name == \"nt\":\n nvc_extra_lib = [\"nvcvhpi\"]\n logger.info(\"Compiling libraries for NVC\")\n nvc_vhpi_ext = _get_vhpi_lib_ext(\n include_dirs=include_dirs,\n share_lib_dir=share_lib_dir,\n sim_define=\"NVC\",\n extra_lib=nvc_extra_lib,\n )\n ext.append(nvc_vhpi_ext)\n\n #\n # DSim\n #\n if os.name == \"posix\":\n logger.info(\"Compiling libraries for DSim\")\n dsim_vpi_ext = _get_vpi_lib_ext(\n include_dirs=include_dirs, share_lib_dir=share_lib_dir, sim_define=\"DSim\"\n )\n ext.append(dsim_vpi_ext)\n\n return ext\n" }, { "path": "docs/.gitignore", "content": ".venv\nsource/master-notes.rst\nsource/doxygen\n" }, { "path": "docs/Doxyfile", "content": "# Doxyfile 1.9.8\n\n# This file describes the settings to be used by the documentation system\n# doxygen (www.doxygen.org) for a project.\n#\n# All text after a double hash (##) is considered a comment and is placed in\n# front of the TAG it is preceding.\n#\n# All text after a single hash (#) is considered a comment and will be ignored.\n# The format is:\n# TAG = value [value, ...]\n# For lists, items can also be appended using:\n# TAG += value [value, ...]\n# Values that contain spaces should be placed between quotes (\\\" \\\").\n#\n# Note:\n#\n# Use doxygen to compare the used configuration file with the template\n# configuration file:\n# doxygen -x [configFile]\n# Use doxygen to compare the used configuration file with the template\n# configuration file without replacing the environment variables or CMake type\n# replacement variables:\n# doxygen -x_noenv [configFile]\n\n#---------------------------------------------------------------------------\n# Project related configuration options\n#---------------------------------------------------------------------------\n\n# This tag specifies the encoding used for all characters in the configuration\n# file that follow. The default is UTF-8 which is also the encoding used for all\n# text before the first occurrence of this tag. Doxygen uses libiconv (or the\n# iconv built into libc) for the transcoding. See\n# https://www.gnu.org/software/libiconv/ for the list of possible encodings.\n# The default value is: UTF-8.\n\nDOXYFILE_ENCODING = UTF-8\n\n# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by\n# double-quotes, unless you are using Doxywizard) that should identify the\n# project for which the documentation is generated. This name is used in the\n# title of most generated pages and in a few other places.\n# The default value is: My Project.\n\nPROJECT_NAME = cocotb\n\n# The PROJECT_NUMBER tag can be used to enter a project or revision number. This\n# could be handy for archiving the generated documentation or if some version\n# control system is used.\n\nPROJECT_NUMBER =\n\n# Using the PROJECT_BRIEF tag one can provide an optional one line description\n# for a project that appears at the top of each page and should give viewer a\n# quick idea about the purpose of the project. Keep the description short.\n\nPROJECT_BRIEF =\n\n# With the PROJECT_LOGO tag one can specify a logo or an icon that is included\n# in the documentation. The maximum height of the logo should not exceed 55\n# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy\n# the logo to the output directory.\n\nPROJECT_LOGO =\n\n# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path\n# into which the generated documentation will be written. If a relative path is\n# entered, it will be relative to the location where doxygen was started. If\n# left blank the current directory will be used.\n\nOUTPUT_DIRECTORY = source/doxygen\n\n# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096\n# sub-directories (in 2 levels) under the output directory of each output format\n# and will distribute the generated files over these directories. Enabling this\n# option can be useful when feeding doxygen a huge amount of source files, where\n# putting all generated files in the same directory would otherwise causes\n# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to\n# control the number of sub-directories.\n# The default value is: NO.\n\nCREATE_SUBDIRS = NO\n\n# Controls the number of sub-directories that will be created when\n# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every\n# level increment doubles the number of directories, resulting in 4096\n# directories at level 8 which is the default and also the maximum value. The\n# sub-directories are organized in 2 levels, the first level always has a fixed\n# number of 16 directories.\n# Minimum value: 0, maximum value: 8, default value: 8.\n# This tag requires that the tag CREATE_SUBDIRS is set to YES.\n\nCREATE_SUBDIRS_LEVEL = 8\n\n# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII\n# characters to appear in the names of generated files. If set to NO, non-ASCII\n# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode\n# U+3044.\n# The default value is: NO.\n\nALLOW_UNICODE_NAMES = NO\n\n# The OUTPUT_LANGUAGE tag is used to specify the language in which all\n# documentation generated by doxygen is written. Doxygen will use this\n# information to generate all constant output in the proper language.\n# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian,\n# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English\n# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek,\n# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with\n# English messages), Korean, Korean-en (Korean with English messages), Latvian,\n# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese,\n# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish,\n# Swedish, Turkish, Ukrainian and Vietnamese.\n# The default value is: English.\n\nOUTPUT_LANGUAGE = English\n\n# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member\n# descriptions after the members that are listed in the file and class\n# documentation (similar to Javadoc). Set to NO to disable this.\n# The default value is: YES.\n\nBRIEF_MEMBER_DESC = YES\n\n# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief\n# description of a member or function before the detailed description\n#\n# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the\n# brief descriptions will be completely suppressed.\n# The default value is: YES.\n\nREPEAT_BRIEF = YES\n\n# This tag implements a quasi-intelligent brief description abbreviator that is\n# used to form the text in various listings. Each string in this list, if found\n# as the leading text of the brief description, will be stripped from the text\n# and the result, after processing the whole list, is used as the annotated\n# text. Otherwise, the brief description is used as-is. If left blank, the\n# following values are used ($name is automatically replaced with the name of\n# the entity):The $name class, The $name widget, The $name file, is, provides,\n# specifies, contains, represents, a, an and the.\n\nABBREVIATE_BRIEF =\n\n# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then\n# doxygen will generate a detailed section even if there is only a brief\n# description.\n# The default value is: NO.\n\nALWAYS_DETAILED_SEC = NO\n\n# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all\n# inherited members of a class in the documentation of that class as if those\n# members were ordinary class members. Constructors, destructors and assignment\n# operators of the base classes will not be shown.\n# The default value is: NO.\n\nINLINE_INHERITED_MEMB = NO\n\n# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path\n# before files name in the file list and in the header files. If set to NO the\n# shortest path that makes the file name unique will be used\n# The default value is: YES.\n\nFULL_PATH_NAMES = NO\n\n# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.\n# Stripping is only done if one of the specified strings matches the left-hand\n# part of the path. The tag can be used to show relative paths in the file list.\n# If left blank the directory from which doxygen is run is used as the path to\n# strip.\n#\n# Note that you can specify absolute paths here, but also relative paths, which\n# will be relative from the directory where doxygen is started.\n# This tag requires that the tag FULL_PATH_NAMES is set to YES.\n\nSTRIP_FROM_PATH =\n\n# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the\n# path mentioned in the documentation of a class, which tells the reader which\n# header file to include in order to use a class. If left blank only the name of\n# the header file containing the class definition is used. Otherwise one should\n# specify the list of include paths that are normally passed to the compiler\n# using the -I flag.\n\nSTRIP_FROM_INC_PATH =\n\n# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but\n# less readable) file names. This can be useful is your file systems doesn't\n# support long names like on DOS, Mac, or CD-ROM.\n# The default value is: NO.\n\nSHORT_NAMES = NO\n\n# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the\n# first line (until the first dot) of a Javadoc-style comment as the brief\n# description. If set to NO, the Javadoc-style will behave just like regular Qt-\n# style comments (thus requiring an explicit @brief command for a brief\n# description.)\n# The default value is: NO.\n\nJAVADOC_AUTOBRIEF = YES\n\n# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line\n# such as\n# /***************\n# as being the beginning of a Javadoc-style comment \"banner\". If set to NO, the\n# Javadoc-style will behave just like regular comments and it will not be\n# interpreted by doxygen.\n# The default value is: NO.\n\nJAVADOC_BANNER = NO\n\n# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first\n# line (until the first dot) of a Qt-style comment as the brief description. If\n# set to NO, the Qt-style will behave just like regular Qt-style comments (thus\n# requiring an explicit \\brief command for a brief description.)\n# The default value is: NO.\n\nQT_AUTOBRIEF = NO\n\n# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a\n# multi-line C++ special comment block (i.e. a block of //! or /// comments) as\n# a brief description. This used to be the default behavior. The new default is\n# to treat a multi-line C++ comment block as a detailed description. Set this\n# tag to YES if you prefer the old behavior instead.\n#\n# Note that setting this tag to YES also means that rational rose comments are\n# not recognized any more.\n# The default value is: NO.\n\nMULTILINE_CPP_IS_BRIEF = NO\n\n# By default Python docstrings are displayed as preformatted text and doxygen's\n# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the\n# doxygen's special commands can be used and the contents of the docstring\n# documentation blocks is shown as doxygen documentation.\n# The default value is: YES.\n\nPYTHON_DOCSTRING = YES\n\n# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the\n# documentation from any documented member that it re-implements.\n# The default value is: YES.\n\nINHERIT_DOCS = YES\n\n# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new\n# page for each member. If set to NO, the documentation of a member will be part\n# of the file/class/namespace that contains it.\n# The default value is: NO.\n\nSEPARATE_MEMBER_PAGES = NO\n\n# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen\n# uses this value to replace tabs by spaces in code fragments.\n# Minimum value: 1, maximum value: 16, default value: 4.\n\nTAB_SIZE = 4\n\n# This tag can be used to specify a number of aliases that act as commands in\n# the documentation. An alias has the form:\n# name=value\n# For example adding\n# \"sideeffect=@par Side Effects:^^\"\n# will allow you to put the command \\sideeffect (or @sideeffect) in the\n# documentation, which will result in a user-defined paragraph with heading\n# \"Side Effects:\". Note that you cannot put \\n's in the value part of an alias\n# to insert newlines (in the resulting output). You can put ^^ in the value part\n# of an alias to insert a newline as if a physical newline was in the original\n# file. When you need a literal { or } or , in the value part of an alias you\n# have to escape them by means of a backslash (\\), this can lead to conflicts\n# with the commands \\{ and \\} for these it is advised to use the version @{ and\n# @} or use a double escape (\\\\{ and \\\\})\n\nALIASES =\n\n# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources\n# only. Doxygen will then generate output that is more tailored for C. For\n# instance, some of the names that are used will be different. The list of all\n# members will be omitted, etc.\n# The default value is: NO.\n\nOPTIMIZE_OUTPUT_FOR_C = NO\n\n# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or\n# Python sources only. Doxygen will then generate output that is more tailored\n# for that language. For instance, namespaces will be presented as packages,\n# qualified scopes will look different, etc.\n# The default value is: NO.\n\nOPTIMIZE_OUTPUT_JAVA = NO\n\n# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran\n# sources. Doxygen will then generate output that is tailored for Fortran.\n# The default value is: NO.\n\nOPTIMIZE_FOR_FORTRAN = NO\n\n# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL\n# sources. Doxygen will then generate output that is tailored for VHDL.\n# The default value is: NO.\n\nOPTIMIZE_OUTPUT_VHDL = NO\n\n# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice\n# sources only. Doxygen will then generate output that is more tailored for that\n# language. For instance, namespaces will be presented as modules, types will be\n# separated into more groups, etc.\n# The default value is: NO.\n\nOPTIMIZE_OUTPUT_SLICE = NO\n\n# Doxygen selects the parser to use depending on the extension of the files it\n# parses. With this tag you can assign which parser to use for a given\n# extension. Doxygen has a built-in mapping, but you can override or extend it\n# using this tag. The format is ext=language, where ext is a file extension, and\n# language is one of the parsers supported by doxygen: IDL, Java, JavaScript,\n# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice,\n# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:\n# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser\n# tries to guess whether the code is fixed or free formatted code, this is the\n# default for Fortran type files). For instance to make doxygen treat .inc files\n# as Fortran files (default is PHP), and .f files as C (default is Fortran),\n# use: inc=Fortran f=C.\n#\n# Note: For files without extension you can use no_extension as a placeholder.\n#\n# Note that for custom extensions you also need to set FILE_PATTERNS otherwise\n# the files are not read by doxygen. When specifying no_extension you should add\n# * to the FILE_PATTERNS.\n#\n# Note see also the list of default file extension mappings.\n\nEXTENSION_MAPPING =\n\n# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments\n# according to the Markdown format, which allows for more readable\n# documentation. See https://daringfireball.net/projects/markdown/ for details.\n# The output of markdown processing is further processed by doxygen, so you can\n# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in\n# case of backward compatibilities issues.\n# The default value is: YES.\n\nMARKDOWN_SUPPORT = YES\n\n# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up\n# to that level are automatically included in the table of contents, even if\n# they do not have an id attribute.\n# Note: This feature currently applies only to Markdown headings.\n# Minimum value: 0, maximum value: 99, default value: 5.\n# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.\n\nTOC_INCLUDE_HEADINGS = 5\n\n# The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to\n# generate identifiers for the Markdown headings. Note: Every identifier is\n# unique.\n# Possible values are: DOXYGEN use a fixed 'autotoc_md' string followed by a\n# sequence number starting at 0 and GITHUB use the lower case version of title\n# with any whitespace replaced by '-' and punctuation characters removed.\n# The default value is: DOXYGEN.\n# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.\n\nMARKDOWN_ID_STYLE = DOXYGEN\n\n# When enabled doxygen tries to link words that correspond to documented\n# classes, or namespaces to their corresponding documentation. Such a link can\n# be prevented in individual cases by putting a % sign in front of the word or\n# globally by setting AUTOLINK_SUPPORT to NO.\n# The default value is: YES.\n\nAUTOLINK_SUPPORT = YES\n\n# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want\n# to include (a tag file for) the STL sources as input, then you should set this\n# tag to YES in order to let doxygen match functions declarations and\n# definitions whose arguments contain STL classes (e.g. func(std::string);\n# versus func(std::string) {}). This also make the inheritance and collaboration\n# diagrams that involve STL classes more complete and accurate.\n# The default value is: NO.\n\nBUILTIN_STL_SUPPORT = NO\n\n# If you use Microsoft's C++/CLI language, you should set this option to YES to\n# enable parsing support.\n# The default value is: NO.\n\nCPP_CLI_SUPPORT = NO\n\n# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:\n# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen\n# will parse them like normal C++ but will assume all classes use public instead\n# of private inheritance when no explicit protection keyword is present.\n# The default value is: NO.\n\nSIP_SUPPORT = NO\n\n# For Microsoft's IDL there are propget and propput attributes to indicate\n# getter and setter methods for a property. Setting this option to YES will make\n# doxygen to replace the get and set methods by a property in the documentation.\n# This will only work if the methods are indeed getting or setting a simple\n# type. If this is not the case, or you want to show the methods anyway, you\n# should set this option to NO.\n# The default value is: YES.\n\nIDL_PROPERTY_SUPPORT = YES\n\n# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC\n# tag is set to YES then doxygen will reuse the documentation of the first\n# member in the group (if any) for the other members of the group. By default\n# all members of a group must be documented explicitly.\n# The default value is: NO.\n\nDISTRIBUTE_GROUP_DOC = NO\n\n# If one adds a struct or class to a group and this option is enabled, then also\n# any nested class or struct is added to the same group. By default this option\n# is disabled and one has to add nested compounds explicitly via \\ingroup.\n# The default value is: NO.\n\nGROUP_NESTED_COMPOUNDS = NO\n\n# Set the SUBGROUPING tag to YES to allow class member groups of the same type\n# (for instance a group of public functions) to be put as a subgroup of that\n# type (e.g. under the Public Functions section). Set it to NO to prevent\n# subgrouping. Alternatively, this can be done per class using the\n# \\nosubgrouping command.\n# The default value is: YES.\n\nSUBGROUPING = YES\n\n# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions\n# are shown inside the group in which they are included (e.g. using \\ingroup)\n# instead of on a separate page (for HTML and Man pages) or section (for LaTeX\n# and RTF).\n#\n# Note that this feature does not work in combination with\n# SEPARATE_MEMBER_PAGES.\n# The default value is: NO.\n\nINLINE_GROUPED_CLASSES = NO\n\n# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions\n# with only public data fields or simple typedef fields will be shown inline in\n# the documentation of the scope in which they are defined (i.e. file,\n# namespace, or group documentation), provided this scope is documented. If set\n# to NO, structs, classes, and unions are shown on a separate page (for HTML and\n# Man pages) or section (for LaTeX and RTF).\n# The default value is: NO.\n\nINLINE_SIMPLE_STRUCTS = NO\n\n# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or\n# enum is documented as struct, union, or enum with the name of the typedef. So\n# typedef struct TypeS {} TypeT, will appear in the documentation as a struct\n# with name TypeT. When disabled the typedef will appear as a member of a file,\n# namespace, or class. And the struct will be named TypeS. This can typically be\n# useful for C code in case the coding convention dictates that all compound\n# types are typedef'ed and only the typedef is referenced, never the tag name.\n# The default value is: NO.\n\nTYPEDEF_HIDES_STRUCT = YES\n\n# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This\n# cache is used to resolve symbols given their name and scope. Since this can be\n# an expensive process and often the same symbol appears multiple times in the\n# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small\n# doxygen will become slower. If the cache is too large, memory is wasted. The\n# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range\n# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536\n# symbols. At the end of a run doxygen will report the cache usage and suggest\n# the optimal cache size from a speed point of view.\n# Minimum value: 0, maximum value: 9, default value: 0.\n\nLOOKUP_CACHE_SIZE = 0\n\n# The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use\n# during processing. When set to 0 doxygen will based this on the number of\n# cores available in the system. You can set it explicitly to a value larger\n# than 0 to get more control over the balance between CPU load and processing\n# speed. At this moment only the input processing can be done using multiple\n# threads. Since this is still an experimental feature the default is set to 1,\n# which effectively disables parallel processing. Please report any issues you\n# encounter. Generating dot graphs in parallel is controlled by the\n# DOT_NUM_THREADS setting.\n# Minimum value: 0, maximum value: 32, default value: 1.\n\nNUM_PROC_THREADS = 1\n\n# If the TIMESTAMP tag is set different from NO then each generated page will\n# contain the date or date and time when the page was generated. Setting this to\n# NO can help when comparing the output of multiple runs.\n# Possible values are: YES, NO, DATETIME and DATE.\n# The default value is: NO.\n\nTIMESTAMP = NO\n\n#---------------------------------------------------------------------------\n# Build related configuration options\n#---------------------------------------------------------------------------\n\n# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in\n# documentation are documented, even if no documentation was available. Private\n# class members and static file members will be hidden unless the\n# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.\n# Note: This will also disable the warnings about undocumented members that are\n# normally produced when WARNINGS is set to YES.\n# The default value is: NO.\n\nEXTRACT_ALL = NO\n\n# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will\n# be included in the documentation.\n# The default value is: NO.\n\nEXTRACT_PRIVATE = NO\n\n# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual\n# methods of a class will be included in the documentation.\n# The default value is: NO.\n\nEXTRACT_PRIV_VIRTUAL = NO\n\n# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal\n# scope will be included in the documentation.\n# The default value is: NO.\n\nEXTRACT_PACKAGE = NO\n\n# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be\n# included in the documentation.\n# The default value is: NO.\n\nEXTRACT_STATIC = NO\n\n# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined\n# locally in source files will be included in the documentation. If set to NO,\n# only classes defined in header files are included. Does not have any effect\n# for Java sources.\n# The default value is: YES.\n\nEXTRACT_LOCAL_CLASSES = YES\n\n# This flag is only useful for Objective-C code. If set to YES, local methods,\n# which are defined in the implementation section but not in the interface are\n# included in the documentation. If set to NO, only methods in the interface are\n# included.\n# The default value is: NO.\n\nEXTRACT_LOCAL_METHODS = NO\n\n# If this flag is set to YES, the members of anonymous namespaces will be\n# extracted and appear in the documentation as a namespace called\n# 'anonymous_namespace{file}', where file will be replaced with the base name of\n# the file that contains the anonymous namespace. By default anonymous namespace\n# are hidden.\n# The default value is: NO.\n\nEXTRACT_ANON_NSPACES = NO\n\n# If this flag is set to YES, the name of an unnamed parameter in a declaration\n# will be determined by the corresponding definition. By default unnamed\n# parameters remain unnamed in the output.\n# The default value is: YES.\n\nRESOLVE_UNNAMED_PARAMS = YES\n\n# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all\n# undocumented members inside documented classes or files. If set to NO these\n# members will be included in the various overviews, but no documentation\n# section is generated. This option has no effect if EXTRACT_ALL is enabled.\n# The default value is: NO.\n\nHIDE_UNDOC_MEMBERS = NO\n\n# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all\n# undocumented classes that are normally visible in the class hierarchy. If set\n# to NO, these classes will be included in the various overviews. This option\n# will also hide undocumented C++ concepts if enabled. This option has no effect\n# if EXTRACT_ALL is enabled.\n# The default value is: NO.\n\nHIDE_UNDOC_CLASSES = NO\n\n# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend\n# declarations. If set to NO, these declarations will be included in the\n# documentation.\n# The default value is: NO.\n\nHIDE_FRIEND_COMPOUNDS = NO\n\n# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any\n# documentation blocks found inside the body of a function. If set to NO, these\n# blocks will be appended to the function's detailed documentation block.\n# The default value is: NO.\n\nHIDE_IN_BODY_DOCS = NO\n\n# The INTERNAL_DOCS tag determines if documentation that is typed after a\n# \\internal command is included. If the tag is set to NO then the documentation\n# will be excluded. Set it to YES to include the internal documentation.\n# The default value is: NO.\n\nINTERNAL_DOCS = NO\n\n# With the correct setting of option CASE_SENSE_NAMES doxygen will better be\n# able to match the capabilities of the underlying filesystem. In case the\n# filesystem is case sensitive (i.e. it supports files in the same directory\n# whose names only differ in casing), the option must be set to YES to properly\n# deal with such files in case they appear in the input. For filesystems that\n# are not case sensitive the option should be set to NO to properly deal with\n# output files written for symbols that only differ in casing, such as for two\n# classes, one named CLASS and the other named Class, and to also support\n# references to files without having to specify the exact matching casing. On\n# Windows (including Cygwin) and MacOS, users should typically set this option\n# to NO, whereas on Linux or other Unix flavors it should typically be set to\n# YES.\n# Possible values are: SYSTEM, NO and YES.\n# The default value is: SYSTEM.\n\nCASE_SENSE_NAMES = YES\n\n# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with\n# their full class and namespace scopes in the documentation. If set to YES, the\n# scope will be hidden.\n# The default value is: NO.\n\nHIDE_SCOPE_NAMES = NO\n\n# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will\n# append additional text to a page's title, such as Class Reference. If set to\n# YES the compound reference will be hidden.\n# The default value is: NO.\n\nHIDE_COMPOUND_REFERENCE= NO\n\n# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class\n# will show which file needs to be included to use the class.\n# The default value is: YES.\n\nSHOW_HEADERFILE = YES\n\n# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of\n# the files that are included by a file in the documentation of that file.\n# The default value is: YES.\n\nSHOW_INCLUDE_FILES = NO\n\n# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each\n# grouped member an include statement to the documentation, telling the reader\n# which file to include in order to use the member.\n# The default value is: NO.\n\nSHOW_GROUPED_MEMB_INC = NO\n\n# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include\n# files with double quotes in the documentation rather than with sharp brackets.\n# The default value is: NO.\n\nFORCE_LOCAL_INCLUDES = NO\n\n# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the\n# documentation for inline members.\n# The default value is: YES.\n\nINLINE_INFO = YES\n\n# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the\n# (detailed) documentation of file and class members alphabetically by member\n# name. If set to NO, the members will appear in declaration order.\n# The default value is: YES.\n\nSORT_MEMBER_DOCS = YES\n\n# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief\n# descriptions of file, namespace and class members alphabetically by member\n# name. If set to NO, the members will appear in declaration order. Note that\n# this will also influence the order of the classes in the class list.\n# The default value is: NO.\n\nSORT_BRIEF_DOCS = NO\n\n# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the\n# (brief and detailed) documentation of class members so that constructors and\n# destructors are listed first. If set to NO the constructors will appear in the\n# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.\n# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief\n# member documentation.\n# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting\n# detailed member documentation.\n# The default value is: NO.\n\nSORT_MEMBERS_CTORS_1ST = NO\n\n# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy\n# of group names into alphabetical order. If set to NO the group names will\n# appear in their defined order.\n# The default value is: NO.\n\nSORT_GROUP_NAMES = NO\n\n# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by\n# fully-qualified names, including namespaces. If set to NO, the class list will\n# be sorted only by class name, not including the namespace part.\n# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.\n# Note: This option applies only to the class list, not to the alphabetical\n# list.\n# The default value is: NO.\n\nSORT_BY_SCOPE_NAME = NO\n\n# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper\n# type resolution of all parameters of a function it will reject a match between\n# the prototype and the implementation of a member function even if there is\n# only one candidate or it is obvious which candidate to choose by doing a\n# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still\n# accept a match between prototype and implementation in such cases.\n# The default value is: NO.\n\nSTRICT_PROTO_MATCHING = NO\n\n# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo\n# list. This list is created by putting \\todo commands in the documentation.\n# The default value is: YES.\n\nGENERATE_TODOLIST = YES\n\n# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test\n# list. This list is created by putting \\test commands in the documentation.\n# The default value is: YES.\n\nGENERATE_TESTLIST = YES\n\n# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug\n# list. This list is created by putting \\bug commands in the documentation.\n# The default value is: YES.\n\nGENERATE_BUGLIST = YES\n\n# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)\n# the deprecated list. This list is created by putting \\deprecated commands in\n# the documentation.\n# The default value is: YES.\n\nGENERATE_DEPRECATEDLIST= YES\n\n# The ENABLED_SECTIONS tag can be used to enable conditional documentation\n# sections, marked by \\if ... \\endif and \\cond \n# ... \\endcond blocks.\n\nENABLED_SECTIONS =\n\n# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the\n# initial value of a variable or macro / define can have for it to appear in the\n# documentation. If the initializer consists of more lines than specified here\n# it will be hidden. Use a value of 0 to hide initializers completely. The\n# appearance of the value of individual variables and macros / defines can be\n# controlled using \\showinitializer or \\hideinitializer command in the\n# documentation regardless of this setting.\n# Minimum value: 0, maximum value: 10000, default value: 30.\n\nMAX_INITIALIZER_LINES = 30\n\n# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at\n# the bottom of the documentation of classes and structs. If set to YES, the\n# list will mention the files that were used to generate the documentation.\n# The default value is: YES.\n\nSHOW_USED_FILES = NO\n\n# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This\n# will remove the Files entry from the Quick Index and from the Folder Tree View\n# (if specified).\n# The default value is: YES.\n\nSHOW_FILES = NO\n\n# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces\n# page. This will remove the Namespaces entry from the Quick Index and from the\n# Folder Tree View (if specified).\n# The default value is: YES.\n\nSHOW_NAMESPACES = YES\n\n# The FILE_VERSION_FILTER tag can be used to specify a program or script that\n# doxygen should invoke to get the current version for each file (typically from\n# the version control system). Doxygen will invoke the program by executing (via\n# popen()) the command command input-file, where command is the value of the\n# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided\n# by doxygen. Whatever the program writes to standard output is used as the file\n# version. For an example see the documentation.\n\nFILE_VERSION_FILTER =\n\n# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed\n# by doxygen. The layout file controls the global structure of the generated\n# output files in an output format independent way. To create the layout file\n# that represents doxygen's defaults, run doxygen with the -l option. You can\n# optionally specify a file name after the option, if omitted DoxygenLayout.xml\n# will be used as the name of the layout file. See also section \"Changing the\n# layout of pages\" for information.\n#\n# Note that if you run doxygen from a directory containing a file called\n# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE\n# tag is left empty.\n\nLAYOUT_FILE =\n\n# The CITE_BIB_FILES tag can be used to specify one or more bib files containing\n# the reference definitions. This must be a list of .bib files. The .bib\n# extension is automatically appended if omitted. This requires the bibtex tool\n# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.\n# For LaTeX the style of the bibliography can be controlled using\n# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the\n# search path. See also \\cite for info how to create references.\n\nCITE_BIB_FILES =\n\n#---------------------------------------------------------------------------\n# Configuration options related to warning and progress messages\n#---------------------------------------------------------------------------\n\n# The QUIET tag can be used to turn on/off the messages that are generated to\n# standard output by doxygen. If QUIET is set to YES this implies that the\n# messages are off.\n# The default value is: NO.\n\nQUIET = NO\n\n# The WARNINGS tag can be used to turn on/off the warning messages that are\n# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES\n# this implies that the warnings are on.\n#\n# Tip: Turn warnings on while writing the documentation.\n# The default value is: YES.\n\nWARNINGS = YES\n\n# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate\n# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag\n# will automatically be disabled.\n# The default value is: YES.\n\nWARN_IF_UNDOCUMENTED = NO\n\n# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for\n# potential errors in the documentation, such as documenting some parameters in\n# a documented function twice, or documenting parameters that don't exist or\n# using markup commands wrongly.\n# The default value is: YES.\n\nWARN_IF_DOC_ERROR = YES\n\n# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete\n# function parameter documentation. If set to NO, doxygen will accept that some\n# parameters have no documentation without warning.\n# The default value is: YES.\n\nWARN_IF_INCOMPLETE_DOC = YES\n\n# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that\n# are documented, but have no documentation for their parameters or return\n# value. If set to NO, doxygen will only warn about wrong parameter\n# documentation, but not about the absence of documentation. If EXTRACT_ALL is\n# set to YES then this flag will automatically be disabled. See also\n# WARN_IF_INCOMPLETE_DOC\n# The default value is: NO.\n\nWARN_NO_PARAMDOC = NO\n\n# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about\n# undocumented enumeration values. If set to NO, doxygen will accept\n# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag\n# will automatically be disabled.\n# The default value is: NO.\n\nWARN_IF_UNDOC_ENUM_VAL = NO\n\n# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when\n# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS\n# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but\n# at the end of the doxygen process doxygen will return with a non-zero status.\n# If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then doxygen behaves\n# like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined doxygen will not\n# write the warning messages in between other messages but write them at the end\n# of a run, in case a WARN_LOGFILE is defined the warning messages will be\n# besides being in the defined file also be shown at the end of a run, unless\n# the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case\n# the behavior will remain as with the setting FAIL_ON_WARNINGS.\n# Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT.\n# The default value is: NO.\n\nWARN_AS_ERROR = NO\n\n# The WARN_FORMAT tag determines the format of the warning messages that doxygen\n# can produce. The string should contain the $file, $line, and $text tags, which\n# will be replaced by the file and line number from which the warning originated\n# and the warning text. Optionally the format may contain $version, which will\n# be replaced by the version of the file (if it could be obtained via\n# FILE_VERSION_FILTER)\n# See also: WARN_LINE_FORMAT\n# The default value is: $file:$line: $text.\n\nWARN_FORMAT = \"$file:$line: $text\"\n\n# In the $text part of the WARN_FORMAT command it is possible that a reference\n# to a more specific place is given. To make it easier to jump to this place\n# (outside of doxygen) the user can define a custom \"cut\" / \"paste\" string.\n# Example:\n# WARN_LINE_FORMAT = \"'vi $file +$line'\"\n# See also: WARN_FORMAT\n# The default value is: at line $line of file $file.\n\nWARN_LINE_FORMAT = \"at line $line of file $file\"\n\n# The WARN_LOGFILE tag can be used to specify a file to which warning and error\n# messages should be written. If left blank the output is written to standard\n# error (stderr). In case the file specified cannot be opened for writing the\n# warning and error messages are written to standard error. When as file - is\n# specified the warning and error messages are written to standard output\n# (stdout).\n\nWARN_LOGFILE =\n\n#---------------------------------------------------------------------------\n# Configuration options related to the input files\n#---------------------------------------------------------------------------\n\n# The INPUT tag is used to specify the files and/or directories that contain\n# documented source files. You may enter file names like myfile.cpp or\n# directories like /usr/src/myproject. Separate the files or directories with\n# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING\n# Note: If this tag is empty the current directory is searched.\n\nINPUT = ../src/cocotb/share/include/gpi.h\n\n# This tag can be used to specify the character encoding of the source files\n# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses\n# libiconv (or the iconv built into libc) for the transcoding. See the libiconv\n# documentation (see:\n# https://www.gnu.org/software/libiconv/) for the list of possible encodings.\n# See also: INPUT_FILE_ENCODING\n# The default value is: UTF-8.\n\nINPUT_ENCODING = UTF-8\n\n# This tag can be used to specify the character encoding of the source files\n# that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify\n# character encoding on a per file pattern basis. Doxygen will compare the file\n# name with each pattern and apply the encoding instead of the default\n# INPUT_ENCODING) if there is a match. The character encodings are a list of the\n# form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding\n# \"INPUT_ENCODING\" for further information on supported encodings.\n\nINPUT_FILE_ENCODING =\n\n# If the value of the INPUT tag contains directories, you can use the\n# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and\n# *.h) to filter out the source-files in the directories.\n#\n# Note that for custom extensions or not directly supported extensions you also\n# need to set EXTENSION_MAPPING for the extension otherwise the files are not\n# read by doxygen.\n#\n# Note the list of default checked file patterns might differ from the list of\n# default file extension mappings.\n#\n# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm,\n# *.cpp, *.cppm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl,\n# *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.ixx, *.l, *.cs, *.d, *.php,\n# *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be\n# provided as doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,\n# *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.\n\nFILE_PATTERNS =\n\n# The RECURSIVE tag can be used to specify whether or not subdirectories should\n# be searched for input files as well.\n# The default value is: NO.\n\nRECURSIVE = YES\n\n# The EXCLUDE tag can be used to specify files and/or directories that should be\n# excluded from the INPUT source files. This way you can easily exclude a\n# subdirectory from a directory tree whose root is specified with the INPUT tag.\n#\n# Note that relative paths are relative to the directory from which doxygen is\n# run.\n\nEXCLUDE =\n\n# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or\n# directories that are symbolic links (a Unix file system feature) are excluded\n# from the input.\n# The default value is: NO.\n\nEXCLUDE_SYMLINKS = NO\n\n# If the value of the INPUT tag contains directories, you can use the\n# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude\n# certain files from those directories.\n#\n# Note that the wildcards are matched against the file with absolute path, so to\n# exclude all test directories for example use the pattern */test/*\n\nEXCLUDE_PATTERNS =\n\n# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names\n# (namespaces, classes, functions, etc.) that should be excluded from the\n# output. The symbol name can be a fully qualified name, a word, or if the\n# wildcard * is used, a substring. Examples: ANamespace, AClass,\n# ANamespace::AClass, ANamespace::*Test\n\nEXCLUDE_SYMBOLS =\n\n# The EXAMPLE_PATH tag can be used to specify one or more files or directories\n# that contain example code fragments that are included (see the \\include\n# command).\n\nEXAMPLE_PATH =\n\n# If the value of the EXAMPLE_PATH tag contains directories, you can use the\n# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and\n# *.h) to filter out the source-files in the directories. If left blank all\n# files are included.\n\nEXAMPLE_PATTERNS =\n\n# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be\n# searched for input files to be used with the \\include or \\dontinclude commands\n# irrespective of the value of the RECURSIVE tag.\n# The default value is: NO.\n\nEXAMPLE_RECURSIVE = NO\n\n# The IMAGE_PATH tag can be used to specify one or more files or directories\n# that contain images that are to be included in the documentation (see the\n# \\image command).\n\nIMAGE_PATH =\n\n# The INPUT_FILTER tag can be used to specify a program that doxygen should\n# invoke to filter for each input file. Doxygen will invoke the filter program\n# by executing (via popen()) the command:\n#\n# \n#\n# where is the value of the INPUT_FILTER tag, and is the\n# name of an input file. Doxygen will then use the output that the filter\n# program writes to standard output. If FILTER_PATTERNS is specified, this tag\n# will be ignored.\n#\n# Note that the filter must not add or remove lines; it is applied before the\n# code is scanned, but not when the output code is generated. If lines are added\n# or removed, the anchors will not be placed correctly.\n#\n# Note that doxygen will use the data processed and written to standard output\n# for further processing, therefore nothing else, like debug statements or used\n# commands (so in case of a Windows batch file always use @echo OFF), should be\n# written to standard output.\n#\n# Note that for custom extensions or not directly supported extensions you also\n# need to set EXTENSION_MAPPING for the extension otherwise the files are not\n# properly processed by doxygen.\n\nINPUT_FILTER =\n\n# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern\n# basis. Doxygen will compare the file name with each pattern and apply the\n# filter if there is a match. The filters are a list of the form: pattern=filter\n# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how\n# filters are used. If the FILTER_PATTERNS tag is empty or if none of the\n# patterns match the file name, INPUT_FILTER is applied.\n#\n# Note that for custom extensions or not directly supported extensions you also\n# need to set EXTENSION_MAPPING for the extension otherwise the files are not\n# properly processed by doxygen.\n\nFILTER_PATTERNS =\n\n# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using\n# INPUT_FILTER) will also be used to filter the input files that are used for\n# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).\n# The default value is: NO.\n\nFILTER_SOURCE_FILES = NO\n\n# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file\n# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and\n# it is also possible to disable source filtering for a specific pattern using\n# *.ext= (so without naming a filter).\n# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.\n\nFILTER_SOURCE_PATTERNS =\n\n# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that\n# is part of the input, its contents will be placed on the main page\n# (index.html). This can be useful if you have a project on for instance GitHub\n# and want to reuse the introduction page also for the doxygen output.\n\nUSE_MDFILE_AS_MAINPAGE =\n\n# The Fortran standard specifies that for fixed formatted Fortran code all\n# characters from position 72 are to be considered as comment. A common\n# extension is to allow longer lines before the automatic comment starts. The\n# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can\n# be processed before the automatic comment starts.\n# Minimum value: 7, maximum value: 10000, default value: 72.\n\nFORTRAN_COMMENT_AFTER = 72\n\n#---------------------------------------------------------------------------\n# Configuration options related to source browsing\n#---------------------------------------------------------------------------\n\n# If the SOURCE_BROWSER tag is set to YES then a list of source files will be\n# generated. Documented entities will be cross-referenced with these sources.\n#\n# Note: To get rid of all source code in the generated output, make sure that\n# also VERBATIM_HEADERS is set to NO.\n# The default value is: NO.\n\nSOURCE_BROWSER = NO\n\n# Setting the INLINE_SOURCES tag to YES will include the body of functions,\n# classes and enums directly into the documentation.\n# The default value is: NO.\n\nINLINE_SOURCES = NO\n\n# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any\n# special comment blocks from generated source code fragments. Normal C, C++ and\n# Fortran comments will always remain visible.\n# The default value is: YES.\n\nSTRIP_CODE_COMMENTS = YES\n\n# If the REFERENCED_BY_RELATION tag is set to YES then for each documented\n# entity all documented functions referencing it will be listed.\n# The default value is: NO.\n\nREFERENCED_BY_RELATION = NO\n\n# If the REFERENCES_RELATION tag is set to YES then for each documented function\n# all documented entities called/used by that function will be listed.\n# The default value is: NO.\n\nREFERENCES_RELATION = NO\n\n# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set\n# to YES then the hyperlinks from functions in REFERENCES_RELATION and\n# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will\n# link to the documentation.\n# The default value is: YES.\n\nREFERENCES_LINK_SOURCE = YES\n\n# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the\n# source code will show a tooltip with additional information such as prototype,\n# brief description and links to the definition and documentation. Since this\n# will make the HTML file larger and loading of large files a bit slower, you\n# can opt to disable this feature.\n# The default value is: YES.\n# This tag requires that the tag SOURCE_BROWSER is set to YES.\n\nSOURCE_TOOLTIPS = YES\n\n# If the USE_HTAGS tag is set to YES then the references to source code will\n# point to the HTML generated by the htags(1) tool instead of doxygen built-in\n# source browser. The htags tool is part of GNU's global source tagging system\n# (see https://www.gnu.org/software/global/global.html). You will need version\n# 4.8.6 or higher.\n#\n# To use it do the following:\n# - Install the latest version of global\n# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file\n# - Make sure the INPUT points to the root of the source tree\n# - Run doxygen as normal\n#\n# Doxygen will invoke htags (and that will in turn invoke gtags), so these\n# tools must be available from the command line (i.e. in the search path).\n#\n# The result: instead of the source browser generated by doxygen, the links to\n# source code will now point to the output of htags.\n# The default value is: NO.\n# This tag requires that the tag SOURCE_BROWSER is set to YES.\n\nUSE_HTAGS = NO\n\n# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a\n# verbatim copy of the header file for each class for which an include is\n# specified. Set to NO to disable this.\n# See also: Section \\class.\n# The default value is: YES.\n\nVERBATIM_HEADERS = YES\n\n# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the\n# clang parser (see:\n# http://clang.llvm.org/) for more accurate parsing at the cost of reduced\n# performance. This can be particularly helpful with template rich C++ code for\n# which doxygen's built-in parser lacks the necessary type information.\n# Note: The availability of this option depends on whether or not doxygen was\n# generated with the -Duse_libclang=ON option for CMake.\n# The default value is: NO.\n\nCLANG_ASSISTED_PARSING = NO\n\n# If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS\n# tag is set to YES then doxygen will add the directory of each input to the\n# include path.\n# The default value is: YES.\n# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.\n\nCLANG_ADD_INC_PATHS = YES\n\n# If clang assisted parsing is enabled you can provide the compiler with command\n# line options that you would normally use when invoking the compiler. Note that\n# the include paths will already be set by doxygen for the files and directories\n# specified with INPUT and INCLUDE_PATH.\n# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.\n\nCLANG_OPTIONS =\n\n# If clang assisted parsing is enabled you can provide the clang parser with the\n# path to the directory containing a file called compile_commands.json. This\n# file is the compilation database (see:\n# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the\n# options used when the source files were built. This is equivalent to\n# specifying the -p option to a clang tool, such as clang-check. These options\n# will then be passed to the parser. Any options specified with CLANG_OPTIONS\n# will be added as well.\n# Note: The availability of this option depends on whether or not doxygen was\n# generated with the -Duse_libclang=ON option for CMake.\n\nCLANG_DATABASE_PATH =\n\n#---------------------------------------------------------------------------\n# Configuration options related to the alphabetical class index\n#---------------------------------------------------------------------------\n\n# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all\n# compounds will be generated. Enable this if the project contains a lot of\n# classes, structs, unions or interfaces.\n# The default value is: YES.\n\nALPHABETICAL_INDEX = YES\n\n# The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes)\n# that should be ignored while generating the index headers. The IGNORE_PREFIX\n# tag works for classes, function and member names. The entity will be placed in\n# the alphabetical list under the first letter of the entity name that remains\n# after removing the prefix.\n# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.\n\nIGNORE_PREFIX =\n\n#---------------------------------------------------------------------------\n# Configuration options related to the HTML output\n#---------------------------------------------------------------------------\n\n# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output\n# The default value is: YES.\n\nGENERATE_HTML = NO\n\n# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a\n# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of\n# it.\n# The default directory is: html.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_OUTPUT = html\n\n# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each\n# generated HTML page (for example: .htm, .php, .asp).\n# The default value is: .html.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_FILE_EXTENSION = .html\n\n# The HTML_HEADER tag can be used to specify a user-defined HTML header file for\n# each generated HTML page. If the tag is left blank doxygen will generate a\n# standard header.\n#\n# To get valid HTML the header file that includes any scripts and style sheets\n# that doxygen needs, which is dependent on the configuration options used (e.g.\n# the setting GENERATE_TREEVIEW). It is highly recommended to start with a\n# default header using\n# doxygen -w html new_header.html new_footer.html new_stylesheet.css\n# YourConfigFile\n# and then modify the file new_header.html. See also section \"Doxygen usage\"\n# for information on how to generate the default header that doxygen normally\n# uses.\n# Note: The header is subject to change so you typically have to regenerate the\n# default header when upgrading to a newer version of doxygen. For a description\n# of the possible markers and block names see the documentation.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_HEADER =\n\n# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each\n# generated HTML page. If the tag is left blank doxygen will generate a standard\n# footer. See HTML_HEADER for more information on how to generate a default\n# footer and what special commands can be used inside the footer. See also\n# section \"Doxygen usage\" for information on how to generate the default footer\n# that doxygen normally uses.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_FOOTER =\n\n# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style\n# sheet that is used by each HTML page. It can be used to fine-tune the look of\n# the HTML output. If left blank doxygen will generate a default style sheet.\n# See also section \"Doxygen usage\" for information on how to generate the style\n# sheet that doxygen normally uses.\n# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as\n# it is more robust and this tag (HTML_STYLESHEET) will in the future become\n# obsolete.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_STYLESHEET =\n\n# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined\n# cascading style sheets that are included after the standard style sheets\n# created by doxygen. Using this option one can overrule certain style aspects.\n# This is preferred over using HTML_STYLESHEET since it does not replace the\n# standard style sheet and is therefore more robust against future updates.\n# Doxygen will copy the style sheet files to the output directory.\n# Note: The order of the extra style sheet files is of importance (e.g. the last\n# style sheet in the list overrules the setting of the previous ones in the\n# list).\n# Note: Since the styling of scrollbars can currently not be overruled in\n# Webkit/Chromium, the styling will be left out of the default doxygen.css if\n# one or more extra stylesheets have been specified. So if scrollbar\n# customization is desired it has to be added explicitly. For an example see the\n# documentation.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_EXTRA_STYLESHEET =\n\n# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or\n# other source files which should be copied to the HTML output directory. Note\n# that these files will be copied to the base HTML output directory. Use the\n# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these\n# files. In the HTML_STYLESHEET file, use the file name only. Also note that the\n# files will be copied as-is; there are no commands or markers available.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_EXTRA_FILES =\n\n# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output\n# should be rendered with a dark or light theme.\n# Possible values are: LIGHT always generate light mode output, DARK always\n# generate dark mode output, AUTO_LIGHT automatically set the mode according to\n# the user preference, use light mode if no preference is set (the default),\n# AUTO_DARK automatically set the mode according to the user preference, use\n# dark mode if no preference is set and TOGGLE allow to user to switch between\n# light and dark mode via a button.\n# The default value is: AUTO_LIGHT.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_COLORSTYLE = AUTO_LIGHT\n\n# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen\n# will adjust the colors in the style sheet and background images according to\n# this color. Hue is specified as an angle on a color-wheel, see\n# https://en.wikipedia.org/wiki/Hue for more information. For instance the value\n# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300\n# purple, and 360 is red again.\n# Minimum value: 0, maximum value: 359, default value: 220.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_COLORSTYLE_HUE = 220\n\n# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors\n# in the HTML output. For a value of 0 the output will use gray-scales only. A\n# value of 255 will produce the most vivid colors.\n# Minimum value: 0, maximum value: 255, default value: 100.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_COLORSTYLE_SAT = 100\n\n# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the\n# luminance component of the colors in the HTML output. Values below 100\n# gradually make the output lighter, whereas values above 100 make the output\n# darker. The value divided by 100 is the actual gamma applied, so 80 represents\n# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not\n# change the gamma.\n# Minimum value: 40, maximum value: 240, default value: 80.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_COLORSTYLE_GAMMA = 80\n\n# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML\n# documentation will contain a main index with vertical navigation menus that\n# are dynamically created via JavaScript. If disabled, the navigation index will\n# consists of multiple levels of tabs that are statically embedded in every HTML\n# page. Disable this option to support browsers that do not have JavaScript,\n# like the Qt help browser.\n# The default value is: YES.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_DYNAMIC_MENUS = YES\n\n# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML\n# documentation will contain sections that can be hidden and shown after the\n# page has loaded.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_DYNAMIC_SECTIONS = NO\n\n# If the HTML_CODE_FOLDING tag is set to YES then classes and functions can be\n# dynamically folded and expanded in the generated HTML source code.\n# The default value is: YES.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_CODE_FOLDING = YES\n\n# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries\n# shown in the various tree structured indices initially; the user can expand\n# and collapse entries dynamically later on. Doxygen will expand the tree to\n# such a level that at most the specified number of entries are visible (unless\n# a fully collapsed tree already exceeds this amount). So setting the number of\n# entries 1 will produce a full collapsed tree by default. 0 is a special value\n# representing an infinite number of entries and will result in a full expanded\n# tree by default.\n# Minimum value: 0, maximum value: 9999, default value: 100.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_INDEX_NUM_ENTRIES = 100\n\n# If the GENERATE_DOCSET tag is set to YES, additional index files will be\n# generated that can be used as input for Apple's Xcode 3 integrated development\n# environment (see:\n# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To\n# create a documentation set, doxygen will generate a Makefile in the HTML\n# output directory. Running make will produce the docset in that directory and\n# running make install will install the docset in\n# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at\n# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy\n# genXcode/_index.html for more information.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nGENERATE_DOCSET = NO\n\n# This tag determines the name of the docset feed. A documentation feed provides\n# an umbrella under which multiple documentation sets from a single provider\n# (such as a company or product suite) can be grouped.\n# The default value is: Doxygen generated docs.\n# This tag requires that the tag GENERATE_DOCSET is set to YES.\n\nDOCSET_FEEDNAME = \"Doxygen generated docs\"\n\n# This tag determines the URL of the docset feed. A documentation feed provides\n# an umbrella under which multiple documentation sets from a single provider\n# (such as a company or product suite) can be grouped.\n# This tag requires that the tag GENERATE_DOCSET is set to YES.\n\nDOCSET_FEEDURL =\n\n# This tag specifies a string that should uniquely identify the documentation\n# set bundle. This should be a reverse domain-name style string, e.g.\n# com.mycompany.MyDocSet. Doxygen will append .docset to the name.\n# The default value is: org.doxygen.Project.\n# This tag requires that the tag GENERATE_DOCSET is set to YES.\n\nDOCSET_BUNDLE_ID = org.doxygen.Project\n\n# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify\n# the documentation publisher. This should be a reverse domain-name style\n# string, e.g. com.mycompany.MyDocSet.documentation.\n# The default value is: org.doxygen.Publisher.\n# This tag requires that the tag GENERATE_DOCSET is set to YES.\n\nDOCSET_PUBLISHER_ID = org.doxygen.Publisher\n\n# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.\n# The default value is: Publisher.\n# This tag requires that the tag GENERATE_DOCSET is set to YES.\n\nDOCSET_PUBLISHER_NAME = Publisher\n\n# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three\n# additional HTML index files: index.hhp, index.hhc, and index.hhk. The\n# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop\n# on Windows. In the beginning of 2021 Microsoft took the original page, with\n# a.o. the download links, offline the HTML help workshop was already many years\n# in maintenance mode). You can download the HTML help workshop from the web\n# archives at Installation executable (see:\n# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo\n# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe).\n#\n# The HTML Help Workshop contains a compiler that can convert all HTML output\n# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML\n# files are now used as the Windows 98 help format, and will replace the old\n# Windows help format (.hlp) on all Windows platforms in the future. Compressed\n# HTML files also contain an index, a table of contents, and you can search for\n# words in the documentation. The HTML workshop also contains a viewer for\n# compressed HTML files.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nGENERATE_HTMLHELP = NO\n\n# The CHM_FILE tag can be used to specify the file name of the resulting .chm\n# file. You can add a path in front of the file if the result should not be\n# written to the html output directory.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nCHM_FILE =\n\n# The HHC_LOCATION tag can be used to specify the location (absolute path\n# including file name) of the HTML help compiler (hhc.exe). If non-empty,\n# doxygen will try to run the HTML help compiler on the generated index.hhp.\n# The file has to be specified with full path.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nHHC_LOCATION =\n\n# The GENERATE_CHI flag controls if a separate .chi index file is generated\n# (YES) or that it should be included in the main .chm file (NO).\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nGENERATE_CHI = NO\n\n# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)\n# and project file content.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nCHM_INDEX_ENCODING =\n\n# The BINARY_TOC flag controls whether a binary table of contents is generated\n# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it\n# enables the Previous and Next buttons.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nBINARY_TOC = NO\n\n# The TOC_EXPAND flag can be set to YES to add extra items for group members to\n# the table of contents of the HTML help documentation and to the tree view.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nTOC_EXPAND = NO\n\n# The SITEMAP_URL tag is used to specify the full URL of the place where the\n# generated documentation will be placed on the server by the user during the\n# deployment of the documentation. The generated sitemap is called sitemap.xml\n# and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL\n# is specified no sitemap is generated. For information about the sitemap\n# protocol see https://www.sitemaps.org\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nSITEMAP_URL =\n\n# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and\n# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that\n# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help\n# (.qch) of the generated HTML documentation.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nGENERATE_QHP = NO\n\n# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify\n# the file name of the resulting .qch file. The path specified is relative to\n# the HTML output folder.\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQCH_FILE =\n\n# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help\n# Project output. For more information please see Qt Help Project / Namespace\n# (see:\n# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).\n# The default value is: org.doxygen.Project.\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHP_NAMESPACE = org.doxygen.Project\n\n# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt\n# Help Project output. For more information please see Qt Help Project / Virtual\n# Folders (see:\n# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).\n# The default value is: doc.\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHP_VIRTUAL_FOLDER = doc\n\n# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom\n# filter to add. For more information please see Qt Help Project / Custom\n# Filters (see:\n# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHP_CUST_FILTER_NAME =\n\n# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the\n# custom filter to add. For more information please see Qt Help Project / Custom\n# Filters (see:\n# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHP_CUST_FILTER_ATTRS =\n\n# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this\n# project's filter section matches. Qt Help Project / Filter Attributes (see:\n# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHP_SECT_FILTER_ATTRS =\n\n# The QHG_LOCATION tag can be used to specify the location (absolute path\n# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to\n# run qhelpgenerator on the generated .qhp file.\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHG_LOCATION =\n\n# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be\n# generated, together with the HTML files, they form an Eclipse help plugin. To\n# install this plugin and make it available under the help contents menu in\n# Eclipse, the contents of the directory containing the HTML and XML files needs\n# to be copied into the plugins directory of eclipse. The name of the directory\n# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.\n# After copying Eclipse needs to be restarted before the help appears.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nGENERATE_ECLIPSEHELP = NO\n\n# A unique identifier for the Eclipse help plugin. When installing the plugin\n# the directory name containing the HTML and XML files should also have this\n# name. Each documentation set should have its own identifier.\n# The default value is: org.doxygen.Project.\n# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.\n\nECLIPSE_DOC_ID = org.doxygen.Project\n\n# If you want full control over the layout of the generated HTML pages it might\n# be necessary to disable the index and replace it with your own. The\n# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top\n# of each HTML page. A value of NO enables the index and the value YES disables\n# it. Since the tabs in the index contain the same information as the navigation\n# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nDISABLE_INDEX = NO\n\n# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index\n# structure should be generated to display hierarchical information. If the tag\n# value is set to YES, a side panel will be generated containing a tree-like\n# index structure (just like the one that is generated for HTML Help). For this\n# to work a browser that supports JavaScript, DHTML, CSS and frames is required\n# (i.e. any modern browser). Windows users are probably better off using the\n# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can\n# further fine tune the look of the index (see \"Fine-tuning the output\"). As an\n# example, the default style sheet generated by doxygen has an example that\n# shows how to put an image at the root of the tree instead of the PROJECT_NAME.\n# Since the tree basically has the same information as the tab index, you could\n# consider setting DISABLE_INDEX to YES when enabling this option.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nGENERATE_TREEVIEW = NO\n\n# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the\n# FULL_SIDEBAR option determines if the side bar is limited to only the treeview\n# area (value NO) or if it should extend to the full height of the window (value\n# YES). Setting this to YES gives a layout similar to\n# https://docs.readthedocs.io with more room for contents, but less room for the\n# project logo, title, and description. If either GENERATE_TREEVIEW or\n# DISABLE_INDEX is set to NO, this option has no effect.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nFULL_SIDEBAR = NO\n\n# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that\n# doxygen will group on one line in the generated HTML documentation.\n#\n# Note that a value of 0 will completely suppress the enum values from appearing\n# in the overview section.\n# Minimum value: 0, maximum value: 20, default value: 4.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nENUM_VALUES_PER_LINE = 4\n\n# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used\n# to set the initial width (in pixels) of the frame in which the tree is shown.\n# Minimum value: 0, maximum value: 1500, default value: 250.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nTREEVIEW_WIDTH = 250\n\n# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to\n# external symbols imported via tag files in a separate window.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nEXT_LINKS_IN_WINDOW = NO\n\n# If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email\n# addresses.\n# The default value is: YES.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nOBFUSCATE_EMAILS = YES\n\n# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg\n# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see\n# https://inkscape.org) to generate formulas as SVG images instead of PNGs for\n# the HTML output. These images will generally look nicer at scaled resolutions.\n# Possible values are: png (the default) and svg (looks nicer but requires the\n# pdf2svg or inkscape tool).\n# The default value is: png.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_FORMULA_FORMAT = png\n\n# Use this tag to change the font size of LaTeX formulas included as images in\n# the HTML documentation. When you change the font size after a successful\n# doxygen run you need to manually remove any form_*.png images from the HTML\n# output directory to force them to be regenerated.\n# Minimum value: 8, maximum value: 50, default value: 10.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nFORMULA_FONTSIZE = 10\n\n# The FORMULA_MACROFILE can contain LaTeX \\newcommand and \\renewcommand commands\n# to create new LaTeX commands to be used in formulas as building blocks. See\n# the section \"Including formulas\" for details.\n\nFORMULA_MACROFILE =\n\n# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see\n# https://www.mathjax.org) which uses client side JavaScript for the rendering\n# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX\n# installed or if you want to formulas look prettier in the HTML output. When\n# enabled you may also need to install MathJax separately and configure the path\n# to it using the MATHJAX_RELPATH option.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nUSE_MATHJAX = NO\n\n# With MATHJAX_VERSION it is possible to specify the MathJax version to be used.\n# Note that the different versions of MathJax have different requirements with\n# regards to the different settings, so it is possible that also other MathJax\n# settings have to be changed when switching between the different MathJax\n# versions.\n# Possible values are: MathJax_2 and MathJax_3.\n# The default value is: MathJax_2.\n# This tag requires that the tag USE_MATHJAX is set to YES.\n\nMATHJAX_VERSION = MathJax_2\n\n# When MathJax is enabled you can set the default output format to be used for\n# the MathJax output. For more details about the output format see MathJax\n# version 2 (see:\n# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3\n# (see:\n# http://docs.mathjax.org/en/latest/web/components/output.html).\n# Possible values are: HTML-CSS (which is slower, but has the best\n# compatibility. This is the name for Mathjax version 2, for MathJax version 3\n# this will be translated into chtml), NativeMML (i.e. MathML. Only supported\n# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This\n# is the name for Mathjax version 3, for MathJax version 2 this will be\n# translated into HTML-CSS) and SVG.\n# The default value is: HTML-CSS.\n# This tag requires that the tag USE_MATHJAX is set to YES.\n\nMATHJAX_FORMAT = HTML-CSS\n\n# When MathJax is enabled you need to specify the location relative to the HTML\n# output directory using the MATHJAX_RELPATH option. The destination directory\n# should contain the MathJax.js script. For instance, if the mathjax directory\n# is located at the same level as the HTML output directory, then\n# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax\n# Content Delivery Network so you can quickly see the result without installing\n# MathJax. However, it is strongly recommended to install a local copy of\n# MathJax from https://www.mathjax.org before deployment. The default value is:\n# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2\n# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3\n# This tag requires that the tag USE_MATHJAX is set to YES.\n\nMATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest\n\n# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax\n# extension names that should be enabled during MathJax rendering. For example\n# for MathJax version 2 (see\n# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions):\n# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols\n# For example for MathJax version 3 (see\n# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html):\n# MATHJAX_EXTENSIONS = ams\n# This tag requires that the tag USE_MATHJAX is set to YES.\n\nMATHJAX_EXTENSIONS =\n\n# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces\n# of code that will be used on startup of the MathJax code. See the MathJax site\n# (see:\n# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an\n# example see the documentation.\n# This tag requires that the tag USE_MATHJAX is set to YES.\n\nMATHJAX_CODEFILE =\n\n# When the SEARCHENGINE tag is enabled doxygen will generate a search box for\n# the HTML output. The underlying search engine uses javascript and DHTML and\n# should work on any modern browser. Note that when using HTML help\n# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)\n# there is already a search function so this one should typically be disabled.\n# For large projects the javascript based search engine can be slow, then\n# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to\n# search using the keyboard; to jump to the search box use + S\n# (what the is depends on the OS and browser, but it is typically\n# , /