Sign Up
Log In
Log In
or
Sign Up
Places
All Projects
Status Monitor
Collapse sidebar
home:jonaski:audio
strawberry
kdsingleapplication.patch
Overview
Repositories
Revisions
Requests
Users
Attributes
Meta
File kdsingleapplication.patch of Package strawberry
diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/.clang-format b/3rdparty/kdsingleapplication/KDSingleApplication/.clang-format new file mode 100644 index 0000000..a681ad3 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/.clang-format @@ -0,0 +1,72 @@ +--- +BasedOnStyle: WebKit +Language: Cpp +Standard: Cpp11 + +IndentWidth: 4 +SpacesBeforeTrailingComments: 1 +TabWidth: 8 +UseTab: Never +SortIncludes: false +ContinuationIndentWidth: 4 +MaxEmptyLinesToKeep: 3 +BreakBeforeBinaryOperators: NonAssignment +BreakBeforeTernaryOperators: true +BreakConstructorInitializers: BeforeColon +BreakConstructorInitializersBeforeComma: true + +BreakBeforeBraces: Custom +BraceWrapping: + AfterClass: true + AfterControlStatement: false + AfterEnum: false + AfterFunction: true + AfterNamespace: false + AfterObjCDeclaration: false + AfterStruct: true + AfterUnion: false + BeforeCatch: false + BeforeElse: false + IndentBraces: false + +ForEachMacros: + - forever # avoids { wrapped to next line + - foreach + - Q_FOREACH + +AccessModifierOffset: -4 +ConstructorInitializerIndentWidth: 4 +AlignEscapedNewlinesLeft: false +AlignTrailingComments: false +AllowAllParametersOfDeclarationOnNextLine: true +AllowShortIfStatementsOnASingleLine: false +AllowShortLoopsOnASingleLine: false +AllowShortFunctionsOnASingleLine: false +AllowShortEnumsOnASingleLine: false # requires clang-format 11 +AlignAfterOpenBracket: true +AlwaysBreakBeforeMultilineStrings: false +AlwaysBreakTemplateDeclarations: true +BinPackParameters: true +ColumnLimit: 0 +Cpp11BracedListStyle: false +DerivePointerBinding: false +ExperimentalAutoDetectBinPacking: false +IndentCaseLabels: false +NamespaceIndentation: None +ObjCSpaceBeforeProtocolList: true +PenaltyBreakBeforeFirstCallParameter: 19 +PenaltyBreakComment: 60 +PenaltyBreakFirstLessLess: 120 +PenaltyBreakString: 1000 +PenaltyExcessCharacter: 1000000 +PenaltyReturnTypeOnItsOwnLine: 60 +PointerBindsToType: false +SpaceAfterTemplateKeyword: false +IndentFunctionDeclarationAfterType: false +SpaceAfterControlStatementKeyword: true +SpaceBeforeAssignmentOperators: true +SpaceInEmptyParentheses: false +SpacesInAngles: false +SpacesInCStyleCastParentheses: true +SpacesInParentheses: false +... diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/.cmake-format.py b/3rdparty/kdsingleapplication/KDSingleApplication/.cmake-format.py new file mode 100644 index 0000000..d0101f7 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/.cmake-format.py @@ -0,0 +1,241 @@ +# ---------------------------------- +# Options affecting listfile parsing +# ---------------------------------- +with section("parse"): + + # Specify structure for custom cmake functions + additional_commands = {'foo': {'flags': ['BAR', 'BAZ'], + 'kwargs': {'DEPENDS': '*', 'HEADERS': '*', 'SOURCES': '*'}}} + + # Override configurations per-command where available + override_spec = {} + + # Specify variable tags. + vartags = [] + + # Specify property tags. + proptags = [] + +# ----------------------------- +# Options affecting formatting. +# ----------------------------- +with section("format"): + + # Disable formatting entirely, making cmake-format a no-op + disable = False + + # How wide to allow formatted cmake files + line_width = 120 + + # How many spaces to tab for indent + tab_size = 4 + + # If true, lines are indented using tab characters (utf-8 0x09) instead of + # <tab_size> space characters (utf-8 0x20). In cases where the layout would + # require a fractional tab character, the behavior of the fractional + # indentation is governed by <fractional_tab_policy> + use_tabchars = False + + # If <use_tabchars> is True, then the value of this variable indicates how + # fractional indentions are handled during whitespace replacement. If set to + # 'use-space', fractional indentation is left as spaces (utf-8 0x20). If set + # to `round-up` fractional indentation is replaced with a single tab character + # (utf-8 0x09) effectively shifting the column to the next tabstop + fractional_tab_policy = 'use-space' + + # If an argument group contains more than this many sub-groups (parg or kwarg + # groups) then force it to a vertical layout. + max_subgroups_hwrap = 2 + + # If a positional argument group contains more than this many arguments, then + # force it to a vertical layout. + max_pargs_hwrap = 4 + + # If a cmdline positional group consumes more than this many lines without + # nesting, then invalidate the layout (and nest) + max_rows_cmdline = 2 + + # If true, separate flow control names from their parentheses with a space + separate_ctrl_name_with_space = False + + # If true, separate function names from parentheses with a space + separate_fn_name_with_space = False + + # If a statement is wrapped to more than one line, than dangle the closing + # parenthesis on its own line. + dangle_parens = True + + # If the trailing parenthesis must be 'dangled' on its on line, then align it + # to this reference: `prefix`: the start of the statement, `prefix-indent`: + # the start of the statement, plus one indentation level, `child`: align to + # the column of the arguments + dangle_align = 'prefix' + + # If the statement spelling length (including space and parenthesis) is + # smaller than this amount, then force reject nested layouts. + min_prefix_chars = 4 + + # If the statement spelling length (including space and parenthesis) is larger + # than the tab width by more than this amount, then force reject un-nested + # layouts. + max_prefix_chars = 10 + + # If a candidate layout is wrapped horizontally but it exceeds this many + # lines, then reject the layout. + max_lines_hwrap = 2 + + # What style line endings to use in the output. + line_ending = 'unix' + + # Format command names consistently as 'lower' or 'upper' case + command_case = 'lower' + + # Format keywords consistently as 'lower' or 'upper' case + keyword_case = 'upper' + + # A list of command names which should always be wrapped + always_wrap = ["add_executable", "add_library", + "target_link_libraries", "target_include_directories", "install"] + + # If true, the argument lists which are known to be sortable will be sorted + # lexicographicall + enable_sort = True + + # If true, the parsers may infer whether or not an argument list is sortable + # (without annotation). + autosort = True + + # By default, if cmake-format cannot successfully fit everything into the + # desired linewidth it will apply the last, most agressive attempt that it + # made. If this flag is True, however, cmake-format will print error, exit + # with non-zero status code, and write-out nothing + require_valid_layout = False + + # A dictionary mapping layout nodes to a list of wrap decisions. See the + # documentation for more information. + layout_passes = {} + +# ------------------------------------------------ +# Options affecting comment reflow and formatting. +# ------------------------------------------------ +with section("markup"): + + # What character to use for bulleted lists + bullet_char = '*' + + # What character to use as punctuation after numerals in an enumerated list + enum_char = '.' + + # If comment markup is enabled, don't reflow the first comment block in each + # listfile. Use this to preserve formatting of your copyright/license + # statements. + first_comment_is_literal = False + + # If comment markup is enabled, don't reflow any comment block which matches + # this (regex) pattern. Default is `None` (disabled). + literal_comment_pattern = None + + # Regular expression to match preformat fences in comments default= + # ``r'^\s*([`~]{3}[`~]*)(.*)$'`` + fence_pattern = '^\\s*([`~]{3}[`~]*)(.*)$' + + # Regular expression to match rulers in comments default= + # ``r'^\s*[^\w\s]{3}.*[^\w\s]{3}$'`` + ruler_pattern = '^\\s*[^\\w\\s]{3}.*[^\\w\\s]{3}$' + + # If a comment line matches starts with this pattern then it is explicitly a + # trailing comment for the preceeding argument. Default is '#<' + explicit_trailing_pattern = '#<' + + # If a comment line starts with at least this many consecutive hash + # characters, then don't lstrip() them off. This allows for lazy hash rulers + # where the first hash char is not separated by space + hashruler_min_length = 10 + + # If true, then insert a space between the first hash char and remaining hash + # chars in a hash ruler, and normalize its length to fill the column + canonicalize_hashrulers = True + + # enable comment markup parsing and reflow + enable_markup = False + +# ---------------------------- +# Options affecting the linter +# ---------------------------- +with section("lint"): + + # a list of lint codes to disable + disabled_codes = [] + + # regular expression pattern describing valid function names + function_pattern = '[0-9a-z_]+' + + # regular expression pattern describing valid macro names + macro_pattern = '[0-9a-z_]+' + + # regular expression pattern describing valid names for variables with global + # (cache) scope + global_var_pattern = '[A-Z][0-9A-Z_]+' + + # regular expression pattern describing valid names for variables with global + # scope (but internal semantic) + internal_var_pattern = '[A-Z][0-9A-Z_]+' + + # regular expression pattern describing valid names for variables with local + # scope + local_var_pattern = '[_A-Za-z][A-Za-z0-9_]+' + + # regular expression pattern describing valid names for privatedirectory + # variables + private_var_pattern = '[0-9a-z_]+' + + # regular expression pattern describing valid names for public directory + # variables + public_var_pattern = '.*' + + # regular expression pattern describing valid names for function/macro + # arguments and loop variables. + argument_var_pattern = '[a-z_][a-z0-9_]+' + + # regular expression pattern describing valid names for keywords used in + # functions or macros + keyword_pattern = '[A-Z][0-9A-Z_]+' + + # In the heuristic for C0201, how many conditionals to match within a loop in + # before considering the loop a parser. + max_conditionals_custom_parser = 2 + + # Require at least this many newlines between statements + min_statement_spacing = 1 + + # Require no more than this many newlines between statements + max_statement_spacing = 2 + max_returns = 6 + max_branches = 15 + max_arguments = 10 + max_localvars = 15 + max_statements = 50 + +# ------------------------------- +# Options affecting file encoding +# ------------------------------- +with section("encode"): + + # If true, emit the unicode byte-order mark (BOM) at the start of the file + emit_byteorder_mark = False + + # Specify the encoding of the input file. Defaults to utf-8 + input_encoding = 'utf-8' + + # Specify the encoding of the output file. Defaults to utf-8. Note that cmake + # only claims to support utf-8 so be careful when using anything else + output_encoding = 'utf-8' + +# ------------------------------------- +# Miscellaneous configurations options. +# ------------------------------------- +with section("misc"): + + # A dictionary containing any per-command configuration overrides. Currently + # only `command_case` is supported. + per_command = {} diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/.codespellrc b/3rdparty/kdsingleapplication/KDSingleApplication/.codespellrc new file mode 100644 index 0000000..18572ef --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/.codespellrc @@ -0,0 +1,6 @@ +[codespell] +skip = ./build-*,.git +interactive = 3 +ignore-words-list = overlayed +#ignore camelCase, regardless. also mixed case words with correct spelling +ignore-regex = \b([a-z]+[A-Z0-9][a-z0-9]*)\b diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/.github/workflows/build.yml b/3rdparty/kdsingleapplication/KDSingleApplication/.github/workflows/build.yml new file mode 100644 index 0000000..c1651f2 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/.github/workflows/build.yml @@ -0,0 +1,90 @@ +# SPDX-FileCopyrightText: 2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> +# +# SPDX-License-Identifier: MIT + +name: CI + +on: + push: + branches: + - master + pull_request: + branches: + - master + +jobs: + build: + runs-on: ${{ matrix.os }} + strategy: + fail-fast: true + matrix: + os: + - ubuntu-22.04 + #- ubuntu-20.04 + - windows-2022 + #- windows-2019 + - macos-12 + #- macos-11 + build_type: + - Debug + #- Release + qt: + - version: "5.15.2" + requested: "5.15" + - version: "6.5.3" + requested: "6.5.*" + + steps: + - name: Install Qt with options and default aqtversion + uses: jurplel/install-qt-action@v3 + with: + aqtversion: null # use whatever the default is + modules: ${{ matrix.qt.modules }} + version: ${{ matrix.qt.requested }} + cache: true + + - name: Checkout sources + uses: actions/checkout@v4 + + - name: Create build directory + run: mkdir build + + - name: Install ninja-build tool (must be after Qt due PATH changes) + uses: turtlesec-no/get-ninja@main + + - name: Make sure MSVC is found when Ninja generator is in use + uses: ilammy/msvc-dev-cmd@v1 + + - name: Configure project + run: > + cmake -S . -B ./build -G Ninja + -DCMAKE_BUILD_TYPE=${{ matrix.build_type }} + -DKDSingleApplication_QT6=${{ startsWith(matrix.qt.version, '6.') }} + -DKDSingleApplication_DEVELOPER_MODE=${{ matrix.build_type == 'Debug' }} + -DKDSingleApplication_TESTS=${{ matrix.build_type == 'Debug' }} + -DKDSingleApplication_EXAMPLES=${{ matrix.build_type == 'Debug' }} + -DKDSingleApplication_DOCS=${{ matrix.build_type == 'Debug' && runner.os == 'Linux' }} + + - name: Build Project + run: cmake --build ./build + + - name: Run tests on Linux (offscreen) + if: ${{ matrix.build_type == 'Debug' && runner.os == 'Linux' }} + run: ctest --test-dir ./build -C ${{ matrix.build_type }} --output-on-failure + env: + QT_QPA_PLATFORM: offscreen + + - name: Run tests on macOS + if: ${{ matrix.build_type == 'Debug' && runner.os == 'macOS' }} + run: ctest --test-dir ./build -C ${{ matrix.build_type }} --output-on-failure + + # Exclude stress test, proper QProcess cleanup fixed local tests, but at CI it's flaky + - name: Run tests on Windows + if: ${{ matrix.build_type == 'Debug' && runner.os == 'Windows' }} + run: ctest -V --test-dir ./build -C ${{ matrix.build_type }} --output-on-failure --exclude-regex "tst_stresstest" + + - name: Read tests log when it fails + uses: andstor/file-reader-action@v1 + if: ${{ failure() && matrix.build_type == 'Debug' }} + with: + path: "./build/Testing/Temporary/LastTest.log" diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/.gitignore b/3rdparty/kdsingleapplication/KDSingleApplication/.gitignore new file mode 100644 index 0000000..e399a6e --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/.gitignore @@ -0,0 +1,5 @@ +*.pro.user +Makefile +.cmake/ +CMakeLists.txt.user +/build*/ diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/.gitreview b/3rdparty/kdsingleapplication/KDSingleApplication/.gitreview new file mode 100644 index 0000000..ecfa597 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/.gitreview @@ -0,0 +1,5 @@ +[gerrit] +host=codereview.kdab.com +port=29418 +project=kdab/KDSingleApplication +defaultbranch=master diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/.krazy b/3rdparty/kdsingleapplication/KDSingleApplication/.krazy new file mode 100644 index 0000000..f2b65e0 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/.krazy @@ -0,0 +1,16 @@ +CHECKSETS qt5,c++,foss + +#KDAB-specific checks +EXTRA kdabcopyright-reuse,kdabcontactus,fosslicense-reuse + +#exclude checks now being done by clazy or clang-tools +EXCLUDE strings,explicit,normalize,passbyvalue,operators,nullstrcompare,nullstrassign,doublequote_chars,qobject,sigsandslots,staticobjects +#exclude more checks +EXCLUDE qminmax,captruefalse +EXCLUDE style + +#skip other cmake +SKIP Doxyfile.cmake +SKIP \.cmake-format\.py +#skip the borrowed code in the cmake subdir +SKIP /cmake/ECM/|/cmake/KDAB/ diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/.mdlrc b/3rdparty/kdsingleapplication/KDSingleApplication/.mdlrc new file mode 100644 index 0000000..3acbfec --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/.mdlrc @@ -0,0 +1 @@ +style ".mdlrc.rb" diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/.mdlrc.rb b/3rdparty/kdsingleapplication/KDSingleApplication/.mdlrc.rb new file mode 100644 index 0000000..b9f5244 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/.mdlrc.rb @@ -0,0 +1,5 @@ +all +rule 'MD007', :indent => 2, :start_indented => false +rule 'MD013', :line_length => 100, :tables => false +rule 'MD029', :style => :ordered +exclude_rule 'MD033' diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/.pre-commit-config.yaml b/3rdparty/kdsingleapplication/KDSingleApplication/.pre-commit-config.yaml new file mode 100644 index 0000000..43f5421 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/.pre-commit-config.yaml @@ -0,0 +1,41 @@ +# See https://pre-commit.com for more information +# See https://pre-commit.com/hooks.html for more hooks +exclude: ^(cmake/ECM|cmake/KDAB/) +repos: +- repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.4.0 + hooks: + - id: trailing-whitespace + - id: end-of-file-fixer + - id: check-added-large-files + - id: check-case-conflict + - id: check-yaml + args: [--allow-multiple-documents] + - id: check-json +- repo: https://github.com/pre-commit/mirrors-clang-format + rev: v16.0.6 + hooks: + - id: clang-format + exclude: (.json) +- repo: https://github.com/codespell-project/codespell + rev: v2.2.5 + hooks: + - id: codespell +- repo: https://github.com/cheshirekow/cmake-format-precommit + rev: v0.6.13 + hooks: + - id: cmake-lint + exclude: (.py.cmake|Doxyfile.cmake) + - id: cmake-format + exclude: (.py.cmake|Doxyfile.cmake) +- repo: https://github.com/markdownlint/markdownlint + rev: v0.12.0 + hooks: + - id: markdownlint + entry: mdl + language: ruby + files: \.(md|mdown|markdown)$ +- repo: https://github.com/fsfe/reuse-tool + rev: v2.1.0 + hooks: + - id: reuse diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/.reuse/dep5 b/3rdparty/kdsingleapplication/KDSingleApplication/.reuse/dep5 new file mode 100644 index 0000000..9011f83 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/.reuse/dep5 @@ -0,0 +1,29 @@ +Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ +Upstream-Name: KDSingleApplication +Upstream-Contact: <info@kdab.com> +Source: https://www.github.com/KDAB/KDSingleApplication + +#misc source code +#Files: +#Copyright: 2019-2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> +#License: MIT + +#misc documentation +Files: README.md INSTALL.txt docs/api/*.html +Copyright: 2019-2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> +License: MIT + +#misc config files +Files: .clang-format .cmake-format.py .codespellrc .gitignore .gitreview .krazy .mdlrc .mdlrc.rb .pre-commit-config.yaml appveyor.yml docs/api/Doxyfile.cmake distro/* +Copyright: 2019-2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> +License: MIT + +#artwork +Files: docs/api/*.png +Copyright: 2019-2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> +License: MIT + +#3rdparty +Files: cmake/ECM/modules/* +Copyright: The KDE Project +License: BSD-3-Clause diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/CMakeLists.txt b/3rdparty/kdsingleapplication/KDSingleApplication/CMakeLists.txt new file mode 100644 index 0000000..9e52ebe --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/CMakeLists.txt @@ -0,0 +1,219 @@ +# This file is part of KDSingleApplication. +# +# SPDX-FileCopyrightText: 2020-2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> +# +# SPDX-License-Identifier: MIT +# +# Contact KDAB at <info@kdab.com> for commercial licensing options. +# + +# This is the top-level CMakeLists.txt file for the KDSingleApplication project. +# +# Pass the following variables to cmake to control the build: +# (See INSTALL.txt for more information) +# +# -DKDSingleApplication_QT6=[true|false] +# Build against Qt6 rather than Qt5 +# Default=false (Qt5 will be used even if Qt6 is available) +# +# -DKDSingleApplication_STATIC=[true|false] +# Build static versions of the libraries +# Default=false +# +# -DKDSingleApplication_TESTS=[true|false] +# Build the test harness. +# Default=false +# +# -DKDSingleApplication_EXAMPLES=[true|false] +# Build the examples. +# Default=true +# +# -DKDSingleApplication_DOCS=[true|false] +# Build the API documentation. Enables the 'docs' build target. +# Default=false +# +## DO NOT USE IF YOU ARE AN END-USER. FOR THE DEVELOPERS ONLY!! +# Special CMake Options for Developers +# +# -DKDSingleApplication_DEVELOPER_MODE=[true|false] +# Configure the build for a developer setup (strict compiler options, etc) +# Default=false +# + +cmake_minimum_required(VERSION 3.12) + +project( + KDSingleApplication + DESCRIPTION "KDSingleApplication is a helper class for single-instance policy applications written by KDAB" + HOMEPAGE_URL "https://github.com/KDAB/KDSingleApplication" + LANGUAGES CXX +) + +set(${PROJECT_NAME}_VERSION_MAJOR 1) +set(${PROJECT_NAME}_VERSION_MINOR 0) +set(${PROJECT_NAME}_VERSION_PATCH 95) +set(${PROJECT_NAME}_VERSION + ${${PROJECT_NAME}_VERSION_MAJOR}.${${PROJECT_NAME}_VERSION_MINOR}.${${PROJECT_NAME}_VERSION_PATCH} +) +set(PROJECT_VERSION ${${PROJECT_NAME}_VERSION}) #PROJECT_VERSION is needed by some ECM modules +set(${PROJECT_NAME}_SOVERSION "1.1") + +cmake_policy(SET CMP0020 NEW) +cmake_policy(SET CMP0042 NEW) + +include(FeatureSummary) + +option(${PROJECT_NAME}_QT6 "Build against Qt 6" OFF) +option(${PROJECT_NAME}_DEVELOPER_MODE "Developer Mode" OFF) +option(${PROJECT_NAME}_TESTS "Build the tests" OFF) +option(${PROJECT_NAME}_EXAMPLES "Build the examples" ON) +option(${PROJECT_NAME}_DOCS "Build the API documentation" OFF) +option(${PROJECT_NAME}_STATIC "Build lib as static" OFF) + +list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/cmake/ECM/modules") +list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/cmake/KDAB/modules") + +# Set a default build type if none was specified +set(default_build_type "Release") +if(EXISTS "${CMAKE_SOURCE_DIR}/.git" OR ${PROJECT_NAME}_DEVELOPER_MODE) + set(default_build_type "Debug") +endif() +if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES) + message(STATUS "Setting build type to ${default_build_type} as none was specified.") + set(CMAKE_BUILD_TYPE + "${default_build_type}" + CACHE STRING "Choose the type of build." FORCE + ) + # Set the possible values of build type for cmake-gui + set_property( + CACHE CMAKE_BUILD_TYPE + PROPERTY STRINGS + "Debug" + "Release" + "MinSizeRel" + "RelWithDebInfo" + ) +endif() + +if(${PROJECT_NAME}_QT6) + find_package(QT NAMES Qt6 REQUIRED) + set(${PROJECT_NAME}_LIBRARY_QTID "-qt6") + set(KDSingleApplication_LIBRARY_QTID ${${PROJECT_NAME}_LIBRARY_QTID}) +else() + find_package(QT NAMES Qt5 REQUIRED) + set(${PROJECT_NAME}_LIBRARY_QTID "") + set(KDSingleApplication_LIBRARY_QTID "") +endif() +find_package(Qt${QT_VERSION_MAJOR} REQUIRED COMPONENTS Core Network Widgets) + +if(${PROJECT_NAME}_TESTS) + find_package(Qt${QT_VERSION_MAJOR} REQUIRED COMPONENTS Test) +endif() + +set(Qt_VERSION_MAJOR ${QT_VERSION_MAJOR}) # KDQtInstallPaths wants "Qt", not "QT" +include(KDQtInstallPaths) #to set QT_INSTALL_FOO variables + +add_definitions( + -DQT_NO_CAST_TO_ASCII + -DQT_NO_CAST_FROM_ASCII + -DQT_NO_URL_CAST_FROM_STRING + -DQT_NO_CAST_FROM_BYTEARRAY + -DQT_NO_SIGNALS_SLOTS_KEYWORDS + -DQT_USE_QSTRINGBUILDER + -DQT_NO_NARROWING_CONVERSIONS_IN_CONNECT + -DQT_NO_KEYWORDS + -DQT_DISABLE_DEPRECATED_BEFORE=0x051200 + -DQT_NO_FOREACH +) + +set(CMAKE_AUTOMOC ON) +set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin) +set(CMAKE_CXX_STANDARD 14) +set(CMAKE_CXX_STANDARD_REQUIRED ON) +if(NOT MSVC) + # Strict iterators can't be used on Windows with MSVC (for Qt<5.13) as they lead + # to a link error when application code iterates over a QVector<QPoint> for instance, + # unless Qt itself was also built with strict iterators. + # See example at https://bugreports.qt.io/browse/AUTOSUITE-946 + add_definitions(-DQT_STRICT_ITERATORS) + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wunused-parameter") +endif() + +# Default to hidden visibility for symbols +set(CMAKE_C_VISIBILITY_PRESET hidden) +set(CMAKE_CXX_VISIBILITY_PRESET hidden) +set(CMAKE_VISIBILITY_INLINES_HIDDEN 1) + +if(${PROJECT_NAME}_DEVELOPER_MODE) + add_definitions(-DQT_FORCE_ASSERTS) + if(NOT MSVC) + add_compile_options(-Wall -Wextra -Werror -Wshadow) + endif() +endif() + +# setup default install locations +include(KDInstallLocation) + +set(KDSINGLEAPPLICATION_INCLUDEDIR ${INSTALL_INCLUDE_DIR}/kdsingleapplication${KDSingleApplication_LIBRARY_QTID}) + +if(CMAKE_SOURCE_DIR STREQUAL PROJECT_SOURCE_DIR) + set(${PROJECT_NAME}_IS_ROOT_PROJECT TRUE) + + message(STATUS "Building ${PROJECT_NAME} ${${PROJECT_NAME}_VERSION} in ${CMAKE_BUILD_TYPE} mode. " + "Installing to ${CMAKE_INSTALL_PREFIX}" + ) + + set(CMAKE_RUNTIME_OUTPUT_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/bin") + set(CMAKE_LIBRARY_OUTPUT_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/lib") + set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/lib") + + install(FILES LICENSE.txt README.md DESTINATION ${INSTALL_DOC_DIR}) + install(DIRECTORY LICENSES DESTINATION ${INSTALL_DOC_DIR}) + + # Generate .pri file for qmake users (except when using the VS generator) + if(NOT CMAKE_CONFIGURATION_TYPES) + if(QT_VERSION_MAJOR EQUAL 5 OR (QT_VERSION_MAJOR EQUAL 6 AND Qt6Core_VERSION VERSION_GREATER "6.2")) + include(ECMGeneratePriFile) + set(PROJECT_VERSION_STRING ${${PROJECT_NAME}_VERSION}) + ecm_generate_pri_file( + BASE_NAME + KDSingleApplication + LIB_NAME + kdsingleapplication${KDSingleApplication_LIBRARY_QTID} + FILENAME_VAR + pri_filename + INCLUDE_INSTALL_DIR + ${KDSINGLEAPPLICATION_INCLUDEDIR} + ) + install(FILES ${pri_filename} DESTINATION ${ECM_MKSPECS_INSTALL_DIR}) + endif() + endif() +else() + #Always disable tests, examples, docs when used as a submodule + set(${PROJECT_NAME}_IS_ROOT_PROJECT FALSE) + set(${PROJECT_NAME}_TESTS FALSE) + set(${PROJECT_NAME}_EXAMPLES FALSE) + set(${PROJECT_NAME}_DOCS FALSE) +endif() + +add_subdirectory(src) + +if(${PROJECT_NAME}_TESTS) + enable_testing() + add_definitions(-DKDSINGLEAPPLICATION_BINARY_DIR="${CMAKE_BINARY_DIR}/bin/") + add_subdirectory(tests) +endif() +if(${PROJECT_NAME}_EXAMPLES) + add_subdirectory(examples) +endif() + +if(${PROJECT_NAME}_DOCS) + add_subdirectory(docs) # needs to go last, in case there are build source files +endif() + +if(${PROJECT_NAME}_IS_ROOT_PROJECT) + # Add uninstall target (not for submodules since parent projects typically have uninstall too) + include(ECMUninstallTarget) +endif() + +feature_summary(WHAT ALL INCLUDE_QUIET_PACKAGES FATAL_ON_MISSING_REQUIRED_PACKAGES) diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/INSTALL.txt b/3rdparty/kdsingleapplication/KDSingleApplication/INSTALL.txt new file mode 100644 index 0000000..aeb83b3 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/INSTALL.txt @@ -0,0 +1,97 @@ +These are the instructions for installing KDSingleApplication using the CMake buildsystem. +CMake version 3.12 or higher is required. + +Qt Version support: + * Qt5 and Qt6 is supported + +Also note that the code requires a C++14 compliant compiler, + +Please see the comments at the top of CMakeLists.txt for +the available configuration options you can pass to cmake. + +The installation directory defaults to C:/Program Files (x86)/KDSingleApplication on Windows +(you'll need admin privileges) and /usr/local on non-Windows. You can change this +location by passing the option -DCMAKE_INSTALL_PREFIX=/install/path to cmake. + +1) From the top directory of your KDSingleApplication installation create a build directory: + + mkdir build + + and change directory into that build directory: + + cd build + +2) Now run 'cmake' depending on the kind of build one of the following: + cmake -DCMAKE_BUILD_TYPE=Debug .. + cmake -DCMAKE_BUILD_TYPE=Release .. + cmake -DKDSingleApplication_STATIC=True -DCMAKE_BUILD_TYPE=Debug .. + cmake -DKDSingleApplication_STATIC=True -DCMAKE_BUILD_TYPE=Release .. + + To define the install-location use for example: + cmake -DCMAKE_BUILD_TYPE=Debug -DCMAKE_INSTALL_PREFIX=C:/KDAB/kdsingleapplication .. + cmake -DCMAKE_BUILD_TYPE=Debug -DCMAKE_INSTALL_PREFIX=/opt/kdsingleapplication .. + +3) Unix + + set your LD_LIBRARY_PATH to point to your KDSingleApplication installation lib directory. + + If you do not have LD_LIBRARY_PATH set already, then in your terminal run: + % LD_LIBRARY_PATH=/path/to/kdsingleapplication/lib:$LD_LIBRARY_PATH + % export LD_LIBRARY_PATH + + The above must be added into your .bashrc or similar to remain. It may also of course + be run from a shell just before building software using KDSingleApplication, but in this case + your settings will only be available for this shell. + +4) MacOS + + Proceed as described above, but using DYLD_LIBRARY_PATH instead of LD_LIBRARY_PATH + +5) Windows + + For running executables, add the path to the KDSingleApplication dll (kdsingleapplication\bin) into your PATH. + eg. set PATH=C:\KDAB\kdsingleapplication\bin;%PATH% + + For development, add the path to the KDSingleApplication lib (kdsingleapplication\lib) into your LIB environment. + eg. set LIB=C:\KDAB\kdsingleapplication\lib;%LIB% + +6) Build everything by typing: + + From your top-level KDSingleApplication directory run: + + % make # Unix, Mac + % nmake # Windows + +7) (optionally:) Install KDSingleApplication: + + From your top-level KDSingleApplication directory run: + + % make install # Unix, Mac + % nmake install # Windows + + This will copy the necessary files into the sub-directories of your installation path: + For Unix/Linux, Mac: /usr/local + For Windows this is: C:\Program Files (x86)\KDSingleApplication + +8) Have a look at the examples applications. They will get you started with KDSingleApplication. + +== Testing == +To build the testing harness, pass -DKDSingleApplication_TESTS=true to CMake, like so: + % cmake -DKDSingleApplication_TESTS=true + +Then run 'make test' to run the unit tests. + +== Using == +From your CMake project, add + + find_package(KDSingleApplication CONFIG REQUIRED) + +or for Qt6 + + find_package(KDSingleApplication-qt6 CONFIG REQUIRED) + +and link to the imported target KDAB::kdsingleapplication. +That's all you need to do (the imported target also brings in the include directories) + +You may also need to point the CMAKE_PREFIX_PATH environment variable depending +on where you installed KDSingleApplication. diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/LICENSE.txt b/3rdparty/kdsingleapplication/KDSingleApplication/LICENSE.txt new file mode 100644 index 0000000..12ee586 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/LICENSE.txt @@ -0,0 +1,6 @@ +KDSingleApplication is (C) 2019-2023, Klarälvdalens Datakonsult AB, +and is available under the terms of the MIT license. + +See the full license text in the LICENSES folder. + +Contact KDAB at <info@kdab.com> to inquire about commercial licensing. diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/LICENSES/BSD-3-Clause.txt b/3rdparty/kdsingleapplication/KDSingleApplication/LICENSES/BSD-3-Clause.txt new file mode 100644 index 0000000..086d399 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/LICENSES/BSD-3-Clause.txt @@ -0,0 +1,11 @@ +Copyright (c) <year> <owner>. + +Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. + +2. 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. + +3. Neither the name of the 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 HOLDER 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/3rdparty/kdsingleapplication/KDSingleApplication/LICENSES/MIT.txt b/3rdparty/kdsingleapplication/KDSingleApplication/LICENSES/MIT.txt new file mode 100644 index 0000000..2071b23 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/LICENSES/MIT.txt @@ -0,0 +1,9 @@ +MIT License + +Copyright (c) <year> <copyright holders> + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/README.md b/3rdparty/kdsingleapplication/KDSingleApplication/README.md new file mode 100644 index 0000000..1c6e452 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/README.md @@ -0,0 +1,55 @@ +# KDSingleApplication + +`KDSingleApplication` is a helper class for single-instance policy applications +written by [KDAB](https://www.kdab.com). + +## Usage + +Currently the documentation is woefully lacking, but see the examples or tests +for inspiration. Basically it involves: + +1. Create a `Q(Core|Gui)Application` object. +2. Create a `KDSingleApplication` object. +3. Check if the current instance is *primary* (or "master") or + *secondary* (or "slave") by calling `isPrimaryInstance`: + * the *primary* instance needs to listen from messages coming from the + secondary instances, by connecting a slot to the `messageReceived` signal; + * the *secondary* instances can send messages to the primary instance + by calling `sendMessage`. + +See [INSTALL.txt](INSTALL.txt) for installation instructions using CMake. + +## Licensing + +KDSingleApplication is (C) 2019-2023, Klarälvdalens Datakonsult AB, and is available +under the terms of the [MIT license](LICENSES/MIT.txt). + +Contact KDAB at <info@kdab.com> if you need different licensing options. + +## Get Involved + +KDAB will happily accept external contributions. + +Please submit your contributions or issue reports from our GitHub space at +<https://github.com/KDAB/KDSingleApplication>. + +## About KDAB + +KDSingleApplication is supported and maintained by Klarälvdalens Datakonsult AB (KDAB). + +The KDAB Group is the global No.1 software consultancy for Qt, C++ and +OpenGL applications across desktop, embedded and mobile platforms. + +The KDAB Group provides consulting and mentoring for developing Qt applications +from scratch and in porting from all popular and legacy frameworks to Qt. +We continue to help develop parts of Qt and are one of the major contributors +to the Qt Project. We can give advanced or standard trainings anywhere +around the globe on Qt as well as C++, OpenGL, 3D and more. + +Please visit <https://www.kdab.com> to meet the people who write code like this. + +Stay up-to-date with KDAB product announcements: + +* [KDAB Newsletter](https://news.kdab.com) +* [KDAB Blogs](https://www.kdab.com/category/blogs) +* [KDAB on Twitter](https://twitter.com/KDABQt) diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/appveyor.yml b/3rdparty/kdsingleapplication/KDSingleApplication/appveyor.yml new file mode 100644 index 0000000..2a980ff --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/appveyor.yml @@ -0,0 +1,94 @@ +#---------------------------------# +# general configuration # +#---------------------------------# + +# version format +version: 1.0.{build}-{branch} + +# branches to build +branches: + except: + - gh-pages + +# Do not build on tags (GitHub and BitBucket) +skip_tags: false + +#---------------------------------# +# environment configuration # +#---------------------------------# + +# Build worker image +image: + - Ubuntu2004 + - macos-monterey + - Visual Studio 2019 + +# scripts that are called at very beginning, before repo cloning +init: + - git config --global core.autocrlf input + +#---------------------------------# +# build configuration # +#---------------------------------# + +# build platform, i.e. x86, x64, Any CPU. This setting is optional. +platform: + - x64 + +# build Configuration, i.e. Debug, Release, etc. +configuration: + - Release + - Debug + +environment: + matrix: + - useqt6: False + - useqt6: True + +install: + - sh: if [ "`uname -s`" = "Darwin" ]; then brew install ninja; else sudo apt-get -y update; sudo apt-get -y install mesa-common-dev libglu1-mesa-dev libxkbcommon-dev libxkbcommon-x11-dev; fi + +before_build: + - cmd: call "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvars64.bat" + - cmd: set PATH=C:\Qt\6.5\msvc2019_64\bin;C:\Qt\5.15\msvc2019_64\bin;%PATH% + - sh: export QT_QUICK_BACKEND=software + - sh: if [ "`uname -s`" = "Darwin" ]; then export PATH=$HOME/Qt/6.2/macos/bin:$HOME/Qt/5.15/clang_64/bin:$PATH; else export PATH=$HOME/Qt/6.3/gcc_64/bin:$HOME/Qt/5.15/gcc_64/bin:$PATH; fi + +build_script: + - mkdir build + - cd build + - cmd: cmake -G Ninja -DCMAKE_BUILD_TYPE=%CONFIGURATION% -DKDSingleApplication_QT6=%useqt6% -DKDSingleApplication_TESTS=True -DKDSingleApplication_EXAMPLES=True -DKDSingleApplication_DEVELOPER_MODE=True .. + - sh: cmake -G Ninja -DCMAKE_BUILD_TYPE=$CONFIGURATION -DKDSingleApplication_QT6=$useqt6 -DKDSingleApplication_TESTS=True -DKDSingleApplication_EXAMPLES==True -DKDSingleApplication_DEVELOPER_MODE=True .. + - cmake --build . + - cmd: cmake --build . --target install + - sh: sudo cmake --build . --target install + - cmd: set PATH=.\bin;%PATH% + - ctest --test-dir . -V + +# to disable automatic builds +#build: off + +#---------------------------------# +# tests configuration # +#---------------------------------# + +# to disable automatic tests +test: off + + +#---------------------------------# +# deployment configuration # +#---------------------------------# + +deploy: off + +#---------------------------------# +# notifications # +#---------------------------------# +notifications: + # Email + - provider: Email + to: + - allen.winter@kdab.com + on_build_success: false + on_build_failure: true diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/cmake/ECM/modules/ECMGenerateHeaders.cmake b/3rdparty/kdsingleapplication/KDSingleApplication/cmake/ECM/modules/ECMGenerateHeaders.cmake new file mode 100644 index 0000000..86f35ad --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/cmake/ECM/modules/ECMGenerateHeaders.cmake @@ -0,0 +1,223 @@ +# SPDX-FileCopyrightText: 2013 Aleix Pol Gonzalez <aleixpol@blue-systems.com> +# SPDX-FileCopyrightText: 2014 Alex Merry <alex.merry@kdemail.net> +# SPDX-FileCopyrightText: 2015 Patrick Spendrin <patrick.spendrin@kdab.com> +# +# SPDX-License-Identifier: BSD-3-Clause + +#[=======================================================================[.rst: +ECMGenerateHeaders +------------------ + +Generate C/C++ CamelCase forwarding headers. + +:: + + ecm_generate_headers(<camelcase_forwarding_headers_var> + HEADER_NAMES <CamelCaseName> [<CamelCaseName> [...]] + [ORIGINAL <CAMELCASE|LOWERCASE>] + [HEADER_EXTENSION <header_extension>] + [OUTPUT_DIR <output_dir>] + [PREFIX <prefix>] + [REQUIRED_HEADERS <variable>] + [COMMON_HEADER <HeaderName>] + [RELATIVE <relative_path>]) + +For each CamelCase header name passed to ``HEADER_NAMES``, a file of that name +will be generated that will include a version with ``.h`` or, if set, +``.<header_extension>`` appended. +For example, the generated header ``ClassA`` will include ``classa.h`` (or +``ClassA.h``, see ``ORIGINAL``). +If a CamelCaseName consists of multiple comma-separated files, e.g. +``ClassA,ClassB,ClassC``, then multiple camelcase header files will be +generated which are redirects to the first header file. +The file locations of these generated headers will be stored in +<camelcase_forwarding_headers_var>. + +``ORIGINAL`` specifies how the name of the original header is written: lowercased +or also camelcased. The default is "LOWERCASE". Since 1.8.0. + +``HEADER_EXTENSION`` specifies what file name extension is used for the header +files. The default is "h". Since 5.48.0. + +``PREFIX`` places the generated headers in subdirectories. This should be a +CamelCase name like ``KParts``, which will cause the CamelCase forwarding +headers to be placed in the ``KParts`` directory (e.g. ``KParts/Part``). It +will also, for the convenience of code in the source distribution, generate +forwarding headers based on the original names (e.g. ``kparts/part.h``). This +allows includes like ``"#include <kparts/part.h>"`` to be used before +installation, as long as the include_directories are set appropriately. + +``OUTPUT_DIR`` specifies where the files will be generated; this should be within +the build directory. By default, ``${CMAKE_CURRENT_BINARY_DIR}`` will be used. +This option can be used to avoid file conflicts. + +``REQUIRED_HEADERS`` specifies an output variable name where all the required +headers will be appended so that they can be installed together with the +generated ones. This is mostly intended as a convenience so that adding a new +header to a project only requires specifying the CamelCase variant in the +CMakeLists.txt file; the original variant will then be added to this +variable. + +``COMMON_HEADER`` generates an additional convenience header which includes all +other header files. + +The ``RELATIVE`` argument indicates where the original headers can be found +relative to ``CMAKE_CURRENT_SOURCE_DIR``. It does not affect the generated +CamelCase forwarding files, but ``ecm_generate_headers()`` uses it when checking +that the original header exists, and to generate originally named forwarding +headers when ``PREFIX`` is set. + +To allow other parts of the source distribution (eg: tests) to use the +generated headers before installation, it may be desirable to set the +``INCLUDE_DIRECTORIES`` property for the library target to output_dir. For +example, if ``OUTPUT_DIR`` is ``CMAKE_CURRENT_BINARY_DIR`` (the default), you could do + +.. code-block:: cmake + + target_include_directories(MyLib PUBLIC "$<BUILD_INTERFACE:${CMAKE_CURRENT_BINARY_DIR}>") + +Example usage (without ``PREFIX``): + +.. code-block:: cmake + + ecm_generate_headers( + MyLib_FORWARDING_HEADERS + HEADERS + MLFoo + MLBar + # etc + REQUIRED_HEADERS MyLib_HEADERS + COMMON_HEADER MLGeneral + ) + install(FILES ${MyLib_FORWARDING_HEADERS} ${MyLib_HEADERS} + DESTINATION ${CMAKE_INSTALL_PREFIX}/include + COMPONENT Devel) + +Example usage (with ``PREFIX``): + +.. code-block:: cmake + + ecm_generate_headers( + MyLib_FORWARDING_HEADERS + HEADERS + Foo + # several classes are contained in bar.h, so generate + # additional files + Bar,BarList + # etc + PREFIX MyLib + REQUIRED_HEADERS MyLib_HEADERS + ) + install(FILES ${MyLib_FORWARDING_HEADERS} + DESTINATION ${CMAKE_INSTALL_PREFIX}/include/MyLib + COMPONENT Devel) + install(FILES ${MyLib_HEADERS} + DESTINATION ${CMAKE_INSTALL_PREFIX}/include/mylib + COMPONENT Devel) + +Since pre-1.0.0. +#]=======================================================================] + +include(CMakeParseArguments) + +function(ECM_GENERATE_HEADERS camelcase_forwarding_headers_var) + set(options) + set(oneValueArgs ORIGINAL HEADER_EXTENSION OUTPUT_DIR PREFIX REQUIRED_HEADERS COMMON_HEADER RELATIVE) + set(multiValueArgs HEADER_NAMES) + cmake_parse_arguments(EGH "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN}) + + if (EGH_UNPARSED_ARGUMENTS) + message(FATAL_ERROR "Unexpected arguments to ECM_GENERATE_HEADERS: ${EGH_UNPARSED_ARGUMENTS}") + endif() + + if(NOT EGH_HEADER_NAMES) + message(FATAL_ERROR "Missing header_names argument to ECM_GENERATE_HEADERS") + endif() + + if(NOT EGH_ORIGINAL) + # default + set(EGH_ORIGINAL "LOWERCASE") + endif() + if(NOT EGH_ORIGINAL STREQUAL "LOWERCASE" AND NOT EGH_ORIGINAL STREQUAL "CAMELCASE") + message(FATAL_ERROR "Unexpected value for original argument to ECM_GENERATE_HEADERS: ${EGH_ORIGINAL}") + endif() + + if(NOT EGH_HEADER_EXTENSION) + set(EGH_HEADER_EXTENSION "h") + endif() + + if(NOT EGH_OUTPUT_DIR) + set(EGH_OUTPUT_DIR "${CMAKE_CURRENT_BINARY_DIR}") + endif() + + # Make sure EGH_RELATIVE is /-terminated when it's not empty + if (EGH_RELATIVE AND NOT "${EGH_RELATIVE}" MATCHES "^.*/$") + set(EGH_RELATIVE "${EGH_RELATIVE}/") + endif() + + set(originalprefix) + if (EGH_PREFIX) + if (NOT "${EGH_PREFIX}" MATCHES "^.*/$") + set(EGH_PREFIX "${EGH_PREFIX}/") + endif() + if (EGH_ORIGINAL STREQUAL "CAMELCASE") + set(originalprefix "${EGH_PREFIX}") + else() + string(TOLOWER "${EGH_PREFIX}" originalprefix) + endif() + endif() + + foreach(_classnameentry ${EGH_HEADER_NAMES}) + string(REPLACE "," ";" _classnames ${_classnameentry}) + list(GET _classnames 0 _baseclass) + + if (EGH_ORIGINAL STREQUAL "CAMELCASE") + set(originalbasename "${_baseclass}") + else() + string(TOLOWER "${_baseclass}" originalbasename) + endif() + + set(_actualheader "${CMAKE_CURRENT_SOURCE_DIR}/${EGH_RELATIVE}${originalbasename}.${EGH_HEADER_EXTENSION}") + if (NOT EXISTS ${_actualheader}) + message(FATAL_ERROR "Could not find \"${_actualheader}\"") + endif() + + foreach(_CLASSNAME ${_classnames}) + set(FANCY_HEADER_FILE "${EGH_OUTPUT_DIR}/${EGH_PREFIX}${_CLASSNAME}") + if (NOT EXISTS ${FANCY_HEADER_FILE}) + file(WRITE ${FANCY_HEADER_FILE} "#include \"${originalprefix}${originalbasename}.${EGH_HEADER_EXTENSION}\"\n") + endif() + list(APPEND ${camelcase_forwarding_headers_var} "${FANCY_HEADER_FILE}") + if (EGH_PREFIX) + # Local forwarding header, for namespaced headers, e.g. kparts/part.h + if(EGH_ORIGINAL STREQUAL "CAMELCASE") + set(originalclassname "${_CLASSNAME}") + else() + string(TOLOWER "${_CLASSNAME}" originalclassname) + endif() + set(REGULAR_HEADER_NAME ${EGH_OUTPUT_DIR}/${originalprefix}${originalclassname}.${EGH_HEADER_EXTENSION}) + if (NOT EXISTS ${REGULAR_HEADER_NAME}) + file(WRITE ${REGULAR_HEADER_NAME} "#include \"${_actualheader}\"\n") + endif() + endif() + endforeach() + + list(APPEND _REQUIRED_HEADERS "${_actualheader}") + endforeach() + + if(EGH_COMMON_HEADER) + #combine required headers into 1 big convenience header + set(COMMON_HEADER ${EGH_OUTPUT_DIR}/${EGH_PREFIX}${EGH_COMMON_HEADER}) + file(WRITE ${COMMON_HEADER} "// convenience header\n") + foreach(_header ${_REQUIRED_HEADERS}) + get_filename_component(_base ${_header} NAME) + file(APPEND ${COMMON_HEADER} "#include \"${_base}\"\n") + endforeach() + list(APPEND ${camelcase_forwarding_headers_var} "${COMMON_HEADER}") + endif() + + set(${camelcase_forwarding_headers_var} ${${camelcase_forwarding_headers_var}} PARENT_SCOPE) + if (EGH_REQUIRED_HEADERS) + set(${EGH_REQUIRED_HEADERS} ${${EGH_REQUIRED_HEADERS}} ${_REQUIRED_HEADERS} PARENT_SCOPE) + endif () +endfunction() diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/cmake/ECM/modules/ECMGeneratePriFile.cmake b/3rdparty/kdsingleapplication/KDSingleApplication/cmake/ECM/modules/ECMGeneratePriFile.cmake new file mode 100644 index 0000000..8910cd9 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/cmake/ECM/modules/ECMGeneratePriFile.cmake @@ -0,0 +1,256 @@ +# SPDX-FileCopyrightText: 2014 David Faure <faure@kde.org> +# +# SPDX-License-Identifier: BSD-3-Clause + +#[=======================================================================[.rst: +ECMGeneratePriFile +------------------ + +Generate a ``.pri`` file for the benefit of qmake-based projects. + +As well as the function below, this module creates the cache variable +``ECM_MKSPECS_INSTALL_DIR`` and sets the default value to ``mkspecs/modules``. +This assumes Qt and the current project are both installed to the same +non-system prefix. Packagers who use ``-DCMAKE_INSTALL_PREFIX=/usr`` will +certainly want to set ``ECM_MKSPECS_INSTALL_DIR`` to something like +``share/qt5/mkspecs/modules``. + +The main thing is that this should be the ``modules`` subdirectory of either +the default qmake ``mkspecs`` directory or of a directory that will be in the +``$QMAKEPATH`` environment variable when qmake is run. + +:: + + ecm_generate_pri_file(BASE_NAME <baseName> + LIB_NAME <libName> + [VERSION <version>] # since 5.83 + [DEPS "<dep> [<dep> [...]]"] + [FILENAME_VAR <filename_variable>] + [INCLUDE_INSTALL_DIRS <dir> [<dir> [...]]] # since 5.92 + [INCLUDE_INSTALL_DIR <dir>] # deprecated since 5.92 + [LIB_INSTALL_DIR <dir>]) + +If your CMake project produces a Qt-based library, you may expect there to be +applications that wish to use it that use a qmake-based build system, rather +than a CMake-based one. Creating a ``.pri`` file will make use of your +library convenient for them, in much the same way that CMake config files make +things convenient for CMake-based applications. ``ecm_generate_pri_file()`` +generates just such a file. + +``VERSION`` specifies the version of the library the ``.pri`` file describes. If +not set, the value is taken from the context variable ``PROJECT_VERSION``. +This variable is usually set by the ``project(... VERSION ...)`` command or, +if CMake policy CMP0048 is not ``NEW``, by :module:`ECMSetupVersion`. +For backward-compatibility with older ECM versions the +``PROJECT_VERSION_STRING`` variable as set by :module:`ECMSetupVersion` +will be preferred over ``PROJECT_VERSION`` if set, unless the minimum +required version of ECM is 5.83 and newer. Since 5.83. + +``BASE_NAME`` specifies the name qmake project (.pro) files should use to refer to +the library (eg: KArchive). ``LIB_NAME`` is the name of the actual library to +link to (ie: the first argument to add_library()). ``DEPS`` is a space-separated +list of the base names of other libraries (for Qt libraries, use the same +names you use with the ``QT`` variable in a qmake project file, such as "core" +for QtCore). ``FILENAME_VAR`` specifies the name of a variable to store the path +to the generated file in. + +``INCLUDE_INSTALL_DIRS`` are the paths (relative to ``CMAKE_INSTALL_PREFIX``) that +include files will be installed to. It defaults to +``${INCLUDE_INSTALL_DIR}/<baseName>`` if the ``INCLUDE_INSTALL_DIR`` variable +is set. If that variable is not set, the ``CMAKE_INSTALL_INCLUDEDIR`` variable +is used instead, and if neither are set ``include`` is used. ``LIB_INSTALL_DIR`` +operates similarly for the installation location for libraries; it defaults to +``${LIB_INSTALL_DIR}``, ``${CMAKE_INSTALL_LIBDIR}`` or ``lib``, in that order. + +``INCLUDE_INSTALL_DIR`` is the old variant of ``INCLUDE_INSTALL_DIRS``, taking only one +directory. + +Example usage: + +.. code-block:: cmake + + ecm_generate_pri_file( + BASE_NAME KArchive + LIB_NAME KF5KArchive + DEPS "core" + FILENAME_VAR pri_filename + VERSION 4.2.0 + ) + install(FILES ${pri_filename} DESTINATION ${ECM_MKSPECS_INSTALL_DIR}) + +A qmake-based project that wished to use this would then do:: + + QT += KArchive + +in their ``.pro`` file. + +Since pre-1.0.0. +#]=======================================================================] + +# Replicate the logic from KDEInstallDirs.cmake as we can't depend on it +# Ask qmake if we're using the same prefix as Qt +set(_should_query_qt OFF) +if(NOT DEFINED KDE_INSTALL_USE_QT_SYS_PATHS) + include(ECMQueryQt) + ecm_query_qt(qt_install_prefix_dir QT_INSTALL_PREFIX TRY) + if(qt_install_prefix_dir STREQUAL "${CMAKE_INSTALL_PREFIX}") + set(_should_query_qt ON) + endif() +endif() + +if(KDE_INSTALL_USE_QT_SYS_PATHS OR _should_query_qt) + include(ECMQueryQt) + ecm_query_qt(qt_install_prefix_dir QT_INSTALL_PREFIX) + ecm_query_qt(qt_host_data_dir QT_HOST_DATA) + if(qt_install_prefix_dir STREQUAL "${CMAKE_INSTALL_PREFIX}") + file(RELATIVE_PATH qt_host_data_dir ${qt_install_prefix_dir} ${qt_host_data_dir}) + endif() + if(qt_host_data_dir STREQUAL "") + set(mkspecs_install_dir mkspecs/modules) + else() + set(mkspecs_install_dir ${qt_host_data_dir}/mkspecs/modules) + endif() + set(ECM_MKSPECS_INSTALL_DIR ${mkspecs_install_dir} CACHE PATH "The directory where mkspecs will be installed to.") +else() + set(ECM_MKSPECS_INSTALL_DIR mkspecs/modules CACHE PATH "The directory where mkspecs will be installed to.") +endif() + +function(ECM_GENERATE_PRI_FILE) + set(options ) + set(oneValueArgs BASE_NAME LIB_NAME DEPS FILENAME_VAR INCLUDE_INSTALL_DIR LIB_INSTALL_DIR VERSION) + set(multiValueArgs INCLUDE_INSTALL_DIRS) + + cmake_parse_arguments(EGPF "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN}) + + if(EGPF_UNPARSED_ARGUMENTS) + message(FATAL_ERROR "Unknown keywords given to ECM_GENERATE_PRI_FILE(): \"${EGPF_UNPARSED_ARGUMENTS}\"") + endif() + + if(ECM_GLOBAL_FIND_VERSION VERSION_LESS 5.83.0) + set(_support_backward_compat_version_string_var TRUE) + else() + set(_support_backward_compat_version_string_var FALSE) + endif() + + if(NOT EGPF_BASE_NAME) + message(FATAL_ERROR "Required argument BASE_NAME missing in ECM_GENERATE_PRI_FILE() call") + endif() + if(NOT EGPF_LIB_NAME) + message(FATAL_ERROR "Required argument LIB_NAME missing in ECM_GENERATE_PRI_FILE() call") + endif() + if(NOT EGPF_VERSION) + if(_support_backward_compat_version_string_var) + if(NOT PROJECT_VERSION_STRING AND NOT PROJECT_VERSION) + message(FATAL_ERROR "Required variable PROJECT_VERSION_STRING or PROJECT_VERSION not set before ECM_GENERATE_PRI_FILE() call. Missing call of ecm_setup_version() or project(VERSION)?") + endif() + else() + if(NOT PROJECT_VERSION) + message(FATAL_ERROR "Required variable PROJECT_VERSION not set before ECM_GENERATE_PRI_FILE() call. Missing call of ecm_setup_version() or project(VERSION)?") + endif() + endif() + endif() + if(EGPF_INCLUDE_INSTALL_DIR) + if(EGPF_INCLUDE_INSTALL_DIRS) + message(FATAL_ERROR "Only one argument of INCLUDE_INSTALL_DIR & INCLUDE_INSTALL_DIRS can be used in ECM_GENERATE_PRI_FILE() call") + endif() + set(EGPF_INCLUDE_INSTALL_DIRS ${EGPF_INCLUDE_INSTALL_DIR}) + endif() + if(NOT EGPF_INCLUDE_INSTALL_DIRS) + if(INCLUDE_INSTALL_DIR) + set(EGPF_INCLUDE_INSTALL_DIRS "${INCLUDE_INSTALL_DIR}/${EGPF_BASE_NAME}") + elseif(CMAKE_INSTALL_INCLUDEDIR) + set(EGPF_INCLUDE_INSTALL_DIRS "${CMAKE_INSTALL_INCLUDEDIR}/${EGPF_BASE_NAME}") + else() + set(EGPF_INCLUDE_INSTALL_DIRS "include/${EGPF_BASE_NAME}") + endif() + endif() + if(NOT EGPF_LIB_INSTALL_DIR) + if(LIB_INSTALL_DIR) + set(EGPF_LIB_INSTALL_DIR "${LIB_INSTALL_DIR}") + elseif(CMAKE_INSTALL_LIBDIR) + set(EGPF_LIB_INSTALL_DIR "${CMAKE_INSTALL_LIBDIR}") + else() + set(EGPF_LIB_INSTALL_DIR "lib") + endif() + endif() + + if(EGPF_VERSION) + set(PRI_VERSION "${EGPF_VERSION}") + else() + if(_support_backward_compat_version_string_var AND PROJECT_VERSION_STRING) + set(PRI_VERSION "${PROJECT_VERSION_STRING}") + if(NOT PROJECT_VERSION_STRING STREQUAL PROJECT_VERSION) + message(DEPRECATION "ECM_GENERATE_PRI_FILE() will no longer support PROJECT_VERSION_STRING when the required minimum version of ECM is 5.83 or newer. Set VERSION parameter or use PROJECT_VERSION instead.") + endif() + else() + set(PRI_VERSION "${PROJECT_VERSION}") + endif() + endif() + + string(REGEX REPLACE "^([0-9]+)\\.[0-9]+\\.[0-9]+.*" "\\1" PRI_VERSION_MAJOR "${PRI_VERSION}") + string(REGEX REPLACE "^[0-9]+\\.([0-9]+)\\.[0-9]+.*" "\\1" PRI_VERSION_MINOR "${PRI_VERSION}") + string(REGEX REPLACE "^[0-9]+\\.[0-9]+\\.([0-9]+).*" "\\1" PRI_VERSION_PATCH "${PRI_VERSION}") + + # Prepare the right number of "../.." to go from ECM_MKSPECS_INSTALL_DIR to the install prefix + # This allows to make the generated pri files relocatable (no absolute paths) + if (IS_ABSOLUTE ${ECM_MKSPECS_INSTALL_DIR}) + set(BASEPATH ${CMAKE_INSTALL_PREFIX}) + else() + string(REGEX REPLACE "[^/]+" ".." PRI_ROOT_RELATIVE_TO_MKSPECS ${ECM_MKSPECS_INSTALL_DIR}) + set(BASEPATH "$$PWD/${PRI_ROOT_RELATIVE_TO_MKSPECS}") + endif() + + set(PRI_TARGET_BASENAME ${EGPF_BASE_NAME}) + set(PRI_TARGET_LIBNAME ${EGPF_LIB_NAME}) + set(PRI_TARGET_QTDEPS ${EGPF_DEPS}) + set(PRI_TARGET_INCLUDES) + foreach(_dir ${EGPF_INCLUDE_INSTALL_DIRS}) + # separate list entries with space + if(IS_ABSOLUTE "${_dir}") + string(APPEND PRI_TARGET_INCLUDES " ${_dir}") + else() + string(APPEND PRI_TARGET_INCLUDES " ${BASEPATH}/${_dir}") + endif() + endforeach() + if(IS_ABSOLUTE "${EGPF_LIB_INSTALL_DIR}") + set(PRI_TARGET_LIBS "${EGPF_LIB_INSTALL_DIR}") + else() + set(PRI_TARGET_LIBS "${BASEPATH}/${EGPF_LIB_INSTALL_DIR}") + endif() + set(PRI_TARGET_DEFINES "") + + set(PRI_FILENAME ${CMAKE_CURRENT_BINARY_DIR}/qt_${PRI_TARGET_BASENAME}.pri) + if (EGPF_FILENAME_VAR) + set(${EGPF_FILENAME_VAR} ${PRI_FILENAME} PARENT_SCOPE) + endif() + + set(PRI_TARGET_MODULE_CONFIG "") + # backward compat: it was not obvious LIB_NAME needs to be a target name, + # and some projects where the target name was not the actual library output name + # passed the output name for LIB_NAME, so .name & .module prperties are correctly set. + # TODO: improve API dox, allow control over module name if target name != output name + if(TARGET ${EGPF_LIB_NAME}) + get_target_property(target_type ${EGPF_LIB_NAME} TYPE) + if (target_type STREQUAL "STATIC_LIBRARY") + set(PRI_TARGET_MODULE_CONFIG "staticlib") + endif() + endif() + + file(GENERATE + OUTPUT ${PRI_FILENAME} + CONTENT + "QT.${PRI_TARGET_BASENAME}.VERSION = ${PRI_VERSION} +QT.${PRI_TARGET_BASENAME}.MAJOR_VERSION = ${PRI_VERSION_MAJOR} +QT.${PRI_TARGET_BASENAME}.MINOR_VERSION = ${PRI_VERSION_MINOR} +QT.${PRI_TARGET_BASENAME}.PATCH_VERSION = ${PRI_VERSION_PATCH} +QT.${PRI_TARGET_BASENAME}.name = ${PRI_TARGET_LIBNAME} +QT.${PRI_TARGET_BASENAME}.module = ${PRI_TARGET_LIBNAME} +QT.${PRI_TARGET_BASENAME}.defines = ${PRI_TARGET_DEFINES} +QT.${PRI_TARGET_BASENAME}.includes = ${PRI_TARGET_INCLUDES} +QT.${PRI_TARGET_BASENAME}.private_includes = +QT.${PRI_TARGET_BASENAME}.libs = ${PRI_TARGET_LIBS} +QT.${PRI_TARGET_BASENAME}.depends = ${PRI_TARGET_QTDEPS} +QT.${PRI_TARGET_BASENAME}.module_config = ${PRI_TARGET_MODULE_CONFIG} +" + ) +endfunction() diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/cmake/ECM/modules/ECMQueryQt.cmake b/3rdparty/kdsingleapplication/KDSingleApplication/cmake/ECM/modules/ECMQueryQt.cmake new file mode 100644 index 0000000..3f3b86b --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/cmake/ECM/modules/ECMQueryQt.cmake @@ -0,0 +1,100 @@ +# SPDX-FileCopyrightText: 2014 Rohan Garg <rohan16garg@gmail.com> +# SPDX-FileCopyrightText: 2014 Alex Merry <alex.merry@kde.org> +# SPDX-FileCopyrightText: 2014-2016 Aleix Pol <aleixpol@kde.org> +# SPDX-FileCopyrightText: 2017 Friedrich W. H. Kossebau <kossebau@kde.org> +# SPDX-FileCopyrightText: 2022 Ahmad Samir <a.samir78@gmail.com> +# +# SPDX-License-Identifier: BSD-3-Clause +#[=======================================================================[.rst: +ECMQueryQt +--------------- +This module can be used to query the installation paths used by Qt. + +For Qt5 this uses ``qmake``, and for Qt6 this used ``qtpaths`` (the latter has built-in +support to query the paths of a target platform when cross-compiling). + +This module defines the following function: +:: + + ecm_query_qt(<result_variable> <qt_variable> [TRY]) + +Passing ``TRY`` will result in the method not making the build fail if the executable +used for querying has not been found, but instead simply print a warning message and +return an empty string. + +Example usage: + +.. code-block:: cmake + + include(ECMQueryQt) + ecm_query_qt(bin_dir QT_INSTALL_BINS) + +If the call succeeds ``${bin_dir}`` will be set to ``<prefix>/path/to/bin/dir`` (e.g. +``/usr/lib64/qt/bin/``). + +Since: 5.93 +#]=======================================================================] + +include(${CMAKE_CURRENT_LIST_DIR}/QtVersionOption.cmake) +include(CheckLanguage) +check_language(CXX) +if (CMAKE_CXX_COMPILER) + # Enable the CXX language to let CMake look for config files in library dirs. + # See: https://gitlab.kitware.com/cmake/cmake/-/issues/23266 + enable_language(CXX) +endif() + +if (QT_MAJOR_VERSION STREQUAL "5") + # QUIET to accommodate the TRY option + find_package(Qt${QT_MAJOR_VERSION}Core QUIET) + if(TARGET Qt5::qmake) + get_target_property(_qmake_executable_default Qt5::qmake LOCATION) + + set(QUERY_EXECUTABLE ${_qmake_executable_default} + CACHE FILEPATH "Location of the Qt5 qmake executable") + set(_exec_name_text "Qt5 qmake") + set(_cli_option "-query") + endif() +elseif(QT_MAJOR_VERSION STREQUAL "6") + # QUIET to accommodate the TRY option + find_package(Qt6 COMPONENTS CoreTools QUIET CONFIG) + if (TARGET Qt6::qtpaths) + get_target_property(_qtpaths_executable Qt6::qtpaths LOCATION) + + set(QUERY_EXECUTABLE ${_qtpaths_executable} + CACHE FILEPATH "Location of the Qt6 qtpaths executable") + set(_exec_name_text "Qt6 qtpaths") + set(_cli_option "--query") + endif() +endif() + +function(ecm_query_qt result_variable qt_variable) + set(options TRY) + set(oneValueArgs) + set(multiValueArgs) + + cmake_parse_arguments(ARGS "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN}) + + if(NOT QUERY_EXECUTABLE) + if(ARGS_TRY) + set(${result_variable} "" PARENT_SCOPE) + message(STATUS "No ${_exec_name_text} executable found. Can't check ${qt_variable}") + return() + else() + message(FATAL_ERROR "No ${_exec_name_text} executable found. Can't check ${qt_variable} as required") + endif() + endif() + execute_process( + COMMAND ${QUERY_EXECUTABLE} ${_cli_option} "${qt_variable}" + RESULT_VARIABLE return_code + OUTPUT_VARIABLE output + ) + if(return_code EQUAL 0) + string(STRIP "${output}" output) + file(TO_CMAKE_PATH "${output}" output_path) + set(${result_variable} "${output_path}" PARENT_SCOPE) + else() + message(WARNING "Failed call: ${QUERY_EXECUTABLE} ${_cli_option} ${qt_variable}") + message(FATAL_ERROR "${_exec_name_text} call failed: ${return_code}") + endif() +endfunction() diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/cmake/ECM/modules/ECMSetupVersion.cmake b/3rdparty/kdsingleapplication/KDSingleApplication/cmake/ECM/modules/ECMSetupVersion.cmake new file mode 100644 index 0000000..330f736 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/cmake/ECM/modules/ECMSetupVersion.cmake @@ -0,0 +1,213 @@ +# SPDX-FileCopyrightText: 2014 Alex Merry <alex.merry@kde.org> +# SPDX-FileCopyrightText: 2012 Alexander Neundorf <neundorf@kde.org> +# +# SPDX-License-Identifier: BSD-3-Clause + +#[=======================================================================[.rst: +ECMSetupVersion +--------------- + +Handle library version information. + +:: + + ecm_setup_version(<version> + VARIABLE_PREFIX <prefix> + [SOVERSION <soversion>] + [VERSION_HEADER <filename>] + [PACKAGE_VERSION_FILE <filename> [COMPATIBILITY <compat>]] ) + +This parses a version string and sets up a standard set of version variables. +It can optionally also create a C version header file and a CMake package +version file to install along with the library. + +If the ``<version>`` argument is of the form ``<major>.<minor>.<patch>`` +(or ``<major>.<minor>.<patch>.<tweak>``), The following CMake variables are +set:: + + <prefix>_VERSION_MAJOR - <major> + <prefix>_VERSION_MINOR - <minor> + <prefix>_VERSION_PATCH - <patch> + <prefix>_VERSION - <version> + <prefix>_SOVERSION - <soversion>, or <major> if SOVERSION was not given + +For backward-compatibility also this variable is set (only if the minimum required +version of ECM is < 5.83):: + + <prefix>_VERSION_STRING - <version> (use <prefix>_VERSION instead) + +If CMake policy CMP0048 is not ``NEW``, the following CMake variables will also +be set:: + + PROJECT_VERSION_MAJOR - <major> + PROJECT_VERSION_MINOR - <minor> + PROJECT_VERSION_PATCH - <patch> + PROJECT_VERSION - <version> + +For backward-compatibility, if CMake policy CMP0048 is not ``NEW``, also this variable is set +(only if the minimum required version of ECM is < 5.83):: + + PROJECT_VERSION_STRING - <version> (use PROJECT_VERSION instead) + +If the ``VERSION_HEADER`` option is used, a simple C header is generated with the +given filename. If filename is a relative path, it is interpreted as relative +to ``CMAKE_CURRENT_BINARY_DIR``. The generated header contains the following +macros:: + + <prefix>_VERSION_MAJOR - <major> as an integer + <prefix>_VERSION_MINOR - <minor> as an integer + <prefix>_VERSION_PATCH - <patch> as an integer + <prefix>_VERSION_STRING - <version> as a C string + <prefix>_VERSION - the version as an integer + +``<prefix>_VERSION`` has ``<patch>`` in the bottom 8 bits, ``<minor>`` in the +next 8 bits and ``<major>`` in the remaining bits. Note that ``<patch>`` and +``<minor>`` must be less than 256. + +If the ``PACKAGE_VERSION_FILE`` option is used, a simple CMake package version +file is created using the ``write_basic_package_version_file()`` macro provided by +CMake. It should be installed in the same location as the Config.cmake file of +the library so that it can be found by ``find_package()``. If the filename is a +relative path, it is interpreted as relative to ``CMAKE_CURRENT_BINARY_DIR``. The +optional ``COMPATIBILITY`` option is forwarded to +``write_basic_package_version_file()``, and defaults to ``AnyNewerVersion``. + +If CMake policy CMP0048 is ``NEW``, an alternative form of the command is +available:: + + ecm_setup_version(PROJECT + [VARIABLE_PREFIX <prefix>] + [SOVERSION <soversion>] + [VERSION_HEADER <filename>] + [PACKAGE_VERSION_FILE <filename>] ) + +This will use the version information set by the ``project()`` command. +``VARIABLE_PREFIX`` defaults to the project name. Note that ``PROJECT`` must be the +first argument. In all other respects, it behaves like the other form of the +command. + +Since pre-1.0.0. + +``COMPATIBILITY`` option available since 1.6.0. +#]=======================================================================] + +include(CMakePackageConfigHelpers) + +# save the location of the header template while CMAKE_CURRENT_LIST_DIR +# has the value we want +set(_ECM_SETUP_VERSION_HEADER_TEMPLATE "${CMAKE_CURRENT_LIST_DIR}/ECMVersionHeader.h.in") + +function(ecm_setup_version _version) + set(options ) + set(oneValueArgs VARIABLE_PREFIX SOVERSION VERSION_HEADER PACKAGE_VERSION_FILE COMPATIBILITY) + set(multiValueArgs ) + + cmake_parse_arguments(ESV "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN}) + + if(ESV_UNPARSED_ARGUMENTS) + message(FATAL_ERROR "Unknown keywords given to ECM_SETUP_VERSION(): \"${ESV_UNPARSED_ARGUMENTS}\"") + endif() + + set(project_manages_version FALSE) + set(use_project_version FALSE) + cmake_policy(GET CMP0048 project_version_policy) + if(project_version_policy STREQUAL "NEW") + set(project_manages_version TRUE) + if(_version STREQUAL "PROJECT") + set(use_project_version TRUE) + endif() + elseif(_version STREQUAL "PROJECT") + message(FATAL_ERROR "ecm_setup_version given PROJECT argument, but CMP0048 is not NEW") + endif() + + set(should_set_prefixed_vars TRUE) + if(NOT ESV_VARIABLE_PREFIX) + if(use_project_version) + set(ESV_VARIABLE_PREFIX "${PROJECT_NAME}") + set(should_set_prefixed_vars FALSE) + else() + message(FATAL_ERROR "Required argument PREFIX missing in ECM_SETUP_VERSION() call") + endif() + endif() + + if(use_project_version) + set(_version "${PROJECT_VERSION}") + # drop leading 0 from values to avoid bogus octal values in c/C++ e.g. with 08 or 09 + string(REGEX REPLACE "0*([0-9]+)" "\\1" _major "${PROJECT_VERSION_MAJOR}") + string(REGEX REPLACE "0*([0-9]+)" "\\1" _minor "${PROJECT_VERSION_MINOR}") + string(REGEX REPLACE "0*([0-9]+)" "\\1" _patch "${PROJECT_VERSION_PATCH}") + else() + string(REGEX REPLACE "^0*([0-9]+)\\.[0-9]+\\.[0-9]+.*" "\\1" _major "${_version}") + string(REGEX REPLACE "^[0-9]+\\.0*([0-9]+)\\.[0-9]+.*" "\\1" _minor "${_version}") + string(REGEX REPLACE "^[0-9]+\\.[0-9]+\\.0*([0-9]+).*" "\\1" _patch "${_version}") + endif() + + if(NOT ESV_SOVERSION) + set(ESV_SOVERSION ${_major}) + endif() + + if(ECM_GLOBAL_FIND_VERSION VERSION_LESS 5.83.0) + set(_set_backward_compat_version_string_vars TRUE) + else() + set(_set_backward_compat_version_string_vars FALSE) + endif() + + if(should_set_prefixed_vars) + set(${ESV_VARIABLE_PREFIX}_VERSION "${_version}") + set(${ESV_VARIABLE_PREFIX}_VERSION_MAJOR ${_major}) + set(${ESV_VARIABLE_PREFIX}_VERSION_MINOR ${_minor}) + set(${ESV_VARIABLE_PREFIX}_VERSION_PATCH ${_patch}) + endif() + + set(${ESV_VARIABLE_PREFIX}_SOVERSION ${ESV_SOVERSION}) + + if(NOT project_manages_version) + set(PROJECT_VERSION "${_version}") + set(PROJECT_VERSION_MAJOR "${_major}") + set(PROJECT_VERSION_MINOR "${_minor}") + set(PROJECT_VERSION_PATCH "${_patch}") + endif() + + if(_set_backward_compat_version_string_vars) + set(PROJECT_VERSION_STRING "${PROJECT_VERSION}") + set(${ESV_VARIABLE_PREFIX}_VERSION_STRING "${${ESV_VARIABLE_PREFIX}_VERSION}") + endif() + + if(ESV_VERSION_HEADER) + set(HEADER_PREFIX "${ESV_VARIABLE_PREFIX}") + set(HEADER_VERSION "${_version}") + set(HEADER_VERSION_MAJOR "${_major}") + set(HEADER_VERSION_MINOR "${_minor}") + set(HEADER_VERSION_PATCH "${_patch}") + configure_file("${_ECM_SETUP_VERSION_HEADER_TEMPLATE}" "${ESV_VERSION_HEADER}") + endif() + + if(ESV_PACKAGE_VERSION_FILE) + if(NOT ESV_COMPATIBILITY) + set(ESV_COMPATIBILITY AnyNewerVersion) + endif() + write_basic_package_version_file("${ESV_PACKAGE_VERSION_FILE}" VERSION ${_version} COMPATIBILITY ${ESV_COMPATIBILITY}) + endif() + + if(should_set_prefixed_vars) + set(${ESV_VARIABLE_PREFIX}_VERSION_MAJOR "${${ESV_VARIABLE_PREFIX}_VERSION_MAJOR}" PARENT_SCOPE) + set(${ESV_VARIABLE_PREFIX}_VERSION_MINOR "${${ESV_VARIABLE_PREFIX}_VERSION_MINOR}" PARENT_SCOPE) + set(${ESV_VARIABLE_PREFIX}_VERSION_PATCH "${${ESV_VARIABLE_PREFIX}_VERSION_PATCH}" PARENT_SCOPE) + set(${ESV_VARIABLE_PREFIX}_VERSION "${${ESV_VARIABLE_PREFIX}_VERSION}" PARENT_SCOPE) + endif() + + # always set the soversion + set(${ESV_VARIABLE_PREFIX}_SOVERSION "${${ESV_VARIABLE_PREFIX}_SOVERSION}" PARENT_SCOPE) + + if(NOT project_manages_version) + set(PROJECT_VERSION "${PROJECT_VERSION}" PARENT_SCOPE) + set(PROJECT_VERSION_MAJOR "${PROJECT_VERSION_MAJOR}" PARENT_SCOPE) + set(PROJECT_VERSION_MINOR "${PROJECT_VERSION_MINOR}" PARENT_SCOPE) + set(PROJECT_VERSION_PATCH "${PROJECT_VERSION_PATCH}" PARENT_SCOPE) + endif() + + if(_set_backward_compat_version_string_vars) + set(PROJECT_VERSION_STRING "${PROJECT_VERSION_STRING}" PARENT_SCOPE) + set(${ESV_VARIABLE_PREFIX}_VERSION_STRING "${${ESV_VARIABLE_PREFIX}_VERSION}" PARENT_SCOPE) + endif() +endfunction() diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/cmake/ECM/modules/ECMUninstallTarget.cmake b/3rdparty/kdsingleapplication/KDSingleApplication/cmake/ECM/modules/ECMUninstallTarget.cmake new file mode 100644 index 0000000..7298012 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/cmake/ECM/modules/ECMUninstallTarget.cmake @@ -0,0 +1,50 @@ +# SPDX-FileCopyrightText: 2015 Alex Merry <alex.merry@kde.org> +# +# SPDX-License-Identifier: BSD-3-Clause + +#[=======================================================================[.rst: +ECMUninstallTarget +------------------ + +Add an ``uninstall`` target. + +By including this module, an ``uninstall`` target will be added to your CMake +project. This will remove all files installed (or updated) by a previous +invocation of the ``install`` target. It will not remove files created or +modified by an ``install(SCRIPT)`` or ``install(CODE)`` command; you should +create a custom uninstallation target for these and use ``add_dependency`` to +make the ``uninstall`` target depend on it: + +.. code-block:: cmake + + include(ECMUninstallTarget) + install(SCRIPT install-foo.cmake) + add_custom_target(uninstall_foo COMMAND ${CMAKE_COMMAND} -P uninstall-foo.cmake) + add_dependency(uninstall uninstall_foo) + +The target will fail if the ``install`` target has not yet been run (so it is +not possible to run CMake on the project and then immediately run the +``uninstall`` target). + +.. warning:: + + CMake deliberately does not provide an ``uninstall`` target by default on + the basis that such a target has the potential to remove important files + from a user's computer. Use with caution. + +Since 1.7.0. +#]=======================================================================] + +if (NOT TARGET uninstall) + configure_file( + "${CMAKE_CURRENT_LIST_DIR}/ecm_uninstall.cmake.in" + "${CMAKE_BINARY_DIR}/ecm_uninstall.cmake" + IMMEDIATE + @ONLY + ) + + add_custom_target(uninstall + COMMAND "${CMAKE_COMMAND}" -P "${CMAKE_BINARY_DIR}/ecm_uninstall.cmake" + WORKING_DIRECTORY "${CMAKE_BINARY_DIR}" + ) +endif() diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/cmake/ECM/modules/ECMVersionHeader.h.in b/3rdparty/kdsingleapplication/KDSingleApplication/cmake/ECM/modules/ECMVersionHeader.h.in new file mode 100644 index 0000000..c0ed6c0 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/cmake/ECM/modules/ECMVersionHeader.h.in @@ -0,0 +1,17 @@ +// This file was generated by ecm_setup_version(): DO NOT EDIT! + +#ifndef @HEADER_PREFIX@_VERSION_H +#define @HEADER_PREFIX@_VERSION_H + +#define @HEADER_PREFIX@_VERSION_STRING "@HEADER_VERSION@" +#define @HEADER_PREFIX@_VERSION_MAJOR @HEADER_VERSION_MAJOR@ +#define @HEADER_PREFIX@_VERSION_MINOR @HEADER_VERSION_MINOR@ +#define @HEADER_PREFIX@_VERSION_PATCH @HEADER_VERSION_PATCH@ +#define @HEADER_PREFIX@_VERSION @HEADER_PREFIX@_VERSION_CHECK(@HEADER_PREFIX@_VERSION_MAJOR, @HEADER_PREFIX@_VERSION_MINOR, @HEADER_PREFIX@_VERSION_PATCH) + +/* + for example: @HEADER_PREFIX@_VERSION >= @HEADER_PREFIX@_VERSION_CHECK(1, 2, 2)) +*/ +#define @HEADER_PREFIX@_VERSION_CHECK(major, minor, patch) ((major<<16)|(minor<<8)|(patch)) + +#endif diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/cmake/ECM/modules/QtVersionOption.cmake b/3rdparty/kdsingleapplication/KDSingleApplication/cmake/ECM/modules/QtVersionOption.cmake new file mode 100644 index 0000000..ea37da2 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/cmake/ECM/modules/QtVersionOption.cmake @@ -0,0 +1,36 @@ +# SPDX-FileCopyrightText: 2021 Volker Krause <vkrause@kde.org> +# +# SPDX-License-Identifier: BSD-3-Clause + +#[=======================================================================[.rst: +QtVersionOption +--------------- + +Adds a build option to select the major Qt version if necessary, +that is, if the major Qt version has not yet been determined otherwise +(e.g. by a corresponding ``find_package()`` call). +This module is typically included by other modules requiring knowledge +about the major Qt version. + +``QT_MAJOR_VERSION`` is defined to either be "5" or "6". + +Since 5.82.0. +#]=======================================================================] + +if (DEFINED QT_MAJOR_VERSION) + return() +endif() + +if (TARGET Qt5::Core) + set(QT_MAJOR_VERSION 5) +elseif (TARGET Qt6::Core) + set(QT_MAJOR_VERSION 6) +else() + option(BUILD_WITH_QT6 "Build against Qt 6" OFF) + + if (BUILD_WITH_QT6) + set(QT_MAJOR_VERSION 6) + else() + set(QT_MAJOR_VERSION 5) + endif() +endif() diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/cmake/ECM/modules/ecm_uninstall.cmake.in b/3rdparty/kdsingleapplication/KDSingleApplication/cmake/ECM/modules/ecm_uninstall.cmake.in new file mode 100644 index 0000000..379239b --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/cmake/ECM/modules/ecm_uninstall.cmake.in @@ -0,0 +1,21 @@ +if(NOT EXISTS "@CMAKE_BINARY_DIR@/install_manifest.txt") + message(FATAL_ERROR "Cannot find install manifest: @CMAKE_BINARY_DIR@/install_manifest.txt") +endif() + +file(READ "@CMAKE_BINARY_DIR@/install_manifest.txt" files) +string(REGEX REPLACE "\n" ";" files "${files}") +foreach(file ${files}) + message(STATUS "Uninstalling $ENV{DESTDIR}${file}") + if(IS_SYMLINK "$ENV{DESTDIR}${file}" OR EXISTS "$ENV{DESTDIR}${file}") + exec_program( + "@CMAKE_COMMAND@" ARGS "-E remove \"$ENV{DESTDIR}${file}\"" + OUTPUT_VARIABLE rm_out + RETURN_VALUE rm_retval + ) + if(NOT "${rm_retval}" STREQUAL 0) + message(FATAL_ERROR "Problem when removing $ENV{DESTDIR}${file}") + endif() + else() + message(STATUS "File $ENV{DESTDIR}${file} does not exist.") + endif() +endforeach() diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/cmake/KDAB/modules/KDInstallLocation.cmake b/3rdparty/kdsingleapplication/KDSingleApplication/cmake/KDAB/modules/KDInstallLocation.cmake new file mode 100644 index 0000000..96baaf3 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/cmake/KDAB/modules/KDInstallLocation.cmake @@ -0,0 +1,41 @@ +# +# SPDX-FileCopyrightText: 2012-2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> +# +# SPDX-License-Identifier: BSD-3-Clause +# + +# Some default installation locations. These should be global, with any project +# specific locations added to the end. These paths are all relative to the +# install prefix. +# +# These paths attempt to adhere to the FHS, and are similar to those provided +# by autotools and used in many Linux distributions. + +# Use GNU install directories +include(GNUInstallDirs) + +if(NOT INSTALL_RUNTIME_DIR) + set(INSTALL_RUNTIME_DIR ${CMAKE_INSTALL_BINDIR}) +endif() +if(NOT INSTALL_LIBRARY_DIR) + set(INSTALL_LIBRARY_DIR ${CMAKE_INSTALL_LIBDIR}) +endif() +if(NOT INSTALL_ARCHIVE_DIR) + set(INSTALL_ARCHIVE_DIR ${CMAKE_INSTALL_LIBDIR}) +endif() +if(NOT INSTALL_INCLUDE_DIR) + set(INSTALL_INCLUDE_DIR ${CMAKE_INSTALL_INCLUDEDIR}) +endif() +if(NOT INSTALL_DATADIR) + set(INSTALL_DATADIR ${CMAKE_INSTALL_DATADIR}) +endif() +if(NOT INSTALL_DOC_DIR) + set(INSTALL_DOC_DIR ${CMAKE_INSTALL_DOCDIR}${${PROJECT_NAME}_LIBRARY_QTID}) +endif() + +set(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE) +if(APPLE) + set(CMAKE_MACOSX_RPATH ON) +else() + set(CMAKE_INSTALL_RPATH "$ORIGIN/../${INSTALL_LIBRARY_DIR}") +endif() diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/cmake/KDAB/modules/KDQtInstallPaths.cmake b/3rdparty/kdsingleapplication/KDSingleApplication/cmake/KDAB/modules/KDQtInstallPaths.cmake new file mode 100644 index 0000000..27f4ff8 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/cmake/KDAB/modules/KDQtInstallPaths.cmake @@ -0,0 +1,55 @@ +# +# SPDX-FileCopyrightText: 2016-2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> +# Author: Allen Winter <allen.winter@kdab.com> +# +# SPDX-License-Identifier: BSD-3-Clause +# + +# Assumes you've already found Qt and Qt_VERSION_MAJOR is set +# +# Create variables for all the various install paths for the Qt version in use +# Make sure to have found Qt before using this. +# sets variables like QT_INSTALL_PREFIX, QT_INSTALL_DATA, QT_INSTALL_DOCS, etc. +# run qmake -query to see a full list + +if(NOT DEFINED Qt_VERSION_MAJOR) + message(FATAL_ERROR "Please set Qt_VERSION_MAJOR first (ie. set(Qt_VERSION_MAJOR 5))") +endif() + +if(TARGET Qt${Qt_VERSION_MAJOR}::qmake) + get_target_property(QT_QMAKE_EXECUTABLE Qt${Qt_VERSION_MAJOR}::qmake LOCATION) +else() + message(FATAL_ERROR "No supported Qt version found. Make sure you find Qt before calling this") +endif() + +execute_process( + COMMAND ${QT_QMAKE_EXECUTABLE} -query + RESULT_VARIABLE return_code + OUTPUT_VARIABLE ALL_VARS +) +if(NOT return_code EQUAL 0) + message(WARNING "Failed call: ${QT_QMAKE_EXECUTABLE} -query") + message(FATAL_ERROR "QMake call failed: ${return_code}") +endif() + +string(REPLACE "\n" ";" VARS_LIST ${ALL_VARS}) +foreach(qval ${VARS_LIST}) + if(qval MATCHES "QT_INSTALL_") + string(REPLACE ":" ";" QVAL_LIST ${qval}) + list(LENGTH QVAL_LIST listlen) + list(GET QVAL_LIST 0 var) + if(WIN32 AND ${listlen} GREATER 2) + list(GET QVAL_LIST 2 path) + list(GET QVAL_LIST 1 drive) + set(path "${drive}:${path}") + else() + list(GET QVAL_LIST 1 path) + endif() + if(NOT ${var}) #if set already on the command line for example + set(${var} + ${path} + CACHE PATH "Qt install path for ${var}" + ) + endif() + endif() +endforeach() diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/distro/debian.changelog b/3rdparty/kdsingleapplication/KDSingleApplication/distro/debian.changelog new file mode 100644 index 0000000..861cac6 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/distro/debian.changelog @@ -0,0 +1,5 @@ +kdsingleapplication (1.0.0) release candidate; urgency=high + + * 1.0.0 final + + -- Allen Winter <allen.winter@kdab.com> Mon, 17 July 2023 12:00:00 -0500 diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/distro/debian.compat b/3rdparty/kdsingleapplication/KDSingleApplication/distro/debian.compat new file mode 100644 index 0000000..ec63514 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/distro/debian.compat @@ -0,0 +1 @@ +9 diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/distro/qt5-debian.control b/3rdparty/kdsingleapplication/KDSingleApplication/distro/qt5-debian.control new file mode 100644 index 0000000..6c30125 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/distro/qt5-debian.control @@ -0,0 +1,12 @@ +Source: kdsingleapplication +Section: Miscellaneous +Priority: optional +Maintainer: Allen Winter <allen.winter@kdab.com> +Build-Depends: debhelper (>=9), cdbs, cmake +Standards-Version: 3.9.6 +Homepage: https://github.com/KDAB/KDSingleApplication + +Package: qt5-kdsingleapplication +Architecture: any +Depends: ${misc:Depends}, ${shlibs:Depends} +Description: KDAB's helper class for Qt5 single-instance policy applications diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/distro/qt5-debian.rules b/3rdparty/kdsingleapplication/KDSingleApplication/distro/qt5-debian.rules new file mode 100644 index 0000000..155f947 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/distro/qt5-debian.rules @@ -0,0 +1,4 @@ +#!/usr/bin/make -f +DEB_CMAKE_EXTRA_FLAGS = -DCMAKE_BUILD_TYPE=Release -DKDSingleApplication_STATIC=True +include /usr/share/cdbs/1/rules/debhelper.mk +include /usr/share/cdbs/1/class/cmake.mk diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/distro/qt5-kdsingleapplication-rpmlintrc b/3rdparty/kdsingleapplication/KDSingleApplication/distro/qt5-kdsingleapplication-rpmlintrc new file mode 100644 index 0000000..14ec53b --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/distro/qt5-kdsingleapplication-rpmlintrc @@ -0,0 +1 @@ +addFilter("E: shlib-policy-name-error") diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/distro/qt5-kdsingleapplication.dsc b/3rdparty/kdsingleapplication/KDSingleApplication/distro/qt5-kdsingleapplication.dsc new file mode 100644 index 0000000..90008e8 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/distro/qt5-kdsingleapplication.dsc @@ -0,0 +1,10 @@ +Format: 1.0 +Source: kdsingleapplication +Version: 1.0.0-1 +Binary: kdsingleapplication +Maintainer: Allen Winter <allen.winter@kdab.com> +Architecture: any +Build-Depends: debhelper (>=9), cdbs, cmake, qtbase5-dev + +Files: + 00000000000000000000000000000000 00000 qt5-kdsingleapplication-1.0.0.tar.gz diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/distro/qt6-debian.control b/3rdparty/kdsingleapplication/KDSingleApplication/distro/qt6-debian.control new file mode 100644 index 0000000..ce2acbf --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/distro/qt6-debian.control @@ -0,0 +1,12 @@ +Source: kdsingleapplication +Section: Miscellaneous +Priority: optional +Maintainer: Allen Winter <allen.winter@kdab.com> +Build-Depends: debhelper (>=9), cdbs, cmake +Standards-Version: 3.9.6 +Homepage: https://github.com/KDAB/KDSingleApplication + +Package: qt6-kdsingleapplication +Architecture: any +Depends: ${misc:Depends}, ${shlibs:Depends} +Description: KDAB's helper class for Qt5 single-instance policy applications diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/distro/qt6-debian.rules b/3rdparty/kdsingleapplication/KDSingleApplication/distro/qt6-debian.rules new file mode 100644 index 0000000..9090671 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/distro/qt6-debian.rules @@ -0,0 +1,4 @@ +#!/usr/bin/make -f +DEB_CMAKE_EXTRA_FLAGS = -DCMAKE_BUILD_TYPE=Release -DKDSingleApplication_QT6=True -DKDSingleApplication_STATIC=True +include /usr/share/cdbs/1/rules/debhelper.mk +include /usr/share/cdbs/1/class/cmake.mk diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/distro/qt6-kdsingleapplication-rpmlintrc b/3rdparty/kdsingleapplication/KDSingleApplication/distro/qt6-kdsingleapplication-rpmlintrc new file mode 100644 index 0000000..14ec53b --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/distro/qt6-kdsingleapplication-rpmlintrc @@ -0,0 +1 @@ +addFilter("E: shlib-policy-name-error") diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/distro/qt6-kdsingleapplication.dsc b/3rdparty/kdsingleapplication/KDSingleApplication/distro/qt6-kdsingleapplication.dsc new file mode 100644 index 0000000..77a6de4 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/distro/qt6-kdsingleapplication.dsc @@ -0,0 +1,10 @@ +Format: 1.0 +Source: kdsingleapplication +Version: 1.0.0-1 +Binary: kdsingleapplication +Maintainer: Allen Winter <allen.winter@kdab.com> +Architecture: any +Build-Depends: debhelper (>=9), cdbs, cmake, qt6-base-dev, libgl1-mesa-dev, libfontconfig-dev, libfreetype-dev + +Files: + 00000000000000000000000000000000 00000 qt6-kdsingleapplication-1.0.0.tar.gz diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/docs/CMakeLists.txt b/3rdparty/kdsingleapplication/KDSingleApplication/docs/CMakeLists.txt new file mode 100644 index 0000000..0b0c709 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/docs/CMakeLists.txt @@ -0,0 +1,23 @@ +# +# This file is part of KDSingleApplication. +# +# SPDX-FileCopyrightText: 2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> +# +# SPDX-License-Identifier: MIT +# +# Contact KDAB at <info@kdab.com> for commercial licensing options. +# + +# Doxygen +find_package(Doxygen) +set_package_properties( + Doxygen PROPERTIES + TYPE OPTIONAL + DESCRIPTION "API Documentation system" + URL "https://www.doxygen.org" + PURPOSE "Needed to build the API documentation." +) + +if(DOXYGEN_FOUND) + add_subdirectory(api) +endif() diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/docs/api/CMakeLists.txt b/3rdparty/kdsingleapplication/KDSingleApplication/docs/api/CMakeLists.txt new file mode 100644 index 0000000..e61b35a --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/docs/api/CMakeLists.txt @@ -0,0 +1,80 @@ +# +# This file is part of KDSingleApplication. +# +# SPDX-FileCopyrightText: 2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> +# +# SPDX-License-Identifier: MIT +# +# Contact KDAB at <info@kdab.com> for commercial licensing options. + +# dot should come with Doxygen find_package(Doxygen) +if(DOXYGEN_DOT_EXECUTABLE) + set(HAVE_DOT "YES") +else() + set(HAVE_DOT "NO") + message(STATUS "Unable to provide inheritance diagrams for the API documentation. " + "To fix, install the graphviz project from https://www.graphviz.org" + ) +endif() + +# qhelpgenerator +find_program(QHELPGEN_EXECUTABLE qhelpgenerator HINTS ${QT_INSTALL_BINS}) +if(QHELPGEN_EXECUTABLE) + set(HAVE_QHELPGEN "YES") +else() + set(HAVE_QHELPGEN "NO") + message(STATUS "Unable to generate the API documentation in qch format. " + "To fix, install the qthelpgenerator program which comes with Qt." + ) +endif() + +find_file(QDOC_QTCORE_TAG qtcore.tags HINTS ${QT_INSTALL_DOCS}/qtcore ${QT_INSTALL_DATA}/doc/qtcore) +set(QDOC_TAG_DIR "<QDOC_TAG_DIR_not_found>") +if(QDOC_QTCORE_TAG) + get_filename_component(QDOC_TAG_DIR ${QDOC_QTCORE_TAG} DIRECTORY) + get_filename_component(QDOC_TAG_DIR ${QDOC_TAG_DIR} DIRECTORY) +endif() + +file(GLOB _dox_deps *.dox *.html) +set(DOXYGEN_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR}) + +#apidox generation using doxygen +configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.cmake ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile) + +add_custom_command( + OUTPUT ${DOXYGEN_OUTPUT_DIR}/qch/kdsingleapplication-api.qch + COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile + #handle a bug in doxygen where image files referred to in markdown are not copied the output + #copy some files by-hand that are referred to by the markdown README + COMMAND ${CMAKE_COMMAND} -E make_directory ${DOXYGEN_OUTPUT_DIR}/html/LICENSES + COMMAND ${CMAKE_COMMAND} -E copy_if_different ${CMAKE_SOURCE_DIR}/LICENSES/MIT.txt + ${DOXYGEN_OUTPUT_DIR}/html/LICENSES + COMMAND ${CMAKE_COMMAND} -E make_directory ${DOXYGEN_OUTPUT_DIR}/html/docs + COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_SOURCE_DIR}/examples ${DOXYGEN_OUTPUT_DIR}/html/examples + DEPENDS ${_dox_deps} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile + WORKING_DIRECTORY ${CMAKE_BINARY_DIR} + COMMENT "Generate the .qch file" +) +add_custom_target( + kdsingleapplication-api.qch ALL + DEPENDS ${DOXYGEN_OUTPUT_DIR}/qch/kdsingleapplication-api.qch + COMMENT "Target generate the .qch file" +) +add_custom_target( + docs + DEPENDS kdsingleapplication-api.qch + COMMENT "Target to generate the documentation" +) + +set(QCH_INSTALL_DIR + ${INSTALL_DOC_DIR} + CACHE STRING "Install location of Qt Assistant help files." +) +install( + FILES ${DOXYGEN_OUTPUT_DIR}/qch/kdsingleapplication-api.qch + DESTINATION ${QCH_INSTALL_DIR} +) +install( + FILES ${DOXYGEN_OUTPUT_DIR}/kdsingleapplication.tags + DESTINATION ${INSTALL_DOC_DIR} +) diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/docs/api/Doxyfile.cmake b/3rdparty/kdsingleapplication/KDSingleApplication/docs/api/Doxyfile.cmake new file mode 100644 index 0000000..d5fe7ba --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/docs/api/Doxyfile.cmake @@ -0,0 +1,2554 @@ +# Doxyfile 1.8.20 + +# 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 = "@PROJECT_NAME@ API Documentation" + +# 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 = @KDSingleApplication_VERSION_MAJOR@.@KDSingleApplication_VERSION_MINOR@ + +# 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 = NO + +# 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 = YES + +# 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 = 8 + +# 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 = "reimp=Reimplemented for internal purposes.\n" + +# 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. + +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 = NO + +# 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 = YES + +# 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 = YES + +# 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 = NO + +# 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 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 = YES + +# 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 = YES + +# 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 + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# (including Cygwin) and Mac users are advised to set this option to NO. +# 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 = YES + +# 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 = YES + +# 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 = NO + +# 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 = NO + +# 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 = NO + +# 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 <section_label> ... \endif and \cond <section_label> +# ... \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 = YES + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. +# 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 = doxygen.log + +#--------------------------------------------------------------------------- +# 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 = "@CMAKE_SOURCE_DIR@/README.md" \ + "@CMAKE_SOURCE_DIR@/src" + +# 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. +# +# 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), +# *.doc (to be provided as doxygen C comment), *.txt (to be provided as doxygen +# C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, +# *.vhdl, *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = *.cpp \ + *.h \ + *.dox \ + *.md \ + *.gif \ + *.png + +# 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 = */.svn/* \ + */.git/* \ + */cmake/* \ + *.moc.* \ + moc* \ + *.all_cpp.* \ + *unload.* \ + */test/* \ + */tests/* \ + *_p.cpp \ + *_p.h \ + *_export.h \ + */fwd_headers/* + +# 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: +# +# <filter> <input-file> +# +# where <filter> is the value of the INPUT_FILTER tag, and <input-file> 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 = "@CMAKE_SOURCE_DIR@/README.md" + +#--------------------------------------------------------------------------- +# 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 = YES + +# 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 = YES + +# 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 = YES + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# 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 = "@CMAKE_CURRENT_SOURCE_DIR@/footer.html" + +# 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 = "@CMAKE_CURRENT_SOURCE_DIR@/kdab-logo-16x16.png" + +# 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 = YES + +# 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 = @HAVE_QHELPGEN@ + +# 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 = "@DOXYGEN_OUTPUT_DIR@/qch/kdsingleapplication-api.qch" + +# 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 = com.kdab.@PROJECT_NAME@.api.@KDSingleApplication_VERSION@ + +# 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 = @PROJECT_NAME@-@KDSingleApplication_VERSION@ + +# 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 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 = "@QHELPGEN_EXECUTABLE@" + +# 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/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/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 <access key> + S +# (what the <access key> is depends on the OS and browser, but it is typically +# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down +# key> to jump into the search results window, the results can be navigated +# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel +# the search. The filter options can be selected when the cursor is inside the +# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys> +# to select a filter and <Enter> or <escape> to activate or cancel the filter +# option. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +SEARCHENGINE = YES + +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be +# implemented using a web server instead of a web client using JavaScript. There +# are two flavors of web server based searching depending on the EXTERNAL_SEARCH +# setting. When disabled, doxygen will generate a PHP script for searching and +# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing +# and searching needs to be provided by external tools. See the section +# "External Indexing and Searching" for details. +# The default value is: NO. +# This tag requires that the tag SEARCHENGINE is set to YES. + +SERVER_BASED_SEARCH = NO + +# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP +# script for searching. Instead the search results are written to an XML file +# which needs to be processed by an external indexer. Doxygen will invoke an +# external search engine pointed to by the SEARCHENGINE_URL option to obtain the +# search results. +# +# Doxygen ships with an example indexer (doxyindexer) and search engine +# (doxysearch.cgi) which are based on the open source search engine library +# Xapian (see: https://xapian.org/). +# +# See the section "External Indexing and Searching" for details. +# The default value is: NO. +# This tag requires that the tag SEARCHENGINE is set to YES. + +EXTERNAL_SEARCH = NO + +# The SEARCHENGINE_URL should point to a search engine hosted by a web server +# which will return the search results when EXTERNAL_SEARCH is enabled. +# +# Doxygen ships with an example indexer (doxyindexer) and search engine +# (doxysearch.cgi) which are based on the open source search engine library +# Xapian (see: https://xapian.org/). See the section "External Indexing and +# Searching" for details. +# This tag requires that the tag SEARCHENGINE is set to YES. + +SEARCHENGINE_URL = + +# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed +# search data is written to a file for indexing by an external tool. With the +# SEARCHDATA_FILE tag the name of this file can be specified. +# The default file is: searchdata.xml. +# This tag requires that the tag SEARCHENGINE is set to YES. + +SEARCHDATA_FILE = searchdata.xml + +# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the +# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is +# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple +# projects and redirect the results back to the right project. +# This tag requires that the tag SEARCHENGINE is set to YES. + +EXTERNAL_SEARCH_ID = + +# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen +# projects other than the one defined by this configuration file, but that are +# all added to the same external search index. Each project needs to have a +# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of +# to a relative location where the documentation can be found. The format is: +# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... +# This tag requires that the tag SEARCHENGINE is set to YES. + +EXTRA_SEARCH_MAPPINGS = + +#--------------------------------------------------------------------------- +# Configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. +# The default value is: YES. + +GENERATE_LATEX = NO + +# The LATEX_OUTPUT tag is used to specify where the LaTeX 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: latex. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. +# +# Note that when not enabling USE_PDFLATEX the default is latex when enabling +# USE_PDFLATEX the default is pdflatex and when in the later case latex is +# chosen this is overwritten by pdflatex. For specific output languages the +# default can have been set differently, this depends on the implementation of +# the output language. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate +# index for LaTeX. +# Note: This tag is used in the Makefile / make.bat. +# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file +# (.tex). +# The default file is: makeindex. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +MAKEINDEX_CMD_NAME = makeindex + +# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to +# generate index for LaTeX. In case there is no backslash (\) as first character +# it will be automatically added in the LaTeX code. +# Note: This tag is used in the generated output file (.tex). +# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat. +# The default value is: makeindex. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_MAKEINDEX_CMD = makeindex + +# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX +# documents. This may be useful for small projects and may help to save some +# trees in general. +# The default value is: NO. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used by the +# printer. +# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x +# 14 inches) and executive (7.25 x 10.5 inches). +# The default value is: a4. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +PAPER_TYPE = a4 + +# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names +# that should be included in the LaTeX output. The package can be specified just +# by its name or with the correct syntax as to be used with the LaTeX +# \usepackage command. To get the times font for instance you can specify : +# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times} +# To use the option intlimits with the amsmath package you can specify: +# EXTRA_PACKAGES=[intlimits]{amsmath} +# If left blank no extra packages will be included. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the +# generated LaTeX document. The header should contain everything until the first +# chapter. If it is left blank doxygen will generate a standard header. See +# section "Doxygen usage" for information on how to let doxygen write the +# default header to a separate file. +# +# Note: Only use a user-defined header if you know what you are doing! The +# following commands have a special meaning inside the header: $title, +# $datetime, $date, $doxygenversion, $projectname, $projectnumber, +# $projectbrief, $projectlogo. Doxygen will replace $title with the empty +# string, for the replacement values of the other commands the user is referred +# to HTML_HEADER. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_HEADER = + +# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the +# generated LaTeX document. The footer should contain everything after the last +# chapter. If it is left blank doxygen will generate a standard footer. See +# LATEX_HEADER for more information on how to generate a default footer and what +# special commands can be used inside the footer. +# +# Note: Only use a user-defined footer if you know what you are doing! +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_FOOTER = + +# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# LaTeX style sheets that are included after the standard style sheets created +# by doxygen. Using this option one can overrule certain style aspects. 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). +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_EXTRA_STYLESHEET = + +# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the LATEX_OUTPUT output +# directory. Note that the files will be copied as-is; there are no commands or +# markers available. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_EXTRA_FILES = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is +# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will +# contain links (just like the HTML output) instead of page references. This +# makes the output suitable for online browsing using a PDF viewer. +# The default value is: YES. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +PDF_HYPERLINKS = YES + +# If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as +# specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX +# files. Set this option to YES, to get a higher quality PDF documentation. +# +# See also section LATEX_CMD_NAME for selecting the engine. +# The default value is: YES. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +USE_PDFLATEX = NO + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode +# command to the generated LaTeX files. This will instruct LaTeX to keep running +# if errors occur, instead of asking the user for help. This option is also used +# when generating formulas in HTML. +# The default value is: NO. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_BATCHMODE = NO + +# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the +# index chapters (such as File Index, Compound Index, etc.) in the output. +# The default value is: NO. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_HIDE_INDICES = NO + +# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source +# code with syntax highlighting in the LaTeX output. +# +# Note that which sources are shown also depends on other settings such as +# SOURCE_BROWSER. +# The default value is: NO. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_SOURCE_CODE = NO + +# The LATEX_BIB_STYLE tag can be used to specify the style to use for the +# bibliography, e.g. plainnat, or ieeetr. See +# https://en.wikipedia.org/wiki/BibTeX and \cite for more info. +# The default value is: plain. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_BIB_STYLE = plain + +# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated +# page will contain the date and time when the page was generated. Setting this +# to NO can help when comparing the output of multiple runs. +# The default value is: NO. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_TIMESTAMP = NO + +# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute) +# path from which the emoji images will be read. If a relative path is entered, +# it will be relative to the LATEX_OUTPUT directory. If left blank the +# LATEX_OUTPUT directory will be used. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_EMOJI_DIRECTORY = + +#--------------------------------------------------------------------------- +# Configuration options related to the RTF output +#--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The +# RTF output is optimized for Word 97 and may not look too pretty with other RTF +# readers/editors. +# The default value is: NO. + +GENERATE_RTF = NO + +# The RTF_OUTPUT tag is used to specify where the RTF 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: rtf. +# This tag requires that the tag GENERATE_RTF is set to YES. + +RTF_OUTPUT = rtf + +# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF +# documents. This may be useful for small projects and may help to save some +# trees in general. +# The default value is: NO. +# This tag requires that the tag GENERATE_RTF is set to YES. + +COMPACT_RTF = NO + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will +# contain hyperlink fields. The RTF file will contain links (just like the HTML +# output) instead of page references. This makes the output suitable for online +# browsing using Word or some other Word compatible readers that support those +# fields. +# +# Note: WordPad (write) and others do not support links. +# The default value is: NO. +# This tag requires that the tag GENERATE_RTF is set to YES. + +RTF_HYPERLINKS = NO + +# Load stylesheet definitions from file. Syntax is similar to doxygen's +# configuration file, i.e. a series of assignments. You only have to provide +# replacements, missing definitions are set to their default value. +# +# See also section "Doxygen usage" for information on how to generate the +# default style sheet that doxygen normally uses. +# This tag requires that the tag GENERATE_RTF is set to YES. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an RTF document. Syntax is +# similar to doxygen's configuration file. A template extensions file can be +# generated using doxygen -e rtf extensionFile. +# This tag requires that the tag GENERATE_RTF is set to YES. + +RTF_EXTENSIONS_FILE = + +# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code +# with syntax highlighting in the RTF output. +# +# Note that which sources are shown also depends on other settings such as +# SOURCE_BROWSER. +# The default value is: NO. +# This tag requires that the tag GENERATE_RTF is set to YES. + +RTF_SOURCE_CODE = NO + +#--------------------------------------------------------------------------- +# Configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for +# classes and files. +# The default value is: NO. + +GENERATE_MAN = NO + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. A directory man3 will be created inside the directory specified by +# MAN_OUTPUT. +# The default directory is: man. +# This tag requires that the tag GENERATE_MAN is set to YES. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to the generated +# man pages. In case the manual section does not start with a number, the number +# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is +# optional. +# The default value is: .3. +# This tag requires that the tag GENERATE_MAN is set to YES. + +MAN_EXTENSION = .3 + +# The MAN_SUBDIR tag determines the name of the directory created within +# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by +# MAN_EXTENSION with the initial . removed. +# This tag requires that the tag GENERATE_MAN is set to YES. + +MAN_SUBDIR = + +# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it +# will generate one additional man file for each entity documented in the real +# man page(s). These additional files only source the real man page, but without +# them the man command would be unable to find the correct page. +# The default value is: NO. +# This tag requires that the tag GENERATE_MAN is set to YES. + +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# Configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that +# captures the structure of the code including all documentation. +# The default value is: NO. + +GENERATE_XML = NO + +# The XML_OUTPUT tag is used to specify where the XML pages 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: xml. +# This tag requires that the tag GENERATE_XML is set to YES. + +XML_OUTPUT = xml + +# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program +# listings (including syntax highlighting and cross-referencing information) to +# the XML output. Note that enabling this will significantly increase the size +# of the XML output. +# The default value is: YES. +# This tag requires that the tag GENERATE_XML is set to YES. + +XML_PROGRAMLISTING = YES + +# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include +# namespace members in file scope as well, matching the HTML output. +# The default value is: NO. +# This tag requires that the tag GENERATE_XML is set to YES. + +XML_NS_MEMB_FILE_SCOPE = NO + +#--------------------------------------------------------------------------- +# Configuration options related to the DOCBOOK output +#--------------------------------------------------------------------------- + +# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files +# that can be used to generate PDF. +# The default value is: NO. + +GENERATE_DOCBOOK = NO + +# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages 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: docbook. +# This tag requires that the tag GENERATE_DOCBOOK is set to YES. + +DOCBOOK_OUTPUT = docbook + +# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the +# program listings (including syntax highlighting and cross-referencing +# information) to the DOCBOOK output. Note that enabling this will significantly +# increase the size of the DOCBOOK output. +# The default value is: NO. +# This tag requires that the tag GENERATE_DOCBOOK is set to YES. + +DOCBOOK_PROGRAMLISTING = NO + +#--------------------------------------------------------------------------- +# Configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an +# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures +# the structure of the code including all documentation. Note that this feature +# is still experimental and incomplete at the moment. +# The default value is: NO. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# Configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module +# file that captures the structure of the code including all documentation. +# +# Note that this feature is still experimental and incomplete at the moment. +# The default value is: NO. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary +# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI +# output from the Perl module output. +# The default value is: NO. +# This tag requires that the tag GENERATE_PERLMOD is set to YES. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely +# formatted so it can be parsed by a human reader. This is useful if you want to +# understand what is going on. On the other hand, if this tag is set to NO, the +# size of the Perl module output will be much smaller and Perl will parse it +# just the same. +# The default value is: YES. +# This tag requires that the tag GENERATE_PERLMOD is set to YES. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file are +# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful +# so different doxyrules.make files included by the same Makefile don't +# overwrite each other's variables. +# This tag requires that the tag GENERATE_PERLMOD is set to YES. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all +# C-preprocessor directives found in the sources and include files. +# The default value is: YES. + +ENABLE_PREPROCESSING = YES + +# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names +# in the source code. If set to NO, only conditional compilation will be +# performed. Macro expansion can be done in a controlled way by setting +# EXPAND_ONLY_PREDEF to YES. +# The default value is: NO. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +MACRO_EXPANSION = NO + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then +# the macro expansion is limited to the macros specified with the PREDEFINED and +# EXPAND_AS_DEFINED tags. +# The default value is: NO. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +EXPAND_ONLY_PREDEF = NO + +# If the SEARCH_INCLUDES tag is set to YES, the include files in the +# INCLUDE_PATH will be searched if a #include is found. +# The default value is: YES. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +SEARCH_INCLUDES = YES + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by the +# preprocessor. +# This tag requires that the tag SEARCH_INCLUDES is set to YES. + +INCLUDE_PATH = + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will be +# used. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +INCLUDE_FILE_PATTERNS = + +# The PREDEFINED tag can be used to specify one or more macro names that are +# defined before the preprocessor is started (similar to the -D option of e.g. +# gcc). The argument of the tag is a list of macros of the form: name or +# name=definition (no spaces). If the definition and the "=" are omitted, "=1" +# is assumed. To prevent a macro definition from being undefined via #undef or +# recursively expanded use the := operator instead of the = operator. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +PREDEFINED = "Q_DECL_IMPORT=" \ + "Q_CORE_EXPORT=" \ + "KDSINGLEAPPLICATION_EXPORT=" \ + "override=override" + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this +# tag can be used to specify a list of macro names that should be expanded. The +# macro definition that is found in the sources will be used. Use the PREDEFINED +# tag if you want to use a different macro definition that overrules the +# definition found in the source code. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will +# remove all references to function-like macros that are alone on a line, have +# an all uppercase name, and do not end with a semicolon. Such function macros +# are typically used for boiler-plate code, and will confuse the parser if not +# removed. +# The default value is: YES. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES tag can be used to specify one or more tag files. For each tag +# file the location of the external documentation should be added. The format of +# a tag file without this location is as follows: +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where loc1 and loc2 can be relative or absolute paths or URLs. See the +# section "Linking to external documentation" for more information about the use +# of tag files. +# Note: Each tag file must have a unique name (where the name does NOT include +# the path). If a tag file is not located in the directory in which doxygen is +# run, you must also specify the path to the tagfile here. + +TAGFILES = "@QDOC_TAG_DIR@/qtcore/qtcore.tags=https://doc.qt.io/qt-5/" \ + "@QDOC_TAG_DIR@/qtgui/qtgui.tags=https://doc.qt.io/qt-5/" \ + "@QDOC_TAG_DIR@/qtwidgets/qtwidgets.tags=https://doc.qt.io/qt-5/" \ + "@QDOC_TAG_DIR@/qtnetwork/qtnetwork.tags=https://doc.qt.io/qt-5/" + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create a +# tag file that is based on the input files it reads. See section "Linking to +# external documentation" for more information about the usage of tag files. + +GENERATE_TAGFILE = "@DOXYGEN_OUTPUT_DIR@/kdsingleapplication.tags" + +# If the ALLEXTERNALS tag is set to YES, all external class will be listed in +# the class index. If set to NO, only the inherited external classes will be +# listed. +# The default value is: NO. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will be +# listed. +# The default value is: YES. + +EXTERNAL_GROUPS = YES + +# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in +# the related pages index. If set to NO, only the current project's pages will +# be listed. +# The default value is: YES. + +EXTERNAL_PAGES = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram +# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to +# NO turns the diagrams off. Note that this option also works with HAVE_DOT +# disabled, but it is recommended to install and use dot, since it yields more +# powerful graphs. +# The default value is: YES. + +CLASS_DIAGRAMS = YES + +# You can include diagrams made with dia in doxygen documentation. Doxygen will +# then run dia to produce the diagram and insert it in the documentation. The +# DIA_PATH tag allows you to specify the directory where the dia binary resides. +# If left empty dia is assumed to be found in the default search path. + +DIA_PATH = + +# If set to YES the inheritance and collaboration graphs will hide inheritance +# and usage relations if the target is undocumented or is not a class. +# The default value is: YES. + +HIDE_UNDOC_RELATIONS = YES + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz (see: +# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent +# Bell Labs. The other options in this section have no effect if this option is +# set to NO +# The default value is: NO. + +HAVE_DOT = @HAVE_DOT@ + +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed +# to run in parallel. When set to 0 doxygen will base this on the number of +# processors available in the system. You can set it explicitly to a value +# larger than 0 to get control over the balance between CPU load and processing +# speed. +# Minimum value: 0, maximum value: 32, default value: 0. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_NUM_THREADS = 0 + +# When you want a differently looking font in the dot files that doxygen +# generates you can specify the font name using DOT_FONTNAME. You need to make +# sure dot is able to find the font, which can be done by putting it in a +# standard location or by setting the DOTFONTPATH environment variable or by +# setting DOT_FONTPATH to the directory containing the font. +# The default value is: Helvetica. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_FONTNAME = Helvetica + +# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of +# dot graphs. +# Minimum value: 4, maximum value: 24, default value: 10. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_FONTSIZE = 10 + +# By default doxygen will tell dot to use the default font as specified with +# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set +# the path where dot can find it using this tag. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_FONTPATH = + +# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for +# each documented class showing the direct and indirect inheritance relations. +# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +CLASS_GRAPH = YES + +# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a +# graph for each documented class showing the direct and indirect implementation +# dependencies (inheritance, containment, and class references variables) of the +# class with other documented classes. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +COLLABORATION_GRAPH = YES + +# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for +# groups, showing the direct groups dependencies. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +GROUP_GRAPHS = YES + +# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +UML_LOOK = NO + +# If the UML_LOOK tag is enabled, the fields and methods are shown inside the +# class node. If there are many fields or methods and many nodes the graph may +# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the +# number of items for each type to make the size more manageable. Set this to 0 +# for no limit. Note that the threshold may be exceeded by 50% before the limit +# is enforced. So when you set the threshold to 10, up to 15 fields may appear, +# but if the number exceeds 15, the total amount of fields shown is limited to +# 10. +# Minimum value: 0, maximum value: 100, default value: 10. +# This tag requires that the tag HAVE_DOT is set to YES. + +UML_LIMIT_NUM_FIELDS = 10 + +# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and +# collaboration graphs will show the relations between templates and their +# instances. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +TEMPLATE_RELATIONS = NO + +# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to +# YES then doxygen will generate a graph for each documented file showing the +# direct and indirect include dependencies of the file with other documented +# files. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +INCLUDE_GRAPH = YES + +# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are +# set to YES then doxygen will generate a graph for each documented file showing +# the direct and indirect include dependencies of the file with other documented +# files. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH tag is set to YES then doxygen will generate a call +# dependency graph for every global function or class method. +# +# Note that enabling this option will significantly increase the time of a run. +# So in most cases it will be better to enable call graphs for selected +# functions only using the \callgraph command. Disabling a call graph can be +# accomplished by means of the command \hidecallgraph. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +CALL_GRAPH = NO + +# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller +# dependency graph for every global function or class method. +# +# Note that enabling this option will significantly increase the time of a run. +# So in most cases it will be better to enable caller graphs for selected +# functions only using the \callergraph command. Disabling a caller graph can be +# accomplished by means of the command \hidecallergraph. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +CALLER_GRAPH = NO + +# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical +# hierarchy of all classes instead of a textual one. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +GRAPHICAL_HIERARCHY = YES + +# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the +# dependencies a directory has on other directories in a graphical way. The +# dependency relations are determined by the #include relations between the +# files in the directories. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +DIRECTORY_GRAPH = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. For an explanation of the image formats see the section +# output formats in the documentation of the dot tool (Graphviz (see: +# http://www.graphviz.org/)). +# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order +# to make the SVG files visible in IE 9+ (other browsers do not have this +# requirement). +# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo, +# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and +# png:gdiplus:gdiplus. +# The default value is: png. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_IMAGE_FORMAT = png + +# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to +# enable generation of interactive SVG images that allow zooming and panning. +# +# Note that this requires a modern browser other than Internet Explorer. Tested +# and working are Firefox, Chrome, Safari, and Opera. +# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make +# the SVG files visible. Older versions of IE do not have SVG support. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +INTERACTIVE_SVG = NO + +# The DOT_PATH tag can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found in the path. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_PATH = + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the \dotfile +# command). +# This tag requires that the tag HAVE_DOT is set to YES. + +DOTFILE_DIRS = + +# The MSCFILE_DIRS tag can be used to specify one or more directories that +# contain msc files that are included in the documentation (see the \mscfile +# command). + +MSCFILE_DIRS = + +# The DIAFILE_DIRS tag can be used to specify one or more directories that +# contain dia files that are included in the documentation (see the \diafile +# command). + +DIAFILE_DIRS = + +# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the +# path where java can find the plantuml.jar file. If left blank, it is assumed +# PlantUML is not used or called during a preprocessing step. Doxygen will +# generate a warning when it encounters a \startuml command in this case and +# will not generate output for the diagram. + +PLANTUML_JAR_PATH = + +# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a +# configuration file for plantuml. + +PLANTUML_CFG_FILE = + +# When using plantuml, the specified paths are searched for files specified by +# the !include statement in a plantuml block. + +PLANTUML_INCLUDE_PATH = + +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes +# that will be shown in the graph. If the number of nodes in a graph becomes +# larger than this value, doxygen will truncate the graph, which is visualized +# by representing a node as a red box. Note that doxygen if the number of direct +# children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that +# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. +# Minimum value: 0, maximum value: 10000, default value: 50. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_GRAPH_MAX_NODES = 50 + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs +# generated by dot. A depth value of 3 means that only nodes reachable from the +# root by following a path via at most 3 edges will be shown. Nodes that lay +# further from the root node will be omitted. Note that setting this option to 1 +# or 2 may greatly reduce the computation time needed for large code bases. Also +# note that the size of a graph can be further restricted by +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. +# Minimum value: 0, maximum value: 1000, default value: 0. +# This tag requires that the tag HAVE_DOT is set to YES. + +MAX_DOT_GRAPH_DEPTH = 1000 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is disabled by default, because dot on Windows does not seem +# to support this out of the box. +# +# Warning: Depending on the platform used, enabling this option may lead to +# badly anti-aliased labels on the edges of a graph (i.e. they become hard to +# read). +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_TRANSPARENT = NO + +# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) support +# this, this feature is disabled by default. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_MULTI_TARGETS = NO + +# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page +# explaining the meaning of the various boxes and arrows in the dot generated +# graphs. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot +# files that are used to generate the various graphs. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_CLEANUP = YES diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/docs/api/footer.html b/3rdparty/kdsingleapplication/KDSingleApplication/docs/api/footer.html new file mode 100644 index 0000000..d0674e0 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/docs/api/footer.html @@ -0,0 +1,18 @@ + <hr> + <div style="float: left;"> + <img src="kdab-logo-16x16.png"> + <font style="font-weight: bold;">© 2019-2023 Klarälvdalens Datakonsult AB (KDAB)</font> + <br> + "The Qt, C++ and OpenGL Experts"<br> + <a href="https://www.kdab.com/">https://www.kdab.com/</a> + </div> + + <div style="text-align: right;"> + <font style="font-weight: bold;">KDSingleApplication</font> + <br> + A helper class for single-instance policy Qt applications<br> + $generatedby doxygen $doxygenversion<br> + </div> + + </body> +</html> diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/docs/api/kdab-logo-16x16.png b/3rdparty/kdsingleapplication/KDSingleApplication/docs/api/kdab-logo-16x16.png new file mode 100644 index 0000000..61dc65e Binary files /dev/null and b/3rdparty/kdsingleapplication/KDSingleApplication/docs/api/kdab-logo-16x16.png differ diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/examples/CMakeLists.txt b/3rdparty/kdsingleapplication/KDSingleApplication/examples/CMakeLists.txt new file mode 100644 index 0000000..466f292 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/examples/CMakeLists.txt @@ -0,0 +1,9 @@ +# This file is part of KDSingleApplication. +# +# SPDX-FileCopyrightText: 2020-2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> +# +# SPDX-License-Identifier: MIT +# +# Contact KDAB at <info@kdab.com> for commercial licensing options. +# +add_subdirectory(widgetsingleapplication) diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/examples/widgetsingleapplication/CMakeLists.txt b/3rdparty/kdsingleapplication/KDSingleApplication/examples/widgetsingleapplication/CMakeLists.txt new file mode 100644 index 0000000..0ee049f --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/examples/widgetsingleapplication/CMakeLists.txt @@ -0,0 +1,16 @@ +# This file is part of KDSingleApplication. +# +# SPDX-FileCopyrightText: 2020-2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> +# +# SPDX-License-Identifier: MIT +# +# Contact KDAB at <info@kdab.com> for commercial licensing options. +# +set(widgetsingleapplication_SRCS main.cpp primaryinstancewidget.cpp secondaryinstancewidget.cpp) +add_executable( + widgetsingleapplication + ${widgetsingleapplication_SRCS} +) +target_link_libraries( + widgetsingleapplication Qt::Widgets kdsingleapplication +) diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/examples/widgetsingleapplication/main.cpp b/3rdparty/kdsingleapplication/KDSingleApplication/examples/widgetsingleapplication/main.cpp new file mode 100644 index 0000000..e7d7aa3 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/examples/widgetsingleapplication/main.cpp @@ -0,0 +1,41 @@ +/* + This file is part of KDSingleApplication. + + SPDX-FileCopyrightText: 2019-2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> + + SPDX-License-Identifier: MIT + + Contact KDAB at <info@kdab.com> for commercial licensing options. +*/ + +#include <QtWidgets/QApplication> + +#include <kdsingleapplication.h> + +#include "primaryinstancewidget.h" +#include "secondaryinstancewidget.h" + +int main(int argc, char **argv) +{ + QApplication app(argc, argv); + + KDSingleApplication kdsa; + + QWidget *widget; + + if (kdsa.isPrimaryInstance()) { + PrimaryInstanceWidget *piw = new PrimaryInstanceWidget; + QObject::connect(&kdsa, &KDSingleApplication::messageReceived, + piw, &PrimaryInstanceWidget::addMessage); + + widget = piw; + } else { + SecondaryInstanceWidget *siw = new SecondaryInstanceWidget(&kdsa); + widget = siw; + } + + widget->setAttribute(Qt::WA_DeleteOnClose); + widget->show(); + + return app.exec(); +} diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/examples/widgetsingleapplication/primaryinstancewidget.cpp b/3rdparty/kdsingleapplication/KDSingleApplication/examples/widgetsingleapplication/primaryinstancewidget.cpp new file mode 100644 index 0000000..f4e1269 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/examples/widgetsingleapplication/primaryinstancewidget.cpp @@ -0,0 +1,34 @@ +/* + This file is part of KDSingleApplication. + + SPDX-FileCopyrightText: 2019-2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> + + SPDX-License-Identifier: MIT + + Contact KDAB at <info@kdab.com> for commercial licensing options. +*/ + +#include "primaryinstancewidget.h" + +#include <QLabel> +#include <QListWidget> + +#include <QVBoxLayout> + +PrimaryInstanceWidget::PrimaryInstanceWidget(QWidget *parent) + : QWidget(parent) +{ + setWindowTitle(tr("Primary instance")); + QLabel *label = new QLabel(tr("<b>Primary instance.</b> Messages received from secondaries:")); + m_messagesListWidget = new QListWidget(this); + + QVBoxLayout *layout = new QVBoxLayout(this); + layout->addWidget(label); + layout->addWidget(m_messagesListWidget); +} + +void PrimaryInstanceWidget::addMessage(const QByteArray &message) +{ + m_messagesListWidget->addItem(QString::fromUtf8(message)); + m_messagesListWidget->scrollToBottom(); +} diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/examples/widgetsingleapplication/primaryinstancewidget.h b/3rdparty/kdsingleapplication/KDSingleApplication/examples/widgetsingleapplication/primaryinstancewidget.h new file mode 100644 index 0000000..cf743d4 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/examples/widgetsingleapplication/primaryinstancewidget.h @@ -0,0 +1,34 @@ +/* + This file is part of KDSingleApplication. + + SPDX-FileCopyrightText: 2019-2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> + + SPDX-License-Identifier: MIT + + Contact KDAB at <info@kdab.com> for commercial licensing options. +*/ + +#ifndef PRIMARYINSTANCEWIDGET_H +#define PRIMARYINSTANCEWIDGET_H + +#include <QWidget> + +QT_BEGIN_NAMESPACE +class QListWidget; +QT_END_NAMESPACE + +class PrimaryInstanceWidget : public QWidget +{ + Q_OBJECT + +public: + explicit PrimaryInstanceWidget(QWidget *parent = nullptr); + +public Q_SLOTS: + void addMessage(const QByteArray &message); + +private: + QListWidget *m_messagesListWidget = nullptr; +}; + +#endif // PRIMARYINSTANCEWIDGET_H diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/examples/widgetsingleapplication/secondaryinstancewidget.cpp b/3rdparty/kdsingleapplication/KDSingleApplication/examples/widgetsingleapplication/secondaryinstancewidget.cpp new file mode 100644 index 0000000..6047d9c --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/examples/widgetsingleapplication/secondaryinstancewidget.cpp @@ -0,0 +1,58 @@ +/* + This file is part of KDSingleApplication. + + SPDX-FileCopyrightText: 2019-2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> + + SPDX-License-Identifier: MIT + + Contact KDAB at <info@kdab.com> for commercial licensing options. +*/ + +#include "secondaryinstancewidget.h" + +#include <kdsingleapplication.h> + +#include <QtWidgets/QLabel> +#include <QtWidgets/QLineEdit> +#include <QtWidgets/QPushButton> +#include <QtWidgets/QGridLayout> + +#include <QtWidgets/QMessageBox> + +SecondaryInstanceWidget::SecondaryInstanceWidget(KDSingleApplication *kdsa, QWidget *parent) + : QWidget(parent) + , m_kdsa(kdsa) +{ + setWindowTitle(tr("Secondary instance")); + QLabel *label = new QLabel(tr("<b>Secondary instance.</b> Send message to primary:")); + m_messageEdit = new QLineEdit; + m_messageEdit->setPlaceholderText(tr("Type something here...")); + + QPushButton *sendButton = new QPushButton(tr("&Send")); + + QGridLayout *layout = new QGridLayout; + layout->addWidget(label, 0, 0, 1, 2); + layout->addWidget(m_messageEdit, 1, 0); + layout->addWidget(sendButton, 1, 1); + + setLayout(layout); + + connect(m_messageEdit, &QLineEdit::returnPressed, this, &SecondaryInstanceWidget::sendMessage); + connect(m_messageEdit, &QLineEdit::textChanged, + this, [sendButton](const QString &text) { sendButton->setEnabled(!text.isEmpty()); }); + connect(sendButton, &QPushButton::clicked, this, &SecondaryInstanceWidget::sendMessage); +} + +void SecondaryInstanceWidget::sendMessage() +{ + const QString message = m_messageEdit->text(); + if (!message.isEmpty()) { + if (m_kdsa->sendMessageWithTimeout(message.toUtf8(), 1000)) { + m_messageEdit->clear(); + } else { + QMessageBox::warning(this, + tr("Error sending message"), + tr("The message '%1' could not be sent to the primary.").arg(message)); + } + } +} diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/examples/widgetsingleapplication/secondaryinstancewidget.h b/3rdparty/kdsingleapplication/KDSingleApplication/examples/widgetsingleapplication/secondaryinstancewidget.h new file mode 100644 index 0000000..1fddd8e --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/examples/widgetsingleapplication/secondaryinstancewidget.h @@ -0,0 +1,36 @@ +/* + This file is part of KDSingleApplication. + + SPDX-FileCopyrightText: 2019-2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> + + SPDX-License-Identifier: MIT + + Contact KDAB at <info@kdab.com> for commercial licensing options. +*/ + +#ifndef SECONDARYINSTANCEWIDGET_H +#define SECONDARYINSTANCEWIDGET_H + +#include <QWidget> + +QT_BEGIN_NAMESPACE +class QLineEdit; +QT_END_NAMESPACE + +class KDSingleApplication; + +class SecondaryInstanceWidget : public QWidget +{ + Q_OBJECT + +public: + explicit SecondaryInstanceWidget(KDSingleApplication *kdsa, + QWidget *parent = nullptr); + +private: + void sendMessage(); + KDSingleApplication *m_kdsa = nullptr; + QLineEdit *m_messageEdit = nullptr; +}; + +#endif // SECONDARYINSTANCEWIDGET_H diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/src/CMakeLists.txt b/3rdparty/kdsingleapplication/KDSingleApplication/src/CMakeLists.txt new file mode 100644 index 0000000..7c68880 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/src/CMakeLists.txt @@ -0,0 +1,117 @@ +# This file is part of KDSingleApplication. +# +# SPDX-FileCopyrightText: 2020-2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> +# +# SPDX-License-Identifier: MIT +# +# Contact KDAB at <info@kdab.com> for commercial licensing options. +# +set(KDSINGLEAPPLICATION_SRCS kdsingleapplication.cpp kdsingleapplication_localsocket.cpp) + +set(KDSINGLEAPPLICATION_INSTALLABLE_INCLUDES kdsingleapplication.h kdsingleapplication_lib.h) + +set(KDSINGLEAPPLICATION_NON_INSTALLABLE_INCLUDES kdsingleapplication_localsocket_p.h) + +if(${PROJECT_NAME}_STATIC) + add_library(kdsingleapplication STATIC ${KDSINGLEAPPLICATION_INSTALLABLE_INCLUDES} ${KDSINGLEAPPLICATION_SRCS}) + target_compile_definitions(kdsingleapplication PUBLIC KDSINGLEAPPLICATION_STATIC_BUILD) +else() + add_library(kdsingleapplication SHARED ${KDSINGLEAPPLICATION_INSTALLABLE_INCLUDES} ${KDSINGLEAPPLICATION_SRCS}) + target_compile_definitions(kdsingleapplication PRIVATE KDSINGLEAPPLICATION_SHARED_BUILD) +endif() +add_library( + KDAB::kdsingleapplication ALIAS kdsingleapplication +) +set_target_properties( + kdsingleapplication PROPERTIES OUTPUT_NAME "kdsingleapplication${KDSingleApplication_LIBRARY_QTID}" +) + +target_include_directories( + kdsingleapplication + PUBLIC $<INSTALL_INTERFACE:${KDSINGLEAPPLICATION_INCLUDEDIR}> $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}> + PRIVATE ${CMAKE_CURRENT_SOURCE_DIR} +) + +if(WIN32) + target_link_libraries(kdsingleapplication PRIVATE kernel32) +endif() +target_link_libraries( + kdsingleapplication + PUBLIC Qt::Core + PRIVATE Qt::Network +) + +install( + FILES ${KDSINGLEAPPLICATION_INSTALLABLE_INCLUDES} + DESTINATION ${KDSINGLEAPPLICATION_INCLUDEDIR} +) + +install( + TARGETS kdsingleapplication + EXPORT kdsingleapplicationTargets + RUNTIME DESTINATION ${INSTALL_RUNTIME_DIR} + LIBRARY DESTINATION ${INSTALL_LIBRARY_DIR} + ARCHIVE DESTINATION ${INSTALL_ARCHIVE_DIR} +) + +if(${PROJECT_NAME}_IS_ROOT_PROJECT) + install( + EXPORT kdsingleapplicationTargets + FILE KDSingleApplicationTargets.cmake + NAMESPACE KDAB:: + DESTINATION ${INSTALL_LIBRARY_DIR}/cmake/KDSingleApplication${KDSingleApplication_LIBRARY_QTID} + ) + configure_file( + KDSingleApplicationConfig.cmake.in KDSingleApplication${KDSingleApplication_LIBRARY_QTID}Config.cmake @ONLY + ) + install( + FILES "${CMAKE_CURRENT_BINARY_DIR}/KDSingleApplication${KDSingleApplication_LIBRARY_QTID}Config.cmake" + "${CMAKE_CURRENT_BINARY_DIR}/KDSingleApplication${KDSingleApplication_LIBRARY_QTID}ConfigVersion.cmake" + DESTINATION "${INSTALL_LIBRARY_DIR}/cmake/KDSingleApplication${KDSingleApplication_LIBRARY_QTID}" + ) + + include(ECMGenerateHeaders) + ecm_generate_headers( + kdsingleapplication_HEADERS + HEADER_NAMES + KDSingleApplication + OUTPUT_DIR + ${CMAKE_CURRENT_BINARY_DIR}/KDSingleApplication + ) + + install(FILES ${kdsingleapplication_HEADERS} DESTINATION ${KDSINGLEAPPLICATION_INCLUDEDIR}) + + if(MSVC AND NOT ${PROJECT_NAME}_STATIC) + install( + FILES "$<TARGET_PDB_FILE_DIR:kdsingleapplication>/$<TARGET_PDB_FILE_NAME:kdsingleapplication>" + DESTINATION ${INSTALL_LIBRARY_DIR} + CONFIGURATIONS Debug RelWithDebInfo + ) + endif() +endif() + +# Generate library version files +include(ECMSetupVersion) +ecm_setup_version( + ${${PROJECT_NAME}_VERSION} + VARIABLE_PREFIX + KDSINGLEAPPLICATION + VERSION_HEADER + "${CMAKE_CURRENT_BINARY_DIR}/kdsingleapplication_version.h" + PACKAGE_VERSION_FILE + "${CMAKE_CURRENT_BINARY_DIR}/KDSingleApplication${KDSingleApplication_LIBRARY_QTID}ConfigVersion.cmake" + SOVERSION + ${${PROJECT_NAME}_SOVERSION} + COMPATIBILITY + AnyNewerVersion +) +install( + FILES "${CMAKE_CURRENT_BINARY_DIR}/kdsingleapplication_version.h" + DESTINATION ${KDSINGLEAPPLICATION_INCLUDEDIR} +) +install( + EXPORT kdsingleapplicationTargets + FILE KDSingleApplication${KDSingleApplication_LIBRARY_QTID}Targets.cmake + NAMESPACE KDAB:: + DESTINATION ${INSTALL_LIBRARY_DIR}/cmake/KDSingleApplication${KDSingleApplication_LIBRARY_QTID} +) diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/src/KDSingleApplicationConfig.cmake.in b/3rdparty/kdsingleapplication/KDSingleApplication/src/KDSingleApplicationConfig.cmake.in new file mode 100644 index 0000000..9f72e72 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/src/KDSingleApplicationConfig.cmake.in @@ -0,0 +1,15 @@ +# This file is part of KDSingleApplication. +# +# SPDX-FileCopyrightText: 2020-2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> +# +# SPDX-License-Identifier: MIT +# +# Contact KDAB at <info@kdab.com> for commercial licensing options. +# +include(CMakeFindDependencyMacro) + +find_dependency(Qt@QT_VERSION_MAJOR@Widgets REQUIRED) +find_dependency(Qt@QT_VERSION_MAJOR@Network REQUIRED) + +# Add the targets file +include("${CMAKE_CURRENT_LIST_DIR}/KDSingleApplication@KDSingleApplication_LIBRARY_QTID@Targets.cmake") diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/src/kdsingleapplication.cpp b/3rdparty/kdsingleapplication/KDSingleApplication/src/kdsingleapplication.cpp new file mode 100644 index 0000000..d0945bb --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/src/kdsingleapplication.cpp @@ -0,0 +1,112 @@ +/* + This file is part of KDSingleApplication. + + SPDX-FileCopyrightText: 2019-2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> + + SPDX-License-Identifier: MIT + + Contact KDAB at <info@kdab.com> for commercial licensing options. +*/ + +#include "kdsingleapplication.h" + +#include <QtCore/QCoreApplication> +#include <QtCore/QFileInfo> + +// TODO: make this pluggable. +#include "kdsingleapplication_localsocket_p.h" + +// Avoiding dragging in Qt private APIs for now, so this does not inherit +// from QObjectPrivate. +class KDSingleApplicationPrivate +{ +public: + explicit KDSingleApplicationPrivate(const QString &name, KDSingleApplication::Options options, KDSingleApplication *q); + + QString name() const + { + return m_name; + } + + bool isPrimaryInstance() const + { + return m_impl.isPrimaryInstance(); + } + + bool sendMessage(const QByteArray &message, int timeout) + { + return m_impl.sendMessage(message, timeout); + } + +private: + Q_DECLARE_PUBLIC(KDSingleApplication) + + KDSingleApplication *q_ptr; + QString m_name; + + KDSingleApplicationLocalSocket m_impl; +}; + +KDSingleApplicationPrivate::KDSingleApplicationPrivate(const QString &name, KDSingleApplication::Options options, KDSingleApplication *q) + : q_ptr(q) + , m_name(name) + , m_impl(name, options) +{ + if (Q_UNLIKELY(name.isEmpty())) + qFatal("KDSingleApplication requires a non-empty application name"); + + if (isPrimaryInstance()) { + QObject::connect(&m_impl, &KDSingleApplicationLocalSocket::messageReceived, + q, &KDSingleApplication::messageReceived); + } +} + +static QString extractExecutableName(const QString &applicationFilePath) +{ + return QFileInfo(applicationFilePath).fileName(); +} + +KDSingleApplication::KDSingleApplication(QObject *parent) + : KDSingleApplication(extractExecutableName(QCoreApplication::applicationFilePath()), parent) +{ +} + +KDSingleApplication::KDSingleApplication(const QString &name, QObject *parent) + : QObject(parent) + , d_ptr(new KDSingleApplicationPrivate(name, Option::IncludeUsernameInSocketName | Option::IncludeSessionInSocketName, this)) +{ +} + +KDSingleApplication::KDSingleApplication(const QString &name, Options options, QObject *parent) + : QObject(parent) + , d_ptr(new KDSingleApplicationPrivate(name, options, this)) +{ +} + +QString KDSingleApplication::name() const +{ + Q_D(const KDSingleApplication); + return d->name(); +} + +bool KDSingleApplication::isPrimaryInstance() const +{ + Q_D(const KDSingleApplication); + return d->isPrimaryInstance(); +} + +bool KDSingleApplication::sendMessage(const QByteArray &message) +{ + return sendMessageWithTimeout(message, 5000); +} + +bool KDSingleApplication::sendMessageWithTimeout(const QByteArray &message, int timeout) +{ + Q_ASSERT(!isPrimaryInstance()); + + Q_D(KDSingleApplication); + return d->sendMessage(message, timeout); +} + + +KDSingleApplication::~KDSingleApplication() = default; diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/src/kdsingleapplication.h b/3rdparty/kdsingleapplication/KDSingleApplication/src/kdsingleapplication.h new file mode 100644 index 0000000..e8cc35c --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/src/kdsingleapplication.h @@ -0,0 +1,61 @@ +/* + This file is part of KDSingleApplication. + + SPDX-FileCopyrightText: 2019-2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> + + SPDX-License-Identifier: MIT + + Contact KDAB at <info@kdab.com> for commercial licensing options. +*/ +#ifndef KDSINGLEAPPLICATION_H +#define KDSINGLEAPPLICATION_H + +#include <QtCore/QObject> +#include <QtCore/QFlags> + +#include <memory> + +#include "kdsingleapplication_lib.h" + +class KDSingleApplicationPrivate; + +class KDSINGLEAPPLICATION_EXPORT KDSingleApplication : public QObject +{ + Q_OBJECT + Q_PROPERTY(QString name READ name CONSTANT) + Q_PROPERTY(bool isPrimaryInstance READ isPrimaryInstance CONSTANT) + +public: + // IncludeUsernameInSocketName - Include the username in the socket name. + // IncludeSessionInSocketName - Include the graphical session in the socket name. + enum class Option { + None = 0x0, + IncludeUsernameInSocketName = 0x1, + IncludeSessionInSocketName = 0x2, + }; + Q_DECLARE_FLAGS(Options, Option) + + explicit KDSingleApplication(QObject *parent = nullptr); + explicit KDSingleApplication(const QString &name, QObject *parent = nullptr); + explicit KDSingleApplication(const QString &name, Options options, QObject *parent = nullptr); + ~KDSingleApplication(); + + QString name() const; + bool isPrimaryInstance() const; + +public Q_SLOTS: + // avoid default arguments and overloads, as they don't mix with connections + bool sendMessage(const QByteArray &message); + bool sendMessageWithTimeout(const QByteArray &message, int timeout); + +Q_SIGNALS: + void messageReceived(const QByteArray &message); + +private: + Q_DECLARE_PRIVATE(KDSingleApplication) + std::unique_ptr<KDSingleApplicationPrivate> d_ptr; +}; + +Q_DECLARE_OPERATORS_FOR_FLAGS(KDSingleApplication::Options) + +#endif // KDSINGLEAPPLICATION_H diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/src/kdsingleapplication_lib.h b/3rdparty/kdsingleapplication/KDSingleApplication/src/kdsingleapplication_lib.h new file mode 100644 index 0000000..060dd67 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/src/kdsingleapplication_lib.h @@ -0,0 +1,23 @@ +/* + This file is part of KDSingleApplication. + + SPDX-FileCopyrightText: 2019-2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> + + SPDX-License-Identifier: MIT + + Contact KDAB at <info@kdab.com> for commercial licensing options. +*/ +#ifndef KDSINGLEAPPLICATION_LIB_H +#define KDSINGLEAPPLICATION_LIB_H + +#include <QtCore/QtGlobal> + +#if defined(KDSINGLEAPPLICATION_STATIC_BUILD) +#define KDSINGLEAPPLICATION_EXPORT +#elif defined(KDSINGLEAPPLICATION_SHARED_BUILD) +#define KDSINGLEAPPLICATION_EXPORT Q_DECL_EXPORT +#else +#define KDSINGLEAPPLICATION_EXPORT Q_DECL_IMPORT +#endif + +#endif // KDSINGLEAPPLICATION_LIB_H diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/src/kdsingleapplication_localsocket.cpp b/3rdparty/kdsingleapplication/KDSingleApplication/src/kdsingleapplication_localsocket.cpp new file mode 100644 index 0000000..fc10cad --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/src/kdsingleapplication_localsocket.cpp @@ -0,0 +1,340 @@ +/* + This file is part of KDSingleApplication. + + SPDX-FileCopyrightText: 2019-2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> + + SPDX-License-Identifier: MIT + + Contact KDAB at <info@kdab.com> for commercial licensing options. +*/ + +#include "kdsingleapplication_localsocket_p.h" + +#include <QtCore/QDir> +#include <QtCore/QDeadlineTimer> +#include <QtCore/QTimer> +#include <QtCore/QLockFile> +#include <QtCore/QDataStream> + +#include <QtCore/QtDebug> +#include <QtCore/QLoggingCategory> + +#include <QtNetwork/QLocalServer> +#include <QtNetwork/QLocalSocket> + +#include <chrono> +#include <algorithm> + +#if defined(Q_OS_UNIX) +// for ::getuid() +#include <sys/types.h> +#include <unistd.h> +#include <pwd.h> +#endif + +#if defined(Q_OS_WIN) +#include <qt_windows.h> +#include <lmcons.h> +#endif + +#include "kdsingleapplication.h" + +static const auto LOCALSOCKET_CONNECTION_TIMEOUT = std::chrono::seconds(5); +static const char LOCALSOCKET_PROTOCOL_VERSION = 2; + +Q_LOGGING_CATEGORY(kdsaLocalSocket, "kdsingleapplication.localsocket", QtWarningMsg); + +KDSingleApplicationLocalSocket::KDSingleApplicationLocalSocket(const QString &name, KDSingleApplication::Options options, QObject *parent) + : QObject(parent) +{ + + m_socketName = QStringLiteral("kdsingleapp"); + +#if defined(Q_OS_UNIX) + /* cppcheck-suppress useInitializationList */ + if (options.testFlag(KDSingleApplication::Option::IncludeUsernameInSocketName)) { + m_socketName += QStringLiteral("-"); + uid_t uid = ::getuid(); + struct passwd *pw = ::getpwuid(uid); + if (pw) { + QString username = QString::fromUtf8(pw->pw_name); + m_socketName += username; + } else { + m_socketName += QString::number(uid); + } + } + if (options.testFlag(KDSingleApplication::Option::IncludeSessionInSocketName)) { + QString sessionId = qEnvironmentVariable("XDG_SESSION_ID"); + if (!sessionId.isEmpty()) { + m_socketName += QStringLiteral("-"); + m_socketName += sessionId; + } + } +#elif defined(Q_OS_WIN) + // I'm not sure of a "global session identifier" on Windows; are + // multiple logins from the same user a possibility? For now, following this: + // https://docs.microsoft.com/en-us/windows/desktop/devnotes/getting-the-session-id-of-the-current-process + if (options.testFlag(KDSingleApplication::Option::IncludeUsernameInSocketName)) { + DWORD usernameLen = UNLEN + 1; + wchar_t username[UNLEN + 1]; + if (GetUserNameW(username, &usernameLen)) { + m_socketName += QStringLiteral("-"); + m_socketName += QString::fromWCharArray(username); + } + } + if (options.testFlag(KDSingleApplication::Option::IncludeSessionInSocketName)) { + DWORD sessionId; + BOOL haveSessionId = ProcessIdToSessionId(GetCurrentProcessId(), &sessionId); + if (haveSessionId) { + m_socketName += QStringLiteral("-"); + m_socketName += QString::number(sessionId); + } + } +#else +#error "KDSingleApplication has not been ported to this platform" +#endif + + m_socketName += QStringLiteral("-"); + m_socketName += name; + + const QString lockFilePath = + QDir::tempPath() + QLatin1Char('/') + m_socketName + QLatin1String(".lock"); + + qCDebug(kdsaLocalSocket) << "Socket name is" << m_socketName; + qCDebug(kdsaLocalSocket) << "Lock file path is" << lockFilePath; + + std::unique_ptr<QLockFile> lockFile(new QLockFile(lockFilePath)); + lockFile->setStaleLockTime(0); + + if (!lockFile->tryLock()) { + // someone else has the lock => we're secondary + qCDebug(kdsaLocalSocket) << "Secondary instance"; + return; + } + + qCDebug(kdsaLocalSocket) << "Primary instance"; + + std::unique_ptr<QLocalServer> server = std::make_unique<QLocalServer>(); + if (!server->listen(m_socketName)) { + // maybe the primary crashed, leaving a stale socket; delete it and try again + QLocalServer::removeServer(m_socketName); + if (!server->listen(m_socketName)) { + // TODO: better error handling. + qWarning("KDSingleApplication: unable to make the primary instance listen on %ls: %ls", + qUtf16Printable(m_socketName), + qUtf16Printable(server->errorString())); + + return; + } + } + + connect(server.get(), &QLocalServer::newConnection, + this, &KDSingleApplicationLocalSocket::handleNewConnection); + + m_lockFile = std::move(lockFile); + m_localServer = std::move(server); +} + +KDSingleApplicationLocalSocket::~KDSingleApplicationLocalSocket() = default; + +bool KDSingleApplicationLocalSocket::isPrimaryInstance() const +{ + return m_localServer != nullptr; +} + +bool KDSingleApplicationLocalSocket::sendMessage(const QByteArray &message, int timeout) +{ + Q_ASSERT(!isPrimaryInstance()); + QLocalSocket socket; + + qCDebug(kdsaLocalSocket) << "Preparing to send message" << message << "with timeout" << timeout; + + QDeadlineTimer deadline(timeout); + + // There is an inherent race here with the setup of the server side. + // Even if the socket lock is held by the server, the server may not + // be listening yet. So this connection may fail; keep retrying + // until we hit the timeout. + do { + socket.connectToServer(m_socketName); + if (socket.waitForConnected(deadline.remainingTime())) + break; + } while (!deadline.hasExpired()); + + qCDebug(kdsaLocalSocket) << "Socket state:" << socket.state() << "Timer remaining" << deadline.remainingTime() << "Expired?" << deadline.hasExpired(); + + if (deadline.hasExpired()) { + qCWarning(kdsaLocalSocket) << "Connection timed out"; + return false; + } + + socket.write(&LOCALSOCKET_PROTOCOL_VERSION, 1); + + { + QByteArray encodedMessage; + QDataStream ds(&encodedMessage, QIODevice::WriteOnly); + ds << message; + socket.write(encodedMessage); + } + + qCDebug(kdsaLocalSocket) << "Wrote message in the socket" + << "Timer remaining" << deadline.remainingTime() << "Expired?" << deadline.hasExpired(); + + // There is no acknowledgement mechanism here. + // Should there be one? + + while (socket.bytesToWrite() > 0) { + if (!socket.waitForBytesWritten(deadline.remainingTime())) { + qCWarning(kdsaLocalSocket) << "Message to primary timed out"; + return false; + } + } + + qCDebug(kdsaLocalSocket) << "Bytes written, now disconnecting" + << "Timer remaining" << deadline.remainingTime() << "Expired?" << deadline.hasExpired(); + + socket.disconnectFromServer(); + + if (socket.state() == QLocalSocket::UnconnectedState) { + qCDebug(kdsaLocalSocket) << "Disconnected -- success!"; + return true; + } + + if (!socket.waitForDisconnected(deadline.remainingTime())) { + qCWarning(kdsaLocalSocket) << "Disconnection from primary timed out"; + return false; + } + + qCDebug(kdsaLocalSocket) << "Disconnected -- success!"; + + return true; +} + +void KDSingleApplicationLocalSocket::handleNewConnection() +{ + Q_ASSERT(m_localServer); + + QLocalSocket *socket; + while ((socket = m_localServer->nextPendingConnection())) { + qCDebug(kdsaLocalSocket) << "Got new connection on" << m_socketName << "state" << socket->state(); + + Connection c(socket); + socket = c.socket.get(); + + c.readDataConnection = QObjectConnectionHolder( + connect(socket, &QLocalSocket::readyRead, + this, &KDSingleApplicationLocalSocket::readDataFromSecondary)); + + c.secondaryDisconnectedConnection = QObjectConnectionHolder( + connect(socket, &QLocalSocket::disconnected, + this, &KDSingleApplicationLocalSocket::secondaryDisconnected)); + + c.abortConnection = QObjectConnectionHolder( + connect(c.timeoutTimer.get(), &QTimer::timeout, + this, &KDSingleApplicationLocalSocket::abortConnectionToSecondary)); + + m_clients.push_back(std::move(c)); + + // Note that by the time we get here, the socket could've already been closed, + // and no signals emitted (hello, Windows!). Read what's already in the socket. + if (readDataFromSecondarySocket(socket)) + return; + + if (socket->state() == QLocalSocket::UnconnectedState) + secondarySocketDisconnected(socket); + } +} + +template<typename Container> +static auto findConnectionBySocket(Container &container, QLocalSocket *socket) +{ + auto i = std::find_if(container.begin(), + container.end(), + [socket](const auto &c) { return c.socket.get() == socket; }); + Q_ASSERT(i != container.end()); + return i; +} + +template<typename Container> +static auto findConnectionByTimer(Container &container, QTimer *timer) +{ + auto i = std::find_if(container.begin(), + container.end(), + [timer](const auto &c) { return c.timeoutTimer.get() == timer; }); + Q_ASSERT(i != container.end()); + return i; +} + +void KDSingleApplicationLocalSocket::readDataFromSecondary() +{ + QLocalSocket *socket = static_cast<QLocalSocket *>(sender()); + readDataFromSecondarySocket(socket); +} + +bool KDSingleApplicationLocalSocket::readDataFromSecondarySocket(QLocalSocket *socket) +{ + auto i = findConnectionBySocket(m_clients, socket); + Connection &c = *i; + c.readData.append(socket->readAll()); + + qCDebug(kdsaLocalSocket) << "Got more data from a secondary. Data read so far:" << c.readData; + + const QByteArray &data = c.readData; + + if (data.size() >= 1) { + if (data[0] != LOCALSOCKET_PROTOCOL_VERSION) { + qCDebug(kdsaLocalSocket) << "Got an invalid protocol version"; + m_clients.erase(i); + return true; + } + } + + QDataStream ds(data); + ds.skipRawData(1); + + ds.startTransaction(); + QByteArray message; + ds >> message; + + if (ds.commitTransaction()) { + qCDebug(kdsaLocalSocket) << "Got a complete message:" << message; + Q_EMIT messageReceived(message); + m_clients.erase(i); + return true; + } + + return false; +} + +void KDSingleApplicationLocalSocket::secondaryDisconnected() +{ + QLocalSocket *socket = static_cast<QLocalSocket *>(sender()); + secondarySocketDisconnected(socket); +} + +void KDSingleApplicationLocalSocket::secondarySocketDisconnected(QLocalSocket *socket) +{ + auto i = findConnectionBySocket(m_clients, socket); + Connection c = std::move(*i); + m_clients.erase(i); + + qCDebug(kdsaLocalSocket) << "Secondary disconnected. Data read:" << c.readData; +} + +void KDSingleApplicationLocalSocket::abortConnectionToSecondary() +{ + QTimer *timer = static_cast<QTimer *>(sender()); + + auto i = findConnectionByTimer(m_clients, timer); + Connection c = std::move(*i); + m_clients.erase(i); + + qCDebug(kdsaLocalSocket) << "Secondary timed out. Data read:" << c.readData; +} + +KDSingleApplicationLocalSocket::Connection::Connection(QLocalSocket *_socket) + : socket(_socket) + , timeoutTimer(new QTimer) +{ + timeoutTimer->start(LOCALSOCKET_CONNECTION_TIMEOUT); +} diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/src/kdsingleapplication_localsocket_p.h b/3rdparty/kdsingleapplication/KDSingleApplication/src/kdsingleapplication_localsocket_p.h new file mode 100644 index 0000000..2c58616 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/src/kdsingleapplication_localsocket_p.h @@ -0,0 +1,129 @@ +/* + This file is part of KDSingleApplication. + + SPDX-FileCopyrightText: 2019-2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> + + SPDX-License-Identifier: MIT + + Contact KDAB at <info@kdab.com> for commercial licensing options. +*/ + +#ifndef KDSINGLEAPPLICATION_LOCALSOCKET_P_H +#define KDSINGLEAPPLICATION_LOCALSOCKET_P_H + +#include <QtCore/QObject> +#include <QtCore/QByteArray> +#include <QtCore/QString> + +QT_BEGIN_NAMESPACE +class QLockFile; +class QLocalServer; +class QLocalSocket; +class QTimer; +QT_END_NAMESPACE + +#include <memory> +#include <vector> + +#include "kdsingleapplication.h" + +struct QObjectDeleteLater +{ + void operator()(QObject *o) + { + o->deleteLater(); + } +}; + +class QObjectConnectionHolder +{ + Q_DISABLE_COPY(QObjectConnectionHolder) + QMetaObject::Connection c; + +public: + QObjectConnectionHolder() + { + } + + explicit QObjectConnectionHolder(QMetaObject::Connection _c) + : c(std::move(_c)) + { + } + + ~QObjectConnectionHolder() + { + QObject::disconnect(c); + } + + QObjectConnectionHolder(QObjectConnectionHolder &&other) noexcept + : c(std::exchange(other.c, {})) + { + } + + QObjectConnectionHolder &operator=(QObjectConnectionHolder &&other) noexcept + { + QObjectConnectionHolder moved(std::move(other)); + swap(moved); + return *this; + } + + void swap(QObjectConnectionHolder &other) noexcept + { + using std::swap; + swap(c, other.c); + } +}; + +class KDSingleApplicationLocalSocket : public QObject +{ + Q_OBJECT + +public: + explicit KDSingleApplicationLocalSocket(const QString &name, + KDSingleApplication::Options options, + QObject *parent = nullptr); + ~KDSingleApplicationLocalSocket(); + + bool isPrimaryInstance() const; + +public Q_SLOTS: + bool sendMessage(const QByteArray &message, int timeout); + +Q_SIGNALS: + void messageReceived(const QByteArray &message); + +private: + void handleNewConnection(); + void readDataFromSecondary(); + bool readDataFromSecondarySocket(QLocalSocket *socket); + void secondaryDisconnected(); + void secondarySocketDisconnected(QLocalSocket *socket); + void abortConnectionToSecondary(); + + QString m_socketName; + + std::unique_ptr<QLockFile> m_lockFile; // protects m_localServer + std::unique_ptr<QLocalServer> m_localServer; + + struct Connection + { + explicit Connection(QLocalSocket *s); + + std::unique_ptr<QLocalSocket, QObjectDeleteLater> socket; + std::unique_ptr<QTimer, QObjectDeleteLater> timeoutTimer; + QByteArray readData; + + // socket/timeoutTimer are deleted via deleteLater (as we delete them + // in slots connected to their signals). Before the deleteLater is acted upon, + // they may emit further signals, triggering logic that it's not supposed + // to be triggered (as the Connection has already been destroyed). + // Use this Holder to break the connections. + QObjectConnectionHolder readDataConnection; + QObjectConnectionHolder secondaryDisconnectedConnection; + QObjectConnectionHolder abortConnection; + }; + + std::vector<Connection> m_clients; +}; + +#endif // KDSINGLEAPPLICATION_LOCALSOCKET_P_H diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/tests/CMakeLists.txt b/3rdparty/kdsingleapplication/KDSingleApplication/tests/CMakeLists.txt new file mode 100644 index 0000000..ba594a7 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/tests/CMakeLists.txt @@ -0,0 +1,10 @@ +# This file is part of KDSingleApplication. +# +# SPDX-FileCopyrightText: 2020-2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> +# +# SPDX-License-Identifier: MIT +# +# Contact KDAB at <info@kdab.com> for commercial licensing options. +# +add_subdirectory(auto) +add_subdirectory(manual) diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/tests/auto/CMakeLists.txt b/3rdparty/kdsingleapplication/KDSingleApplication/tests/auto/CMakeLists.txt new file mode 100644 index 0000000..b2516d2 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/tests/auto/CMakeLists.txt @@ -0,0 +1,10 @@ +# This file is part of KDSingleApplication. +# +# SPDX-FileCopyrightText: 2020-2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> +# +# SPDX-License-Identifier: MIT +# +# Contact KDAB at <info@kdab.com> for commercial licensing options. +# +add_subdirectory(simpletest) +add_subdirectory(stresstest) diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/tests/auto/simpletest/CMakeLists.txt b/3rdparty/kdsingleapplication/KDSingleApplication/tests/auto/simpletest/CMakeLists.txt new file mode 100644 index 0000000..18a1f99 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/tests/auto/simpletest/CMakeLists.txt @@ -0,0 +1,10 @@ +# This file is part of KDSingleApplication. +# +# SPDX-FileCopyrightText: 2020-2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> +# +# SPDX-License-Identifier: MIT +# +# Contact KDAB at <info@kdab.com> for commercial licensing options. +# +add_subdirectory(simpletest) +add_subdirectory(test) diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/tests/auto/simpletest/simpletest/CMakeLists.txt b/3rdparty/kdsingleapplication/KDSingleApplication/tests/auto/simpletest/simpletest/CMakeLists.txt new file mode 100644 index 0000000..ebb43de --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/tests/auto/simpletest/simpletest/CMakeLists.txt @@ -0,0 +1,16 @@ +# This file is part of KDSingleApplication. +# +# SPDX-FileCopyrightText: 2020-2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> +# +# SPDX-License-Identifier: MIT +# +# Contact KDAB at <info@kdab.com> for commercial licensing options. +# +set(simpletest_SRCS main.cpp) +add_executable( + simpletest + ${simpletest_SRCS} +) +target_link_libraries( + simpletest Qt::Widgets kdsingleapplication +) diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/tests/auto/simpletest/simpletest/main.cpp b/3rdparty/kdsingleapplication/KDSingleApplication/tests/auto/simpletest/simpletest/main.cpp new file mode 100644 index 0000000..d3aef3d --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/tests/auto/simpletest/simpletest/main.cpp @@ -0,0 +1,59 @@ +/* + This file is part of KDSingleApplication. + + SPDX-FileCopyrightText: 2019-2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> + + SPDX-License-Identifier: MIT + + Contact KDAB at <info@kdab.com> for commercial licensing options. +*/ + +#include <QtCore/QCoreApplication> +#include <QtCore/QStringList> +#include <QtCore/QString> +#include <QtCore/QTimer> + +#include <kdsingleapplication.h> + +#include <iostream> + +#if defined(Q_OS_WIN) +#include <io.h> +#include <fcntl.h> +#endif + +int main(int argc, char **argv) +{ +#if defined(Q_OS_WIN) + _setmode(_fileno(stdout), _O_BINARY); +#endif + + QCoreApplication app(argc, argv); + + const QString appName = QLatin1String("simpletest-") + app.arguments().value(1); + + KDSingleApplication kdsa(appName); + + if (kdsa.isPrimaryInstance()) { + std::cout << "Primary" << std::endl; + + QObject::connect(&kdsa, &KDSingleApplication::messageReceived, + [](const QByteArray &message) { + std::cout << "MESSAGE: >" << message.constData() << '<' << std::endl; + qApp->quit(); + }); + + QTimer::singleShot(5000, []() { qApp->exit(1); }); + + return app.exec(); + } else { + std::cout << "Secondary" << std::endl; + + if (!kdsa.sendMessage(app.arguments().value(2).toUtf8())) { + std::cerr << "Unable to send message to the primary!" << std::endl; + return 1; + } + } + + return 0; +} diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/tests/auto/simpletest/test/CMakeLists.txt b/3rdparty/kdsingleapplication/KDSingleApplication/tests/auto/simpletest/test/CMakeLists.txt new file mode 100644 index 0000000..196d9d3 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/tests/auto/simpletest/test/CMakeLists.txt @@ -0,0 +1,19 @@ +# This file is part of KDSingleApplication. +# +# SPDX-FileCopyrightText: 2020-2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> +# +# SPDX-License-Identifier: MIT +# +# Contact KDAB at <info@kdab.com> for commercial licensing options. +# +include_directories(${CMAKE_SOURCE_DIR}/src) +include_directories(${CMAKE_CURRENT_BINARY_DIR}) + +add_executable( + tst_simpletest + ../tst_simpletest.cpp +) +target_link_libraries( + tst_simpletest Qt::Test +) +add_test(NAME tst_simpletest COMMAND tst_simpletest) diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/tests/auto/simpletest/tst_simpletest.cpp b/3rdparty/kdsingleapplication/KDSingleApplication/tests/auto/simpletest/tst_simpletest.cpp new file mode 100644 index 0000000..35f4d0f --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/tests/auto/simpletest/tst_simpletest.cpp @@ -0,0 +1,102 @@ +/* + This file is part of KDSingleApplication. + + SPDX-FileCopyrightText: 2019-2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> + + SPDX-License-Identifier: MIT + + Contact KDAB at <info@kdab.com> for commercial licensing options. +*/ + +#include <QtCore/QProcess> +#include <QtCore/QRandomGenerator> +#include <QtTest/QTest> + + +#include <vector> +#include <memory> + +// runs a primary, runs a secondary, checks that a message is received. + +class tst_SimpleTest : public QObject +{ + Q_OBJECT +private Q_SLOTS: + void testSimple_data(); + void testSimple(); +}; + +void tst_SimpleTest::testSimple_data() +{ + QTest::addColumn<QString>("message"); + + QTest::addRow("message-1") << QStringLiteral("Hello"); + QTest::addRow("message-2") << QStringLiteral("Hello World"); + QTest::addRow("message-3") << QStringLiteral("Hello World 123456789"); + // QTest::addRow("message empty") << QString(); + + for (int i = 1; i <= 2048; i *= 2) { + QTest::addRow("message-x-%d", i) << QString(i, QLatin1Char('x')); + } +} + +void tst_SimpleTest::testSimple() +{ + QFETCH(QString, message); +#ifdef KDSINGLEAPPLICATION_BINARY_DIR + const QString executable = QStringLiteral(KDSINGLEAPPLICATION_BINARY_DIR "simpletest"); +#else + const QString executable = QStringLiteral("simpletest/simpletest"); +#endif + QByteArray output; + bool ok; + + const QString testId = QString::number(QRandomGenerator::global()->generate()); + + QProcess primary; + primary.setProcessChannelMode(QProcess::ForwardedErrorChannel); + primary.start(executable, { testId }); + QVERIFY(primary.waitForStarted()); + QCOMPARE(primary.state(), QProcess::Running); + output.clear(); + ok = QTest::qWaitFor([&]() { + output += primary.readAllStandardOutput(); + return output == "Primary\n"; + }); + QVERIFY(ok); + + QProcess secondary; + secondary.setProcessChannelMode(QProcess::ForwardedErrorChannel); + secondary.start(executable, { testId, message }); + QVERIFY(secondary.waitForStarted()); + QCOMPARE(secondary.state(), QProcess::Running); + + output.clear(); + ok = QTest::qWaitFor([&]() { + output += secondary.readAllStandardOutput(); + return output == "Secondary\n"; + }); + QVERIFY(ok); + + if (secondary.state() != QProcess::NotRunning) + QVERIFY(secondary.waitForFinished()); + QCOMPARE(secondary.exitCode(), 0); + QCOMPARE(secondary.exitStatus(), QProcess::NormalExit); + + output.clear(); + const QByteArray expected = "MESSAGE: >" + message.toUtf8() + "<\n"; + ok = QTest::qWaitFor([&]() { + output += primary.readAllStandardOutput(); + return output == expected; + }); + QVERIFY(ok); + + if (primary.state() != QProcess::NotRunning) + QVERIFY(primary.waitForFinished()); + QCOMPARE(primary.exitCode(), 0); + QCOMPARE(primary.exitStatus(), QProcess::NormalExit); +} + +QTEST_MAIN(tst_SimpleTest) + +#include "tst_simpletest.moc" diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/tests/auto/stresstest/CMakeLists.txt b/3rdparty/kdsingleapplication/KDSingleApplication/tests/auto/stresstest/CMakeLists.txt new file mode 100644 index 0000000..459491e --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/tests/auto/stresstest/CMakeLists.txt @@ -0,0 +1,11 @@ +# This file is part of KDSingleApplication. +# +# SPDX-FileCopyrightText: 2020-2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> +# +# SPDX-License-Identifier: MIT +# +# Contact KDAB at <info@kdab.com> for commercial licensing options. +# +add_subdirectory(stresstest) +add_subdirectory(stresstest2) +add_subdirectory(test) diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/tests/auto/stresstest/stresstest/CMakeLists.txt b/3rdparty/kdsingleapplication/KDSingleApplication/tests/auto/stresstest/stresstest/CMakeLists.txt new file mode 100644 index 0000000..8b77262 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/tests/auto/stresstest/stresstest/CMakeLists.txt @@ -0,0 +1,16 @@ +# This file is part of KDSingleApplication. +# +# SPDX-FileCopyrightText: 2020-2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> +# +# SPDX-License-Identifier: MIT +# +# Contact KDAB at <info@kdab.com> for commercial licensing options. +# +set(stresstest_SRCS main.cpp) +add_executable( + stresstest + ${stresstest_SRCS} +) +target_link_libraries( + stresstest Qt::Widgets kdsingleapplication +) diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/tests/auto/stresstest/stresstest/main.cpp b/3rdparty/kdsingleapplication/KDSingleApplication/tests/auto/stresstest/stresstest/main.cpp new file mode 100644 index 0000000..32aa826 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/tests/auto/stresstest/stresstest/main.cpp @@ -0,0 +1,79 @@ +/* + This file is part of KDSingleApplication. + + SPDX-FileCopyrightText: 2019-2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> + + SPDX-License-Identifier: MIT + + Contact KDAB at <info@kdab.com> for commercial licensing options. +*/ + +#include <QtCore/QCoreApplication> +#include <QtCore/QStringList> +#include <QtCore/QString> +#include <QtCore/QTimer> + +#include <kdsingleapplication.h> + +#include <iostream> + +#if defined(Q_OS_WIN) +#include <io.h> +#include <fcntl.h> +#endif + +int main(int argc, char **argv) +{ +#if defined(Q_OS_WIN) + _setmode(_fileno(stdout), _O_BINARY); +#endif + + QCoreApplication app(argc, argv); + + const QByteArrayList messages = { + QByteArrayLiteral("secondary"), + QByteArrayLiteral("secondary 123456"), + QByteArray(1024 * 10, 'x') + }; + + const QString appName = QLatin1String("stresstest-") + app.arguments().value(1); + const QString mode = app.arguments().value(2); + const int timeout = app.arguments().value(3).toInt(); + const int counter = app.arguments().value(4).toInt(); + + if (mode == QLatin1String("primary")) { + KDSingleApplication kdsa(appName); + if (!kdsa.isPrimaryInstance()) + return 1; + + std::cout << "Primary" << std::endl; + + int totalMessages = counter * messages.size(); + + QObject::connect(&kdsa, &KDSingleApplication::messageReceived, + [&totalMessages]() { + if (--totalMessages == 0) + qApp->quit(); + }); + + QTimer::singleShot(timeout, [&totalMessages]() { + std::cerr << "Primary timed out, still " << totalMessages << " messages" << std::endl; + qApp->exit(1); + }); + + return app.exec(); + } else if (mode == QLatin1String("secondary")) { + for (int i = 0; i < counter; ++i) { + KDSingleApplication kdsa(appName); + if (kdsa.isPrimaryInstance()) + return 1; + + for (const auto &message : messages) { + if (!kdsa.sendMessageWithTimeout(message, timeout)) + return 2; + } + } + } + + return 0; +} diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/tests/auto/stresstest/stresstest2/CMakeLists.txt b/3rdparty/kdsingleapplication/KDSingleApplication/tests/auto/stresstest/stresstest2/CMakeLists.txt new file mode 100644 index 0000000..aed7f90 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/tests/auto/stresstest/stresstest2/CMakeLists.txt @@ -0,0 +1,16 @@ +# This file is part of KDSingleApplication. +# +# SPDX-FileCopyrightText: 2020-2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> +# +# SPDX-License-Identifier: MIT +# +# Contact KDAB at <info@kdab.com> for commercial licensing options. +# +set(stresstest2_SRCS main.cpp) +add_executable( + stresstest2 + ${stresstest2_SRCS} +) +target_link_libraries( + stresstest2 Qt::Widgets kdsingleapplication +) diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/tests/auto/stresstest/stresstest2/main.cpp b/3rdparty/kdsingleapplication/KDSingleApplication/tests/auto/stresstest/stresstest2/main.cpp new file mode 100644 index 0000000..274bf58 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/tests/auto/stresstest/stresstest2/main.cpp @@ -0,0 +1,69 @@ +/* + This file is part of KDSingleApplication. + + SPDX-FileCopyrightText: 2019-2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> + + SPDX-License-Identifier: MIT + + Contact KDAB at <info@kdab.com> for commercial licensing options. +*/ + +#include <QtCore/QCoreApplication> +#include <QtCore/QRandomGenerator> +#include <QtCore/QStringList> +#include <QtCore/QString> +#include <QtCore/QTimer> +#include <QtCore/QThread> + +#include <kdsingleapplication.h> + +#include <iostream> + +#if defined(Q_OS_WIN) +#include <io.h> +#include <fcntl.h> +#endif + +int main(int argc, char **argv) +{ +#if defined(Q_OS_WIN) + _setmode(_fileno(stdout), _O_BINARY); +#endif + + QCoreApplication app(argc, argv); + + const int delay = ( int )QRandomGenerator::global()->bounded(100, 200); + QThread::msleep(delay); + + const QString appName = QLatin1String("stresstest2-") + app.arguments().value(1); + const int timeout = app.arguments().value(2).toInt(); + + KDSingleApplication kdsa(appName); + if (kdsa.isPrimaryInstance()) { + std::cout << "Primary" << std::endl; + + int counter = app.arguments().value(3).toInt(); + --counter; + + QObject::connect(&kdsa, &KDSingleApplication::messageReceived, + [&counter]() { + --counter; + if (counter == 0) + qApp->quit(); + }); + + QTimer::singleShot(timeout, [&counter]() { + std::cerr << "Primary time out, still " << counter << " secondaries" << std::endl; + qApp->exit(1); + }); + + return app.exec(); + } else { + std::cout << "Secondary" << std::endl; + + if (!kdsa.sendMessageWithTimeout(QByteArray(delay, 'x'), timeout)) + return 1; + } + + return 0; +} diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/tests/auto/stresstest/test/CMakeLists.txt b/3rdparty/kdsingleapplication/KDSingleApplication/tests/auto/stresstest/test/CMakeLists.txt new file mode 100644 index 0000000..c64aa20 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/tests/auto/stresstest/test/CMakeLists.txt @@ -0,0 +1,19 @@ +# This file is part of KDSingleApplication. +# +# SPDX-FileCopyrightText: 2020-2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> +# +# SPDX-License-Identifier: MIT +# +# Contact KDAB at <info@kdab.com> for commercial licensing options. +# +include_directories(${CMAKE_SOURCE_DIR}/src) +include_directories(${CMAKE_CURRENT_BINARY_DIR}) + +add_executable( + tst_stresstest + ../tst_stresstest.cpp +) +target_link_libraries( + tst_stresstest Qt::Test +) +add_test(NAME tst_stresstest COMMAND tst_stresstest) diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/tests/auto/stresstest/tst_stresstest.cpp b/3rdparty/kdsingleapplication/KDSingleApplication/tests/auto/stresstest/tst_stresstest.cpp new file mode 100644 index 0000000..2155a0e --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/tests/auto/stresstest/tst_stresstest.cpp @@ -0,0 +1,229 @@ +/* + This file is part of KDSingleApplication. + + SPDX-FileCopyrightText: 2019-2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> + + SPDX-License-Identifier: MIT + + Contact KDAB at <info@kdab.com> for commercial licensing options. +*/ + +#include <QtCore/QProcess> +#include <QtCore/QRandomGenerator> +#include <QtCore/QScopeGuard> +#include <QtTest/QTest> + +#include <vector> +#include <memory> + +#ifdef Q_OS_UNIX +#include <sys/time.h> +#include <sys/resource.h> +#endif + +class tst_StressTest : public QObject +{ + Q_OBJECT +private Q_SLOTS: + void initTestCase(); + void testOnePrimaryManySecondaries(); + + void testOnlyOnePrimary_data(); + void testOnlyOnePrimary(); + +private: + bool m_isRunninginCI = false; +}; + +// The default timeouts don't seem to be enough +// on Windows/OSX; increase it when the number of instances grows. +static int calculateTimeout(int instances) +{ + return qMax(instances * 5000, 30000); +} + +void tst_StressTest::initTestCase() +{ +#ifdef Q_OS_UNIX + // increase the system limits if possible + struct rlimit ulimit; + if (::getrlimit(RLIMIT_NOFILE, &ulimit) != 0) { + perror("Cannot get ulimits"); + QFAIL("Aborting testcase"); + } + + // up to 100 processes, up to 4 fds per process; + // this should be more than enough! + constexpr int minimumNumberOfFds = 4096; + + if (ulimit.rlim_cur < minimumNumberOfFds) { + ulimit.rlim_cur = minimumNumberOfFds; + + if (::setrlimit(RLIMIT_NOFILE, &ulimit) != 0) { + perror("Cannot set ulimits"); + QFAIL("Aborting testcase"); + } + } +#endif + + // Avoid overloading the Windows VMs, or they'll time out +#if defined(Q_OS_WIN) + m_isRunninginCI = []() { + bool ok; + const int ciBuild = qEnvironmentVariableIntValue("CI_BUILD", &ok); + if (!ok) + return true; + return ciBuild != 0; + }(); +#else + m_isRunninginCI = false; +#endif + + if (m_isRunninginCI) + qDebug() << "Running a subset of the tests to avoid overloading the CI. Set CI_BUILD=0 to override"; + else + qDebug() << "Running full tests"; +} + +void tst_StressTest::testOnePrimaryManySecondaries() +{ + // Each secondary will output runsPerSecondary _blocks_ of messages; + // we run secondariesCount secondaries. + // * The primary gets: how many blocks of messages to expect in total + // * The secondaries get: how many blocks to send + // + // (The primary will do the math internally) + +#ifdef KDSINGLEAPPLICATION_BINARY_DIR + const QString executable = QStringLiteral(KDSINGLEAPPLICATION_BINARY_DIR "stresstest"); +#else + const QString executable = QStringLiteral("stresstest/stresstest"); +#endif + + const int secondariesCount = m_isRunninginCI ? 5 : 50; + const int runsPerSecondary = m_isRunninginCI ? 5 : 50; + + const QString testId = QString::number(QRandomGenerator::global()->generate()); + const int timeout = calculateTimeout(secondariesCount); + const QString timeoutString = QString::number(timeout); + + QByteArray output; + bool ok; + + QProcess primary; + auto cleanup = qScopeGuard([&primary] { + // QTests might return early and we might leave running process + primary.kill(); + primary.waitForFinished(); + }); + primary.setProcessChannelMode(QProcess::ForwardedErrorChannel); + primary.start(executable, { testId, QStringLiteral("primary"), timeoutString, QString::number(secondariesCount * runsPerSecondary) }); + QVERIFY(primary.waitForStarted()); + QCOMPARE(primary.state(), QProcess::Running); + output.clear(); + ok = QTest::qWaitFor([&]() { + output += primary.readAllStandardOutput(); + return output == "Primary\n"; + }); + QVERIFY(ok); + + std::vector<std::unique_ptr<QProcess>> secondaries; + auto cleanupSecondaries = qScopeGuard([&secondaries] { + // QTests might return early and we might leave running process + for (auto &secondary : secondaries) { + secondary->kill(); + secondary->waitForFinished(); + } + }); + secondaries.reserve(secondariesCount); + for (int i = 0; i < secondariesCount; ++i) { + std::unique_ptr<QProcess> secondary = std::make_unique<QProcess>(); + secondary->setProcessChannelMode(QProcess::ForwardedErrorChannel); + secondary->start(executable, { testId, QStringLiteral("secondary"), timeoutString, QString::number(runsPerSecondary) }); + secondaries.push_back(std::move(secondary)); + } + + for (auto &secondary : secondaries) + QVERIFY(secondary->waitForStarted(timeout)); + + for (auto &secondary : secondaries) { + if (secondary->state() != QProcess::NotRunning) + QVERIFY(secondary->waitForFinished(timeout)); + QCOMPARE(secondary->exitCode(), 0); + QCOMPARE(secondary->exitStatus(), QProcess::NormalExit); + } + + secondaries.clear(); + + if (primary.state() != QProcess::NotRunning) + QVERIFY(primary.waitForFinished(timeout)); + QCOMPARE(primary.exitCode(), 0); + QCOMPARE(primary.exitStatus(), QProcess::NormalExit); +} + +void tst_StressTest::testOnlyOnePrimary_data() +{ + QTest::addColumn<int>("count"); + + const int totalCount = m_isRunninginCI ? 10 : 100; + for (int i = 10; i <= totalCount; i += 10) + QTest::addRow("count-%d", i) << i; +} + +void tst_StressTest::testOnlyOnePrimary() +{ + QFETCH(int, count); + + int primaryCount = 0; + int secondaryCount = 0; + +#ifdef KDSINGLEAPPLICATION_BINARY_DIR + const QString executable = QStringLiteral(KDSINGLEAPPLICATION_BINARY_DIR "stresstest2"); +#else + const QString executable = QStringLiteral("stresstest2/stresstest2"); +#endif + + const QString countString = QString::number(count); + const QString testId = QString::number(QRandomGenerator::global()->generate()); + + const auto timeout = calculateTimeout(count); + const auto timeoutString = QString::number(timeout); + + std::vector<std::unique_ptr<QProcess>> processes; + auto cleanup = qScopeGuard([&processes] { + // QTests might return early and we might leave running process + for (auto &secondary : processes) { + secondary->kill(); + secondary->waitForFinished(); + } + }); + processes.reserve(count); + for (int i = 0; i < count; ++i) { + std::unique_ptr<QProcess> process = std::make_unique<QProcess>(); + process->setProcessChannelMode(QProcess::ForwardedErrorChannel); + process->start(executable, { testId, timeoutString, countString }); + processes.push_back(std::move(process)); + } + + for (auto &process : processes) { + if (process->state() != QProcess::NotRunning) + QVERIFY(process->waitForFinished(timeout)); + QCOMPARE(process->exitCode(), 0); + QCOMPARE(process->exitStatus(), QProcess::NormalExit); + + QByteArray output = process->readAllStandardOutput(); + if (output == "Primary\n") + ++primaryCount; + else if (output == "Secondary\n") + ++secondaryCount; + else + QFAIL("Unexpected output"); + } + + QCOMPARE(primaryCount, 1); + QCOMPARE(secondaryCount, count - 1); +} + +QTEST_MAIN(tst_StressTest) + +#include "tst_stresstest.moc" diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/tests/manual/CMakeLists.txt b/3rdparty/kdsingleapplication/KDSingleApplication/tests/manual/CMakeLists.txt new file mode 100644 index 0000000..8ce4470 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/tests/manual/CMakeLists.txt @@ -0,0 +1,9 @@ +# This file is part of KDSingleApplication. +# +# SPDX-FileCopyrightText: 2020-2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> +# +# SPDX-License-Identifier: MIT +# +# Contact KDAB at <info@kdab.com> for commercial licensing options. +# +add_subdirectory(simplesingleapp) diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/tests/manual/simplesingleapp/CMakeLists.txt b/3rdparty/kdsingleapplication/KDSingleApplication/tests/manual/simplesingleapp/CMakeLists.txt new file mode 100644 index 0000000..3e06e5f --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/tests/manual/simplesingleapp/CMakeLists.txt @@ -0,0 +1,18 @@ +# This file is part of KDSingleApplication. +# +# SPDX-FileCopyrightText: 2020-2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> +# +# SPDX-License-Identifier: MIT +# +# Contact KDAB at <info@kdab.com> for commercial licensing options. +# +include_directories(${CMAKE_SOURCE_DIR}/src) +include_directories(${CMAKE_CURRENT_BINARY_DIR}) + +add_executable( + simplesingleapp + main.cpp +) +target_link_libraries( + simplesingleapp Qt::Widgets kdsingleapplication +) diff --git a/3rdparty/kdsingleapplication/KDSingleApplication/tests/manual/simplesingleapp/main.cpp b/3rdparty/kdsingleapplication/KDSingleApplication/tests/manual/simplesingleapp/main.cpp new file mode 100644 index 0000000..9dd12a7 --- /dev/null +++ b/3rdparty/kdsingleapplication/KDSingleApplication/tests/manual/simplesingleapp/main.cpp @@ -0,0 +1,54 @@ +/* + This file is part of KDSingleApplication. + + SPDX-FileCopyrightText: 2019-2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> + + SPDX-License-Identifier: MIT + + Contact KDAB at <info@kdab.com> for commercial licensing options. +*/ + +#include <QtCore/QCoreApplication> +#include <QtCore/QTimer> + +#include <kdsingleapplication.h> + +#include <chrono> +#include <iostream> + +int main(int argc, char **argv) +{ + QCoreApplication app(argc, argv); + + KDSingleApplication kdsa; + + QTimer shutdownTimer; + shutdownTimer.setSingleShot(true); + shutdownTimer.setInterval(std::chrono::seconds(15)); + QObject::connect(&shutdownTimer, &QTimer::timeout, &app, &QCoreApplication::quit); + + if (kdsa.isPrimaryInstance()) { + std::cout << "Primary; waiting for secondary instances..." << std::endl; + shutdownTimer.start(); + + QObject::connect(&kdsa, &KDSingleApplication::messageReceived, + [&shutdownTimer](const QByteArray &message) { + shutdownTimer.start(); + std::cout << "Message from secondary: >" << message.constData() << '<' << std::endl; + }); + } else { + auto args = app.arguments(); + const QByteArray message = args.join(QLatin1Char(',')).toUtf8(); + + std::cout << "Secondary; sending message >" << message.constData() << '<' << std::endl; + + if (!kdsa.sendMessage(message)) { + std::cerr << "Unable to send message to the primary!" << std::endl; + return 1; + } + + return 0; + } + + return app.exec(); +}
Locations
Projects
Search
Status Monitor
Help
OpenBuildService.org
Documentation
API Documentation
Code of Conduct
Contact
Support
@OBShq
Terms
openSUSE Build Service is sponsored by
The Open Build Service is an
openSUSE project
.
Sign Up
Log In
Places
Places
All Projects
Status Monitor
