diff --git a/.appveyor.yml b/.appveyor.yml deleted file mode 100644 index 67a739daf..000000000 --- a/.appveyor.yml +++ /dev/null @@ -1,69 +0,0 @@ -clone_depth: 5 - -environment: - matrix: - - GENERATOR : "Visual Studio 16 2019" - ARCHITECTURE : "-A x64" - APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2019 - QTDIR: C:\Qt\5.14.0\msvc2017_64 - PLATFORM: x64 - - GENERATOR : "Visual Studio 15 2017" - ARCHITECTURE : "" - APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2017 - QTDIR: C:\Qt\5.13.2\msvc2017 - PLATFORM: Win32 - - GENERATOR : "MinGW Makefiles" - ARCHITECTURE : "" - QTDIR: C:\Qt\5.11.3\mingw53_32 - PLATFORM: x86 - CMAKE_CXX_FLAGS_INIT: -DCATCH_CONFIG_NO_CPP11_TO_STRING - -configuration: - - Release - -install: - - set PATH=%QTDIR%\bin;%PATH% - - set Qt5_DIR=%QTDIR%\lib\cmake\Qt5 - - set PATH=C:\MinGW\bin;C:\MinGW\msys\1.0;%PATH% - - set PATH=C:\Qt\Tools\mingw530_32;%PATH% - - set PATH=%PATH:C:\Program Files\Git\usr\bin=% # trick to remove sh.exe - -before_build: - - mkdir build - - cd build - - mkdir bin - - set OUTPUT_DIR=%cd%\bin - - cmake "-G%GENERATOR%" %ARCHITECTURE% - -DCMAKE_RUNTIME_OUTPUT_DIRECTORY_DEBUG="%OUTPUT_DIR%" - -DCMAKE_RUNTIME_OUTPUT_DIRECTORY_RELEASE="%OUTPUT_DIR%" - -DCMAKE_CXX_FLAGS_INIT="%CMAKE_CXX_FLAGS_INIT%" - .. - - -build_script: - - cmake --build . - -test_script: - - ps: $env:isX86 = $env:PLATFORM.Contains("x86") - - IF %isX86% == False ctest --output-on-failure -C Debug - - -after_build: - - 7z a examples.zip %APPVEYOR_BUILD_FOLDER%/build/bin - - cmd: cd - - cmd: dir \S \P "examples.zip" - -artifacts: - - path: build\examples.zip - name: ex - -#deploy: - #release: $(APPVEYOR_REPO_TAG_NAME) - #provider: GitHub - #artifact: /.*\.exe/ - #auth_token: - #secure: j0nBV9xVItdG3j6d0gHoyvrzi7TOhAy9/QIeyCbFeP8PTqq7DPr1oYwL5WIkPaXe - #draft: false - #prerelease: false - #on: - #appveyor_repo_tag: true diff --git a/.clang-format b/.clang-format new file mode 100644 index 000000000..013d06b12 --- /dev/null +++ b/.clang-format @@ -0,0 +1,102 @@ +--- +Language: Cpp +AccessModifierOffset: -4 +AlignAfterOpenBracket: Align +AlignConsecutiveAssignments: false +AlignConsecutiveDeclarations: false +AlignEscapedNewlines: DontAlign +AlignOperands: true +AlignTrailingComments: true +AllowAllParametersOfDeclarationOnNextLine: true +AllowShortBlocksOnASingleLine: false +AllowShortCaseLabelsOnASingleLine: false +AllowShortFunctionsOnASingleLine: Inline +AllowShortIfStatementsOnASingleLine: false +AllowShortLoopsOnASingleLine: false +AlwaysBreakAfterReturnType: None +AlwaysBreakBeforeMultilineStrings: false +AlwaysBreakTemplateDeclarations: true +BinPackArguments: false +BinPackParameters: false +BraceWrapping: + AfterClass: true + AfterControlStatement: false + AfterEnum: false + AfterFunction: true + AfterNamespace: false + AfterObjCDeclaration: false + AfterStruct: true + AfterUnion: false + BeforeCatch: false + BeforeElse: false + IndentBraces: false + SplitEmptyFunction: false + SplitEmptyRecord: false + SplitEmptyNamespace: false +BreakBeforeBinaryOperators: All +BreakBeforeBraces: Custom +BreakBeforeInheritanceComma: true +BreakBeforeTernaryOperators: true +BreakConstructorInitializersBeforeComma: false +BreakConstructorInitializers: BeforeComma +BreakAfterJavaFieldAnnotations: false +BreakStringLiterals: true +ColumnLimit: 100 +CommentPragmas: '^ IWYU pragma:' +CompactNamespaces: false +ConstructorInitializerAllOnOneLineOrOnePerLine: false +ConstructorInitializerIndentWidth: 4 +ContinuationIndentWidth: 4 +Cpp11BracedListStyle: true +DerivePointerAlignment: false +DisableFormat: false +ExperimentalAutoDetectBinPacking: false +FixNamespaceComments: true +ForEachMacros: + - forever # avoids { wrapped to next line + - foreach + - Q_FOREACH + - BOOST_FOREACH +IncludeCategories: + - Regex: '^ + +## Testing +- Qt version tested: +- [ ] Existing tests still pass +- [ ] Added tests for new functionality (if applicable) + +## Breaking changes? + + +## Related issue + + +--- +*Please fill out the sections above to help reviewers understand your changes.* \ No newline at end of file diff --git a/.github/workflows/cmake_build.yml b/.github/workflows/cmake_build.yml new file mode 100644 index 000000000..b513864cb --- /dev/null +++ b/.github/workflows/cmake_build.yml @@ -0,0 +1,104 @@ +name: build nodeeditor + +on: + push: + branches: + - master + - main + tags: + - "*" + pull_request: + +jobs: + build-and-test: + + name: ${{ matrix.toolchain }} + runs-on: ${{ matrix.os }} + + strategy: + fail-fast: false + matrix: + toolchain: + - linux-gcc + - macos-clang + - windows-msvc + + configuration: + - Release + + include: + - toolchain: linux-gcc + os: ubuntu-22.04 + compiler: gcc + qt_version: "5.15.2" + modules: "" + use_qt6: "OFF" + + - toolchain: macos-clang + os: macos-latest + compiler: clang + qt_version: "6.7.1" + modules: "" + use_qt6: "ON" + + - toolchain: windows-msvc + os: windows-latest + compiler: msvc + qt_version: "5.15.2" + modules: "" + use_qt6: "OFF" + + - toolchain: windows-msvc + os: windows-latest + compiler: msvc + qt_version: "6.3.0" + modules: "qt5compat" + use_qt6: "ON" + + steps: + - name: Checkout Code + uses: actions/checkout@v2 + with: + submodules: true + + - name: Install Qt + uses: jurplel/install-qt-action@v3 + with: + version: ${{ matrix.qt_version }} + modules: ${{ matrix.modules }} + + - name: Setup (Linux) + if: startsWith (matrix.os, 'ubuntu') + run: | + sudo apt-get update + sudo apt-get install libxkbcommon-dev xvfb + + - name: Setup VS tools (Windows) + if: startsWith (matrix.os, 'windows') + uses: egor-tensin/vs-shell@v2 + with: + arch: x64 + + - name: Configure (${{ matrix.configuration }}) + run: cmake -S . -Bbuild -DCMAKE_BUILD_TYPE=${{ matrix.configuration }} -DBUILD_DOCS=OFF -DUSE_QT6=${{ matrix.use_qt6 }} + + - name: Build with ${{ matrix.compiler }} + run: cmake --build build --config ${{ matrix.configuration }} + + - name: Run Tests (Linux) + if: startsWith (matrix.os, 'ubuntu') + run: | + cd build + xvfb-run -a ctest --output-on-failure --progress + + - name: Run Tests (macOS) + if: startsWith (matrix.os, 'macos') + run: | + cd build + ctest --output-on-failure --progress + + - name: Run Tests (Windows) + if: startsWith (matrix.os, 'windows') + run: | + cd build + ctest -C ${{ matrix.configuration }} --output-on-failure --progress diff --git a/.gitignore b/.gitignore index c9eb5941f..552a9b2f0 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,9 @@ -*.py *.pyc CMakeLists.txt.user + +build*/ +.vscode/ + +qt-build + +tags diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 000000000..d5ba37a8f --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,27 @@ +# .readthedocs.yml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +build: + os: ubuntu-22.04 + tools: + python: "3.12" + +# Build documentation in the docs/ directory with Sphinx +sphinx: + builder: html + configuration: docs/conf.py + + +# Optionally set the version of Python and requirements required to build your docs +python: + install: + - requirements: docs/requirements.txt + +# Optionally build your docs in additional formats such as PDF +#formats: + #- pdf + diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index d2712bb1c..000000000 --- a/.travis.yml +++ /dev/null @@ -1,54 +0,0 @@ -language: cpp - -matrix: - include: - - os: osx - osx_image: xcode11.3 - compiler: clang - env: Qt5_DIR=/usr/local/opt/qt5/lib/cmake/Qt5 - - - os: linux - dist: xenial - sudo: false - compiler: clang - env: CXX=clang++-7 CC=clang-7 QT=512 - addons: - apt: - sources: - - llvm-toolchain-xenial-7 - packages: - - clang-7 - - - os: linux - dist: xenial - sudo: false - compiler: gcc - env: CXX=g++-7 CC=gcc-7 QT=512 - addons: - apt: - sources: - - ubuntu-toolchain-r-test - packages: - - g++-7 - -git: - depth: 10 - -before_install: - - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew update ; fi - - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew install qt; fi - - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then sudo apt-get update -qq ; fi - - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then sudo apt-get install build-essential libgl1-mesa-dev ; fi - - if [[ "$QT" == "512" ]]; then sudo add-apt-repository ppa:beineri/opt-qt-5.12.1-xenial -y; fi - - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then sudo apt-get update -qq; fi - - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then sudo apt-get -yqq install qt${QT}base; source /opt/qt${QT}/bin/qt${QT}-env.sh; fi - -script: - - mkdir build - - cd build - - cmake -DCMAKE_VERBOSE_MAKEFILE=$VERBOSE_BUILD .. && make -j - - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then xvfb-run --server-args="-screen 0 1024x768x24" ctest --output-on-failure; fi - - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then ctest --output-on-failure; fi - -notifications: - email: false diff --git a/CMakeLists.txt b/CMakeLists.txt index 1fc58a721..51db1f685 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,10 +1,21 @@ -cmake_minimum_required(VERSION 3.2) -# version 3.4 is required as other do not work with C++14 and clang +cmake_minimum_required(VERSION 3.11) -project(NodeEditor CXX) +cmake_policy(SET CMP0072 NEW) # new in 3.11. The NEW behavior for this policy is to set OpenGL_GL_PREFERENCE to GLVND. +cmake_policy(SET CMP0068 NEW) # new in 3.9. The NEW behavior of this policy is to ignore the RPATH settings for install_name on macOS. + + +project(QtNodesLibrary CXX) + +set(CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake" ${CMAKE_MODULE_PATH}) set(CMAKE_DISABLE_IN_SOURCE_BUILD ON) set(CMAKE_DISABLE_SOURCE_CHANGES ON) +set(OpenGL_GL_PREFERENCE LEGACY) +set(CMAKE_EXPORT_COMPILE_COMMANDS ON) + +# Enable AUTOMOC globally for all targets (needed for examples with Q_OBJECT) +set(CMAKE_AUTOMOC ON) +set(CMAKE_AUTORCC ON) get_directory_property(_has_parent PARENT_DIRECTORY) if(_has_parent) @@ -13,131 +24,178 @@ else() set(is_root_project ON) endif() -set(NE_DEVELOPER_DEFAULTS "${is_root_project}" CACHE BOOL "Turns on default settings for development of NodeEditor") +set(QT_NODES_DEVELOPER_DEFAULTS "${is_root_project}" CACHE BOOL "Turns on default settings for development of QtNodes") -option(BUILD_TESTING "Build tests" "${NE_DEVELOPER_DEFAULTS}") -option(BUILD_EXAMPLES "Build Examples" "${NE_DEVELOPER_DEFAULTS}") +option(BUILD_TESTING "Build tests" "${QT_NODES_DEVELOPER_DEFAULTS}") +option(BUILD_EXAMPLES "Build Examples" "${QT_NODES_DEVELOPER_DEFAULTS}") +option(BUILD_DOCS "Build Documentation" "${QT_NODES_DEVELOPER_DEFAULTS}") option(BUILD_SHARED_LIBS "Build as shared library" ON) -option(NE_FORCE_TEST_COLOR "Force colorized unit test output" OFF) - -enable_testing() - -if(NE_DEVELOPER_DEFAULTS) - set(CMAKE_CXX_STANDARD 14) - set(CMAKE_CXX_EXTENSIONS OFF) +option(BUILD_DEBUG_POSTFIX_D "Append d suffix to debug libraries" OFF) +option(QT_NODES_FORCE_TEST_COLOR "Force colorized unit test output" OFF) +option(USE_QT6 "Build with Qt6 (Enabled by default)" ON) +if(QT_NODES_DEVELOPER_DEFAULTS) set(CMAKE_RUNTIME_OUTPUT_DIRECTORY "${PROJECT_BINARY_DIR}/bin") set(CMAKE_LIBRARY_OUTPUT_DIRECTORY "${PROJECT_BINARY_DIR}/lib") set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY "${PROJECT_BINARY_DIR}/lib") endif() +if(BUILD_DEBUG_POSTFIX_D) + set(CMAKE_DEBUG_POSTFIX "d") + set(CMAKE_RELEASE_POSTFIX "") + set(CMAKE_RELWITHDEBINFO_POSTFIX "rd") + set(CMAKE_MINSIZEREL_POSTFIX "s") +endif() + add_subdirectory(external) -# Find the QtWidgets library -find_package(Qt5 5.3 COMPONENTS - Core - Widgets - Gui - OpenGL) +if(USE_QT6) + find_package(QT NAMES Qt6 REQUIRED COMPONENTS Widgets) +else() + find_package(QT NAMES Qt5 REQUIRED COMPONENTS Widgets) +endif() -qt5_add_resources(RESOURCES ./resources/resources.qrc) +find_package(Qt${QT_VERSION_MAJOR} REQUIRED COMPONENTS Core Widgets Gui OpenGL) +message(STATUS "QT_VERSION: ${QT_VERSION}, QT_DIR: ${QT_DIR}") -# Unfortunately, as we have a split include/src, AUTOMOC doesn't work. -# We'll have to manually specify some files -set(CMAKE_AUTOMOC ON) +if (${QT_VERSION} VERSION_LESS 5.11.0) + message(FATAL_ERROR "Requires qt version >= 5.11.0, Your current version is ${QT_VERSION}") +endif() set(CPP_SOURCE_FILES - src/Connection.cpp - src/ConnectionBlurEffect.cpp - src/ConnectionGeometry.cpp + src/AbstractGraphModel.cpp + src/AbstractNodeGeometry.cpp + src/BasicGraphicsScene.cpp src/ConnectionGraphicsObject.cpp - src/ConnectionPainter.cpp src/ConnectionState.cpp src/ConnectionStyle.cpp - src/DataModelRegistry.cpp - src/FlowScene.cpp - src/FlowView.cpp - src/FlowViewStyle.cpp - src/Node.cpp + src/DataFlowGraphModel.cpp + src/DataFlowGraphicsScene.cpp + src/DefaultConnectionPainter.cpp + src/DefaultHorizontalNodeGeometry.cpp + src/DefaultNodePainter.cpp + src/DefaultVerticalNodeGeometry.cpp + src/Definitions.cpp + src/GraphicsView.cpp + src/GraphicsViewStyle.cpp src/NodeConnectionInteraction.cpp - src/NodeDataModel.cpp - src/NodeGeometry.cpp + src/NodeDelegateModel.cpp + src/NodeDelegateModelRegistry.cpp src/NodeGraphicsObject.cpp - src/NodePainter.cpp src/NodeState.cpp src/NodeStyle.cpp - src/Properties.cpp src/StyleCollection.cpp + src/UndoCommands.cpp + src/locateNode.cpp + resources/resources.qrc +) + +set(HPP_HEADER_FILES + include/QtNodes/internal/AbstractConnectionPainter.hpp + include/QtNodes/internal/AbstractGraphModel.hpp + include/QtNodes/internal/AbstractNodeGeometry.hpp + include/QtNodes/internal/AbstractNodePainter.hpp + include/QtNodes/internal/BasicGraphicsScene.hpp + include/QtNodes/internal/Compiler.hpp + include/QtNodes/internal/ConnectionGraphicsObject.hpp + include/QtNodes/internal/ConnectionIdHash.hpp + include/QtNodes/internal/ConnectionIdUtils.hpp + include/QtNodes/internal/ConnectionState.hpp + include/QtNodes/internal/ConnectionStyle.hpp + include/QtNodes/internal/DataFlowGraphicsScene.hpp + include/QtNodes/internal/DataFlowGraphModel.hpp + include/QtNodes/internal/Definitions.hpp + include/QtNodes/internal/Export.hpp + include/QtNodes/internal/GraphicsView.hpp + include/QtNodes/internal/GraphicsViewStyle.hpp + include/QtNodes/internal/locateNode.hpp + include/QtNodes/internal/NodeData.hpp + include/QtNodes/internal/NodeDelegateModel.hpp + include/QtNodes/internal/NodeDelegateModelRegistry.hpp + include/QtNodes/internal/NodeGraphicsObject.hpp + include/QtNodes/internal/NodeState.hpp + include/QtNodes/internal/NodeStyle.hpp + include/QtNodes/internal/OperatingSystem.hpp + include/QtNodes/internal/QStringStdHash.hpp + include/QtNodes/internal/QUuidStdHash.hpp + include/QtNodes/internal/Serializable.hpp + include/QtNodes/internal/Style.hpp + include/QtNodes/internal/StyleCollection.hpp + include/QtNodes/internal/DefaultConnectionPainter.hpp + include/QtNodes/internal/DefaultHorizontalNodeGeometry.hpp + include/QtNodes/internal/DefaultNodePainter.hpp + include/QtNodes/internal/DefaultVerticalNodeGeometry.hpp + include/QtNodes/internal/NodeConnectionInteraction.hpp + include/QtNodes/internal/UndoCommands.hpp ) # If we want to give the option to build a static library, # set BUILD_SHARED_LIBS option to OFF -add_library(nodes +add_library(QtNodes ${CPP_SOURCE_FILES} - ${RESOURCES} + ${HPP_HEADER_FILES} ) -add_library(NodeEditor::nodes ALIAS nodes) -target_include_directories(nodes +add_library(QtNodes::QtNodes ALIAS QtNodes) + + +target_include_directories(QtNodes PUBLIC $ $ PRIVATE $ - $ + $ ) -target_link_libraries(nodes +target_link_libraries(QtNodes PUBLIC - Qt5::Core - Qt5::Widgets - Qt5::Gui - Qt5::OpenGL + Qt${QT_VERSION_MAJOR}::Core + Qt${QT_VERSION_MAJOR}::Widgets + Qt${QT_VERSION_MAJOR}::Gui + Qt${QT_VERSION_MAJOR}::OpenGL ) -target_compile_definitions(nodes +target_compile_definitions(QtNodes PUBLIC - ${Qt5Widgets_DEFINITIONS} - NODE_EDITOR_SHARED + $, NODE_EDITOR_SHARED, NODE_EDITOR_STATIC> PRIVATE NODE_EDITOR_EXPORTS #NODE_DEBUG_DRAWING QT_NO_KEYWORDS ) -target_compile_options(nodes +if(MSVC) + string(REGEX REPLACE "/W[0-4]" "" CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}") +endif() + +target_compile_options(QtNodes PRIVATE - $<$:/W4 /wd4127 /EHsc> + $<$:/W4 /wd4127 /EHsc /utf-8> $<$:-Wall -Wextra> - $<$:-Wall -Wextra> + $<$:-Wall -Wextra -Werror> ) +if(NOT "${CMAKE_CXX_SIMULATE_ID}" STREQUAL "MSVC") + # Clang-Cl on MSVC identifies as "Clang" but behaves more like MSVC: + target_compile_options(QtNodes + PRIVATE + $<$:-Wall -Wextra> + ) +endif() + +if(QT_NODES_DEVELOPER_DEFAULTS) + target_compile_features(QtNodes PUBLIC cxx_std_14) + set_target_properties(QtNodes PROPERTIES CXX_EXTENSIONS OFF) +endif() -target_compile_features(nodes - PUBLIC - cxx_generic_lambdas # Require C++14 -) -set_target_properties(nodes +set_target_properties(QtNodes PROPERTIES ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin ) -###### -# Moc -## - -file(GLOB_RECURSE HEADERS_TO_MOC include/nodes/internal/*.hpp) - -qt5_wrap_cpp(nodes_moc - ${HEADERS_TO_MOC} - TARGET nodes - OPTIONS --no-notes # Don't display a note for the headers which don't produce a moc_*.cpp -) - -target_sources(nodes PRIVATE ${nodes_moc}) - ########### # Examples ## @@ -146,9 +204,15 @@ if(BUILD_EXAMPLES) add_subdirectory(examples) endif() +if(BUILD_DOCS) + add_subdirectory(docs) +endif() + ################## # Automated Tests ## +enable_testing() + if(BUILD_TESTING) add_subdirectory(test) @@ -160,30 +224,33 @@ endif() include(GNUInstallDirs) -set(INSTALL_CONFIGDIR ${CMAKE_INSTALL_LIBDIR}/cmake/NodeEditor) +set(INSTALL_CONFIGDIR ${CMAKE_INSTALL_LIBDIR}/cmake/QtNodes) -install(TARGETS nodes - EXPORT NodeEditorTargets +install(TARGETS QtNodes + EXPORT QtNodesTargets + RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR} LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR} + RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR} ) -install(DIRECTORY include/ DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}) +install(DIRECTORY include/ + DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}) -install(EXPORT NodeEditorTargets - FILE NodeEditorTargets.cmake - NAMESPACE NodeEditor:: +install(EXPORT QtNodesTargets + FILE QtNodesTargets.cmake + NAMESPACE QtNodes:: DESTINATION ${INSTALL_CONFIGDIR} ) include(CMakePackageConfigHelpers) -configure_package_config_file(${CMAKE_CURRENT_LIST_DIR}/cmake/NodeEditorConfig.cmake.in - ${CMAKE_CURRENT_BINARY_DIR}/NodeEditorConfig.cmake +configure_package_config_file(${CMAKE_CURRENT_LIST_DIR}/cmake/QtNodesConfig.cmake.in + ${CMAKE_CURRENT_BINARY_DIR}/QtNodesConfig.cmake INSTALL_DESTINATION ${INSTALL_CONFIGDIR} ) install(FILES - ${CMAKE_CURRENT_BINARY_DIR}/NodeEditorConfig.cmake + ${CMAKE_CURRENT_BINARY_DIR}/QtNodesConfig.cmake DESTINATION ${INSTALL_CONFIGDIR} ) diff --git a/LICENSE b/LICENSE deleted file mode 100644 index bc2bbeaf9..000000000 --- a/LICENSE +++ /dev/null @@ -1,28 +0,0 @@ -Copyright (c) 2017, Dmitry Pinaev -All rights reserved. - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are -met: - - * Redistributions of source code must retain the above copyright -notice, this list of conditions and the following disclaimer. - * Redistributions in binary form must reproduce the above -copyright notice, this list of conditions and the following disclaimer -in the documentation and/or other materials provided with the -distribution. - * Neither the name of copyright holder, nor the names of its -contributors may be used to endorse or promote products derived from -this software without specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/LICENSE.rst b/LICENSE.rst new file mode 100644 index 000000000..c485d7f92 --- /dev/null +++ b/LICENSE.rst @@ -0,0 +1,28 @@ +BSD-3-Clause license +==================== + +Copyright (c) 2022, Dmitry Pinaev +All rights reserved. + +Redistribution and use in source and binary forms, with or without modification, +are permitted provided that the following conditions are met: + + * Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + * Neither the name of copyright holder, nor the names of its contributors may + be used to endorse or promote products derived from this software without + specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR +ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS +OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN +IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/README.md b/README.md deleted file mode 100644 index c772b5e61..000000000 --- a/README.md +++ /dev/null @@ -1,117 +0,0 @@ -### Purpose - -**NodeEditor** is conceived as a general-purpose Qt-based library aimed at -graph-controlled data processing. Nodes represent algorithms with certain inputs -and outputs. Connections transfer data from the output (source) of the first node -to the input (sink) of the second one. - -**NodeEditor** framework is a Visual [Dataflow -Programming](https://en.wikipedia.org/wiki/Dataflow_programming) tool. A library -client defines models and registers them in the data model registry. Further -work is driven by events taking place in DataModels and Nodes. The model -computing is triggered upon arriving of any new input data. The computed result -is propagated to the output connections. Each new connection fetches available -data and propagates is further. - -Each change in the source node is immediately propagated through all the -connections updating the whole graph. - -### Platforms - -* OSX (Apple Clang - LLVM 3.6), Linux (x64, gcc-7.0, clang-7): [![Build Status](https://travis-ci.org/paceholder/nodeeditor.svg?branch=master)](https://travis-ci.org/paceholder/nodeeditor) -* Windows (Win32, x64, msvc2017, MinGW 5.3): [![Build status](https://ci.appveyor.com/api/projects/status/wxp47wv3uyyiujjw/branch/master?svg=true)](https://ci.appveyor.com/project/paceholder/nodeeditor/branch/master) - - -### Dependencies - -* Qt >5.2 -* CMake 3.2 -* Catch2 - -### Current state - -* Model-based nodes -* Automatic data propagation -* Datatype-aware connections -* Embedded Qt widgets -* One-output to many-input connections -* JSON-based interface styles -* Saving scenes to JSON files - -### Building - -#### Linux - -~~~ -git clone git@github.com:paceholder/nodeeditor.git -cd nodeeditor -mkdir build -cd build -cmake .. -make -j && make install -~~~ - -#### Qt Creator - -1. Open `CMakeLists.txt` as project. -2. If you don't have the `Catch2` library installed, go to `Build Settings`, disable the checkbox `BUILD_TESTING`. -3. `Build -> Run CMake` -4. `Build -> Build All` -5. Click the button `Run` - -### Roadmap - -1. Extend set of examples -2. GUI: fix scrolling for scene view window scrolling -3. Implement grouping nodes -4. Split graph and GUI parts -5. Build data propagation on top of the graph code - -### Citing - - Dmitry Pinaev et al, Qt5 Node Editor, (2017), GitHub repository, https://github.com/paceholder/nodeeditor - -BibTeX - - @misc{Pinaev2017, - author = {Dmitry Pinaev et al}, - title = {Qt5 Node Editor}, - year = {2017}, - publisher = {GitHub}, - journal = {GitHub repository}, - howpublished = {\url{https://github.com/paceholder/nodeeditor}}, - commit = {1d1757d09b03cea0e4921bc19659465fe6e65b9b} - } - - -### Youtube video: - -[![Youtube demonstration](https://bitbucket.org/paceholder/nodeeditor/raw/master/pictures/vid1.png)](https://www.youtube.com/watch?v=pxMXjSvlOFw) - -### Now with styles - - -[![Styles](https://bitbucket.org/paceholder/nodeeditor/raw/master/pictures/style_example.png)](https://www.youtube.com/watch?v=i_pB-Y0hCYQ) - - -### Buy me a beer - -[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://paypal.me/DmitryPinaev) - -### Showcase - -#### [Chigraph](https://github.com/chigraph/chigraph) - -Chigraph is a programming language for beginners that is unique in that it is an -intuitive flow graph: - -![chigraph screenshot](pictures/chigraph.png) - -It features easy bindings to C/C++, package management, and a cool interface. - -#### [Spkgen particle engine editor](https://github.com/fredakilla/spkgen) - -![spkgen screenshot](pictures/spkgen.png) - -Spkgen is an editor for the SPARK particles engine using a node-based interface -to create particles effects for games. diff --git a/README.rst b/README.rst new file mode 100644 index 000000000..833ba84f7 --- /dev/null +++ b/README.rst @@ -0,0 +1,313 @@ +QtNodes +####### + +.. image:: https://github.com/paceholder/nodeeditor/actions/workflows/cmake_build.yml/badge.svg + :target: https://github.com/paceholder/nodeeditor/actions/workflows/cmake_build.yml + +Introduction +============ + +**QtNodes** is conceived as a general-purpose Qt-based library aimed at +developing Node Editors for various applications. The library could be used for +simple graph visualization and editing or extended further for using the +`Dataflow paradigm `_ . + +The library is written using the Model-View approach. The whole graph structure +is defined by a class derived from ``AbstractGraphModel``. It is possible to +create or add Nodes and Connections. The underlying data structures could be of +any arbitrary type or representation. + +An instance of ``AbstractGraphModel`` could or could not be attached to +specialized ``QGraphicsScene`` and ``QGraphicsView`` objects. I.e. the so-called +"headless" `modus operandi` is possible. + +Documentation +============= + +`Read the Docs for QtNodes `_ + +Warning + Many classes were changed in the version ``3.0``. If you had a large project + based on ``2.x.x``, make sure you read the documentation first and see the + examples before checking out the new code. + +Branches +-------- + +There are branchses ``v2`` and ``v3`` for versions ``2.x.x`` and ``3.x`` +respectively. The branch ``master`` contains the latest dev state. + + +.. contents:: Navigation + :depth: 2 + + +Data Flow Paradigm +================== + +The extended model class ``DataFlowGraphModel`` allows to register "processing +algorithms" represented by nodes and is equipped with a set of Qt's signals and +slots for propagating the data though the nodes. + +The node's algorithm is triggered upon arriving of any new input data. The +computed result is propagated to the output connections. Each new connection +fetches available data and propagates is further. Each change in the source node +is immediately propagated through all the connections updating the whole graph. + + +Supported Environments +====================== + +Platforms +--------- + +* Linux (x64, gcc, Qt 5.15.2) |ImageLink| +* OSX (Apple Clang, Qt 5.15.2) |ImageLink| +* Windows (MSVC, Qt 5.15.2) |ImageLink| +* Windows (MSVC, Qt 6.3.0) |ImageLink| + +.. |ImageLink| image:: https://github.com/paceholder/nodeeditor/actions/workflows/cmake_build.yml/badge.svg + :target: https://github.com/paceholder/nodeeditor/actions/workflows/cmake_build.yml + + +Dependencies +------------ + +* Qt >5.15 +* CMake 3.8 +* Catch2 + + +Current State (v3) +================== + +* Model-based graph +* Headless mode + You can create, populate, modify the derivative of ``AbstractGraphModel`` + without adding it to the actual Flow Scene. The library is now designed to be + general-purpose graph visualization and modification tool, without + specialization on only data propagation. +* Automatic data propagation built on top of the graph-model code + The library could be used for both pure graph visualization purposes and for + originally implemented data propagation. +* Dynamic ports +* Datatype-aware connections +* Embedded Qt widgets +* One-output to many-input connections +* JSON-based interface styles +* Saving scenes to JSON files +* Custom Node Geometry +* Vertical and Horizontal graph layouts +* Undo/Redo, Duplication (CTRL+D) + + +Building +======== + +Set this option to false if you want to build with Qt5 version instead of Qt6: + +:: + + USE_QT6 + + mkdir build && cd build && cmake .. -DUSE_QT6=on + or + mkdir build && cd build && cmake .. -DUSE_QT6=off + +For building a static lib use: + +:: + + cmake .. -BUILD_SHARED_LIBS=off + +Linux +----- + +:: + + git clone git@github.com:paceholder/nodeeditor.git + cd nodeeditor + mkdir build + cd build + cmake .. + make -j && make install + + +Qt Creator +---------- + +1. Open `CMakeLists.txt` as project. +2. `Build -> Run CMake` +3. `Build -> Build All` +4. Click the button `Run` + +.. note:: + The project includes unit tests built with Catch2. If you don't have Catch2 installed, + you can disable testing by setting `-DBUILD_TESTING=OFF` in CMake configuration. + + +With Cmake using `vcpkg` +^^^^^^^^^^^^^^^^^^^^^^^^ + +1. Install `vcpkg` +2. Add the following flag in configuration step of `CMake` + +:: + + -DCMAKE_TOOLCHAIN_FILE=/scripts/buildsystems/scripts/buildsystems/vcpkg.cmake + + +Testing +======= + +QtNodes includes a comprehensive unit test suite built with Catch2. + +**Running Tests** + +From the build directory: + +:: + + # Build tests + make test_nodes + + # Run all tests + ./bin/test_nodes + + # Run specific categories + ./bin/test_nodes "[core]" # Core functionality tests + ./bin/test_nodes "[graphics]" # Graphics system tests + +**Test Coverage** + +* Core model operations (node CRUD, connections) +* Signal emission verification (AbstractGraphModel signals) +* Serialization (JSON save/load) +* Undo system integration +* Graphics scene management +* Connection utilities + +For detailed testing documentation, see the `Testing Guide `_. + + +Help Needed +=========== + +#. Python wrappring using PySide. +#. QML frontend. +#. Wirting a ClangFormat config. + +Any suggestions are welcome! + + +Contribution +============ + +#. Be polite, respectful and collaborative. +#. For submitting a bug: + + #. Describe your environment (Qt version, compiler, OS etc) + #. Describe steps to reproduce the issue + +#. For submitting a pull request: + + #. Create a proposal task first. We can come up with a better design together. + #. Create a pull-request. If applicable, create a simple example for your + problem, describe the changes in details, provide use cases. + +#. For submitting a development request: + + #. Describe your issue in details + #. Provide some use cases. + +#. I maintain this probject in my free time, when I am not busy with my work or + my family. **If I do not react or do not answer for too long, please ping + me**. + + +Citing +====== + +:: + + Dmitry Pinaev et al, Qt Nodes, (2013-2025), GitHub repository, https://github.com/paceholder/nodeeditor + +BibTeX:: + + @misc{Pinaev2025, + author = {Dmitry Pinaev et al}, + title = {QtNodes. Node Editor}, + year = {2025}, + publisher = {GitHub}, + journal = {GitHub repository}, + howpublished = {\url{https://github.com/paceholder/nodeeditor}}, + commit = {877ddb8c447a7a061a5022e9956a3194132e3dd9} + } + +Support +======= + +If you like the project you could donate me on PayPal |ImagePaypal|_ + +.. |ImagePaypal| image:: https://img.shields.io/badge/Donate-PayPal-green.svg +.. _ImagePaypal: https://www.paypal.com/paypalme/DmitryPinaev + + +If you send more than $100, I'll forward $100 to some fund supporting sick +children and report to you back. + + +Thanks +====== + +The version 3 was released with a generous help of +`Davide Faconti `_ + + +Showcase +======== + +Youtube videos +-------------- + +.. image:: https://img.youtube.com/vi/pxMXjSvlOFw/0.jpg + :target: https://www.youtube.com/watch?v=pxMXjSvlOFw + +| + +.. image:: https://img.youtube.com/vi/i_pB-Y0hCYQ/0.jpg + :target: https://www.youtube.com/watch?v=i_pB-Y0hCYQ + +CANdevStudio +------------ + +`CANdevStudio `_ is a cost-effective, +cross-platform replacement for CAN simulation software. CANdevStudio enables to +simulate CAN signals such as ignition status, doors status or reverse gear by +every automotive developer. Thanks to modularity it is easy to implement new, +custom features. + + +.. image:: docs/_static/showcase_CANdevStudio.png + + +Chigraph +-------- + +`Chigraph `_ is a visual programming +language for beginners that is unique in that it is an intuitive flow graph: + +.. image:: docs/_static/chigraph.png + + +It features easy bindings to C/C++, package management, and a cool interface. + + +Spkgen particle editor +---------------------- + +`Spkgen `_ is an editor for the SPARK +particles engine that uses a node-based interface to create particles effects for +games + +.. image:: docs/_static/spkgen.png diff --git a/cmake/FindPySide2.cmake b/cmake/FindPySide2.cmake new file mode 100644 index 000000000..7ebb33d02 --- /dev/null +++ b/cmake/FindPySide2.cmake @@ -0,0 +1,160 @@ +# +# SPDX-FileCopyrightText: 2020-2021 Klarälvdalens Datakonsult AB, a KDAB Group company +# Author: Renato Araujo Oliveira Filho +# +# SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only +# +# Contact KDAB at for commercial licensing options. +# + +# PYSIDE_BASEDIR - Top of the PySide2 installation +# PYSIDE_INCLUDE_DIR - Directories to include to use PySide2 +# PYSIDE_LIBRARY - Files to link against to use PySide2 +# PYSIDE_TYPESYSTEMS - Type system files that should be used by other bindings extending PySide2 +# +# You can install PySide2 from Qt repository with +# pip3 install --index-url=https://download.qt.io/official_releases/QtForPython --trusted-host download.qt.io pyside2 + +find_package(PkgConfig) +if(PKG_CONFIG_FOUND) + pkg_check_modules(PYSIDE2_PRIV QUIET pyside2) +endif() + +set(PYSIDE2_FOUND FALSE) + +if(PYSIDE2_PRIV_FOUND) + set(PYSIDE2_FOUND TRUE) + message(STATUS "Using PySide2 found in the system!") + pkg_get_variable(SHIBOKEN_BINARY + pyside2 + generator_location + ) + pkg_get_variable(PYSIDE2_BASEDIR + pyside2 + typesystemdir + ) + pkg_get_variable(PYSIDE_INCLUDE_DIR + pyside2 + includedir + ) + set(PYSIDE_TYPESYSTEMS ${PYSIDE2_BASEDIR}) + set(PYSIDE2_SO_VERSION ${PYSIDE2_PRIV_VERSION}) + set(PYSIDE_LIBRARY ${PYSIDE2_PRIV_LINK_LIBRARIES}) + list(GET PYSIDE_LIBRARY 0 PYSIDE_LIBRARY) +else() + # extract python library basename + list(GET Python3_LIBRARIES 0 PYTHON_LIBRARY_FILENAME) + get_filename_component(PYTHON_LIBRARY_FILENAME ${PYTHON_LIBRARY_FILENAME} NAME) + + execute_process( + COMMAND ${Python3_EXECUTABLE} -c "if True: + import os, sys + try: + import PySide2.QtCore as QtCore + print(os.path.dirname(QtCore.__file__)) + except Exception as error: + print(error, file=sys.stderr) + exit() + " + OUTPUT_VARIABLE PYSIDE2_BASEDIR + OUTPUT_STRIP_TRAILING_WHITESPACE + ) + + if(PYSIDE2_BASEDIR) + set(PYSIDE_BASEDIR ${PYSIDE2_BASEDIR} CACHE PATH "Top level install of PySide2" FORCE) + execute_process( + COMMAND ${Python3_EXECUTABLE} -c "if True: + import os + import PySide2.QtCore as QtCore + print(os.path.basename(QtCore.__file__).split('.', 1)[1]) + " + OUTPUT_VARIABLE PYSIDE2_SUFFIX + OUTPUT_STRIP_TRAILING_WHITESPACE + ) + + execute_process( + COMMAND ${Python3_EXECUTABLE} -c "if True: + import os + import PySide2.QtCore as QtCore + print(';'.join(map(str, QtCore.__version_info__))) + " + OUTPUT_VARIABLE PYSIDE2_SO_VERSION + OUTPUT_STRIP_TRAILING_WHITESPACE + ) + list(GET PYSIDE2_SO_VERSION 0 PYSIDE2_SO_MACRO_VERSION) + list(GET PYSIDE2_SO_VERSION 1 PYSIDE2_SO_MICRO_VERSION) + list(GET PYSIDE2_SO_VERSION 2 PYSIDE2_SO_MINOR_VERSION) + string(REPLACE ";" "." PYSIDE2_SO_VERSION "${PYSIDE2_SO_VERSION}") + + if(NOT APPLE) + set(PYSIDE2_SUFFIX "${PYSIDE2_SUFFIX}.${PYSIDE2_SO_MACRO_VERSION}.${PYSIDE2_SO_MICRO_VERSION}") + else() + string(REPLACE ".so" "" PYSIDE2_SUFFIX ${PYSIDE2_SUFFIX}) + set(PYSIDE2_SUFFIX "${PYSIDE2_SUFFIX}.${PYSIDE2_SO_MACRO_VERSION}.${PYSIDE2_SO_MICRO_VERSION}.dylib") + endif() + + set(PYSIDE2_FOUND TRUE) + message(STATUS "PySide2 base dir: ${PYSIDE2_BASEDIR}" ) + message(STATUS "PySide2 suffix: ${PYSIDE2_SUFFIX}") + endif() + + if (PYSIDE2_FOUND) + #PySide + #=============================================================================== + find_path(PYSIDE_INCLUDE_DIR + pyside.h + PATHS ${PYSIDE2_BASEDIR}/include ${PYSIDE2_CUSTOM_PREFIX}/include/PySide2 + NO_DEFAULT_PATH) + + # Platform specific library names + if(MSVC) + SET(PYSIDE_LIBRARY_BASENAMES "pyside2.abi3.lib") + elseif(CYGWIN) + SET(PYSIDE_LIBRARY_BASENAMES "") + elseif(WIN32) + SET(PYSIDE_LIBRARY_BASENAMES "libpyside2.${PYSIDE2_SUFFIX}") + else() + SET(PYSIDE_LIBRARY_BASENAMES "libpyside2.${PYSIDE2_SUFFIX}") + endif() + + find_file(PYSIDE_LIBRARY + ${PYSIDE_LIBRARY_BASENAMES} + PATHS ${PYSIDE2_BASEDIR} ${PYSIDE2_CUSTOM_PREFIX}/lib + NO_DEFAULT_PATH) + + find_path(PYSIDE_TYPESYSTEMS + typesystem_core.xml + PATHS ${PYSIDE2_BASEDIR}/typesystems ${PYSIDE2_CUSTOM_PREFIX}/share/PySide2/typesystems + NO_DEFAULT_PATH) + endif() +endif() + +if(PYSIDE2_FOUND) + message(STATUS "PySide include dir: ${PYSIDE_INCLUDE_DIR}") + message(STATUS "PySide library: ${PYSIDE_LIBRARY}") + message(STATUS "PySide typesystems: ${PYSIDE_TYPESYSTEMS}") + message(STATUS "PySide2 version: ${PYSIDE2_SO_VERSION}") + + # Create PySide2 target + add_library(PySide2::pyside2 SHARED IMPORTED GLOBAL) + if(MSVC) + set_property(TARGET PySide2::pyside2 PROPERTY + IMPORTED_IMPLIB ${PYSIDE_LIBRARY}) + endif() + set_property(TARGET PySide2::pyside2 PROPERTY + IMPORTED_LOCATION ${PYSIDE_LIBRARY}) + set_property(TARGET PySide2::pyside2 APPEND PROPERTY + INTERFACE_INCLUDE_DIRECTORIES + ${PYSIDE_INCLUDE_DIR} + ${PYSIDE_INCLUDE_DIR}/QtCore/ + ${PYSIDE_INCLUDE_DIR}/QtGui/ + ${PYSIDE_INCLUDE_DIR}/QtWidgets/ + ${Python3_INCLUDE_DIRS} + ) +endif() + + +find_package_handle_standard_args(PySide2 + REQUIRED_VARS PYSIDE2_BASEDIR PYSIDE_INCLUDE_DIR PYSIDE_LIBRARY PYSIDE_TYPESYSTEMS + VERSION_VAR PYSIDE2_SO_VERSION +) diff --git a/cmake/FindShiboken2.cmake b/cmake/FindShiboken2.cmake new file mode 100644 index 000000000..b86e6ad14 --- /dev/null +++ b/cmake/FindShiboken2.cmake @@ -0,0 +1,187 @@ +# +# SPDX-FileCopyrightText: 2020-2021 Klarälvdalens Datakonsult AB, a KDAB Group company +# Author: Renato Araujo Oliveira Filho +# +# SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only +# +# Contact KDAB at for commercial licensing options. +# + +# SHIBOKEN_INCLUDE_DIR - Directories to include to use SHIBOKEN +# SHIBOKEN_LIBRARY - Files to link against to use SHIBOKEN +# SHIBOKEN_BINARY - Executable name +# SHIBOKEN_BUILD_TYPE - Tells if Shiboken was compiled in Release or Debug mode. + +# You can install Shiboken from Qt repository with +# pip3 install --index-url=https://download.qt.io/official_releases/QtForPython --trusted-host download.qt.io shiboken2-generator + +find_package(PkgConfig) +if(PKG_CONFIG_FOUND) + pkg_check_modules(SHIBOKEN2_PRIV QUIET shiboken2) +endif() + +set(SHIBOKEN_FOUND FALSE) + +if(SHIBOKEN2_PRIV_FOUND) + set(SHIBOKEN_FOUND TRUE) + message(STATUS "Using shiboken found in the system!") + pkg_get_variable(SHIBOKEN_BINARY + shiboken2 + generator_location + ) + pkg_get_variable(SHIBOKEN_BASEDIR + shiboken2 + libdir + ) + pkg_get_variable(SHIBOKEN_INCLUDE_DIR + shiboken2 + includedir + ) + set(SHIBOKEN_VERSION ${SHIBOKEN2_PRIV_VERSION}) + set(SHIBOKEN_LIBRARY ${SHIBOKEN2_PRIV_LINK_LIBRARIES}) +else() + execute_process( + COMMAND ${Python3_EXECUTABLE} -c "if True: + import os + try: + import shiboken2_generator + print(shiboken2_generator.__path__[0]) + except: + exit() + " + OUTPUT_VARIABLE SHIBOKEN_GENERATOR_BASEDIR + OUTPUT_STRIP_TRAILING_WHITESPACE + ) + execute_process( + COMMAND ${Python3_EXECUTABLE} -c "if True: + import os + try: + import shiboken2 + print(shiboken2.__path__[0]) + except: + exit() + " + OUTPUT_VARIABLE SHIBOKEN_BASEDIR + OUTPUT_STRIP_TRAILING_WHITESPACE + ) + execute_process( + COMMAND ${Python3_EXECUTABLE} -c "if True: + import os + import shiboken2 + print(';'.join(filter(None, map(str, shiboken2.__version_info__)))) + " + OUTPUT_VARIABLE SHIBOKEN_VERSION + OUTPUT_STRIP_TRAILING_WHITESPACE + ) + list(GET SHIBOKEN_VERSION 0 SHIBOKEN_MACRO_VERSION) + list(GET SHIBOKEN_VERSION 1 SHIBOKEN_MICRO_VERSION) + list(GET SHIBOKEN_VERSION 2 SHIBOKEN_MINOR_VERSION) + string(REPLACE ";" "." SHIBOKEN_VERSION "${SHIBOKEN_VERSION}") + + message(STATUS "ShibokenGenerator base dir: ${SHIBOKEN_GENERATOR_BASEDIR}") + message(STATUS "Shiboken base dir: ${SHIBOKEN_BASEDIR}") + message(STATUS "Shiboken custom path: ${SHIBOKEN_CUSTOM_PATH}") + + if(SHIBOKEN_BASEDIR) + find_path(SHIBOKEN_INCLUDE_DIR + shiboken.h + PATHS ${SHIBOKEN_CUSTOM_PATH} ${SHIBOKEN_GENERATOR_BASEDIR}/include + NO_DEFAULT_PATH) + if(MSVC) + SET(SHIBOKEN_LIBRARY_BASENAMES "shiboken2.abi3.lib") + elseif(CYGWIN) + SET(SHIBOKEN_LIBRARY_BASENAMES "") + elseif(WIN32) + SET(SHIBOKEN_LIBRARY_BASENAMES "libshiboken2.${PYSIDE2_SUFFIX}") + elseif(APPLE) + SET(SHIBOKEN_LIBRARY_BASENAMES + libshiboken2.abi3.dylib + libshiboken2.abi3.${SHIBOKEN_MACRO_VERSION}.dylib + libshiboken2.abi3.${SHIBOKEN_MACRO_VERSION}.${SHIBOKEN_MICRO_VERSION}.dylib + libshiboken2.abi3.${SHIBOKEN_VERSION}.dylib + ) + else() + SET(SHIBOKEN_LIBRARY_BASENAMES + libshiboken2.abi3.so + libshiboken2.abi3.so.${SHIBOKEN_MACRO_VERSION} + libshiboken2.abi3.so.${SHIBOKEN_MACRO_VERSION}.${SHIBOKEN_MICRO_VERSION} + libshiboken2.abi3.so.${SHIBOKEN_VERSION} + ) + endif() + + if (NOT SHIBOKEN_INCLUDE_DIR) + return() + endif() + set(SHIBOKEN_SEARCH_PATHS ${SHIBOKEN_CUSTOM_PATH}) + list(APPEND SHIBOKEN_SEARCH_PATHS ${SHIBOKEN_BASEDIR}) + list(APPEND SHIBOKEN_SEARCH_PATHS ${SHIBOKEN_GENERATOR_BASEDIR}) + find_file(SHIBOKEN_LIBRARY + ${SHIBOKEN_LIBRARY_BASENAMES} + PATHS ${SHIBOKEN_SEARCH_PATHS} + NO_DEFAULT_PATH) + + find_program(SHIBOKEN_BINARY + shiboken2 + PATHS ${SHIBOKEN_SEARCH_PATHS} + NO_DEFAULT_PATH + ) + endif() + if (SHIBOKEN_INCLUDE_DIR AND SHIBOKEN_LIBRARY AND SHIBOKEN_BINARY) + set(SHIBOKEN_FOUND TRUE) + endif() + + if(SHIBOKEN_FOUND) + endif() + + + if(MSVC) + # On Windows we must link to python3.dll that is a small library that links against python3x.dll + # that allow us to choose any python3x.dll at runtime + execute_process( + COMMAND ${Python3_EXECUTABLE} -c "if True: + for lib in '${Python3_LIBRARIES}'.split(';'): + if '/' in lib: + prefix, py = lib.rsplit('/', 1) + if py.startswith('python3'): + print(prefix + '/python3.lib') + break + " + OUTPUT_VARIABLE PYTHON_LIMITED_LIBRARIES + OUTPUT_STRIP_TRAILING_WHITESPACE + ) + else() + # On Linux and MacOs our modules should not link with any python library + # that must be handled by the main process + set(PYTHON_LIMITED_LIBRARIES "") + endif() +endif() +if (SHIBOKEN_FOUND) + message(STATUS "Shiboken include dir: ${SHIBOKEN_INCLUDE_DIR}") + message(STATUS "Shiboken library: ${SHIBOKEN_LIBRARY}") + message(STATUS "Shiboken binary: ${SHIBOKEN_BINARY}") + message(STATUS "Shiboken version: ${SHIBOKEN_VERSION}") + + # Create shiboke2 target + add_library(Shiboken2::libshiboken SHARED IMPORTED GLOBAL) + if(MSVC) + set_property(TARGET Shiboken2::libshiboken PROPERTY + IMPORTED_IMPLIB ${SHIBOKEN_LIBRARY}) + endif() + set_property(TARGET Shiboken2::libshiboken PROPERTY + IMPORTED_LOCATION ${SHIBOKEN_LIBRARY}) + set_property(TARGET Shiboken2::libshiboken APPEND PROPERTY + INTERFACE_INCLUDE_DIRECTORIES ${SHIBOKEN_INCLUDE_DIR} ${Python3_INCLUDE_DIRS}) + set_property(TARGET Shiboken2::libshiboken APPEND PROPERTY + INTERFACE_LINK_LIBRARIES ${PYTHON_LIMITED_LIBRARIES}) + + # Generator target + add_executable(Shiboken2::shiboken IMPORTED GLOBAL) + set_property(TARGET Shiboken2::shiboken PROPERTY + IMPORTED_LOCATION ${SHIBOKEN_BINARY}) +endif() + +find_package_handle_standard_args(Shiboken2 + REQUIRED_VARS SHIBOKEN_BASEDIR SHIBOKEN_INCLUDE_DIR SHIBOKEN_LIBRARY SHIBOKEN_BINARY + VERSION_VAR SHIBOKEN_VERSION +) + diff --git a/cmake/FindSphinx.cmake b/cmake/FindSphinx.cmake new file mode 100644 index 000000000..1d977a8e1 --- /dev/null +++ b/cmake/FindSphinx.cmake @@ -0,0 +1,12 @@ +#Look for an executable called sphinx-build +find_program(SPHINX_EXECUTABLE + NAMES sphinx-build + DOC "Path to sphinx-build executable") + +include(FindPackageHandleStandardArgs) + +#Handle standard arguments to find_package like REQUIRED and QUIET +find_package_handle_standard_args(Sphinx + "Failed to find sphinx-build executable" + SPHINX_EXECUTABLE) + diff --git a/cmake/NodeEditorConfig.cmake.in b/cmake/NodeEditorConfig.cmake.in deleted file mode 100644 index fa3f4ae57..000000000 --- a/cmake/NodeEditorConfig.cmake.in +++ /dev/null @@ -1,17 +0,0 @@ -get_filename_component(NodeEditor_CMAKE_DIR "${CMAKE_CURRENT_LIST_FILE}" PATH) - -include(CMakeFindDependencyMacro) - -# NOTE Had to use find_package because find_dependency does not support COMPONENTS or MODULE until 3.8.0 - -find_package(Qt5 REQUIRED COMPONENTS - Core - Widgets - Gui - OpenGL) - -if(NOT TARGET NodeEditor::nodes) - include("${NodeEditor_CMAKE_DIR}/NodeEditorTargets.cmake") -endif() - -set(NodeEditor_LIBRARIES NodeEditor::nodes) diff --git a/cmake/PySide2ModuleBuild.cmake b/cmake/PySide2ModuleBuild.cmake new file mode 100644 index 000000000..06f2b620e --- /dev/null +++ b/cmake/PySide2ModuleBuild.cmake @@ -0,0 +1,157 @@ +# +# SPDX-FileCopyrightText: 2020-2021 Klarälvdalens Datakonsult AB, a KDAB Group company +# Author: Renato Araujo Oliveira Filho +# +# SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only +# +# Contact KDAB at for commercial licensing options. +# + +if (NOT ${PROJECT_NAME}_PYTHON_BINDINGS_INSTALL_PREFIX) + SET(${PROJECT_NAME}_PYTHON_BINDINGS_INSTALL_PREFIX ${CMAKE_INSTALL_PREFIX} CACHE FILEPATH "Custom path to install python bindings.") +endif() + +message(STATUS "PYTHON INSTALL PREFIX ${${PROJECT_NAME}_PYTHON_BINDINGS_INSTALL_PREFIX}") + +if (WIN32) + set(PATH_SEP "\;") +else() + set(PATH_SEP ":") +endif() +if (NOT CMAKE_CXX_STANDARD) + set(CMAKE_CXX_STANDARD 17) +endif() + +# On macOS, check if Qt is a framework build. This affects how include paths should be handled. +get_target_property(QtCore_is_framework Qt5::Core FRAMEWORK) +if (QtCore_is_framework) + # Get the path to the framework dir. + list(GET Qt5Core_INCLUDE_DIRS 0 QT_INCLUDE_DIR) + get_filename_component(QT_FRAMEWORK_INCLUDE_DIR "${QT_INCLUDE_DIR}/../" ABSOLUTE) + + # QT_INCLUDE_DIR points to the QtCore.framework directory, so we need to adjust this to point + # to the actual include directory, which has include files for non-framework parts of Qt. + get_filename_component(QT_INCLUDE_DIR "${QT_INCLUDE_DIR}/../../include" ABSOLUTE) +endif() + +# Flags that we will pass to shiboken-generator +# --generator-set=shiboken: tells the generator that we want to use shiboken to generate code, +# a doc generator is also available +# --enable-parent-ctor-heuristic: Enable heuristics to detect parent relationship on constructors, +# this try to guess parent ownership based on the arguments of the constructors +# --enable-pyside-extensionsL: This will generate code for Qt based classes, adding extra attributes, +# like signal, slot; +# --enable-return-value-heuristic: Similar as --enable-parent-ctor-heuristic this use some logic to guess +# parent child relationship based on the returned argument +# --use-isnull-as-nb_nonzero: If a class have an isNull() const method, it will be used to compute +# the value of boolean casts. +# Example, QImage::isNull() will be used when on python side you do `if (myQImage)` +set(GENERATOR_EXTRA_FLAGS --generator-set=shiboken + --enable-parent-ctor-heuristic + --enable-pyside-extensions + --enable-return-value-heuristic + --use-isnull-as-nb_nonzero + -std=c++${CMAKE_CXX_STANDARD}) + +# 2017-04-24 The protected hack can unfortunately not be disabled, because +# Clang does produce linker errors when we disable the hack. +# But the ugly workaround in Python is replaced by a shiboken change. +if(WIN32 OR DEFINED AVOID_PROTECTED_HACK) + set(GENERATOR_EXTRA_FLAGS ${GENERATOR_EXTRA_FLAGS} --avoid-protected-hack) + add_definitions(-DAVOID_PROTECTED_HACK) +endif() + +macro(make_path varname) + # accepts any number of path variables + string(REPLACE ";" "${PATH_SEP}" ${varname} "${ARGN}") +endmacro() + +# Creates a PySide module target based on the arguments +# This will: +# 1 - Create a Cmake custom-target that call shiboken-generator passign the correct arguments +# 2 - Create a Cmake library target called "Py${LIBRARY_NAME}" the output name of this target +# will be changed to match PySide template +# Args: +# LIBRARY_NAME - The name of the output module +# TYPESYSTEM_PATHS - A list of paths where shiboken should look for typesystem files +# INCLUDE_PATHS - Include pahts necessary to parse your class. *This is not the same as build* +# OUTPUT_SOURCES - The files that will be generated by shiboken +# TARGET_INCLUDE_DIRS - This will be passed to target_include_directories +# TARGET_LINK_LIBRARIES - This will be passed to target_link_libraries +# GLOBAL_INCLUDE - A header-file that contains alls classes that will be generated +# TYPESYSTEM_XML - The target binding typesystem (that should be the full path) +# DEPENDS - This var will be passed to add_custom_command(DEPENDS) so a new generation will be +# trigger if one of these files changes +# MODULE_OUTPUT_DIR - Where the library file should be stored +macro(CREATE_PYTHON_BINDINGS + LIBRARY_NAME + TYPESYSTEM_PATHS + INCLUDE_PATHS + OUTPUT_SOURCES + TARGET_INCLUDE_DIRS + TARGET_LINK_LIBRARIES + GLOBAL_INCLUDE + TYPESYSTEM_XML + DEPENDS + MODULE_OUTPUT_DIR) + + # Transform the path separators into something shiboken understands. + make_path(shiboken_include_dirs ${INCLUDE_PATHS}) + make_path(shiboken_typesystem_dirs ${TYPESYSTEM_PATHS}) + get_property(raw_python_dir_include_dirs DIRECTORY PROPERTY INCLUDE_DIRECTORIES) + make_path(python_dir_include_dirs ${raw_python_dir_include_dirs}) + set(shiboken_include_dirs "${shiboken_include_dirs}${PATH_SEP}${python_dir_include_dirs}") + + set(shiboken_framework_include_dirs_option "") + if(CMAKE_HOST_APPLE) + set(shiboken_framework_include_dirs "${QT_FRAMEWORK_INCLUDE_DIR}") + make_path(shiboken_framework_include_dirs ${shiboken_framework_include_dirs}) + set(shiboken_framework_include_dirs_option "--framework-include-paths=${shiboken_framework_include_dirs}") + endif() + set_property(SOURCE ${OUTPUT_SOURCES} PROPERTY SKIP_AUTOGEN ON) + add_custom_command(OUTPUT ${OUTPUT_SOURCES} + COMMAND $ ${GENERATOR_EXTRA_FLAGS} + ${GLOBAL_INCLUDE} + --include-paths=${shiboken_include_dirs} + --typesystem-paths=${shiboken_typesystem_dirs} + ${shiboken_framework_include_dirs_option} + --output-directory=${CMAKE_CURRENT_BINARY_DIR} + ${TYPESYSTEM_XML} + DEPENDS ${TYPESYSTEM_XML} ${DEPENDS} + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} + COMMENT "Running generator for ${LIBRARY_NAME} binding...") + + set(TARGET_NAME "Py${LIBRARY_NAME}") + set(MODULE_NAME "${LIBRARY_NAME}") + add_library(${TARGET_NAME} MODULE ${OUTPUT_SOURCES}) + + set_target_properties(${TARGET_NAME} PROPERTIES + PREFIX "" + OUTPUT_NAME ${MODULE_NAME} + LIBRARY_OUTPUT_DIRECTORY ${MODULE_OUTPUT_DIR} + ) + + if(WIN32) + set_target_properties(${TARGET_NAME} PROPERTIES SUFFIX ".pyd") + endif() + + target_include_directories(${TARGET_NAME} PUBLIC + ${TARGET_INCLUDE_DIRS} + ${PYSIDE_EXTRA_INCLUDES} + ) + + target_link_libraries(${TARGET_NAME} + ${TARGET_LINK_LIBRARIES} + PySide2::pyside2 + Shiboken2::libshiboken + ) + target_compile_definitions(${TARGET_NAME} + PRIVATE Py_LIMITED_API=0x03050000 + ) + if(APPLE) + set_property(TARGET ${TARGET_NAME} APPEND PROPERTY + LINK_FLAGS "-undefined dynamic_lookup") + endif() + install(TARGETS ${TARGET_NAME} + LIBRARY DESTINATION ${${PROJECT_NAME}_PYTHON_BINDINGS_INSTALL_PREFIX}/${TARGET_NAME}) +endmacro() diff --git a/cmake/QtNodesConfig.cmake.in b/cmake/QtNodesConfig.cmake.in new file mode 100644 index 000000000..e08a6e9f5 --- /dev/null +++ b/cmake/QtNodesConfig.cmake.in @@ -0,0 +1,18 @@ +get_filename_component(QtNodes_CMAKE_DIR "${CMAKE_CURRENT_LIST_FILE}" PATH) + +include(CMakeFindDependencyMacro) + +# NOTE Had to use find_package because find_dependency does not support COMPONENTS or MODULE until 3.8.0 + +find_dependency(QT NAMES Qt6 Qt5 REQUIRED COMPONENTS Widgets) +find_dependency(Qt${QT_VERSION_MAJOR} REQUIRED COMPONENTS + Core + Widgets + Gui + OpenGL) + +if(NOT TARGET QtNodes::QtNodes) + include("${QtNodes_CMAKE_DIR}/QtNodesTargets.cmake") +endif() + +set(QtNodes_LIBRARIES QtNodes::QtNodes) diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt new file mode 100644 index 000000000..8e38e057f --- /dev/null +++ b/docs/CMakeLists.txt @@ -0,0 +1,78 @@ +find_package(Doxygen) + +if(DOXYGEN_FOUND) + + # Find all the public headers + get_target_property(QT_NODES_PUBLIC_HEADER_DIR QtNodes INTERFACE_INCLUDE_DIRECTORIES) + + file(GLOB_RECURSE QT_NODES_PUBLIC_HEADERS ${QT_NODES_PUBLIC_HEADER_DIR}/*.hpp) + + #This will be the main output of our command + set(DOXYGEN_INDEX_FILE ${CMAKE_CURRENT_BINARY_DIR}/html/index.html) + + set(DOXYGEN_INPUT_DIR ${PROJECT_SOURCE_DIR}/src + ${PROJECT_SOURCE_DIR}/include + ${PROJECT_SOURCE_DIR}/examples/calculator) + # Making string joined with " " + list(JOIN DOXYGEN_INPUT_DIR " " DOXYGEN_INPUT_DIR_JOINED) + + set(DOXYGEN_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/doxygen) + + set(DOXYGEN_INDEX_FILE ${DOXYGEN_OUTPUT_DIR}/html/index.html) + + set(DOXYFILE_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in) + set(DOXYFILE_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile) + + + configure_file(${DOXYFILE_IN} ${DOXYFILE_OUT} @ONLY) + + + file(MAKE_DIRECTORY ${DOXYGEN_OUTPUT_DIR}) #Doxygen won't create this for us + + add_custom_command(OUTPUT ${DOXYGEN_INDEX_FILE} + DEPENDS ${QT_NODES_PUBLIC_HEADERS} + COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYFILE_OUT} + MAIN_DEPENDENCY ${DOXYFILE_OUT} ${DOXYFILE_IN} + COMMENT "Generating docs" + VERBATIM) + + add_custom_target(Doxygen ALL DEPENDS ${DOXYGEN_INDEX_FILE}) +endif() + + +##################################################################################### + + +find_package(Sphinx) + +if (Sphinx_FOUND) + set(SPHINX_SOURCE ${CMAKE_CURRENT_SOURCE_DIR}) + set(SPHINX_BUILD ${CMAKE_CURRENT_BINARY_DIR}/sphinx) + set(SPHINX_INDEX_FILE ${SPHINX_BUILD}/index.html) + + # Only regenerate Sphinx when: + # - Doxygen has rerun + # - Our doc files have been updated + # - The Sphinx config has been updated + + + add_custom_command(OUTPUT ${SPHINX_INDEX_FILE} + COMMAND ${SPHINX_EXECUTABLE} -b html + # Tell Breathe where to find the Doxygen output + -Dbreathe_projects.QtNodes=${DOXYGEN_OUTPUT_DIR}/xml + ${SPHINX_SOURCE} ${SPHINX_BUILD} + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} + # Other docs files you want to track should go here (or in some variable) + DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/index.rst + ${DOXYGEN_INDEX_FILE} + MAIN_DEPENDENCY ${SPHINX_SOURCE}/conf.py + COMMENT "Generating documentation with Sphinx") + + # Nice named target so we can run the job easily + add_custom_target(Sphinx ALL DEPENDS ${SPHINX_INDEX_FILE}) + + # Add an install target to install the docs + include(GNUInstallDirs) + install(DIRECTORY ${SPHINX_BUILD} + DESTINATION ${CMAKE_INSTALL_DOCDIR}) +endif() diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in new file mode 100644 index 000000000..d58dcbf5d --- /dev/null +++ b/docs/Doxyfile.in @@ -0,0 +1,2618 @@ +# Doxyfile 1.9.1 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "QtNodes" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = 1 + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = @DOXYGEN_OUTPUT_DIR@ + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all generated output in the proper direction. +# Possible values are: None, LTR, RTL and Context. +# The default value is: None. + +OUTPUT_TEXT_DIRECTION = None + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# By default Python docstrings are displayed as preformatted text and doxygen's +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the +# doxygen's special commands can be used and the contents of the docstring +# documentation blocks is shown as doxygen documentation. +# The default value is: YES. + +PYTHON_DOCSTRING = YES + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines (in the resulting output). You can put ^^ in the value part of an +# alias to insert a newline as if a physical newline was in the original file. +# When you need a literal { or } or , in the value part of an alias you have to +# escape them by means of a backslash (\), this can lead to conflicts with the +# commands \{ and \} for these it is advised to use the version @{ and @} or use +# a double escape (\\{ and \\}) + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, +# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL, +# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files). For instance to make doxygen treat .inc files +# as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. When specifying no_extension you should add +# * to the FILE_PATTERNS. +# +# Note see also the list of default file extension mappings. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 5 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = YES + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use +# during processing. When set to 0 doxygen will based this on the number of +# cores available in the system. You can set it explicitly to a value larger +# than 0 to get more control over the balance between CPU load and processing +# speed. At this moment only the input processing can be done using multiple +# threads. Since this is still an experimental feature the default is set to 1, +# which efficively disables parallel processing. Please report any issues you +# encounter. Generating dot graphs in parallel is controlled by the +# DOT_NUM_THREADS setting. +# Minimum value: 0, maximum value: 32, default value: 1. + +NUM_PROC_THREADS = 1 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If this flag is set to YES, the name of an unnamed parameter in a declaration +# will be determined by the corresponding definition. By default unnamed +# parameters remain unnamed in the output. +# The default value is: YES. + +RESOLVE_UNNAMED_PARAMS = YES + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# declarations. If set to NO, these declarations will be included in the +# documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# With the correct setting of option CASE_SENSE_NAMES doxygen will better be +# able to match the capabilities of the underlying filesystem. In case the +# filesystem is case sensitive (i.e. it supports files in the same directory +# whose names only differ in casing), the option must be set to YES to properly +# deal with such files in case they appear in the input. For filesystems that +# are not case sensitive the option should be be set to NO to properly deal with +# output files written for symbols that only differ in casing, such as for two +# classes, one named CLASS and the other named Class, and to also support +# references to files without having to specify the exact matching casing. On +# Windows (including Cygwin) and MacOS, users should typically set this option +# to NO, whereas on Linux or other Unix flavors it should typically be set to +# YES. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. If +# EXTRACT_ALL is set to YES then this flag will automatically be disabled. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS +# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the doxygen process doxygen will return with a non-zero status. +# Possible values are: NO, YES and FAIL_ON_WARNINGS. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = @DOXYGEN_INPUT_DIR_JOINED@ + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: +# https://www.gnu.org/software/libiconv/) for the list of possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# Note the list of default checked file patterns might differ from the list of +# default file extension mappings. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment), +# *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, *.vhdl, +# *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f18 \ + *.f \ + *.for \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf \ + *.ice + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: +# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To +# create a documentation set, doxygen will generate a Makefile in the HTML +# output directory. Running make will produce the docset in that directory and +# running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: +# https://www.microsoft.com/en-us/download/details.aspx?id=21138) on Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the main .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location (absolute path +# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to +# run qhelpgenerator on the generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for +# the HTML output. These images will generally look nicer at scaled resolutions. +# Possible values are: png (the default) and svg (looks nicer but requires the +# pdf2svg or inkscape tool). +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = png + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANSPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side JavaScript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from https://www.mathjax.org before deployment. +# The default value is: https://cdn.jsdelivr.net/npm/mathjax@2. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@2 + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /